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/classPxPruningStructure.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/classPxPruningStructure.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxPruningStructure.html | 303 |
1 files changed, 303 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxPruningStructure.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxPruningStructure.html new file mode 100644 index 00000000..7be3f573 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxPruningStructure.html @@ -0,0 +1,303 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxPruningStructure 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>PxPruningStructure Class Reference<br> +<small> +[<a class="el" href="group__physics.html">Physics</a>]</small> +</h1><!-- doxytag: class="PxPruningStructure" --><!-- doxytag: inherits="PxBase" -->A precomputed pruning structure to accelerate scene queries against newly added actors. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxPruningStructure_8h-source.html">PxPruningStructure.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxPruningStructure:</div> +<div class="dynsection"> +<p><center><img src="classPxPruningStructure__inherit__graph.png" border="0" usemap="#PxPruningStructure__inherit__map" alt="Inheritance graph"></center> +<map name="PxPruningStructure__inherit__map"> +<area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="39,16,95,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxPruningStructure:</div> +<div class="dynsection"> +<p><center><img src="classPxPruningStructure__coll__graph.png" border="0" usemap="#PxPruningStructure__coll__map" alt="Collaboration graph"></center> +<map name="PxPruningStructure__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="classPxPruningStructure-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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPruningStructure.html#1075ac464928c4f97d98e4f287b33182">release</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Release this object. <a href="#1075ac464928c4f97d98e4f287b33182"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPruningStructure.html#6c930e8a4f47e3b4a3f1c5bde7f98169">getRigidActors</a> (<a class="el" href="classPxRigidActor.html">PxRigidActor</a> **userBuffer, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> bufferSize, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> startIndex=0) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve rigid actors in the pruning structure. <a href="#6c930e8a4f47e3b4a3f1c5bde7f98169"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPruningStructure.html#654e539a68db0ea162d54f8c5ee8c4ed">getNbRigidActors</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of rigid actors in the pruning structure. <a href="#654e539a68db0ea162d54f8c5ee8c4ed"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPruningStructure.html#d3dd642b3521f1ddec760bb1f41b2f7d">getConcreteTypeName</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#d3dd642b3521f1ddec760bb1f41b2f7d"></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="classPxPruningStructure.html#034b569b8e1db318efcb97fa3dc03020">PxPruningStructure</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="classPxPruningStructure.html#2123cf6d0ec8f856c4b8cdf7c3693326">PxPruningStructure</a> (<a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPruningStructure.html#4d56877674adf3eaf854cd677d2b3f56">~PxPruningStructure</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPruningStructure.html#e98909cff0cdd4acaa494e760380004d">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="#e98909cff0cdd4acaa494e760380004d"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A precomputed pruning structure to accelerate scene queries against newly added actors. +<p> +The pruning structure can be provided to <a class="el" href="classPxScene.html" title="A scene is a collection of bodies, particle systems and constraints which can interact...">PxScene</a>:: addActors() in which case it will get merged directly into the scene query optimization AABB tree, thus leading to improved performance when doing queries against the newly added actors. This applies to both static and dynamic actors.<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd><a class="el" href="classPxPruningStructure.html" title="A precomputed pruning structure to accelerate scene queries against newly added actors...">PxPruningStructure</a> objects can be added to a collection and get serialized. <p> +Adding a <a class="el" href="classPxPruningStructure.html" title="A precomputed pruning structure to accelerate scene queries against newly added actors...">PxPruningStructure</a> object to a collection will also add the actors that were used to build the pruning structure.<p> +<a class="el" href="classPxPruningStructure.html" title="A precomputed pruning structure to accelerate scene queries against newly added actors...">PxPruningStructure</a> must be released before its rigid actors. <p> +<a class="el" href="classPxRigidBody.html" title="PxRigidBody is a base class shared between dynamic rigid body objects.">PxRigidBody</a> objects can be in one <a class="el" href="classPxPruningStructure.html" title="A precomputed pruning structure to accelerate scene queries against newly added actors...">PxPruningStructure</a> only. <p> +Changing the bounds of <a class="el" href="classPxRigidBody.html" title="PxRigidBody is a base class shared between dynamic rigid body objects.">PxRigidBody</a> objects assigned to a pruning structure that has not been added to a scene yet will invalidate the pruning structure. Same happens if shape scene query flags change or shape gets removed from an actor.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxScene.html#caae28f21ccf233d0a9c0ad17a1ff5bd" title="Adds actors to this scene.">PxScene::addActors</a> <a class="el" href="classPxCollection.html" title="Collection class for serialization.">PxCollection</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="034b569b8e1db318efcb97fa3dc03020"></a><!-- doxytag: member="PxPruningStructure::PxPruningStructure" ref="034b569b8e1db318efcb97fa3dc03020" args="(PxType concreteType, PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxPruningStructure::PxPruningStructure </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="2123cf6d0ec8f856c4b8cdf7c3693326"></a><!-- doxytag: member="PxPruningStructure::PxPruningStructure" ref="2123cf6d0ec8f856c4b8cdf7c3693326" args="(PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxPruningStructure::PxPruningStructure </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="4d56877674adf3eaf854cd677d2b3f56"></a><!-- doxytag: member="PxPruningStructure::~PxPruningStructure" ref="4d56877674adf3eaf854cd677d2b3f56" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxPruningStructure::~PxPruningStructure </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="d3dd642b3521f1ddec760bb1f41b2f7d"></a><!-- doxytag: member="PxPruningStructure::getConcreteTypeName" ref="d3dd642b3521f1ddec760bb1f41b2f7d" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual const char* PxPruningStructure::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="654e539a68db0ea162d54f8c5ee8c4ed"></a><!-- doxytag: member="PxPruningStructure::getNbRigidActors" ref="654e539a68db0ea162d54f8c5ee8c4ed" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxPruningStructure::getNbRigidActors </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 rigid actors in the pruning structure. +<p> +You can use <a class="el" href="classPxPruningStructure.html#6c930e8a4f47e3b4a3f1c5bde7f98169" title="Retrieve rigid actors in the pruning structure.">getRigidActors()</a> to retrieve the rigid actor pointers.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of rigid actors in the pruning structure.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxRigidActor.html" title="PxRigidActor represents a base class shared between dynamic and static rigid bodies...">PxRigidActor</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="6c930e8a4f47e3b4a3f1c5bde7f98169"></a><!-- doxytag: member="PxPruningStructure::getRigidActors" ref="6c930e8a4f47e3b4a3f1c5bde7f98169" args="(PxRigidActor **userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxPruningStructure::getRigidActors </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxRigidActor.html">PxRigidActor</a> ** </td> + <td class="paramname"> <em>userBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>bufferSize</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>startIndex</em> = <code>0</code></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> +Retrieve rigid actors in the pruning structure. +<p> +You can retrieve the number of rigid actor pointers by calling <a class="el" href="classPxPruningStructure.html#654e539a68db0ea162d54f8c5ee8c4ed" title="Returns the number of rigid actors in the pruning structure.">getNbRigidActors()</a><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>userBuffer</em> </td><td>The buffer to store the actor pointers. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>bufferSize</em> </td><td>Size of provided user buffer. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>startIndex</em> </td><td>Index of first actor pointer to be retrieved </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of rigid actor pointers written to the buffer.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxRigidActor.html" title="PxRigidActor represents a base class shared between dynamic and static rigid bodies...">PxRigidActor</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e98909cff0cdd4acaa494e760380004d"></a><!-- doxytag: member="PxPruningStructure::isKindOf" ref="e98909cff0cdd4acaa494e760380004d" args="(const char *name) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxPruningStructure::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="1075ac464928c4f97d98e4f287b33182"></a><!-- doxytag: member="PxPruningStructure::release" ref="1075ac464928c4f97d98e4f287b33182" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxPruningStructure::release </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Release this object. +<p> + +<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="PxPruningStructure_8h-source.html">PxPruningStructure.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> |