RavEngine
Loading...
Searching...
No Matches
physx::PxParticleClothBuffer Class Referenceabstract

A particle buffer used to simulate particle cloth. More...

#include <PxParticleBuffer.h>

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

Public Member Functions

virtual PxVec4 * getRestPositions ()=0
 Get rest positions for this particle buffer.
 
virtual PxU32 * getTriangles () const =0
 Get the triangle indices for this particle buffer.
 
virtual void setNbTriangles (PxU32 nbTriangles)=0
 Set the number of triangles for this particle buffer.
 
virtual PxU32 getNbTriangles () const =0
 Get the number of triangles for this particle buffer.
 
virtual PxU32 getNbSprings () const =0
 Get the number of springs in this particle buffer.
 
virtual PxParticleSpring * getSprings ()=0
 Get the springs for this particle buffer.
 
virtual void setCloths (PxPartitionedParticleCloth &cloths)=0
 Set cloths for this particle 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 PxParticleClothBuffer (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 particle cloth.

See PxPhysics::createParticleClothBuffer.

Member Function Documentation

◆ getNbSprings()

virtual PxU32 physx::PxParticleClothBuffer::getNbSprings ( ) const
pure virtual

Get the number of springs in this particle buffer.

Returns
The number of springs in this cloth buffer.

◆ getNbTriangles()

virtual PxU32 physx::PxParticleClothBuffer::getNbTriangles ( ) const
pure virtual

Get the number of triangles for this particle buffer.

Returns
The number triangles for this cloth buffer.

◆ getRestPositions()

virtual PxVec4 * physx::PxParticleClothBuffer::getRestPositions ( )
pure virtual

Get rest positions for this particle buffer.

Returns
A pointer to a device buffer containing the rest positions packed as PxVec4(pos.x, pos.y, pos.z, 0.0f).

◆ getSprings()

virtual PxParticleSpring * physx::PxParticleClothBuffer::getSprings ( )
pure virtual

Get the springs for this particle buffer.

Returns
A pointer to a device buffer containing the springs for this cloth buffer.

◆ getTriangles()

virtual PxU32 * physx::PxParticleClothBuffer::getTriangles ( ) const
pure virtual

Get the triangle indices for this particle buffer.

Returns
A pointer to a device buffer containing the triangle indices for this cloth buffer.

◆ setCloths()

virtual void physx::PxParticleClothBuffer::setCloths ( PxPartitionedParticleCloth &  cloths)
pure virtual

Set cloths for this particle buffer.

Parameters
[in]clothsA pointer to a PxPartitionedParticleCloth.

See #PxPartitionedParticleCloth, #PxParticleClothPreProcessor

◆ setNbTriangles()

virtual void physx::PxParticleClothBuffer::setNbTriangles ( PxU32  nbTriangles)
pure virtual

Set the number of triangles for this particle buffer.

Parameters
[in]nbTrianglesThe number of triangles for this particle cloth buffer.

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