Files
PhysX4.1/physx/documentation/PhysXAPI/files/classPxSceneLimits.html
2025-11-28 23:13:44 +05:30

287 lines
18 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxSceneLimits Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxSceneLimits.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classPxSceneLimits-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PxSceneLimits Class Reference<div class="ingroups"><a class="el" href="group__physics.html">Physics</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Class used to retrieve limits(e.g. maximum number of bodies) for a scene. The limits are used as a hint to the size of the scene, not as a hard limit (i.e. it will be possible to create more objects than specified in the scene limits).
<a href="classPxSceneLimits.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PxSceneDesc_8h_source.html">PxSceneDesc.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:gad36024f1760b55b0947dc0d91e080bd7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__physics.html#gad36024f1760b55b0947dc0d91e080bd7">PxSceneLimits</a> ()</td></tr>
<tr class="memdesc:gad36024f1760b55b0947dc0d91e080bd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor sets to default <a href="group__physics.html#gad36024f1760b55b0947dc0d91e080bd7">More...</a><br /></td></tr>
<tr class="separator:gad36024f1760b55b0947dc0d91e080bd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae673c050f15b0fc912860adbb3394e34"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__physics.html#gae673c050f15b0fc912860adbb3394e34">setToDefault</a> ()</td></tr>
<tr class="memdesc:gae673c050f15b0fc912860adbb3394e34"><td class="mdescLeft">&#160;</td><td class="mdescRight">(re)sets the structure to the default <a href="group__physics.html#gae673c050f15b0fc912860adbb3394e34">More...</a><br /></td></tr>
<tr class="separator:gae673c050f15b0fc912860adbb3394e34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga622bf3792efe0007282d836719e80093"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__physics.html#ga622bf3792efe0007282d836719e80093">isValid</a> () const</td></tr>
<tr class="memdesc:ga622bf3792efe0007282d836719e80093"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the descriptor is valid. <a href="group__physics.html#ga622bf3792efe0007282d836719e80093">More...</a><br /></td></tr>
<tr class="separator:ga622bf3792efe0007282d836719e80093"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:af0a6bbbff2a3c1ce5cf80d2ef3666cf5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#af0a6bbbff2a3c1ce5cf80d2ef3666cf5">maxNbActors</a></td></tr>
<tr class="memdesc:af0a6bbbff2a3c1ce5cf80d2ef3666cf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expected maximum number of actors. <a href="#af0a6bbbff2a3c1ce5cf80d2ef3666cf5">More...</a><br /></td></tr>
<tr class="separator:af0a6bbbff2a3c1ce5cf80d2ef3666cf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0eaee83c330232159c791093abc0f4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#ad0eaee83c330232159c791093abc0f4c">maxNbBodies</a></td></tr>
<tr class="memdesc:ad0eaee83c330232159c791093abc0f4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expected maximum number of dynamic rigid bodies. <a href="#ad0eaee83c330232159c791093abc0f4c">More...</a><br /></td></tr>
<tr class="separator:ad0eaee83c330232159c791093abc0f4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5269e317c229389fc49ed658d60f1a7e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#a5269e317c229389fc49ed658d60f1a7e">maxNbStaticShapes</a></td></tr>
<tr class="memdesc:a5269e317c229389fc49ed658d60f1a7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expected maximum number of static shapes. <a href="#a5269e317c229389fc49ed658d60f1a7e">More...</a><br /></td></tr>
<tr class="separator:a5269e317c229389fc49ed658d60f1a7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2657acecc1cc484fc48a1263f4fc0427"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#a2657acecc1cc484fc48a1263f4fc0427">maxNbDynamicShapes</a></td></tr>
<tr class="memdesc:a2657acecc1cc484fc48a1263f4fc0427"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expected maximum number of dynamic shapes. <a href="#a2657acecc1cc484fc48a1263f4fc0427">More...</a><br /></td></tr>
<tr class="separator:a2657acecc1cc484fc48a1263f4fc0427"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad44cb62b261514d8937077f75b40c5cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#ad44cb62b261514d8937077f75b40c5cc">maxNbAggregates</a></td></tr>
<tr class="memdesc:ad44cb62b261514d8937077f75b40c5cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expected maximum number of aggregates. <a href="#ad44cb62b261514d8937077f75b40c5cc">More...</a><br /></td></tr>
<tr class="separator:ad44cb62b261514d8937077f75b40c5cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4226fb580e6cf704af33208a931bfd0e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#a4226fb580e6cf704af33208a931bfd0e">maxNbConstraints</a></td></tr>
<tr class="memdesc:a4226fb580e6cf704af33208a931bfd0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expected maximum number of constraint shaders. <a href="#a4226fb580e6cf704af33208a931bfd0e">More...</a><br /></td></tr>
<tr class="separator:a4226fb580e6cf704af33208a931bfd0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac629764140a510c999a83e1b65e796af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#ac629764140a510c999a83e1b65e796af">maxNbRegions</a></td></tr>
<tr class="memdesc:ac629764140a510c999a83e1b65e796af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expected maximum number of broad-phase regions. <a href="#ac629764140a510c999a83e1b65e796af">More...</a><br /></td></tr>
<tr class="separator:ac629764140a510c999a83e1b65e796af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f662dce363bf4b21782a0d33b309446"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#a8f662dce363bf4b21782a0d33b309446">maxNbBroadPhaseOverlaps</a></td></tr>
<tr class="memdesc:a8f662dce363bf4b21782a0d33b309446"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expected maximum number of broad-phase overlaps. <a href="#a8f662dce363bf4b21782a0d33b309446">More...</a><br /></td></tr>
<tr class="separator:a8f662dce363bf4b21782a0d33b309446"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class used to retrieve limits(e.g. maximum number of bodies) for a scene. The limits are used as a hint to the size of the scene, not as a hard limit (i.e. it will be possible to create more objects than specified in the scene limits). </p>
<p>0 indicates no limit. Using limits allows the SDK to preallocate various arrays, leading to less re-allocations and faster code at runtime. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="af0a6bbbff2a3c1ce5cf80d2ef3666cf5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0a6bbbff2a3c1ce5cf80d2ef3666cf5">&#9670;&nbsp;</a></span>maxNbActors</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxSceneLimits::maxNbActors</td>
</tr>
</table>
</div><div class="memdoc">
<p>Expected maximum number of actors. </p>
</div>
</div>
<a id="ad44cb62b261514d8937077f75b40c5cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad44cb62b261514d8937077f75b40c5cc">&#9670;&nbsp;</a></span>maxNbAggregates</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxSceneLimits::maxNbAggregates</td>
</tr>
</table>
</div><div class="memdoc">
<p>Expected maximum number of aggregates. </p>
</div>
</div>
<a id="ad0eaee83c330232159c791093abc0f4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0eaee83c330232159c791093abc0f4c">&#9670;&nbsp;</a></span>maxNbBodies</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxSceneLimits::maxNbBodies</td>
</tr>
</table>
</div><div class="memdoc">
<p>Expected maximum number of dynamic rigid bodies. </p>
</div>
</div>
<a id="a8f662dce363bf4b21782a0d33b309446"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f662dce363bf4b21782a0d33b309446">&#9670;&nbsp;</a></span>maxNbBroadPhaseOverlaps</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxSceneLimits::maxNbBroadPhaseOverlaps</td>
</tr>
</table>
</div><div class="memdoc">
<p>Expected maximum number of broad-phase overlaps. </p>
</div>
</div>
<a id="a4226fb580e6cf704af33208a931bfd0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4226fb580e6cf704af33208a931bfd0e">&#9670;&nbsp;</a></span>maxNbConstraints</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxSceneLimits::maxNbConstraints</td>
</tr>
</table>
</div><div class="memdoc">
<p>Expected maximum number of constraint shaders. </p>
</div>
</div>
<a id="a2657acecc1cc484fc48a1263f4fc0427"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2657acecc1cc484fc48a1263f4fc0427">&#9670;&nbsp;</a></span>maxNbDynamicShapes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxSceneLimits::maxNbDynamicShapes</td>
</tr>
</table>
</div><div class="memdoc">
<p>Expected maximum number of dynamic shapes. </p>
</div>
</div>
<a id="ac629764140a510c999a83e1b65e796af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac629764140a510c999a83e1b65e796af">&#9670;&nbsp;</a></span>maxNbRegions</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxSceneLimits::maxNbRegions</td>
</tr>
</table>
</div><div class="memdoc">
<p>Expected maximum number of broad-phase regions. </p>
<p class="reference">Referenced by <a class="el" href="group__physics.html#ga622bf3792efe0007282d836719e80093">isValid()</a>.</p>
</div>
</div>
<a id="a5269e317c229389fc49ed658d60f1a7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5269e317c229389fc49ed658d60f1a7e">&#9670;&nbsp;</a></span>maxNbStaticShapes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxSceneLimits::maxNbStaticShapes</td>
</tr>
</table>
</div><div class="memdoc">
<p>Expected maximum number of static shapes. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxSceneDesc_8h_source.html">PxSceneDesc.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classPxSceneLimits.html">PxSceneLimits</a></li>
<li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
</ul>
</div>
</body>
</html>