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
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxFixedJoint 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>PxFixedJoint Class Reference<br>
<small>
[<a class="el" href="group__extensions.html">Extensions</a>]</small>
</h1><!-- doxytag: class="PxFixedJoint" --><!-- doxytag: inherits="PxJoint" -->A fixed joint permits no relative movement between two bodies. ie the bodies are glued together.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxFixedJoint_8h-source.html">PxFixedJoint.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for PxFixedJoint:</div>
<div class="dynsection">
<p><center><img src="classPxFixedJoint__inherit__graph.png" border="0" usemap="#PxFixedJoint__inherit__map" alt="Inheritance graph"></center>
<map name="PxFixedJoint__inherit__map">
<area shape="rect" href="classPxJoint.html" title="a base interface providing common functionality for PhysX joints" alt="PxJoint" coords="21,85,75,106"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="20,16,76,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxFixedJoint:</div>
<div class="dynsection">
<p><center><img src="classPxFixedJoint__coll__graph.png" border="0" usemap="#PxFixedJoint__coll__map" alt="Collaboration graph"></center>
<map name="PxFixedJoint__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\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" 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="classPxFixedJoint-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFixedJoint.html#45f16f6dc31f103ea8bef435b6bd0e5f">setProjectionLinearTolerance</a> (PxReal tolerance)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the linear 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="#45f16f6dc31f103ea8bef435b6bd0e5f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFixedJoint.html#de788fe7ea26f4cc1bc2f3b764583717">getProjectionLinearTolerance</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the linear tolerance threshold for projection. <a href="#de788fe7ea26f4cc1bc2f3b764583717"></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="classPxFixedJoint.html#cb90411048d18e7e09aa3f1e4ece7609">setProjectionAngularTolerance</a> (PxReal tolerance)=0</td></tr>
<tr><td class="mdescLeft"> </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="#cb90411048d18e7e09aa3f1e4ece7609"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFixedJoint.html#5cf2d9348b4ccdc66ba83245b0ff7bf9">getProjectionAngularTolerance</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the angular tolerance threshold for projection. <a href="#5cf2d9348b4ccdc66ba83245b0ff7bf9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFixedJoint.html#5051abbe778feecbc83c720002657c3e">getConcreteTypeName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of <a class="el" href="classPxFixedJoint.html" title="A fixed joint permits no relative movement between two bodies. ie the bodies are...">PxFixedJoint</a>, used for serialization. <a href="#5051abbe778feecbc83c720002657c3e"></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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFixedJoint.html#0b7b4136d03244ee300096764be4ad7c">PxFixedJoint</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"> </td><td class="mdescRight">Constructor. <a href="#0b7b4136d03244ee300096764be4ad7c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFixedJoint.html#56bf2f1c7c00e29de43b535989329897">PxFixedJoint</a> (<a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deserialization constructor. <a href="#56bf2f1c7c00e29de43b535989329897"></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="classPxFixedJoint.html#5104a08772b4a89d470c8979531825e3">isKindOf</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a given type name matches with the type of this instance. <a href="#5104a08772b4a89d470c8979531825e3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A fixed joint permits no relative movement between two bodies. ie the bodies are glued together.
<p>
<div align="center">
<img src="fixedJoint.png" alt="fixedJoint.png">
</div>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__extensions.html#g17f2eab8a94d35778f2555a85c34ea7f" title="Create a fixed joint.">PxFixedJointCreate()</a> <a class="el" href="classPxJoint.html" title="a base interface providing common functionality for PhysX joints">PxJoint</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="0b7b4136d03244ee300096764be4ad7c"></a><!-- doxytag: member="PxFixedJoint::PxFixedJoint" ref="0b7b4136d03244ee300096764be4ad7c" args="(PxType concreteType, PxBaseFlags baseFlags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_INLINE PxFixedJoint::PxFixedJoint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> </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> </td>
<td class="paramname"> <em>baseFlags</em></td><td> </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="56bf2f1c7c00e29de43b535989329897"></a><!-- doxytag: member="PxFixedJoint::PxFixedJoint" ref="56bf2f1c7c00e29de43b535989329897" args="(PxBaseFlags baseFlags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_INLINE PxFixedJoint::PxFixedJoint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a> </td>
<td class="paramname"> <em>baseFlags</em> </td>
<td> ) </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="5051abbe778feecbc83c720002657c3e"></a><!-- doxytag: member="PxFixedJoint::getConcreteTypeName" ref="5051abbe778feecbc83c720002657c3e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* PxFixedJoint::getConcreteTypeName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns string name of <a class="el" href="classPxFixedJoint.html" title="A fixed joint permits no relative movement between two bodies. ie the bodies are...">PxFixedJoint</a>, used for serialization.
<p>
<p>Implements <a class="el" href="classPxBase.html#67fe206d8897ddce896c371ac8d789a9">PxBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="5cf2d9348b4ccdc66ba83245b0ff7bf9"></a><!-- doxytag: member="PxFixedJoint::getProjectionAngularTolerance" ref="5cf2d9348b4ccdc66ba83245b0ff7bf9" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxReal PxFixedJoint::getProjectionAngularTolerance </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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="return" compact><dt><b>Returns:</b></dt><dd>the angular tolerance threshold in radians</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxFixedJoint.html#cb90411048d18e7e09aa3f1e4ece7609" title="Set the angular tolerance threshold for projection. Projection is enabled if PxConstraintFlag::ePROJ...">setProjectionAngularTolerance()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="de788fe7ea26f4cc1bc2f3b764583717"></a><!-- doxytag: member="PxFixedJoint::getProjectionLinearTolerance" ref="de788fe7ea26f4cc1bc2f3b764583717" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxReal PxFixedJoint::getProjectionLinearTolerance </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxFixedJoint.html#45f16f6dc31f103ea8bef435b6bd0e5f" title="Set the linear tolerance threshold for projection. Projection is enabled if PxConstraintFlag::ePROJE...">setProjectionLinearTolerance()</a> <a class="el" href="classPxJoint.html#5bbf2a4196e036d711eea9bd5e542ce9" title="set a constraint flags for this joint to a specified value.">PxJoint::setConstraintFlag()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="5104a08772b4a89d470c8979531825e3"></a><!-- doxytag: member="PxFixedJoint::isKindOf" ref="5104a08772b4a89d470c8979531825e3" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxFixedJoint::isKindOf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </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="cb90411048d18e7e09aa3f1e4ece7609"></a><!-- doxytag: member="PxFixedJoint::setProjectionAngularTolerance" ref="cb90411048d18e7e09aa3f1e4ece7609" args="(PxReal tolerance)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxFixedJoint::setProjectionAngularTolerance </td>
<td>(</td>
<td class="paramtype">PxReal </td>
<td class="paramname"> <em>tolerance</em> </td>
<td> ) </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 deviates by more than this angle around its locked angular degrees of freedom, the solver will move the bodies to close the angle.<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,Pi] <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> </td><td valign="top"><em>tolerance</em> </td><td>the angular tolerance threshold in radians</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxFixedJoint.html#5cf2d9348b4ccdc66ba83245b0ff7bf9" title="Get the angular tolerance threshold for projection.">getProjectionAngularTolerance()</a> <a class="el" href="classPxJoint.html#5bbf2a4196e036d711eea9bd5e542ce9" title="set a constraint flags for this joint to a specified value.">PxJoint::setConstraintFlag()</a> <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc34272d3f8e02cd1fa3a41256d186a0a38ebf" title="whether the actors should get projected for this constraint (the direction will be...">PxConstraintFlag::ePROJECTION</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="45f16f6dc31f103ea8bef435b6bd0e5f"></a><!-- doxytag: member="PxFixedJoint::setProjectionLinearTolerance" ref="45f16f6dc31f103ea8bef435b6bd0e5f" args="(PxReal tolerance)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxFixedJoint::setProjectionLinearTolerance </td>
<td>(</td>
<td class="paramtype">PxReal </td>
<td class="paramname"> <em>tolerance</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the linear 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> 1e10f<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>tolerance</em> </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="classPxFixedJoint.html#de788fe7ea26f4cc1bc2f3b764583717" 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> <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc34272d3f8e02cd1fa3a41256d186a0a38ebf" title="whether the actors should get projected for this constraint (the direction will be...">PxConstraintFlag::ePROJECTION</a> </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxFixedJoint_8h-source.html">PxFixedJoint.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>
|