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/classPxClothFabricCooker.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/classPxClothFabricCooker.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxClothFabricCooker.html | 188 |
1 files changed, 188 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxClothFabricCooker.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxClothFabricCooker.html new file mode 100644 index 00000000..ab1658ba --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxClothFabricCooker.html @@ -0,0 +1,188 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxClothFabricCooker 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>PxClothFabricCooker Class Reference<br> +<small> +[<a class="el" href="group__extensions.html">Extensions</a>]</small> +</h1><!-- doxytag: class="PxClothFabricCooker" --><code>#include <<a class="el" href="PxClothFabricCooker_8h-source.html">PxClothFabricCooker.h</a>></code> +<p> + +<p> +<a href="classPxClothFabricCooker-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="classPxClothFabricCooker.html#b837011efb0ada8bc6a9866d539ec72f">PxClothFabricCooker</a> (const <a class="el" href="classPxClothMeshDesc.html">PxClothMeshDesc</a> &desc, const <a class="el" href="classPxVec3.html">PxVec3</a> &gravity, bool useGeodesicTether=true)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Cooks a triangle mesh to a <a class="el" href="classPxClothFabricDesc.html" title="References all the data required to create a fabric.">PxClothFabricDesc</a>. <a href="#b837011efb0ada8bc6a9866d539ec72f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxClothFabricCooker.html#1da47c2eb6ce951637eea65a1b785faa">~PxClothFabricCooker</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxClothFabricDesc.html">PxClothFabricDesc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxClothFabricCooker.html#041888e50a3dcd31130ea63443696deb">getDescriptor</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the fabric descriptor to create the fabric. <a href="#041888e50a3dcd31130ea63443696deb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxClothFabricCooker.html#6d9657cf26e9eece0d0fe66dfaf5f12a">save</a> (<a class="el" href="classPxOutputStream.html">PxOutputStream</a> &stream, bool platformMismatch) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Saves the fabric data to a platform and version dependent stream. <a href="#6d9657cf26e9eece0d0fe66dfaf5f12a"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxFabricCookerImpl * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxClothFabricCooker.html#ce53b5654f9a13c07be3194913082530">mImpl</a></td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="b837011efb0ada8bc6a9866d539ec72f"></a><!-- doxytag: member="PxClothFabricCooker::PxClothFabricCooker" ref="b837011efb0ada8bc6a9866d539ec72f" args="(const PxClothMeshDesc &desc, const PxVec3 &gravity, bool useGeodesicTether=true)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxClothFabricCooker::PxClothFabricCooker </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxClothMeshDesc.html">PxClothMeshDesc</a> & </td> + <td class="paramname"> <em>desc</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>gravity</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>useGeodesicTether</em> = <code>true</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Cooks a triangle mesh to a <a class="el" href="classPxClothFabricDesc.html" title="References all the data required to create a fabric.">PxClothFabricDesc</a>. +<p> +<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 on which the generation of the cooked mesh depends. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>gravity</em> </td><td>A normalized vector which specifies the direction of gravity. This information allows the cooker to generate a fabric with higher quality simulation behavior. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>useGeodesicTether</em> </td><td>A flag to indicate whether to compute geodesic distance for tether constraints. </td></tr> + </table> +</dl> +<dl class="note" compact><dt><b>Note:</b></dt><dd>The geodesic option for tether only works for manifold input. For non-manifold input, a simple Euclidean distance will be used. For more detailed cooker status for such cases, try running <a class="el" href="classPxClothGeodesicTetherCooker.html">PxClothGeodesicTetherCooker</a> directly. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="1da47c2eb6ce951637eea65a1b785faa"></a><!-- doxytag: member="PxClothFabricCooker::~PxClothFabricCooker" ref="1da47c2eb6ce951637eea65a1b785faa" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxClothFabricCooker::~PxClothFabricCooker </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="041888e50a3dcd31130ea63443696deb"></a><!-- doxytag: member="PxClothFabricCooker::getDescriptor" ref="041888e50a3dcd31130ea63443696deb" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxClothFabricDesc.html">PxClothFabricDesc</a> PxClothFabricCooker::getDescriptor </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the fabric descriptor to create the fabric. +<p> + +</div> +</div><p> +<a class="anchor" name="6d9657cf26e9eece0d0fe66dfaf5f12a"></a><!-- doxytag: member="PxClothFabricCooker::save" ref="6d9657cf26e9eece0d0fe66dfaf5f12a" args="(PxOutputStream &stream, bool platformMismatch) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxClothFabricCooker::save </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxOutputStream.html">PxOutputStream</a> & </td> + <td class="paramname"> <em>stream</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>platformMismatch</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Saves the fabric data to a platform and version dependent stream. +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="ce53b5654f9a13c07be3194913082530"></a><!-- doxytag: member="PxClothFabricCooker::mImpl" ref="ce53b5654f9a13c07be3194913082530" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxFabricCookerImpl* <a class="el" href="classPxClothFabricCooker.html#ce53b5654f9a13c07be3194913082530">PxClothFabricCooker::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="PxClothFabricCooker_8h-source.html">PxClothFabricCooker.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> |