iEmitState Struct Reference
This interface describes the API for the emitter mesh object. More...
#include <imesh/emit.h>
Inheritance diagram for iEmitState:

Public Member Functions | |
virtual void | AddAge (int time, const csColor &color, float alpha, float swirl, float rotspeed, float scale)=0 |
Add an aging moment, they are interpolated. | |
virtual int | GetAgingCount () const =0 |
Get the number of aging moments. | |
virtual void | GetAgingMoment (int i, int &time, csColor &color, float &alpha, float &swirl, float &rotspeed, float &scale)=0 |
get the settings of aging moment i (0..number-1) | |
virtual iEmitGen3D * | GetAttractorEmit () const =0 |
get the particle attrator emitter. Null means no attractor. | |
virtual float | GetAttractorForce () const =0 |
Get the force of the attractor. | |
virtual bool | GetContainerBox (csVector3 &min, csVector3 &max) const =0 |
Get container box, particles are only allowed inside this box. | |
virtual iEmitGen3D * | GetFieldAccelEmit () const =0 |
get field accel emitter, can be 0 | |
virtual iEmitGen3D * | GetFieldSpeedEmit () const =0 |
get field speed emitter, can be 0 | |
virtual bool | GetLighting () const =0 |
See if lighting is enabled. | |
virtual int | GetParticleCount () const =0 |
Get the number of particles used. | |
virtual int | GetParticleTime () const =0 |
Get the time to live for all particles, in msec. | |
virtual void | GetRectParticles (float &w, float &h) const =0 |
get the size of rect particles; | |
virtual void | GetRegularParticles (int &n, float &radius) const =0 |
Get the regular shaped particles sides and radius. | |
virtual iEmitGen3D * | GetStartAccelEmit () const =0 |
get the particle start acceleration emitter | |
virtual iEmitGen3D * | GetStartPosEmit () const =0 |
get the particle start position emitter | |
virtual iEmitGen3D * | GetStartSpeedEmit () const =0 |
get the particle start speed emitter | |
virtual void | RemoveAge (int time, const csColor &color, float alpha, float swirl, float rotspeed, float scale)=0 |
remove an aging moment | |
virtual void | ReplaceAge (int time, const csColor &color, float alpha, float swirl, float rotspeed, float scale)=0 |
replace the settings for the age at the timepoint given. | |
virtual void | SetAttractorEmit (iEmitGen3D *emit)=0 |
set the particle attrator emitter, increfs. Position is given. | |
virtual void | SetAttractorForce (float f)=0 |
Set the force of the attractor (negative gives repulsion). | |
virtual void | SetContainerBox (bool enabled, const csVector3 &min, const csVector3 &max)=0 |
Set container box, particles are only allowed inside this box. | |
virtual void | SetFieldAccelEmit (iEmitGen3D *emit)=0 |
Set the field accel emitter, increfs (given position determines accel). | |
virtual void | SetFieldSpeedEmit (iEmitGen3D *emit)=0 |
Set the field speed emitter, increfs (given position determines speed). | |
virtual void | SetLighting (bool l)=0 |
Enable or disable lighting. | |
virtual void | SetParticleCount (int num)=0 |
Set the number of particles to use. | |
virtual void | SetParticleTime (int ttl)=0 |
Set the time to live for all particles, in msec. | |
virtual void | SetRectParticles (float w, float h)=0 |
Set the particle system to use rectangular particles, given w, h. | |
virtual void | SetRegularParticles (int n, float radius)=0 |
Set the particle system to use regular shaped particles. | |
virtual void | SetStartAccelEmit (iEmitGen3D *emit)=0 |
set the particle start acceleration emitter, increfs. Position is given. | |
virtual void | SetStartPosEmit (iEmitGen3D *emit)=0 |
set the particle start position emitter, increfs | |
virtual void | SetStartSpeedEmit (iEmitGen3D *emit)=0 |
set the particle start speed emitter, increfs. The position is given. | |
virtual bool | UsingRectParticles () const =0 |
true if using rect particles. false if using regular particles. |
Detailed Description
This interface describes the API for the emitter mesh object.Main creators of instances implementing this interface:
- Emit mesh object plugin (crystalspace.mesh.object.emit)
- iMeshObjectFactory::NewInstance()
- Emit Loader plugin (crystalspace.mesh.loader.emit)
Definition at line 315 of file emit.h.
Member Function Documentation
|
Add an aging moment, they are interpolated. time is the time since creation of the particle in msec. color is a gouraud color to set the particle to. (0..1) alpha can be used to make the particles transparent. the value 0 is a solid particle, the value 1 is an invisible particle the swirl value gives a swirlyness of the movement of the particle. rotspeed is the rotationspeed of the particle (per second). scale is the size of the particle at the time |
|
Get the number of aging moments.
|
|
get the settings of aging moment i (0..number-1)
|
|
get the particle attrator emitter. Null means no attractor.
|
|
Get the force of the attractor.
|
|
Get container box, particles are only allowed inside this box. returns true if the container box is enabled. Objects outside this box are not drawn. But they are also not restarted, since that would cause many short-aged particles. |
|
get field accel emitter, can be 0
|
|
get field speed emitter, can be 0
|
|
See if lighting is enabled.
|
|
Get the number of particles used.
|
|
Get the time to live for all particles, in msec.
|
|
get the size of rect particles;
|
|
Get the regular shaped particles sides and radius.
|
|
get the particle start acceleration emitter
|
|
get the particle start position emitter
|
|
get the particle start speed emitter
|
|
remove an aging moment
|
|
replace the settings for the age at the timepoint given.
|
|
set the particle attrator emitter, increfs. Position is given.
|
|
Set the force of the attractor (negative gives repulsion).
|
|
Set container box, particles are only allowed inside this box.
|
|
Set the field accel emitter, increfs (given position determines accel).
|
|
Set the field speed emitter, increfs (given position determines speed).
|
|
Enable or disable lighting.
|
|
Set the number of particles to use.
|
|
Set the time to live for all particles, in msec.
|
|
Set the particle system to use rectangular particles, given w, h.
|
|
Set the particle system to use regular shaped particles.
|
|
set the particle start acceleration emitter, increfs. Position is given.
|
|
set the particle start position emitter, increfs
|
|
set the particle start speed emitter, increfs. The position is given.
|
|
true if using rect particles. false if using regular particles.
|
The documentation for this struct was generated from the following file:
- imesh/emit.h
Generated for Crystal Space by doxygen 1.4.4