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/classPxConstraint.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/classPxConstraint.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxConstraint.html | 730 |
1 files changed, 730 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxConstraint.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxConstraint.html new file mode 100644 index 00000000..b8d2b87a --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxConstraint.html @@ -0,0 +1,730 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxConstraint 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>PxConstraint Class Reference<br> +<small> +[<a class="el" href="group__physics.html">Physics</a>]</small> +</h1><!-- doxytag: class="PxConstraint" --><!-- doxytag: inherits="PxBase" -->A plugin class for implementing constraints. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxConstraint_8h-source.html">PxConstraint.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxConstraint:</div> +<div class="dynsection"> +<p><center><img src="classPxConstraint__inherit__graph.png" border="0" usemap="#PxConstraint__inherit__map" alt="Inheritance graph"></center> +<map name="PxConstraint__inherit__map"> +<area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="21,16,77,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxConstraint:</div> +<div class="dynsection"> +<p><center><img src="classPxConstraint__coll__graph.png" border="0" usemap="#PxConstraint__coll__map" alt="Collaboration graph"></center> +<map name="PxConstraint__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="classPxConstraint-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="classPxConstraint.html#8153c211d21fff49565e7e06e475d5cc">release</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases a <a class="el" href="classPxConstraint.html" title="A plugin class for implementing constraints.">PxConstraint</a> instance. <a href="#8153c211d21fff49565e7e06e475d5cc"></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="classPxConstraint.html#a94f6f40eac2640b1211eb3ede57588b">getScene</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the scene which this constraint belongs to. <a href="#a94f6f40eac2640b1211eb3ede57588b"></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="classPxConstraint.html#e0842055f2c3263cebcea65b1b09888e">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">Retrieves the actors for this constraint. <a href="#e0842055f2c3263cebcea65b1b09888e"></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="classPxConstraint.html#ad3f1f8c8e4220238c8fcb00c440e701">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">Sets the actors for this constraint. <a href="#ad3f1f8c8e4220238c8fcb00c440e701"></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="classPxConstraint.html#c54f23bc7b3d52d3b5f265f6750e3199">markDirty</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Notify the scene that the constraint shader data has been updated by the application. <a href="#c54f23bc7b3d52d3b5f265f6750e3199"></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="classPxConstraint.html#2d697724814976973b1de9e303e15b3f">setFlags</a> (<a class="el" href="classPxFlags.html">PxConstraintFlags</a> flags)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the flags for this constraint. <a href="#2d697724814976973b1de9e303e15b3f"></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="classPxConstraint.html#45297b7f2310005fd74f3e7be995b0f8">getFlags</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the flags for this constraint. <a href="#45297b7f2310005fd74f3e7be995b0f8"></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="classPxConstraint.html#95488eea1d5847d3d1408c3d5cdf2576">setFlag</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 flag for this constraint. <a href="#95488eea1d5847d3d1408c3d5cdf2576"></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="classPxConstraint.html#5838f1118a15b32ca27a6b89e6580cf4">getForce</a> (<a class="el" href="classPxVec3.html">PxVec3</a> &linear, <a class="el" href="classPxVec3.html">PxVec3</a> &angular) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the constraint force most recently applied to maintain this constraint. <a href="#5838f1118a15b32ca27a6b89e6580cf4"></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="classPxConstraint.html#96bea6e60039cf468b1c677d2594611a">isValid</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">whether the constraint is valid. <a href="#96bea6e60039cf468b1c677d2594611a"></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="classPxConstraint.html#dc0b069b41e76b7c017632cfc24f08d3">setBreakForce</a> (PxReal linear, PxReal angular)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the break force and torque thresholds for this constraint. <a href="#dc0b069b41e76b7c017632cfc24f08d3"></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="classPxConstraint.html#9b0da09475c44c2957e1dd6c7fb91ab1">getBreakForce</a> (PxReal &linear, PxReal &angular) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the constraint break force and torque thresholds. <a href="#9b0da09475c44c2957e1dd6c7fb91ab1"></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="classPxConstraint.html#9ddd5450fca029d9574b5c854b77d3d6">setMinResponseThreshold</a> (PxReal threshold)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the minimum response threshold for a constraint row. <a href="#9ddd5450fca029d9574b5c854b77d3d6"></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="classPxConstraint.html#0319884873f5ad2c5e6b6798d6c985a4">getMinResponseThreshold</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the constraint break force and torque thresholds. <a href="#0319884873f5ad2c5e6b6798d6c985a4"></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="classPxConstraint.html#c35d572c4d343685c120f11c8884526e">getExternalReference</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> &typeID)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch external owner of the constraint. <a href="#c35d572c4d343685c120f11c8884526e"></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="classPxConstraint.html#3fb6da793a10be50c30bb8e3fb175d68">setConstraintFunctions</a> (<a class="el" href="classPxConstraintConnector.html">PxConstraintConnector</a> &connector, const <a class="el" href="structPxConstraintShaderTable.html">PxConstraintShaderTable</a> &shaders)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the constraint functions for this constraint. <a href="#3fb6da793a10be50c30bb8e3fb175d68"></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="classPxConstraint.html#4bd4ab732d811b1d4fc7fa84e686ab66">getConcreteTypeName</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#4bd4ab732d811b1d4fc7fa84e686ab66"></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="classPxConstraint.html#505f367bc330fa15970154faf7f75d47">PxConstraint</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="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConstraint.html#c3a2526c82e5ee4e83c00d0d1d03990b">PxConstraint</a> (<a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConstraint.html#dbcf13c57ee012d5e03ea54017c127cb">~PxConstraint</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConstraint.html#dc7e64a1dc17a8713d91d5be6dc39bb9">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="#dc7e64a1dc17a8713d91d5be6dc39bb9"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A plugin class for implementing constraints. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxPhysics.html#1126f3f545ebe183be1753f62d1efc7d" title="Creates a constraint shader.">PxPhysics.createConstraint</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="505f367bc330fa15970154faf7f75d47"></a><!-- doxytag: member="PxConstraint::PxConstraint" ref="505f367bc330fa15970154faf7f75d47" args="(PxType concreteType, PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxConstraint::PxConstraint </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> + +</div> +</div><p> +<a class="anchor" name="c3a2526c82e5ee4e83c00d0d1d03990b"></a><!-- doxytag: member="PxConstraint::PxConstraint" ref="c3a2526c82e5ee4e83c00d0d1d03990b" args="(PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxConstraint::PxConstraint </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> + +</div> +</div><p> +<a class="anchor" name="dbcf13c57ee012d5e03ea54017c127cb"></a><!-- doxytag: member="PxConstraint::~PxConstraint" ref="dbcf13c57ee012d5e03ea54017c127cb" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxConstraint::~PxConstraint </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> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="e0842055f2c3263cebcea65b1b09888e"></a><!-- doxytag: member="PxConstraint::getActors" ref="e0842055f2c3263cebcea65b1b09888e" args="(PxRigidActor *&actor0, PxRigidActor *&actor1) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxConstraint::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> +Retrieves the actors for this constraint. +<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>a reference to the pointer for the first actor </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>actor1</em> </td><td>a reference to the pointer for the second actor</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK.">PxActor</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9b0da09475c44c2957e1dd6c7fb91ab1"></a><!-- doxytag: member="PxConstraint::getBreakForce" ref="9b0da09475c44c2957e1dd6c7fb91ab1" args="(PxReal &linear, PxReal &angular) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxConstraint::getBreakForce </td> + <td>(</td> + <td class="paramtype">PxReal & </td> + <td class="paramname"> <em>linear</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal & </td> + <td class="paramname"> <em>angular</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> +Retrieve the constraint break force and torque thresholds. +<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>linear</em> </td><td>the linear break threshold </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>angular</em> </td><td>the angular break threshold </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="4bd4ab732d811b1d4fc7fa84e686ab66"></a><!-- doxytag: member="PxConstraint::getConcreteTypeName" ref="4bd4ab732d811b1d4fc7fa84e686ab66" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual const char* PxConstraint::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 dynamic type. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Class name of most derived type of this object. </dd></dl> + +<p>Implements <a class="el" href="classPxBase.html#67fe206d8897ddce896c371ac8d789a9">PxBase</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c35d572c4d343685c120f11c8884526e"></a><!-- doxytag: member="PxConstraint::getExternalReference" ref="c35d572c4d343685c120f11c8884526e" args="(PxU32 &typeID)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void* PxConstraint::getExternalReference </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> & </td> + <td class="paramname"> <em>typeID</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Fetch external owner of the constraint. +<p> +Provides a reference to the external owner of a constraint and a unique owner type ID.<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>typeID</em> </td><td>Unique type identifier of the external object. </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to the external object which owns the constraint.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxConstraintConnector.html#1210c94b5fa0513b2cd99ceedccd23ee" title="Fetches external data for a constraint.">PxConstraintConnector.getExternalReference()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="45297b7f2310005fd74f3e7be995b0f8"></a><!-- doxytag: member="PxConstraint::getFlags" ref="45297b7f2310005fd74f3e7be995b0f8" 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> PxConstraint::getFlags </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieve the flags for this constraint. +<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="group__physics.html#gf2b7f07d3fa7fafaf3d85114fbb120ee" title="constraint flags">PxConstraintFlags</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="5838f1118a15b32ca27a6b89e6580cf4"></a><!-- doxytag: member="PxConstraint::getForce" ref="5838f1118a15b32ca27a6b89e6580cf4" args="(PxVec3 &linear, PxVec3 &angular) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxConstraint::getForce </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>linear</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>angular</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> +Retrieve the constraint force most recently applied to maintain this constraint. +<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>linear</em> </td><td>the constraint force </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>angular</em> </td><td>the constraint torque </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="0319884873f5ad2c5e6b6798d6c985a4"></a><!-- doxytag: member="PxConstraint::getMinResponseThreshold" ref="0319884873f5ad2c5e6b6798d6c985a4" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxConstraint::getMinResponseThreshold </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieve the constraint break force and torque thresholds. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the minimum response threshold for a constraint row </dd></dl> + +</div> +</div><p> +<a class="anchor" name="a94f6f40eac2640b1211eb3ede57588b"></a><!-- doxytag: member="PxConstraint::getScene" ref="a94f6f40eac2640b1211eb3ede57588b" 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>* PxConstraint::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 constraint 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="dc7e64a1dc17a8713d91d5be6dc39bb9"></a><!-- doxytag: member="PxConstraint::isKindOf" ref="dc7e64a1dc17a8713d91d5be6dc39bb9" args="(const char *name) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxConstraint::isKindOf </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>superClass</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>References <a class="el" href="PxBase_8h-source.html#l00178">PxBase::isKindOf()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="96bea6e60039cf468b1c677d2594611a"></a><!-- doxytag: member="PxConstraint::isValid" ref="96bea6e60039cf468b1c677d2594611a" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxConstraint::isValid </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +whether the constraint is valid. +<p> +A constraint is valid if it has at least one dynamic rigid body or articulation link. A constraint that is not valid may not be inserted into a scene, and therefore a static actor to which an invalid constraint is attached may not be inserted into a scene.<p> +Invalid constraints arise only when an actor to which the constraint is attached has been deleted. +</div> +</div><p> +<a class="anchor" name="c54f23bc7b3d52d3b5f265f6750e3199"></a><!-- doxytag: member="PxConstraint::markDirty" ref="c54f23bc7b3d52d3b5f265f6750e3199" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxConstraint::markDirty </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Notify the scene that the constraint shader data has been updated by the application. +<p> + +</div> +</div><p> +<a class="anchor" name="8153c211d21fff49565e7e06e475d5cc"></a><!-- doxytag: member="PxConstraint::release" ref="8153c211d21fff49565e7e06e475d5cc" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxConstraint::release </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Releases a <a class="el" href="classPxConstraint.html" title="A plugin class for implementing constraints.">PxConstraint</a> instance. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>This call does not wake up the connected rigid bodies.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxPhysics.html#1126f3f545ebe183be1753f62d1efc7d" title="Creates a constraint shader.">PxPhysics.createConstraint</a>, <a class="el" href="classPxBase.html#fe6aedda1df0d6d29b1a28213a5ee25a" title="Releases the PxBase instance, please check documentation of release in derived class...">PxBase.release()</a> </dd></dl> + +<p>Implements <a class="el" href="classPxBase.html#fe6aedda1df0d6d29b1a28213a5ee25a">PxBase</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ad3f1f8c8e4220238c8fcb00c440e701"></a><!-- doxytag: member="PxConstraint::setActors" ref="ad3f1f8c8e4220238c8fcb00c440e701" args="(PxRigidActor *actor0, PxRigidActor *actor1)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxConstraint::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> +Sets the actors for this constraint. +<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>a reference to the pointer for the first actor </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>actor1</em> </td><td>a reference to the pointer for the second actor</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK.">PxActor</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="dc0b069b41e76b7c017632cfc24f08d3"></a><!-- doxytag: member="PxConstraint::setBreakForce" ref="dc0b069b41e76b7c017632cfc24f08d3" args="(PxReal linear, PxReal angular)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxConstraint::setBreakForce </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>linear</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>angular</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 and torque thresholds for this constraint. +<p> +If either the force or torque measured at the constraint exceed these thresholds the constraint will break.<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>linear</em> </td><td>the linear break threshold </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>angular</em> </td><td>the angular break threshold </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="3fb6da793a10be50c30bb8e3fb175d68"></a><!-- doxytag: member="PxConstraint::setConstraintFunctions" ref="3fb6da793a10be50c30bb8e3fb175d68" args="(PxConstraintConnector &connector, const PxConstraintShaderTable &shaders)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxConstraint::setConstraintFunctions </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxConstraintConnector.html">PxConstraintConnector</a> & </td> + <td class="paramname"> <em>connector</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structPxConstraintShaderTable.html">PxConstraintShaderTable</a> & </td> + <td class="paramname"> <em>shaders</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 constraint functions for this constraint. +<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>connector</em> </td><td>the constraint connector object by which the SDK communicates with the constraint. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>shaders</em> </td><td>the shader table for the constraint</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxConstraintConnector.html" title="This class connects a custom constraint to the SDK.">PxConstraintConnector</a> <a class="el" href="group__physics.html#g538ba0a5410c612bc666bb10d44bcb7a">PxConstraintSolverPrep</a> <a class="el" href="group__physics.html#g26f16746e25ee96e354e4ee05d6b359e">PxConstraintProject</a> <a class="el" href="group__physics.html#gcb8cd04ba92e7016abe9e14053e22373">PxConstraintVisualize</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="95488eea1d5847d3d1408c3d5cdf2576"></a><!-- doxytag: member="PxConstraint::setFlag" ref="95488eea1d5847d3d1408c3d5cdf2576" args="(PxConstraintFlag::Enum flag, bool value)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxConstraint::setFlag </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 flag for this constraint. +<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 new value of the flag</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__physics.html#gf2b7f07d3fa7fafaf3d85114fbb120ee" title="constraint flags">PxConstraintFlags</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="2d697724814976973b1de9e303e15b3f"></a><!-- doxytag: member="PxConstraint::setFlags" ref="2d697724814976973b1de9e303e15b3f" args="(PxConstraintFlags flags)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxConstraint::setFlags </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 flags for this constraint. +<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 new constraint flags</td></tr> + </table> +</dl> +default: <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc3427330ccf346c5056c0570dbc495007d1ce" title="limits for drive strength are forces rather than impulses">PxConstraintFlag::eDRIVE_LIMITS_ARE_FORCES</a><p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__physics.html#gf2b7f07d3fa7fafaf3d85114fbb120ee" title="constraint flags">PxConstraintFlags</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9ddd5450fca029d9574b5c854b77d3d6"></a><!-- doxytag: member="PxConstraint::setMinResponseThreshold" ref="9ddd5450fca029d9574b5c854b77d3d6" args="(PxReal threshold)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxConstraint::setMinResponseThreshold </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>threshold</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the minimum response threshold for a constraint row. +<p> +When using mass modification for a joint or infinite inertia for a jointed body, very stiff solver constraints can be generated which can destabilize simulation. Setting this value to a small positive value (e.g. 1e-8) will cause constraint rows to be ignored if very large changes in impulses will generate only small changes in velocity. When setting this value, also set <a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc3427519966ef860b18d3609d7c08f66389ef" title="suppress constraint preprocessing, intended for use with rowResponseThreshold. May...">PxConstraintFlag::eDISABLE_PREPROCESSING</a>. The solver accuracy for this joint may be reduced.<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>threshold</em> </td><td>the minimum response threshold</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxConstraintFlag.html#86960e99b3e80ddb9e0ab51d7afc3427519966ef860b18d3609d7c08f66389ef" title="suppress constraint preprocessing, intended for use with rowResponseThreshold. May...">PxConstraintFlag::eDISABLE_PREPROCESSING</a> </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxConstraint_8h-source.html">PxConstraint.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> |