aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/structPxVolumeCache_1_1Iterator.html
blob: 7cb9981c8c805107665860e711c7843b826b242b (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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVolumeCache::PxVolumeCache::Iterator Struct 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="navpath"><a class="el" href="classPxVolumeCache.html">PxVolumeCache</a>::<a class="el" href="structPxVolumeCache_1_1Iterator.html">Iterator</a>
  </div>
<div class="contents">
<h1>PxVolumeCache::PxVolumeCache::Iterator Struct Reference</h1><!-- doxytag: class="PxVolumeCache::Iterator" -->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="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxVolumeCache_8h-source.html">PxVolumeCache.h</a>&gt;</code>
<p>

<p>
<a href="structPxVolumeCache_1_1Iterator-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 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxVolumeCache_1_1Iterator.html#865f03b842d2e74a249ed840435d17a9">processShapes</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> count, const <a class="el" href="structPxActorShape.html">PxActorShape</a> *actorShapePairs)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reports cache contents to the user.  <a href="#865f03b842d2e74a249ed840435d17a9"></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="structPxVolumeCache_1_1Iterator.html#1ef5a224b3c176a16c68eaf495e6ee01">finalizeQuery</a> ()</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="structPxVolumeCache_1_1Iterator.html#01da91983bd08226ed3de46111bedfc2">~Iterator</a> ()</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
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. 
<p>
Works in tandem with <a class="el" href="classPxVolumeCache.html#e589287aa090d15e8bd13efd7a80285b" title="Iterates over the scene shapes overlapping with the cache volume.">forEach()</a>. Used to return shapes overlapping with the cache volume (set using the last <a class="el" href="classPxVolumeCache.html#046b0c5bed6e6f0dad3696cc9b69ed17" title="Fills the cache with objects intersecting the specified cacheVolume.">fill()</a> call) to the user.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVolumeCache.html#e589287aa090d15e8bd13efd7a80285b" title="Iterates over the scene shapes overlapping with the cache volume.">PxVolumeCache::forEach</a> </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="01da91983bd08226ed3de46111bedfc2"></a><!-- doxytag: member="PxVolumeCache::Iterator::~Iterator" ref="01da91983bd08226ed3de46111bedfc2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxVolumeCache::PxVolumeCache::Iterator::~Iterator           </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="1ef5a224b3c176a16c68eaf495e6ee01"></a><!-- doxytag: member="PxVolumeCache::Iterator::finalizeQuery" ref="1ef5a224b3c176a16c68eaf495e6ee01" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxVolumeCache::PxVolumeCache::Iterator::finalizeQuery           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
/brief Called after the last processShapes was called.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxVolumeCache_1_1Iterator.html#865f03b842d2e74a249ed840435d17a9" title="Reports cache contents to the user.">PxVolumeCache::Iterator::processShapes</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="865f03b842d2e74a249ed840435d17a9"></a><!-- doxytag: member="PxVolumeCache::Iterator::processShapes" ref="865f03b842d2e74a249ed840435d17a9" args="(PxU32 count, const PxActorShape *actorShapePairs)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxVolumeCache::PxVolumeCache::Iterator::processShapes           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td>
          <td class="paramname"> <em>count</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structPxActorShape.html">PxActorShape</a> *&nbsp;</td>
          <td class="paramname"> <em>actorShapePairs</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>
Reports cache contents to the user. 
<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>count</em>&nbsp;</td><td>The number of shapes returned with this call. </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>actorShapePairs</em>&nbsp;</td><td>Array of <a class="el" href="structPxActorShape.html" title="collection of set bits defined in PxHitFlag.">PxActorShape</a> pairs.</td></tr>
  </table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVolumeCache.html#e589287aa090d15e8bd13efd7a80285b" title="Iterates over the scene shapes overlapping with the cache volume.">PxVolumeCache::forEach</a> </dd></dl>

</div>
</div><p>
<hr>The documentation for this struct 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 &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>