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/classPxClothSimpleTetherCooker.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/classPxClothSimpleTetherCooker.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxClothSimpleTetherCooker.html | 144 |
1 files changed, 144 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxClothSimpleTetherCooker.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxClothSimpleTetherCooker.html new file mode 100644 index 00000000..730907b0 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxClothSimpleTetherCooker.html @@ -0,0 +1,144 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxClothSimpleTetherCooker 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>PxClothSimpleTetherCooker Class Reference</h1><!-- doxytag: class="PxClothSimpleTetherCooker" --><code>#include <<a class="el" href="PxClothTetherCooker_8h-source.html">PxClothTetherCooker.h</a>></code> +<p> + +<p> +<a href="classPxClothSimpleTetherCooker-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxClothSimpleTetherCooker.html#12acbb7e523e2b1cff25a41add360e79">PxClothSimpleTetherCooker</a> (const <a class="el" href="classPxClothMeshDesc.html">PxClothMeshDesc</a> &desc)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute tether data from <a class="el" href="classPxClothMeshDesc.html" title="Descriptor class for a cloth mesh.">PxClothMeshDesc</a> with simple distance measure. <a href="#12acbb7e523e2b1cff25a41add360e79"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxClothSimpleTetherCooker.html#9cf9905858b8ef134150d23428e614a1">~PxClothSimpleTetherCooker</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxClothSimpleTetherCooker.html#4a7bc691494d9941f39ab1a12bc8aff7">getTetherData</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> *userTetherAnchors, PxReal *userTetherLengths) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns computed tether data. <a href="#4a7bc691494d9941f39ab1a12bc8aff7"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxClothSimpleTetherCookerImpl * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxClothSimpleTetherCooker.html#1a5c734b0e171d117f763656fe6e2b3a">mImpl</a></td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="12acbb7e523e2b1cff25a41add360e79"></a><!-- doxytag: member="PxClothSimpleTetherCooker::PxClothSimpleTetherCooker" ref="12acbb7e523e2b1cff25a41add360e79" args="(const PxClothMeshDesc &desc)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxClothSimpleTetherCooker::PxClothSimpleTetherCooker </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxClothMeshDesc.html">PxClothMeshDesc</a> & </td> + <td class="paramname"> <em>desc</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Compute tether data from <a class="el" href="classPxClothMeshDesc.html" title="Descriptor class for a cloth mesh.">PxClothMeshDesc</a> with simple distance measure. +<p> +The tether constraint in <a class="el" href="classPxCloth.html" title="Set of connected particles tailored towards simulating character cloth.">PxCloth</a> requires rest distance and anchor index to be precomputed during cooking time. This cooker computes a simple Euclidean distance to closest anchor point. The Euclidean distance measure works reasonably for flat cloth and flags and computation time is very fast. With this cooker, there is only one tether anchor point per particle. <dl class="see" compact><dt><b>See also:</b></dt><dd>PxClothTetherGeodesicCooker for more accurate distance estimation. </dd></dl> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>desc</em> </td><td>The cloth mesh descriptor prepared for cooking </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="9cf9905858b8ef134150d23428e614a1"></a><!-- doxytag: member="PxClothSimpleTetherCooker::~PxClothSimpleTetherCooker" ref="9cf9905858b8ef134150d23428e614a1" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxClothSimpleTetherCooker::~PxClothSimpleTetherCooker </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="4a7bc691494d9941f39ab1a12bc8aff7"></a><!-- doxytag: member="PxClothSimpleTetherCooker::getTetherData" ref="4a7bc691494d9941f39ab1a12bc8aff7" args="(PxU32 *userTetherAnchors, PxReal *userTetherLengths) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxClothSimpleTetherCooker::getTetherData </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> * </td> + <td class="paramname"> <em>userTetherAnchors</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal * </td> + <td class="paramname"> <em>userTetherLengths</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns computed tether data. +<p> +This function returns anchor indices for each particle as well as desired distance between the tether anchor and the particle. The user buffers should be at least as large as number of particles. +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="1a5c734b0e171d117f763656fe6e2b3a"></a><!-- doxytag: member="PxClothSimpleTetherCooker::mImpl" ref="1a5c734b0e171d117f763656fe6e2b3a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxClothSimpleTetherCookerImpl* <a class="el" href="classPxClothSimpleTetherCooker.html#1a5c734b0e171d117f763656fe6e2b3a">PxClothSimpleTetherCooker::mImpl</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxClothTetherCooker_8h-source.html">PxClothTetherCooker.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> |