blob: a9a7e55264b7185e2ef1a738c3b619f8f0fdc95c (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxSpatialLocationCallback Struct 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>PxSpatialLocationCallback Struct Reference<br>
<small>
[<a class="el" href="group__physics.html">Physics</a>]</small>
</h1><!-- doxytag: class="PxSpatialLocationCallback" -->Callback class for raycast and sweep queries against <a class="el" href="classPxSpatialIndex.html" title="provides direct access to PhysX' Spatial Query engine">PxSpatialIndex</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxSpatialIndex_8h-source.html">PxSpatialIndex.h</a>></code>
<p>
<p>
<a href="structPxSpatialLocationCallback-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__scenequery.html#g4d0184965c0a910f5c96cb69c0690f5c">PxAgain</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxSpatialLocationCallback.html#869a311bedd23a07890d0d1d279eaab4">onHit</a> (<a class="el" href="classPxSpatialIndexItem.html">PxSpatialIndexItem</a> &item, PxReal distance, PxReal &shrunkDistance)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">callback method invoked when a sweep or raycast query hits an item in a <a class="el" href="classPxSpatialIndex.html" title="provides direct access to PhysX' Spatial Query engine">PxSpatialIndex</a> structure. <a href="#869a311bedd23a07890d0d1d279eaab4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxSpatialLocationCallback.html#b3b5df6caf441e46163273d340cb478a">~PxSpatialLocationCallback</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Callback class for raycast and sweep queries against <a class="el" href="classPxSpatialIndex.html" title="provides direct access to PhysX' Spatial Query engine">PxSpatialIndex</a>.
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000052">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="classPxSpatialIndex.html" title="provides direct access to PhysX' Spatial Query engine">PxSpatialIndex</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="b3b5df6caf441e46163273d340cb478a"></a><!-- doxytag: member="PxSpatialLocationCallback::~PxSpatialLocationCallback" ref="b3b5df6caf441e46163273d340cb478a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxSpatialLocationCallback::~PxSpatialLocationCallback </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="869a311bedd23a07890d0d1d279eaab4"></a><!-- doxytag: member="PxSpatialLocationCallback::onHit" ref="869a311bedd23a07890d0d1d279eaab4" args="(PxSpatialIndexItem &item, PxReal distance, PxReal &shrunkDistance)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__scenequery.html#g4d0184965c0a910f5c96cb69c0690f5c">PxAgain</a> PxSpatialLocationCallback::onHit </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">PxReal </td>
<td class="paramname"> <em>distance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PxReal & </td>
<td class="paramname"> <em>shrunkDistance</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>
callback method invoked when a sweep or raycast query hits an item in a <a class="el" href="classPxSpatialIndex.html" title="provides direct access to PhysX' Spatial Query engine">PxSpatialIndex</a> structure.
<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 that was hit. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>distance</em> </td><td>the current maximum distance of the query. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>shrunkDistance</em> </td><td>the updated maximum distance of the query. This must be no more than the current maximum distance.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the query should continue, false if it should stop</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__scenequery.html#g4d0184965c0a910f5c96cb69c0690f5c" title="Describes query behavior after returning a partial query result via a callback.">PxAgain</a> </dd></dl>
</div>
</div><p>
<hr>The documentation for this struct 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-2018 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>
|