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
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBroadPhaseRegion 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>PxBroadPhaseRegion Struct Reference<br>
<small>
[<a class="el" href="group__physics.html">Physics</a>]</small>
</h1><!-- doxytag: class="PxBroadPhaseRegion" -->"Region of interest" for the broad-phase.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxBroadPhase_8h-source.html">PxBroadPhase.h</a>></code>
<p>
<div class="dynheader">
Collaboration diagram for PxBroadPhaseRegion:</div>
<div class="dynsection">
<p><center><img src="structPxBroadPhaseRegion__coll__graph.png" border="0" usemap="#PxBroadPhaseRegion__coll__map" alt="Collaboration graph"></center>
<map name="PxBroadPhaseRegion__coll__map">
<area shape="rect" href="classPxBounds3.html" title="Class representing 3D range or axis aligned bounding box." alt="PxBounds3" coords="37,123,115,144"><area shape="rect" href="classPxVec3.html" title="3 Element vector class." alt="PxVec3" coords="49,16,103,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structPxBroadPhaseRegion-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 Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxBounds3.html">PxBounds3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBroadPhaseRegion.html#e13e89ca861565e52680e073da3e4043">bounds</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Region's bounds. <a href="#e13e89ca861565e52680e073da3e4043"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBroadPhaseRegion.html#71ea61caf0560a874bd7fb53cea525b4">userData</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Region's user-provided data. <a href="#71ea61caf0560a874bd7fb53cea525b4"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
"Region of interest" for the broad-phase.
<p>
This is currently only used for the <a class="el" href="structPxBroadPhaseType.html#c7422f895533bff02d0043d35a2b7ddabe0a5c309436a84e58c227c548fa17da" title="Multi box pruning.">PxBroadPhaseType::eMBP</a> broad-phase, which requires zones or regions to be defined when the simulation starts in order to work. Regions can overlap and be added or removed at runtime, but at least one region needs to be defined when the scene is created.<p>
If objects that do no overlap any region are inserted into the scene, they will not be added to the broad-phase and thus collisions will be disabled for them. A <a class="el" href="classPxBroadPhaseCallback.html" title="Broad-phase callback to receive broad-phase related events.">PxBroadPhaseCallback</a> out-of-bounds notification will be sent for each one of those objects.<p>
The total number of regions is limited by <a class="el" href="structPxBroadPhaseCaps.html#eff3784c87ac5de06aa45e086724df23" title="Max number of regions supported by the broad-phase.">PxBroadPhaseCaps::maxNbRegions</a>.<p>
The number of regions has a direct impact on performance and memory usage, so it is recommended to experiment with various settings to find the best combination for your game. A good default setup is to start with global bounds around the whole world, and subdivide these bounds into 4*4 regions. The <a class="el" href="classPxBroadPhaseExt.html#24301db187094029361f8d63fda7c274" title="Creates regions for PxSceneDesc, from a global box.">PxBroadPhaseExt::createRegionsFromWorldBounds</a> function can do that for you.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBroadPhaseCallback.html" title="Broad-phase callback to receive broad-phase related events.">PxBroadPhaseCallback</a> <a class="el" href="classPxBroadPhaseExt.html#24301db187094029361f8d63fda7c274" title="Creates regions for PxSceneDesc, from a global box.">PxBroadPhaseExt.createRegionsFromWorldBounds</a> </dd></dl>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="e13e89ca861565e52680e073da3e4043"></a><!-- doxytag: member="PxBroadPhaseRegion::bounds" ref="e13e89ca861565e52680e073da3e4043" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPxBounds3.html">PxBounds3</a> <a class="el" href="structPxBroadPhaseRegion.html#e13e89ca861565e52680e073da3e4043">PxBroadPhaseRegion::bounds</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Region's bounds.
<p>
</div>
</div><p>
<a class="anchor" name="71ea61caf0560a874bd7fb53cea525b4"></a><!-- doxytag: member="PxBroadPhaseRegion::userData" ref="71ea61caf0560a874bd7fb53cea525b4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="structPxBroadPhaseRegion.html#71ea61caf0560a874bd7fb53cea525b4">PxBroadPhaseRegion::userData</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Region's user-provided data.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="PxBroadPhase_8h-source.html">PxBroadPhase.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>
|