aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxSpatialIndex.html
blob: 983857fb5880bef0281799461c5ffed2335e4d65 (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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxSpatialIndex 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>PxSpatialIndex Class Reference<br>
<small>
[<a class="el" href="group__physics.html">Physics</a>]</small>
</h1><!-- doxytag: class="PxSpatialIndex" -->provides direct access to PhysX' Spatial Query engine  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxSpatialIndex_8h-source.html">PxSpatialIndex.h</a>&gt;</code>
<p>

<p>
<a href="classPxSpatialIndex-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">virtual <a class="el" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#7af68f3695944ba55a4e3b9ddf8b95a6">insert</a> (<a class="el" href="classPxSpatialIndexItem.html">PxSpatialIndexItem</a> &amp;item, const <a class="el" href="classPxBounds3.html">PxBounds3</a> &amp;bounds)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">insert a bounding box into a spatial index  <a href="#7af68f3695944ba55a4e3b9ddf8b95a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#cf1e4d6cbeff5759dfbe471eaeb4d9ed">update</a> (<a class="el" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a> id, const <a class="el" href="classPxBounds3.html">PxBounds3</a> &amp;bounds)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">update a bounding box in a spatial index  <a href="#cf1e4d6cbeff5759dfbe471eaeb4d9ed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#0d9de31ad322614cac4c19bcc6a076f1">remove</a> (<a class="el" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a> id)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">remove an item from a spatial index  <a href="#0d9de31ad322614cac4c19bcc6a076f1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#00cf7e306339f210ca9c9f4cc0ca8b76">overlap</a> (const <a class="el" href="classPxBounds3.html">PxBounds3</a> &amp;aabb, <a class="el" href="structPxSpatialOverlapCallback.html">PxSpatialOverlapCallback</a> &amp;callback) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">make an overlap query against a spatial index  <a href="#00cf7e306339f210ca9c9f4cc0ca8b76"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#51d38d0a9ced5338ea67b77be5bc044c">raycast</a> (const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;origin, const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;unitDir, PxReal maxDist, <a class="el" href="structPxSpatialLocationCallback.html">PxSpatialLocationCallback</a> &amp;callback) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">make a raycast query against a spatial index  <a href="#51d38d0a9ced5338ea67b77be5bc044c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#fa49a33803f4f392d2908287c41bfeab">sweep</a> (const <a class="el" href="classPxBounds3.html">PxBounds3</a> &amp;aabb, const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;unitDir, PxReal maxDist, <a class="el" href="structPxSpatialLocationCallback.html">PxSpatialLocationCallback</a> &amp;callback) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">make a sweep query against a spatial index  <a href="#fa49a33803f4f392d2908287c41bfeab"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#0d92a1d62a9c3499c19195b9ec459f24">flush</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">force an immediate update of the internal structures of the index  <a href="#0d92a1d62a9c3499c19195b9ec459f24"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#fe8693bc795bb94f0ee575d4281aa5ac">rebuildFull</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">force a full optimized rebuild of the index.  <a href="#fe8693bc795bb94f0ee575d4281aa5ac"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#c1d1711a3dc99f9bb244ca0d2ea78f5f">setIncrementalRebuildRate</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> rate)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set the incremental rebuild rate for the index.  <a href="#c1d1711a3dc99f9bb244ca0d2ea78f5f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#c2410c7b878f0cd2b25f74fa4e7e4e69">rebuildStep</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">take one step in rebuilding the tree. See <a class="el" href="classPxSpatialIndex.html#c1d1711a3dc99f9bb244ca0d2ea78f5f" title="set the incremental rebuild rate for the index.">setIncrementalRebuildRate()</a>  <a href="#c2410c7b878f0cd2b25f74fa4e7e4e69"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#0a3706d24bfce84cebfeed9e366d8a14">release</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">release this object  <a href="#0a3706d24bfce84cebfeed9e366d8a14"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#4eef678b188d97ac75362f246f3d69c3">~PxSpatialIndex</a> ()</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
provides direct access to PhysX' Spatial Query engine 
<p>
This class allows bounding boxes to be inserted, and then queried using sweep, raycast and overlap checks.<p>
It is not thread-safe and defers handling some updates until queries are invoked, so care must be taken when calling any methods in parallel. Specifically, to call query methods (raycast, overlap, sweep) in parallel, first call <a class="el" href="classPxSpatialIndex.html#0d92a1d62a9c3499c19195b9ec459f24" title="force an immediate update of the internal structures of the index">flush()</a> to force immediate update of internal structures.<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000053">Deprecated:</a></b></dt><dd>Spatial index feature has been deprecated in PhysX version 3.4</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__physics.html#g4608473fcea7bec808f20e2e9ed4bbf1" title="Creates a spatial index.">PxCreateSpatialIndex</a> </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="4eef678b188d97ac75362f246f3d69c3"></a><!-- doxytag: member="PxSpatialIndex::~PxSpatialIndex" ref="4eef678b188d97ac75362f246f3d69c3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxSpatialIndex::~PxSpatialIndex           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0d92a1d62a9c3499c19195b9ec459f24"></a><!-- doxytag: member="PxSpatialIndex::flush" ref="0d92a1d62a9c3499c19195b9ec459f24" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxSpatialIndex::flush           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
force an immediate update of the internal structures of the index 
<p>
For reasons of efficiency an index structure may be lazily updated at the point of query if this method is not called. Once this method has been called, subsequent queries (sweeps, overlaps, raycasts) may be executed in parallel until the next write call to the index (insertion, removal, update, rebuild) 
</div>
</div><p>
<a class="anchor" name="7af68f3695944ba55a4e3b9ddf8b95a6"></a><!-- doxytag: member="PxSpatialIndex::insert" ref="7af68f3695944ba55a4e3b9ddf8b95a6" args="(PxSpatialIndexItem &amp;item, const PxBounds3 &amp;bounds)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a> PxSpatialIndex::insert           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classPxSpatialIndexItem.html">PxSpatialIndexItem</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>item</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxBounds3.html">PxBounds3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>bounds</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
insert a bounding box into a spatial index 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>item</em>&nbsp;</td><td>the item to be inserted </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>bounds</em>&nbsp;</td><td>the bounds of the new item </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="00cf7e306339f210ca9c9f4cc0ca8b76"></a><!-- doxytag: member="PxSpatialIndex::overlap" ref="00cf7e306339f210ca9c9f4cc0ca8b76" args="(const PxBounds3 &amp;aabb, PxSpatialOverlapCallback &amp;callback) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxSpatialIndex::overlap           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPxBounds3.html">PxBounds3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>aabb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structPxSpatialOverlapCallback.html">PxSpatialOverlapCallback</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>callback</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
make an overlap query against a spatial index 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aabb</em>&nbsp;</td><td>the axis aligned bounding box for the query </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>callback</em>&nbsp;</td><td>the callback to invoke when an overlap is found </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="51d38d0a9ced5338ea67b77be5bc044c"></a><!-- doxytag: member="PxSpatialIndex::raycast" ref="51d38d0a9ced5338ea67b77be5bc044c" args="(const PxVec3 &amp;origin, const PxVec3 &amp;unitDir, PxReal maxDist, PxSpatialLocationCallback &amp;callback) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxSpatialIndex::raycast           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>origin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>unitDir</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PxReal&nbsp;</td>
          <td class="paramname"> <em>maxDist</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structPxSpatialLocationCallback.html">PxSpatialLocationCallback</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>callback</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
make a raycast query against a spatial index 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>origin</em>&nbsp;</td><td>the origin of the ray </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>unitDir</em>&nbsp;</td><td>a unit vector in the direction of the ray </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>maxDist</em>&nbsp;</td><td>the maximum distance to cast the ray </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>callback</em>&nbsp;</td><td>the callback to invoke when an item is hit by the ray </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="fe8693bc795bb94f0ee575d4281aa5ac"></a><!-- doxytag: member="PxSpatialIndex::rebuildFull" ref="fe8693bc795bb94f0ee575d4281aa5ac" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxSpatialIndex::rebuildFull           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
force a full optimized rebuild of the index. 
<p>

</div>
</div><p>
<a class="anchor" name="c2410c7b878f0cd2b25f74fa4e7e4e69"></a><!-- doxytag: member="PxSpatialIndex::rebuildStep" ref="c2410c7b878f0cd2b25f74fa4e7e4e69" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxSpatialIndex::rebuildStep           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
take one step in rebuilding the tree. See <a class="el" href="classPxSpatialIndex.html#c1d1711a3dc99f9bb244ca0d2ea78f5f" title="set the incremental rebuild rate for the index.">setIncrementalRebuildRate()</a> 
<p>

</div>
</div><p>
<a class="anchor" name="0a3706d24bfce84cebfeed9e366d8a14"></a><!-- doxytag: member="PxSpatialIndex::release" ref="0a3706d24bfce84cebfeed9e366d8a14" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxSpatialIndex::release           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
release this object 
<p>

</div>
</div><p>
<a class="anchor" name="0d9de31ad322614cac4c19bcc6a076f1"></a><!-- doxytag: member="PxSpatialIndex::remove" ref="0d9de31ad322614cac4c19bcc6a076f1" args="(PxSpatialIndexItemId id)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxSpatialIndex::remove           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a>&nbsp;</td>
          <td class="paramname"> <em>id</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
remove an item from a spatial index 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>id</em>&nbsp;</td><td>the id of the item to be removed </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="c1d1711a3dc99f9bb244ca0d2ea78f5f"></a><!-- doxytag: member="PxSpatialIndex::setIncrementalRebuildRate" ref="c1d1711a3dc99f9bb244ca0d2ea78f5f" args="(PxU32 rate)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxSpatialIndex::setIncrementalRebuildRate           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td>
          <td class="paramname"> <em>rate</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
set the incremental rebuild rate for the index. 
<p>
The index builds gradually in the background each time a rebuild step is taken; this value determines the number of steps required to rebuild the index.<p>
See <a class="el" href="classPxScene.html#bf2322887ca4db2fdea0229a44e2892c" title="Sets the rebuild rate of the dynamic tree pruning structures.">PxScene::setDynamicTreeRebuildRateHint()</a> for more information.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>rate</em>&nbsp;</td><td>the rebuild rate</td></tr>
  </table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxScene.html#bf2322887ca4db2fdea0229a44e2892c" title="Sets the rebuild rate of the dynamic tree pruning structures.">PxScene::setDynamicTreeRebuildRateHint()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="fa49a33803f4f392d2908287c41bfeab"></a><!-- doxytag: member="PxSpatialIndex::sweep" ref="fa49a33803f4f392d2908287c41bfeab" args="(const PxBounds3 &amp;aabb, const PxVec3 &amp;unitDir, PxReal maxDist, PxSpatialLocationCallback &amp;callback) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxSpatialIndex::sweep           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPxBounds3.html">PxBounds3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>aabb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>unitDir</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PxReal&nbsp;</td>
          <td class="paramname"> <em>maxDist</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structPxSpatialLocationCallback.html">PxSpatialLocationCallback</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>callback</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
make a sweep query against a spatial index 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aabb</em>&nbsp;</td><td>the axis aligned bounding box to sweep </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>unitDir</em>&nbsp;</td><td>a unit vector in the direction of the sweep </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>maxDist</em>&nbsp;</td><td>the maximum distance to apply the sweep </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>callback</em>&nbsp;</td><td>the callback to invoke when an item is hit by the sweep </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="cf1e4d6cbeff5759dfbe471eaeb4d9ed"></a><!-- doxytag: member="PxSpatialIndex::update" ref="cf1e4d6cbeff5759dfbe471eaeb4d9ed" args="(PxSpatialIndexItemId id, const PxBounds3 &amp;bounds)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxSpatialIndex::update           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a>&nbsp;</td>
          <td class="paramname"> <em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxBounds3.html">PxBounds3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>bounds</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
update a bounding box in a spatial index 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>id</em>&nbsp;</td><td>the id of the item to be updated </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>bounds</em>&nbsp;</td><td>the new bounds of the item </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxSpatialIndex_8h-source.html">PxSpatialIndex.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>