aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxD6JointDrive.html
blob: 3424dc7e627f0f2667959cab63afbfa64a78709e (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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxD6JointDrive 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>PxD6JointDrive Class Reference<br>
<small>
[<a class="el" href="group__extensions.html">Extensions</a>]</small>
</h1><!-- doxytag: class="PxD6JointDrive" --><!-- doxytag: inherits="PxSpring" -->parameters for configuring the drive model of a <a class="el" href="classPxD6Joint.html" title="A D6 joint is a general constraint between two actors.">PxD6Joint</a>  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxD6Joint_8h-source.html">PxD6Joint.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for PxD6JointDrive:</div>
<div class="dynsection">
<p><center><img src="classPxD6JointDrive__inherit__graph.png" border="0" usemap="#PxD6JointDrive__inherit__map" alt="Inheritance graph"></center>
<map name="PxD6JointDrive__inherit__map">
<area shape="rect" href="classPxSpring.html" title="PxSpring" alt="PxSpring" coords="25,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 PxD6JointDrive:</div>
<div class="dynsection">
<p><center><img src="classPxD6JointDrive__coll__graph.png" border="0" usemap="#PxD6JointDrive__coll__map" alt="Collaboration graph"></center>
<map name="PxD6JointDrive__coll__map">
<area shape="rect" href="classPxSpring.html" title="PxSpring" alt="PxSpring" coords="7,16,68,37"><area shape="rect" href="classPxFlags.html" title="PxFlags\&lt; PxD6JointDriveFlag::Enum, PxU32 \&gt;" alt="PxFlags\&lt; PxD6JointDriveFlag::Enum, PxU32 \&gt;" coords="92,16,369,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classPxD6JointDrive-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxD6JointDrive.html#fc858c65b698a54bcdbe8036de4ff82b">PxD6JointDrive</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor for <a class="el" href="classPxD6JointDrive.html" title="parameters for configuring the drive model of a PxD6Joint">PxD6JointDrive</a>.  <a href="#fc858c65b698a54bcdbe8036de4ff82b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxD6JointDrive.html#81fd6955014f2472d93db04f6362dcc4">PxD6JointDrive</a> (PxReal driveStiffness, PxReal driveDamping, PxReal driveForceLimit, bool isAcceleration=false)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">constructor a <a class="el" href="classPxD6JointDrive.html" title="parameters for configuring the drive model of a PxD6Joint">PxD6JointDrive</a>.  <a href="#81fd6955014f2472d93db04f6362dcc4"></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="classPxD6JointDrive.html#1e9fd368cabd36f929133a8f380aed77">isValid</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns true if the drive is valid  <a href="#1e9fd368cabd36f929133a8f380aed77"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxD6JointDrive.html#419e8a0f6bbf4cafd708e7a8279a5c83">forceLimit</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the force limit of the drive - may be an impulse or a force depending on <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc3427330ccf346c5056c0570dbc495007d1ce" title="limits for drive strength are forces rather than impulses">PxConstraintFlag::eDRIVE_LIMITS_ARE_FORCES</a>  <a href="#419e8a0f6bbf4cafd708e7a8279a5c83"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxFlags.html">PxD6JointDriveFlags</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxD6JointDrive.html#fb4c9ee49ac7713aad8aaf33646f336a">flags</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the joint drive flags  <a href="#fb4c9ee49ac7713aad8aaf33646f336a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
parameters for configuring the drive model of a <a class="el" href="classPxD6Joint.html" title="A D6 joint is a general constraint between two actors.">PxD6Joint</a> 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxD6Joint.html" title="A D6 joint is a general constraint between two actors.">PxD6Joint</a> </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="fc858c65b698a54bcdbe8036de4ff82b"></a><!-- doxytag: member="PxD6JointDrive::PxD6JointDrive" ref="fc858c65b698a54bcdbe8036de4ff82b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxD6JointDrive::PxD6JointDrive           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
default constructor for <a class="el" href="classPxD6JointDrive.html" title="parameters for configuring the drive model of a PxD6Joint">PxD6JointDrive</a>. 
<p>

</div>
</div><p>
<a class="anchor" name="81fd6955014f2472d93db04f6362dcc4"></a><!-- doxytag: member="PxD6JointDrive::PxD6JointDrive" ref="81fd6955014f2472d93db04f6362dcc4" args="(PxReal driveStiffness, PxReal driveDamping, PxReal driveForceLimit, bool isAcceleration=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxD6JointDrive::PxD6JointDrive           </td>
          <td>(</td>
          <td class="paramtype">PxReal&nbsp;</td>
          <td class="paramname"> <em>driveStiffness</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PxReal&nbsp;</td>
          <td class="paramname"> <em>driveDamping</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PxReal&nbsp;</td>
          <td class="paramname"> <em>driveForceLimit</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>isAcceleration</em> = <code>false</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
constructor a <a class="el" href="classPxD6JointDrive.html" title="parameters for configuring the drive model of a PxD6Joint">PxD6JointDrive</a>. 
<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>driveStiffness</em>&nbsp;</td><td>the stiffness of the drive spring. </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>driveDamping</em>&nbsp;</td><td>the damping of the drive spring </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>driveForceLimit</em>&nbsp;</td><td>the maximum impulse or force that can be exerted by the drive </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>isAcceleration</em>&nbsp;</td><td>whether the drive is an acceleration drive or a force drive </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1e9fd368cabd36f929133a8f380aed77"></a><!-- doxytag: member="PxD6JointDrive::isValid" ref="1e9fd368cabd36f929133a8f380aed77" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool PxD6JointDrive::isValid           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
returns true if the drive is valid 
<p>

<p>References <a class="el" href="PxMath_8h-source.html#l00292">PxIsFinite()</a>.</p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="fb4c9ee49ac7713aad8aaf33646f336a"></a><!-- doxytag: member="PxD6JointDrive::flags" ref="fb4c9ee49ac7713aad8aaf33646f336a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classPxFlags.html">PxD6JointDriveFlags</a> <a class="el" href="classPxD6JointDrive.html#fb4c9ee49ac7713aad8aaf33646f336a">PxD6JointDrive::flags</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
the joint drive flags 
<p>

</div>
</div><p>
<a class="anchor" name="419e8a0f6bbf4cafd708e7a8279a5c83"></a><!-- doxytag: member="PxD6JointDrive::forceLimit" ref="419e8a0f6bbf4cafd708e7a8279a5c83" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxReal <a class="el" href="classPxD6JointDrive.html#419e8a0f6bbf4cafd708e7a8279a5c83">PxD6JointDrive::forceLimit</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
the force limit of the drive - may be an impulse or a force depending on <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc3427330ccf346c5056c0570dbc495007d1ce" title="limits for drive strength are forces rather than impulses">PxConstraintFlag::eDRIVE_LIMITS_ARE_FORCES</a> 
<p>

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