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
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVolumeCache 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>
<a class="qindex" href="hierarchy.html">Class Hierarchy</a>
<a class="qindex" href="annotated.html">Compound List</a>
<a class="qindex" href="functions.html">Compound Members</a>
</center>
<hr class="second">
</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxVolumeCache Class Reference<br>
<small>
[<a class="el" href="group__physics.html">Physics</a>]</small>
</h1><!-- doxytag: class="PxVolumeCache" -->Volumetric cache for local collision geometry.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxVolumeCache_8h-source.html">PxVolumeCache.h</a>></code>
<p>
<p>
<a href="classPxVolumeCache-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxVolumeCache_1_1Iterator.html">Iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A callback wrapper class for use with <a class="el" href="classPxVolumeCache.html#e589287aa090d15e8bd13efd7a80285b" title="Iterates over the scene shapes overlapping with the cache volume.">PxVolumeCache::forEach</a> function. <a href="structPxVolumeCache_1_1Iterator.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#43e58f6fea62f6ec81827e2f251912f5">FillStatus</a> { <br>
<a class="el" href="classPxVolumeCache.html#43e58f6fea62f6ec81827e2f251912f505556701b332b57b8899a95c431d8b56">FILL_OK</a>,
<br>
<a class="el" href="classPxVolumeCache.html#43e58f6fea62f6ec81827e2f251912f54a3175a948c5e06d6a2c2f44495a6f95">FILL_OVER_MAX_COUNT</a>,
<br>
<a class="el" href="classPxVolumeCache.html#43e58f6fea62f6ec81827e2f251912f536f4ffaf326d5f4fc310fd0a8676e6f3">FILL_UNSUPPORTED_GEOMETRY_TYPE</a>,
<br>
<a class="el" href="classPxVolumeCache.html#43e58f6fea62f6ec81827e2f251912f5cbdc57f8bf59feec81f31871969c8c1e">FILL_OUT_OF_MEMORY</a>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">describes <a class="el" href="classPxVolumeCache.html#046b0c5bed6e6f0dad3696cc9b69ed17" title="Fills the cache with objects intersecting the specified cacheVolume.">fill()</a> return status. <a href="classPxVolumeCache.html#43e58f6fea62f6ec81827e2f251912f5">More...</a><br></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="classPxVolumeCache.html#43e58f6fea62f6ec81827e2f251912f5">FillStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#046b0c5bed6e6f0dad3696cc9b69ed17">fill</a> (const <a class="el" href="classPxGeometry.html">PxGeometry</a> &cacheVolume, const <a class="el" href="classPxTransform.html">PxTransform</a> &pose)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills the cache with objects intersecting the specified cacheVolume. <a href="#046b0c5bed6e6f0dad3696cc9b69ed17"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#f151c4569e890ee2b36b1c9ad0da348f">isValid</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if the cache is valid (not over specified max capacity, for both statics and dynamics) and up-to-date. <a href="#f151c4569e890ee2b36b1c9ad0da348f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#a5f2d9a1fcd27838188f4da17ae03dd8">invalidate</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Invalidates the cache. <a href="#a5f2d9a1fcd27838188f4da17ae03dd8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#31f69209809698ad305b9ae29b5d2366">getCacheVolume</a> (<a class="el" href="classPxGeometryHolder.html">PxGeometryHolder</a> &resultVolume, <a class="el" href="classPxTransform.html">PxTransform</a> &resultPose)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the last cached volume geometry. <a href="#31f69209809698ad305b9ae29b5d2366"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxI32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#cd8687904f29300ec7a27222f8db50bf">getNbCachedShapes</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the total number of cached shapes. <a href="#cd8687904f29300ec7a27222f8db50bf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#5cf192b373fadb356a2c016717852c4d">release</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases the cache object and its resources. <a href="#5cf192b373fadb356a2c016717852c4d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#e589287aa090d15e8bd13efd7a80285b">forEach</a> (<a class="el" href="structPxVolumeCache_1_1Iterator.html">Iterator</a> &iter)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterates over the scene shapes overlapping with the cache volume. <a href="#e589287aa090d15e8bd13efd7a80285b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#7c239abc1d93b2dea0cec7ae68d93319">setMaxNbStaticShapes</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> maxCount)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the limit on the maximum number of static shapes allowed to be stored in the cache. <a href="#7c239abc1d93b2dea0cec7ae68d93319"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#30048238aa971768c4bf24c56d186d7c">setMaxNbDynamicShapes</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> maxCount)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the limit on the maximum number of dynamic shapes allowed to be stored in the cache. <a href="#30048238aa971768c4bf24c56d186d7c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#daf05a6049d5f282069ab2d666fdc911">getMaxNbStaticShapes</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current maximum number of static cached shapes. <a href="#daf05a6049d5f282069ab2d666fdc911"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#721bd8c6edc998ad2fd2b113c4acb1a4">getMaxNbDynamicShapes</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current maximum number of dynamic cached shapes. <a href="#721bd8c6edc998ad2fd2b113c4acb1a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#e9feb4df002ccf6a69f1442689f18186">raycast</a> (const <a class="el" href="classPxVec3.html">PxVec3</a> &origin, const <a class="el" href="classPxVec3.html">PxVec3</a> &unitDir, const PxReal distance, <a class="el" href="structPxHitCallback.html">PxRaycastCallback</a> &hitCall, PxHitFlags hitFlags=PxHitFlags(PxHitFlag::eDEFAULT), const <a class="el" href="structPxQueryFilterData.html">PxQueryFilterData</a> &filterData=<a class="el" href="structPxQueryFilterData.html">PxQueryFilterData</a>(), <a class="el" href="classPxQueryFilterCallback.html">PxQueryFilterCallback</a> *filterCall=NULL) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Raycast against objects in the cache, returning results via PxRaycastCallback callback or PxRaycastBuffer object or a custom user callback implementation. <a href="#e9feb4df002ccf6a69f1442689f18186"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#86eb361338891b14b27f9d4594b15df8">sweep</a> (const <a class="el" href="classPxGeometry.html">PxGeometry</a> &geometry, const <a class="el" href="classPxTransform.html">PxTransform</a> &pose, const <a class="el" href="classPxVec3.html">PxVec3</a> &unitDir, const PxReal distance, <a class="el" href="structPxHitCallback.html">PxSweepCallback</a> &hitCall, PxHitFlags hitFlags=PxHitFlag::eDEFAULT, const <a class="el" href="structPxQueryFilterData.html">PxQueryFilterData</a> &filterData=<a class="el" href="structPxQueryFilterData.html">PxQueryFilterData</a>(), <a class="el" href="classPxQueryFilterCallback.html">PxQueryFilterCallback</a> *filterCall=NULL, const PxReal inflation=0.f) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sweep against objects in the cache, returning results via PxRaycastCallback callback or PxRaycastBuffer object or a custom user callback implementation. <a href="#86eb361338891b14b27f9d4594b15df8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#d339ef9e688aed817333ef1ac78d868c">overlap</a> (const <a class="el" href="classPxGeometry.html">PxGeometry</a> &geometry, const <a class="el" href="classPxTransform.html">PxTransform</a> &pose, <a class="el" href="structPxHitCallback.html">PxOverlapCallback</a> &hitCall, const <a class="el" href="structPxQueryFilterData.html">PxQueryFilterData</a> &filterData=<a class="el" href="structPxQueryFilterData.html">PxQueryFilterData</a>(), <a class="el" href="classPxQueryFilterCallback.html">PxQueryFilterCallback</a> *filterCall=NULL) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test overlap between a geometry and objects in the cache. <a href="#d339ef9e688aed817333ef1ac78d868c"></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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVolumeCache.html#1fad2b6c49845c49d143151678e01616">~PxVolumeCache</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Volumetric cache for local collision geometry.
<p>
Provides a mechanism for caching objects within a specified volume and performing raycast, sweep, overlap and forEach queries on the cached objects.<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000055">Deprecated:</a></b></dt><dd>The volume cache 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="classPxScene.html#b5921a4665caaa38d0e02d9324b77c7c" title="Creates a volume cache. See the Guide, "Scene Queries" section, "Volume...">PxScene.createVolumeCache()</a> </dd></dl>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="43e58f6fea62f6ec81827e2f251912f5"></a><!-- doxytag: member="PxVolumeCache::FillStatus" ref="43e58f6fea62f6ec81827e2f251912f5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classPxVolumeCache.html#43e58f6fea62f6ec81827e2f251912f5">PxVolumeCache::FillStatus</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
describes <a class="el" href="classPxVolumeCache.html#046b0c5bed6e6f0dad3696cc9b69ed17" title="Fills the cache with objects intersecting the specified cacheVolume.">fill()</a> return status.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVolumeCache.html#046b0c5bed6e6f0dad3696cc9b69ed17" title="Fills the cache with objects intersecting the specified cacheVolume.">PxVolumeCache.fill()</a> </dd></dl>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="43e58f6fea62f6ec81827e2f251912f505556701b332b57b8899a95c431d8b56"></a><!-- doxytag: member="FILL_OK" ref="43e58f6fea62f6ec81827e2f251912f505556701b332b57b8899a95c431d8b56" args="" -->FILL_OK</em> </td><td>
Cache <a class="el" href="classPxVolumeCache.html#046b0c5bed6e6f0dad3696cc9b69ed17" title="Fills the cache with objects intersecting the specified cacheVolume.">fill()</a> operation was successful, the cache is valid and had enough capacity to store all the objects within the specified cacheVolume. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="43e58f6fea62f6ec81827e2f251912f54a3175a948c5e06d6a2c2f44495a6f95"></a><!-- doxytag: member="FILL_OVER_MAX_COUNT" ref="43e58f6fea62f6ec81827e2f251912f54a3175a948c5e06d6a2c2f44495a6f95" args="" -->FILL_OVER_MAX_COUNT</em> </td><td>
Over specified cache capacity.
<p>
Cache <a class="el" href="classPxVolumeCache.html#046b0c5bed6e6f0dad3696cc9b69ed17" title="Fills the cache with objects intersecting the specified cacheVolume.">fill()</a> was over max count specified in <a class="el" href="classPxScene.html#b5921a4665caaa38d0e02d9324b77c7c" title="Creates a volume cache. See the Guide, "Scene Queries" section, "Volume...">PxScene.createVolumeCache()</a> or <a class="el" href="classPxVolumeCache.html#7c239abc1d93b2dea0cec7ae68d93319" title="Sets the limit on the maximum number of static shapes allowed to be stored in the...">setMaxNbStaticShapes()</a> and <a class="el" href="classPxVolumeCache.html#30048238aa971768c4bf24c56d186d7c" title="Sets the limit on the maximum number of dynamic shapes allowed to be stored in the...">setMaxNbDynamicShapes()</a>. If this value is returned the cache will be in invalid state (no caching), but all the queries will still return correct results within the specified cache volume.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxScene.html#b5921a4665caaa38d0e02d9324b77c7c" title="Creates a volume cache. See the Guide, "Scene Queries" section, "Volume...">PxScene.createVolumeCache()</a> <a class="el" href="classPxVolumeCache.html#7c239abc1d93b2dea0cec7ae68d93319" title="Sets the limit on the maximum number of static shapes allowed to be stored in the...">setMaxNbStaticShapes()</a> <a class="el" href="classPxVolumeCache.html#30048238aa971768c4bf24c56d186d7c" title="Sets the limit on the maximum number of dynamic shapes allowed to be stored in the...">setMaxNbDynamicShapes()</a> </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="43e58f6fea62f6ec81827e2f251912f536f4ffaf326d5f4fc310fd0a8676e6f3"></a><!-- doxytag: member="FILL_UNSUPPORTED_GEOMETRY_TYPE" ref="43e58f6fea62f6ec81827e2f251912f536f4ffaf326d5f4fc310fd0a8676e6f3" args="" -->FILL_UNSUPPORTED_GEOMETRY_TYPE</em> </td><td>
Unsupported geometry type.
<p>
The geometry type of cacheVolume parameter provided to <a class="el" href="classPxVolumeCache.html#046b0c5bed6e6f0dad3696cc9b69ed17" title="Fills the cache with objects intersecting the specified cacheVolume.">fill()</a> is not supported. Supported types are sphere, box, capsule. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="43e58f6fea62f6ec81827e2f251912f5cbdc57f8bf59feec81f31871969c8c1e"></a><!-- doxytag: member="FILL_OUT_OF_MEMORY" ref="43e58f6fea62f6ec81827e2f251912f5cbdc57f8bf59feec81f31871969c8c1e" args="" -->FILL_OUT_OF_MEMORY</em> </td><td>
Cache <a class="el" href="classPxVolumeCache.html#046b0c5bed6e6f0dad3696cc9b69ed17" title="Fills the cache with objects intersecting the specified cacheVolume.">fill()</a> ran out of temporary memory for intermediate results, try reducing the cache size. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="1fad2b6c49845c49d143151678e01616"></a><!-- doxytag: member="PxVolumeCache::~PxVolumeCache" ref="1fad2b6c49845c49d143151678e01616" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxVolumeCache::~PxVolumeCache </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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="046b0c5bed6e6f0dad3696cc9b69ed17"></a><!-- doxytag: member="PxVolumeCache::fill" ref="046b0c5bed6e6f0dad3696cc9b69ed17" args="(const PxGeometry &cacheVolume, const PxTransform &pose)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classPxVolumeCache.html#43e58f6fea62f6ec81827e2f251912f5">FillStatus</a> PxVolumeCache::fill </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classPxGeometry.html">PxGeometry</a> & </td>
<td class="paramname"> <em>cacheVolume</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> & </td>
<td class="paramname"> <em>pose</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fills the cache with objects intersecting the specified cacheVolume.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>cacheVolume</em> </td><td>Geometry of the cached volume (supported types are: sphere, box, capsule). </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pose</em> </td><td>Pose of the cache volume.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a <a class="el" href="classPxVolumeCache.html#43e58f6fea62f6ec81827e2f251912f5" title="describes fill() return status.">FillStatus</a> enum.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVolumeCache.html#43e58f6fea62f6ec81827e2f251912f5" title="describes fill() return status.">PxVolumeCache.FillStatus</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="e589287aa090d15e8bd13efd7a80285b"></a><!-- doxytag: member="PxVolumeCache::forEach" ref="e589287aa090d15e8bd13efd7a80285b" args="(Iterator &iter)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxVolumeCache::forEach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structPxVolumeCache_1_1Iterator.html">Iterator</a> & </td>
<td class="paramname"> <em>iter</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Iterates over the scene shapes overlapping with the cache volume.
<p>
forEach will invoke <a class="el" href="structPxVolumeCache_1_1Iterator.html#865f03b842d2e74a249ed840435d17a9" title="Reports cache contents to the user.">PxVolumeCache::Iterator::processShapes</a> virtual function, returning all overlapping shapes (possibly by issuing multiple callbacks) to the user. The size of reported blocks can change depending on internal SDK implementation. Any pointers to the contents of the buffer are only valid within the scope of a single processShapes() callback function. If forEach is invoked on an invalid cache (empty or out of date), this call will attempt to refill the cache within specified capacity. If the cache is over capacity, an attempt will be made to allocate a temp internal buffer, retrieve the results directly from the scene and return to the user via provided iterator. Results from forEach will be current for the last set cacheVolume provided in <a class="el" href="classPxVolumeCache.html#046b0c5bed6e6f0dad3696cc9b69ed17" title="Fills the cache with objects intersecting the specified cacheVolume.">fill()</a> even if the cache is invalid and refill fails. If the number of overlapping shapes is so high that the internal temporary allocation fails this call will produce an error and return.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>iter</em> </td><td><a class="el" href="structPxVolumeCache_1_1Iterator.html" title="A callback wrapper class for use with PxVolumeCache::forEach function.">Iterator</a> callback. <a class="el" href="classPxVolumeCache.html#e589287aa090d15e8bd13efd7a80285b" title="Iterates over the scene shapes overlapping with the cache volume.">forEach()</a> will invokes iter.shapes() function (possibly multiple times) to return blocks of actor+shape pairs overlapped with cacheVolume to the user. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="31f69209809698ad305b9ae29b5d2366"></a><!-- doxytag: member="PxVolumeCache::getCacheVolume" ref="31f69209809698ad305b9ae29b5d2366" args="(PxGeometryHolder &resultVolume, PxTransform &resultPose)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxVolumeCache::getCacheVolume </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxGeometryHolder.html">PxGeometryHolder</a> & </td>
<td class="paramname"> <em>resultVolume</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxTransform.html">PxTransform</a> & </td>
<td class="paramname"> <em>resultPose</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves the last cached volume geometry.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the cache wasn't previously filled. True otherwise with cacheVolume from the last <a class="el" href="classPxVolumeCache.html#046b0c5bed6e6f0dad3696cc9b69ed17" title="Fills the cache with objects intersecting the specified cacheVolume.">fill()</a> call returned in resultVolume and corresponding transform in resultPose.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVolumeCache.html#046b0c5bed6e6f0dad3696cc9b69ed17" title="Fills the cache with objects intersecting the specified cacheVolume.">fill()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="721bd8c6edc998ad2fd2b113c4acb1a4"></a><!-- doxytag: member="PxVolumeCache::getMaxNbDynamicShapes" ref="721bd8c6edc998ad2fd2b113c4acb1a4" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxVolumeCache::getMaxNbDynamicShapes </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the current maximum number of dynamic cached shapes.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The max number of cached dynamics. </dd></dl>
</div>
</div><p>
<a class="anchor" name="daf05a6049d5f282069ab2d666fdc911"></a><!-- doxytag: member="PxVolumeCache::getMaxNbStaticShapes" ref="daf05a6049d5f282069ab2d666fdc911" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxVolumeCache::getMaxNbStaticShapes </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the current maximum number of static cached shapes.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The max number of cached statics. </dd></dl>
</div>
</div><p>
<a class="anchor" name="cd8687904f29300ec7a27222f8db50bf"></a><!-- doxytag: member="PxVolumeCache::getNbCachedShapes" ref="cd8687904f29300ec7a27222f8db50bf" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxI32 PxVolumeCache::getNbCachedShapes </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the total number of cached shapes.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of shapes stored in the cache (statics+dynamics). Returns -1 if the cache is invalid. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a5f2d9a1fcd27838188f4da17ae03dd8"></a><!-- doxytag: member="PxVolumeCache::invalidate" ref="a5f2d9a1fcd27838188f4da17ae03dd8" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxVolumeCache::invalidate </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Invalidates the cache.
<p>
Marks the cache as invalid. Subsequent query will attempt to refill the cache from the scene.
</div>
</div><p>
<a class="anchor" name="f151c4569e890ee2b36b1c9ad0da348f"></a><!-- doxytag: member="PxVolumeCache::isValid" ref="f151c4569e890ee2b36b1c9ad0da348f" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxVolumeCache::isValid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks if the cache is valid (not over specified max capacity, for both statics and dynamics) and up-to-date.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the cache is valid and up-to-date. Cache can become out-of-date if any statics or dynamics are moved or added or deleted from the scene.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVolumeCache.html#43e58f6fea62f6ec81827e2f251912f5" title="describes fill() return status.">PxVolumeCache.FillStatus</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="d339ef9e688aed817333ef1ac78d868c"></a><!-- doxytag: member="PxVolumeCache::overlap" ref="d339ef9e688aed817333ef1ac78d868c" args="(const PxGeometry &geometry, const PxTransform &pose, PxOverlapCallback &hitCall, const PxQueryFilterData &filterData=PxQueryFilterData(), PxQueryFilterCallback *filterCall=NULL) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxVolumeCache::overlap </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classPxGeometry.html">PxGeometry</a> & </td>
<td class="paramname"> <em>geometry</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> & </td>
<td class="paramname"> <em>pose</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structPxHitCallback.html">PxOverlapCallback</a> & </td>
<td class="paramname"> <em>hitCall</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structPxQueryFilterData.html">PxQueryFilterData</a> & </td>
<td class="paramname"> <em>filterData</em> = <code><a class="el" href="structPxQueryFilterData.html">PxQueryFilterData</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxQueryFilterCallback.html">PxQueryFilterCallback</a> * </td>
<td class="paramname"> <em>filterCall</em> = <code>NULL</code></td><td> </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>
Test overlap between a geometry and objects in the cache.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Filtering: Overlap tests do not distinguish between touching and blocking hit types (see <a class="el" href="structPxQueryHitType.html" title="Classification of scene query hits (intersections).">PxQueryHitType</a>). Both get written to the hit buffer.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>geometry</em> </td><td>Geometry of object to check for overlap (supported types are: box, sphere, capsule, convex). </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pose</em> </td><td>Pose of the object. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>hitCall</em> </td><td>Overlap hit callback or hit buffer object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterData</em> </td><td>Filtering data and simple logic. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterCall</em> </td><td>Custom filtering logic (optional). Only used if the corresponding <a class="el" href="structPxQueryFlag.html" title="Filtering flags for scene queries.">PxQueryFlag</a> flags are set. If NULL, all hits are assumed to overlap. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if a blocking hit was found or any hit was found in case <a class="el" href="structPxQueryFlag.html#2124ff0cff0a021e01e6880a1bba431f2837a6ac649b29ee72af661b65f4d8ab">PxQueryFlag::eANY_HIT</a> flag was specified.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__scenequery.html#g9baa3a8cad31bbb8ef666fe01b3afeb7" title="Overlap query callback.">PxOverlapCallback</a> <a class="el" href="group__scenequery.html#g54a708942a891f3321c2427d5c160750" title="Overlap query buffer.">PxOverlapBuffer</a> <a class="el" href="structPxQueryFilterData.html" title="Scene query filtering data.">PxQueryFilterData</a> <a class="el" href="classPxQueryFilterCallback.html" title="Scene query filtering callbacks.">PxQueryFilterCallback</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="e9feb4df002ccf6a69f1442689f18186"></a><!-- doxytag: member="PxVolumeCache::raycast" ref="e9feb4df002ccf6a69f1442689f18186" args="(const PxVec3 &origin, const PxVec3 &unitDir, const PxReal distance, PxRaycastCallback &hitCall, PxHitFlags hitFlags=PxHitFlags(PxHitFlag::eDEFAULT), const PxQueryFilterData &filterData=PxQueryFilterData(), PxQueryFilterCallback *filterCall=NULL) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxVolumeCache::raycast </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </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> & </td>
<td class="paramname"> <em>unitDir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const PxReal </td>
<td class="paramname"> <em>distance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structPxHitCallback.html">PxRaycastCallback</a> & </td>
<td class="paramname"> <em>hitCall</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PxHitFlags </td>
<td class="paramname"> <em>hitFlags</em> = <code>PxHitFlags(PxHitFlag::eDEFAULT)</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structPxQueryFilterData.html">PxQueryFilterData</a> & </td>
<td class="paramname"> <em>filterData</em> = <code><a class="el" href="structPxQueryFilterData.html">PxQueryFilterData</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxQueryFilterCallback.html">PxQueryFilterCallback</a> * </td>
<td class="paramname"> <em>filterCall</em> = <code>NULL</code></td><td> </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>
Raycast against objects in the cache, returning results via PxRaycastCallback callback or PxRaycastBuffer object or a custom user callback implementation.
<p>
Returns whether any rigid actor is hit along the ray.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Shooting a ray from within an object leads to different results depending on the shape type. Please check the details in user guide article SceneQuery. User can ignore such objects by employing one of the provided filter mechanisms.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>origin</em> </td><td>Origin of the ray. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>unitDir</em> </td><td>Normalized direction of the ray. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>distance</em> </td><td>Length of the ray. Needs to be larger than 0. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>hitCall</em> </td><td>Raycast hit callback or hit buffer object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>hitFlags</em> </td><td>Specifies which properties per hit should be computed and returned via the hit callback. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterData</em> </td><td>Filtering data and simple logic. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterCall</em> </td><td>Custom filtering logic (optional). Only used if the corresponding <a class="el" href="structPxQueryFlag.html" title="Filtering flags for scene queries.">PxQueryFlag</a> flags are set. If NULL, all hits are assumed to be blocking. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if a blocking hit was found or any hit was found in case <a class="el" href="structPxQueryFlag.html#2124ff0cff0a021e01e6880a1bba431f2837a6ac649b29ee72af661b65f4d8ab">PxQueryFlag::eANY_HIT</a> flag was used.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__scenequery.html#g4dbe8142d799492bd8e7c5ec70bfac41" title="Raycast query callback.">PxRaycastCallback</a> <a class="el" href="group__scenequery.html#gb21a68ce9e5a18aa742111920b75a84c" title="Raycast query buffer.">PxRaycastBuffer</a> <a class="el" href="structPxQueryFilterData.html" title="Scene query filtering data.">PxQueryFilterData</a> <a class="el" href="classPxQueryFilterCallback.html" title="Scene query filtering callbacks.">PxQueryFilterCallback</a> <a class="el" href="structPxQueryCache.html" title="single hit cache for scene queries.">PxQueryCache</a> <a class="el" href="structPxRaycastHit.html" title="Stores results of raycast queries.">PxRaycastHit</a> <a class="el" href="structPxQueryFlag.html" title="Filtering flags for scene queries.">PxQueryFlag</a> <a class="el" href="structPxQueryFlag.html#2124ff0cff0a021e01e6880a1bba431f2837a6ac649b29ee72af661b65f4d8ab">PxQueryFlag::eANY_HIT</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="5cf192b373fadb356a2c016717852c4d"></a><!-- doxytag: member="PxVolumeCache::release" ref="5cf192b373fadb356a2c016717852c4d" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxVolumeCache::release </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Releases the cache object and its resources.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxScene.html#b5921a4665caaa38d0e02d9324b77c7c" title="Creates a volume cache. See the Guide, "Scene Queries" section, "Volume...">PxScene.createVolumeCache</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="30048238aa971768c4bf24c56d186d7c"></a><!-- doxytag: member="PxVolumeCache::setMaxNbDynamicShapes" ref="30048238aa971768c4bf24c56d186d7c" args="(PxU32 maxCount)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxVolumeCache::setMaxNbDynamicShapes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>maxCount</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the limit on the maximum number of dynamic shapes allowed to be stored in the cache.
<p>
If the number of cached objects goes over this limit, the query functions (forEach/raycast/sweep/overlap) will fall back to scene queries.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>maxCount</em> </td><td>Maximum number of dynamic shapes cached. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="7c239abc1d93b2dea0cec7ae68d93319"></a><!-- doxytag: member="PxVolumeCache::setMaxNbStaticShapes" ref="7c239abc1d93b2dea0cec7ae68d93319" args="(PxU32 maxCount)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxVolumeCache::setMaxNbStaticShapes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>maxCount</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the limit on the maximum number of static shapes allowed to be stored in the cache.
<p>
If the number of cached objects goes over this limit, the query functions (forEach/raycast/sweep/overlap) will fall back to scene queries.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>maxCount</em> </td><td>Maximum number of static shapes cached. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="86eb361338891b14b27f9d4594b15df8"></a><!-- doxytag: member="PxVolumeCache::sweep" ref="86eb361338891b14b27f9d4594b15df8" args="(const PxGeometry &geometry, const PxTransform &pose, const PxVec3 &unitDir, const PxReal distance, PxSweepCallback &hitCall, PxHitFlags hitFlags=PxHitFlag::eDEFAULT, const PxQueryFilterData &filterData=PxQueryFilterData(), PxQueryFilterCallback *filterCall=NULL, const PxReal inflation=0.f) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxVolumeCache::sweep </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classPxGeometry.html">PxGeometry</a> & </td>
<td class="paramname"> <em>geometry</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> & </td>
<td class="paramname"> <em>pose</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td>
<td class="paramname"> <em>unitDir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const PxReal </td>
<td class="paramname"> <em>distance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structPxHitCallback.html">PxSweepCallback</a> & </td>
<td class="paramname"> <em>hitCall</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PxHitFlags </td>
<td class="paramname"> <em>hitFlags</em> = <code>PxHitFlag::eDEFAULT</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structPxQueryFilterData.html">PxQueryFilterData</a> & </td>
<td class="paramname"> <em>filterData</em> = <code><a class="el" href="structPxQueryFilterData.html">PxQueryFilterData</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxQueryFilterCallback.html">PxQueryFilterCallback</a> * </td>
<td class="paramname"> <em>filterCall</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const PxReal </td>
<td class="paramname"> <em>inflation</em> = <code>0.f</code></td><td> </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>
Sweep against objects in the cache, returning results via PxRaycastCallback callback or PxRaycastBuffer object or a custom user callback implementation.
<p>
Returns whether any rigid actor is hit along the sweep path.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>geometry</em> </td><td>Geometry of object to sweep (supported types are: box, sphere, capsule, convex). </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pose</em> </td><td>Pose of the sweep object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>unitDir</em> </td><td>Normalized direction of the sweep. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>distance</em> </td><td>Sweep distance. Needs to be larger than 0. Will be clamped to PX_MAX_SWEEP_DISTANCE. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>hitCall</em> </td><td>Sweep hit callback or hit buffer object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>hitFlags</em> </td><td>Specifies which properties per hit should be computed and returned via the hit callback. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterData</em> </td><td>Filtering data and simple logic. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filterCall</em> </td><td>Custom filtering logic (optional). Only used if the corresponding <a class="el" href="structPxQueryFlag.html" title="Filtering flags for scene queries.">PxQueryFlag</a> flags are set. If NULL, all hits are assumed to be blocking. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>inflation</em> </td><td>This parameter creates a skin around the swept geometry which increases its extents for sweeping. The sweep will register a hit as soon as the skin touches a shape, and will return the corresponding distance and normal. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if a blocking hit was found or any hit was found in case <a class="el" href="structPxQueryFlag.html#2124ff0cff0a021e01e6880a1bba431f2837a6ac649b29ee72af661b65f4d8ab">PxQueryFlag::eANY_HIT</a> flag was specified.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__scenequery.html#g6f93f556cef747d50f643499928dd865" title="Sweep query callback.">PxSweepCallback</a> <a class="el" href="group__scenequery.html#gecfed2b83a930b922b3d95e22ff30665" title="Sweep query buffer.">PxSweepBuffer</a> <a class="el" href="structPxQueryFilterData.html" title="Scene query filtering data.">PxQueryFilterData</a> <a class="el" href="classPxQueryFilterCallback.html" title="Scene query filtering callbacks.">PxQueryFilterCallback</a> <a class="el" href="structPxSweepHit.html" title="Stores results of sweep queries.">PxSweepHit</a> <a class="el" href="structPxQueryCache.html" title="single hit cache for scene queries.">PxQueryCache</a> PxHitFlags </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxVolumeCache_8h-source.html">PxVolumeCache.h</a></ul>
</div>
<hr style="width: 100%; height: 2px;"><br>
Copyright © 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>
|