aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneLimits.html
blob: 8e2db9742d934b04fa2e5433b96540166d8fda02 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxSceneLimits Class Reference</title>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
		<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
	</head>

	<body bgcolor="#FFFFFF">
		<div id="header">
			<hr class="first">
			<img alt="" src="images/PhysXlogo.png" align="middle"> <br>
			<center>
				<a class="qindex" href="main.html">Main Page</a> &nbsp; 
				<a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; 
				<a class="qindex" href="annotated.html">Compound List</a> &nbsp; 
				<a class="qindex" href="functions.html">Compound Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxSceneLimits Class Reference<br>
<small>
[<a class="el" href="group__physics.html">Physics</a>]</small>
</h1><!-- doxytag: class="PxSceneLimits" -->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="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxSceneDesc_8h-source.html">PxSceneDesc.h</a>&gt;</code>
<p>

<p>
<a href="classPxSceneLimits-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__physics.html#gd36024f1760b55b0947dc0d91e080bd7">PxSceneLimits</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">constructor sets to default  <a href="group__physics.html#gd36024f1760b55b0947dc0d91e080bd7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__physics.html#ge673c050f15b0fc912860adbb3394e34">setToDefault</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(re)sets the structure to the default  <a href="group__physics.html#ge673c050f15b0fc912860adbb3394e34"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__physics.html#g0fdb519fc67615aed0a8548b8f6fcab1">isValid</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the descriptor is valid.  <a href="group__physics.html#g0fdb519fc67615aed0a8548b8f6fcab1"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#f0a6bbbff2a3c1ce5cf80d2ef3666cf5">maxNbActors</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Expected maximum number of actors.  <a href="#f0a6bbbff2a3c1ce5cf80d2ef3666cf5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#d0eaee83c330232159c791093abc0f4c">maxNbBodies</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Expected maximum number of dynamic rigid bodies.  <a href="#d0eaee83c330232159c791093abc0f4c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#5269e317c229389fc49ed658d60f1a7e">maxNbStaticShapes</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Expected maximum number of static shapes.  <a href="#5269e317c229389fc49ed658d60f1a7e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#2657acecc1cc484fc48a1263f4fc0427">maxNbDynamicShapes</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Expected maximum number of dynamic shapes.  <a href="#2657acecc1cc484fc48a1263f4fc0427"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#d44cb62b261514d8937077f75b40c5cc">maxNbAggregates</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Expected maximum number of aggregates.  <a href="#d44cb62b261514d8937077f75b40c5cc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#4226fb580e6cf704af33208a931bfd0e">maxNbConstraints</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Expected maximum number of constraint shaders.  <a href="#4226fb580e6cf704af33208a931bfd0e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#c629764140a510c999a83e1b65e796af">maxNbRegions</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Expected maximum number of broad-phase regions.  <a href="#c629764140a510c999a83e1b65e796af"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#8f662dce363bf4b21782a0d33b309446">maxNbBroadPhaseOverlaps</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Expected maximum number of broad-phase overlaps.  <a href="#8f662dce363bf4b21782a0d33b309446"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_DEPRECATED <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneLimits.html#098be54fe1199d3a31c9cb91f2eec003">maxNbObjectsPerRegion</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
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>
0 indicates no limit. Using limits allows the SDK to preallocate various arrays, leading to less re-allocations and faster code at runtime. <hr><h2>Member Data Documentation</h2>
<a class="anchor" name="f0a6bbbff2a3c1ce5cf80d2ef3666cf5"></a><!-- doxytag: member="PxSceneLimits::maxNbActors" ref="f0a6bbbff2a3c1ce5cf80d2ef3666cf5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxSceneLimits.html#f0a6bbbff2a3c1ce5cf80d2ef3666cf5">PxSceneLimits::maxNbActors</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Expected maximum number of actors. 
<p>

</div>
</div><p>
<a class="anchor" name="d44cb62b261514d8937077f75b40c5cc"></a><!-- doxytag: member="PxSceneLimits::maxNbAggregates" ref="d44cb62b261514d8937077f75b40c5cc" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxSceneLimits.html#d44cb62b261514d8937077f75b40c5cc">PxSceneLimits::maxNbAggregates</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Expected maximum number of aggregates. 
<p>

</div>
</div><p>
<a class="anchor" name="d0eaee83c330232159c791093abc0f4c"></a><!-- doxytag: member="PxSceneLimits::maxNbBodies" ref="d0eaee83c330232159c791093abc0f4c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxSceneLimits.html#d0eaee83c330232159c791093abc0f4c">PxSceneLimits::maxNbBodies</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Expected maximum number of dynamic rigid bodies. 
<p>

</div>
</div><p>
<a class="anchor" name="8f662dce363bf4b21782a0d33b309446"></a><!-- doxytag: member="PxSceneLimits::maxNbBroadPhaseOverlaps" ref="8f662dce363bf4b21782a0d33b309446" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxSceneLimits.html#8f662dce363bf4b21782a0d33b309446">PxSceneLimits::maxNbBroadPhaseOverlaps</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Expected maximum number of broad-phase overlaps. 
<p>

</div>
</div><p>
<a class="anchor" name="4226fb580e6cf704af33208a931bfd0e"></a><!-- doxytag: member="PxSceneLimits::maxNbConstraints" ref="4226fb580e6cf704af33208a931bfd0e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxSceneLimits.html#4226fb580e6cf704af33208a931bfd0e">PxSceneLimits::maxNbConstraints</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Expected maximum number of constraint shaders. 
<p>

</div>
</div><p>
<a class="anchor" name="2657acecc1cc484fc48a1263f4fc0427"></a><!-- doxytag: member="PxSceneLimits::maxNbDynamicShapes" ref="2657acecc1cc484fc48a1263f4fc0427" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxSceneLimits.html#2657acecc1cc484fc48a1263f4fc0427">PxSceneLimits::maxNbDynamicShapes</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Expected maximum number of dynamic shapes. 
<p>

</div>
</div><p>
<a class="anchor" name="098be54fe1199d3a31c9cb91f2eec003"></a><!-- doxytag: member="PxSceneLimits::maxNbObjectsPerRegion" ref="098be54fe1199d3a31c9cb91f2eec003" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_DEPRECATED <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxSceneLimits.html#098be54fe1199d3a31c9cb91f2eec003">PxSceneLimits::maxNbObjectsPerRegion</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000047">Deprecated:</a></b></dt><dd>This is deprecated. Expected maximum number of objects in one broad-phase region </dd></dl>

</div>
</div><p>
<a class="anchor" name="c629764140a510c999a83e1b65e796af"></a><!-- doxytag: member="PxSceneLimits::maxNbRegions" ref="c629764140a510c999a83e1b65e796af" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxSceneLimits.html#c629764140a510c999a83e1b65e796af">PxSceneLimits::maxNbRegions</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Expected maximum number of broad-phase regions. 
<p>

<p>Referenced by <a class="el" href="PxSceneDesc_8h-source.html#l00460">isValid()</a>.</p>

</div>
</div><p>
<a class="anchor" name="5269e317c229389fc49ed658d60f1a7e"></a><!-- doxytag: member="PxSceneLimits::maxNbStaticShapes" ref="5269e317c229389fc49ed658d60f1a7e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxSceneLimits.html#5269e317c229389fc49ed658d60f1a7e">PxSceneLimits::maxNbStaticShapes</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Expected maximum number of static shapes. 
<p>

</div>
</div><p>
<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></ul>
</div>

<hr style="width: 100%; height: 2px;"><br>
Copyright &copy; 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</body>
</html>