diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxDistanceJoint.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxDistanceJoint.html | 597 |
1 files changed, 597 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxDistanceJoint.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxDistanceJoint.html new file mode 100644 index 00000000..5eac1b30 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxDistanceJoint.html @@ -0,0 +1,597 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxDistanceJoint 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>PxDistanceJoint Class Reference<br> +<small> +[<a class="el" href="group__extensions.html">Extensions</a>]</small> +</h1><!-- doxytag: class="PxDistanceJoint" --><!-- doxytag: inherits="PxJoint" -->a joint that maintains an upper or lower bound (or both) on the distance between two points on different objects +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxDistanceJoint_8h-source.html">PxDistanceJoint.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxDistanceJoint:</div> +<div class="dynsection"> +<p><center><img src="classPxDistanceJoint__inherit__graph.png" border="0" usemap="#PxDistanceJoint__inherit__map" alt="Inheritance graph"></center> +<map name="PxDistanceJoint__inherit__map"> +<area shape="rect" href="classPxJoint.html" title="a base interface providing common functionality for PhysX joints" alt="PxJoint" coords="31,85,84,106"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="29,16,85,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxDistanceJoint:</div> +<div class="dynsection"> +<p><center><img src="classPxDistanceJoint__coll__graph.png" border="0" usemap="#PxDistanceJoint__coll__map" alt="Collaboration graph"></center> +<map name="PxDistanceJoint__coll__map"> +<area shape="rect" href="classPxJoint.html" title="a base interface providing common functionality for PhysX joints" alt="PxJoint" coords="99,178,152,200"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="97,106,153,128"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="7,16,244,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxDistanceJoint-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">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#8c8b00c006fb57d2da329794f38a14eb">getDistance</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current distance of the joint. <a href="#8c8b00c006fb57d2da329794f38a14eb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#1b58a39c6c0fa2cca1ea52a8da949e9b">setMinDistance</a> (PxReal distance)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the allowed minimum distance for the joint. <a href="#1b58a39c6c0fa2cca1ea52a8da949e9b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#fb07ed620be2f7b24d37e9f46babcbae">getMinDistance</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the allowed minimum distance for the joint. <a href="#fb07ed620be2f7b24d37e9f46babcbae"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#a1f0551bbf0f5cac9878e41525d67e9a">setMaxDistance</a> (PxReal distance)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the allowed maximum distance for the joint. <a href="#a1f0551bbf0f5cac9878e41525d67e9a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#a3dbd91844fc5129202114b888c92094">getMaxDistance</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the allowed maximum distance for the joint. <a href="#a3dbd91844fc5129202114b888c92094"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#a4897db1805eea28a241867aaeb01d70">setTolerance</a> (PxReal tolerance)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the error tolerance of the joint. <a href="#a4897db1805eea28a241867aaeb01d70"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#b4fac37f8d97e6f8c3e16a673267523f">getTolerance</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the error tolerance of the joint. <a href="#b4fac37f8d97e6f8c3e16a673267523f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#2ac2f3e6b8afe91d7b39e34e34310e28">setStiffness</a> (PxReal stiffness)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the strength of the joint spring. <a href="#2ac2f3e6b8afe91d7b39e34e34310e28"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#046e3c320c50c2e83c3bb0bd43de97e2">getStiffness</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the strength of the joint spring. <a href="#046e3c320c50c2e83c3bb0bd43de97e2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#1fcc6660ac4544d477582057ebff39de">setDamping</a> (PxReal damping)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the damping of the joint spring. <a href="#1fcc6660ac4544d477582057ebff39de"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#f4e9269585bc01a804ac439d24ad157b">getDamping</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the damping of the joint spring. <a href="#f4e9269585bc01a804ac439d24ad157b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#7ecea55140d9946b94279b1730507062">setDistanceJointFlags</a> (<a class="el" href="classPxFlags.html">PxDistanceJointFlags</a> flags)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the flags specific to the Distance Joint. <a href="#7ecea55140d9946b94279b1730507062"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#ec3a1147c1d87db4fdf4573f9f190bfa">setDistanceJointFlag</a> (<a class="el" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d9">PxDistanceJointFlag::Enum</a> flag, bool value)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a single flag specific to a Distance Joint to true or false. <a href="#ec3a1147c1d87db4fdf4573f9f190bfa"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxFlags.html">PxDistanceJointFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#0f19fad4431d8194f1fed43095a0159a">getDistanceJointFlags</a> (void) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the flags specific to the Distance Joint. <a href="#0f19fad4431d8194f1fed43095a0159a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#25ea84cb332b384dba0211731f392c2e">getConcreteTypeName</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of <a class="el" href="classPxDistanceJoint.html" title="a joint that maintains an upper or lower bound (or both) on the distance between...">PxDistanceJoint</a>, used for serialization. <a href="#25ea84cb332b384dba0211731f392c2e"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#ae85edd4c5a075bbefb05045efe264dc">PxDistanceJoint</a> (<a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> concreteType, <a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#ae85edd4c5a075bbefb05045efe264dc"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#e627fb3c5c40d42b32a1373acf62497e">PxDistanceJoint</a> (<a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Deserialization constructor. <a href="#e627fb3c5c40d42b32a1373acf62497e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDistanceJoint.html#776679114f757961f63b9fd12c2dbae5">isKindOf</a> (const char *name) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a given type name matches with the type of this instance. <a href="#776679114f757961f63b9fd12c2dbae5"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +a joint that maintains an upper or lower bound (or both) on the distance between two points on different objects +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__extensions.html#gf7580a5a315137094cb676a7874c978a" title="Create a distance Joint.">PxDistanceJointCreate</a> <a class="el" href="classPxJoint.html" title="a base interface providing common functionality for PhysX joints">PxJoint</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="ae85edd4c5a075bbefb05045efe264dc"></a><!-- doxytag: member="PxDistanceJoint::PxDistanceJoint" ref="ae85edd4c5a075bbefb05045efe264dc" args="(PxType concreteType, PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxDistanceJoint::PxDistanceJoint </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> </td> + <td class="paramname"> <em>concreteType</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a> </td> + <td class="paramname"> <em>baseFlags</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inline, protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructor. +<p> + +</div> +</div><p> +<a class="anchor" name="e627fb3c5c40d42b32a1373acf62497e"></a><!-- doxytag: member="PxDistanceJoint::PxDistanceJoint" ref="e627fb3c5c40d42b32a1373acf62497e" args="(PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxDistanceJoint::PxDistanceJoint </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a> </td> + <td class="paramname"> <em>baseFlags</em> </td> + <td> ) </td> + <td><code> [inline, protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Deserialization constructor. +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="25ea84cb332b384dba0211731f392c2e"></a><!-- doxytag: member="PxDistanceJoint::getConcreteTypeName" ref="25ea84cb332b384dba0211731f392c2e" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual const char* PxDistanceJoint::getConcreteTypeName </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns string name of <a class="el" href="classPxDistanceJoint.html" title="a joint that maintains an upper or lower bound (or both) on the distance between...">PxDistanceJoint</a>, used for serialization. +<p> + +<p>Implements <a class="el" href="classPxBase.html#67fe206d8897ddce896c371ac8d789a9">PxBase</a>.</p> + +</div> +</div><p> +<a class="anchor" name="f4e9269585bc01a804ac439d24ad157b"></a><!-- doxytag: member="PxDistanceJoint::getDamping" ref="f4e9269585bc01a804ac439d24ad157b" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxDistanceJoint::getDamping </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the damping of the joint spring. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the degree of damping of the joint spring of the joint</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d9cef7db4704446fb9dc75d3602f1bfd49">PxDistanceJointFlag::eSPRING_ENABLED</a> <a class="el" href="classPxDistanceJoint.html#1fcc6660ac4544d477582057ebff39de" title="Set the damping of the joint spring.">setDamping()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8c8b00c006fb57d2da329794f38a14eb"></a><!-- doxytag: member="PxDistanceJoint::getDistance" ref="8c8b00c006fb57d2da329794f38a14eb" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxDistanceJoint::getDistance </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return the current distance of the joint. +<p> + +</div> +</div><p> +<a class="anchor" name="0f19fad4431d8194f1fed43095a0159a"></a><!-- doxytag: member="PxDistanceJoint::getDistanceJointFlags" ref="0f19fad4431d8194f1fed43095a0159a" args="(void) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxFlags.html">PxDistanceJointFlags</a> PxDistanceJoint::getDistanceJointFlags </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the flags specific to the Distance Joint. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the joint flags</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd>PxDistanceJoint::flags, <a class="el" href="structPxDistanceJointFlag.html" title="flags for configuring the drive of a PxDistanceJoint">PxDistanceJointFlag</a> setFlag() setFlags() </dd></dl> + +</div> +</div><p> +<a class="anchor" name="a3dbd91844fc5129202114b888c92094"></a><!-- doxytag: member="PxDistanceJoint::getMaxDistance" ref="a3dbd91844fc5129202114b888c92094" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxDistanceJoint::getMaxDistance </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the allowed maximum distance for the joint. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the allowed maximum distance</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd>PxDistanceJoint::maxDistance, <a class="el" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d957b10d96775d80633ee37fb674c37576">PxDistanceJointFlag::eMAX_DISTANCE_ENABLED</a> <a class="el" href="classPxDistanceJoint.html#a1f0551bbf0f5cac9878e41525d67e9a" title="Set the allowed maximum distance for the joint.">setMaxDistance()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="fb07ed620be2f7b24d37e9f46babcbae"></a><!-- doxytag: member="PxDistanceJoint::getMinDistance" ref="fb07ed620be2f7b24d37e9f46babcbae" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxDistanceJoint::getMinDistance </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the allowed minimum distance for the joint. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the allowed minimum distance</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd>PxDistanceJoint::minDistance, <a class="el" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d9445ff9fe34cd5d13f8bd5656899101cb">PxDistanceJointFlag::eMIN_DISTANCE_ENABLED</a> <a class="el" href="classPxDistanceJoint.html#1b58a39c6c0fa2cca1ea52a8da949e9b" title="Set the allowed minimum distance for the joint.">setMinDistance()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="046e3c320c50c2e83c3bb0bd43de97e2"></a><!-- doxytag: member="PxDistanceJoint::getStiffness" ref="046e3c320c50c2e83c3bb0bd43de97e2" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxDistanceJoint::getStiffness </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the strength of the joint spring. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>stiffness the spring strength of the joint</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d9cef7db4704446fb9dc75d3602f1bfd49">PxDistanceJointFlag::eSPRING_ENABLED</a> <a class="el" href="classPxDistanceJoint.html#2ac2f3e6b8afe91d7b39e34e34310e28" title="Set the strength of the joint spring.">setStiffness()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="b4fac37f8d97e6f8c3e16a673267523f"></a><!-- doxytag: member="PxDistanceJoint::getTolerance" ref="b4fac37f8d97e6f8c3e16a673267523f" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxDistanceJoint::getTolerance </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the error tolerance of the joint. +<p> +the distance beyond the joint's [min, max] range before the joint becomes active.<p> +<b>Default</b> 0.25f * <a class="el" href="classPxTolerancesScale.html#7d93bf20de0e5b54783eda5bb64effeb">PxTolerancesScale::length</a> <b>Range</b> (0, PX_MAX_F32)<p> +This value should be used to ensure that if the minimum distance is zero and the spring function is in use, the rest length of the spring is non-zero.<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd>PxDistanceJoint::tolerance, <a class="el" href="classPxDistanceJoint.html#a4897db1805eea28a241867aaeb01d70" title="Set the error tolerance of the joint.">setTolerance()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="776679114f757961f63b9fd12c2dbae5"></a><!-- doxytag: member="PxDistanceJoint::isKindOf" ref="776679114f757961f63b9fd12c2dbae5" args="(const char *name) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxDistanceJoint::isKindOf </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>name</em> </td> + <td> ) </td> + <td> const<code> [inline, protected, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns whether a given type name matches with the type of this instance. +<p> + +<p>Reimplemented from <a class="el" href="classPxJoint.html#bf37afb8ce63b5402cf69ab6e9344b28">PxJoint</a>.</p> + +<p>References <a class="el" href="PxJoint_8h-source.html#l00400">PxJoint::isKindOf()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="1fcc6660ac4544d477582057ebff39de"></a><!-- doxytag: member="PxDistanceJoint::setDamping" ref="1fcc6660ac4544d477582057ebff39de" args="(PxReal damping)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxDistanceJoint::setDamping </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>damping</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the damping of the joint spring. +<p> +The spring is used if enabled, and the distance exceeds the range [min-error, max+error].<p> +<b>Default</b> 0.0f <b>Range</b> [0, PX_MAX_F32)<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>damping</em> </td><td>the degree of damping of the joint spring of the joint</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d9cef7db4704446fb9dc75d3602f1bfd49">PxDistanceJointFlag::eSPRING_ENABLED</a> <a class="el" href="classPxDistanceJoint.html#1fcc6660ac4544d477582057ebff39de" title="Set the damping of the joint spring.">setDamping()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ec3a1147c1d87db4fdf4573f9f190bfa"></a><!-- doxytag: member="PxDistanceJoint::setDistanceJointFlag" ref="ec3a1147c1d87db4fdf4573f9f190bfa" args="(PxDistanceJointFlag::Enum flag, bool value)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxDistanceJoint::setDistanceJointFlag </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d9">PxDistanceJointFlag::Enum</a> </td> + <td class="paramname"> <em>flag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a single flag specific to a Distance Joint to true or false. +<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>flag</em> </td><td>The flag to set or clear. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>value</em> </td><td>the value to which to set the flag</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxDistanceJointFlag.html" title="flags for configuring the drive of a PxDistanceJoint">PxDistanceJointFlag</a>, getFlags() setFlags() </dd></dl> + +</div> +</div><p> +<a class="anchor" name="7ecea55140d9946b94279b1730507062"></a><!-- doxytag: member="PxDistanceJoint::setDistanceJointFlags" ref="7ecea55140d9946b94279b1730507062" args="(PxDistanceJointFlags flags)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxDistanceJoint::setDistanceJointFlags </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxDistanceJointFlags</a> </td> + <td class="paramname"> <em>flags</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the flags specific to the Distance Joint. +<p> +<b>Default</b> <a class="el" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d957b10d96775d80633ee37fb674c37576">PxDistanceJointFlag::eMAX_DISTANCE_ENABLED</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>flags</em> </td><td>The joint flags.</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxDistanceJointFlag.html" title="flags for configuring the drive of a PxDistanceJoint">PxDistanceJointFlag</a> setFlag() getFlags() </dd></dl> + +</div> +</div><p> +<a class="anchor" name="a1f0551bbf0f5cac9878e41525d67e9a"></a><!-- doxytag: member="PxDistanceJoint::setMaxDistance" ref="a1f0551bbf0f5cac9878e41525d67e9a" args="(PxReal distance)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxDistanceJoint::setMaxDistance </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>distance</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the allowed maximum distance for the joint. +<p> +The maximum distance must be no less than the minimum distance.<p> +<b>Default</b> 0.0f <b>Range</b> [0, PX_MAX_F32)<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>distance</em> </td><td>the maximum distance</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd>PxDistanceJoint::maxDistance, <a class="el" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d957b10d96775d80633ee37fb674c37576">PxDistanceJointFlag::eMAX_DISTANCE_ENABLED</a> <a class="el" href="classPxDistanceJoint.html#fb07ed620be2f7b24d37e9f46babcbae" title="Get the allowed minimum distance for the joint.">getMinDistance()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="1b58a39c6c0fa2cca1ea52a8da949e9b"></a><!-- doxytag: member="PxDistanceJoint::setMinDistance" ref="1b58a39c6c0fa2cca1ea52a8da949e9b" args="(PxReal distance)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxDistanceJoint::setMinDistance </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>distance</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the allowed minimum distance for the joint. +<p> +The minimum distance must be no more than the maximum distance<p> +<b>Default</b> 0.0f <b>Range</b> [0, PX_MAX_F32)<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>distance</em> </td><td>the minimum distance</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd>PxDistanceJoint::minDistance, <a class="el" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d9445ff9fe34cd5d13f8bd5656899101cb">PxDistanceJointFlag::eMIN_DISTANCE_ENABLED</a> <a class="el" href="classPxDistanceJoint.html#fb07ed620be2f7b24d37e9f46babcbae" title="Get the allowed minimum distance for the joint.">getMinDistance()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="2ac2f3e6b8afe91d7b39e34e34310e28"></a><!-- doxytag: member="PxDistanceJoint::setStiffness" ref="2ac2f3e6b8afe91d7b39e34e34310e28" args="(PxReal stiffness)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxDistanceJoint::setStiffness </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>stiffness</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the strength of the joint spring. +<p> +The spring is used if enabled, and the distance exceeds the range [min-error, max+error].<p> +<b>Default</b> 0.0f <b>Range</b> [0, PX_MAX_F32)<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>stiffness</em> </td><td>the spring strength of the joint</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d9cef7db4704446fb9dc75d3602f1bfd49">PxDistanceJointFlag::eSPRING_ENABLED</a> <a class="el" href="classPxDistanceJoint.html#046e3c320c50c2e83c3bb0bd43de97e2" title="Get the strength of the joint spring.">getStiffness()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="a4897db1805eea28a241867aaeb01d70"></a><!-- doxytag: member="PxDistanceJoint::setTolerance" ref="a4897db1805eea28a241867aaeb01d70" args="(PxReal tolerance)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxDistanceJoint::setTolerance </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>tolerance</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the error tolerance of the joint. +<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>tolerance</em> </td><td>the distance beyond the allowed range at which the joint becomes active</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd>PxDistanceJoint::tolerance, <a class="el" href="classPxDistanceJoint.html#b4fac37f8d97e6f8c3e16a673267523f" title="Get the error tolerance of the joint.">getTolerance()</a> </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxDistanceJoint_8h-source.html">PxDistanceJoint.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> |