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/classPxMeshOverlapUtil.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/classPxMeshOverlapUtil.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshOverlapUtil.html | 324 |
1 files changed, 324 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshOverlapUtil.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshOverlapUtil.html new file mode 100644 index 00000000..7a5c2022 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshOverlapUtil.html @@ -0,0 +1,324 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxMeshOverlapUtil 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>PxMeshOverlapUtil Class Reference<br> +<small> +[<a class="el" href="group__extensions.html">Extensions</a>]</small> +</h1><!-- doxytag: class="PxMeshOverlapUtil" -->Utility class to find mesh triangles touched by a specified geometry object. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxTriangleMeshExt_8h-source.html">PxTriangleMeshExt.h</a>></code> +<p> + +<p> +<a href="classPxMeshOverlapUtil-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshOverlapUtil.html#bd9c8b4408c4a5d4a8edddfd77ae3a32">PxMeshOverlapUtil</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshOverlapUtil.html#8dde132a40d70f077a3f1f18aa4602c1">~PxMeshOverlapUtil</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshOverlapUtil.html#5a7ae3b4ede9cd27b22205668a850fce">findOverlap</a> (const <a class="el" href="classPxGeometry.html">PxGeometry</a> &geom, const <a class="el" href="classPxTransform.html">PxTransform</a> &geomPose, const <a class="el" href="classPxTriangleMeshGeometry.html">PxTriangleMeshGeometry</a> &meshGeom, const <a class="el" href="classPxTransform.html">PxTransform</a> &meshPose)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Find the mesh triangles which touch the specified geometry object. <a href="#5a7ae3b4ede9cd27b22205668a850fce"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshOverlapUtil.html#5df6a18748cb8fc4e8fe5bca26b64182">findOverlap</a> (const <a class="el" href="classPxGeometry.html">PxGeometry</a> &geom, const <a class="el" href="classPxTransform.html">PxTransform</a> &geomPose, const <a class="el" href="classPxHeightFieldGeometry.html">PxHeightFieldGeometry</a> &hfGeom, const <a class="el" href="classPxTransform.html">PxTransform</a> &hfPose)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Find the height field triangles which touch the specified geometry object. <a href="#5df6a18748cb8fc4e8fe5bca26b64182"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshOverlapUtil.html#afc10eb1eb093a12f44ad751edda5059">getResults</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves array of triangle indices after a findOverlap call. <a href="#afc10eb1eb093a12f44ad751edda5059"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshOverlapUtil.html#3c6325446aac1cf7f1a8f07ffe90dd03">getNbResults</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves number of triangle indices after a findOverlap call. <a href="#3c6325446aac1cf7f1a8f07ffe90dd03"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshOverlapUtil.html#e7c3e17877da7c7c7fb3049401a1f8d4">mResultsMemory</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshOverlapUtil.html#a2c290a124977239d5c5210e972ffd8d">mResults</a> [256]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshOverlapUtil.html#cfe5ac18f78dff731479057553f04785">mNbResults</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshOverlapUtil.html#84e59558ff811c57d858bc5d0cde469d">mMaxNbResults</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Utility class to find mesh triangles touched by a specified geometry object. +<p> +This class is a helper calling <a class="el" href="classPxMeshQuery.html#ea451debbcaca51f9f1f49df3d5bfe74" title="Find the mesh triangles which touch the specified geometry object.">PxMeshQuery::findOverlapTriangleMesh</a> or <a class="el" href="classPxMeshQuery.html#461e1f01530df9d99e0762ca20493c2d" title="Find the height field triangles which touch the specified geometry object.">PxMeshQuery::findOverlapHeightField</a> under the hood, while taking care of necessary memory management issues.<p> +<a class="el" href="classPxMeshQuery.html#ea451debbcaca51f9f1f49df3d5bfe74" title="Find the mesh triangles which touch the specified geometry object.">PxMeshQuery::findOverlapTriangleMesh</a> and <a class="el" href="classPxMeshQuery.html#461e1f01530df9d99e0762ca20493c2d" title="Find the height field triangles which touch the specified geometry object.">PxMeshQuery::findOverlapHeightField</a> are the "raw" functions operating on user-provided fixed-size buffers. These functions abort with an error code in case of buffer overflow. <a class="el" href="classPxMeshOverlapUtil.html" title="Utility class to find mesh triangles touched by a specified geometry object.">PxMeshOverlapUtil</a> is a convenient helper function checking this error code, and resizing buffers appropriately, until the desired call succeeds.<p> +Returned triangle indices are stored within the class, and can be used with <a class="el" href="classPxMeshQuery.html#c567bb759621105f07886f257587d70f" title="Retrieves triangle data from a triangle ID.">PxMeshQuery::getTriangle()</a> to retrieve the triangle properties. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="bd9c8b4408c4a5d4a8edddfd77ae3a32"></a><!-- doxytag: member="PxMeshOverlapUtil::PxMeshOverlapUtil" ref="bd9c8b4408c4a5d4a8edddfd77ae3a32" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxMeshOverlapUtil::PxMeshOverlapUtil </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="8dde132a40d70f077a3f1f18aa4602c1"></a><!-- doxytag: member="PxMeshOverlapUtil::~PxMeshOverlapUtil" ref="8dde132a40d70f077a3f1f18aa4602c1" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxMeshOverlapUtil::~PxMeshOverlapUtil </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="5df6a18748cb8fc4e8fe5bca26b64182"></a><!-- doxytag: member="PxMeshOverlapUtil::findOverlap" ref="5df6a18748cb8fc4e8fe5bca26b64182" args="(const PxGeometry &geom, const PxTransform &geomPose, const PxHeightFieldGeometry &hfGeom, const PxTransform &hfPose)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxMeshOverlapUtil::findOverlap </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxGeometry.html">PxGeometry</a> & </td> + <td class="paramname"> <em>geom</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> & </td> + <td class="paramname"> <em>geomPose</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxHeightFieldGeometry.html">PxHeightFieldGeometry</a> & </td> + <td class="paramname"> <em>hfGeom</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> & </td> + <td class="paramname"> <em>hfPose</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Find the height field triangles which touch the specified geometry object. +<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>geom</em> </td><td>The geometry object to test for height field overlaps. Supported geometries are <a class="el" href="classPxSphereGeometry.html" title="A class representing the geometry of a sphere.">PxSphereGeometry</a>, <a class="el" href="classPxCapsuleGeometry.html" title="Class representing the geometry of a capsule.">PxCapsuleGeometry</a> and <a class="el" href="classPxBoxGeometry.html" title="Class representing the geometry of a box.">PxBoxGeometry</a>. The sphere and capsule queries are currently conservative estimates. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>geomPose</em> </td><td>Pose of the geometry object </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>hfGeom</em> </td><td>The height field geometry to check overlap against </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>hfPose</em> </td><td>Pose of the height field </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of overlaps found. Triangle indices can then be accessed through the <a class="el" href="classPxMeshOverlapUtil.html#afc10eb1eb093a12f44ad751edda5059" title="Retrieves array of triangle indices after a findOverlap call.">getResults()</a> function.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxGeometry.html" title="A geometry object.">PxGeometry</a> <a class="el" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector">PxTransform</a> <a class="el" href="classPxHeightFieldGeometry.html" title="Height field geometry class.">PxHeightFieldGeometry</a> <a class="el" href="classPxMeshQuery.html#461e1f01530df9d99e0762ca20493c2d" title="Find the height field triangles which touch the specified geometry object.">PxMeshQuery::findOverlapHeightField</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="5a7ae3b4ede9cd27b22205668a850fce"></a><!-- doxytag: member="PxMeshOverlapUtil::findOverlap" ref="5a7ae3b4ede9cd27b22205668a850fce" args="(const PxGeometry &geom, const PxTransform &geomPose, const PxTriangleMeshGeometry &meshGeom, const PxTransform &meshPose)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxMeshOverlapUtil::findOverlap </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxGeometry.html">PxGeometry</a> & </td> + <td class="paramname"> <em>geom</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> & </td> + <td class="paramname"> <em>geomPose</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxTriangleMeshGeometry.html">PxTriangleMeshGeometry</a> & </td> + <td class="paramname"> <em>meshGeom</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> & </td> + <td class="paramname"> <em>meshPose</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Find the mesh triangles which touch the specified geometry object. +<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>geom</em> </td><td>The geometry object to test for mesh triangle overlaps. Supported geometries are <a class="el" href="classPxSphereGeometry.html" title="A class representing the geometry of a sphere.">PxSphereGeometry</a>, <a class="el" href="classPxCapsuleGeometry.html" title="Class representing the geometry of a capsule.">PxCapsuleGeometry</a> and <a class="el" href="classPxBoxGeometry.html" title="Class representing the geometry of a box.">PxBoxGeometry</a> </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>geomPose</em> </td><td>Pose of the geometry object </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>meshGeom</em> </td><td>The triangle mesh geometry to check overlap against </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>meshPose</em> </td><td>Pose of the triangle mesh </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of overlaps found. Triangle indices can then be accessed through the <a class="el" href="classPxMeshOverlapUtil.html#afc10eb1eb093a12f44ad751edda5059" title="Retrieves array of triangle indices after a findOverlap call.">getResults()</a> function.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxGeometry.html" title="A geometry object.">PxGeometry</a> <a class="el" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector">PxTransform</a> <a class="el" href="classPxTriangleMeshGeometry.html" title="Triangle mesh geometry class.">PxTriangleMeshGeometry</a> <a class="el" href="classPxMeshQuery.html#ea451debbcaca51f9f1f49df3d5bfe74" title="Find the mesh triangles which touch the specified geometry object.">PxMeshQuery::findOverlapTriangleMesh</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3c6325446aac1cf7f1a8f07ffe90dd03"></a><!-- doxytag: member="PxMeshOverlapUtil::getNbResults" ref="3c6325446aac1cf7f1a8f07ffe90dd03" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxMeshOverlapUtil::getNbResults </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves number of triangle indices after a findOverlap call. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of touched triangles </dd></dl> + +</div> +</div><p> +<a class="anchor" name="afc10eb1eb093a12f44ad751edda5059"></a><!-- doxytag: member="PxMeshOverlapUtil::getResults" ref="afc10eb1eb093a12f44ad751edda5059" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>* PxMeshOverlapUtil::getResults </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves array of triangle indices after a findOverlap call. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Indices of touched triangles </dd></dl> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="84e59558ff811c57d858bc5d0cde469d"></a><!-- doxytag: member="PxMeshOverlapUtil::mMaxNbResults" ref="84e59558ff811c57d858bc5d0cde469d" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxMeshOverlapUtil.html#84e59558ff811c57d858bc5d0cde469d">PxMeshOverlapUtil::mMaxNbResults</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="cfe5ac18f78dff731479057553f04785"></a><!-- doxytag: member="PxMeshOverlapUtil::mNbResults" ref="cfe5ac18f78dff731479057553f04785" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxMeshOverlapUtil.html#cfe5ac18f78dff731479057553f04785">PxMeshOverlapUtil::mNbResults</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="a2c290a124977239d5c5210e972ffd8d"></a><!-- doxytag: member="PxMeshOverlapUtil::mResults" ref="a2c290a124977239d5c5210e972ffd8d" args="[256]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxMeshOverlapUtil.html#a2c290a124977239d5c5210e972ffd8d">PxMeshOverlapUtil::mResults</a>[256]<code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="e7c3e17877da7c7c7fb3049401a1f8d4"></a><!-- doxytag: member="PxMeshOverlapUtil::mResultsMemory" ref="e7c3e17877da7c7c7fb3049401a1f8d4" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>* <a class="el" href="classPxMeshOverlapUtil.html#e7c3e17877da7c7c7fb3049401a1f8d4">PxMeshOverlapUtil::mResultsMemory</a><code> [private]</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="PxTriangleMeshExt_8h-source.html">PxTriangleMeshExt.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> |