RavEngine
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
physx::PxParticleRigidBuffer Class Referenceabstract

A particle buffer used to simulate rigid bodies using shape matching with particles. More...

#include <PxParticleBuffer.h>

Inheritance diagram for physx::PxParticleRigidBuffer:
[legend]
Collaboration diagram for physx::PxParticleRigidBuffer:
[legend]

Public Member Functions

virtual PxU32 * getRigidOffsets () const =0
 Get the particle indices of the first particle for each shape matched rigid body.
 
virtual PxReal * getRigidCoefficients () const =0
 Get the stiffness coefficients for all shape matched rigid bodies in this buffer.
 
virtual PxVec4 * getRigidLocalPositions () const =0
 Get the local position of each particle relative to the rigid body's center of mass.
 
virtual PxVec4 * getRigidTranslations () const =0
 Get the world-space translations for all rigid bodies in this buffer.
 
virtual PxVec4 * getRigidRotations () const =0
 Get the world-space rotation of every shape-matched rigid body in this buffer.
 
virtual PxVec4 * getRigidLocalNormals () const =0
 Get the local space normals for each particle relative to the shape of the corresponding rigid body.
 
virtual void setNbRigids (PxU32 nbRigids)=0
 Set the number of shape matched rigid bodies in this buffer.
 
virtual PxU32 getNbRigids () const =0
 Get the number of shape matched rigid bodies in this buffer.
 
- Public Member Functions inherited from physx::PxParticleBuffer
virtual PxVec4 * getPositionInvMasses () const =0
 Get positions and inverse masses for this particle buffer.
 
virtual PxVec4 * getVelocities () const =0
 Get velocities for this particle buffer.
 
virtual PxU32 * getPhases () const =0
 Get phases for this particle buffer.
 
virtual PxParticleVolume * getParticleVolumes () const =0
 Get particle volumes for this particle buffer.
 
virtual void setNbActiveParticles (PxU32 nbActiveParticles)=0
 Set the number of active particles for this particle buffer.
 
virtual PxU32 getNbActiveParticles () const =0
 Get the number of active particles for this particle buffer.
 
virtual PxU32 getMaxParticles () const =0
 Get the maximum number particles this particle buffer can hold.
 
virtual PxU32 getNbParticleVolumes () const =0
 Get the number of particle volumes in this particle buffer.
 
virtual void setNbParticleVolumes (PxU32 nbParticleVolumes)=0
 Set the number of #PxParticleVolume s for this particle buffer.
 
virtual PxU32 getMaxParticleVolumes () const =0
 Get the maximum number of particle volumes this particle buffer can hold.
 
virtual void setRigidFilters (PxParticleRigidFilterPair *filters, PxU32 nbFilters)=0
 Set the #PxParticleRigidFilterPair s for collision filtering of particles in this buffer with rigid bodies.
 
virtual void setRigidAttachments (PxParticleRigidAttachment *attachments, PxU32 nbAttachments)=0
 Set the particle-rigid body attachments for particles in this particle buffer.
 
virtual PxU32 getFlatListStartIndex () const =0
 Get the start index for the first particle of this particle buffer in the complete list of particles of the particle system this buffer is used in.
 
virtual void raiseFlags (PxParticleBufferFlag::Enum flags)=0
 Raise dirty flags on this particle buffer to communicate that the corresponding data has been updated by the user.
 
virtual void release ()=0
 Release this buffer and deallocate all the memory.
 
virtual void onParticleSystemDestroy ()=0
 Cleanup helper used in case a particle system is released before the particle buffers have been removed.
 
virtual void setInternalData (void *data)=0
 Reserved for internal use.
 
- Public Member Functions inherited from physx::PxBase
virtual const char * getConcreteTypeName () const =0
 Returns string name of dynamic type.
 
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.
 

Protected Member Functions

PX_INLINE PxParticleRigidBuffer (PxU32 uniqueId)
 
- Protected Member Functions inherited from physx::PxParticleBuffer
PX_INLINE PxParticleBuffer (PxU32 uniqueId)
 
PX_INLINE PxParticleBuffer (PxU32 uniqueId, PxType type)
 
- 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.
 
virtual bool isKindOf (const char *superClass) const
 Returns whether a given type name matches with the type of this instance.
 
template<class T >
bool typeMatch () const
 

Additional Inherited Members

- Public Attributes inherited from physx::PxParticleBuffer
PxU32 bufferIndex
 Index of this buffer in the particle system it is assigned to.
 
const PxU32 bufferUniqueId
 Unique index that does not change over the lifetime of a PxParticleBuffer.
 
- Protected Attributes inherited from physx::PxBase
PxType mConcreteType
 
PxBaseFlags mBaseFlags
 
PxU32 mBuiltInRefCount
 

Detailed Description

A particle buffer used to simulate rigid bodies using shape matching with particles.

See PxPhysics::createParticleRigidBuffer.

Member Function Documentation

◆ getNbRigids()

virtual PxU32 physx::PxParticleRigidBuffer::getNbRigids ( ) const
pure virtual

Get the number of shape matched rigid bodies in this buffer.

Returns
The number of shape matched rigid bodies in this buffer.

◆ getRigidCoefficients()

virtual PxReal * physx::PxParticleRigidBuffer::getRigidCoefficients ( ) const
pure virtual

Get the stiffness coefficients for all shape matched rigid bodies in this buffer.

Stiffness must be in the range [0, 1].

Returns
A device buffer containing the list of stiffness coefficients for each rigid body.

◆ getRigidLocalNormals()

virtual PxVec4 * physx::PxParticleRigidBuffer::getRigidLocalNormals ( ) const
pure virtual

Get the local space normals for each particle relative to the shape of the corresponding rigid body.

The 4th component of every PxVec4 should be the negative signed distance of the particle inside its shape.

Returns
A pointer to a device buffer containing the local-space normals for each particle.

◆ getRigidLocalPositions()

virtual PxVec4 * physx::PxParticleRigidBuffer::getRigidLocalPositions ( ) const
pure virtual

Get the local position of each particle relative to the rigid body's center of mass.

Returns
A pointer to a device buffer containing the local position for each particle.

◆ getRigidOffsets()

virtual PxU32 * physx::PxParticleRigidBuffer::getRigidOffsets ( ) const
pure virtual

Get the particle indices of the first particle for each shape matched rigid body.

Returns
A device buffer containing the list of particle start indices of each shape matched rigid body.

◆ getRigidRotations()

virtual PxVec4 * physx::PxParticleRigidBuffer::getRigidRotations ( ) const
pure virtual

Get the world-space rotation of every shape-matched rigid body in this buffer.

Rotations are specified as quaternions.

Returns
A pointer to a device buffer containing the world-space rotation for every shape-matched rigid body in this buffer.

◆ getRigidTranslations()

virtual PxVec4 * physx::PxParticleRigidBuffer::getRigidTranslations ( ) const
pure virtual

Get the world-space translations for all rigid bodies in this buffer.

Returns
A pointer to a device buffer containing the world-space translations for all shape-matched rigid bodies in this buffer.

◆ setNbRigids()

virtual void physx::PxParticleRigidBuffer::setNbRigids ( PxU32  nbRigids)
pure virtual

Set the number of shape matched rigid bodies in this buffer.

Parameters
[in]nbRigidsThe number of shape matched rigid bodies
The documentation for this class was generated from the following file: