OGRE
14.3
Object-Oriented Graphics Rendering Engine
|
Abstract class defining the interface to be implemented by particle emitters. More...
#include <OgreParticleEmitter.h>
Public Member Functions | |
ParticleEmitter (ParticleSystem *psys) | |
virtual | ~ParticleEmitter () |
Virtual destructor essential. More... | |
virtual unsigned short | _getEmissionCount (Real timeElapsed) |
Gets the number of particles which this emitter would like to emit based on the time elapsed. More... | |
virtual void | _initParticle (Particle *pParticle) |
Initialises a particle based on the emitter's approach and parameters. More... | |
virtual const Radian & | getAngle (void) const |
Returns the maximum angle which the initial particle direction can deviate from the emitters base direction. More... | |
virtual const ColourValue & | getColour (void) const |
Gets the colour of particles to be emitted. More... | |
virtual const ColourValue & | getColourRangeEnd (void) const |
Gets the maximum colour of particles to be emitted. More... | |
virtual const ColourValue & | getColourRangeStart (void) const |
Gets the minimum colour of particles to be emitted. More... | |
virtual const Vector3 & | getDirection (void) const |
Returns the base direction of the emitter. More... | |
virtual const Vector3 & | getDirPositionReference () const |
Returns the position reference to generate direction of emitted particles. More... | |
virtual bool | getDirPositionReferenceEnabled () const |
Returns whether direction or position reference is used. More... | |
virtual Real | getDuration (void) const |
Gets the duration of the emitter from when it is created or re-enabled. More... | |
virtual Real | getEmissionRate (void) const |
Returns the emission rate set for this emitter. More... | |
const String & | getEmittedEmitter (void) const |
Returns the name of the emitter to be emitted. More... | |
virtual bool | getEnabled (void) const |
Gets the flag indicating if this emitter is enabled or not. More... | |
virtual Real | getMaxDuration (void) const |
Gets the maximum duration of this emitter in seconds (see setDuration for more details) More... | |
virtual Real | getMaxParticleVelocity (void) const |
Returns the maximum particle velocity. More... | |
virtual Real | getMaxRepeatDelay (void) const |
Gets the maximum duration of this emitter in seconds (see setRepeatDelay for more details) More... | |
virtual Real | getMaxTimeToLive (void) const |
Gets the maximum time each particle will live for. More... | |
virtual Real | getMinDuration (void) const |
Gets the minimum duration of this emitter in seconds (see setDuration for more details) More... | |
virtual Real | getMinParticleVelocity (void) const |
Returns the minimum particle velocity. More... | |
virtual Real | getMinRepeatDelay (void) const |
Gets the minimum duration of this emitter in seconds (see setRepeatDelay for more details) More... | |
virtual Real | getMinTimeToLive (void) const |
Gets the minimum time each particle will live for. More... | |
const String & | getName (void) const |
Returns the name of the emitter. More... | |
virtual Real | getParticleVelocity (void) const |
Returns the initial velocity of particles emitted. More... | |
virtual const Vector3 & | getPosition (void) const |
Returns the position of this emitter relative to the center of the particle system. More... | |
virtual Real | getRepeatDelay (void) const |
Gets the duration of the emitter from when it is created or re-enabled. More... | |
virtual Real | getStartTime (void) const |
Gets the start time of the emitter. More... | |
virtual Real | getTimeToLive (void) const |
Gets the time each particle will live for. More... | |
const String & | getType (void) const |
Returns the name of the type of emitter. More... | |
virtual const Vector3 & | getUp (void) const |
Returns the up vector of the emitter. More... | |
virtual bool | isEmitted (void) const |
Return true if the emitter is emitted by another emitter. More... | |
virtual void | setAngle (const Radian &angle) |
Sets the maximum angle away from the emitter direction which particle will be emitted. 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 | setColourRangeEnd (const ColourValue &colour) |
Sets the maximum colour of particles to be emitted. More... | |
virtual void | setColourRangeStart (const ColourValue &colour) |
Sets the minimum colour of particles to be emitted. More... | |
virtual void | setDirection (const Vector3 &direction) |
Sets the direction of the emitter. More... | |
virtual void | setDirPositionReference (const Vector3 &position, bool enable) |
Sets the direction 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 void | setEmissionRate (Real particlesPerSecond) |
Sets the emission rate for this emitter. More... | |
virtual void | setEmitted (bool emitted) |
Set the indication (true/false) to indicate that the emitter is emitted by another emitter. More... | |
virtual void | setEmittedEmitter (const String &emittedEmitter) |
Sets the name of the emitter to be emitted. More... | |
virtual void | setEnabled (bool enabled) |
Sets whether or not the emitter is enabled. More... | |
virtual void | setMaxDuration (Real max) |
Sets the maximum duration of this emitter in seconds (see setDuration for more details) More... | |
virtual void | setMaxParticleVelocity (Real max) |
Returns the maximum particle velocity. More... | |
virtual void | setMaxRepeatDelay (Real max) |
Sets the maximum duration of this emitter in seconds (see setRepeatDelay for more details) More... | |
virtual void | setMaxTimeToLive (Real max) |
Sets the maximum time each particle will live for. More... | |
virtual void | setMinDuration (Real min) |
Sets the minimum duration of this emitter in seconds (see setDuration for more details) More... | |
virtual void | setMinParticleVelocity (Real min) |
Returns the minimum particle velocity. More... | |
virtual void | setMinRepeatDelay (Real min) |
Sets the minimum duration of this emitter in seconds (see setRepeatDelay for more details) More... | |
virtual void | setMinTimeToLive (Real min) |
Sets the minimum time each particle will live for. More... | |
virtual void | setName (const String &newName) |
Sets the name of the emitter. More... | |
virtual void | setParticleVelocity (Real min, Real max) |
Sets the initial velocity range of particles emitted. More... | |
virtual void | setParticleVelocity (Real speed) |
Sets the initial velocity of particles emitted. More... | |
virtual void | setPosition (const Vector3 &pos) |
Sets the position of this emitter relative to the particle system center. 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 void | setStartTime (Real startTime) |
Sets the 'start time' of this emitter. More... | |
virtual void | setTimeToLive (Real minTtl, Real maxTtl) |
Sets the range of lifetime for particles emitted. More... | |
virtual void | setTimeToLive (Real ttl) |
Sets the lifetime of all particles emitted. More... | |
virtual void | setUp (const Vector3 &up) |
Sets the notional up vector of the emitter. More... | |
Public Member Functions inherited from Ogre::StringInterface | |
StringInterface () | |
virtual | ~StringInterface () |
Virtual destructor, see Effective C++. More... | |
void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. More... | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. More... | |
const ParamDictionary * | getParamDictionary (void) const |
String | getParameter (const String &name) const |
Generic parameter retrieval method. More... | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. More... | |
bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. More... | |
void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. More... | |
Public Member Functions inherited from Ogre::Particle | |
Particle () | |
float | getOwnHeight (void) const |
Retrieves the particle's personal width, if hasOwnDimensions is true. More... | |
float | getOwnWidth (void) const |
Retrieves the particle's personal width, if hasOwnDimensions is true. More... | |
const Radian & | getRotation (void) const |
bool | hasOwnDimensions (void) const |
void | setDimensions (float width, float height) |
Sets the width and height for this particle. More... | |
void | setRotation (const Radian &rad) |
Sets the current rotation. More... | |
Additional Inherited Members | |
Public Types inherited from Ogre::Particle | |
enum | ParticleType : uint8 { Visual , Emitter } |
Type of particle. More... | |
Static Public Member Functions inherited from Ogre::StringInterface | |
static void | cleanupDictionary () |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More... | |
Public Attributes inherited from Ogre::Particle | |
RGBA | mColour |
Current colour. More... | |
Vector3 | mDirection |
Direction (and speed) More... | |
float | mHeight |
Particle height. More... | |
ParticleType | mParticleType |
Determines the type of particle. More... | |
Vector3 | mPosition |
World position. More... | |
uint8 | mRandomTexcoordOffset |
Radian | mRotation |
Current rotation value. More... | |
Radian | mRotationSpeed |
Speed of rotation in radians/sec. More... | |
uint8 | mTexcoordIndex |
Index into the array of texture coordinates. More... | |
float | mTimeToLive |
Time to live, number of seconds left of particles natural life. More... | |
float | mTotalTimeToLive |
Total Time to live, number of seconds of particles natural life. More... | |
float | mWidth |
Particle width. More... | |
Abstract class defining the interface to be implemented by particle emitters.
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).
Ogre::ParticleEmitter::ParticleEmitter | ( | ParticleSystem * | psys | ) |
|
virtual |
Virtual destructor essential.
|
virtual |
Sets the position of this emitter relative to the particle system center.
|
virtual |
Returns the position of this emitter relative to the center of the particle system.
|
virtual |
Sets the direction of the emitter.
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.
direction | The base direction for particles emitted. |
Reimplemented in Ogre::AreaEmitter.
|
virtual |
Returns the base direction of the emitter.
|
virtual |
Sets the notional up vector of the emitter.
Many emitters emit particles from within a region, and for some that region is not circularly symmetric about the emitter direction. The up vector allows such emitters to be orientated about the direction vector.
up | The base direction for particles emitted. It must be perpendicular to the direction vector. |
|
virtual |
Returns the up vector of the emitter.
|
virtual |
Sets the direction of the emitter.
Some particle effects need to emit particles in many random directions, but still following some rules; like not having them collide against each other. Very useful for explosions and implosions (when velocity is negative)
position | The reference position in which the direction of the particles will be calculated from, also taking into account the particle's position at the time of emission. |
enable | True to use mDirPositionRef, false to use the default behaviour with mDirection |
|
virtual |
Returns the position reference to generate direction of emitted particles.
|
virtual |
Returns whether direction or position reference is used.
|
virtual |
Sets the maximum angle away from the emitter direction which particle will be emitted.
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, whereas if you set it to 180 degrees or more, particles will be emitted in a sphere, i.e. in all directions.
angle | Maximum angle which initial particle direction can deviate from the emitter base direction vector. |
|
virtual |
Returns the maximum angle which the initial particle direction can deviate from the emitters base direction.
|
virtual |
Sets the initial velocity of particles emitted.
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.
speed | The initial speed in world units per second which every particle emitted starts with. |
Sets the initial velocity range of particles emitted.
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.
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. |
|
virtual |
Returns the minimum particle velocity.
|
virtual |
Returns the maximum particle velocity.
|
virtual |
Returns the initial velocity of particles emitted.
|
virtual |
Returns the minimum particle velocity.
|
virtual |
Returns the maximum particle velocity.
|
virtual |
Sets the emission rate for this emitter.
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.
particlesPerSecond | The number of particles to be emitted every second. |
|
virtual |
Returns the emission rate set for this emitter.
|
virtual |
Sets the lifetime of all particles emitted.
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.
ttl | The number of seconds each particle will live for. |
Sets the range of lifetime for particles emitted.
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.
minTtl | The minimum number of seconds each particle will live for. Must be non-negative! |
maxTtl | The maximum number of seconds each particle will live for. Must be non-negative! |
|
virtual |
Sets the minimum time each particle will live for.
Must be non-negative!
|
virtual |
Sets the maximum time each particle will live for.
Must be non-negative!
|
virtual |
Gets the time each particle will live for.
|
virtual |
Gets the minimum time each particle will live for.
|
virtual |
Gets the maximum time each particle will live for.
|
virtual |
Sets the initial colour of particles emitted.
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.
colour | The colour which all particles will be given on emission. |
|
virtual |
Sets the range of colours for emitted particles.
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.
colourStart | The start of the colour range |
colourEnd | The end of the colour range |
|
virtual |
Sets the minimum colour of particles to be emitted.
|
virtual |
Sets the maximum colour of particles to be emitted.
|
virtual |
Gets the colour of particles to be emitted.
|
virtual |
Gets the minimum colour of particles to be emitted.
|
virtual |
Gets the maximum colour of particles to be emitted.
|
inlinevirtual |
Gets the number of particles which this emitter would like to emit based on the time elapsed.
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).
|
inlinevirtual |
Initialises a particle based on the emitter's approach and parameters.
See the _getEmissionCount method for details of why there is a separation between 'requested' emissions and actual initialised particles.
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. |
Reimplemented in Ogre::RingEmitter, Ogre::PointEmitter, Ogre::HollowEllipsoidEmitter, Ogre::EllipsoidEmitter, Ogre::CylinderEmitter, and Ogre::BoxEmitter.
References Ogre::ParticleSystem::getDefaultHeight(), Ogre::ParticleSystem::getDefaultWidth(), and Ogre::Particle::setDimensions().
|
inline |
Returns the name of the type of emitter.
This property is useful for determining the type of emitter procedurally so another can be created.
|
virtual |
Sets whether or not the emitter is enabled.
You can turn an emitter off completely by setting this parameter to false.
|
virtual |
Gets the flag indicating if this emitter is enabled or not.
|
virtual |
Sets the 'start time' of this emitter.
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.
startTime | The time in seconds from the creation or enabling of the emitter. |
|
virtual |
Gets the start time of the emitter.
|
virtual |
Sets the duration of the emitter.
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.
duration | The duration in seconds. |
|
virtual |
Gets the duration of the emitter from when it is created or re-enabled.
Sets the range of random duration for this emitter.
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.
min | The minimum duration in seconds. |
max | The minimum duration in seconds. |
|
virtual |
Sets the minimum duration of this emitter in seconds (see setDuration for more details)
|
virtual |
Sets the maximum duration of this emitter in seconds (see setDuration for more details)
|
virtual |
Gets the minimum duration of this emitter in seconds (see setDuration for more details)
|
virtual |
Gets the maximum duration of this emitter in seconds (see setDuration for more details)
|
virtual |
Sets the time between repeats of the emitter.
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
duration | The duration in seconds. |
|
virtual |
Gets the duration of the emitter from when it is created or re-enabled.
Sets the range of random duration for this emitter.
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.
min | The minimum duration in seconds. |
max | The minimum duration in seconds. |
|
virtual |
Sets the minimum duration of this emitter in seconds (see setRepeatDelay for more details)
|
virtual |
Sets the maximum duration of this emitter in seconds (see setRepeatDelay for more details)
|
virtual |
Gets the minimum duration of this emitter in seconds (see setRepeatDelay for more details)
|
virtual |
Gets the maximum duration of this emitter in seconds (see setRepeatDelay for more details)
const String& Ogre::ParticleEmitter::getName | ( | void | ) | const |
Returns the name of the emitter.
|
virtual |
Sets the name of the emitter.
const String& Ogre::ParticleEmitter::getEmittedEmitter | ( | void | ) | const |
Returns the name of the emitter to be emitted.
|
virtual |
Sets the name of the emitter to be emitted.
|
virtual |
Return true if the emitter is emitted by another emitter.
|
virtual |
Set the indication (true/false) to indicate that the emitter is emitted by another emitter.