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/classPxJointLinearLimitPair.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/classPxJointLinearLimitPair.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxJointLinearLimitPair.html | 236 |
1 files changed, 236 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxJointLinearLimitPair.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxJointLinearLimitPair.html new file mode 100644 index 00000000..a0cfb93d --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxJointLinearLimitPair.html @@ -0,0 +1,236 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxJointLinearLimitPair 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>PxJointLinearLimitPair Class Reference<br> +<small> +[<a class="el" href="group__extensions.html">Extensions</a>]</small> +</h1><!-- doxytag: class="PxJointLinearLimitPair" --><!-- doxytag: inherits="PxJointLimitParameters" -->Describes a two-sided 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 PxJointLinearLimitPair:</div> +<div class="dynsection"> +<p><center><img src="classPxJointLinearLimitPair__inherit__graph.png" border="0" usemap="#PxJointLinearLimitPair__inherit__map" alt="Inheritance graph"></center> +<map name="PxJointLinearLimitPair__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 PxJointLinearLimitPair:</div> +<div class="dynsection"> +<p><center><img src="classPxJointLinearLimitPair__coll__graph.png" border="0" usemap="#PxJointLinearLimitPair__coll__map" alt="Collaboration graph"></center> +<map name="PxJointLinearLimitPair__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="classPxJointLinearLimitPair-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="classPxJointLinearLimitPair.html#ebd9d130d0b09c7bc81044a91da6a32d">PxJointLinearLimitPair</a> (const <a class="el" href="classPxTolerancesScale.html">PxTolerancesScale</a> &scale, PxReal lowerLimit, PxReal upperLimit, PxReal contactDist=-1)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a linear hard limit pair. The lower distance value must be less than the upper distance value. <a href="#ebd9d130d0b09c7bc81044a91da6a32d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLinearLimitPair.html#8a95bf4d353436b030e652ef3cb1343b">PxJointLinearLimitPair</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 a linear soft limit pair <a href="#8a95bf4d353436b030e652ef3cb1343b"></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="classPxJointLinearLimitPair.html#98bb06960d695370677a5e2e4a2e3d21">isValid</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the limit is valid. <a href="#98bb06960d695370677a5e2e4a2e3d21"></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="classPxJointLinearLimitPair.html#247c6737628a515ca5fc8fd139678d25">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, and if they are equal the limited degree of freedom will be treated as locked. <a href="#247c6737628a515ca5fc8fd139678d25"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLinearLimitPair.html#09443a891435349fdafaeae3a6377a2b">lower</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Describes a two-sided limit. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="ebd9d130d0b09c7bc81044a91da6a32d"></a><!-- doxytag: member="PxJointLinearLimitPair::PxJointLinearLimitPair" ref="ebd9d130d0b09c7bc81044a91da6a32d" args="(const PxTolerancesScale &scale, PxReal lowerLimit, PxReal upperLimit, PxReal contactDist=-1)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxJointLinearLimitPair::PxJointLinearLimitPair </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxTolerancesScale.html">PxTolerancesScale</a> & </td> + <td class="paramname"> <em>scale</em>, </td> + </tr> + <tr> + <td class="paramkey"></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 a linear hard limit pair. The lower distance value must be less than the upper distance 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>scale</em> </td><td>a <a class="el" href="classPxTolerancesScale.html" title="Class to define the scale at which simulation runs. Most simulation tolerances are...">PxTolerancesScale</a> struct. Should be the same as used when creating the <a class="el" href="classPxPhysics.html" title="Abstract singleton factory class used for instancing objects in the Physics SDK.">PxPhysics</a> object. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>lowerLimit</em> </td><td>the lower distance of the limit </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>upperLimit</em> </td><td>the upper distance 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.01f scaled by the tolerance length scale, 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> <a class="el" href="classPxTolerancesScale.html" title="Class to define the scale at which simulation runs. Most simulation tolerances are...">PxTolerancesScale</a> </dd></dl> + +<p>References <a class="el" href="PxJointLimit_8h-source.html#l00123">PxJointLimitParameters::contactDistance</a>, <a class="el" href="PxTolerancesScale_8h-source.html#l00069">PxTolerancesScale::length</a>, and <a class="el" href="PxMath_8h-source.html#l00086">PxMin()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8a95bf4d353436b030e652ef3cb1343b"></a><!-- doxytag: member="PxJointLinearLimitPair::PxJointLinearLimitPair" ref="8a95bf4d353436b030e652ef3cb1343b" args="(PxReal lowerLimit, PxReal upperLimit, const PxSpring &spring)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxJointLinearLimitPair::PxJointLinearLimitPair </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 a linear soft limit pair +<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 distance of the limit </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>upperLimit</em> </td><td>the upper distance 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 parameters 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> <a class="el" href="classPxTolerancesScale.html" title="Class to define the scale at which simulation runs. Most simulation tolerances are...">PxTolerancesScale</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="98bb06960d695370677a5e2e4a2e3d21"></a><!-- doxytag: member="PxJointLinearLimitPair::isValid" ref="98bb06960d695370677a5e2e4a2e3d21" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE bool PxJointLinearLimitPair::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="09443a891435349fdafaeae3a6377a2b"></a><!-- doxytag: member="PxJointLinearLimitPair::lower" ref="09443a891435349fdafaeae3a6377a2b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxJointLinearLimitPair.html#09443a891435349fdafaeae3a6377a2b">PxJointLinearLimitPair::lower</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="247c6737628a515ca5fc8fd139678d25"></a><!-- doxytag: member="PxJointLinearLimitPair::upper" ref="247c6737628a515ca5fc8fd139678d25" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxJointLinearLimitPair.html#247c6737628a515ca5fc8fd139678d25">PxJointLinearLimitPair::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, and if they are equal the limited degree of freedom will be treated as locked. +<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> |