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/group__cloth.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/group__cloth.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/group__cloth.html | 208 |
1 files changed, 208 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/group__cloth.html b/PhysX_3.4/Documentation/PhysXAPI/files/group__cloth.html new file mode 100644 index 00000000..070a114c --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/group__cloth.html @@ -0,0 +1,208 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: Cloth</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>Cloth</h1><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Classes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothStretchConfig.html">PxClothStretchConfig</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Solver configuration parameters for the vertical and horizontal stretch phase types. <a href="structPxClothStretchConfig.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothTetherConfig.html">PxClothTetherConfig</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Solver configuration parameters for the tether phases. <a href="structPxClothTetherConfig.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothMotionConstraintConfig.html">PxClothMotionConstraintConfig</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Solver configuration parameters for the tether phases. <a href="structPxClothMotionConstraintConfig.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCloth.html">PxCloth</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set of connected particles tailored towards simulating character cloth. <a href="classPxCloth.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothCollisionSphere.html">PxClothCollisionSphere</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sphere representation used for cloth-sphere and cloth-capsule collision. <a href="structPxClothCollisionSphere.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothCollisionPlane.html">PxClothCollisionPlane</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Plane representation used for cloth-convex collision. <a href="structPxClothCollisionPlane.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothCollisionTriangle.html">PxClothCollisionTriangle</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Triangle representation used for cloth-mesh collision. <a href="structPxClothCollisionTriangle.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothFabricPhaseType.html">PxClothFabricPhaseType</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Describe type of phase in cloth fabric. <a href="structPxClothFabricPhaseType.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothFabricPhase.html">PxClothFabricPhase</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">References a set of constraints that can be solved in parallel. <a href="structPxClothFabricPhase.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxClothFabricDesc.html">PxClothFabricDesc</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">References all the data required to create a fabric. <a href="classPxClothFabricDesc.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxClothFabric.html">PxClothFabric</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A cloth fabric is a structure that contains all the internal solver constraints of a cloth mesh. <a href="classPxClothFabric.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothFlag.html">PxClothFlag</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">flag for behaviors of the cloth solver <a href="structPxClothFlag.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothParticle.html">PxClothParticle</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Per particle data for cloth. <a href="structPxClothParticle.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothParticleMotionConstraint.html">PxClothParticleMotionConstraint</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constraints for cloth particle motion. <a href="structPxClothParticleMotionConstraint.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothParticleSeparationConstraint.html">PxClothParticleSeparationConstraint</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Separation constraints for cloth particle movement. <a href="structPxClothParticleSeparationConstraint.html#_details">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classPxFlags.html">PxFlags</a><br class="typebreak"> +< <a class="el" href="structPxClothFlag.html#e53797ea68710df0ee906aea21693fe2">PxClothFlag::Enum</a>, PxU16 > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cloth.html#g2be4311f196add0112bf7148caa36151">PxClothFlags</a></td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cloth.html#ga6666ad3d3501085542b7c9ccc94a8d7">PxClothFabricPhase::PxClothFabricPhase</a> (<a class="el" href="structPxClothFabricPhaseType.html#9f876cdc99a8e874ef799592a5f5562e">PxClothFabricPhaseType::Enum</a> type=PxClothFabricPhaseType::eINVALID, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> index=0)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cloth.html#g67e57148524e0336ebc001c5dc9f345f">PxClothFabricDesc::PxClothFabricDesc</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor sets to default. <a href="#g67e57148524e0336ebc001c5dc9f345f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cloth.html#g2a75f18d35312c00faeacf1e144af741">PxClothFabricDesc::setToDefault</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">(re)sets the structure to the default. <a href="#g2a75f18d35312c00faeacf1e144af741"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cloth.html#g9da16e662b3e661e129cb7cb8726b8dd">PxClothFabricDesc::isValid</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the descriptor is valid. <a href="#g9da16e662b3e661e129cb7cb8726b8dd"></a><br></td></tr> +</table> +<hr><h2>Typedef Documentation</h2> +<a class="anchor" name="g2be4311f196add0112bf7148caa36151"></a><!-- doxytag: member="PxClothTypes.h::PxClothFlags" ref="g2be4311f196add0112bf7148caa36151" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef <a class="el" href="classPxFlags.html">PxFlags</a><<a class="el" href="structPxClothFlag.html#e53797ea68710df0ee906aea21693fe2">PxClothFlag::Enum</a>,PxU16> <a class="el" href="classPxFlags.html">PxClothFlags</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="g9da16e662b3e661e129cb7cb8726b8dd"></a><!-- doxytag: member="PxClothFabricDesc::isValid" ref="g9da16e662b3e661e129cb7cb8726b8dd" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE bool PxClothFabricDesc::isValid </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inherited]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns true if the descriptor is valid. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the current settings are valid </dd></dl> + +<p>References <a class="el" href="PxClothFabric_8h-source.html#l00109">PxClothFabricDesc::indices</a>, <a class="el" href="PxClothFabric_8h-source.html#l00096">PxClothFabricDesc::nbParticles</a>, <a class="el" href="PxClothFabric_8h-source.html#l00099">PxClothFabricDesc::nbPhases</a>, <a class="el" href="PxClothFabric_8h-source.html#l00104">PxClothFabricDesc::nbSets</a>, <a class="el" href="PxClothFabric_8h-source.html#l00114">PxClothFabricDesc::nbTethers</a>, <a class="el" href="PxClothFabric_8h-source.html#l00123">PxClothFabricDesc::nbTriangles</a>, <a class="el" href="PxClothFabric_8h-source.html#l00101">PxClothFabricDesc::phases</a>, <a class="el" href="PxClothFabric_8h-source.html#l00111">PxClothFabricDesc::restvalues</a>, <a class="el" href="PxClothFabric_8h-source.html#l00106">PxClothFabricDesc::sets</a>, <a class="el" href="PxClothFabric_8h-source.html#l00116">PxClothFabricDesc::tetherAnchors</a>, <a class="el" href="PxClothFabric_8h-source.html#l00118">PxClothFabricDesc::tetherLengths</a>, and <a class="el" href="PxClothFabric_8h-source.html#l00121">PxClothFabricDesc::triangles</a>.</p> + +</div> +</div><p> +<a class="anchor" name="g67e57148524e0336ebc001c5dc9f345f"></a><!-- doxytag: member="PxClothFabricDesc::PxClothFabricDesc" ref="g67e57148524e0336ebc001c5dc9f345f" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxClothFabricDesc::PxClothFabricDesc </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inherited]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +constructor sets to default. +<p> + +<p>References <a class="el" href="PxClothFabric_8h-source.html#l00147">PxClothFabricDesc::setToDefault()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ga6666ad3d3501085542b7c9ccc94a8d7"></a><!-- doxytag: member="PxClothFabricPhase::PxClothFabricPhase" ref="ga6666ad3d3501085542b7c9ccc94a8d7" args="(PxClothFabricPhaseType::Enum type=PxClothFabricPhaseType::eINVALID, PxU32 index=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxClothFabricPhase::PxClothFabricPhase </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structPxClothFabricPhaseType.html#9f876cdc99a8e874ef799592a5f5562e">PxClothFabricPhaseType::Enum</a> </td> + <td class="paramname"> <em>type</em> = <code>PxClothFabricPhaseType::eINVALID</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>index</em> = <code>0</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inherited]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="g2a75f18d35312c00faeacf1e144af741"></a><!-- doxytag: member="PxClothFabricDesc::setToDefault" ref="g2a75f18d35312c00faeacf1e144af741" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE void PxClothFabricDesc::setToDefault </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inherited]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +(re)sets the structure to the default. +<p> + +<p>Referenced by <a class="el" href="PxClothFabric_8h-source.html#l00142">PxClothFabricDesc::PxClothFabricDesc()</a>.</p> + +</div> +</div><p> +</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> |