aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxTriangleMeshDesc.html
blob: c8b2c2512651fd9dffb51d7e0512d0b2780ea691 (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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxTriangleMeshDesc 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>PxTriangleMeshDesc Class Reference<br>
<small>
[<a class="el" href="group__cooking.html">Cooking</a>]</small>
</h1><!-- doxytag: class="PxTriangleMeshDesc" --><!-- doxytag: inherits="PxSimpleTriangleMesh" -->Descriptor class for <a class="el" href="classPxTriangleMesh.html" title="A triangle mesh, also called a &#39;polygon soup&#39;.">PxTriangleMesh</a>.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxTriangleMeshDesc_8h-source.html">PxTriangleMeshDesc.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for PxTriangleMeshDesc:</div>
<div class="dynsection">
<p><center><img src="classPxTriangleMeshDesc__inherit__graph.png" border="0" usemap="#PxTriangleMeshDesc__inherit__map" alt="Inheritance graph"></center>
<map name="PxTriangleMeshDesc__inherit__map">
<area shape="rect" href="classPxSimpleTriangleMesh.html" title="A structure describing a triangle mesh." alt="PxSimpleTriangleMesh" coords="7,16,153,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxTriangleMeshDesc:</div>
<div class="dynsection">
<p><center><img src="classPxTriangleMeshDesc__coll__graph.png" border="0" usemap="#PxTriangleMeshDesc__coll__map" alt="Collaboration graph"></center>
<map name="PxTriangleMeshDesc__coll__map">
<area shape="rect" href="classPxSimpleTriangleMesh.html" title="A structure describing a triangle mesh." alt="PxSimpleTriangleMesh" coords="97,195,244,216"><area shape="rect" href="classPxFlags.html" title="PxFlags\&lt; PxMeshFlag::Enum, PxU16 \&gt;" alt="PxFlags\&lt; PxMeshFlag::Enum, PxU16 \&gt;" coords="7,88,247,109"><area shape="rect" href="structPxBoundedData.html" title="PxBoundedData" alt="PxBoundedData" coords="271,88,375,109"><area shape="rect" href="structPxStridedData.html" title="PxStridedData" alt="PxStridedData" coords="276,16,369,37"><area shape="rect" href="structPxTypedStridedData.html" title="PxTypedStridedData\&lt; PxMaterialTableIndex \&gt;" alt="PxTypedStridedData\&lt; PxMaterialTableIndex \&gt;" coords="268,195,545,216"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classPxTriangleMeshDesc-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="group__cooking.html#g15d3050ac143dfb67ad43a8682c7b569">PxTriangleMeshDesc</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor sets to default.  <a href="group__cooking.html#g15d3050ac143dfb67ad43a8682c7b569"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cooking.html#gfd882da42844238f9a91e5754694391e">setToDefault</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(re)sets the structure to the default.  <a href="group__cooking.html#gfd882da42844238f9a91e5754694391e"></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__cooking.html#gb15c89f8d8d8723d3697cce47ef24b01">isValid</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the descriptor is valid.  <a href="group__cooking.html#gb15c89f8d8d8723d3697cce47ef24b01"></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="structPxTypedStridedData.html">PxTypedStridedData</a><br class="typebreak">
&lt; <a class="el" href="group__common.html#gc816bc62a68a52f01bf21f963295e822">PxMaterialTableIndex</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxTriangleMeshDesc.html#138ca14d6cad6d86484c8ecd9f96d46f">materialIndices</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Descriptor class for <a class="el" href="classPxTriangleMesh.html" title="A triangle mesh, also called a &#39;polygon soup&#39;.">PxTriangleMesh</a>. 
<p>
Note that this class is derived from <a class="el" href="classPxSimpleTriangleMesh.html" title="A structure describing a triangle mesh.">PxSimpleTriangleMesh</a> which contains the members that describe the basic mesh. The mesh data is *copied* when an <a class="el" href="classPxTriangleMesh.html" title="A triangle mesh, also called a &#39;polygon soup&#39;.">PxTriangleMesh</a> object is created from this descriptor. After the call the user may discard the triangle data.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxTriangleMesh.html" title="A triangle mesh, also called a &#39;polygon soup&#39;.">PxTriangleMesh</a> <a class="el" href="classPxTriangleMeshGeometry.html" title="Triangle mesh geometry class.">PxTriangleMeshGeometry</a> <a class="el" href="classPxShape.html" title="Abstract class for collision shapes.">PxShape</a> </dd></dl>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="138ca14d6cad6d86484c8ecd9f96d46f"></a><!-- doxytag: member="PxTriangleMeshDesc::materialIndices" ref="138ca14d6cad6d86484c8ecd9f96d46f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structPxTypedStridedData.html">PxTypedStridedData</a>&lt;<a class="el" href="group__common.html#gc816bc62a68a52f01bf21f963295e822">PxMaterialTableIndex</a>&gt; <a class="el" href="classPxTriangleMeshDesc.html#138ca14d6cad6d86484c8ecd9f96d46f">PxTriangleMeshDesc::materialIndices</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Optional pointer to first material index, or NULL. There are PxSimpleTriangleMesh::numTriangles indices in total. Caller may add materialIndexStride bytes to the pointer to access the next triangle.<p>
When a triangle mesh collides with another object, a material is required at the collision point. If materialIndices is NULL, then the material of the <a class="el" href="classPxShape.html" title="Abstract class for collision shapes.">PxShape</a> instance is used. Otherwise, if the point of contact is on a triangle with index i, then the material index is determined as: PxMaterialTableIndex index = *(PxMaterialTableIndex *)(((PxU8*)materialIndices) + materialIndexStride * i);<p>
If the contact point falls on a vertex or an edge, a triangle adjacent to the vertex or edge is selected, and its index used to look up a material. The selection is arbitrary but consistent over time.<p>
<b>Default:</b> NULL<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>materialIndexStride </dd></dl>

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

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