aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxConvexMeshGeometry.html
blob: 8c2e598d78b509da4d0b412146932ebc09a2e583 (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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxConvexMeshGeometry 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> &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>PxConvexMeshGeometry Class Reference<br>
<small>
[<a class="el" href="group__geomutils.html">Geomutils</a>]</small>
</h1><!-- doxytag: class="PxConvexMeshGeometry" --><!-- doxytag: inherits="PxGeometry" -->Convex mesh geometry class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxConvexMeshGeometry_8h-source.html">PxConvexMeshGeometry.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for PxConvexMeshGeometry:</div>
<div class="dynsection">
<p><center><img src="classPxConvexMeshGeometry__inherit__graph.png" border="0" usemap="#PxConvexMeshGeometry__inherit__map" alt="Inheritance graph"></center>
<map name="PxConvexMeshGeometry__inherit__map">
<area shape="rect" href="classPxGeometry.html" title="A geometry object." alt="PxGeometry" coords="44,16,129,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxConvexMeshGeometry:</div>
<div class="dynsection">
<p><center><img src="classPxConvexMeshGeometry__coll__graph.png" border="0" usemap="#PxConvexMeshGeometry__coll__map" alt="Collaboration graph"></center>
<map name="PxConvexMeshGeometry__coll__map">
<area shape="rect" href="classPxGeometry.html" title="A geometry object." alt="PxGeometry" coords="673,8,759,29"><area shape="rect" href="classPxFlags.html" title="PxFlags\&lt; PxConvexMeshGeometryFlag::Enum, PxU8 \&gt;" alt="PxFlags\&lt; PxConvexMeshGeometryFlag::Enum, PxU8 \&gt;" coords="549,67,883,88"><area shape="rect" href="classPxMeshScale.html" title="A class expressing a nonuniform scaling transformation." alt="PxMeshScale" coords="671,136,761,157"><area shape="rect" href="classPxVec3.html" title="3 Element vector class." alt="PxVec3" coords="391,101,444,123"><area shape="rect" href="classPxQuat.html" title="This is a quaternion class. For more information on quaternion mathematics consult..." alt="PxQuat" coords="391,171,444,192"><area shape="rect" href="structPxPadding.html" title="PxPadding\&lt; 3 \&gt;" alt="PxPadding\&lt; 3 \&gt;" coords="664,205,768,227"><area shape="rect" href="classPxConvexMesh.html" title="A convex mesh." alt="PxConvexMesh" coords="665,275,767,296"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="389,275,445,296"><area shape="rect" href="classPxFlags.html" title="PxFlags\&lt; PxBaseFlag::Enum, PxU16 \&gt;" alt="PxFlags\&lt; PxBaseFlag::Enum, PxU16 \&gt;" coords="17,275,255,296"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classPxConvexMeshGeometry-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="classPxConvexMeshGeometry.html#1560beb69b5adf8d53d7dd13524438a1">PxConvexMeshGeometry</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#1560beb69b5adf8d53d7dd13524438a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshGeometry.html#9a514176c85b854f1a32b0d3ae0c00bc">PxConvexMeshGeometry</a> (<a class="el" href="classPxConvexMesh.html">PxConvexMesh</a> *mesh, const <a class="el" href="classPxMeshScale.html">PxMeshScale</a> &amp;scaling=<a class="el" href="classPxMeshScale.html">PxMeshScale</a>(), <a class="el" href="classPxFlags.html">PxConvexMeshGeometryFlags</a> flags=<a class="el" href="classPxFlags.html">PxConvexMeshGeometryFlags</a>(), float margin=3.4e38f)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#9a514176c85b854f1a32b0d3ae0c00bc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__geomutils.html#geb9f7427fef44fef543098cb347b59e6">isValid</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the geometry is valid.  <a href="group__geomutils.html#geb9f7427fef44fef543098cb347b59e6"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxMeshScale.html">PxMeshScale</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshGeometry.html#777f625bb1fd49fabf03eb4be02ed581">scale</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The scaling transformation (from vertex space to shape space).  <a href="#777f625bb1fd49fabf03eb4be02ed581"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxConvexMesh.html">PxConvexMesh</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshGeometry.html#2fdc589d347de81e55c8b45b7c133feb">convexMesh</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A reference to the convex mesh object.  <a href="#2fdc589d347de81e55c8b45b7c133feb"></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="classPxConvexMeshGeometry.html#769be6bf3be1bd8a39ea0a3ee6b092b1">maxMargin</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Max shrunk amount permitted by PCM contact gen.  <a href="#769be6bf3be1bd8a39ea0a3ee6b092b1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxFlags.html">PxConvexMeshGeometryFlags</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshGeometry.html#6b2561b421c602ca110e6870a3037d49">meshFlags</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mesh flags.  <a href="#6b2561b421c602ca110e6870a3037d49"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxPadding.html">PxPadding</a>&lt; 3 &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshGeometry.html#d2bed15287e31918b5ca0051f0604eeb">paddingFromFlags</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">padding for mesh flags  <a href="#d2bed15287e31918b5ca0051f0604eeb"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Convex mesh geometry class. 
<p>
This class unifies a convex mesh object with a scaling transform, and lets the combined object be used anywhere a <a class="el" href="classPxGeometry.html" title="A geometry object.">PxGeometry</a> is needed.<p>
The scaling is a transform along arbitrary axes contained in the scale object. The vertices of the mesh in geometry (or shape) space is the <a class="el" href="classPxMeshScale.html#e2b26c0cb36188e42f532f8c22024a71" title="Converts this transformation to a 3x3 matrix representation.">PxMeshScale::toMat33()</a> transform, multiplied by the vertex space vertices in the <a class="el" href="classPxConvexMesh.html" title="A convex mesh.">PxConvexMesh</a> object. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="1560beb69b5adf8d53d7dd13524438a1"></a><!-- doxytag: member="PxConvexMeshGeometry::PxConvexMeshGeometry" ref="1560beb69b5adf8d53d7dd13524438a1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_INLINE PxConvexMeshGeometry::PxConvexMeshGeometry           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Default constructor. 
<p>
Creates an empty object with a NULL mesh and identity scale. 
</div>
</div><p>
<a class="anchor" name="9a514176c85b854f1a32b0d3ae0c00bc"></a><!-- doxytag: member="PxConvexMeshGeometry::PxConvexMeshGeometry" ref="9a514176c85b854f1a32b0d3ae0c00bc" args="(PxConvexMesh *mesh, const PxMeshScale &amp;scaling=PxMeshScale(), PxConvexMeshGeometryFlags flags=PxConvexMeshGeometryFlags(), float margin=3.4e38f)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_INLINE PxConvexMeshGeometry::PxConvexMeshGeometry           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classPxConvexMesh.html">PxConvexMesh</a> *&nbsp;</td>
          <td class="paramname"> <em>mesh</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxMeshScale.html">PxMeshScale</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>scaling</em> = <code><a class="el" href="classPxMeshScale.html">PxMeshScale</a>()</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classPxFlags.html">PxConvexMeshGeometryFlags</a>&nbsp;</td>
          <td class="paramname"> <em>flags</em> = <code><a class="el" href="classPxFlags.html">PxConvexMeshGeometryFlags</a>()</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>margin</em> = <code>3.4e38f</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. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>mesh</em>&nbsp;</td><td>Mesh pointer. May be NULL, though this will not make the object valid for shape construction. </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>scaling</em>&nbsp;</td><td>Scale factor. </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>flags</em>&nbsp;</td><td>Mesh flags. </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>margin</em>&nbsp;</td><td>The maximum margin. Used to limit how much PCM shrinks the geometry by in collision detection. \ </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="2fdc589d347de81e55c8b45b7c133feb"></a><!-- doxytag: member="PxConvexMeshGeometry::convexMesh" ref="2fdc589d347de81e55c8b45b7c133feb" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classPxConvexMesh.html">PxConvexMesh</a>* <a class="el" href="classPxConvexMeshGeometry.html#2fdc589d347de81e55c8b45b7c133feb">PxConvexMeshGeometry::convexMesh</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
A reference to the convex mesh object. 
<p>

<p>Referenced by <a class="el" href="PxConvexMeshGeometry_8h-source.html#l00136">isValid()</a>, and <a class="el" href="PxMassProperties_8h-source.html#l00083">PxMassProperties::PxMassProperties()</a>.</p>

</div>
</div><p>
<a class="anchor" name="769be6bf3be1bd8a39ea0a3ee6b092b1"></a><!-- doxytag: member="PxConvexMeshGeometry::maxMargin" ref="769be6bf3be1bd8a39ea0a3ee6b092b1" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxReal <a class="el" href="classPxConvexMeshGeometry.html#769be6bf3be1bd8a39ea0a3ee6b092b1">PxConvexMeshGeometry::maxMargin</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Max shrunk amount permitted by PCM contact gen. 
<p>

<p>Referenced by <a class="el" href="PxConvexMeshGeometry_8h-source.html#l00136">isValid()</a>.</p>

</div>
</div><p>
<a class="anchor" name="6b2561b421c602ca110e6870a3037d49"></a><!-- doxytag: member="PxConvexMeshGeometry::meshFlags" ref="6b2561b421c602ca110e6870a3037d49" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classPxFlags.html">PxConvexMeshGeometryFlags</a> <a class="el" href="classPxConvexMeshGeometry.html#6b2561b421c602ca110e6870a3037d49">PxConvexMeshGeometry::meshFlags</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Mesh flags. 
<p>

</div>
</div><p>
<a class="anchor" name="d2bed15287e31918b5ca0051f0604eeb"></a><!-- doxytag: member="PxConvexMeshGeometry::paddingFromFlags" ref="d2bed15287e31918b5ca0051f0604eeb" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structPxPadding.html">PxPadding</a>&lt;3&gt; <a class="el" href="classPxConvexMeshGeometry.html#d2bed15287e31918b5ca0051f0604eeb">PxConvexMeshGeometry::paddingFromFlags</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
padding for mesh flags 
<p>

</div>
</div><p>
<a class="anchor" name="777f625bb1fd49fabf03eb4be02ed581"></a><!-- doxytag: member="PxConvexMeshGeometry::scale" ref="777f625bb1fd49fabf03eb4be02ed581" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classPxMeshScale.html">PxMeshScale</a> <a class="el" href="classPxConvexMeshGeometry.html#777f625bb1fd49fabf03eb4be02ed581">PxConvexMeshGeometry::scale</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The scaling transformation (from vertex space to shape space). 
<p>

<p>Referenced by <a class="el" href="PxConvexMeshGeometry_8h-source.html#l00136">isValid()</a>, and <a class="el" href="PxMassProperties_8h-source.html#l00083">PxMassProperties::PxMassProperties()</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxConvexMeshGeometry_8h-source.html">PxConvexMeshGeometry.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>