diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/classPxD6JointDrive.html | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxD6JointDrive.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxD6JointDrive.html | 209 |
1 files changed, 209 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxD6JointDrive.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxD6JointDrive.html new file mode 100644 index 00000000..6778221f --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxD6JointDrive.html @@ -0,0 +1,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> + <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>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 <<a class="el" href="PxD6Joint_8h-source.html">PxD6Joint.h</a>></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\< PxD6JointDriveFlag::Enum, PxU32 \>" alt="PxFlags\< PxD6JointDriveFlag::Enum, PxU32 \>" 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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxD6JointDrive.html#fc858c65b698a54bcdbe8036de4ff82b">PxD6JointDrive</a> ()</td></tr> + +<tr><td class="mdescLeft"> </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"> </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"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxD6JointDrive.html#1e9fd368cabd36f929133a8f380aed77">isValid</a> () const </td></tr> + +<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxD6JointDrive.html#419e8a0f6bbf4cafd708e7a8279a5c83">forceLimit</a></td></tr> + +<tr><td class="mdescLeft"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxD6JointDrive.html#fb4c9ee49ac7713aad8aaf33646f336a">flags</a></td></tr> + +<tr><td class="mdescLeft"> </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 & 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> ) </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 </td> + <td class="paramname"> <em>driveStiffness</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>driveDamping</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>driveForceLimit</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>isAcceleration</em> = <code>false</code></td><td> </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> </td><td valign="top"><em>driveStiffness</em> </td><td>the stiffness of the drive spring. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>driveDamping</em> </td><td>the damping of the drive spring </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>driveForceLimit</em> </td><td>the maximum impulse or force that can be exerted by the drive </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>isAcceleration</em> </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> ) </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 © 2008-2016 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> |