aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/structPxConvexFlag.html
blob: 4097cc5c4e42084b1b680490dcf16c666d3e81a3 (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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxConvexFlag 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>PxConvexFlag Struct Reference<br>
<small>
[<a class="el" href="group__cooking.html">Cooking</a>]</small>
</h1><!-- doxytag: class="PxConvexFlag" -->Flags which describe the format and behavior of a convex mesh.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxConvexMeshDesc_8h-source.html">PxConvexMeshDesc.h</a>&gt;</code>
<p>

<p>
<a href="structPxConvexFlag-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b6">Enum</a> { <br>
&nbsp;&nbsp;<a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b618b6c42727636f294561c735de5dc37b">e16_BIT_INDICES</a> =  (1&lt;&lt;0), 
<br>
&nbsp;&nbsp;<a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b6d3153afeb45ae6488b40fc4698919c6b">eCOMPUTE_CONVEX</a> =  (1&lt;&lt;1), 
<br>
&nbsp;&nbsp;<a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b612c7c442cadd1e3474fc613944981c44">eCHECK_ZERO_AREA_TRIANGLES</a> =  (1&lt;&lt;2), 
<br>
&nbsp;&nbsp;<a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b6136d6a29364af41ef1af645f698d54d1">eINFLATE_CONVEX</a> =  (1&lt;&lt;3), 
<br>
&nbsp;&nbsp;<a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b6e10437ca01f341cb3afff0bd2c40529d">eQUANTIZE_INPUT</a> =  (1 &lt;&lt; 4), 
<br>
&nbsp;&nbsp;<a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b610a876ecefb45e1c7dbaec2afed5c3ad">eDISABLE_MESH_VALIDATION</a> =  (1 &lt;&lt; 5), 
<br>
&nbsp;&nbsp;<a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b662cbe73f95f10cb93b5d471affef7c89">ePLANE_SHIFTING</a> =  (1 &lt;&lt; 6), 
<br>
&nbsp;&nbsp;<a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b6c694e25cda4aa49e1afb054b08bfc207">eFAST_INERTIA_COMPUTATION</a> =  (1 &lt;&lt; 7), 
<br>
&nbsp;&nbsp;<a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b68126f89c7d2dac99246261ca6a7ae067">eGPU_COMPATIBLE</a> =  (1 &lt;&lt; 8), 
<br>
&nbsp;&nbsp;<a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b699ab52dd1e60d72bc99834e1b8093d78">eSHIFT_VERTICES</a> =  (1 &lt;&lt; 9)
<br>
 }</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Flags which describe the format and behavior of a convex mesh. <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="4b7bd21fa96c72b320a39e880208b4b6"></a><!-- doxytag: member="PxConvexFlag::Enum" ref="4b7bd21fa96c72b320a39e880208b4b6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b6">PxConvexFlag::Enum</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="4b7bd21fa96c72b320a39e880208b4b618b6c42727636f294561c735de5dc37b"></a><!-- doxytag: member="e16_BIT_INDICES" ref="4b7bd21fa96c72b320a39e880208b4b618b6c42727636f294561c735de5dc37b" args="" -->e16_BIT_INDICES</em>&nbsp;</td><td>
Denotes the use of 16-bit vertex indices in PxConvexMeshDesc::triangles or <a class="el" href="classPxConvexMeshDesc.html#1b710dc3c2ef759a6bef8bd888e1ecf8" title="Polygons data in PxBoundedData format.">PxConvexMeshDesc::polygons</a>. (otherwise, 32-bit indices are assumed) <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxConvexMeshDesc.html#4e760fc52d1f0f9e55c919320bed1cef" title="Polygon indices data in PxBoundedData format.">PxConvexMeshDesc.indices</a> </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="4b7bd21fa96c72b320a39e880208b4b6d3153afeb45ae6488b40fc4698919c6b"></a><!-- doxytag: member="eCOMPUTE_CONVEX" ref="4b7bd21fa96c72b320a39e880208b4b6d3153afeb45ae6488b40fc4698919c6b" args="" -->eCOMPUTE_CONVEX</em>&nbsp;</td><td>
Automatically recomputes the hull from the vertices. If this flag is not set, you must provide the entire geometry manually.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>There are two different algorithms for hull computation, please see <a class="el" href="structPxConvexMeshCookingType.html" title="Enumeration for convex mesh cooking algorithms.">PxConvexMeshCookingType</a>.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxConvexMeshCookingType.html" title="Enumeration for convex mesh cooking algorithms.">PxConvexMeshCookingType</a> </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="4b7bd21fa96c72b320a39e880208b4b612c7c442cadd1e3474fc613944981c44"></a><!-- doxytag: member="eCHECK_ZERO_AREA_TRIANGLES" ref="4b7bd21fa96c72b320a39e880208b4b612c7c442cadd1e3474fc613944981c44" args="" -->eCHECK_ZERO_AREA_TRIANGLES</em>&nbsp;</td><td>
Checks and removes almost zero-area triangles during convex hull computation. The rejected area size is specified in <a class="el" href="structPxCookingParams.html#ec2fbb426b8c0bb2daee1e31b8e2adc2" title="Zero-size area epsilon used in convex hull computation.">PxCookingParams::areaTestEpsilon</a>. 
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>This flag is only used in combination with eCOMPUTE_CONVEX.<p>
If this flag is used in combination with eINFLATE_CONVEX, the newly added triangles by the inflation algorithm are not checked (size of the triangles depends on PxCooking::skinWidth).</dd></dl>
<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="structPxCookingParams.html#ec2fbb426b8c0bb2daee1e31b8e2adc2" title="Zero-size area epsilon used in convex hull computation.">PxCookingParams::areaTestEpsilon</a> </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="4b7bd21fa96c72b320a39e880208b4b6136d6a29364af41ef1af645f698d54d1"></a><!-- doxytag: member="eINFLATE_CONVEX" ref="4b7bd21fa96c72b320a39e880208b4b6136d6a29364af41ef1af645f698d54d1" args="" -->eINFLATE_CONVEX</em>&nbsp;</td><td>
Inflates the convex points according to skin width. 
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>eINFLATE_CONVEX flag has been deprecated. The flag is automatically used when PxConvexMeshCookingType::eINFLATION_INCREMENTAL_HULL is set. The default algorithm PxConvexMeshCookingType::eQUICK_HULL ignores this flag, inflation is not used.</dd></dl>
<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="structPxConvexMeshCookingType.html" title="Enumeration for convex mesh cooking algorithms.">PxConvexMeshCookingType</a> </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="4b7bd21fa96c72b320a39e880208b4b6e10437ca01f341cb3afff0bd2c40529d"></a><!-- doxytag: member="eQUANTIZE_INPUT" ref="4b7bd21fa96c72b320a39e880208b4b6e10437ca01f341cb3afff0bd2c40529d" args="" -->eQUANTIZE_INPUT</em>&nbsp;</td><td>
Quantizes the input vertices using the k-means clustering. 
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The input vertices are quantized to <a class="el" href="classPxConvexMeshDesc.html#8dc525326a4835f94311f4e44ca219f2" title="Maximum number of vertices after quantization. The quantization is done during the...">PxConvexMeshDesc::quantizedCount</a> see <a href="http://en.wikipedia.org/wiki/K-means_clustering">http://en.wikipedia.org/wiki/K-means_clustering</a> </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="4b7bd21fa96c72b320a39e880208b4b610a876ecefb45e1c7dbaec2afed5c3ad"></a><!-- doxytag: member="eDISABLE_MESH_VALIDATION" ref="4b7bd21fa96c72b320a39e880208b4b610a876ecefb45e1c7dbaec2afed5c3ad" args="" -->eDISABLE_MESH_VALIDATION</em>&nbsp;</td><td>
Disables the convex mesh validation to speed-up hull creation. Please use separate validation function in checked/debug builds. Creating a convex mesh with invalid input data without prior validation may result in undefined behavior. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxCooking.html#ea8a3c270cc6db602ad250c82c1225bc" title="Verifies if the convex mesh is valid. Prints an error message for each inconsistency...">PxCooking::validateConvexMesh</a> </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="4b7bd21fa96c72b320a39e880208b4b662cbe73f95f10cb93b5d471affef7c89"></a><!-- doxytag: member="ePLANE_SHIFTING" ref="4b7bd21fa96c72b320a39e880208b4b662cbe73f95f10cb93b5d471affef7c89" args="" -->ePLANE_SHIFTING</em>&nbsp;</td><td>
Enables plane shifting vertex limit algorithm. 
<p>
Plane shifting is an alternative algorithm for the case when the computed hull has more vertices than the specified vertex limit.<p>
The default algorithm computes the full hull, and an OBB around the input vertices. This OBB is then sliced with the hull planes until the vertex limit is reached.The default algorithm requires the vertex limit to be set to at least 8, and typically produces results that are much better quality than are produced by plane shifting.<p>
When plane shifting is enabled, the hull computation stops when vertex limit is reached. The hull planes are then shifted to contain all input vertices, and the new plane intersection points are then used to generate the final hull with the given vertex limit.Plane shifting may produce sharp edges to vertices very far away from the input cloud, and does not guarantee that all input vertices are inside the resulting hull.However, it can be used with a vertex limit as low as 4. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="4b7bd21fa96c72b320a39e880208b4b6c694e25cda4aa49e1afb054b08bfc207"></a><!-- doxytag: member="eFAST_INERTIA_COMPUTATION" ref="4b7bd21fa96c72b320a39e880208b4b6c694e25cda4aa49e1afb054b08bfc207" args="" -->eFAST_INERTIA_COMPUTATION</em>&nbsp;</td><td>
Inertia tensor computation is faster using SIMD code, but the precision is lower, which may result in incorrect inertia for very thin hulls. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="4b7bd21fa96c72b320a39e880208b4b68126f89c7d2dac99246261ca6a7ae067"></a><!-- doxytag: member="eGPU_COMPATIBLE" ref="4b7bd21fa96c72b320a39e880208b4b68126f89c7d2dac99246261ca6a7ae067" args="" -->eGPU_COMPATIBLE</em>&nbsp;</td><td>
Convex hulls are created with respect to GPU simulation limitations. Vertex limit is set to 64 and vertex limit per face is internally set to 32. 
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Can be used only with eCOMPUTE_CONVEX flag. </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="4b7bd21fa96c72b320a39e880208b4b699ab52dd1e60d72bc99834e1b8093d78"></a><!-- doxytag: member="eSHIFT_VERTICES" ref="4b7bd21fa96c72b320a39e880208b4b699ab52dd1e60d72bc99834e1b8093d78" args="" -->eSHIFT_VERTICES</em>&nbsp;</td><td>
Convex hull input vertices are shifted to be around origin to provide better computation stability. It is recommended to provide input vertices around the origin, otherwise use this flag to improve numerical stability. 
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Is used only with eCOMPUTE_CONVEX flag. </dd></dl>
</td></tr>
</table>
</dl>

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