PhysX_3.4/Documentation/PhysXAPI/files/structPxBatchQueryResult.html


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

<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBatchQueryResult&lt; HitType &gt; Struct Template 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>PxBatchQueryResult&lt; HitType &gt; Struct Template Reference<br>
<small>
[<a class="el" href="group__physics.html">Physics</a>]</small>
</h1><!-- doxytag: class="PxBatchQueryResult" -->Generic struct for receiving results of single query in a batch. Gets templated on hit type <a class="el" href="structPxRaycastHit.html" title="Stores results of raycast queries.">PxRaycastHit</a>, <a class="el" href="structPxSweepHit.html" title="Stores results of sweep queries.">PxSweepHit</a> or <a class="el" href="structPxOverlapHit.html" title="Stores results of overlap queries.">PxOverlapHit</a>.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxBatchQueryDesc_8h-source.html">PxBatchQueryDesc.h</a>&gt;</code>
<p>
<div class="dynheader">
Collaboration diagram for PxBatchQueryResult&lt; HitType &gt;:</div>
<div class="dynsection">
<p><center><img src="structPxBatchQueryResult__coll__graph.png" border="0" usemap="#PxBatchQueryResult_3_01HitType_01_4__coll__map" alt="Collaboration graph"></center>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structPxBatchQueryResult-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 <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#c6a60639763e94b658edf5c3eb4c21aa">getNbAnyHits</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Computes the number of any hits in this result, blocking or touching.  <a href="#c6a60639763e94b658edf5c3eb4c21aa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE const HitType &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#7ec0ebeebc65930db22f2c2cdd7af6ce">getAnyHit</a> (const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> index) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convenience iterator used to access any hits in this result, blocking or touching.  <a href="#7ec0ebeebc65930db22f2c2cdd7af6ce"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">HitType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#a91f15d629285e2471fcbb039af1d17b">block</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds the closest blocking hit for a single query in a batch. Only valid if hasBlock is true.  <a href="#a91f15d629285e2471fcbb039af1d17b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">HitType *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#4b4cabd4f1a5befef4a55048854d1a68">touches</a></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="structPxBatchQueryResult.html#ac884d117477c6f480d9ceb53d229ead">nbTouches</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of touching hits returned by this query, works in tandem with touches pointer.  <a href="#ac884d117477c6f480d9ceb53d229ead"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#1fc4664be9c55e563e5ba65b0071ee89">userData</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy of the userData pointer specified in the corresponding query.  <a href="#1fc4664be9c55e563e5ba65b0071ee89"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxU8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#db01163e07196e8a4867f4b5d4c8752d">queryStatus</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Takes on values from <a class="el" href="structPxBatchQueryStatus.html#65079b6fb3edafc98c6101bd6bc9b306">PxBatchQueryStatus::Enum</a>.  <a href="#db01163e07196e8a4867f4b5d4c8752d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#35efe4f4170d5b2ee88a42f1618644d4">hasBlock</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if there was a blocking hit.  <a href="#35efe4f4170d5b2ee88a42f1618644d4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxU16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#d0b4a79dc77732dc7bbe5c56f50bd4a6">pad</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">pads the struct to 16 bytes.  <a href="#d0b4a79dc77732dc7bbe5c56f50bd4a6"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename HitType&gt;<br>
 struct PxBatchQueryResult&lt; HitType &gt;</h3>

Generic struct for receiving results of single query in a batch. Gets templated on hit type <a class="el" href="structPxRaycastHit.html" title="Stores results of raycast queries.">PxRaycastHit</a>, <a class="el" href="structPxSweepHit.html" title="Stores results of sweep queries.">PxSweepHit</a> or <a class="el" href="structPxOverlapHit.html" title="Stores results of overlap queries.">PxOverlapHit</a>. 
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>The batched query feature has been deprecated in PhysX version 3.4 </dd></dl>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7ec0ebeebc65930db22f2c2cdd7af6ce"></a><!-- doxytag: member="PxBatchQueryResult::getAnyHit" ref="7ec0ebeebc65930db22f2c2cdd7af6ce" args="(const PxU32 index) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">PX_INLINE const HitType&amp; <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::getAnyHit           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>&nbsp;</td>
          <td class="paramname"> <em>index</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Convenience iterator used to access any hits in this result, blocking or touching. 
<p>

<p>References <a class="el" href="PxAssert_8h-source.html#l00061">PX_ASSERT</a>.</p>

</div>
</div><p>
<a class="anchor" name="c6a60639763e94b658edf5c3eb4c21aa"></a><!-- doxytag: member="PxBatchQueryResult::getNbAnyHits" ref="c6a60639763e94b658edf5c3eb4c21aa" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">PX_INLINE <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::getNbAnyHits           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Computes the number of any hits in this result, blocking or touching. 
<p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="a91f15d629285e2471fcbb039af1d17b"></a><!-- doxytag: member="PxBatchQueryResult::block" ref="a91f15d629285e2471fcbb039af1d17b" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">HitType <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::<a class="el" href="structPxBatchQueryResult.html#a91f15d629285e2471fcbb039af1d17b">block</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Holds the closest blocking hit for a single query in a batch. Only valid if hasBlock is true. 
<p>

</div>
</div><p>
<a class="anchor" name="35efe4f4170d5b2ee88a42f1618644d4"></a><!-- doxytag: member="PxBatchQueryResult::hasBlock" ref="35efe4f4170d5b2ee88a42f1618644d4" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::<a class="el" href="structPxBatchQueryResult.html#35efe4f4170d5b2ee88a42f1618644d4">hasBlock</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
True if there was a blocking hit. 
<p>

</div>
</div><p>
<a class="anchor" name="ac884d117477c6f480d9ceb53d229ead"></a><!-- doxytag: member="PxBatchQueryResult::nbTouches" ref="ac884d117477c6f480d9ceb53d229ead" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::<a class="el" href="structPxBatchQueryResult.html#ac884d117477c6f480d9ceb53d229ead">nbTouches</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Number of touching hits returned by this query, works in tandem with touches pointer. 
<p>

</div>
</div><p>
<a class="anchor" name="d0b4a79dc77732dc7bbe5c56f50bd4a6"></a><!-- doxytag: member="PxBatchQueryResult::pad" ref="d0b4a79dc77732dc7bbe5c56f50bd4a6" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">PxU16 <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::<a class="el" href="structPxBatchQueryResult.html#d0b4a79dc77732dc7bbe5c56f50bd4a6">pad</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
pads the struct to 16 bytes. 
<p>

</div>
</div><p>
<a class="anchor" name="db01163e07196e8a4867f4b5d4c8752d"></a><!-- doxytag: member="PxBatchQueryResult::queryStatus" ref="db01163e07196e8a4867f4b5d4c8752d" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">PxU8 <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::<a class="el" href="structPxBatchQueryResult.html#db01163e07196e8a4867f4b5d4c8752d">queryStatus</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Takes on values from <a class="el" href="structPxBatchQueryStatus.html#65079b6fb3edafc98c6101bd6bc9b306">PxBatchQueryStatus::Enum</a>. 
<p>

</div>
</div><p>
<a class="anchor" name="4b4cabd4f1a5befef4a55048854d1a68"></a><!-- doxytag: member="PxBatchQueryResult::touches" ref="4b4cabd4f1a5befef4a55048854d1a68" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">HitType* <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::<a class="el" href="structPxBatchQueryResult.html#4b4cabd4f1a5befef4a55048854d1a68">touches</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
This pointer will either be set to NULL for 0 nbTouches or will point into the user provided batch query results buffer specified in <a class="el" href="classPxBatchQueryDesc.html" title="Descriptor class for PxBatchQuery.">PxBatchQueryDesc</a>. 
</div>
</div><p>
<a class="anchor" name="1fc4664be9c55e563e5ba65b0071ee89"></a><!-- doxytag: member="PxBatchQueryResult::userData" ref="1fc4664be9c55e563e5ba65b0071ee89" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void* <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::<a class="el" href="structPxBatchQueryResult.html#1fc4664be9c55e563e5ba65b0071ee89">userData</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Copy of the userData pointer specified in the corresponding query. 
<p>

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