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/classPxJointLimitCone.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/classPxJointLimitCone.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxJointLimitCone.html | 236 |
1 files changed, 236 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxJointLimitCone.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxJointLimitCone.html new file mode 100644 index 00000000..2c8a55ea --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxJointLimitCone.html @@ -0,0 +1,236 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxJointLimitCone 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>PxJointLimitCone Class Reference<br> +<small> +[<a class="el" href="group__extensions.html">Extensions</a>]</small> +</h1><!-- doxytag: class="PxJointLimitCone" --><!-- doxytag: inherits="PxJointLimitParameters" -->Describes an elliptical conical joint limit. Note that very small or highly elliptical limit cones may result in jitter. +<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 PxJointLimitCone:</div> +<div class="dynsection"> +<p><center><img src="classPxJointLimitCone__inherit__graph.png" border="0" usemap="#PxJointLimitCone__inherit__map" alt="Inheritance graph"></center> +<map name="PxJointLimitCone__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 PxJointLimitCone:</div> +<div class="dynsection"> +<p><center><img src="classPxJointLimitCone__coll__graph.png" border="0" usemap="#PxJointLimitCone__coll__map" alt="Collaboration graph"></center> +<map name="PxJointLimitCone__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="classPxJointLimitCone-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="classPxJointLimitCone.html#6b3ff7c47d158bb4ef637c69ce349706">PxJointLimitCone</a> (PxReal yLimitAngle, PxReal zLimitAngle, PxReal contactDist=-1)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a cone hard limit. <a href="#6b3ff7c47d158bb4ef637c69ce349706"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitCone.html#0bb99b52fb177d263b926938b239aa9c">PxJointLimitCone</a> (PxReal yLimitAngle, PxReal zLimitAngle, const <a class="el" href="classPxSpring.html">PxSpring</a> &spring)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a cone soft limit. <a href="#0bb99b52fb177d263b926938b239aa9c"></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="classPxJointLimitCone.html#6811418b2779a67918aa9b1ef17cc574">isValid</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the limit is valid. <a href="#6811418b2779a67918aa9b1ef17cc574"></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="classPxJointLimitCone.html#eac6d3168fe1a6ccca4642a9f19e50a7">yAngle</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">the maximum angle from the Y axis of the constraint frame. <a href="#eac6d3168fe1a6ccca4642a9f19e50a7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitCone.html#f14e3c875ee7f9cf772bafc535af7631">zAngle</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">the maximum angle from the Z-axis of the constraint frame. <a href="#f14e3c875ee7f9cf772bafc535af7631"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Describes an elliptical conical joint limit. Note that very small or highly elliptical limit cones may result in jitter. +<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> <a class="el" href="classPxSphericalJoint.html" title="A joint which behaves in a similar way to a ball and socket.">PxSphericalJoint</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="6b3ff7c47d158bb4ef637c69ce349706"></a><!-- doxytag: member="PxJointLimitCone::PxJointLimitCone" ref="6b3ff7c47d158bb4ef637c69ce349706" args="(PxReal yLimitAngle, PxReal zLimitAngle, PxReal contactDist=-1)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxJointLimitCone::PxJointLimitCone </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>yLimitAngle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>zLimitAngle</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 a cone hard limit. +<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>yLimitAngle</em> </td><td>the limit angle from the Y-axis of the constraint frame </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>zLimitAngle</em> </td><td>the limit angle from the Z-axis of the constraint frame </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 * the lower of the limit angles</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="0bb99b52fb177d263b926938b239aa9c"></a><!-- doxytag: member="PxJointLimitCone::PxJointLimitCone" ref="0bb99b52fb177d263b926938b239aa9c" args="(PxReal yLimitAngle, PxReal zLimitAngle, const PxSpring &spring)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxJointLimitCone::PxJointLimitCone </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>yLimitAngle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>zLimitAngle</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 a cone soft limit. +<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>yLimitAngle</em> </td><td>the limit angle from the Y-axis of the constraint frame </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>zLimitAngle</em> </td><td>the limit angle from the Z-axis of the constraint frame </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="6811418b2779a67918aa9b1ef17cc574"></a><!-- doxytag: member="PxJointLimitCone::isValid" ref="6811418b2779a67918aa9b1ef17cc574" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE bool PxJointLimitCone::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>, <a class="el" href="PxMath_8h-source.html#l00292">PxIsFinite()</a>, and <a class="el" href="PxMath_8h-source.html#l00058">PxPi</a>.</p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="eac6d3168fe1a6ccca4642a9f19e50a7"></a><!-- doxytag: member="PxJointLimitCone::yAngle" ref="eac6d3168fe1a6ccca4642a9f19e50a7" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxJointLimitCone.html#eac6d3168fe1a6ccca4642a9f19e50a7">PxJointLimitCone::yAngle</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +the maximum angle from the Y axis of the constraint frame. +<p> +<b>Unit:</b> Angular: Radians <b>Range:</b> Angular: (0,PI)<br> + <b>Default:</b> PI/2 +</div> +</div><p> +<a class="anchor" name="f14e3c875ee7f9cf772bafc535af7631"></a><!-- doxytag: member="PxJointLimitCone::zAngle" ref="f14e3c875ee7f9cf772bafc535af7631" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxJointLimitCone.html#f14e3c875ee7f9cf772bafc535af7631">PxJointLimitCone::zAngle</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +the maximum angle from the Z-axis of the constraint frame. +<p> +<b>Unit:</b> Angular: Radians <b>Range:</b> Angular: (0,PI)<br> + <b>Default:</b> PI/2 +</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> |