aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxMidphaseDesc.html
blob: 540ae9bdc3aedec9decf2ada6d12ccc73c78fd4a (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
252
253
254
255
256
257
258
259
260
261
262
263
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxMidphaseDesc 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>PxMidphaseDesc Class Reference<br>
<small>
[<a class="el" href="group__cooking.html">Cooking</a>]</small>
</h1><!-- doxytag: class="PxMidphaseDesc" -->Structure describing parameters affecting midphase mesh structure.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxMidphaseDesc_8h-source.html">PxMidphaseDesc.h</a>&gt;</code>
<p>
<div class="dynheader">
Collaboration diagram for PxMidphaseDesc:</div>
<div class="dynsection">
<p><center><img src="classPxMidphaseDesc__coll__graph.png" border="0" usemap="#PxMidphaseDesc__coll__map" alt="Collaboration graph"></center>
<map name="PxMidphaseDesc__coll__map">
<area shape="rect" href="structPxBVH34MidphaseDesc.html" title="Structure describing parameters affecting BVH34 midphase mesh structure." alt="PxBVH34MidphaseDesc" coords="7,16,159,37"><area shape="rect" href="structPxBVH33MidphaseDesc.html" title="Structure describing parameters affecting BVH33 midphase mesh structure." alt="PxBVH33MidphaseDesc" coords="183,16,335,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classPxMidphaseDesc-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_FORCE_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMidphaseDesc.html#2884c3beff507638b6bceb78c46c9eee">PxMidphaseDesc</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE <br class="typebreak">
<a class="el" href="structPxMeshMidPhase.html#49f740883fbfb1a49631c28818c219f4">PxMeshMidPhase::Enum</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMidphaseDesc.html#02e9447258a748b314f7ee1896f4e5f4">getType</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns type of midphase mesh structure.  <a href="#02e9447258a748b314f7ee1896f4e5f4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMidphaseDesc.html#c941c94835e494ae0dcc3f774ac16240">setToDefault</a> (<a class="el" href="structPxMeshMidPhase.html#49f740883fbfb1a49631c28818c219f4">PxMeshMidPhase::Enum</a> type)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the midphase mesh structure descriptor.  <a href="#c941c94835e494ae0dcc3f774ac16240"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMidphaseDesc.html#db72729d6ff5211ccb053402a0124fd6">isValid</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the descriptor is valid.  <a href="#db72729d6ff5211ccb053402a0124fd6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE <a class="el" href="classPxMidphaseDesc.html">PxMidphaseDesc</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMidphaseDesc.html#eaef37abd96ca9fd99fb92050f798881">operator=</a> (<a class="el" href="structPxMeshMidPhase.html#49f740883fbfb1a49631c28818c219f4">PxMeshMidPhase::Enum</a> descType)</td></tr>

<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap>union {</td></tr>

<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structPxBVH33MidphaseDesc.html">PxBVH33MidphaseDesc</a>&nbsp;&nbsp;&nbsp;<a class="el" href="classPxMidphaseDesc.html#ed287e641cd5f9c1c30659666534123e">mBVH33Desc</a></td></tr>

<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structPxBVH34MidphaseDesc.html">PxBVH34MidphaseDesc</a>&nbsp;&nbsp;&nbsp;<a class="el" href="classPxMidphaseDesc.html#e369084445c520f5de14039bb91fefb5">mBVH34Desc</a></td></tr>

<tr><td class="memItemLeft" nowrap valign="top">};&nbsp;</td><td class="memItemRight" valign="bottom"></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Midphase descriptors union.  <a href="#96d799e26076d5a4f56e2b3fa0b0990e"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxMeshMidPhase.html#49f740883fbfb1a49631c28818c219f4">PxMeshMidPhase::Enum</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMidphaseDesc.html#ccf127a843dae110fc24fe458f7924e6">mType</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Structure describing parameters affecting midphase mesh structure. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxCookingParams.html" title="Structure describing parameters affecting mesh cooking.">PxCookingParams</a>, <a class="el" href="structPxBVH33MidphaseDesc.html" title="Structure describing parameters affecting BVH33 midphase mesh structure.">PxBVH33MidphaseDesc</a>, <a class="el" href="structPxBVH34MidphaseDesc.html" title="Structure describing parameters affecting BVH34 midphase mesh structure.">PxBVH34MidphaseDesc</a> </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="2884c3beff507638b6bceb78c46c9eee"></a><!-- doxytag: member="PxMidphaseDesc::PxMidphaseDesc" ref="2884c3beff507638b6bceb78c46c9eee" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_FORCE_INLINE PxMidphaseDesc::PxMidphaseDesc           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="02e9447258a748b314f7ee1896f4e5f4"></a><!-- doxytag: member="PxMidphaseDesc::getType" ref="02e9447258a748b314f7ee1896f4e5f4" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_FORCE_INLINE <a class="el" href="structPxMeshMidPhase.html#49f740883fbfb1a49631c28818c219f4">PxMeshMidPhase::Enum</a> PxMidphaseDesc::getType           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns type of midphase mesh structure. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="structPxMeshMidPhase.html#49f740883fbfb1a49631c28818c219f4">PxMeshMidPhase::Enum</a></dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxMeshMidPhase.html#49f740883fbfb1a49631c28818c219f4">PxMeshMidPhase::Enum</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="db72729d6ff5211ccb053402a0124fd6"></a><!-- doxytag: member="PxMidphaseDesc::isValid" ref="db72729d6ff5211ccb053402a0124fd6" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool PxMidphaseDesc::isValid           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns true if the descriptor is valid. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the current settings are valid. </dd></dl>

<p>References <a class="el" href="PxTriangleMesh_8h-source.html#l00068">PxMeshMidPhase::eBVH33</a>, and <a class="el" href="PxTriangleMesh_8h-source.html#l00069">PxMeshMidPhase::eBVH34</a>.</p>

</div>
</div><p>
<a class="anchor" name="eaef37abd96ca9fd99fb92050f798881"></a><!-- doxytag: member="PxMidphaseDesc::operator=" ref="eaef37abd96ca9fd99fb92050f798881" args="(PxMeshMidPhase::Enum descType)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_FORCE_INLINE <a class="el" href="classPxMidphaseDesc.html">PxMidphaseDesc</a>&amp; PxMidphaseDesc::operator=           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structPxMeshMidPhase.html#49f740883fbfb1a49631c28818c219f4">PxMeshMidPhase::Enum</a>&nbsp;</td>
          <td class="paramname"> <em>descType</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="c941c94835e494ae0dcc3f774ac16240"></a><!-- doxytag: member="PxMidphaseDesc::setToDefault" ref="c941c94835e494ae0dcc3f774ac16240" args="(PxMeshMidPhase::Enum type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PxMidphaseDesc::setToDefault           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structPxMeshMidPhase.html#49f740883fbfb1a49631c28818c219f4">PxMeshMidPhase::Enum</a>&nbsp;</td>
          <td class="paramname"> <em>type</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize the midphase mesh structure descriptor. 
<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>type</em>&nbsp;</td><td>Midphase mesh structure descriptor</td></tr>
  </table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd>PxBV33MidphaseDesc, PxBV34MidphaseDesc </dd></dl>

<p>References <a class="el" href="PxTriangleMesh_8h-source.html#l00068">PxMeshMidPhase::eBVH33</a>, and <a class="el" href="PxTriangleMesh_8h-source.html#l00069">PxMeshMidPhase::eBVH34</a>.</p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="96d799e26076d5a4f56e2b3fa0b0990e"></a><!-- doxytag: member="PxMidphaseDesc::@3" ref="96d799e26076d5a4f56e2b3fa0b0990e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">union { ... }           </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Midphase descriptors union. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>PxBV33MidphaseDesc, PxBV34MidphaseDesc </dd></dl>

</div>
</div><p>
<a class="anchor" name="ed287e641cd5f9c1c30659666534123e"></a><!-- doxytag: member="PxMidphaseDesc::mBVH33Desc" ref="ed287e641cd5f9c1c30659666534123e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structPxBVH33MidphaseDesc.html">PxBVH33MidphaseDesc</a> <a class="el" href="classPxMidphaseDesc.html#ed287e641cd5f9c1c30659666534123e">PxMidphaseDesc::mBVH33Desc</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="e369084445c520f5de14039bb91fefb5"></a><!-- doxytag: member="PxMidphaseDesc::mBVH34Desc" ref="e369084445c520f5de14039bb91fefb5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structPxBVH34MidphaseDesc.html">PxBVH34MidphaseDesc</a> <a class="el" href="classPxMidphaseDesc.html#e369084445c520f5de14039bb91fefb5">PxMidphaseDesc::mBVH34Desc</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="ccf127a843dae110fc24fe458f7924e6"></a><!-- doxytag: member="PxMidphaseDesc::mType" ref="ccf127a843dae110fc24fe458f7924e6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structPxMeshMidPhase.html#49f740883fbfb1a49631c28818c219f4">PxMeshMidPhase::Enum</a> <a class="el" href="classPxMidphaseDesc.html#ccf127a843dae110fc24fe458f7924e6">PxMidphaseDesc::mType</a><code> [protected]</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="PxMidphaseDesc_8h-source.html">PxMidphaseDesc.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>