PxPruningStructure Class Reference

A precomputed pruning structure to accelerate scene queries against newly added actors. More...

#include <PxPruningStructure.h>

Inheritance diagram for PxPruningStructure:

Collaboration diagram for PxPruningStructure:

Public Member Functions
virtual void	release ()=0
	Release this object. More...
virtual PxU32	getRigidActors (PxRigidActor **userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const =0
	Retrieve rigid actors in the pruning structure. More...
virtual PxU32	getNbRigidActors () const =0
	Returns the number of rigid actors in the pruning structure. More...
virtual const char *	getConcreteTypeName () const
	Returns string name of dynamic type. More...
Public Member Functions inherited from PxBase
template<class T >
T *	is ()
template<class T >
const T *	is () const
PX_FORCE_INLINE PxType	getConcreteType () const
	Returns concrete type of object. More...
PX_FORCE_INLINE void	setBaseFlag (PxBaseFlag::Enum flag, bool value)
	Set PxBaseFlag. More...
PX_FORCE_INLINE void	setBaseFlags (PxBaseFlags inFlags)
	Set PxBaseFlags. More...
PX_FORCE_INLINE PxBaseFlags	getBaseFlags () const
	Returns PxBaseFlags. More...
virtual bool	isReleasable () const
	Whether the object is subordinate. More...

Protected Member Functions
PX_INLINE	PxPruningStructure (PxType concreteType, PxBaseFlags baseFlags)
PX_INLINE	PxPruningStructure (PxBaseFlags baseFlags)
virtual	~PxPruningStructure ()
virtual bool	isKindOf (const char *name) const
	Returns whether a given type name matches with the type of this instance. More...
Protected Member Functions inherited from PxBase
PX_INLINE	PxBase (PxType concreteType, PxBaseFlags baseFlags)
	Constructor setting concrete type and base flags. More...
PX_INLINE	PxBase (PxBaseFlags baseFlags)
	Deserialization constructor setting base flags. More...
virtual	~PxBase ()
	Destructor. More...
template<class T >
bool	typeMatch () const

Additional Inherited Members
Protected Attributes inherited from PxBase
PxType	mConcreteType
PxBaseFlags	mBaseFlags

Detailed Description

A precomputed pruning structure to accelerate scene queries against newly added actors.

The pruning structure can be provided to PxScene:: addActors() in which case it will get merged directly into the scene query optimization AABB tree, thus leading to improved performance when doing queries against the newly added actors. This applies to both static and dynamic actors.

Note

PxPruningStructure objects can be added to a collection and get serialized.

Adding a PxPruningStructure object to a collection will also add the actors that were used to build the pruning structure.

PxPruningStructure must be released before its rigid actors.

PxRigidBody objects can be in one PxPruningStructure only.

Changing the bounds of PxRigidBody objects assigned to a pruning structure that has not been added to a scene yet will invalidate the pruning structure. Same happens if shape scene query flags change or shape gets removed from an actor.

See also

PxScene::addActors PxCollection

Constructor & Destructor Documentation

PxPruningStructure() [1/2]

PX_INLINE PxPruningStructure::PxPruningStructure ( PxType  concreteType, PxBaseFlags  baseFlags  )

inlineprotected

PxPruningStructure() [2/2]

PX_INLINE PxPruningStructure::PxPruningStructure ( PxBaseFlags  baseFlags )

inlineprotected

~PxPruningStructure()

virtual PxPruningStructure::~PxPruningStructure ( )

inlineprotectedvirtual

Member Function Documentation

getConcreteTypeName()

virtual const char* PxPruningStructure::getConcreteTypeName ( ) const

inlinevirtual

Returns string name of dynamic type.

Returns

Class name of most derived type of this object.

Implements PxBase.

getNbRigidActors()

virtual PxU32 PxPruningStructure::getNbRigidActors ( ) const

pure virtual

Returns the number of rigid actors in the pruning structure.

You can use getRigidActors() to retrieve the rigid actor pointers.

Returns

Number of rigid actors in the pruning structure.

See also

PxRigidActor

getRigidActors()

virtual PxU32 PxPruningStructure::getRigidActors ( PxRigidActor **  userBuffer, PxU32  bufferSize, PxU32  startIndex = 0  ) const

pure virtual

Retrieve rigid actors in the pruning structure.

You can retrieve the number of rigid actor pointers by calling getNbRigidActors()

Parameters

[out]	userBuffer	The buffer to store the actor pointers.
[in]	bufferSize	Size of provided user buffer.
[in]	startIndex	Index of first actor pointer to be retrieved

Returns

Number of rigid actor pointers written to the buffer.

See also

PxRigidActor

isKindOf()

virtual bool PxPruningStructure::isKindOf ( const char *  superClass ) const

inlineprotectedvirtual

Returns whether a given type name matches with the type of this instance.

Reimplemented from PxBase.

References PxBase::isKindOf().

release()

virtual void PxPruningStructure::release ( )

pure virtual

Release this object.

Implements PxBase.

---

The documentation for this class was generated from the following file:

• PxPruningStructure.h