blob: 5fedd0395c7657e6a2fca92a944c688dcbfa54a2 (
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
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxObstacleContext 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>PxObstacleContext Class Reference<br>
<small>
[<a class="el" href="group__character.html">Character</a>]</small>
</h1><!-- doxytag: class="PxObstacleContext" -->Context class for obstacles.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxControllerObstacles_8h-source.html">PxControllerObstacles.h</a>></code>
<p>
<p>
<a href="classPxObstacleContext-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#53b1408cf617fc505dc1bbf19f94f1ff">PxObstacleContext</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#df341c13bb11532604ee7012228061f6">~PxObstacleContext</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#af653d99de6f092896cc1baa2a4e99c2">release</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases the context. <a href="#af653d99de6f092896cc1baa2a4e99c2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxControllerManager.html">PxControllerManager</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#9390f860fb489f283c9f872af2777123">getControllerManager</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the controller manager associated with this context. <a href="#9390f860fb489f283c9f872af2777123"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#106c0261677ccf7ef0959e1fde761ef3">addObstacle</a> (const <a class="el" href="classPxObstacle.html">PxObstacle</a> &obstacle)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an obstacle to the context. <a href="#106c0261677ccf7ef0959e1fde761ef3"></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="classPxObstacleContext.html#3ea7ddb35145ea2ca1184ae7d8ce7b15">removeObstacle</a> (<a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> handle)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes an obstacle from the context. <a href="#3ea7ddb35145ea2ca1184ae7d8ce7b15"></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="classPxObstacleContext.html#73ea47d73adaeda1228fd5030ee8cdd2">updateObstacle</a> (<a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> handle, const <a class="el" href="classPxObstacle.html">PxObstacle</a> &obstacle)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Updates data for an existing obstacle. <a href="#73ea47d73adaeda1228fd5030ee8cdd2"></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="classPxObstacleContext.html#e55da4495a10d1c310068e23d87ce7d5">getNbObstacles</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves number of obstacles in the context. <a href="#e55da4495a10d1c310068e23d87ce7d5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classPxObstacle.html">PxObstacle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#228a7b8cb5900251d7888ee0f4d912cd">getObstacle</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> i) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves desired obstacle. <a href="#228a7b8cb5900251d7888ee0f4d912cd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classPxObstacle.html">PxObstacle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#fa8438d6cdc3d82375944d7ca126487a">getObstacleByHandle</a> (<a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> handle) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves desired obstacle by given handle. <a href="#fa8438d6cdc3d82375944d7ca126487a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Context class for obstacles.
<p>
An obstacle context class contains and manages a set of user-defined obstacles.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxObstacle.html" title="A box obstacle.">PxBoxObstacle</a> <a class="el" href="classPxCapsuleObstacle.html" title="A capsule obstacle.">PxCapsuleObstacle</a> <a class="el" href="classPxObstacle.html" title="Base class for obstacles.">PxObstacle</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="53b1408cf617fc505dc1bbf19f94f1ff"></a><!-- doxytag: member="PxObstacleContext::PxObstacleContext" ref="53b1408cf617fc505dc1bbf19f94f1ff" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxObstacleContext::PxObstacleContext </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="df341c13bb11532604ee7012228061f6"></a><!-- doxytag: member="PxObstacleContext::~PxObstacleContext" ref="df341c13bb11532604ee7012228061f6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxObstacleContext::~PxObstacleContext </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="106c0261677ccf7ef0959e1fde761ef3"></a><!-- doxytag: member="PxObstacleContext::addObstacle" ref="106c0261677ccf7ef0959e1fde761ef3" args="(const PxObstacle &obstacle)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> PxObstacleContext::addObstacle </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classPxObstacle.html">PxObstacle</a> & </td>
<td class="paramname"> <em>obstacle</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds an obstacle to the context.
<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>obstacle</em> </td><td>Obstacle data for the new obstacle. The data gets copied.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Handle for newly-added obstacle </dd></dl>
</div>
</div><p>
<a class="anchor" name="9390f860fb489f283c9f872af2777123"></a><!-- doxytag: member="PxObstacleContext::getControllerManager" ref="9390f860fb489f283c9f872af2777123" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classPxControllerManager.html">PxControllerManager</a>& PxObstacleContext::getControllerManager </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves the controller manager associated with this context.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The associated controller manager </dd></dl>
</div>
</div><p>
<a class="anchor" name="e55da4495a10d1c310068e23d87ce7d5"></a><!-- doxytag: member="PxObstacleContext::getNbObstacles" ref="e55da4495a10d1c310068e23d87ce7d5" args="() const =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> PxObstacleContext::getNbObstacles </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves number of obstacles in the context.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of obstacles in the context </dd></dl>
</div>
</div><p>
<a class="anchor" name="228a7b8cb5900251d7888ee0f4d912cd"></a><!-- doxytag: member="PxObstacleContext::getObstacle" ref="228a7b8cb5900251d7888ee0f4d912cd" args="(PxU32 i) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classPxObstacle.html">PxObstacle</a>* PxObstacleContext::getObstacle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves desired obstacle.
<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>i</em> </td><td>Obstacle index</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Desired obstacle </dd></dl>
</div>
</div><p>
<a class="anchor" name="fa8438d6cdc3d82375944d7ca126487a"></a><!-- doxytag: member="PxObstacleContext::getObstacleByHandle" ref="fa8438d6cdc3d82375944d7ca126487a" args="(ObstacleHandle handle) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classPxObstacle.html">PxObstacle</a>* PxObstacleContext::getObstacleByHandle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> </td>
<td class="paramname"> <em>handle</em> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves desired obstacle by given handle.
<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>handle</em> </td><td>Obstacle handle</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Desired obstacle </dd></dl>
</div>
</div><p>
<a class="anchor" name="af653d99de6f092896cc1baa2a4e99c2"></a><!-- doxytag: member="PxObstacleContext::release" ref="af653d99de6f092896cc1baa2a4e99c2" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxObstacleContext::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 context.
<p>
</div>
</div><p>
<a class="anchor" name="3ea7ddb35145ea2ca1184ae7d8ce7b15"></a><!-- doxytag: member="PxObstacleContext::removeObstacle" ref="3ea7ddb35145ea2ca1184ae7d8ce7b15" args="(ObstacleHandle handle)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxObstacleContext::removeObstacle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> </td>
<td class="paramname"> <em>handle</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Removes an obstacle from the context.
<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>handle</em> </td><td>Handle for the obstacle object that needs to be removed.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if success </dd></dl>
</div>
</div><p>
<a class="anchor" name="73ea47d73adaeda1228fd5030ee8cdd2"></a><!-- doxytag: member="PxObstacleContext::updateObstacle" ref="73ea47d73adaeda1228fd5030ee8cdd2" args="(ObstacleHandle handle, const PxObstacle &obstacle)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxObstacleContext::updateObstacle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxObstacle.html">PxObstacle</a> & </td>
<td class="paramname"> <em>obstacle</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>
Updates data for an existing obstacle.
<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>handle</em> </td><td>Handle for the obstacle object that needs to be updated. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>obstacle</em> </td><td>New obstacle data</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if success </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxControllerObstacles_8h-source.html">PxControllerObstacles.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>
|