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/classPxFixedJoint.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/classPxFixedJoint.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxFixedJoint.html | 306 |
1 files changed, 306 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxFixedJoint.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxFixedJoint.html new file mode 100644 index 00000000..80506ac6 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxFixedJoint.html @@ -0,0 +1,306 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxFixedJoint 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>PxFixedJoint Class Reference<br> +<small> +[<a class="el" href="group__extensions.html">Extensions</a>]</small> +</h1><!-- doxytag: class="PxFixedJoint" --><!-- doxytag: inherits="PxJoint" -->A fixed joint permits no relative movement between two bodies. ie the bodies are glued together. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxFixedJoint_8h-source.html">PxFixedJoint.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxFixedJoint:</div> +<div class="dynsection"> +<p><center><img src="classPxFixedJoint__inherit__graph.png" border="0" usemap="#PxFixedJoint__inherit__map" alt="Inheritance graph"></center> +<map name="PxFixedJoint__inherit__map"> +<area shape="rect" href="classPxJoint.html" title="a base interface providing common functionality for PhysX joints" alt="PxJoint" coords="21,85,75,106"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="20,16,76,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxFixedJoint:</div> +<div class="dynsection"> +<p><center><img src="classPxFixedJoint__coll__graph.png" border="0" usemap="#PxFixedJoint__coll__map" alt="Collaboration graph"></center> +<map name="PxFixedJoint__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="classPxFixedJoint-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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFixedJoint.html#45f16f6dc31f103ea8bef435b6bd0e5f">setProjectionLinearTolerance</a> (PxReal tolerance)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the linear tolerance threshold for projection. Projection is enabled if <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc34272d3f8e02cd1fa3a41256d186a0a38ebf" title="whether the actors should get projected for this constraint (the direction will be...">PxConstraintFlag::ePROJECTION</a> is set for the joint. <a href="#45f16f6dc31f103ea8bef435b6bd0e5f"></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="classPxFixedJoint.html#de788fe7ea26f4cc1bc2f3b764583717">getProjectionLinearTolerance</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the linear tolerance threshold for projection. <a href="#de788fe7ea26f4cc1bc2f3b764583717"></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="classPxFixedJoint.html#cb90411048d18e7e09aa3f1e4ece7609">setProjectionAngularTolerance</a> (PxReal tolerance)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the angular tolerance threshold for projection. Projection is enabled if <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc34272d3f8e02cd1fa3a41256d186a0a38ebf" title="whether the actors should get projected for this constraint (the direction will be...">PxConstraintFlag::ePROJECTION</a> is set for the joint. <a href="#cb90411048d18e7e09aa3f1e4ece7609"></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="classPxFixedJoint.html#5cf2d9348b4ccdc66ba83245b0ff7bf9">getProjectionAngularTolerance</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the angular tolerance threshold for projection. <a href="#5cf2d9348b4ccdc66ba83245b0ff7bf9"></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="classPxFixedJoint.html#5051abbe778feecbc83c720002657c3e">getConcreteTypeName</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of <a class="el" href="classPxFixedJoint.html" title="A fixed joint permits no relative movement between two bodies. ie the bodies are...">PxFixedJoint</a>, used for serialization. <a href="#5051abbe778feecbc83c720002657c3e"></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="classPxFixedJoint.html#0b7b4136d03244ee300096764be4ad7c">PxFixedJoint</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="#0b7b4136d03244ee300096764be4ad7c"></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="classPxFixedJoint.html#56bf2f1c7c00e29de43b535989329897">PxFixedJoint</a> (<a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Deserialization constructor. <a href="#56bf2f1c7c00e29de43b535989329897"></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="classPxFixedJoint.html#5104a08772b4a89d470c8979531825e3">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="#5104a08772b4a89d470c8979531825e3"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A fixed joint permits no relative movement between two bodies. ie the bodies are glued together. +<p> +<div align="center"> +<img src="fixedJoint.png" alt="fixedJoint.png"> +</div> +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__extensions.html#g17f2eab8a94d35778f2555a85c34ea7f" title="Create a fixed joint.">PxFixedJointCreate()</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="0b7b4136d03244ee300096764be4ad7c"></a><!-- doxytag: member="PxFixedJoint::PxFixedJoint" ref="0b7b4136d03244ee300096764be4ad7c" args="(PxType concreteType, PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxFixedJoint::PxFixedJoint </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="56bf2f1c7c00e29de43b535989329897"></a><!-- doxytag: member="PxFixedJoint::PxFixedJoint" ref="56bf2f1c7c00e29de43b535989329897" args="(PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxFixedJoint::PxFixedJoint </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="5051abbe778feecbc83c720002657c3e"></a><!-- doxytag: member="PxFixedJoint::getConcreteTypeName" ref="5051abbe778feecbc83c720002657c3e" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual const char* PxFixedJoint::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="classPxFixedJoint.html" title="A fixed joint permits no relative movement between two bodies. ie the bodies are...">PxFixedJoint</a>, used for serialization. +<p> + +<p>Implements <a class="el" href="classPxBase.html#67fe206d8897ddce896c371ac8d789a9">PxBase</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5cf2d9348b4ccdc66ba83245b0ff7bf9"></a><!-- doxytag: member="PxFixedJoint::getProjectionAngularTolerance" ref="5cf2d9348b4ccdc66ba83245b0ff7bf9" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxFixedJoint::getProjectionAngularTolerance </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 angular tolerance threshold for projection. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the angular tolerance threshold in radians</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxFixedJoint.html#cb90411048d18e7e09aa3f1e4ece7609" title="Set the angular tolerance threshold for projection. Projection is enabled if PxConstraintFlag::ePROJ...">setProjectionAngularTolerance()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="de788fe7ea26f4cc1bc2f3b764583717"></a><!-- doxytag: member="PxFixedJoint::getProjectionLinearTolerance" ref="de788fe7ea26f4cc1bc2f3b764583717" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxFixedJoint::getProjectionLinearTolerance </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 linear tolerance threshold for projection. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the linear tolerance threshold</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxFixedJoint.html#45f16f6dc31f103ea8bef435b6bd0e5f" title="Set the linear tolerance threshold for projection. Projection is enabled if PxConstraintFlag::ePROJE...">setProjectionLinearTolerance()</a> <a class="el" href="classPxJoint.html#5bbf2a4196e036d711eea9bd5e542ce9" title="set a constraint flags for this joint to a specified value.">PxJoint::setConstraintFlag()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="5104a08772b4a89d470c8979531825e3"></a><!-- doxytag: member="PxFixedJoint::isKindOf" ref="5104a08772b4a89d470c8979531825e3" args="(const char *name) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxFixedJoint::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="cb90411048d18e7e09aa3f1e4ece7609"></a><!-- doxytag: member="PxFixedJoint::setProjectionAngularTolerance" ref="cb90411048d18e7e09aa3f1e4ece7609" args="(PxReal tolerance)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxFixedJoint::setProjectionAngularTolerance </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 angular tolerance threshold for projection. Projection is enabled if <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc34272d3f8e02cd1fa3a41256d186a0a38ebf" title="whether the actors should get projected for this constraint (the direction will be...">PxConstraintFlag::ePROJECTION</a> is set for the joint. +<p> +If the joint deviates by more than this angle around its locked angular degrees of freedom, the solver will move the bodies to close the angle.<p> +Setting a very small tolerance may result in simulation jitter or other artifacts.<p> +Sometimes it is not possible to project (for example when the joints form a cycle).<p> +<b>Range:</b> [0,Pi] <br> + <b>Default:</b> Pi<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 angular tolerance threshold in radians</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxFixedJoint.html#5cf2d9348b4ccdc66ba83245b0ff7bf9" title="Get the angular tolerance threshold for projection.">getProjectionAngularTolerance()</a> <a class="el" href="classPxJoint.html#5bbf2a4196e036d711eea9bd5e542ce9" title="set a constraint flags for this joint to a specified value.">PxJoint::setConstraintFlag()</a> <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc34272d3f8e02cd1fa3a41256d186a0a38ebf" title="whether the actors should get projected for this constraint (the direction will be...">PxConstraintFlag::ePROJECTION</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="45f16f6dc31f103ea8bef435b6bd0e5f"></a><!-- doxytag: member="PxFixedJoint::setProjectionLinearTolerance" ref="45f16f6dc31f103ea8bef435b6bd0e5f" args="(PxReal tolerance)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxFixedJoint::setProjectionLinearTolerance </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 linear tolerance threshold for projection. Projection is enabled if <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc34272d3f8e02cd1fa3a41256d186a0a38ebf" title="whether the actors should get projected for this constraint (the direction will be...">PxConstraintFlag::ePROJECTION</a> is set for the joint. +<p> +If the joint separates by more than this distance along its locked degrees of freedom, the solver will move the bodies to close the distance.<p> +Setting a very small tolerance may result in simulation jitter or other artifacts.<p> +Sometimes it is not possible to project (for example when the joints form a cycle).<p> +<b>Range:</b> [0, PX_MAX_F32)<br> + <b>Default:</b> 1e10f<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 linear tolerance threshold</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxFixedJoint.html#de788fe7ea26f4cc1bc2f3b764583717" title="Get the linear tolerance threshold for projection.">getProjectionLinearTolerance()</a> <a class="el" href="classPxJoint.html#857ea5abc40d94b0e1537b566a9d45bf" title="set the constraint flags for this joint.">PxJoint::setConstraintFlags()</a> <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc34272d3f8e02cd1fa3a41256d186a0a38ebf" title="whether the actors should get projected for this constraint (the direction will be...">PxConstraintFlag::ePROJECTION</a> </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxFixedJoint_8h-source.html">PxFixedJoint.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> |