diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxConvexMesh.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxConvexMesh.html | 538 |
1 files changed, 538 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxConvexMesh.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxConvexMesh.html new file mode 100644 index 00000000..32bb8e61 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxConvexMesh.html @@ -0,0 +1,538 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxConvexMesh 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>PxConvexMesh Class Reference<br> +<small> +[<a class="el" href="group__geomutils.html">Geomutils</a>]</small> +</h1><!-- doxytag: class="PxConvexMesh" --><!-- doxytag: inherits="PxBase" -->A convex mesh. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxConvexMesh_8h-source.html">PxConvexMesh.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxConvexMesh:</div> +<div class="dynsection"> +<p><center><img src="classPxConvexMesh__inherit__graph.png" border="0" usemap="#PxConvexMesh__inherit__map" alt="Inheritance graph"></center> +<map name="PxConvexMesh__inherit__map"> +<area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="29,16,85,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxConvexMesh:</div> +<div class="dynsection"> +<p><center><img src="classPxConvexMesh__coll__graph.png" border="0" usemap="#PxConvexMesh__coll__map" alt="Collaboration graph"></center> +<map name="PxConvexMesh__coll__map"> +<area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="97,106,153,128"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="7,16,244,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxConvexMesh-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">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#91f22f88d2a3a100711b94b815152fd2">getNbVertices</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of vertices. <a href="#91f22f88d2a3a100711b94b815152fd2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <br class="typebreak"> +const <a class="el" href="classPxVec3.html">PxVec3</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#3698df65fd0496d92a0fb7e80b7fe30e">getVertices</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the vertices. <a href="#3698df65fd0496d92a0fb7e80b7fe30e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <br class="typebreak"> +const PxU8 * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#97ef9cae4003c691c023884b71caffb0">getIndexBuffer</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the index buffer. <a href="#97ef9cae4003c691c023884b71caffb0"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#5246b9a1efd734db68b211d51c672ed7">getNbPolygons</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of polygons. <a href="#5246b9a1efd734db68b211d51c672ed7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#9c9e10d0faaa446ea96494160d359cba">getPolygonData</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> index, <a class="el" href="structPxHullPolygon.html">PxHullPolygon</a> &data) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the polygon data. <a href="#9c9e10d0faaa446ea96494160d359cba"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#6d2ce602a2383f40a3eb7d79e0c990d8">release</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrements the reference count of a convex mesh and releases it if the new reference count is zero. <a href="#6d2ce602a2383f40a3eb7d79e0c990d8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#b7cd51e753d6eaa80b73e06544db7f1b">getReferenceCount</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the reference count of a convex mesh. <a href="#b7cd51e753d6eaa80b73e06544db7f1b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#31e7441288db086d259a82a2c13ac2ef">acquireReference</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Acquires a counted reference to a convex mesh. <a href="#31e7441288db086d259a82a2c13ac2ef"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#497cea6e1975b9081760afc602985bbc">getMassInformation</a> (PxReal &mass, <a class="el" href="classPxMat33.html">PxMat33</a> &localInertia, <a class="el" href="classPxVec3.html">PxVec3</a> &localCenterOfMass) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the mass properties of the mesh assuming unit density. <a href="#497cea6e1975b9081760afc602985bbc"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <br class="typebreak"> +<a class="el" href="classPxBounds3.html">PxBounds3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#288d742ed2fee5c7681fbf5ee6f30f02">getLocalBounds</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the local-space (vertex space) AABB from the convex mesh. <a href="#288d742ed2fee5c7681fbf5ee6f30f02"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API <br class="typebreak"> +const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#b2586810d7be96cc4f58ad95ff27b775">getConcreteTypeName</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#b2586810d7be96cc4f58ad95ff27b775"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#940cb6a762ae1689b217e62facf461eb">isGpuCompatible</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This method decides whether a convex mesh is gpu compatible. If the total number of vertices are more than 64 or any number of vertices in a polygon is more than 32, or convex hull data was not cooked with GPU data enabled during cooking or was loaded from a serialized collection, the convex hull is incompatible with GPU collision detection. Otherwise it is compatible. <a href="#940cb6a762ae1689b217e62facf461eb"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Protected 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="classPxConvexMesh.html#54250e0e545e7d32586f981b1e217526">PxConvexMesh</a> (<a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> concreteType, <a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#6f8637b732295864836bfc2a4b9f54fb">PxConvexMesh</a> (<a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#1c493ccf3bfcbc7ab360c3a72bb9a18b">~PxConvexMesh</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_PHYSX_COMMON_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxConvexMesh.html#83fcfce5eb9b19deab9430ae0acc0e0a">isKindOf</a> (const char *name) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a given type name matches with the type of this instance. <a href="#83fcfce5eb9b19deab9430ae0acc0e0a"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A convex mesh. +<p> +Internally represented as a list of convex polygons. The number of polygons is limited to 256.<p> +To avoid duplicating data when you have several instances of a particular mesh positioned differently, you do not use this class to represent a convex object directly. Instead, you create an instance of this mesh via the <a class="el" href="classPxConvexMeshGeometry.html" title="Convex mesh geometry class.">PxConvexMeshGeometry</a> and <a class="el" href="classPxShape.html" title="Abstract class for collision shapes.">PxShape</a> classes.<p> +<h3>Creation</h3> +<p> +To create an instance of this class call <a class="el" href="classPxPhysics.html#54fc5f8b0884977ccfd45ea829392a52" title="Creates a convex mesh object.">PxPhysics::createConvexMesh()</a>, and <a class="el" href="classPxConvexMesh.html#6d2ce602a2383f40a3eb7d79e0c990d8" title="Decrements the reference count of a convex mesh and releases it if the new reference...">PxConvexMesh::release()</a> to delete it. This is only possible once you have released all of its <a class="el" href="classPxShape.html" title="Abstract class for collision shapes.">PxShape</a> instances.<p> +<h3>Visualizations:</h3> +<p> +<ul> +<li><a class="el" href="structPxVisualizationParameter.html#dce8e8a77c144356b0968d2b9f79eb10714f24bab39d1bbe8b131bd10ef5552b" title="Visualize bounds (AABBs in world space).">PxVisualizationParameter::eCOLLISION_AABBS</a> </li> +<li><a class="el" href="structPxVisualizationParameter.html#dce8e8a77c144356b0968d2b9f79eb10515f4c3c72ee88d7507b52d6ccd14eab" title="Shape visualization.">PxVisualizationParameter::eCOLLISION_SHAPES</a> </li> +<li><a class="el" href="structPxVisualizationParameter.html#dce8e8a77c144356b0968d2b9f79eb100ad9dcb10f5f3d6ded3baecfc1e387d3" title="Shape axis visualization.">PxVisualizationParameter::eCOLLISION_AXES</a> </li> +<li><a class="el" href="structPxVisualizationParameter.html#dce8e8a77c144356b0968d2b9f79eb10fd900f30ba421d555e7f7b087126cd92" title="Mesh & convex face normals.">PxVisualizationParameter::eCOLLISION_FNORMALS</a> </li> +<li><a class="el" href="structPxVisualizationParameter.html#dce8e8a77c144356b0968d2b9f79eb10a0e06ca7fa1a0445abe0f4d293feb961" title="Active edges for meshes.">PxVisualizationParameter::eCOLLISION_EDGES</a></li> +</ul> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxConvexMeshDesc.html" title="Descriptor class for PxConvexMesh.">PxConvexMeshDesc</a> <a class="el" href="classPxPhysics.html#54fc5f8b0884977ccfd45ea829392a52" title="Creates a convex mesh object.">PxPhysics.createConvexMesh()</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="54250e0e545e7d32586f981b1e217526"></a><!-- doxytag: member="PxConvexMesh::PxConvexMesh" ref="54250e0e545e7d32586f981b1e217526" args="(PxType concreteType, PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxConvexMesh::PxConvexMesh </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> </td> + <td class="paramname"> <em>concreteType</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a> </td> + <td class="paramname"> <em>baseFlags</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inline, protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="6f8637b732295864836bfc2a4b9f54fb"></a><!-- doxytag: member="PxConvexMesh::PxConvexMesh" ref="6f8637b732295864836bfc2a4b9f54fb" args="(PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxConvexMesh::PxConvexMesh </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a> </td> + <td class="paramname"> <em>baseFlags</em> </td> + <td> ) </td> + <td><code> [inline, protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="1c493ccf3bfcbc7ab360c3a72bb9a18b"></a><!-- doxytag: member="PxConvexMesh::~PxConvexMesh" ref="1c493ccf3bfcbc7ab360c3a72bb9a18b" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API PxConvexMesh::~PxConvexMesh </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, protected, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="31e7441288db086d259a82a2c13ac2ef"></a><!-- doxytag: member="PxConvexMesh::acquireReference" ref="31e7441288db086d259a82a2c13ac2ef" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API void PxConvexMesh::acquireReference </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Acquires a counted reference to a convex mesh. +<p> +This method increases the reference count of the convex mesh by 1. Decrement the reference count by calling <a class="el" href="classPxConvexMesh.html#6d2ce602a2383f40a3eb7d79e0c990d8" title="Decrements the reference count of a convex mesh and releases it if the new reference...">release()</a> +</div> +</div><p> +<a class="anchor" name="b2586810d7be96cc4f58ad95ff27b775"></a><!-- doxytag: member="PxConvexMesh::getConcreteTypeName" ref="b2586810d7be96cc4f58ad95ff27b775" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API const char* PxConvexMesh::getConcreteTypeName </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns string name of dynamic type. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Class name of most derived type of this object. </dd></dl> + +<p>Implements <a class="el" href="classPxBase.html#67fe206d8897ddce896c371ac8d789a9">PxBase</a>.</p> + +</div> +</div><p> +<a class="anchor" name="97ef9cae4003c691c023884b71caffb0"></a><!-- doxytag: member="PxConvexMesh::getIndexBuffer" ref="97ef9cae4003c691c023884b71caffb0" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API const PxU8* PxConvexMesh::getIndexBuffer </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the index buffer. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Index buffer. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxConvexMesh.html#5246b9a1efd734db68b211d51c672ed7" title="Returns the number of polygons.">getNbPolygons()</a> <a class="el" href="classPxConvexMesh.html#9c9e10d0faaa446ea96494160d359cba" title="Returns the polygon data.">getPolygonData()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="288d742ed2fee5c7681fbf5ee6f30f02"></a><!-- doxytag: member="PxConvexMesh::getLocalBounds" ref="288d742ed2fee5c7681fbf5ee6f30f02" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API <a class="el" href="classPxBounds3.html">PxBounds3</a> PxConvexMesh::getLocalBounds </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the local-space (vertex space) AABB from the convex mesh. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>local-space bounds </dd></dl> + +</div> +</div><p> +<a class="anchor" name="497cea6e1975b9081760afc602985bbc"></a><!-- doxytag: member="PxConvexMesh::getMassInformation" ref="497cea6e1975b9081760afc602985bbc" args="(PxReal &mass, PxMat33 &localInertia, PxVec3 &localCenterOfMass) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API void PxConvexMesh::getMassInformation </td> + <td>(</td> + <td class="paramtype">PxReal & </td> + <td class="paramname"> <em>mass</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxMat33.html">PxMat33</a> & </td> + <td class="paramname"> <em>localInertia</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>localCenterOfMass</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the mass properties of the mesh assuming unit density. +<p> +The following relationship holds between mass and volume:<p> +mass = volume * density<p> +The mass of a unit density mesh is equal to its volume, so this function returns the volume of the mesh.<p> +Similarly, to obtain the localInertia of an identically shaped object with a uniform density of d, simply multiply the localInertia of the unit density mesh by d.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>mass</em> </td><td>The mass of the mesh assuming unit density. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>localInertia</em> </td><td>The inertia tensor in mesh local space assuming unit density. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>localCenterOfMass</em> </td><td>Position of center of mass (or centroid) in mesh local space. </td></tr> + </table> +</dl> + +<p>Referenced by <a class="el" href="PxMassProperties_8h-source.html#l00083">PxMassProperties::PxMassProperties()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5246b9a1efd734db68b211d51c672ed7"></a><!-- doxytag: member="PxConvexMesh::getNbPolygons" ref="5246b9a1efd734db68b211d51c672ed7" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxConvexMesh::getNbPolygons </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the number of polygons. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of polygons. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxConvexMesh.html#97ef9cae4003c691c023884b71caffb0" title="Returns the index buffer.">getIndexBuffer()</a> <a class="el" href="classPxConvexMesh.html#9c9e10d0faaa446ea96494160d359cba" title="Returns the polygon data.">getPolygonData()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="91f22f88d2a3a100711b94b815152fd2"></a><!-- doxytag: member="PxConvexMesh::getNbVertices" ref="91f22f88d2a3a100711b94b815152fd2" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxConvexMesh::getNbVertices </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the number of vertices. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of vertices. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxConvexMesh.html#3698df65fd0496d92a0fb7e80b7fe30e" title="Returns the vertices.">getVertices()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9c9e10d0faaa446ea96494160d359cba"></a><!-- doxytag: member="PxConvexMesh::getPolygonData" ref="9c9e10d0faaa446ea96494160d359cba" args="(PxU32 index, PxHullPolygon &data) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API bool PxConvexMesh::getPolygonData </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>index</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structPxHullPolygon.html">PxHullPolygon</a> & </td> + <td class="paramname"> <em>data</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the polygon data. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>index</em> </td><td>Polygon index in [0 ; <a class="el" href="classPxConvexMesh.html#5246b9a1efd734db68b211d51c672ed7" title="Returns the number of polygons.">getNbPolygons()</a>[. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>data</em> </td><td>Polygon data. </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if success. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxConvexMesh.html#97ef9cae4003c691c023884b71caffb0" title="Returns the index buffer.">getIndexBuffer()</a> <a class="el" href="classPxConvexMesh.html#5246b9a1efd734db68b211d51c672ed7" title="Returns the number of polygons.">getNbPolygons()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="b7cd51e753d6eaa80b73e06544db7f1b"></a><!-- doxytag: member="PxConvexMesh::getReferenceCount" ref="b7cd51e753d6eaa80b73e06544db7f1b" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxConvexMesh::getReferenceCount </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the reference count of a convex mesh. +<p> +At creation, the reference count of the convex mesh is 1. Every shape referencing this convex mesh increments the count by 1. When the reference count reaches 0, and only then, the convex mesh gets destroyed automatically.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the current reference count. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3698df65fd0496d92a0fb7e80b7fe30e"></a><!-- doxytag: member="PxConvexMesh::getVertices" ref="3698df65fd0496d92a0fb7e80b7fe30e" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API const <a class="el" href="classPxVec3.html">PxVec3</a>* PxConvexMesh::getVertices </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the vertices. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Array of vertices. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxConvexMesh.html#91f22f88d2a3a100711b94b815152fd2" title="Returns the number of vertices.">getNbVertices()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="940cb6a762ae1689b217e62facf461eb"></a><!-- doxytag: member="PxConvexMesh::isGpuCompatible" ref="940cb6a762ae1689b217e62facf461eb" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API bool PxConvexMesh::isGpuCompatible </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +This method decides whether a convex mesh is gpu compatible. If the total number of vertices are more than 64 or any number of vertices in a polygon is more than 32, or convex hull data was not cooked with GPU data enabled during cooking or was loaded from a serialized collection, the convex hull is incompatible with GPU collision detection. Otherwise it is compatible. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the convex hull is gpu compatible </dd></dl> + +</div> +</div><p> +<a class="anchor" name="83fcfce5eb9b19deab9430ae0acc0e0a"></a><!-- doxytag: member="PxConvexMesh::isKindOf" ref="83fcfce5eb9b19deab9430ae0acc0e0a" args="(const char *name) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API bool PxConvexMesh::isKindOf </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>superClass</em> </td> + <td> ) </td> + <td> const<code> [inline, protected, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns whether a given type name matches with the type of this instance. +<p> + +<p>Reimplemented from <a class="el" href="classPxBase.html#ae9d444c7cfd1715a101350a1b1226ef">PxBase</a>.</p> + +<p>References <a class="el" href="PxBase_8h-source.html#l00178">PxBase::isKindOf()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6d2ce602a2383f40a3eb7d79e0c990d8"></a><!-- doxytag: member="PxConvexMesh::release" ref="6d2ce602a2383f40a3eb7d79e0c990d8" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_PHYSX_COMMON_API void PxConvexMesh::release </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Decrements the reference count of a convex mesh and releases it if the new reference count is zero. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxPhysics.html#54fc5f8b0884977ccfd45ea829392a52" title="Creates a convex mesh object.">PxPhysics.createConvexMesh()</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> </dd></dl> + +<p>Implements <a class="el" href="classPxBase.html#fe6aedda1df0d6d29b1a28213a5ee25a">PxBase</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxConvexMesh_8h-source.html">PxConvexMesh.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> |