diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/structPxClothStretchConfig.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/structPxClothStretchConfig.html | 178 |
1 files changed, 178 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/structPxClothStretchConfig.html b/PhysX_3.4/Documentation/PhysXAPI/files/structPxClothStretchConfig.html new file mode 100644 index 00000000..4ba92335 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/structPxClothStretchConfig.html @@ -0,0 +1,178 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxClothStretchConfig Struct 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>PxClothStretchConfig Struct Reference<br> +<small> +[<a class="el" href="group__cloth.html">Cloth</a>]</small> +</h1><!-- doxytag: class="PxClothStretchConfig" -->Solver configuration parameters for the vertical and horizontal stretch phase types. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxCloth_8h-source.html">PxCloth.h</a>></code> +<p> + +<p> +<a href="structPxClothStretchConfig-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">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothStretchConfig.html#94ea9465247eaace088e6a358c161ae5">PxClothStretchConfig</a> (PxReal stiffness_=1.0f, PxReal stiffnessMultiplier_=1.0f, PxReal compressionLimit_=1.0f, PxReal stretchLimit_=1.0f)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor initializes to default values. <a href="#94ea9465247eaace088e6a358c161ae5"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothStretchConfig.html#fd8ab340f7881bf434addde22bf28ffd">stiffness</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Stiffness of the stretch constraints. <a href="#fd8ab340f7881bf434addde22bf28ffd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothStretchConfig.html#9f67d875254a4a16c2e31f53e43251b6">stiffnessMultiplier</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Stiffness multiplier of the cloth solver under certain limits. <a href="#9f67d875254a4a16c2e31f53e43251b6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothStretchConfig.html#ad66f56640cefd4edbf452767b6e1f19">compressionLimit</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Limit to control when stiffnessMultiplier has to be applied. <a href="#ad66f56640cefd4edbf452767b6e1f19"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothStretchConfig.html#e7754c4ad295e3a70111fc3ddbf7c747">stretchLimit</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Limit to control when stiffnessMultiplier has to be applied. <a href="#e7754c4ad295e3a70111fc3ddbf7c747"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Solver configuration parameters for the vertical and horizontal stretch phase types. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxCloth.html#287124c7b4d26640849b8dd3489fff0d" title="Sets the solver parameters for the vertical solver phases.">PxCloth.setStretchConfig()</a> <p> +<a class="el" href="classPxClothFabric.html" title="A cloth fabric is a structure that contains all the internal solver constraints of...">PxClothFabric</a> for information on actual phase data in <a class="el" href="group__cloth.html">Cloth</a> fabric </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="94ea9465247eaace088e6a358c161ae5"></a><!-- doxytag: member="PxClothStretchConfig::PxClothStretchConfig" ref="94ea9465247eaace088e6a358c161ae5" args="(PxReal stiffness_=1.0f, PxReal stiffnessMultiplier_=1.0f, PxReal compressionLimit_=1.0f, PxReal stretchLimit_=1.0f)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxClothStretchConfig::PxClothStretchConfig </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>stiffness_</em> = <code>1.0f</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>stiffnessMultiplier_</em> = <code>1.0f</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>compressionLimit_</em> = <code>1.0f</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>stretchLimit_</em> = <code>1.0f</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructor initializes to default values. +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="ad66f56640cefd4edbf452767b6e1f19"></a><!-- doxytag: member="PxClothStretchConfig::compressionLimit" ref="ad66f56640cefd4edbf452767b6e1f19" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="structPxClothStretchConfig.html#ad66f56640cefd4edbf452767b6e1f19">PxClothStretchConfig::compressionLimit</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Limit to control when stiffnessMultiplier has to be applied. +<p> +stiffnessMultiplier multiplies the normal stiffness if the ratio between constraint edge length and rest length lies in the [compressionLimit, 1] range. The valid range is [0, 1], the default limit is 1.0. +</div> +</div><p> +<a class="anchor" name="fd8ab340f7881bf434addde22bf28ffd"></a><!-- doxytag: member="PxClothStretchConfig::stiffness" ref="fd8ab340f7881bf434addde22bf28ffd" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="structPxClothStretchConfig.html#fd8ab340f7881bf434addde22bf28ffd">PxClothStretchConfig::stiffness</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Stiffness of the stretch constraints. +<p> +Defines for the constraint edges how much of the distance error between current length and rest length to correct per stiffness period (see <a class="el" href="classPxCloth.html#3a353d83924d66f611186e0d8a046c63" title="Sets the stiffness frequency parameter.">PxCloth::setStiffnessFrequency</a>). A value of 0 means no correction, a value of 1 corrects to rest length. The default is 1. +</div> +</div><p> +<a class="anchor" name="9f67d875254a4a16c2e31f53e43251b6"></a><!-- doxytag: member="PxClothStretchConfig::stiffnessMultiplier" ref="9f67d875254a4a16c2e31f53e43251b6" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="structPxClothStretchConfig.html#9f67d875254a4a16c2e31f53e43251b6">PxClothStretchConfig::stiffnessMultiplier</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Stiffness multiplier of the cloth solver under certain limits. +<p> +The valid range is [0, 1], the default multiplier is 1.0. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxClothStretchConfig.html#e7754c4ad295e3a70111fc3ddbf7c747" title="Limit to control when stiffnessMultiplier has to be applied.">stretchLimit</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e7754c4ad295e3a70111fc3ddbf7c747"></a><!-- doxytag: member="PxClothStretchConfig::stretchLimit" ref="e7754c4ad295e3a70111fc3ddbf7c747" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="structPxClothStretchConfig.html#e7754c4ad295e3a70111fc3ddbf7c747">PxClothStretchConfig::stretchLimit</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Limit to control when stiffnessMultiplier has to be applied. +<p> +stiffnessMultiplier multiplies the normal stiffness if the ratio between constraint edge length and rest length lies in the [1, stretchLimit] range. The valid range is [1, PX_MAX_F32), the default limit is 1.0. +</div> +</div><p> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="PxCloth_8h-source.html">PxCloth.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> |