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/classPxJoint.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/classPxJoint.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxJoint.html | 996 |
1 files changed, 996 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxJoint.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxJoint.html new file mode 100644 index 00000000..9ff038db --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxJoint.html @@ -0,0 +1,996 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxJoint 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>PxJoint Class Reference<br> +<small> +[<a class="el" href="group__extensions.html">Extensions</a>]</small> +</h1><!-- doxytag: class="PxJoint" --><!-- doxytag: inherits="PxBase" -->a base interface providing common functionality for PhysX joints +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxJoint_8h-source.html">PxJoint.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxJoint:</div> +<div class="dynsection"> +<p><center><img src="classPxJoint__inherit__graph.png" border="0" usemap="#PxJoint__inherit__map" alt="Inheritance graph"></center> +<map name="PxJoint__inherit__map"> +<area shape="rect" href="classPxD6Joint.html" title="A D6 joint is a general constraint between two actors." alt="PxD6Joint" coords="244,5,313,27"><area shape="rect" href="classPxDistanceJoint.html" title="a joint that maintains an upper or lower bound (or both) on the distance between..." alt="PxDistanceJoint" coords="228,51,329,72"><area shape="rect" href="classPxFixedJoint.html" title="A fixed joint permits no relative movement between two bodies. ie the bodies are..." alt="PxFixedJoint" coords="237,96,320,117"><area shape="rect" href="classPxPrismaticJoint.html" title="A prismatic joint permits relative translational movement between two bodies along..." alt="PxPrismaticJoint" coords="227,141,331,163"><area shape="rect" href="classPxRevoluteJoint.html" title="A joint which behaves in a similar way to a hinge or axle." alt="PxRevoluteJoint" coords="227,187,331,208"><area shape="rect" href="classPxSphericalJoint.html" title="A joint which behaves in a similar way to a ball and socket." alt="PxSphericalJoint" coords="227,232,331,253"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="19,119,75,140"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxJoint:</div> +<div class="dynsection"> +<p><center><img src="classPxJoint__coll__graph.png" border="0" usemap="#PxJoint__coll__map" alt="Collaboration graph"></center> +<map name="PxJoint__coll__map"> +<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="classPxJoint-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="classPxJoint.html#e3f3bbd628f77104c438a16a1e9bff2f">setActors</a> (<a class="el" href="classPxRigidActor.html">PxRigidActor</a> *actor0, <a class="el" href="classPxRigidActor.html">PxRigidActor</a> *actor1)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the actors for this joint. <a href="#e3f3bbd628f77104c438a16a1e9bff2f"></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="classPxJoint.html#744ebe07ff38e08fa0497155b891cfb3">getActors</a> (<a class="el" href="classPxRigidActor.html">PxRigidActor</a> *&actor0, <a class="el" href="classPxRigidActor.html">PxRigidActor</a> *&actor1) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the actors for this joint. <a href="#744ebe07ff38e08fa0497155b891cfb3"></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="classPxJoint.html#7bb7f7676c3660945356ef6e726c48b3">setLocalPose</a> (<a class="el" href="structPxJointActorIndex.html#1d62e1a8618a5ff4802335f99d4c5bd1">PxJointActorIndex::Enum</a> actor, const <a class="el" href="classPxTransform.html">PxTransform</a> &localPose)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the joint local pose for an actor. <a href="#7bb7f7676c3660945356ef6e726c48b3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxTransform.html">PxTransform</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJoint.html#d13a76df450cf57cfbed486a5359c895">getLocalPose</a> (<a class="el" href="structPxJointActorIndex.html#1d62e1a8618a5ff4802335f99d4c5bd1">PxJointActorIndex::Enum</a> actor) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the joint local pose for an actor. <a href="#d13a76df450cf57cfbed486a5359c895"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxTransform.html">PxTransform</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJoint.html#116450043c073548c1c55d032014f7e7">getRelativeTransform</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the relative pose for this joint <a href="#116450043c073548c1c55d032014f7e7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJoint.html#ba1e47a8ff180a564a2ef44a016372bf">getRelativeLinearVelocity</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the relative linear velocity of the joint <a href="#ba1e47a8ff180a564a2ef44a016372bf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJoint.html#e1d90c4cb53d5807584474ae130048df">getRelativeAngularVelocity</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the relative angular velocity of the joint <a href="#e1d90c4cb53d5807584474ae130048df"></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="classPxJoint.html#1cfe86fe5c8131cea1b9b5ff9df7a014">setBreakForce</a> (PxReal force, PxReal torque)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">set the break force for this joint. <a href="#1cfe86fe5c8131cea1b9b5ff9df7a014"></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="classPxJoint.html#900aa5084125aa37f8d12bb9f37eab93">getBreakForce</a> (PxReal &force, PxReal &torque) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the break force for this joint. <a href="#900aa5084125aa37f8d12bb9f37eab93"></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="classPxJoint.html#857ea5abc40d94b0e1537b566a9d45bf">setConstraintFlags</a> (<a class="el" href="classPxFlags.html">PxConstraintFlags</a> flags)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">set the constraint flags for this joint. <a href="#857ea5abc40d94b0e1537b566a9d45bf"></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="classPxJoint.html#5bbf2a4196e036d711eea9bd5e542ce9">setConstraintFlag</a> (<a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc3427">PxConstraintFlag::Enum</a> flag, bool value)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">set a constraint flags for this joint to a specified value. <a href="#5bbf2a4196e036d711eea9bd5e542ce9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxFlags.html">PxConstraintFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJoint.html#1da1a62c8aa565a92ff25c83825d1657">getConstraintFlags</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the constraint flags for this joint. <a href="#1da1a62c8aa565a92ff25c83825d1657"></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="classPxJoint.html#df8d09205b60811980a2202f1265562b">setInvMassScale0</a> (PxReal invMassScale)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">set the inverse mass scale for actor0. <a href="#df8d09205b60811980a2202f1265562b"></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="classPxJoint.html#f3bcb7920b533cd5911906744ab2f98c">getInvMassScale0</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the inverse mass scale for actor0. <a href="#f3bcb7920b533cd5911906744ab2f98c"></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="classPxJoint.html#97cc4d817e404177af4c2a598bb944c3">setInvInertiaScale0</a> (PxReal invInertiaScale)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">set the inverse inertia scale for actor0. <a href="#97cc4d817e404177af4c2a598bb944c3"></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="classPxJoint.html#84e7520dfde380005d1c09a258602d33">getInvInertiaScale0</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the inverse inertia scale for actor0. <a href="#84e7520dfde380005d1c09a258602d33"></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="classPxJoint.html#2f5f6c66b5e6933f8578a880a4a957ad">setInvMassScale1</a> (PxReal invMassScale)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">set the inverse mass scale for actor1. <a href="#2f5f6c66b5e6933f8578a880a4a957ad"></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="classPxJoint.html#36e5f97539fc423389536bbe20d59785">getInvMassScale1</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the inverse mass scale for actor1. <a href="#36e5f97539fc423389536bbe20d59785"></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="classPxJoint.html#d733659ee380ebf04a5d1d50fcf46222">setInvInertiaScale1</a> (PxReal invInertiaScale)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">set the inverse inertia scale for actor1. <a href="#d733659ee380ebf04a5d1d50fcf46222"></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="classPxJoint.html#4d2fb184640f84666e2f6198dc6b7e0d">getInvInertiaScale1</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the inverse inertia scale for actor1. <a href="#4d2fb184640f84666e2f6198dc6b7e0d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxConstraint.html">PxConstraint</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJoint.html#eedb92e5f7954e07a9fc5c454b1a67e8">getConstraint</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the <a class="el" href="classPxConstraint.html" title="A plugin class for implementing constraints.">PxConstraint</a> corresponding to this joint. <a href="#eedb92e5f7954e07a9fc5c454b1a67e8"></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="classPxJoint.html#79fbf86820e6ac2b1e5aedf13478e3c4">setName</a> (const char *name)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a name string for the object that can be retrieved with <a class="el" href="classPxJoint.html#c8228ca5462b161b36ca22b9cd99f929" title="Retrieves the name string set with setName().">getName()</a>. <a href="#79fbf86820e6ac2b1e5aedf13478e3c4"></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="classPxJoint.html#c8228ca5462b161b36ca22b9cd99f929">getName</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the name string set with <a class="el" href="classPxJoint.html#79fbf86820e6ac2b1e5aedf13478e3c4" title="Sets a name string for the object that can be retrieved with getName().">setName()</a>. <a href="#c8228ca5462b161b36ca22b9cd99f929"></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="classPxJoint.html#e0e293532bc9faecd381a2a84b1c866f">release</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Deletes the joint. <a href="#e0e293532bc9faecd381a2a84b1c866f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxScene.html">PxScene</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJoint.html#94b6afda907ba342af710f67aae09e6c">getScene</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the scene which this joint belongs to. <a href="#94b6afda907ba342af710f67aae09e6c"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJoint.html#373b38ccd4aff8671b5b17761b73af1b">getBinaryMetaData</a> (<a class="el" href="classPxOutputStream.html">PxOutputStream</a> &stream)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Put class meta data in stream, used for serialization. <a href="#373b38ccd4aff8671b5b17761b73af1b"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJoint.html#8ce68f3ee0d88b6475e6cafbf1fc73ea">userData</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">user can assign this to whatever, usually to create a 1:1 relationship with a user object. <a href="#8ce68f3ee0d88b6475e6cafbf1fc73ea"></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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJoint.html#2c43517c6bc6d77062c4563e45a1dd99">~PxJoint</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJoint.html#e0d4e45e29a51cf4953e22eaf0e7a22b">PxJoint</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="#e0d4e45e29a51cf4953e22eaf0e7a22b"></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="classPxJoint.html#b2ff846430088e54fc1ace3d9ab14d18">PxJoint</a> (<a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Deserialization constructor. <a href="#b2ff846430088e54fc1ace3d9ab14d18"></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="classPxJoint.html#bf37afb8ce63b5402cf69ab6e9344b28">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="#bf37afb8ce63b5402cf69ab6e9344b28"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +a base interface providing common functionality for PhysX joints <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="2c43517c6bc6d77062c4563e45a1dd99"></a><!-- doxytag: member="PxJoint::~PxJoint" ref="2c43517c6bc6d77062c4563e45a1dd99" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxJoint::~PxJoint </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, protected, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="e0d4e45e29a51cf4953e22eaf0e7a22b"></a><!-- doxytag: member="PxJoint::PxJoint" ref="e0d4e45e29a51cf4953e22eaf0e7a22b" args="(PxType concreteType, PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxJoint::PxJoint </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="b2ff846430088e54fc1ace3d9ab14d18"></a><!-- doxytag: member="PxJoint::PxJoint" ref="b2ff846430088e54fc1ace3d9ab14d18" args="(PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxJoint::PxJoint </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="744ebe07ff38e08fa0497155b891cfb3"></a><!-- doxytag: member="PxJoint::getActors" ref="744ebe07ff38e08fa0497155b891cfb3" args="(PxRigidActor *&actor0, PxRigidActor *&actor1) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxJoint::getActors </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxRigidActor.html">PxRigidActor</a> *& </td> + <td class="paramname"> <em>actor0</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxRigidActor.html">PxRigidActor</a> *& </td> + <td class="paramname"> <em>actor1</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the actors for this joint. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>actor0</em> </td><td>the first actor. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>actor1</em> </td><td>the second actor</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#e3f3bbd628f77104c438a16a1e9bff2f" title="Set the actors for this joint.">setActors()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="373b38ccd4aff8671b5b17761b73af1b"></a><!-- doxytag: member="PxJoint::getBinaryMetaData" ref="373b38ccd4aff8671b5b17761b73af1b" args="(PxOutputStream &stream)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static void PxJoint::getBinaryMetaData </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxOutputStream.html">PxOutputStream</a> & </td> + <td class="paramname"> <em>stream</em> </td> + <td> ) </td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Put class meta data in stream, used for serialization. +<p> + +</div> +</div><p> +<a class="anchor" name="900aa5084125aa37f8d12bb9f37eab93"></a><!-- doxytag: member="PxJoint::getBreakForce" ref="900aa5084125aa37f8d12bb9f37eab93" args="(PxReal &force, PxReal &torque) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxJoint::getBreakForce </td> + <td>(</td> + <td class="paramtype">PxReal & </td> + <td class="paramname"> <em>force</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal & </td> + <td class="paramname"> <em>torque</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +get the break force for this joint. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>force</em> </td><td>the maximum force the joint can apply before breaking </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>torque</em> </td><td>the maximum torque the joint can apply before breaking</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#1cfe86fe5c8131cea1b9b5ff9df7a014" title="set the break force for this joint.">setBreakForce()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="eedb92e5f7954e07a9fc5c454b1a67e8"></a><!-- doxytag: member="PxJoint::getConstraint" ref="eedb92e5f7954e07a9fc5c454b1a67e8" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxConstraint.html">PxConstraint</a>* PxJoint::getConstraint </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the <a class="el" href="classPxConstraint.html" title="A plugin class for implementing constraints.">PxConstraint</a> corresponding to this joint. +<p> +This can be used to determine, among other things, the force applied at the joint.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the constraint </dd></dl> + +</div> +</div><p> +<a class="anchor" name="1da1a62c8aa565a92ff25c83825d1657"></a><!-- doxytag: member="PxJoint::getConstraintFlags" ref="1da1a62c8aa565a92ff25c83825d1657" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxFlags.html">PxConstraintFlags</a> PxJoint::getConstraintFlags </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 constraint flags for this joint. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the constraint flags</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxConstraintFlag.html" title="a table of function pointers for a constraint">PxConstraintFlag</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="84e7520dfde380005d1c09a258602d33"></a><!-- doxytag: member="PxJoint::getInvInertiaScale0" ref="84e7520dfde380005d1c09a258602d33" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxJoint::getInvInertiaScale0 </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 inverse inertia scale for actor0. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>inverse inertia scale for actor0</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#97cc4d817e404177af4c2a598bb944c3" title="set the inverse inertia scale for actor0.">setInvInertiaScale0</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="4d2fb184640f84666e2f6198dc6b7e0d"></a><!-- doxytag: member="PxJoint::getInvInertiaScale1" ref="4d2fb184640f84666e2f6198dc6b7e0d" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxJoint::getInvInertiaScale1 </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 inverse inertia scale for actor1. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>inverse inertia scale for actor1</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#d733659ee380ebf04a5d1d50fcf46222" title="set the inverse inertia scale for actor1.">setInvInertiaScale1</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f3bcb7920b533cd5911906744ab2f98c"></a><!-- doxytag: member="PxJoint::getInvMassScale0" ref="f3bcb7920b533cd5911906744ab2f98c" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxJoint::getInvMassScale0 </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 inverse mass scale for actor0. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>inverse mass scale for actor0</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#df8d09205b60811980a2202f1265562b" title="set the inverse mass scale for actor0.">setInvMassScale0</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="36e5f97539fc423389536bbe20d59785"></a><!-- doxytag: member="PxJoint::getInvMassScale1" ref="36e5f97539fc423389536bbe20d59785" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxJoint::getInvMassScale1 </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 inverse mass scale for actor1. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>inverse mass scale for actor1</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#2f5f6c66b5e6933f8578a880a4a957ad" title="set the inverse mass scale for actor1.">setInvMassScale1</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="d13a76df450cf57cfbed486a5359c895"></a><!-- doxytag: member="PxJoint::getLocalPose" ref="d13a76df450cf57cfbed486a5359c895" args="(PxJointActorIndex::Enum actor) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxTransform.html">PxTransform</a> PxJoint::getLocalPose </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structPxJointActorIndex.html#1d62e1a8618a5ff4802335f99d4c5bd1">PxJointActorIndex::Enum</a> </td> + <td class="paramname"> <em>actor</em> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +get the joint local pose for an actor. +<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>actor</em> </td><td>0 for the first actor, 1 for the second actor.</td></tr> + </table> +</dl> +return the local pose for this joint<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#7bb7f7676c3660945356ef6e726c48b3" title="Set the joint local pose for an actor.">setLocalPose()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c8228ca5462b161b36ca22b9cd99f929"></a><!-- doxytag: member="PxJoint::getName" ref="c8228ca5462b161b36ca22b9cd99f929" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual const char* PxJoint::getName </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the name string set with <a class="el" href="classPxJoint.html#79fbf86820e6ac2b1e5aedf13478e3c4" title="Sets a name string for the object that can be retrieved with getName().">setName()</a>. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Name string associated with object.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#79fbf86820e6ac2b1e5aedf13478e3c4" title="Sets a name string for the object that can be retrieved with getName().">setName()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e1d90c4cb53d5807584474ae130048df"></a><!-- doxytag: member="PxJoint::getRelativeAngularVelocity" ref="e1d90c4cb53d5807584474ae130048df" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxVec3.html">PxVec3</a> PxJoint::getRelativeAngularVelocity </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 relative angular velocity of the joint +<p> +This function returns the angular velocity of actor1 relative to actor0. The value is returned in the constraint frame of actor0 +</div> +</div><p> +<a class="anchor" name="ba1e47a8ff180a564a2ef44a016372bf"></a><!-- doxytag: member="PxJoint::getRelativeLinearVelocity" ref="ba1e47a8ff180a564a2ef44a016372bf" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxVec3.html">PxVec3</a> PxJoint::getRelativeLinearVelocity </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 relative linear velocity of the joint +<p> +This function returns the linear velocity of the origin of the constraint frame of actor1, relative to the origin of the constraint frame of actor0. The value is returned in the constraint frame of actor0 +</div> +</div><p> +<a class="anchor" name="116450043c073548c1c55d032014f7e7"></a><!-- doxytag: member="PxJoint::getRelativeTransform" ref="116450043c073548c1c55d032014f7e7" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxTransform.html">PxTransform</a> PxJoint::getRelativeTransform </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 relative pose for this joint +<p> +This function returns the pose of the joint frame of actor1 relative to actor0 +</div> +</div><p> +<a class="anchor" name="94b6afda907ba342af710f67aae09e6c"></a><!-- doxytag: member="PxJoint::getScene" ref="94b6afda907ba342af710f67aae09e6c" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxScene.html">PxScene</a>* PxJoint::getScene </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the scene which this joint belongs to. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Owner Scene. NULL if not part of a scene.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxScene.html" title="A scene is a collection of bodies, particle systems and constraints which can interact...">PxScene</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="bf37afb8ce63b5402cf69ab6e9344b28"></a><!-- doxytag: member="PxJoint::isKindOf" ref="bf37afb8ce63b5402cf69ab6e9344b28" args="(const char *name) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxJoint::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="classPxBase.html#ae9d444c7cfd1715a101350a1b1226ef">PxBase</a>.</p> + +<p>Reimplemented in <a class="el" href="classPxD6Joint.html#6beea386f0d7451ab3ba94148a5da298">PxD6Joint</a>, <a class="el" href="classPxDistanceJoint.html#776679114f757961f63b9fd12c2dbae5">PxDistanceJoint</a>, <a class="el" href="classPxFixedJoint.html#5104a08772b4a89d470c8979531825e3">PxFixedJoint</a>, <a class="el" href="classPxPrismaticJoint.html#78899fed02686ce4b734cf07a801896d">PxPrismaticJoint</a>, <a class="el" href="classPxRevoluteJoint.html#572ee73d78d99e09f6e7a2eb3dcb15f0">PxRevoluteJoint</a>, and <a class="el" href="classPxSphericalJoint.html#2fa42a5334d0b2395dec6b2be0909dd3">PxSphericalJoint</a>.</p> + +<p>References <a class="el" href="PxBase_8h-source.html#l00178">PxBase::isKindOf()</a>.</p> + +<p>Referenced by <a class="el" href="PxSphericalJoint_8h-source.html#l00210">PxSphericalJoint::isKindOf()</a>, <a class="el" href="PxRevoluteJoint_8h-source.html#l00346">PxRevoluteJoint::isKindOf()</a>, <a class="el" href="PxPrismaticJoint_8h-source.html#l00241">PxPrismaticJoint::isKindOf()</a>, <a class="el" href="PxFixedJoint_8h-source.html#l00159">PxFixedJoint::isKindOf()</a>, <a class="el" href="PxDistanceJoint_8h-source.html#l00284">PxDistanceJoint::isKindOf()</a>, and <a class="el" href="PxD6Joint_8h-source.html#l00517">PxD6Joint::isKindOf()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e0e293532bc9faecd381a2a84b1c866f"></a><!-- doxytag: member="PxJoint::release" ref="e0e293532bc9faecd381a2a84b1c866f" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxJoint::release </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Deletes the joint. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>This call does not wake up the connected rigid bodies. </dd></dl> + +<p>Implements <a class="el" href="classPxBase.html#fe6aedda1df0d6d29b1a28213a5ee25a">PxBase</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e3f3bbd628f77104c438a16a1e9bff2f"></a><!-- doxytag: member="PxJoint::setActors" ref="e3f3bbd628f77104c438a16a1e9bff2f" args="(PxRigidActor *actor0, PxRigidActor *actor1)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxJoint::setActors </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxRigidActor.html">PxRigidActor</a> * </td> + <td class="paramname"> <em>actor0</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxRigidActor.html">PxRigidActor</a> * </td> + <td class="paramname"> <em>actor1</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 the actors for this joint. +<p> +An actor may be NULL to indicate the world frame. At most one of the actors may be NULL.<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>actor0</em> </td><td>the first actor. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>actor1</em> </td><td>the second actor</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#744ebe07ff38e08fa0497155b891cfb3" title="Get the actors for this joint.">getActors()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="1cfe86fe5c8131cea1b9b5ff9df7a014"></a><!-- doxytag: member="PxJoint::setBreakForce" ref="1cfe86fe5c8131cea1b9b5ff9df7a014" args="(PxReal force, PxReal torque)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxJoint::setBreakForce </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>force</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>torque</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 the break force for this joint. +<p> +if the constraint force or torque on the joint exceeds the specified values, the joint will break, at which point it will not constrain the two actors and the flag <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc342791151f48e43ade5a5d7153f1b3160696" title="whether the constraint is broken">PxConstraintFlag::eBROKEN</a> will be set. The force and torque are measured in the joint frame of the first actor<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>force</em> </td><td>the maximum force the joint can apply before breaking </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>torque</em> </td><td>the maximum torque the joint can apply before breaking </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="5bbf2a4196e036d711eea9bd5e542ce9"></a><!-- doxytag: member="PxJoint::setConstraintFlag" ref="5bbf2a4196e036d711eea9bd5e542ce9" args="(PxConstraintFlag::Enum flag, bool value)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxJoint::setConstraintFlag </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc3427">PxConstraintFlag::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 constraint flags for this joint to a specified 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>flag</em> </td><td>the constraint flag </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="structPxConstraintFlag.html" title="a table of function pointers for a constraint">PxConstraintFlag</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="857ea5abc40d94b0e1537b566a9d45bf"></a><!-- doxytag: member="PxJoint::setConstraintFlags" ref="857ea5abc40d94b0e1537b566a9d45bf" args="(PxConstraintFlags flags)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxJoint::setConstraintFlags </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxConstraintFlags</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 constraint flags for this 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>flags</em> </td><td>the constraint flags</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxConstraintFlag.html" title="a table of function pointers for a constraint">PxConstraintFlag</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="97cc4d817e404177af4c2a598bb944c3"></a><!-- doxytag: member="PxJoint::setInvInertiaScale0" ref="97cc4d817e404177af4c2a598bb944c3" args="(PxReal invInertiaScale)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxJoint::setInvInertiaScale0 </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>invInertiaScale</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +set the inverse inertia scale for actor0. +<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>invInertiaScale</em> </td><td>the scale to apply to the inverse inertia of actor0 for resolving this constraint</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#f3bcb7920b533cd5911906744ab2f98c" title="get the inverse mass scale for actor0.">getInvMassScale0</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="d733659ee380ebf04a5d1d50fcf46222"></a><!-- doxytag: member="PxJoint::setInvInertiaScale1" ref="d733659ee380ebf04a5d1d50fcf46222" args="(PxReal invInertiaScale)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxJoint::setInvInertiaScale1 </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>invInertiaScale</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +set the inverse inertia scale for actor1. +<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>invInertiaScale</em> </td><td>the scale to apply to the inverse inertia of actor1 for resolving this constraint</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#4d2fb184640f84666e2f6198dc6b7e0d" title="get the inverse inertia scale for actor1.">getInvInertiaScale1</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="df8d09205b60811980a2202f1265562b"></a><!-- doxytag: member="PxJoint::setInvMassScale0" ref="df8d09205b60811980a2202f1265562b" args="(PxReal invMassScale)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxJoint::setInvMassScale0 </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>invMassScale</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +set the inverse mass scale for actor0. +<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>invMassScale</em> </td><td>the scale to apply to the inverse mass of actor 0 for resolving this constraint</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#f3bcb7920b533cd5911906744ab2f98c" title="get the inverse mass scale for actor0.">getInvMassScale0</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="2f5f6c66b5e6933f8578a880a4a957ad"></a><!-- doxytag: member="PxJoint::setInvMassScale1" ref="2f5f6c66b5e6933f8578a880a4a957ad" args="(PxReal invMassScale)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxJoint::setInvMassScale1 </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>invMassScale</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +set the inverse mass scale for actor1. +<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>invMassScale</em> </td><td>the scale to apply to the inverse mass of actor 1 for resolving this constraint</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#36e5f97539fc423389536bbe20d59785" title="get the inverse mass scale for actor1.">getInvMassScale1</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="7bb7f7676c3660945356ef6e726c48b3"></a><!-- doxytag: member="PxJoint::setLocalPose" ref="7bb7f7676c3660945356ef6e726c48b3" args="(PxJointActorIndex::Enum actor, const PxTransform &localPose)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxJoint::setLocalPose </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structPxJointActorIndex.html#1d62e1a8618a5ff4802335f99d4c5bd1">PxJointActorIndex::Enum</a> </td> + <td class="paramname"> <em>actor</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> & </td> + <td class="paramname"> <em>localPose</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 the joint local pose for an actor. +<p> +This is the relative pose which locates the joint frame relative to the actor.<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>actor</em> </td><td>0 for the first actor, 1 for the second actor. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>localPose</em> </td><td>the local pose for the actor this joint</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#d13a76df450cf57cfbed486a5359c895" title="get the joint local pose for an actor.">getLocalPose()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="79fbf86820e6ac2b1e5aedf13478e3c4"></a><!-- doxytag: member="PxJoint::setName" ref="79fbf86820e6ac2b1e5aedf13478e3c4" args="(const char *name)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxJoint::setName </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>name</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets a name string for the object that can be retrieved with <a class="el" href="classPxJoint.html#c8228ca5462b161b36ca22b9cd99f929" title="Retrieves the name string set with setName().">getName()</a>. +<p> +This is for debugging and is not used by the SDK. The string is not copied by the SDK, only the pointer is stored.<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>name</em> </td><td>String to set the objects name to.</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxJoint.html#c8228ca5462b161b36ca22b9cd99f929" title="Retrieves the name string set with setName().">getName()</a> </dd></dl> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="8ce68f3ee0d88b6475e6cafbf1fc73ea"></a><!-- doxytag: member="PxJoint::userData" ref="8ce68f3ee0d88b6475e6cafbf1fc73ea" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* <a class="el" href="classPxJoint.html#8ce68f3ee0d88b6475e6cafbf1fc73ea">PxJoint::userData</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +user can assign this to whatever, usually to create a 1:1 relationship with a user object. +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxJoint_8h-source.html">PxJoint.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> |