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/classPxJointAngularLimitPair.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/classPxJointAngularLimitPair.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxJointAngularLimitPair.html | 227 |
1 files changed, 227 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxJointAngularLimitPair.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxJointAngularLimitPair.html new file mode 100644 index 00000000..80b707fa --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxJointAngularLimitPair.html @@ -0,0 +1,227 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxJointAngularLimitPair 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>PxJointAngularLimitPair Class Reference<br> +<small> +[<a class="el" href="group__extensions.html">Extensions</a>]</small> +</h1><!-- doxytag: class="PxJointAngularLimitPair" --><!-- doxytag: inherits="PxJointLimitParameters" --><code>#include <<a class="el" href="PxJointLimit_8h-source.html">PxJointLimit.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxJointAngularLimitPair:</div> +<div class="dynsection"> +<p><center><img src="classPxJointAngularLimitPair__inherit__graph.png" border="0" usemap="#PxJointAngularLimitPair__inherit__map" alt="Inheritance graph"></center> +<map name="PxJointAngularLimitPair__inherit__map"> +<area shape="rect" href="classPxJointLimitParameters.html" title="Describes the parameters for a joint limit." alt="PxJointLimitParameters" coords="7,16,153,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxJointAngularLimitPair:</div> +<div class="dynsection"> +<p><center><img src="classPxJointAngularLimitPair__coll__graph.png" border="0" usemap="#PxJointAngularLimitPair__coll__map" alt="Collaboration graph"></center> +<map name="PxJointAngularLimitPair__coll__map"> +<area shape="rect" href="classPxJointLimitParameters.html" title="Describes the parameters for a joint limit." alt="PxJointLimitParameters" coords="7,16,153,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxJointAngularLimitPair-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="classPxJointAngularLimitPair.html#dc790f4203b0608a63ef886a49e8e2c1">PxJointAngularLimitPair</a> (PxReal lowerLimit, PxReal upperLimit, PxReal contactDist=-1)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">construct an angular hard limit pair. <a href="#dc790f4203b0608a63ef886a49e8e2c1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointAngularLimitPair.html#02ae4ad9d22a8d163cfd197669c3c83e">PxJointAngularLimitPair</a> (PxReal lowerLimit, PxReal upperLimit, const <a class="el" href="classPxSpring.html">PxSpring</a> &spring)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">construct an angular soft limit pair. <a href="#02ae4ad9d22a8d163cfd197669c3c83e"></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="classPxJointAngularLimitPair.html#6aac14184f38e356217aff386ed4148b">isValid</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the limit is valid. <a href="#6aac14184f38e356217aff386ed4148b"></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="classPxJointAngularLimitPair.html#e346ef11f736245ef7ca8994e6d1492e">upper</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">the range of the limit. The upper limit must be no lower than the lower limit. <a href="#e346ef11f736245ef7ca8994e6d1492e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointAngularLimitPair.html#663e01d9ca54d0068649c6dd88a3ab83">lower</a></td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="dc790f4203b0608a63ef886a49e8e2c1"></a><!-- doxytag: member="PxJointAngularLimitPair::PxJointAngularLimitPair" ref="dc790f4203b0608a63ef886a49e8e2c1" args="(PxReal lowerLimit, PxReal upperLimit, PxReal contactDist=-1)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxJointAngularLimitPair::PxJointAngularLimitPair </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>lowerLimit</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>upperLimit</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>contactDist</em> = <code>-1</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> +construct an angular hard limit pair. +<p> +The lower value must be less than the upper value.<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>lowerLimit</em> </td><td>the lower angle of the limit </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>upperLimit</em> </td><td>the upper angle of the limit </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>contactDist</em> </td><td>the distance from the limit at which it becomes active. Default is the lesser of 0.1 radians, and 0.49 * (upperLimit - lowerLimit)</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJointLimitParameters.html" title="Describes the parameters for a joint limit.">PxJointLimitParameters</a> </dd></dl> + +<p>References <a class="el" href="PxJointLimit_8h-source.html#l00123">PxJointLimitParameters::contactDistance</a>, and <a class="el" href="PxMath_8h-source.html#l00086">PxMin()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="02ae4ad9d22a8d163cfd197669c3c83e"></a><!-- doxytag: member="PxJointAngularLimitPair::PxJointAngularLimitPair" ref="02ae4ad9d22a8d163cfd197669c3c83e" args="(PxReal lowerLimit, PxReal upperLimit, const PxSpring &spring)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxJointAngularLimitPair::PxJointAngularLimitPair </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>lowerLimit</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>upperLimit</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxSpring.html">PxSpring</a> & </td> + <td class="paramname"> <em>spring</em></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> +construct an angular soft limit pair. +<p> +The lower value must be less than the upper value.<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>lowerLimit</em> </td><td>the lower angle of the limit </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>upperLimit</em> </td><td>the upper angle of the limit </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>spring</em> </td><td>the stiffness and damping of the limit spring</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJointLimitParameters.html" title="Describes the parameters for a joint limit.">PxJointLimitParameters</a> </dd></dl> + +<p>References <a class="el" href="PxJoint_8h-source.html#l00416">PxSpring::damping</a>, and <a class="el" href="PxJoint_8h-source.html#l00415">PxSpring::stiffness</a>.</p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="6aac14184f38e356217aff386ed4148b"></a><!-- doxytag: member="PxJointAngularLimitPair::isValid" ref="6aac14184f38e356217aff386ed4148b" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE bool PxJointAngularLimitPair::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 limit is valid. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the current settings are valid </dd></dl> + +<p>Reimplemented from <a class="el" href="classPxJointLimitParameters.html#e3d77fff99d5c4ed862a078957edee9c">PxJointLimitParameters</a>.</p> + +<p>References <a class="el" href="PxJointLimit_8h-source.html#l00141">PxJointLimitParameters::isValid()</a>, and <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="663e01d9ca54d0068649c6dd88a3ab83"></a><!-- doxytag: member="PxJointAngularLimitPair::lower" ref="663e01d9ca54d0068649c6dd88a3ab83" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxJointAngularLimitPair.html#663e01d9ca54d0068649c6dd88a3ab83">PxJointAngularLimitPair::lower</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="e346ef11f736245ef7ca8994e6d1492e"></a><!-- doxytag: member="PxJointAngularLimitPair::upper" ref="e346ef11f736245ef7ca8994e6d1492e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxJointAngularLimitPair.html#e346ef11f736245ef7ca8994e6d1492e">PxJointAngularLimitPair::upper</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +the range of the limit. The upper limit must be no lower than the lower limit. +<p> +<b>Unit:</b> Angular: Radians <b>Range:</b> See the joint on which the limit is used for details<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-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> |