PxBroadPhase.h
Go to the documentation of this file.
1 //
2 // Redistribution and use in source and binary forms, with or without
3 // modification, are permitted provided that the following conditions
4 // are met:
5 // * Redistributions of source code must retain the above copyright
6 // notice, this list of conditions and the following disclaimer.
7 // * Redistributions in binary form must reproduce the above copyright
8 // notice, this list of conditions and the following disclaimer in the
9 // documentation and/or other materials provided with the distribution.
10 // * Neither the name of NVIDIA CORPORATION nor the names of its
11 // contributors may be used to endorse or promote products derived
12 // from this software without specific prior written permission.
13 //
14 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
15 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
18 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22 // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 //
26 // Copyright (c) 2008-2018 NVIDIA Corporation. All rights reserved.
27 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
28 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
29 
30 
31 #ifndef PX_PHYSICS_BROAD_PHASE_H
32 #define PX_PHYSICS_BROAD_PHASE_H
33 
37 #include "PxPhysXConfig.h"
38 #include "foundation/PxBounds3.h"
39 
40 #if !PX_DOXYGEN
41 namespace physx
42 {
43 #endif
44 
45  class PxActor;
46 
67  {
68  enum Enum
69  {
70  eSAP,
71  eMBP,
72  eABP,
74 
75  eLAST
76  };
77  };
78 
97  {
98  public:
99  virtual ~PxBroadPhaseCallback() {}
100 
109  virtual void onObjectOutOfBounds(PxShape& shape, PxActor& actor) = 0;
110 
118  virtual void onObjectOutOfBounds(PxAggregate& aggregate) = 0;
119  };
120 
142  {
144  void* userData;
145  };
146 
151  {
155  bool active;
156  bool overlap;
157  };
158 
163  {
167  };
168 
169 #if !PX_DOXYGEN
170 } // namespace physx
171 #endif
172 
174 #endif
Definition: GuContactBuffer.h:37
Definition: PxBroadPhase.h:73
virtual ~PxBroadPhaseCallback()
Definition: PxBroadPhase.h:99
PxActor is the base class for the main simulation objects in the physics SDK.
Definition: PxActor.h:154
Abstract class for collision shapes.
Definition: PxShape.h:142
bool overlap
True if region overlaps other regions (regions that are just touching are not considering overlapping...
Definition: PxBroadPhase.h:156
3-axes sweep-and-prune
Definition: PxBroadPhase.h:70
"Region of interest" for the broad-phase.
Definition: PxBroadPhase.h:141
Broad phase algorithm used in the simulation.
Definition: PxBroadPhase.h:66
PxU32 nbStaticObjects
Number of static objects in the region.
Definition: PxBroadPhase.h:153
PxU32 nbDynamicObjects
Number of dynamic objects in the region.
Definition: PxBroadPhase.h:154
Information & stats structure for a region.
Definition: PxBroadPhase.h:150
Enum
Definition: PxBroadPhase.h:68
Class representing 3D range or axis aligned bounding box.
Definition: PxBounds3.h:58
PxBounds3 bounds
Region's bounds.
Definition: PxBroadPhase.h:143
bool active
True if region is currently used, i.e. it has not been removed.
Definition: PxBroadPhase.h:155
PxU32 maxNbRegions
Max number of regions supported by the broad-phase.
Definition: PxBroadPhase.h:164
bool needsPredefinedBounds
If true, broad-phase needs 'regions' to work.
Definition: PxBroadPhase.h:166
void * userData
Region's user-provided data.
Definition: PxBroadPhase.h:144
Class to aggregate actors into a single broad-phase entry.
Definition: PxAggregate.h:70
Caps class for broad phase.
Definition: PxBroadPhase.h:162
uint32_t PxU32
Definition: Px.h:48
Broad-phase callback to receive broad-phase related events.
Definition: PxBroadPhase.h:96
Multi box pruning.
Definition: PxBroadPhase.h:71
Automatic box pruning.
Definition: PxBroadPhase.h:72
PxBroadPhaseRegion region
User-provided region data.
Definition: PxBroadPhase.h:152
PxU32 maxNbObjects
Max number of objects supported by the broad-phase.
Definition: PxBroadPhase.h:165