![]() |
OGRE 1.12.10
Object-Oriented Graphics Rendering Engine
|
Particle emitter which emits particles randomly from points inside an area (box, sphere, ellipsoid whatever subclasses choose to be). More...
#include <OgreAreaEmitter.h>
Classes | |
class | CmdDepth |
Command object for area emitter size (see ParamCommand). More... | |
class | CmdHeight |
Command object for area emitter size (see ParamCommand). More... | |
class | CmdWidth |
Command object for area emitter size (see ParamCommand). More... | |
Public Member Functions | |
AreaEmitter (ParticleSystem *psys) | |
unsigned short | _getEmissionCount (Real timeElapsed) |
See ParticleEmitter. | |
Real | getDepth (void) const |
Gets the depth (local y size) of the emitter. | |
Real | getHeight (void) const |
Gets the height (local y size) of the emitter. | |
Real | getWidth (void) const |
Gets the width (local x size) of the emitter. | |
void | setDepth (Real Depth) |
Sets the depth (local y size) of the emitter. | |
void | setDirection (const Vector3 &direction) |
Overloaded to update the trans. | |
void | setHeight (Real Height) |
Sets the height (local y size) of the emitter. | |
void | setSize (const Vector3 &size) |
Sets the size of the area from which particles are emitted. | |
void | setSize (Real x, Real y, Real z) |
Sets the size of the area from which particles are emitted. | |
void | setWidth (Real width) |
Sets the width (local x size) of the emitter. | |
![]() | |
ParticleEmitter (ParticleSystem *psys) | |
virtual | ~ParticleEmitter () |
Virtual destructor essential. | |
virtual void | _initParticle (Particle *pParticle) |
Initialises a particle based on the emitter's approach and parameters. | |
virtual const Radian & | getAngle (void) const |
Returns the maximum angle which the initial particle direction can deviate from the emitters base direction. | |
virtual const ColourValue & | getColour (void) const |
Gets the colour of particles to be emitted. | |
virtual const ColourValue & | getColourRangeEnd (void) const |
Gets the maximum colour of particles to be emitted. | |
virtual const ColourValue & | getColourRangeStart (void) const |
Gets the minimum colour of particles to be emitted. | |
virtual const Vector3 & | getDirection (void) const |
Returns the base direction of the emitter. | |
virtual const Vector3 & | getDirPositionReference () const |
Returns the position reference to generate direction of emitted particles. | |
virtual bool | getDirPositionReferenceEnabled () const |
Returns whether direction or position reference is used. | |
virtual Real | getDuration (void) const |
Gets the duration of the emitter from when it is created or re-enabled. | |
virtual Real | getEmissionRate (void) const |
Returns the emission rate set for this emitter. | |
const String & | getEmittedEmitter (void) const |
Returns the name of the emitter to be emitted. | |
virtual bool | getEnabled (void) const |
Gets the flag indicating if this emitter is enabled or not. | |
virtual Real | getMaxDuration (void) const |
Gets the maximum duration of this emitter in seconds (see setDuration for more details) | |
virtual Real | getMaxParticleVelocity (void) const |
Returns the maximum particle velocity. | |
virtual Real | getMaxRepeatDelay (void) const |
Gets the maximum duration of this emitter in seconds (see setRepeatDelay for more details) | |
virtual Real | getMaxTimeToLive (void) const |
Gets the maximum time each particle will live for. | |
virtual Real | getMinDuration (void) const |
Gets the minimum duration of this emitter in seconds (see setDuration for more details) | |
virtual Real | getMinParticleVelocity (void) const |
Returns the minimum particle velocity. | |
virtual Real | getMinRepeatDelay (void) const |
Gets the minimum duration of this emitter in seconds (see setRepeatDelay for more details) | |
virtual Real | getMinTimeToLive (void) const |
Gets the minimum time each particle will live for. | |
const String & | getName (void) const |
Returns the name of the emitter. | |
virtual Real | getParticleVelocity (void) const |
Returns the initial velocity of particles emitted. | |
virtual const Vector3 & | getPosition (void) const |
Returns the position of this emitter relative to the center of the particle system. | |
virtual Real | getRepeatDelay (void) const |
Gets the duration of the emitter from when it is created or re-enabled. | |
virtual Real | getStartTime (void) const |
Gets the start time of the emitter. | |
virtual Real | getTimeToLive (void) const |
Gets the time each particle will live for. | |
const String & | getType (void) const |
Returns the name of the type of emitter. | |
virtual const Vector3 & | getUp (void) const |
Returns the up vector of the emitter. | |
virtual bool | isEmitted (void) const |
Return true if the emitter is emitted by another emitter. | |
virtual void | setAngle (const Radian &angle) |
Sets the maximum angle away from the emitter direction which particle will be emitted. | |
virtual void | setColour (const ColourValue &colour) |
Sets the initial colour of particles emitted. | |
virtual void | setColour (const ColourValue &colourStart, const ColourValue &colourEnd) |
Sets the range of colours for emitted particles. | |
virtual void | setColourRangeEnd (const ColourValue &colour) |
Sets the maximum colour of particles to be emitted. | |
virtual void | setColourRangeStart (const ColourValue &colour) |
Sets the minimum colour of particles to be emitted. | |
virtual void | setDirPositionReference (const Vector3 &position, bool enable) |
Sets the direction of the emitter. | |
virtual void | setDuration (Real duration) |
Sets the duration of the emitter. | |
virtual void | setDuration (Real min, Real max) |
Sets the range of random duration for this emitter. | |
virtual void | setEmissionRate (Real particlesPerSecond) |
Sets the emission rate for this emitter. | |
virtual void | setEmitted (bool emitted) |
Set the indication (true/false) to indicate that the emitter is emitted by another emitter. | |
virtual void | setEmittedEmitter (const String &emittedEmitter) |
Sets the name of the emitter to be emitted. | |
virtual void | setEnabled (bool enabled) |
Sets whether or not the emitter is enabled. | |
virtual void | setMaxDuration (Real max) |
Sets the maximum duration of this emitter in seconds (see setDuration for more details) | |
virtual void | setMaxParticleVelocity (Real max) |
Returns the maximum particle velocity. | |
virtual void | setMaxRepeatDelay (Real max) |
Sets the maximum duration of this emitter in seconds (see setRepeatDelay for more details) | |
virtual void | setMaxTimeToLive (Real max) |
Sets the maximum time each particle will live for. | |
virtual void | setMinDuration (Real min) |
Sets the minimum duration of this emitter in seconds (see setDuration for more details) | |
virtual void | setMinParticleVelocity (Real min) |
Returns the minimum particle velocity. | |
virtual void | setMinRepeatDelay (Real min) |
Sets the minimum duration of this emitter in seconds (see setRepeatDelay for more details) | |
virtual void | setMinTimeToLive (Real min) |
Sets the minimum time each particle will live for. | |
virtual void | setName (const String &newName) |
Sets the name of the emitter. | |
virtual void | setParticleVelocity (Real min, Real max) |
Sets the initial velocity range of particles emitted. | |
virtual void | setParticleVelocity (Real speed) |
Sets the initial velocity of particles emitted. | |
virtual void | setPosition (const Vector3 &pos) |
Sets the position of this emitter relative to the particle system center. | |
virtual void | setRepeatDelay (Real duration) |
Sets the time between repeats of the emitter. | |
virtual void | setRepeatDelay (Real min, Real max) |
Sets the range of random duration for this emitter. | |
virtual void | setStartTime (Real startTime) |
Sets the 'start time' of this emitter. | |
virtual void | setTimeToLive (Real minTtl, Real maxTtl) |
Sets the range of lifetime for particles emitted. | |
virtual void | setTimeToLive (Real ttl) |
Sets the lifetime of all particles emitted. | |
virtual void | setUp (const Vector3 &up) |
Sets the notional up vector of the emitter. | |
![]() | |
StringInterface () | |
virtual | ~StringInterface () |
Virtual destructor, see Effective C++. | |
void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. | |
const ParamDictionary * | getParamDictionary (void) const |
String | getParameter (const String &name) const |
Generic parameter retrieval method. | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. | |
bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. | |
void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. | |
![]() | |
Particle () | |
void | _notifyOwner (ParticleSystem *owner) |
Internal method for notifying the particle of it's owner. | |
void | _notifyVisualData (ParticleVisualData *vis) |
Internal method for notifying the particle of it's optional visual data. | |
Real | getOwnHeight (void) const |
Retrieves the particle's personal width, if hasOwnDimensions is true. | |
Real | getOwnWidth (void) const |
Retrieves the particle's personal width, if hasOwnDimensions is true. | |
const Radian & | getRotation (void) const |
ParticleVisualData * | getVisualData (void) const |
bool | hasOwnDimensions (void) const |
Returns true if this particle deviates from the ParticleSystem's default dimensions (i.e. | |
void | resetDimensions (void) |
Utility method to reset this particle. | |
void | setDimensions (Real width, Real height) |
Sets the width and height for this particle. | |
void | setRotation (const Radian &rad) |
Sets the current rotation. | |
Additional Inherited Members | |
![]() | |
enum | ParticleType { Visual , Emitter } |
Type of particle. More... | |
![]() | |
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. | |
![]() | |
ColourValue | mColour |
Current colour. | |
Vector3 | mDirection |
Direction (and speed) | |
Real | mHeight |
Personal height if mOwnDimensions == true. | |
bool | mOwnDimensions |
Does this particle have it's own dimensions? | |
ParticleType | mParticleType |
Determines the type of particle. | |
Vector3 | mPosition |
World position. | |
Radian | mRotation |
Current rotation value. | |
Radian | mRotationSpeed |
Speed of rotation in radians/sec. | |
Real | mTimeToLive |
Time to live, number of seconds left of particles natural life. | |
Real | mTotalTimeToLive |
Total Time to live, number of seconds of particles natural life. | |
Real | mWidth |
Personal width if mOwnDimensions == true. | |
Particle emitter which emits particles randomly from points inside an area (box, sphere, ellipsoid whatever subclasses choose to be).
|
inline |
See ParticleEmitter.
Implements Ogre::ParticleEmitter.
Sets the size of the area from which particles are emitted.
size | Vector describing the size of the area. The area extends around the center point by half the x, y and z components of this vector. The box is aligned such that it's local Z axis points along it's direction (see setDirection) |
Sets the size of the area from which particles are emitted.
x,y,z | Individual axis lengths describing the size of the area. The area extends around the center point by half the x, y and z components of this vector. The box is aligned such that it's local Z axis points along it's direction (see setDirection) |