Public Methods |
| RingEmitter () |
void | _initParticle (Particle *pParticle) |
| See ParticleEmitter. More...
|
void | setInnerSize (Real x, Real y) |
| Sets the size of the clear space inside the area from where NO particles are emitted. More...
|
void | setInnerSizeX (Real x) |
| Sets the x component of the area inside the ellipsoid which doesn't emit particles. More...
|
void | setInnerSizeY (Real y) |
| Sets the y component of the area inside the ellipsoid which doesn't emit particles. More...
|
Real | getInnerSizeX (void) |
| Gets the x component of the area inside the ellipsoid which doesn't emit particles. More...
|
Real | getInnerSizeY (void) |
| Gets the y component of the area inside the ellipsoid which doesn't emit particles. More...
|
unsigned short | _getEmissionCount (Real timeElapsed) |
| See ParticleEmitter. More...
|
void | setDirection (const Vector3 &direction) |
| Overloaded to update the trans. More...
|
void | setSize (const Vector3 &size) |
| Sets the size of the area from which particles are emitted. More...
|
void | setSize (Real x, Real y, Real z) |
| Sets the size of the area from which particles are emitted. More...
|
void | setWidth (Real width) |
| Sets the width (local x size) of the emitter. More...
|
Real | getWidth (void) |
| Gets the width (local x size) of the emitter. More...
|
void | setHeight (Real Height) |
| Sets the height (local y size) of the emitter. More...
|
Real | getHeight (void) |
| Gets the height (local y size) of the emitter. More...
|
void | setDepth (Real Depth) |
| Sets the depth (local y size) of the emitter. More...
|
Real | getDepth (void) |
| Gets the depth (local y size) of the emitter. More...
|
virtual void | setPosition (const Vector3 &pos) |
| Sets the position of this emitter relative to the particle system center. More...
|
virtual Vector3 | getPosition (void) |
| Returns the position of this emitter relative to thte center of the particle system. More...
|
virtual Vector3 & | getDirection (void) |
| Returns the base direction of the emitter. More...
|
virtual void | setAngle (Real degrees) |
| Sets the maximum angle away from the emitter direction which particle will be emitted. More...
|
virtual Real | getAngle (void) |
| Returns the maximum angle which the initial particle direction can deviate from the emitters base direction. More...
|
virtual void | setParticleVelocity (Real speed) |
| Sets the initial velocity of particles emitted. More...
|
virtual void | setParticleVelocity (Real min, Real max) |
| Sets the initial velocity range of particles emitted. More...
|
virtual void | setMinParticleVelocity (Real min) |
| Returns the minimum particle velocity. More...
|
virtual void | setMaxParticleVelocity (Real max) |
| Returns the maximum particle velocity. More...
|
virtual Real | getParticleVelocity (void) |
| Returns the initial velocity of particles emitted. More...
|
virtual Real | getMinParticleVelocity (void) |
| Returns the minimum particle velocity. More...
|
virtual Real | getMaxParticleVelocity (void) |
| Returns the maximum particle velocity. More...
|
virtual void | setEmissionRate (Real particlesPerSecond) |
| Sets the emission rate for this emitter. More...
|
virtual Real | getEmissionRate (void) |
| Returns the emission rate set for this emitter. More...
|
virtual void | setTimeToLive (Real ttl) |
| Sets the lifetime of all particles emitted. More...
|
virtual void | setTimeToLive (Real minTtl, Real maxTtl) |
| Sets the range of lifetime for particles emitted. More...
|
virtual void | setMinTimeToLive (Real min) |
| Sets the minimum time each particle will live for. More...
|
virtual void | setMaxTimeToLive (Real max) |
| Sets the maximum time each particle will live for. More...
|
virtual Real | getTimeToLive (void) |
| Gets the time each particle will live for. More...
|
virtual Real | getMinTimeToLive (void) |
| Gets the minimum time each particle will live for. More...
|
virtual Real | getMaxTimeToLive (void) |
| Gets the maximum time each particle will live for. More...
|
virtual void | setColour (const ColourValue &colour) |
| Sets the initial colour of particles emitted. More...
|
virtual void | setColour (const ColourValue &colourStart, const ColourValue &colourEnd) |
| Sets the range of colours for emitted particles. More...
|
virtual void | setColourRangeStart (const ColourValue &colour) |
| Sets the minimum colour of particles to be emitted. More...
|
virtual void | setColourRangeEnd (const ColourValue &colour) |
| Sets the maximum colour of particles to be emitted. More...
|
virtual ColourValue | getColour (void) |
| Gets the colour of particles to be emitted. More...
|
virtual ColourValue | getColourRangeStart (void) |
| Gets the minimum colour of particles to be emitted. More...
|
virtual ColourValue | getColourRangeEnd (void) |
| Gets the maximum colour of particles to be emitted. More...
|
String | getType (void) |
| Returns the name of the type of emitter. More...
|
virtual void | setEnabled (bool enabled) |
| Sets whether or not the emitter is enabled. More...
|
virtual bool | getEnabled (void) |
| Gets the flag indicating if this emitter is enabled or not. More...
|
virtual void | setStartTime (Real startTime) |
| Sets the 'start time' of this emitter. More...
|
virtual Real | getStartTime (void) |
| Gets the start time of the emitter. More...
|
virtual void | setDuration (Real duration) |
| Sets the duration of the emitter. More...
|
virtual void | setDuration (Real min, Real max) |
| Sets the range of random duration for this emitter. More...
|
virtual Real | getDuration (void) |
| Gets the duration of the emitter from when it is created or re-enabled. More...
|
virtual void | setMinDuration (Real min) |
| Sets the minimum duration of this emitter in seconds (see setDuration for more details). More...
|
virtual void | setMaxDuration (Real max) |
| Sets the maximum duration of this emitter in seconds (see setDuration for more details). More...
|
virtual Real | getMinDuration (void) |
| Gets the minimum duration of this emitter in seconds (see setDuration for more details). More...
|
virtual Real | getMaxDuration (void) |
| Gets the maximum duration of this emitter in seconds (see setDuration for more details). More...
|
virtual void | setRepeatDelay (Real duration) |
| Sets the time between repeats of the emitter. More...
|
virtual void | setRepeatDelay (Real min, Real max) |
| Sets the range of random duration for this emitter. More...
|
virtual Real | getRepeatDelay (void) |
| Gets the duration of the emitter from when it is created or re-enabled. More...
|
virtual void | setMinRepeatDelay (Real min) |
| Sets the minimum duration of this emitter in seconds (see setRepeatDelay for more details). More...
|
virtual void | setMaxRepeatDelay (Real max) |
| Sets the maximum duration of this emitter in seconds (see setRepeatDelay for more details). More...
|
virtual Real | getMinRepeatDelay (void) |
| Gets the minimum duration of this emitter in seconds (see setRepeatDelay for more details). More...
|
virtual Real | getMaxRepeatDelay (void) |
| Gets the maximum duration of this emitter in seconds (see setRepeatDelay for more details). More...
|
ParamDictionary * | getParamDictionary (void) |
| Retrieves the parameter dictionary for this class. More...
|
const ParameterList & | getParameters (void) |
| Retrieves a list of parameters valid for this object. More...
|
virtual bool | setParameter (const String &name, const String &value) |
| Generic parameter setting method. More...
|
virtual String | getParameter (const String &name) |
| Generic parameter retrieval method. More...
|
virtual void | copyParametersTo (StringInterface *dest) |
| Method for copying this object's parameters to another object. More...
|
Protected Methods |
void | genAreaAxes (void) |
| Internal method for generating the area axes. More...
|
void | initDefaults (String mType) |
| Internal for initializing some defaults and parameters. More...
|
virtual void | genEmissionDirection (Vector3 &destVector) |
| Internal utility method for generating particle exit direction. More...
|
virtual void | genEmissionVelocity (Vector3 &destVector) |
| Internal utility method to apply velocity to a particle direction. More...
|
virtual Real | genEmissionTTL (void) |
| Internal utility method for generating a time-to-live for a particle. More...
|
virtual void | genEmissionColour (ColourValue &destColour) |
| Internal utility method for generating a colour for a particle. More...
|
virtual unsigned short | genConstantEmissionCount (Real timeElapsed) |
| Internal utility method for generating an emission count based on a constant emission rate. More...
|
void | addBaseParameters (void) |
| Internal method for setting up the basic parameter definitions for a subclass. More...
|
bool | createParamDictionary (const String &className) |
| Internal method for creating a parameter dictionary for the class, if it does not already exist. More...
|
Protected Attributes |
Real | mInnerSizex |
| Size of 'clear' center area (> 0 and < 1.0). More...
|
Real | mInnerSizey |
Vector3 | mSize |
| Size of the area. More...
|
Vector3 | mXRange |
| Local axes, not normalised, their magnitude reflects area size. More...
|
Vector3 | mYRange |
| Local axes, not normalised, their magnitude reflects area size. More...
|
Vector3 | mZRange |
| Local axes, not normalised, their magnitude reflects area size. More...
|
Vector3 | mPosition |
| Position relative to the center of the ParticleSystem. More...
|
Real | mEmissionRate |
| Rate in particles per second at which this emitter wishes to emit particles. More...
|
String | mType |
| Name of the type of emitter, MUST be initialised by subclasses. More...
|
Vector3 | mDirection |
| Base direction of the emitter, may not be used by some emitters. More...
|
Vector3 | mUp |
Real | mAngle |
| Angle around direction which particles may be emitted, internally radians but degrees for interface. More...
|
Real | mMinSpeed |
| Min speed of particles. More...
|
Real | mMaxSpeed |
| Max speed of particles. More...
|
Real | mMinTTL |
| Initial time-to-live of particles (min). More...
|
Real | mMaxTTL |
| Initial time-to-live of particles (max). More...
|
ColourValue | mColourRangeStart |
| Initial colour of particles (range start). More...
|
ColourValue | mColourRangeEnd |
| Initial colour of particles (range end). More...
|
bool | mEnabled |
| Whether this emitter is currently enabled (defaults to true). More...
|
Real | mStartTime |
| Start time (in seconds from start of first call to ParticleSystem to update). More...
|
Real | mDurationMin |
| Minimum length of time emitter will run for (0 = forever). More...
|
Real | mDurationMax |
| Maximum length of time the emitter will run for (0 = forever). More...
|
Real | mDurationRemain |
| Current duration remainder. More...
|
Real | mRepeatDelayMin |
| Time between each repeat. More...
|
Real | mRepeatDelayMax |
Real | mRepeatDelayRemain |
| Repeat delay left. More...
|
String | mParamDictName |
| Class name for this instance to be used as a lookup (must be initialised by subclasses). More...
|
Static Protected Attributes |
CmdInnerX | msCmdInnerX |
CmdInnerY | msCmdInnerY |
CmdWidth | msWidthCmd |
| Command objects. More...
|
CmdHeight | msHeightCmd |
CmdDepth | msDepthCmd |
EmitterCommands::CmdAngle | msAngleCmd |
EmitterCommands::CmdColour | msColourCmd |
EmitterCommands::CmdColourRangeStart | msColourRangeStartCmd |
EmitterCommands::CmdColourRangeEnd | msColourRangeEndCmd |
EmitterCommands::CmdDirection | msDirectionCmd |
EmitterCommands::CmdEmissionRate | msEmissionRateCmd |
EmitterCommands::CmdMaxTTL | msMaxTTLCmd |
EmitterCommands::CmdMaxVelocity | msMaxVelocityCmd |
EmitterCommands::CmdMinTTL | msMinTTLCmd |
EmitterCommands::CmdMinVelocity | msMinVelocityCmd |
EmitterCommands::CmdPosition | msPositionCmd |
EmitterCommands::CmdTTL | msTTLCmd |
EmitterCommands::CmdVelocity | msVelocityCmd |
EmitterCommands::CmdDuration | msDurationCmd |
EmitterCommands::CmdMinDuration | msMinDurationCmd |
EmitterCommands::CmdMaxDuration | msMaxDurationCmd |
EmitterCommands::CmdRepeatDelay | msRepeatDelayCmd |
EmitterCommands::CmdMinRepeatDelay | msMinRepeatDelayCmd |
EmitterCommands::CmdMaxRepeatDelay | msMaxRepeatDelayCmd |
ParamDictionaryMap | msDictionary |
| Dictionary of parameters. More...
|
a tube).