---

Ogre::ParticleEmitter Class Reference

Abstract class defining the interface to be implemented by particle emitters. More...

#include <OgreParticleEmitter.h>

Inheritance diagram for Ogre::ParticleEmitter:

List of all members.

Public Methods
	ParticleEmitter ()
virtual	~ParticleEmitter ()
	Virtual destructor essential. 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 void	setDirection (const Vector3 &direction)
	Sets the direction of the emitter. 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...
virtual unsigned short	_getEmissionCount (Real timeElapsed)=0
	Gets the number of particles which this emitter would like to emit based on the time elapsed. More...
virtual void	_initParticle (Particle *pParticle)=0
	Initialises a particle based on the emitter's approach and parameters. 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 Real	getDuration (void)
	Gets the duration of the emitter from when it is created or re-enabled. More...
virtual void	setDuration (Real min, Real max)
	Sets the range of random duration for this emitter. 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 Real	getRepeatDelay (void)
	Gets the duration of the emitter from when it is created or re-enabled. More...
virtual void	setRepeatDelay (Real min, Real max)
	Sets the range of random duration for this emitter. 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
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
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
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...

---

Detailed Description

Abstract class defining the interface to be implemented by particle emitters.

Remarks:

Particle emitters are the sources of particles in a particle system. This class defines the ParticleEmitter interface, and provides a basic implementation for tasks which most emitters will do (these are of course overridable). Particle emitters can be grouped into types, e.g. 'point' emitters, 'box' emitters etc; each type will create particles with a different starting point, direction and velocity (although within the types you can configure the ranges of these parameters).

Because there are so many types of emitters you could use, OGRE chooses not to dictate the available types. It comes with some in-built, but allows plugins or applications to extend the emitter types available. This is done by subclassing ParticleEmitter to have the appropriate emission behaviour you want, and also creating a subclass of ParticleEmitterFactory which is responsible for creating instances of your new emitter type. You register this factory with the ParticleSystemManager using addEmitterFactory, and from then on emitters of this type can be created either from code or through text particle scripts by naming the type.

This same approach is used for ParticleAffectors (which modify existing particles per frame). This means that OGRE is particularly flexible when it comes to creating particle system effects, with literally infinite combinations of emitter and affector types, and paramters within those types.

---

Constructor & Destructor Documentation

Ogre::ParticleEmitter::ParticleEmitter (    )

Ogre::ParticleEmitter::~ParticleEmitter (    )  [virtual]

Virtual destructor essential.

---

Member Function Documentation

virtual unsigned short Ogre::ParticleEmitter::_getEmissionCount (  Real    timeElapsed )  [pure virtual]

Gets the number of particles which this emitter would like to emit based on the time elapsed. Remarks: For efficiency the emitter does not actually create new Particle instances (these are reused by the ParticleSystem as existing particles 'die'). The implementation for this method must return the number of particles the emitter would like to emit given the number of seconds which have elapsed (passed in as a parameter). Based on the return value from this method, the ParticleSystem class will call _initParticle once for each particle it chooses to allow to be emitted by this emitter. The emitter should not track these _initParticle calls, it should assume all emissions requested were made (even if they could not be because of particle quotas). Implemented in Ogre::AreaEmitter.

virtual void Ogre::ParticleEmitter::_initParticle (  Particle *    pParticle )  [pure virtual]

Initialises a particle based on the emitter's approach and parameters. Remarks: See the _getEmissionCount method for details of why there is a separation between 'requested' emissions and actual initialised particles. Parameters: pParticle  Pointer to a particle which must be initialised based on how this emitter starts particles. This is passed as a pointer rather than being created by the emitter so the ParticleSystem can reuse Particle instances, and can also set defaults itself. Implemented in Ogre::BoxEmitter.

void Ogre::ParticleEmitter::addBaseParameters (  void    )  [protected]

Internal method for setting up the basic parameter definitions for a subclass. Remarks: Because StringInterface holds a dictionary of parameters per class, subclasses need to call this to ask the base class to add it's parameters to their dictionary as well. Can't do this in the constructor because that runs in a non-virtual context. The subclass must have called it's own createParamDictionary before calling this method.

virtual void Ogre::StringInterface::copyParametersTo (  StringInterface *    dest )  [inline, virtual, inherited]

Method for copying this object's parameters to another object. Remarks: This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop. Any unrecognised parameters will be ignored as with setParameter method. Parameters: dest  Pointer to object to have it's parameters set the same as this object.

bool Ogre::StringInterface::createParamDictionary (  const String &    className )  [inline, protected, inherited]

Internal method for creating a parameter dictionary for the class, if it does not already exist. Remarks: This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance). Parameters: className  the name of the class using the dictionary Returns: true if a new dictionary was created, false if it was already there

unsigned short Ogre::ParticleEmitter::genConstantEmissionCount (  Real    timeElapsed )  [protected, virtual]

Internal utility method for generating an emission count based on a constant emission rate.

void Ogre::ParticleEmitter::genEmissionColour (  ColourValue &    destColour )  [protected, virtual]

Internal utility method for generating a colour for a particle.

void Ogre::ParticleEmitter::genEmissionDirection (  Vector3 &    destVector )  [protected, virtual]

Internal utility method for generating particle exit direction. Parameters: destVector  Reference to vector to complete with new direction (normalised)

Real Ogre::ParticleEmitter::genEmissionTTL (  void    )  [protected, virtual]

Internal utility method for generating a time-to-live for a particle.

void Ogre::ParticleEmitter::genEmissionVelocity (  Vector3 &    destVector )  [protected, virtual]

Internal utility method to apply velocity to a particle direction. Parameters: destVector  The vector to scale by a randomly generated scale between min and max speed. Assumed normalised already, and likely already oriented in the right direction.

Real Ogre::ParticleEmitter::getAngle (  void    )  [virtual]

Returns the maximum angle which the initial particle direction can deviate from the emitters base direction.

ColourValue Ogre::ParticleEmitter::getColour (  void    )  [virtual]

Gets the colour of particles to be emitted.

ColourValue Ogre::ParticleEmitter::getColourRangeEnd (  void    )  [virtual]

Gets the maximum colour of particles to be emitted.

ColourValue Ogre::ParticleEmitter::getColourRangeStart (  void    )  [virtual]

Gets the minimum colour of particles to be emitted.

Vector3 & Ogre::ParticleEmitter::getDirection (  void    )  [virtual]

Returns the base direction of the emitter.

Real Ogre::ParticleEmitter::getDuration (  void    )  [virtual]

Gets the duration of the emitter from when it is created or re-enabled.

Real Ogre::ParticleEmitter::getEmissionRate (  void    )  [virtual]

Returns the emission rate set for this emitter.

bool Ogre::ParticleEmitter::getEnabled (  void    )  [virtual]

Gets the flag indicating if this emitter is enabled or not.

Real Ogre::ParticleEmitter::getMaxDuration (  void    )  [virtual]

Gets the maximum duration of this emitter in seconds (see setDuration for more details).

Real Ogre::ParticleEmitter::getMaxParticleVelocity (  void    )  [virtual]

Returns the maximum particle velocity.

Real Ogre::ParticleEmitter::getMaxRepeatDelay (  void    )  [virtual]

Gets the maximum duration of this emitter in seconds (see setRepeatDelay for more details).

Real Ogre::ParticleEmitter::getMaxTimeToLive (  void    )  [virtual]

Gets the maximum time each particle will live for.

Real Ogre::ParticleEmitter::getMinDuration (  void    )  [virtual]

Gets the minimum duration of this emitter in seconds (see setDuration for more details).

Real Ogre::ParticleEmitter::getMinParticleVelocity (  void    )  [virtual]

Returns the minimum particle velocity.

Real Ogre::ParticleEmitter::getMinRepeatDelay (  void    )  [virtual]

Gets the minimum duration of this emitter in seconds (see setRepeatDelay for more details).

Real Ogre::ParticleEmitter::getMinTimeToLive (  void    )  [virtual]

Gets the minimum time each particle will live for.

ParamDictionary* Ogre::StringInterface::getParamDictionary (  void    )  [inline, inherited]

Retrieves the parameter dictionary for this class. Remarks: Only valid to call this after createParamDictionary. Returns: Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

virtual String Ogre::StringInterface::getParameter (  const String &    name )  [inline, virtual, inherited]

Generic parameter retrieval method. Remarks: Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type. Parameters: name  The name of the parameter to get Returns: String value of parameter, blank if not found

const ParameterList& Ogre::StringInterface::getParameters (  void    )  [inline, inherited]

Retrieves a list of parameters valid for this object. Returns: A reference to a static list of ParameterDef objects.

Real Ogre::ParticleEmitter::getParticleVelocity (  void    )  [virtual]

Returns the initial velocity of particles emitted.

Vector3 Ogre::ParticleEmitter::getPosition (  void    )  [virtual]

Returns the position of this emitter relative to thte center of the particle system.

Real Ogre::ParticleEmitter::getRepeatDelay (  void    )  [virtual]

Gets the duration of the emitter from when it is created or re-enabled.

Real Ogre::ParticleEmitter::getStartTime (  void    )  [virtual]

Gets the start time of the emitter.

Real Ogre::ParticleEmitter::getTimeToLive (  void    )  [virtual]

Gets the time each particle will live for.

String Ogre::ParticleEmitter::getType (  void    )  [inline]

Returns the name of the type of emitter. Remarks: This property is useful for determining the type of emitter procedurally so another can be created.

void Ogre::ParticleEmitter::setAngle (  Real    degrees )  [virtual]

Sets the maximum angle away from the emitter direction which particle will be emitted. Remarks: Whilst the direction property defines the general direction of emission for particles, this property defines how far the emission angle can deviate away from this base direction. This allows you to create a scatter effect - if set to 0, all particles will be emitted exactly along the emitters direction vector, wheras if you set it to 180 or more, particles will be emitted in a sphere, i.e. in all directions. Parameters: degrees  Maximum angle in degrees which initial particle direction can deviate from the emitter base direction vector.

void Ogre::ParticleEmitter::setColour (  const ColourValue &    colourStart, const ColourValue &    colourEnd )  [virtual]

Sets the range of colours for emitted particles. Remarks: Particles have an initial colour on emission which the emitter sets. This method sets the range of this colour. See the alternate version of this method which takes a single colour in order to set a constant colour for all particles. Emitters may choose to randomly assign a colour in this range, or may use some other method to vary the colour. Parameters: colourStart  The start of the colour range colourEnd  The end of the colour range

void Ogre::ParticleEmitter::setColour (  const ColourValue &    colour )  [virtual]

Sets the initial colour of particles emitted. Remarks: Particles have an initial colour on emission which the emitter sets. This method sets this colour. See the alternate version of this method which takes 2 colours in order to establish a range of colours to be assigned to particles. Parameters: colour  The colour which all particles will be given on emission.

void Ogre::ParticleEmitter::setColourRangeEnd (  const ColourValue &    colour )  [virtual]

Sets the maximum colour of particles to be emitted.

void Ogre::ParticleEmitter::setColourRangeStart (  const ColourValue &    colour )  [virtual]

Sets the minimum colour of particles to be emitted.

void Ogre::ParticleEmitter::setDirection (  const Vector3 &    direction )  [virtual]

Sets the direction of the emitter. Remarks: Most emitters will have a base direction in which they emit particles (those which emit in all directions will ignore this parameter). They may not emit exactly along this vector for every particle, many will introduce a random scatter around this vector using the angle property. Parameters: direction  The base direction for particles emitted. Reimplemented in Ogre::AreaEmitter.

void Ogre::ParticleEmitter::setDuration (  Real    min, Real    max )  [virtual]

Sets the range of random duration for this emitter. Remarks: By default emitters run indefinitely (unless you manually disable them). By setting this parameter, you can make an emitter turn off on it's own after a random number of seconds. It will then remain disabled until either setEnabled(true) is called, or if the 'repeatAfter' parameter has been set it will also repeat after a number of seconds. Also see the alternative version of this method which allows you to set a constant duration. Parameters: min  The minimum duration in seconds. max  The minimum duration in seconds.

void Ogre::ParticleEmitter::setDuration (  Real    duration )  [virtual]

Sets the duration of the emitter. Remarks: By default emitters run indefinitely (unless you manually disable them). By setting this parameter, you can make an emitter turn off on it's own after a set number of seconds. It will then remain disabled until either setEnabled(true) is called, or if the 'repeatAfter' parameter has been set it will also repeat after a number of seconds. Also see the alternative version of this method which allows you to set a min and max duration for a random variable duration. Parameters: duration  The duration in seconds.

void Ogre::ParticleEmitter::setEmissionRate (  Real    particlesPerSecond )  [virtual]

Sets the emission rate for this emitter. Remarks: This method tells the emitter how many particles per second should be emitted. The emitter subclass does not have to emit these in a continuous burst - this is a relative parameter and the emitter may choose to emit all of the second's worth of particles every half-second for example. This is controlled by the emitter's getEmissionCount method. Also, if the ParticleSystem's particle quota is exceeded, not all the particles requested may be actually emitted. Parameters: particlesPerSecond  The number of particles to be emitted every second.

void Ogre::ParticleEmitter::setEnabled (  bool    enabled )  [virtual]

Sets whether or not the emitter is enabled. Remarks: You can turn an emitter off completely by setting this parameter to false.

void Ogre::ParticleEmitter::setMaxDuration (  Real    max )  [virtual]

Sets the maximum duration of this emitter in seconds (see setDuration for more details).

void Ogre::ParticleEmitter::setMaxParticleVelocity (  Real    max )  [virtual]

Returns the maximum particle velocity.

void Ogre::ParticleEmitter::setMaxRepeatDelay (  Real    max )  [virtual]

Sets the maximum duration of this emitter in seconds (see setRepeatDelay for more details).

void Ogre::ParticleEmitter::setMaxTimeToLive (  Real    max )  [virtual]

Sets the maximum time each particle will live for.

void Ogre::ParticleEmitter::setMinDuration (  Real    min )  [virtual]

Sets the minimum duration of this emitter in seconds (see setDuration for more details).

void Ogre::ParticleEmitter::setMinParticleVelocity (  Real    min )  [virtual]

Returns the minimum particle velocity.

void Ogre::ParticleEmitter::setMinRepeatDelay (  Real    min )  [virtual]

Sets the minimum duration of this emitter in seconds (see setRepeatDelay for more details).

void Ogre::ParticleEmitter::setMinTimeToLive (  Real    min )  [virtual]

Sets the minimum time each particle will live for.

bool Ogre::StringInterface::setParameter (  const String &    name, const String &    value )  [virtual, inherited]

Generic parameter setting method. Remarks: Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters. Parameters: name  The name of the parameter to set value  String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information. Returns: true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

void Ogre::ParticleEmitter::setParticleVelocity (  Real    min, Real    max )  [virtual]

Sets the initial velocity range of particles emitted. Remarks: This method sets the range of starting speeds for emitted particles. See the alternate version of this method which takes 1 parameter if you want a constant speed. This emitter will randomly choose a speed between the minimum and maximum for each particle. Parameters: max  The maximum speed in world units per second for the initial particle speed on emission. min  The minimum speed in world units per second for the initial particle speed on emission.

void Ogre::ParticleEmitter::setParticleVelocity (  Real    speed )  [virtual]

Sets the initial velocity of particles emitted. Remarks: This method sets a constant speed for emitted particles. See the alternate version of this method which takes 2 parameters if you want a variable speed. Parameters: speed  The initial speed in world units per second which every particle emitted starts with.

void Ogre::ParticleEmitter::setPosition (  const Vector3 &    pos )  [virtual]

Sets the position of this emitter relative to the particle system center.

void Ogre::ParticleEmitter::setRepeatDelay (  Real    min, Real    max )  [virtual]

Sets the range of random duration for this emitter. Remarks: By default emitters run indefinitely (unless you manually disable them). By setting this parameter, you can make an emitter turn off on it's own after a random number of seconds. It will then remain disabled until either setEnabled(true) is called, or if the 'repeatAfter' parameter has been set it will also repeat after a number of seconds. Also see the alternative version of this method which allows you to set a constant duration. Parameters: min  The minimum duration in seconds. max  The minimum duration in seconds.

void Ogre::ParticleEmitter::setRepeatDelay (  Real    duration )  [virtual]

Sets the time between repeats of the emitter. Remarks: By default emitters run indefinitely (unless you manually disable them). However, if you manually disable the emitter (by calling setEnabled(false), or it's duration runs out, it will cease to emit Also see the alternative version of this method which allows you to set a min and max duration for a random variable duration. Parameters: duration  The duration in seconds.

void Ogre::ParticleEmitter::setStartTime (  Real    startTime )  [virtual]

Sets the 'start time' of this emitter. Remarks: By default an emitter starts straight away as soon as a ParticleSystem is first created, or also just after it is re-enabled. This parameter allows you to set a time delay so that the emitter does not 'kick in' until later. Parameters: startTime  The time in seconds from the creation or enabling of the emitter.

void Ogre::ParticleEmitter::setTimeToLive (  Real    minTtl, Real    maxTtl )  [virtual]

Sets the range of lifetime for particles emitted. Remarks: The emitter initialises particles with a time-to-live (TTL), the number of seconds a particle will exist before being destroyed. This method sets a range for the TTL for all particles emitted; the ttl may be randomised between these 2 extremes or will vary some other way depending on the emitter. Note that affectors are able to modify the TTL of particles later. Also see the alternate version of this method which takes a single TTL in order to set a constant TTL for all particles. Parameters: minTtl  The minimum number of seconds each particle will live for. maxTtl  The maximum number of seconds each particle will live for.

void Ogre::ParticleEmitter::setTimeToLive (  Real    ttl )  [virtual]

Sets the lifetime of all particles emitted. Remarks: The emitter initialises particles with a time-to-live (TTL), the number of seconds a particle will exist before being destroyed. This method sets a constant TTL for all particles emitted. Note that affectors are able to modify the TTL of particles later. Also see the alternate version of this method which takes a min and max TTL in order to have the TTL vary per particle. Parameters: ttl  The number of seconds each particle will live for.

---

Member Data Documentation

Real Ogre::ParticleEmitter::mAngle [protected]

Angle around direction which particles may be emitted, internally radians but degrees for interface.

ColourValue Ogre::ParticleEmitter::mColourRangeEnd [protected]

Initial colour of particles (range end).

ColourValue Ogre::ParticleEmitter::mColourRangeStart [protected]

Initial colour of particles (range start).

Vector3 Ogre::ParticleEmitter::mDirection [protected]

Base direction of the emitter, may not be used by some emitters.

Real Ogre::ParticleEmitter::mDurationMax [protected]

Maximum length of time the emitter will run for (0 = forever).

Real Ogre::ParticleEmitter::mDurationMin [protected]

Minimum length of time emitter will run for (0 = forever).

Real Ogre::ParticleEmitter::mDurationRemain [protected]

Current duration remainder.

Real Ogre::ParticleEmitter::mEmissionRate [protected]

Rate in particles per second at which this emitter wishes to emit particles.

bool Ogre::ParticleEmitter::mEnabled [protected]

Whether this emitter is currently enabled (defaults to true).

Real Ogre::ParticleEmitter::mMaxSpeed [protected]

Max speed of particles.

Real Ogre::ParticleEmitter::mMaxTTL [protected]

Initial time-to-live of particles (max).

Real Ogre::ParticleEmitter::mMinSpeed [protected]

Min speed of particles.

Real Ogre::ParticleEmitter::mMinTTL [protected]

Initial time-to-live of particles (min).

String Ogre::StringInterface::mParamDictName [protected, inherited]

Class name for this instance to be used as a lookup (must be initialised by subclasses).

Vector3 Ogre::ParticleEmitter::mPosition [protected]

Position relative to the center of the ParticleSystem.

Real Ogre::ParticleEmitter::mRepeatDelayMax [protected]

Real Ogre::ParticleEmitter::mRepeatDelayMin [protected]

Time between each repeat.

Real Ogre::ParticleEmitter::mRepeatDelayRemain [protected]

Repeat delay left.

EmitterCommands::CmdAngle Ogre::ParticleEmitter::msAngleCmd [static, protected]

EmitterCommands::CmdColour Ogre::ParticleEmitter::msColourCmd [static, protected]

EmitterCommands::CmdColourRangeEnd Ogre::ParticleEmitter::msColourRangeEndCmd [static, protected]

EmitterCommands::CmdColourRangeStart Ogre::ParticleEmitter::msColourRangeStartCmd [static, protected]

ParamDictionaryMap Ogre::StringInterface::msDictionary [static, protected, inherited]

Dictionary of parameters.

EmitterCommands::CmdDirection Ogre::ParticleEmitter::msDirectionCmd [static, protected]

EmitterCommands::CmdDuration Ogre::ParticleEmitter::msDurationCmd [static, protected]

EmitterCommands::CmdEmissionRate Ogre::ParticleEmitter::msEmissionRateCmd [static, protected]

EmitterCommands::CmdMaxDuration Ogre::ParticleEmitter::msMaxDurationCmd [static, protected]

EmitterCommands::CmdMaxRepeatDelay Ogre::ParticleEmitter::msMaxRepeatDelayCmd [static, protected]

EmitterCommands::CmdMaxTTL Ogre::ParticleEmitter::msMaxTTLCmd [static, protected]

EmitterCommands::CmdMaxVelocity Ogre::ParticleEmitter::msMaxVelocityCmd [static, protected]

EmitterCommands::CmdMinDuration Ogre::ParticleEmitter::msMinDurationCmd [static, protected]

EmitterCommands::CmdMinRepeatDelay Ogre::ParticleEmitter::msMinRepeatDelayCmd [static, protected]

EmitterCommands::CmdMinTTL Ogre::ParticleEmitter::msMinTTLCmd [static, protected]

EmitterCommands::CmdMinVelocity Ogre::ParticleEmitter::msMinVelocityCmd [static, protected]

EmitterCommands::CmdPosition Ogre::ParticleEmitter::msPositionCmd [static, protected]

EmitterCommands::CmdRepeatDelay Ogre::ParticleEmitter::msRepeatDelayCmd [static, protected]

Real Ogre::ParticleEmitter::mStartTime [protected]

Start time (in seconds from start of first call to ParticleSystem to update).

EmitterCommands::CmdTTL Ogre::ParticleEmitter::msTTLCmd [static, protected]

EmitterCommands::CmdVelocity Ogre::ParticleEmitter::msVelocityCmd [static, protected]

String Ogre::ParticleEmitter::mType [protected]

Name of the type of emitter, MUST be initialised by subclasses.

Vector3 Ogre::ParticleEmitter::mUp [protected]

Copyright © 2002 by The OGRE Team