PxParticleCreationData Class Reference
[particles (deprecated)]

Descriptor-like user-side class describing buffers for particle creation. (deprecated). More...

#include <PxParticleCreationData.h>

Collaboration diagram for PxParticleCreationData:

[legend]

List of all members.

Public Member Functions
PX_INLINE void	setToDefault ()
	(Re)sets the structure to the default.
PX_INLINE bool	isValid () const
	Returns true if the current settings are valid.
PX_INLINE	PxParticleCreationData ()
	Constructor sets to default.
Public Attributes
PxU32	numParticles
	The number of particles stored in the buffer.
PxStrideIterator< const PxU32 >	indexBuffer
	Particle index data.
PxStrideIterator< const PxVec3 >	positionBuffer
	Particle position data.
PxStrideIterator< const PxVec3 >	velocityBuffer
	Particle velocity data.
PxStrideIterator< const PxF32 >	restOffsetBuffer
	Particle rest offset data.
PxStrideIterator< const PxU32 >	flagBuffer
	Particle flags.

---

Detailed Description

Descriptor-like user-side class describing buffers for particle creation. (deprecated).

PxParticleCreationData is used to create particles within the SDK. The SDK copies the particle data referenced by PxParticleCreationData, it may therefore be deallocated right after the creation call returned.

Deprecated:

The PhysX particle feature has been deprecated in PhysX version 3.4

See also:

PxParticleBase::createParticles()

---

Member Data Documentation

PxStrideIterator<const PxU32> PxParticleCreationData::flagBuffer

Particle flags.

PxParticleFlag.eVALID, PxParticleFlag.eCOLLISION_WITH_STATIC, PxParticleFlag.eCOLLISION_WITH_DYNAMIC, PxParticleFlag.eCOLLISION_WITH_DRAIN, PxParticleFlag.eSPATIAL_DATA_STRUCTURE_OVERFLOW are all flags that can't be set on particle creation. They are written by the SDK exclusively.

Providing flag data is optional.

See also:

PxParticleFlag

Referenced by PxParticleCreationData().

PxStrideIterator<const PxU32> PxParticleCreationData::indexBuffer

Particle index data.

When creating particles, providing the particle indices is mandatory.

Referenced by isValid(), and PxParticleCreationData().

PxU32 PxParticleCreationData::numParticles

The number of particles stored in the buffer.

Referenced by isValid().

PxStrideIterator<const PxVec3> PxParticleCreationData::positionBuffer

Particle position data.

When creating particles, providing the particle positions is mandatory.

Referenced by isValid(), and PxParticleCreationData().

PxStrideIterator<const PxF32> PxParticleCreationData::restOffsetBuffer

Particle rest offset data.

Values need to be in the range [0.0f, restOffset]. If PxParticleBaseFlag.ePER_PARTICLE_REST_OFFSET is set, providing per particle rest offset data is mandatory.

See also:

PxParticleBaseFlag.ePER_PARTICLE_REST_OFFSET.

Referenced by PxParticleCreationData().

PxStrideIterator<const PxVec3> PxParticleCreationData::velocityBuffer

Particle velocity data.

Providing velocity data is optional.

Referenced by PxParticleCreationData().

---

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

• PxParticleCreationData.h