VisualEffect

Inherited: None

Description

VisualEffect alows developer to create a complex visual effects.

Public Methods

AABBox	bound () const
int	capacity () const
bool	continous () const
bool	gpu () const
Material *	material () const
Mesh *	mesh () const
int	particleStride () const
int	renderableStride () const
void	setCapacity (int capacity)
void	setContinous (bool continuous)
void	setGpu (bool gpu)
void	setLocal (bool local)
void	setMaterial (Material * material)
void	setMesh (Mesh * mesh)
void	setSpawnRate (float rate)
float	spawnRate () const

Static Methods

None

Methods Description

AABBox VisualEffect::bound () const

Returns bounding box for the emitter.

---

int VisualEffect::capacity () const

Returns a maximum number of particles to emit.

See also setCapacity().

---

bool VisualEffect::continous () const

Returns true for continuous emission, false for one time emission.

See also setContinous().

---

bool VisualEffect::gpu () const

Returns true if GPU particle simulation is enabled, false otherwise.

Note: Gpu simulation is not supported yet.

See also setGpu().

---

Material * VisualEffect::material () const

Returns a material associated with the particle emitter.

See also setMaterial().

---

Mesh * VisualEffect::mesh () const

Returns a mesh associated with the particle emitter.

See also setMesh().

---

int VisualEffect::particleStride () const

Return a size for particle atribute structure.

---

int VisualEffect::renderableStride () const

Return a size for particle atribute structure.

---

void VisualEffect::setCapacity (int capacity)

Sets a maximum capacity of particles to emit.

See also *capacity*().

---

void VisualEffect::setContinous (bool continuous)

Setter for the continuous flag indicating continuous particle emission.

See also continous().

---

void VisualEffect::setGpu (bool gpu)

Setter for the gpu flag indicating GPU particle simulation.

Note: Gpu simulation is not supported yet.

See also *gpu*().

---

void VisualEffect::setLocal (bool local)

Setter for the local flag indicating local particle space.

---

void VisualEffect::setMaterial (Material * material)

Sets a material associated with the particle emitter.

See also *material*().

---

void VisualEffect::setMesh (Mesh * mesh)

Sets a mesh associated with the particle emitter.

See also *mesh*().

---

void VisualEffect::setSpawnRate (float rate)

Sets spawn rate factor of emitted particles.

See also spawnRate().

---

float VisualEffect::spawnRate () const

Returns a distribution factor of emitted particles.

See also setSpawnRate().