ParticleEmitter

Inherited: None

Description

The ParticleEmitter class encapsulates various parameters and settings for controlling the appearance and behavior of particles emitted by a particle system. Users can customize these settings, such as associating a mesh and material, defining distribution factors, enabling GPU simulation, setting local or world space, specifying continuous or discrete emission, and applying particle modifiers.

Public Methods

bool

continous () const

float

distribution () const

bool

gpu () const

Material *

material () const

Mesh *

mesh () const

ModifiersDeque &

modifiers ()

void

setContinous (bool continuous)

void

setDistribution (float distribution)

void

setGpu (bool gpu)

void

setLocal (bool local)

void

setMaterial (Material * material)

void

setMesh (Mesh * mesh)

void

setModifiers (const ModifiersDeque & modifiers)

bool

operator== (const ParticleEmitter & emitter) const

Static Methods

None

Methods Description

bool ParticleEmitter::continous () const

Getter for the continuous flag indicating continuous particle emission. Returns true for continuous emission, false for one time emission.

See also setContinous().


float ParticleEmitter::distribution () const

Getter for the distribution factor of emitted particles.

See also setDistribution().


bool ParticleEmitter::gpu () const

Getter for the GPU flag indicating GPU particle simulation. Returns true if GPU particle simulation is enabled, false otherwise.

Note: Gpu simulation is not supported yet.

See also setGpu().


:ref:`Material<api_Material>`* ParticleEmitter::material () const

Getter for the material associated with the particle emitter.

See also setMaterial().


:ref:`Mesh<api_Mesh>`* ParticleEmitter::mesh () const

Getter for the mesh associated with the particle emitter.

See also setMesh().


:ref:`ModifiersDeque<api_ModifiersDeque>`& ParticleEmitter::modifiers ()

Getter for the deque of particle modifiers.

See also setModifiers().


void ParticleEmitter::setContinous (bool continuous)

Setter for the continuous flag indicating continuous particle emission.

See also continous().


void ParticleEmitter::setDistribution (float distribution)

Setter for the distribution factor of emitted particles.

See also *distribution*().


void ParticleEmitter::setGpu (bool gpu)

Setter for the gpu flag indicating GPU particle simulation.

Note: Gpu simulation is not supported yet.

See also *gpu*().


void ParticleEmitter::setLocal (bool local)

Setter for the local flag indicating local particle space.


void ParticleEmitter::setMaterial (Material * material)

Setter for the material associated with the particle emitter.

See also *material*().


void ParticleEmitter::setMesh (Mesh * mesh)

Setter for the mesh associated with the particle emitter.

See also *mesh*().


void ParticleEmitter::setModifiers (ModifiersDeque & modifiers)

Setter for the deque of particle modifiers.

See also *modifiers*().


bool ParticleEmitter::operator== (ParticleEmitter & emitter) const

Equality operator for comparing two particle emitter objects. Returns true if the *emitter*s are equal, false otherwise.