PxAggregate.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-2021 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_NX_AGGREGATE
32 #define PX_PHYSICS_NX_AGGREGATE
33 
38 #include "PxPhysXConfig.h"
39 #include "common/PxBase.h"
40 
41 
42 #if !PX_DOXYGEN
43 namespace physx
44 {
45 #endif
46 
47 class PxActor;
48 class PxBVHStructure;
49 
70 class PxAggregate : public PxBase
71 {
72 public:
73 
82  virtual void release() = 0;
83 
105  virtual bool addActor(PxActor& actor, const PxBVHStructure* bvhStructure = NULL) = 0;
106 
118  virtual bool removeActor(PxActor& actor) = 0;
119 
134  virtual bool addArticulation(PxArticulationBase& articulation) = 0;
135 
147  virtual bool removeArticulation(PxArticulationBase& articulation) = 0;
148 
158  virtual PxU32 getNbActors() const = 0;
159 
167  virtual PxU32 getMaxNbActors() const = 0;
168 
181  virtual PxU32 getActors(PxActor** userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const = 0;
182 
190  virtual PxScene* getScene() = 0;
191 
197  virtual bool getSelfCollision() const = 0;
198 
199  virtual const char* getConcreteTypeName() const { return "PxAggregate"; }
200 
201 protected:
202  PX_INLINE PxAggregate(PxType concreteType, PxBaseFlags baseFlags) : PxBase(concreteType, baseFlags) {}
203  PX_INLINE PxAggregate(PxBaseFlags baseFlags) : PxBase(baseFlags) {}
204  virtual ~PxAggregate() {}
205  virtual bool isKindOf(const char* name) const { return !::strcmp("PxAggregate", name) || PxBase::isKindOf(name); }
206 };
207 
208 #if !PX_DOXYGEN
209 } // namespace physx
210 #endif
211 
213 #endif
Definition: GuContactBuffer.h:37
A scene is a collection of bodies and constraints which can interact.
Definition: PxScene.h:169
PxActor is the base class for the main simulation objects in the physics SDK.
Definition: PxActor.h:154
virtual bool isKindOf(const char *superClass) const
Returns whether a given type name matches with the type of this instance.
Definition: PxBase.h:178
virtual const char * getConcreteTypeName() const
Returns string name of dynamic type.
Definition: PxAggregate.h:199
PxU16 PxType
Definition: PxBase.h:49
virtual ~PxAggregate()
Definition: PxAggregate.h:204
PX_INLINE PxAggregate(PxBaseFlags baseFlags)
Definition: PxAggregate.h:203
virtual bool isKindOf(const char *name) const
Returns whether a given type name matches with the type of this instance.
Definition: PxAggregate.h:205
a tree structure of bodies connected by joints that is treated as a unit by the dynamics solver ...
Definition: PxArticulationBase.h:56
Class to aggregate actors into a single broad-phase entry.
Definition: PxAggregate.h:70
uint32_t PxU32
Definition: Px.h:48
Class representing the bounding volume hierarchy structure.
Definition: PxBVHStructure.h:57
Base class for objects that can be members of a PxCollection.
Definition: PxBase.h:73
#define PX_INLINE
Definition: PxPreprocessor.h:336
PX_INLINE PxAggregate(PxType concreteType, PxBaseFlags baseFlags)
Definition: PxAggregate.h:202