RavEngine
Loading...
Searching...
No Matches
physx::Sq::PruningStructure Class Reference
Inheritance diagram for physx::Sq::PruningStructure:
[legend]
Collaboration diagram for physx::Sq::PruningStructure:
[legend]

Public Member Functions

 PruningStructure (PxBaseFlags baseFlags)
 
virtual void resolveReferences (PxDeserializationContext &)
 
void preExportDataReset ()
 
void exportExtraData (PxSerializationContext &)
 
void importExtraData (PxDeserializationContext &)
 
virtual void requiresObjects (PxProcessPxBaseCallback &)
 
virtual void release ()
 Release this object.
 
virtual PxU32 getRigidActors (PxRigidActor **userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const
 Retrieve rigid actors in the pruning structure.
 
virtual PxU32 getNbRigidActors () const
 Returns the number of rigid actors in the pruning structure.
 
virtual const void * getStaticMergeData () const
 Gets the merge data for static actors.
 
virtual const void * getDynamicMergeData () const
 Gets the merge data for dynamic actors.
 
bool build (PxRigidActor *const *actors, PxU32 nbActors)
 
PX_FORCE_INLINE PxU32 getNbActors () const
 
PX_FORCE_INLINE PxActor *const * getActors () const
 
PX_FORCE_INLINE bool isValid () const
 
void invalidate (PxActor *actor)
 
- Public Member Functions inherited from physx::PxPruningStructure
virtual const char * getConcreteTypeName () const
 Returns string name of dynamic type.
 
- Public Member Functions inherited from physx::PxBase
template<class T >
T * is ()
 
template<class T >
const T * is () const
 
PX_FORCE_INLINE PxType getConcreteType () const
 Returns concrete type of object.
 
PX_FORCE_INLINE void setBaseFlag (PxBaseFlag::Enum flag, bool value)
 Set PxBaseFlag

 
PX_FORCE_INLINE void setBaseFlags (PxBaseFlags inFlags)
 Set PxBaseFlags

 
PX_FORCE_INLINE PxBaseFlags getBaseFlags () const
 Returns PxBaseFlags.
 
virtual bool isReleasable () const
 Whether the object is subordinate.
 
- Public Member Functions inherited from physx::PxUserAllocated
PX_INLINE void * operator new (size_t, void *address)
 
PX_INLINE void operator delete (void *, void *)
 
template<typename Alloc >
PX_INLINE void * operator new (size_t size, Alloc alloc, const char *fileName, int line)
 
template<typename Alloc >
PX_INLINE void * operator new (size_t size, size_t, Alloc alloc, const char *fileName, int line)
 
template<typename Alloc >
PX_INLINE void * operator new[] (size_t size, Alloc alloc, const char *fileName, int line)
 
template<typename Alloc >
PX_INLINE void * operator new[] (size_t size, size_t, Alloc alloc, const char *fileName, int line)
 
template<typename Alloc >
PX_INLINE void operator delete (void *ptr, Alloc alloc, const char *fileName, int line)
 
template<typename Alloc >
PX_INLINE void operator delete[] (void *ptr, Alloc alloc, const char *fileName, int line)
 
PX_INLINE void operator delete (void *ptr)
 
PX_INLINE void operator delete[] (void *ptr)
 

Static Public Member Functions

static PruningStructure * createObject (PxU8 *&address, PxDeserializationContext &context)
 
static void getBinaryMetaData (PxOutputStream &stream)
 

Additional Inherited Members

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

Member Function Documentation

◆ getDynamicMergeData()

const void * PruningStructure::getDynamicMergeData ( ) const
virtual

Gets the merge data for dynamic actors.

This is mainly called by the PxSceneQuerySystem::merge() function to merge a PxPruningStructure with the internal data-structures of the scene-query system.

Returns
Implementation-dependent merge data for dynamic actors.
See also
PxSceneQuerySystem::merge()

Implements physx::PxPruningStructure.

◆ getNbRigidActors()

PxU32 PruningStructure::getNbRigidActors ( ) const
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

Implements physx::PxPruningStructure.

◆ getRigidActors()

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

Retrieve rigid actors in the pruning structure.

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

Parameters
[out]userBufferThe buffer to store the actor pointers.
[in]bufferSizeSize of provided user buffer.
[in]startIndexIndex of first actor pointer to be retrieved
Returns
Number of rigid actor pointers written to the buffer.
See also
PxRigidActor

Implements physx::PxPruningStructure.

◆ getStaticMergeData()

const void * PruningStructure::getStaticMergeData ( ) const
virtual

Gets the merge data for static actors.

This is mainly called by the PxSceneQuerySystem::merge() function to merge a PxPruningStructure with the internal data-structures of the scene-query system.

Returns
Implementation-dependent merge data for static actors.
See also
PxSceneQuerySystem::merge()

Implements physx::PxPruningStructure.

◆ release()

void PruningStructure::release ( )
virtual

Release this object.

Implements physx::PxPruningStructure.


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