aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/structPxClothTetherConfig.html
blob: ed20c53be6879769ad6c4268abb0e7775b3c4c5e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxClothTetherConfig 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> &nbsp; 
				<a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; 
				<a class="qindex" href="annotated.html">Compound List</a> &nbsp; 
				<a class="qindex" href="functions.html">Compound Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxClothTetherConfig Struct Reference<br>
<small>
[<a class="el" href="group__cloth.html">cloth (deprecated)</a>]</small>
</h1><!-- doxytag: class="PxClothTetherConfig" -->Solver configuration parameters for the tether phases.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxCloth_8h-source.html">PxCloth.h</a>&gt;</code>
<p>

<p>
<a href="structPxClothTetherConfig-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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothTetherConfig.html#d8c144efc57cfd6eca2740538295d76e">PxClothTetherConfig</a> (PxReal stiffness_=1.0f, PxReal stretchLimit_=1.0f)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor sets to default.  <a href="#d8c144efc57cfd6eca2740538295d76e"></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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothTetherConfig.html#182e2fcb7ad9e1b09e457dadad480e95">stiffness</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stiffness of the tether constraints.  <a href="#182e2fcb7ad9e1b09e457dadad480e95"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxClothTetherConfig.html#e39c5e9fcdc3ec3a771ab2274fe81ebc">stretchLimit</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Scale of tether lengths when applying tether constraints.  <a href="#e39c5e9fcdc3ec3a771ab2274fe81ebc"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Solver configuration parameters for the tether phases. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxCloth.html#b6f7f3f91fe4f2ed5e2620605c4723ff" title="Sets the stiffness parameters for the tether constraints.">PxCloth.setTetherConfig()</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 tether constraints in <a class="el" href="group__cloth.html">cloth (deprecated)</a> fabric. </dd></dl>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000057">Deprecated:</a></b></dt><dd>The PhysX cloth feature has been deprecated in PhysX version 3.4.1 </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="d8c144efc57cfd6eca2740538295d76e"></a><!-- doxytag: member="PxClothTetherConfig::PxClothTetherConfig" ref="d8c144efc57cfd6eca2740538295d76e" args="(PxReal stiffness_=1.0f, PxReal stretchLimit_=1.0f)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_INLINE PxClothTetherConfig::PxClothTetherConfig           </td>
          <td>(</td>
          <td class="paramtype">PxReal&nbsp;</td>
          <td class="paramname"> <em>stiffness_</em> = <code>1.0f</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PxReal&nbsp;</td>
          <td class="paramname"> <em>stretchLimit_</em> = <code>1.0f</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor sets to default. 
<p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="182e2fcb7ad9e1b09e457dadad480e95"></a><!-- doxytag: member="PxClothTetherConfig::stiffness" ref="182e2fcb7ad9e1b09e457dadad480e95" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxReal <a class="el" href="structPxClothTetherConfig.html#182e2fcb7ad9e1b09e457dadad480e95">PxClothTetherConfig::stiffness</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Stiffness of the tether constraints. 
<p>
Defines for the tether constraints how much of the error between current distance and tether 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 stiffness is 1.0. 
</div>
</div><p>
<a class="anchor" name="e39c5e9fcdc3ec3a771ab2274fe81ebc"></a><!-- doxytag: member="PxClothTetherConfig::stretchLimit" ref="e39c5e9fcdc3ec3a771ab2274fe81ebc" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxReal <a class="el" href="structPxClothTetherConfig.html#e39c5e9fcdc3ec3a771ab2274fe81ebc">PxClothTetherConfig::stretchLimit</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Scale of tether lengths when applying tether constraints. 
<p>
The limit distance of a tether constraint is computed as the product of stretchLimit and the tether length. 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 &copy; 2008-2018 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>