aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxPrismaticJoint.html
blob: ed97738c75e0fe89343f38d0f4f4dc004c80fe3e (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
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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxPrismaticJoint 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>PxPrismaticJoint Class Reference<br>
<small>
[<a class="el" href="group__extensions.html">Extensions</a>]</small>
</h1><!-- doxytag: class="PxPrismaticJoint" --><!-- doxytag: inherits="PxJoint" -->A prismatic joint permits relative translational movement between two bodies along an axis, but no relative rotational movement.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxPrismaticJoint_8h-source.html">PxPrismaticJoint.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for PxPrismaticJoint:</div>
<div class="dynsection">
<p><center><img src="classPxPrismaticJoint__inherit__graph.png" border="0" usemap="#PxPrismaticJoint__inherit__map" alt="Inheritance graph"></center>
<map name="PxPrismaticJoint__inherit__map">
<area shape="rect" href="classPxJoint.html" title="a base interface providing common functionality for PhysX joints" alt="PxJoint" coords="32,85,85,106"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="31,16,87,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxPrismaticJoint:</div>
<div class="dynsection">
<p><center><img src="classPxPrismaticJoint__coll__graph.png" border="0" usemap="#PxPrismaticJoint__coll__map" alt="Collaboration graph"></center>
<map name="PxPrismaticJoint__coll__map">
<area shape="rect" href="classPxJoint.html" title="a base interface providing common functionality for PhysX joints" alt="PxJoint" coords="99,178,152,200"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="97,106,153,128"><area shape="rect" href="classPxFlags.html" title="PxFlags\&lt; PxBaseFlag::Enum, PxU16 \&gt;" alt="PxFlags\&lt; PxBaseFlag::Enum, PxU16 \&gt;" coords="7,16,244,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classPxPrismaticJoint-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 PxReal&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPrismaticJoint.html#e4dc657df18bfc45e2dc0e21185532c2">getPosition</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns the displacement of the joint along its axis.  <a href="#e4dc657df18bfc45e2dc0e21185532c2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPrismaticJoint.html#672173b63a47773178dc275b96ba1f46">getVelocity</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns the velocity of the joint along its axis  <a href="#672173b63a47773178dc275b96ba1f46"></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="classPxPrismaticJoint.html#7831c090d462d38eb7ba8e2fd25bc751">setLimit</a> (const <a class="el" href="classPxJointLinearLimitPair.html">PxJointLinearLimitPair</a> &amp;)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">sets the joint limit parameters.  <a href="#7831c090d462d38eb7ba8e2fd25bc751"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxJointLinearLimitPair.html">PxJointLinearLimitPair</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPrismaticJoint.html#89eba64a796788bd9be24c4d85eaf7f9">getLimit</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">gets the joint limit parameters.  <a href="#89eba64a796788bd9be24c4d85eaf7f9"></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="classPxPrismaticJoint.html#0041ced8b6962072214dc81032ed2a2d">setPrismaticJointFlags</a> (<a class="el" href="classPxFlags.html">PxPrismaticJointFlags</a> flags)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the flags specific to the Prismatic Joint.  <a href="#0041ced8b6962072214dc81032ed2a2d"></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="classPxPrismaticJoint.html#6d20577d885f919eeee64e9daba76679">setPrismaticJointFlag</a> (<a class="el" href="structPxPrismaticJointFlag.html#d175483117d7036cc021df8ac7dc15f4">PxPrismaticJointFlag::Enum</a> flag, bool value)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a single flag specific to a Prismatic Joint to true or false.  <a href="#6d20577d885f919eeee64e9daba76679"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxFlags.html">PxPrismaticJointFlags</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPrismaticJoint.html#536fe595cc77afd12f0f18a44005dbf7">getPrismaticJointFlags</a> (void) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the flags specific to the Prismatic Joint.  <a href="#536fe595cc77afd12f0f18a44005dbf7"></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="classPxPrismaticJoint.html#01d904a1fd7a2394c44ee39efcbdd6f2">setProjectionLinearTolerance</a> (PxReal tolerance)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the linear tolerance threshold for projection.  <a href="#01d904a1fd7a2394c44ee39efcbdd6f2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPrismaticJoint.html#ea99524ff17e5044d737a2c6c4ebc8c8">getProjectionLinearTolerance</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the linear tolerance threshold for projection.  <a href="#ea99524ff17e5044d737a2c6c4ebc8c8"></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="classPxPrismaticJoint.html#f1a04172a838d1a1ee741d7471f4d62d">setProjectionAngularTolerance</a> (PxReal tolerance)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the angular tolerance threshold for projection. Projection is enabled if <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc34272d3f8e02cd1fa3a41256d186a0a38ebf" title="whether the actors should get projected for this constraint (the direction will be...">PxConstraintFlag::ePROJECTION</a> is set for the joint.  <a href="#f1a04172a838d1a1ee741d7471f4d62d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPrismaticJoint.html#c33eddce826faaf19778cf407206ee60">getProjectionAngularTolerance</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the angular tolerance threshold for projection.  <a href="#c33eddce826faaf19778cf407206ee60"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPrismaticJoint.html#cb93acd1e07a8dfbd49b78651b8d17e0">getConcreteTypeName</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns string name of <a class="el" href="classPxPrismaticJoint.html" title="A prismatic joint permits relative translational movement between two bodies along...">PxPrismaticJoint</a>, used for serialization.  <a href="#cb93acd1e07a8dfbd49b78651b8d17e0"></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">PX_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPrismaticJoint.html#fa9275b9e82afed2d12e8bbd20c318ff">PxPrismaticJoint</a> (<a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> concreteType, <a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#fa9275b9e82afed2d12e8bbd20c318ff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPrismaticJoint.html#d4a9313121cdcf91169165e88f41c0aa">PxPrismaticJoint</a> (<a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deserialization constructor.  <a href="#d4a9313121cdcf91169165e88f41c0aa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPrismaticJoint.html#78899fed02686ce4b734cf07a801896d">isKindOf</a> (const char *name) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether a given type name matches with the type of this instance.  <a href="#78899fed02686ce4b734cf07a801896d"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A prismatic joint permits relative translational movement between two bodies along an axis, but no relative rotational movement. 
<p>
the axis on each body is defined as the line containing the origin of the joint frame and extending along the x-axis of that frame<p>
<div align="center">
<img src="prismJoint.png" alt="prismJoint.png">
</div>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__extensions.html#gef94272b3a37bbcce4008c1911a06b5c" title="Create a prismatic joint.">PxPrismaticJointCreate()</a> <a class="el" href="classPxJoint.html" title="a base interface providing common functionality for PhysX joints">PxJoint</a> </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="fa9275b9e82afed2d12e8bbd20c318ff"></a><!-- doxytag: member="PxPrismaticJoint::PxPrismaticJoint" ref="fa9275b9e82afed2d12e8bbd20c318ff" args="(PxType concreteType, PxBaseFlags baseFlags)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_INLINE PxPrismaticJoint::PxPrismaticJoint           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a>&nbsp;</td>
          <td class="paramname"> <em>concreteType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a>&nbsp;</td>
          <td class="paramname"> <em>baseFlags</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor. 
<p>

</div>
</div><p>
<a class="anchor" name="d4a9313121cdcf91169165e88f41c0aa"></a><!-- doxytag: member="PxPrismaticJoint::PxPrismaticJoint" ref="d4a9313121cdcf91169165e88f41c0aa" args="(PxBaseFlags baseFlags)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_INLINE PxPrismaticJoint::PxPrismaticJoint           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a>&nbsp;</td>
          <td class="paramname"> <em>baseFlags</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Deserialization constructor. 
<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="cb93acd1e07a8dfbd49b78651b8d17e0"></a><!-- doxytag: member="PxPrismaticJoint::getConcreteTypeName" ref="cb93acd1e07a8dfbd49b78651b8d17e0" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* PxPrismaticJoint::getConcreteTypeName           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns string name of <a class="el" href="classPxPrismaticJoint.html" title="A prismatic joint permits relative translational movement between two bodies along...">PxPrismaticJoint</a>, used for serialization. 
<p>

<p>Implements <a class="el" href="classPxBase.html#67fe206d8897ddce896c371ac8d789a9">PxBase</a>.</p>

</div>
</div><p>
<a class="anchor" name="89eba64a796788bd9be24c4d85eaf7f9"></a><!-- doxytag: member="PxPrismaticJoint::getLimit" ref="89eba64a796788bd9be24c4d85eaf7f9" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classPxJointLinearLimitPair.html">PxJointLinearLimitPair</a> PxPrismaticJoint::getLimit           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
gets the joint limit parameters. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJointLinearLimit.html" title="Describes a one-sided linear limit.">PxJointLinearLimit</a> <a class="el" href="classPxPrismaticJoint.html#89eba64a796788bd9be24c4d85eaf7f9" title="gets the joint limit parameters.">getLimit()</a> </dd></dl>

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

<p>
returns the displacement of the joint along its axis. 
<p>

</div>
</div><p>
<a class="anchor" name="536fe595cc77afd12f0f18a44005dbf7"></a><!-- doxytag: member="PxPrismaticJoint::getPrismaticJointFlags" ref="536fe595cc77afd12f0f18a44005dbf7" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classPxFlags.html">PxPrismaticJointFlags</a> PxPrismaticJoint::getPrismaticJointFlags           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the flags specific to the Prismatic Joint. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the joint flags</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd>PxPrismaticJoint::flags, <a class="el" href="structPxPrismaticJointFlag.html" title="Flags specific to the prismatic joint.">PxPrismaticJointFlag</a> setFlag() setFlags() </dd></dl>

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

<p>
Get the angular tolerance threshold for projection. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxPrismaticJoint.html#c33eddce826faaf19778cf407206ee60" title="Get the angular tolerance threshold for projection.">getProjectionAngularTolerance()</a> </dd></dl>

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

<p>
Get the linear tolerance threshold for projection. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the linear tolerance threshold in radians</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxPrismaticJoint.html#01d904a1fd7a2394c44ee39efcbdd6f2" title="Set the linear tolerance threshold for projection.">setProjectionLinearTolerance()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="672173b63a47773178dc275b96ba1f46"></a><!-- doxytag: member="PxPrismaticJoint::getVelocity" ref="672173b63a47773178dc275b96ba1f46" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxReal PxPrismaticJoint::getVelocity           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
returns the velocity of the joint along its axis 
<p>

</div>
</div><p>
<a class="anchor" name="78899fed02686ce4b734cf07a801896d"></a><!-- doxytag: member="PxPrismaticJoint::isKindOf" ref="78899fed02686ce4b734cf07a801896d" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool PxPrismaticJoint::isKindOf           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline, protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns whether a given type name matches with the type of this instance. 
<p>

<p>Reimplemented from <a class="el" href="classPxJoint.html#bf37afb8ce63b5402cf69ab6e9344b28">PxJoint</a>.</p>

<p>References <a class="el" href="PxJoint_8h-source.html#l00400">PxJoint::isKindOf()</a>.</p>

</div>
</div><p>
<a class="anchor" name="7831c090d462d38eb7ba8e2fd25bc751"></a><!-- doxytag: member="PxPrismaticJoint::setLimit" ref="7831c090d462d38eb7ba8e2fd25bc751" args="(const PxJointLinearLimitPair &amp;)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPrismaticJoint::setLimit           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPxJointLinearLimitPair.html">PxJointLinearLimitPair</a> &amp;&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
sets the joint limit parameters. 
<p>
The limit range is [-PX_MAX_F32, PX_MAX_F32], but note that the width of the limit (upper-lower) must also be a valid float.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJointLinearLimitPair.html" title="Describes a two-sided limit.">PxJointLinearLimitPair</a> <a class="el" href="classPxPrismaticJoint.html#89eba64a796788bd9be24c4d85eaf7f9" title="gets the joint limit parameters.">getLimit()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="6d20577d885f919eeee64e9daba76679"></a><!-- doxytag: member="PxPrismaticJoint::setPrismaticJointFlag" ref="6d20577d885f919eeee64e9daba76679" args="(PxPrismaticJointFlag::Enum flag, bool value)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPrismaticJoint::setPrismaticJointFlag           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structPxPrismaticJointFlag.html#d175483117d7036cc021df8ac7dc15f4">PxPrismaticJointFlag::Enum</a>&nbsp;</td>
          <td class="paramname"> <em>flag</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>value</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>
Set a single flag specific to a Prismatic Joint to true or false. 
<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>flag</em>&nbsp;</td><td>The flag to set or clear. </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>value</em>&nbsp;</td><td>the value to which to set the flag</td></tr>
  </table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxPrismaticJointFlag.html" title="Flags specific to the prismatic joint.">PxPrismaticJointFlag</a>, getFlags() setFlags() </dd></dl>

</div>
</div><p>
<a class="anchor" name="0041ced8b6962072214dc81032ed2a2d"></a><!-- doxytag: member="PxPrismaticJoint::setPrismaticJointFlags" ref="0041ced8b6962072214dc81032ed2a2d" args="(PxPrismaticJointFlags flags)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPrismaticJoint::setPrismaticJointFlags           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classPxFlags.html">PxPrismaticJointFlags</a>&nbsp;</td>
          <td class="paramname"> <em>flags</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the flags specific to the Prismatic Joint. 
<p>
<b>Default</b> PxPrismaticJointFlags(0)<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>flags</em>&nbsp;</td><td>The joint flags.</td></tr>
  </table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxPrismaticJointFlag.html" title="Flags specific to the prismatic joint.">PxPrismaticJointFlag</a> setFlag() getFlags() </dd></dl>

</div>
</div><p>
<a class="anchor" name="f1a04172a838d1a1ee741d7471f4d62d"></a><!-- doxytag: member="PxPrismaticJoint::setProjectionAngularTolerance" ref="f1a04172a838d1a1ee741d7471f4d62d" args="(PxReal tolerance)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPrismaticJoint::setProjectionAngularTolerance           </td>
          <td>(</td>
          <td class="paramtype">PxReal&nbsp;</td>
          <td class="paramname"> <em>tolerance</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the angular tolerance threshold for projection. Projection is enabled if <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc34272d3f8e02cd1fa3a41256d186a0a38ebf" title="whether the actors should get projected for this constraint (the direction will be...">PxConstraintFlag::ePROJECTION</a> is set for the joint. 
<p>
If the joint separates by more than this distance along its locked degrees of freedom, the solver will move the bodies to close the distance.<p>
Setting a very small tolerance may result in simulation jitter or other artifacts.<p>
Sometimes it is not possible to project (for example when the joints form a cycle).<p>
<b>Range:</b> [0, PX_MAX_F32)<br>
 <b>Default:</b> Pi<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>tolerance</em>&nbsp;</td><td>the linear tolerance threshold</td></tr>
  </table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxPrismaticJoint.html#ea99524ff17e5044d737a2c6c4ebc8c8" title="Get the linear tolerance threshold for projection.">getProjectionLinearTolerance()</a> <a class="el" href="classPxJoint.html#857ea5abc40d94b0e1537b566a9d45bf" title="set the constraint flags for this joint.">PxJoint::setConstraintFlags()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="01d904a1fd7a2394c44ee39efcbdd6f2"></a><!-- doxytag: member="PxPrismaticJoint::setProjectionLinearTolerance" ref="01d904a1fd7a2394c44ee39efcbdd6f2" args="(PxReal tolerance)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPrismaticJoint::setProjectionLinearTolerance           </td>
          <td>(</td>
          <td class="paramtype">PxReal&nbsp;</td>
          <td class="paramname"> <em>tolerance</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the linear tolerance threshold for projection. 
<p>
If the joint separates by more than this distance along its locked degrees of freedom, the solver will move the bodies to close the distance.<p>
Setting a very small tolerance may result in simulation jitter or other artifacts.<p>
Sometimes it is not possible to project (for example when the joints form a cycle).<p>
This value must be nonnegative.<p>
<b>Range:</b> [0, PX_MAX_F32)<br>
 <b>Default:</b> 1e10f<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>tolerance</em>&nbsp;</td><td>the linear tolerance threshold</td></tr>
  </table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxPrismaticJoint.html#ea99524ff17e5044d737a2c6c4ebc8c8" title="Get the linear tolerance threshold for projection.">getProjectionLinearTolerance()</a> </dd></dl>

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