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/classPxSpatialIndex.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/classPxSpatialIndex.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxSpatialIndex.html | 461 |
1 files changed, 461 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxSpatialIndex.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxSpatialIndex.html new file mode 100644 index 00000000..41b02ab8 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxSpatialIndex.html @@ -0,0 +1,461 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxSpatialIndex 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>PxSpatialIndex Class Reference<br> +<small> +[<a class="el" href="group__physics.html">Physics</a>]</small> +</h1><!-- doxytag: class="PxSpatialIndex" -->provides direct access to PhysX' Spatial Query engine +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxSpatialIndex_8h-source.html">PxSpatialIndex.h</a>></code> +<p> + +<p> +<a href="classPxSpatialIndex-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 <a class="el" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#7af68f3695944ba55a4e3b9ddf8b95a6">insert</a> (<a class="el" href="classPxSpatialIndexItem.html">PxSpatialIndexItem</a> &item, const <a class="el" href="classPxBounds3.html">PxBounds3</a> &bounds)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">insert a bounding box into a spatial index <a href="#7af68f3695944ba55a4e3b9ddf8b95a6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#cf1e4d6cbeff5759dfbe471eaeb4d9ed">update</a> (<a class="el" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a> id, const <a class="el" href="classPxBounds3.html">PxBounds3</a> &bounds)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">update a bounding box in a spatial index <a href="#cf1e4d6cbeff5759dfbe471eaeb4d9ed"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#0d9de31ad322614cac4c19bcc6a076f1">remove</a> (<a class="el" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a> id)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">remove an item from a spatial index <a href="#0d9de31ad322614cac4c19bcc6a076f1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#00cf7e306339f210ca9c9f4cc0ca8b76">overlap</a> (const <a class="el" href="classPxBounds3.html">PxBounds3</a> &aabb, <a class="el" href="structPxSpatialOverlapCallback.html">PxSpatialOverlapCallback</a> &callback) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">make an overlap query against a spatial index <a href="#00cf7e306339f210ca9c9f4cc0ca8b76"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#51d38d0a9ced5338ea67b77be5bc044c">raycast</a> (const <a class="el" href="classPxVec3.html">PxVec3</a> &origin, const <a class="el" href="classPxVec3.html">PxVec3</a> &unitDir, PxReal maxDist, <a class="el" href="structPxSpatialLocationCallback.html">PxSpatialLocationCallback</a> &callback) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">make a raycast query against a spatial index <a href="#51d38d0a9ced5338ea67b77be5bc044c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#fa49a33803f4f392d2908287c41bfeab">sweep</a> (const <a class="el" href="classPxBounds3.html">PxBounds3</a> &aabb, const <a class="el" href="classPxVec3.html">PxVec3</a> &unitDir, PxReal maxDist, <a class="el" href="structPxSpatialLocationCallback.html">PxSpatialLocationCallback</a> &callback) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">make a sweep query against a spatial index <a href="#fa49a33803f4f392d2908287c41bfeab"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#0d92a1d62a9c3499c19195b9ec459f24">flush</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">force an immediate update of the internal structures of the index <a href="#0d92a1d62a9c3499c19195b9ec459f24"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#fe8693bc795bb94f0ee575d4281aa5ac">rebuildFull</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">force a full optimized rebuild of the index. <a href="#fe8693bc795bb94f0ee575d4281aa5ac"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#c1d1711a3dc99f9bb244ca0d2ea78f5f">setIncrementalRebuildRate</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> rate)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">set the incremental rebuild rate for the index. <a href="#c1d1711a3dc99f9bb244ca0d2ea78f5f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#c2410c7b878f0cd2b25f74fa4e7e4e69">rebuildStep</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">take one step in rebuilding the tree. See <a class="el" href="classPxSpatialIndex.html#c1d1711a3dc99f9bb244ca0d2ea78f5f" title="set the incremental rebuild rate for the index.">setIncrementalRebuildRate()</a> <a href="#c2410c7b878f0cd2b25f74fa4e7e4e69"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#0a3706d24bfce84cebfeed9e366d8a14">release</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">release this object <a href="#0a3706d24bfce84cebfeed9e366d8a14"></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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSpatialIndex.html#4eef678b188d97ac75362f246f3d69c3">~PxSpatialIndex</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +provides direct access to PhysX' Spatial Query engine +<p> +This class allows bounding boxes to be inserted, and then queried using sweep, raycast and overlap checks.<p> +It is not thread-safe and defers handling some updates until queries are invoked, so care must be taken when calling any methods in parallel. Specifically, to call query methods (raycast, overlap, sweep) in parallel, first call <a class="el" href="classPxSpatialIndex.html#0d92a1d62a9c3499c19195b9ec459f24" title="force an immediate update of the internal structures of the index">flush()</a> to force immediate update of internal structures.<p> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000038">Deprecated:</a></b></dt><dd>Spatial index feature has been deprecated in PhysX version 3.4</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__physics.html#g4608473fcea7bec808f20e2e9ed4bbf1" title="Creates a spatial index.">PxCreateSpatialIndex</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="4eef678b188d97ac75362f246f3d69c3"></a><!-- doxytag: member="PxSpatialIndex::~PxSpatialIndex" ref="4eef678b188d97ac75362f246f3d69c3" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxSpatialIndex::~PxSpatialIndex </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="0d92a1d62a9c3499c19195b9ec459f24"></a><!-- doxytag: member="PxSpatialIndex::flush" ref="0d92a1d62a9c3499c19195b9ec459f24" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxSpatialIndex::flush </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +force an immediate update of the internal structures of the index +<p> +For reasons of efficiency an index structure may be lazily updated at the point of query if this method is not called. Once this method has been called, subsequent queries (sweeps, overlaps, raycasts) may be executed in parallel until the next write call to the index (insertion, removal, update, rebuild) +</div> +</div><p> +<a class="anchor" name="7af68f3695944ba55a4e3b9ddf8b95a6"></a><!-- doxytag: member="PxSpatialIndex::insert" ref="7af68f3695944ba55a4e3b9ddf8b95a6" args="(PxSpatialIndexItem &item, const PxBounds3 &bounds)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a> PxSpatialIndex::insert </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxSpatialIndexItem.html">PxSpatialIndexItem</a> & </td> + <td class="paramname"> <em>item</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxBounds3.html">PxBounds3</a> & </td> + <td class="paramname"> <em>bounds</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +insert a bounding box into a spatial index +<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>item</em> </td><td>the item to be inserted </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>bounds</em> </td><td>the bounds of the new item </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="00cf7e306339f210ca9c9f4cc0ca8b76"></a><!-- doxytag: member="PxSpatialIndex::overlap" ref="00cf7e306339f210ca9c9f4cc0ca8b76" args="(const PxBounds3 &aabb, PxSpatialOverlapCallback &callback) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxSpatialIndex::overlap </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxBounds3.html">PxBounds3</a> & </td> + <td class="paramname"> <em>aabb</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structPxSpatialOverlapCallback.html">PxSpatialOverlapCallback</a> & </td> + <td class="paramname"> <em>callback</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> +make an overlap query against a spatial index +<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>aabb</em> </td><td>the axis aligned bounding box for the query </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>callback</em> </td><td>the callback to invoke when an overlap is found </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="51d38d0a9ced5338ea67b77be5bc044c"></a><!-- doxytag: member="PxSpatialIndex::raycast" ref="51d38d0a9ced5338ea67b77be5bc044c" args="(const PxVec3 &origin, const PxVec3 &unitDir, PxReal maxDist, PxSpatialLocationCallback &callback) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxSpatialIndex::raycast </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>origin</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>unitDir</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>maxDist</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structPxSpatialLocationCallback.html">PxSpatialLocationCallback</a> & </td> + <td class="paramname"> <em>callback</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> +make a raycast query against a spatial index +<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>origin</em> </td><td>the origin of the ray </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>unitDir</em> </td><td>a unit vector in the direction of the ray </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>maxDist</em> </td><td>the maximum distance to cast the ray </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>callback</em> </td><td>the callback to invoke when an item is hit by the ray </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="fe8693bc795bb94f0ee575d4281aa5ac"></a><!-- doxytag: member="PxSpatialIndex::rebuildFull" ref="fe8693bc795bb94f0ee575d4281aa5ac" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxSpatialIndex::rebuildFull </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +force a full optimized rebuild of the index. +<p> + +</div> +</div><p> +<a class="anchor" name="c2410c7b878f0cd2b25f74fa4e7e4e69"></a><!-- doxytag: member="PxSpatialIndex::rebuildStep" ref="c2410c7b878f0cd2b25f74fa4e7e4e69" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxSpatialIndex::rebuildStep </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +take one step in rebuilding the tree. See <a class="el" href="classPxSpatialIndex.html#c1d1711a3dc99f9bb244ca0d2ea78f5f" title="set the incremental rebuild rate for the index.">setIncrementalRebuildRate()</a> +<p> + +</div> +</div><p> +<a class="anchor" name="0a3706d24bfce84cebfeed9e366d8a14"></a><!-- doxytag: member="PxSpatialIndex::release" ref="0a3706d24bfce84cebfeed9e366d8a14" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxSpatialIndex::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> + +</div> +</div><p> +<a class="anchor" name="0d9de31ad322614cac4c19bcc6a076f1"></a><!-- doxytag: member="PxSpatialIndex::remove" ref="0d9de31ad322614cac4c19bcc6a076f1" args="(PxSpatialIndexItemId id)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxSpatialIndex::remove </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a> </td> + <td class="paramname"> <em>id</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +remove an item from a spatial index +<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>id</em> </td><td>the id of the item to be removed </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="c1d1711a3dc99f9bb244ca0d2ea78f5f"></a><!-- doxytag: member="PxSpatialIndex::setIncrementalRebuildRate" ref="c1d1711a3dc99f9bb244ca0d2ea78f5f" args="(PxU32 rate)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxSpatialIndex::setIncrementalRebuildRate </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>rate</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +set the incremental rebuild rate for the index. +<p> +The index builds gradually in the background each time a rebuild step is taken; this value determines the number of steps required to rebuild the index.<p> +See <a class="el" href="classPxScene.html#bf2322887ca4db2fdea0229a44e2892c" title="Sets the rebuild rate of the dynamic tree pruning structures.">PxScene::setDynamicTreeRebuildRateHint()</a> for more information.<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>rate</em> </td><td>the rebuild rate</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxScene.html#bf2322887ca4db2fdea0229a44e2892c" title="Sets the rebuild rate of the dynamic tree pruning structures.">PxScene::setDynamicTreeRebuildRateHint()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="fa49a33803f4f392d2908287c41bfeab"></a><!-- doxytag: member="PxSpatialIndex::sweep" ref="fa49a33803f4f392d2908287c41bfeab" args="(const PxBounds3 &aabb, const PxVec3 &unitDir, PxReal maxDist, PxSpatialLocationCallback &callback) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxSpatialIndex::sweep </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxBounds3.html">PxBounds3</a> & </td> + <td class="paramname"> <em>aabb</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>unitDir</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>maxDist</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structPxSpatialLocationCallback.html">PxSpatialLocationCallback</a> & </td> + <td class="paramname"> <em>callback</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> +make a sweep query against a spatial index +<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>aabb</em> </td><td>the axis aligned bounding box to sweep </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>unitDir</em> </td><td>a unit vector in the direction of the sweep </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>maxDist</em> </td><td>the maximum distance to apply the sweep </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>callback</em> </td><td>the callback to invoke when an item is hit by the sweep </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="cf1e4d6cbeff5759dfbe471eaeb4d9ed"></a><!-- doxytag: member="PxSpatialIndex::update" ref="cf1e4d6cbeff5759dfbe471eaeb4d9ed" args="(PxSpatialIndexItemId id, const PxBounds3 &bounds)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxSpatialIndex::update </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a> </td> + <td class="paramname"> <em>id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxBounds3.html">PxBounds3</a> & </td> + <td class="paramname"> <em>bounds</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +update a bounding box in a spatial index +<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>id</em> </td><td>the id of the item to be updated </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>bounds</em> </td><td>the new bounds of the item </td></tr> + </table> +</dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxSpatialIndex_8h-source.html">PxSpatialIndex.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> |