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
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxJointLimitParameters 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>PxJointLimitParameters Class Reference<br>
<small>
[<a class="el" href="group__extensions.html">Extensions</a>]</small>
</h1><!-- doxytag: class="PxJointLimitParameters" -->Describes the parameters for a joint limit.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxJointLimit_8h-source.html">PxJointLimit.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for PxJointLimitParameters:</div>
<div class="dynsection">
<p><center><img src="classPxJointLimitParameters__inherit__graph.png" border="0" usemap="#PxJointLimitParameters__inherit__map" alt="Inheritance graph"></center>
<map name="PxJointLimitParameters__inherit__map">
<area shape="rect" href="classPxJointAngularLimitPair.html" title="PxJointAngularLimitPair" alt="PxJointAngularLimitPair" coords="7,85,151,107"><area shape="rect" href="classPxJointLimitCone.html" title="Describes an elliptical conical joint limit. Note that very small or highly elliptical..." alt="PxJointLimitCone" coords="175,85,284,107"><area shape="rect" href="classPxJointLinearLimit.html" title="Describes a one-sided linear limit." alt="PxJointLinearLimit" coords="308,85,420,107"><area shape="rect" href="classPxJointLinearLimitPair.html" title="Describes a two-sided limit." alt="PxJointLinearLimitPair" coords="444,85,580,107"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classPxJointLimitParameters-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="classPxJointLimitParameters.html#b706ebb59cf473d1537741edfab2c387">PxJointLimitParameters</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#e3d77fff99d5c4ed862a078957edee9c">isValid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the current settings are valid. <a href="#e3d77fff99d5c4ed862a078957edee9c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#e5705850231d60e3c0cb7e73bc270d93">isSoft</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#cf208a0f1e54fb8e9219af1e0357d4a9">restitution</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Controls the amount of bounce when the joint hits a limit. <a href="#cf208a0f1e54fb8e9219af1e0357d4a9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#82e6ed96bd05d01b7459d8200f16df9f">bounceThreshold</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#7431e7b65a92dd7fafc386c6a159a22c">stiffness</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">if greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit <a href="#7431e7b65a92dd7fafc386c6a159a22c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#ac6d185cfc3adea24cdb943cf893beac">damping</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">if spring is greater than zero, this is the damping of the limit spring <a href="#ac6d185cfc3adea24cdb943cf893beac"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#dc405245761d0b153f490ec1dd65af78">contactDistance</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the distance inside the limit value at which the limit will be considered to be active by the solver. As this value is made larger, the limit becomes active more quickly. It thus becomes less likely to violate the extents of the limit, but more expensive. <a href="#dc405245761d0b153f490ec1dd65af78"></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#f68daaa7495377cabc01d27d3c2e864e">~PxJointLimitParameters</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Describes the parameters for a joint limit.
<p>
Limits are enabled or disabled by setting flags or other configuration parameters joints, see the documentation for specific joint types for details. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="b706ebb59cf473d1537741edfab2c387"></a><!-- doxytag: member="PxJointLimitParameters::PxJointLimitParameters" ref="b706ebb59cf473d1537741edfab2c387" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxJointLimitParameters::PxJointLimitParameters </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="f68daaa7495377cabc01d27d3c2e864e"></a><!-- doxytag: member="PxJointLimitParameters::~PxJointLimitParameters" ref="f68daaa7495377cabc01d27d3c2e864e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxJointLimitParameters::~PxJointLimitParameters </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e5705850231d60e3c0cb7e73bc270d93"></a><!-- doxytag: member="PxJointLimitParameters::isSoft" ref="e5705850231d60e3c0cb7e73bc270d93" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_INLINE bool PxJointLimitParameters::isSoft </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="e3d77fff99d5c4ed862a078957edee9c"></a><!-- doxytag: member="PxJointLimitParameters::isValid" ref="e3d77fff99d5c4ed862a078957edee9c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_INLINE bool PxJointLimitParameters::isValid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if the current settings are valid.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the current settings are valid </dd></dl>
<p>Reimplemented in <a class="el" href="classPxJointLinearLimit.html#ef8d006945cfb4dd1a3c1538115cb98c">PxJointLinearLimit</a>, <a class="el" href="classPxJointLinearLimitPair.html#98bb06960d695370677a5e2e4a2e3d21">PxJointLinearLimitPair</a>, <a class="el" href="classPxJointAngularLimitPair.html#6aac14184f38e356217aff386ed4148b">PxJointAngularLimitPair</a>, and <a class="el" href="classPxJointLimitCone.html#6811418b2779a67918aa9b1ef17cc574">PxJointLimitCone</a>.</p>
<p>References <a class="el" href="PxMath_8h-source.html#l00292">PxIsFinite()</a>.</p>
<p>Referenced by <a class="el" href="PxJointLimit_8h-source.html#l00462">PxJointLimitCone::isValid()</a>, <a class="el" href="PxJointLimit_8h-source.html#l00373">PxJointAngularLimitPair::isValid()</a>, <a class="el" href="PxJointLimit_8h-source.html#l00297">PxJointLinearLimitPair::isValid()</a>, and <a class="el" href="PxJointLimit_8h-source.html#l00220">PxJointLinearLimit::isValid()</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="82e6ed96bd05d01b7459d8200f16df9f"></a><!-- doxytag: member="PxJointLimitParameters::bounceThreshold" ref="82e6ed96bd05d01b7459d8200f16df9f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal <a class="el" href="classPxJointLimitParameters.html#82e6ed96bd05d01b7459d8200f16df9f">PxJointLimitParameters::bounceThreshold</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
determines the minimum impact velocity which will cause the joint to bounce
</div>
</div><p>
<a class="anchor" name="dc405245761d0b153f490ec1dd65af78"></a><!-- doxytag: member="PxJointLimitParameters::contactDistance" ref="dc405245761d0b153f490ec1dd65af78" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal <a class="el" href="classPxJointLimitParameters.html#dc405245761d0b153f490ec1dd65af78">PxJointLimitParameters::contactDistance</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
the distance inside the limit value at which the limit will be considered to be active by the solver. As this value is made larger, the limit becomes active more quickly. It thus becomes less likely to violate the extents of the limit, but more expensive.
<p>
The contact distance should be less than the limit angle or distance, and in the case of a pair limit, less than half the distance between the upper and lower bounds. Exceeding this value will result in the limit being active all the time.<p>
Making this value too small can result in jitter around the limit.<p>
<b>Default:</b> depends on the joint<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxPhysics.html#e6b06e75ab03222d301a15e14c5ac467" title="Returns the simulation tolerance parameters.">PxPhysics::getTolerancesScale()</a> </dd></dl>
<p>Referenced by <a class="el" href="PxJointLimit_8h-source.html#l00338">PxJointAngularLimitPair::PxJointAngularLimitPair()</a>, <a class="el" href="PxJointLimit_8h-source.html#l00428">PxJointLimitCone::PxJointLimitCone()</a>, <a class="el" href="PxJointLimit_8h-source.html#l00190">PxJointLinearLimit::PxJointLinearLimit()</a>, and <a class="el" href="PxJointLimit_8h-source.html#l00264">PxJointLinearLimitPair::PxJointLinearLimitPair()</a>.</p>
</div>
</div><p>
<a class="anchor" name="ac6d185cfc3adea24cdb943cf893beac"></a><!-- doxytag: member="PxJointLimitParameters::damping" ref="ac6d185cfc3adea24cdb943cf893beac" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal <a class="el" href="classPxJointLimitParameters.html#ac6d185cfc3adea24cdb943cf893beac">PxJointLimitParameters::damping</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
if spring is greater than zero, this is the damping of the limit spring
<p>
<b>Range:</b> [0, PX_MAX_F32)<br>
<b>Default:</b> 0.0
</div>
</div><p>
<a class="anchor" name="cf208a0f1e54fb8e9219af1e0357d4a9"></a><!-- doxytag: member="PxJointLimitParameters::restitution" ref="cf208a0f1e54fb8e9219af1e0357d4a9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal <a class="el" href="classPxJointLimitParameters.html#cf208a0f1e54fb8e9219af1e0357d4a9">PxJointLimitParameters::restitution</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Controls the amount of bounce when the joint hits a limit.
<p>
A restitution value of 1.0 causes the joint to bounce back with the velocity which it hit the limit. A value of zero causes the joint to stop dead.<p>
In situations where the joint has many locked DOFs (e.g. 5) the restitution may not be applied correctly. This is due to a limitation in the solver which causes the restitution velocity to become zero as the solver enforces constraints on the other DOFs.<p>
This limitation applies to both angular and linear limits, however it is generally most apparent with limited angular DOFs. Disabling joint projection and increasing the solver iteration count may improve this behavior to some extent.<p>
Also, combining soft joint limits with joint drives driving against those limits may affect stability.<p>
<b>Range:</b> [0,1]<br>
<b>Default:</b> 0.0
</div>
</div><p>
<a class="anchor" name="7431e7b65a92dd7fafc386c6a159a22c"></a><!-- doxytag: member="PxJointLimitParameters::stiffness" ref="7431e7b65a92dd7fafc386c6a159a22c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal <a class="el" href="classPxJointLimitParameters.html#7431e7b65a92dd7fafc386c6a159a22c">PxJointLimitParameters::stiffness</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
if greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit
<p>
<b>Range:</b> [0, PX_MAX_F32)<br>
<b>Default:</b> 0.0
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxJointLimit_8h-source.html">PxJointLimit.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>
|