diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/classPxConvexMeshDesc.html | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxConvexMeshDesc.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxConvexMeshDesc.html | 211 |
1 files changed, 211 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxConvexMeshDesc.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxConvexMeshDesc.html new file mode 100644 index 00000000..debb4419 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxConvexMeshDesc.html @@ -0,0 +1,211 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxConvexMeshDesc 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> + <a class="qindex" href="hierarchy.html">Class Hierarchy</a> + <a class="qindex" href="annotated.html">Compound List</a> + <a class="qindex" href="functions.html">Compound Members</a> + </center> + <hr class="second"> + </div> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1>PxConvexMeshDesc Class Reference<br> +<small> +[<a class="el" href="group__cooking.html">Cooking</a>]</small> +</h1><!-- doxytag: class="PxConvexMeshDesc" -->Descriptor class for <a class="el" href="classPxConvexMesh.html" title="A convex mesh.">PxConvexMesh</a>. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxConvexMeshDesc_8h-source.html">PxConvexMeshDesc.h</a>></code> +<p> +<div class="dynheader"> +Collaboration diagram for PxConvexMeshDesc:</div> +<div class="dynsection"> +<p><center><img src="classPxConvexMeshDesc__coll__graph.png" border="0" usemap="#PxConvexMeshDesc__coll__map" alt="Collaboration graph"></center> +<map name="PxConvexMeshDesc__coll__map"> +<area shape="rect" href="structPxBoundedData.html" title="PxBoundedData" alt="PxBoundedData" coords="7,88,111,109"><area shape="rect" href="structPxStridedData.html" title="PxStridedData" alt="PxStridedData" coords="12,16,105,37"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxConvexFlag::Enum, PxU16 \>" alt="PxFlags\< PxConvexFlag::Enum, PxU16 \>" coords="135,88,385,109"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxConvexMeshDesc-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cooking.html#g2b98217f34d8856ebe839821740ac438">PxConvexMeshDesc</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor sets to default. <a href="group__cooking.html#g2b98217f34d8856ebe839821740ac438"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cooking.html#g6e86954b2426aae207489af9928d45e3">setToDefault</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">(re)sets the structure to the default. <a href="group__cooking.html#g6e86954b2426aae207489af9928d45e3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cooking.html#g5e7791d7f0688a9f642a9345a7083708">isValid</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the descriptor is valid. <a href="group__cooking.html#g5e7791d7f0688a9f642a9345a7083708"></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="structPxBoundedData.html">PxBoundedData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshDesc.html#939b97ee9f36cd1c1a7b7c34b0e764ef">points</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Vertex positions data in <a class="el" href="structPxBoundedData.html">PxBoundedData</a> format. <a href="#939b97ee9f36cd1c1a7b7c34b0e764ef"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxBoundedData.html">PxBoundedData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshDesc.html#1b710dc3c2ef759a6bef8bd888e1ecf8">polygons</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Polygons data in <a class="el" href="structPxBoundedData.html">PxBoundedData</a> format. <a href="#1b710dc3c2ef759a6bef8bd888e1ecf8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxBoundedData.html">PxBoundedData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshDesc.html#4e760fc52d1f0f9e55c919320bed1cef">indices</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Polygon indices data in <a class="el" href="structPxBoundedData.html">PxBoundedData</a> format. <a href="#4e760fc52d1f0f9e55c919320bed1cef"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxFlags.html">PxConvexFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshDesc.html#f6d2315944dad51ba136b3563b7c00ab">flags</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Flags bits, combined from values of the enum <a class="el" href="structPxConvexFlag.html" title="Flags which describe the format and behavior of a convex mesh.">PxConvexFlag</a>. <a href="#f6d2315944dad51ba136b3563b7c00ab"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxU16 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshDesc.html#467c6feb39620d546a6bc9054405a728">vertexLimit</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Limits the number of vertices of the result convex mesh. Hard maximum limit is 256 and minimum limit is 4 if <a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b662cbe73f95f10cb93b5d471affef7c89" title="Enables plane shifting vertex limit algorithm.">PxConvexFlag::ePLANE_SHIFTING</a> is used, otherwise the minimum limit is 8. <a href="#467c6feb39620d546a6bc9054405a728"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxU16 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMeshDesc.html#8dc525326a4835f94311f4e44ca219f2">quantizedCount</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of vertices after quantization. The quantization is done during the vertex cleaning phase. The quantization is applied when <a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b6e10437ca01f341cb3afff0bd2c40529d" title="Quantizes the input vertices using the k-means clustering.">PxConvexFlag::eQUANTIZE_INPUT</a> is specified. <a href="#8dc525326a4835f94311f4e44ca219f2"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Descriptor class for <a class="el" href="classPxConvexMesh.html" title="A convex mesh.">PxConvexMesh</a>. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>The number of vertices and the number of convex polygons in a cooked convex mesh is limited to 256.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxConvexMesh.html" title="A convex mesh.">PxConvexMesh</a> <a class="el" href="classPxConvexMeshGeometry.html" title="Convex mesh geometry class.">PxConvexMeshGeometry</a> <a class="el" href="classPxShape.html" title="Abstract class for collision shapes.">PxShape</a> <a class="el" href="classPxPhysics.html#54fc5f8b0884977ccfd45ea829392a52" title="Creates a convex mesh object.">PxPhysics.createConvexMesh()</a> </dd></dl> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="f6d2315944dad51ba136b3563b7c00ab"></a><!-- doxytag: member="PxConvexMeshDesc::flags" ref="f6d2315944dad51ba136b3563b7c00ab" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxFlags.html">PxConvexFlags</a> <a class="el" href="classPxConvexMeshDesc.html#f6d2315944dad51ba136b3563b7c00ab">PxConvexMeshDesc::flags</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Flags bits, combined from values of the enum <a class="el" href="structPxConvexFlag.html" title="Flags which describe the format and behavior of a convex mesh.">PxConvexFlag</a>. +<p> +<b>Default:</b> 0 +<p>Referenced by <a class="el" href="PxConvexMeshDesc_8h-source.html#l00253">isValid()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="4e760fc52d1f0f9e55c919320bed1cef"></a><!-- doxytag: member="PxConvexMeshDesc::indices" ref="4e760fc52d1f0f9e55c919320bed1cef" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structPxBoundedData.html">PxBoundedData</a> <a class="el" href="classPxConvexMeshDesc.html#4e760fc52d1f0f9e55c919320bed1cef">PxConvexMeshDesc::indices</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Polygon indices data in <a class="el" href="structPxBoundedData.html">PxBoundedData</a> format. +<p> +Pointer to first index.<p> +<b>Default:</b> NULL<p> +This is declared as a void pointer because it is actually either an PxU16 or a PxU32 pointer.<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxHullPolygon.html" title="Polygon data.">PxHullPolygon</a> <a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b618b6c42727636f294561c735de5dc37b">PxConvexFlag::e16_BIT_INDICES</a> </dd></dl> + +<p>Referenced by <a class="el" href="PxConvexMeshDesc_8h-source.html#l00253">isValid()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="939b97ee9f36cd1c1a7b7c34b0e764ef"></a><!-- doxytag: member="PxConvexMeshDesc::points" ref="939b97ee9f36cd1c1a7b7c34b0e764ef" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structPxBoundedData.html">PxBoundedData</a> <a class="el" href="classPxConvexMeshDesc.html#939b97ee9f36cd1c1a7b7c34b0e764ef">PxConvexMeshDesc::points</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Vertex positions data in <a class="el" href="structPxBoundedData.html">PxBoundedData</a> format. +<p> +<b>Default:</b> NULL +<p>Referenced by <a class="el" href="PxConvexMeshDesc_8h-source.html#l00253">isValid()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="1b710dc3c2ef759a6bef8bd888e1ecf8"></a><!-- doxytag: member="PxConvexMeshDesc::polygons" ref="1b710dc3c2ef759a6bef8bd888e1ecf8" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structPxBoundedData.html">PxBoundedData</a> <a class="el" href="classPxConvexMeshDesc.html#1b710dc3c2ef759a6bef8bd888e1ecf8">PxConvexMeshDesc::polygons</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Polygons data in <a class="el" href="structPxBoundedData.html">PxBoundedData</a> format. +<p> +Pointer to first polygon. <p> +<b>Default:</b> NULL<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxHullPolygon.html" title="Polygon data.">PxHullPolygon</a> </dd></dl> + +<p>Referenced by <a class="el" href="PxConvexMeshDesc_8h-source.html#l00253">isValid()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8dc525326a4835f94311f4e44ca219f2"></a><!-- doxytag: member="PxConvexMeshDesc::quantizedCount" ref="8dc525326a4835f94311f4e44ca219f2" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxU16 <a class="el" href="classPxConvexMeshDesc.html#8dc525326a4835f94311f4e44ca219f2">PxConvexMeshDesc::quantizedCount</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Maximum number of vertices after quantization. The quantization is done during the vertex cleaning phase. The quantization is applied when <a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b6e10437ca01f341cb3afff0bd2c40529d" title="Quantizes the input vertices using the k-means clustering.">PxConvexFlag::eQUANTIZE_INPUT</a> is specified. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b6e10437ca01f341cb3afff0bd2c40529d" title="Quantizes the input vertices using the k-means clustering.">PxConvexFlag::eQUANTIZE_INPUT</a></dd></dl> +<b>Range:</b> [4, 65535]<br> + <b>Default:</b> 255 +<p>Referenced by <a class="el" href="PxConvexMeshDesc_8h-source.html#l00253">isValid()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="467c6feb39620d546a6bc9054405a728"></a><!-- doxytag: member="PxConvexMeshDesc::vertexLimit" ref="467c6feb39620d546a6bc9054405a728" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxU16 <a class="el" href="classPxConvexMeshDesc.html#467c6feb39620d546a6bc9054405a728">PxConvexMeshDesc::vertexLimit</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Limits the number of vertices of the result convex mesh. Hard maximum limit is 256 and minimum limit is 4 if <a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b662cbe73f95f10cb93b5d471affef7c89" title="Enables plane shifting vertex limit algorithm.">PxConvexFlag::ePLANE_SHIFTING</a> is used, otherwise the minimum limit is 8. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Vertex limit is only used when <a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b6d3153afeb45ae6488b40fc4698919c6b">PxConvexFlag::eCOMPUTE_CONVEX</a> is specified. <p> +The please see <a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b662cbe73f95f10cb93b5d471affef7c89" title="Enables plane shifting vertex limit algorithm.">PxConvexFlag::ePLANE_SHIFTING</a> for algorithm explanation</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxConvexFlag.html#4b7bd21fa96c72b320a39e880208b4b662cbe73f95f10cb93b5d471affef7c89" title="Enables plane shifting vertex limit algorithm.">PxConvexFlag::ePLANE_SHIFTING</a></dd></dl> +<b>Range:</b> [4, 255]<br> + <b>Default:</b> 255 +<p>Referenced by <a class="el" href="PxConvexMeshDesc_8h-source.html#l00253">isValid()</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class 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 © 2008-2016 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> |