aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/PxSpatialIndex_8h-source.html
diff options
context:
space:
mode:
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/PxSpatialIndex_8h-source.html')
-rw-r--r--PhysX_3.4/Documentation/PhysXAPI/files/PxSpatialIndex_8h-source.html141
1 files changed, 141 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/PxSpatialIndex_8h-source.html b/PhysX_3.4/Documentation/PhysXAPI/files/PxSpatialIndex_8h-source.html
new file mode 100644
index 00000000..607b8809
--- /dev/null
+++ b/PhysX_3.4/Documentation/PhysXAPI/files/PxSpatialIndex_8h-source.html
@@ -0,0 +1,141 @@
+<html>
+ <head>
+ <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxSpatialIndex.h Source File</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> &nbsp;
+ <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp;
+ <a class="qindex" href="annotated.html">Compound List</a> &nbsp;
+ <a class="qindex" href="functions.html">Compound Members</a> &nbsp;
+ </center>
+ <hr class="second">
+ </div>
+<!-- Generated by Doxygen 1.5.8 -->
+<h1>PxSpatialIndex.h</h1><a href="PxSpatialIndex_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// This code contains NVIDIA Confidential Information and is disclosed to you</span>
+<a name="l00002"></a>00002 <span class="comment">// under a form of NVIDIA software license agreement provided separately to you.</span>
+<a name="l00003"></a>00003 <span class="comment">//</span>
+<a name="l00004"></a>00004 <span class="comment">// Notice</span>
+<a name="l00005"></a>00005 <span class="comment">// NVIDIA Corporation and its licensors retain all intellectual property and</span>
+<a name="l00006"></a>00006 <span class="comment">// proprietary rights in and to this software and related documentation and</span>
+<a name="l00007"></a>00007 <span class="comment">// any modifications thereto. Any use, reproduction, disclosure, or</span>
+<a name="l00008"></a>00008 <span class="comment">// distribution of this software and related documentation without an express</span>
+<a name="l00009"></a>00009 <span class="comment">// license agreement from NVIDIA Corporation is strictly prohibited.</span>
+<a name="l00010"></a>00010 <span class="comment">//</span>
+<a name="l00011"></a>00011 <span class="comment">// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES</span>
+<a name="l00012"></a>00012 <span class="comment">// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO</span>
+<a name="l00013"></a>00013 <span class="comment">// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,</span>
+<a name="l00014"></a>00014 <span class="comment">// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.</span>
+<a name="l00015"></a>00015 <span class="comment">//</span>
+<a name="l00016"></a>00016 <span class="comment">// Information and code furnished is believed to be accurate and reliable.</span>
+<a name="l00017"></a>00017 <span class="comment">// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such</span>
+<a name="l00018"></a>00018 <span class="comment">// information or for any infringement of patents or other rights of third parties that may</span>
+<a name="l00019"></a>00019 <span class="comment">// result from its use. No license is granted by implication or otherwise under any patent</span>
+<a name="l00020"></a>00020 <span class="comment">// or patent rights of NVIDIA Corporation. Details are subject to change without notice.</span>
+<a name="l00021"></a>00021 <span class="comment">// This code supersedes and replaces all information previously supplied.</span>
+<a name="l00022"></a>00022 <span class="comment">// NVIDIA Corporation products are not authorized for use as critical</span>
+<a name="l00023"></a>00023 <span class="comment">// components in life support devices or systems without express written approval of</span>
+<a name="l00024"></a>00024 <span class="comment">// NVIDIA Corporation.</span>
+<a name="l00025"></a>00025 <span class="comment">//</span>
+<a name="l00026"></a>00026 <span class="comment">// Copyright (c) 2008-2016 NVIDIA Corporation. All rights reserved.</span>
+<a name="l00027"></a>00027 <span class="comment">// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.</span>
+<a name="l00028"></a>00028 <span class="comment">// Copyright (c) 2001-2004 NovodeX AG. All rights reserved. </span>
+<a name="l00029"></a>00029
+<a name="l00030"></a>00030
+<a name="l00031"></a>00031 <span class="preprocessor">#ifndef PX_PHYSICS_SPATIAL_INDEX</span>
+<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define PX_PHYSICS_SPATIAL_INDEX</span>
+<a name="l00033"></a>00033 <span class="preprocessor"></span>
+<a name="l00036"></a>00036 <span class="preprocessor">#include "<a class="code" href="PxPhysXConfig_8h.html">PxPhysXConfig.h</a>"</span>
+<a name="l00037"></a>00037 <span class="preprocessor">#include "<a class="code" href="PxTransform_8h.html">foundation/PxTransform.h</a>"</span>
+<a name="l00038"></a>00038 <span class="preprocessor">#include "<a class="code" href="PxGeometry_8h.html">geometry/PxGeometry.h</a>"</span>
+<a name="l00039"></a>00039 <span class="preprocessor">#include "<a class="code" href="PxQueryReport_8h.html">PxQueryReport.h</a>"</span>
+<a name="l00040"></a>00040
+<a name="l00041"></a>00041 <span class="preprocessor">#if !PX_DOXYGEN</span>
+<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="keyword">namespace </span>physx
+<a name="l00043"></a>00043 {
+<a name="l00044"></a>00044 <span class="preprocessor">#endif</span>
+<a name="l00045"></a>00045 <span class="preprocessor"></span>
+<a name="l00046"></a><a class="code" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">00046</a> <span class="keyword">typedef</span> <a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a> <a class="code" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a>;
+<a name="l00047"></a><a class="code" href="group__physics.html#gc5525ef79da01168ea797595a3e4dac0">00047</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a> <a class="code" href="group__physics.html#gc5525ef79da01168ea797595a3e4dac0">PX_SPATIAL_INDEX_INVALID_ITEM_ID</a> = 0xffffffff;
+<a name="l00048"></a>00048
+<a name="l00049"></a>00049
+<a name="l00050"></a><a class="code" href="classPxSpatialIndexItem.html">00050</a> <span class="keyword">class </span><a class="code" href="group__foundation.html#gfd8f8779793627061774cfcfa1b9fbd7">PX_DEPRECATED</a> <a class="code" href="classPxSpatialIndexItem.html">PxSpatialIndexItem</a>
+<a name="l00051"></a>00051 {
+<a name="l00052"></a>00052 };
+<a name="l00053"></a>00053
+<a name="l00061"></a><a class="code" href="structPxSpatialOverlapCallback.html">00061</a> <span class="keyword">struct </span><a class="code" href="group__foundation.html#gfd8f8779793627061774cfcfa1b9fbd7">PX_DEPRECATED</a> <a class="code" href="structPxSpatialOverlapCallback.html" title="Callback class for overlap queries against PxSpatialIndex.">PxSpatialOverlapCallback</a>
+<a name="l00062"></a>00062 {
+<a name="l00063"></a>00063
+<a name="l00071"></a>00071 <span class="keyword">virtual</span> <a class="code" href="group__scenequery.html#g4d0184965c0a910f5c96cb69c0690f5c" title="Describes query behavior after returning a partial query result via a callback.">PxAgain</a> onHit(<a class="code" href="classPxSpatialIndexItem.html">PxSpatialIndexItem</a>&amp; item) = 0;
+<a name="l00072"></a>00072
+<a name="l00073"></a><a class="code" href="structPxSpatialOverlapCallback.html#f720ae6cfcc1a4fc5cd4c654f21564b1">00073</a> <span class="keyword">virtual</span> <a class="code" href="structPxSpatialOverlapCallback.html#f720ae6cfcc1a4fc5cd4c654f21564b1">~PxSpatialOverlapCallback</a>() {}
+<a name="l00074"></a>00074 };
+<a name="l00075"></a>00075
+<a name="l00083"></a><a class="code" href="structPxSpatialLocationCallback.html">00083</a> <span class="keyword">struct </span><a class="code" href="group__foundation.html#gfd8f8779793627061774cfcfa1b9fbd7">PX_DEPRECATED</a> <a class="code" href="structPxSpatialLocationCallback.html" title="Callback class for raycast and sweep queries against PxSpatialIndex.">PxSpatialLocationCallback</a>
+<a name="l00084"></a>00084 {
+<a name="l00096"></a>00096 <span class="keyword">virtual</span> <a class="code" href="group__scenequery.html#g4d0184965c0a910f5c96cb69c0690f5c" title="Describes query behavior after returning a partial query result via a callback.">PxAgain</a> onHit(<a class="code" href="classPxSpatialIndexItem.html">PxSpatialIndexItem</a>&amp; item, <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> distance, <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a>&amp; shrunkDistance) = 0;
+<a name="l00097"></a>00097
+<a name="l00098"></a><a class="code" href="structPxSpatialLocationCallback.html#b3b5df6caf441e46163273d340cb478a">00098</a> <span class="keyword">virtual</span> <a class="code" href="structPxSpatialLocationCallback.html#b3b5df6caf441e46163273d340cb478a">~PxSpatialLocationCallback</a>() {}
+<a name="l00099"></a>00099 };
+<a name="l00100"></a>00100
+<a name="l00101"></a>00101
+<a name="l00102"></a>00102
+<a name="l00116"></a><a class="code" href="classPxSpatialIndex.html">00116</a> <span class="keyword">class </span><a class="code" href="group__foundation.html#gfd8f8779793627061774cfcfa1b9fbd7">PX_DEPRECATED</a> <a class="code" href="classPxSpatialIndex.html" title="provides direct access to PhysX&amp;#39; Spatial Query engine">PxSpatialIndex</a>
+<a name="l00117"></a>00117 {
+<a name="l00118"></a>00118 <span class="keyword">public</span>:
+<a name="l00119"></a>00119
+<a name="l00120"></a>00120
+<a name="l00127"></a>00127 <span class="keyword">virtual</span> <a class="code" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a> insert(<a class="code" href="classPxSpatialIndexItem.html">PxSpatialIndexItem</a>&amp; item,
+<a name="l00128"></a>00128 <span class="keyword">const</span> <a class="code" href="classPxBounds3.html" title="Class representing 3D range or axis aligned bounding box.">PxBounds3</a>&amp; bounds) = 0;
+<a name="l00129"></a>00129
+<a name="l00136"></a>00136 <span class="keyword">virtual</span> <span class="keywordtype">void</span> update(<a class="code" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a> <span class="keywordtype">id</span>,
+<a name="l00137"></a>00137 <span class="keyword">const</span> <a class="code" href="classPxBounds3.html" title="Class representing 3D range or axis aligned bounding box.">PxBounds3</a>&amp; bounds) = 0;
+<a name="l00138"></a>00138
+<a name="l00144"></a>00144 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <span class="keyword">remove</span>(<a class="code" href="group__physics.html#ga07c59a855d77f9e5f7bc2fc3cf8b816">PxSpatialIndexItemId</a> id) = 0;
+<a name="l00145"></a>00145
+<a name="l00146"></a>00146
+<a name="l00153"></a>00153 <span class="keyword">virtual</span> <span class="keywordtype">void</span> overlap(<span class="keyword">const</span> <a class="code" href="classPxBounds3.html" title="Class representing 3D range or axis aligned bounding box.">PxBounds3</a> &amp;aabb,
+<a name="l00154"></a>00154 <a class="code" href="structPxSpatialOverlapCallback.html" title="Callback class for overlap queries against PxSpatialIndex.">PxSpatialOverlapCallback</a>&amp; callback) <span class="keyword">const</span> = 0;
+<a name="l00155"></a>00155
+<a name="l00164"></a>00164 <span class="keyword">virtual</span> <span class="keywordtype">void</span> raycast(<span class="keyword">const</span> <a class="code" href="classPxVec3.html" title="3 Element vector class.">PxVec3</a>&amp; origin,
+<a name="l00165"></a>00165 <span class="keyword">const</span> <a class="code" href="classPxVec3.html" title="3 Element vector class.">PxVec3</a>&amp; unitDir,
+<a name="l00166"></a>00166 <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> maxDist,
+<a name="l00167"></a>00167 <a class="code" href="structPxSpatialLocationCallback.html" title="Callback class for raycast and sweep queries against PxSpatialIndex.">PxSpatialLocationCallback</a>&amp; callback) <span class="keyword">const</span> = 0;
+<a name="l00168"></a>00168
+<a name="l00177"></a>00177 <span class="keyword">virtual</span> <span class="keywordtype">void</span> sweep(<span class="keyword">const</span> <a class="code" href="classPxBounds3.html" title="Class representing 3D range or axis aligned bounding box.">PxBounds3</a>&amp; aabb,
+<a name="l00178"></a>00178 <span class="keyword">const</span> <a class="code" href="classPxVec3.html" title="3 Element vector class.">PxVec3</a>&amp; unitDir,
+<a name="l00179"></a>00179 <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> maxDist,
+<a name="l00180"></a>00180 <a class="code" href="structPxSpatialLocationCallback.html" title="Callback class for raycast and sweep queries against PxSpatialIndex.">PxSpatialLocationCallback</a>&amp; callback) <span class="keyword">const</span> = 0;
+<a name="l00181"></a>00181
+<a name="l00189"></a>00189 <span class="keyword">virtual</span> <span class="keywordtype">void</span> flush() = 0;
+<a name="l00190"></a>00190
+<a name="l00194"></a>00194 <span class="keyword">virtual</span> <span class="keywordtype">void</span> rebuildFull() = 0;
+<a name="l00195"></a>00195
+<a name="l00207"></a>00207 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setIncrementalRebuildRate(<a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a> rate) = 0;
+<a name="l00208"></a>00208
+<a name="l00212"></a>00212 <span class="keyword">virtual</span> <span class="keywordtype">void</span> rebuildStep() = 0;
+<a name="l00213"></a>00213
+<a name="l00217"></a>00217 <span class="keyword">virtual</span> <span class="keywordtype">void</span> release() = 0;
+<a name="l00218"></a>00218 <span class="keyword">protected</span>:
+<a name="l00219"></a><a class="code" href="classPxSpatialIndex.html#4eef678b188d97ac75362f246f3d69c3">00219</a> <span class="keyword">virtual</span> <a class="code" href="classPxSpatialIndex.html#4eef678b188d97ac75362f246f3d69c3">~PxSpatialIndex</a>(){}
+<a name="l00220"></a>00220 };
+<a name="l00221"></a>00221
+<a name="l00229"></a>00229 <a class="code" href="group__foundation.html#gfd8f8779793627061774cfcfa1b9fbd7">PX_DEPRECATED</a> <a class="code" href="group__common.html#g4636d12a5a01930fa258136f3f93366f">PX_PHYSX_CORE_API</a> <a class="code" href="classPxSpatialIndex.html" title="provides direct access to PhysX&amp;#39; Spatial Query engine">PxSpatialIndex</a>* <a class="code" href="group__physics.html#g4608473fcea7bec808f20e2e9ed4bbf1" title="Creates a spatial index.">PxCreateSpatialIndex</a>();
+<a name="l00230"></a>00230
+<a name="l00231"></a>00231 <span class="preprocessor">#if !PX_DOXYGEN</span>
+<a name="l00232"></a>00232 <span class="preprocessor"></span>} <span class="comment">// namespace physx</span>
+<a name="l00233"></a>00233 <span class="preprocessor">#endif</span>
+<a name="l00234"></a>00234 <span class="preprocessor"></span>
+<a name="l00236"></a>00236 <span class="preprocessor">#endif</span>
+</pre></div></div>
+
+<hr style="width: 100%; height: 2px;"><br>
+Copyright &copy; 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>