OGRE  1.7
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Ogre::ParticleEmitter Class Referenceabstract

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

#include <OgreParticleEmitter.h>

+ Inheritance diagram for Ogre::ParticleEmitter:
+ Collaboration diagram for Ogre::ParticleEmitter:

Public Types

enum  ParticleType { Visual, Emitter }
 Type of particle. More...
 

Public Member Functions

 ParticleEmitter (ParticleSystem *psys)
 
virtual ~ParticleEmitter ()
 Virtual destructor essential. 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)
 Initialises a particle based on the emitter's approach and parameters. More...
 
void _notifyOwner (ParticleSystem *owner)
 Internal method for notifying the particle of it's owner. More...
 
void _notifyVisualData (ParticleVisualData *vis)
 Internal method for notifying the particle of it's optional visual data. More...
 
virtual void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
virtual const RadiangetAngle (void) const
 Returns the maximum angle which the initial particle direction can deviate from the emitters base direction. More...
 
virtual const ColourValuegetColour (void) const
 Gets the colour of particles to be emitted. More...
 
virtual const ColourValuegetColourRangeEnd (void) const
 Gets the maximum colour of particles to be emitted. More...
 
virtual const ColourValuegetColourRangeStart (void) const
 Gets the minimum colour of particles to be emitted. More...
 
virtual const Vector3getDirection (void) const
 Returns the base direction of the emitter. 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 StringgetEmittedEmitter (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 StringgetName (void) const
 Returns the name of the emitter. More...
 
Real getOwnHeight (void) const
 Retrieves the particle's personal width, if hasOwnDimensions is true. More...
 
Real getOwnWidth (void) const
 Retrieves the particle's personal width, if hasOwnDimensions is true. More...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
virtual String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object. More...
 
virtual Real getParticleVelocity (void) const
 Returns the initial velocity of particles emitted. More...
 
virtual const Vector3getPosition (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...
 
const RadiangetRotation (void) const
 
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 StringgetType (void) const
 Returns the name of the type of emitter. More...
 
ParticleVisualDatagetVisualData (void) const
 Get the optional visual data associated with the class. More...
 
bool hasOwnDimensions (void) const
 Returns true if this particle deviates from the ParticleSystem's default dimensions (i.e. More...
 
virtual bool isEmitted (void) const
 Return true if the emitter is emitted by another emitter. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
void resetDimensions (void)
 Utility method to reset this particle. 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...
 
void setDimensions (Real width, Real height)
 Sets the width and height for this particle. More...
 
virtual void setDirection (const Vector3 &direction)
 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 bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
virtual void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method. 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 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...
 
void setRotation (const Radian &rad)
 Sets the current rotation. More...
 
virtual void setStartTime (Real startTime)
 Sets the 'start time' of 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...
 

Static Public Member Functions

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

ColourValue colour
 Current colour. More...
 
Vector3 direction
 Direction (and speed) More...
 
Real mHeight
 Personal height if mOwnDimensions == true. More...
 
bool mOwnDimensions
 Does this particle have it's own dimensions? More...
 
Real mWidth
 Personal width if mOwnDimensions == true. More...
 
ParticleType particleType
 Determines the type of particle. More...
 
Vector3 position
 World position. More...
 
Radian rotation
 Current rotation value. More...
 
Radian rotationSpeed
 Speed of rotation in radians/sec. More...
 
Real timeToLive
 Time to live, number of seconds left of particles natural life. More...
 
Real totalTimeToLive
 Total Time to live, number of seconds of particles natural life. More...
 

Protected Member Functions

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...
 
virtual unsigned short genConstantEmissionCount (Real timeElapsed)
 Internal utility method for generating an emission count based on a constant emission rate. More...
 
virtual void genEmissionColour (ColourValue &destColour)
 Internal utility method for generating a colour for a particle. More...
 
virtual void genEmissionDirection (Vector3 &destVector)
 Internal utility method for generating particle exit direction. More...
 
virtual Real genEmissionTTL (void)
 Internal utility method for generating a time-to-live for a particle. More...
 
virtual void genEmissionVelocity (Vector3 &destVector)
 Internal utility method to apply velocity to a particle direction. More...
 
void initDurationRepeat (void)
 Internal method for initialising the duration & repeat of an emitter. More...
 

Protected Attributes

Radian mAngle
 Angle around direction which particles may be emitted, internally radians but angleunits for interface. More...
 
ColourValue mColourRangeEnd
 Initial colour of particles (range end) More...
 
ColourValue mColourRangeStart
 Initial colour of particles (range start) More...
 
Vector3 mDirection
 Base direction of the emitter, may not be used by some emitters. More...
 
Real mDurationMax
 Maximum length of time the emitter will run for (0 = forever) More...
 
Real mDurationMin
 Minimum length of time emitter will run for (0 = forever) More...
 
Real mDurationRemain
 Current duration remainder. More...
 
Real mEmissionRate
 Rate in particles per second at which this emitter wishes to emit particles. More...
 
bool mEmitted
 
String mEmittedEmitter
 The name of the emitter to be emitted (optional) More...
 
bool mEnabled
 Whether this emitter is currently enabled (defaults to true) More...
 
Real mMaxSpeed
 Max speed of particles. More...
 
Real mMaxTTL
 Initial time-to-live of particles (max) More...
 
Real mMinSpeed
 Min speed of particles. More...
 
Real mMinTTL
 Initial time-to-live of particles (min) More...
 
String mName
 The name of the emitter. The name is optional unless it is used as an emitter that is emitted itself. More...
 
ParticleSystemmParent
 Parent particle system. More...
 
ParticleSystemmParentSystem
 Parent ParticleSystem. More...
 
Vector3 mPosition
 Position relative to the center of the ParticleSystem. More...
 
Real mRemainder
 
Real mRepeatDelayMax
 
Real mRepeatDelayMin
 Time between each repeat. More...
 
Real mRepeatDelayRemain
 Repeat delay left. More...
 
Real mStartTime
 Start time (in seconds from start of first call to ParticleSystem to update) More...
 
String mType
 Name of the type of emitter, MUST be initialised by subclasses. More...
 
Vector3 mUp
 
ParticleVisualDatamVisual
 Additional visual data you might want to associate with the Particle. More...
 

Static Protected Attributes

static EmitterCommands::CmdAngle msAngleCmd
 
static EmitterCommands::CmdColour msColourCmd
 
static
EmitterCommands::CmdColourRangeEnd 
msColourRangeEndCmd
 
static
EmitterCommands::CmdColourRangeStart 
msColourRangeStartCmd
 
static
EmitterCommands::CmdDirection 
msDirectionCmd
 
static EmitterCommands::CmdDuration msDurationCmd
 
static
EmitterCommands::CmdEmissionRate 
msEmissionRateCmd
 
static
EmitterCommands::CmdEmittedEmitter 
msEmittedEmitterCmd
 
static
EmitterCommands::CmdMaxDuration 
msMaxDurationCmd
 
static
EmitterCommands::CmdMaxRepeatDelay 
msMaxRepeatDelayCmd
 
static EmitterCommands::CmdMaxTTL msMaxTTLCmd
 
static
EmitterCommands::CmdMaxVelocity 
msMaxVelocityCmd
 
static
EmitterCommands::CmdMinDuration 
msMinDurationCmd
 
static
EmitterCommands::CmdMinRepeatDelay 
msMinRepeatDelayCmd
 
static EmitterCommands::CmdMinTTL msMinTTLCmd
 
static
EmitterCommands::CmdMinVelocity 
msMinVelocityCmd
 
static EmitterCommands::CmdName msNameCmd
 
static EmitterCommands::CmdPosition msPositionCmd
 
static
EmitterCommands::CmdRepeatDelay 
msRepeatDelayCmd
 
static EmitterCommands::CmdTTL msTTLCmd
 
static EmitterCommands::CmdVelocity msVelocityCmd
 

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.

Definition at line 71 of file OgreParticleEmitter.h.

Member Enumeration Documentation

Type of particle.

Enumerator
Visual 
Emitter 

Definition at line 69 of file OgreParticle.h.

Constructor & Destructor Documentation

Ogre::ParticleEmitter::ParticleEmitter ( ParticleSystem psys)
virtual 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, and Ogre::PointEmitter.

virtual void Ogre::ParticleEmitter::_initParticle ( Particle pParticle)
inlinevirtual

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
pParticlePointer 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::HollowEllipsoidEmitter, Ogre::RingEmitter, Ogre::CylinderEmitter, Ogre::EllipsoidEmitter, Ogre::BoxEmitter, and Ogre::PointEmitter.

Definition at line 376 of file OgreParticleEmitter.h.

References Ogre::Particle::resetDimensions().

void Ogre::Particle::_notifyOwner ( ParticleSystem owner)
inherited

Internal method for notifying the particle of it's owner.

void Ogre::Particle::_notifyVisualData ( ParticleVisualData vis)
inlineinherited

Internal method for notifying the particle of it's optional visual data.

Definition at line 141 of file OgreParticle.h.

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.
static void Ogre::StringInterface::cleanupDictionary ( )
staticinherited

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.

MaterialManager) initializes.

virtual void Ogre::StringInterface::copyParametersTo ( StringInterface dest) const
inlinevirtualinherited

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
destPointer to object to have it's parameters set the same as this object.

Definition at line 301 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

bool Ogre::StringInterface::createParamDictionary ( const String className)
inlineprotectedinherited

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
classNamethe name of the class using the dictionary
Returns
true if a new dictionary was created, false if it was already there

Definition at line 184 of file OgreStringInterface.h.

References OGRE_LOCK_MUTEX.

virtual unsigned short Ogre::ParticleEmitter::genConstantEmissionCount ( Real  timeElapsed)
protectedvirtual

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

virtual void Ogre::ParticleEmitter::genEmissionColour ( ColourValue destColour)
protectedvirtual

Internal utility method for generating a colour for a particle.

virtual void Ogre::ParticleEmitter::genEmissionDirection ( Vector3 destVector)
protectedvirtual

Internal utility method for generating particle exit direction.

Parameters
destVectorReference to vector to complete with new direction (normalised)
virtual Real Ogre::ParticleEmitter::genEmissionTTL ( void  )
protectedvirtual

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

virtual void Ogre::ParticleEmitter::genEmissionVelocity ( Vector3 destVector)
protectedvirtual

Internal utility method to apply velocity to a particle direction.

Parameters
destVectorThe vector to scale by a randomly generated scale between min and max speed. Assumed normalised already, and likely already oriented in the right direction.
virtual const Radian& Ogre::ParticleEmitter::getAngle ( void  ) const
virtual

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

virtual const ColourValue& Ogre::ParticleEmitter::getColour ( void  ) const
virtual

Gets the colour of particles to be emitted.

virtual const ColourValue& Ogre::ParticleEmitter::getColourRangeEnd ( void  ) const
virtual

Gets the maximum colour of particles to be emitted.

virtual const ColourValue& Ogre::ParticleEmitter::getColourRangeStart ( void  ) const
virtual

Gets the minimum colour of particles to be emitted.

virtual const Vector3& Ogre::ParticleEmitter::getDirection ( void  ) const
virtual

Returns the base direction of the emitter.

virtual Real Ogre::ParticleEmitter::getDuration ( void  ) const
virtual

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

virtual Real Ogre::ParticleEmitter::getEmissionRate ( void  ) const
virtual

Returns the emission rate set for this emitter.

const String& Ogre::ParticleEmitter::getEmittedEmitter ( void  ) const

Returns the name of the emitter to be emitted.

virtual bool Ogre::ParticleEmitter::getEnabled ( void  ) const
virtual

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

virtual Real Ogre::ParticleEmitter::getMaxDuration ( void  ) const
virtual

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

virtual Real Ogre::ParticleEmitter::getMaxParticleVelocity ( void  ) const
virtual

Returns the maximum particle velocity.

virtual Real Ogre::ParticleEmitter::getMaxRepeatDelay ( void  ) const
virtual

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

virtual Real Ogre::ParticleEmitter::getMaxTimeToLive ( void  ) const
virtual

Gets the maximum time each particle will live for.

virtual Real Ogre::ParticleEmitter::getMinDuration ( void  ) const
virtual

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

virtual Real Ogre::ParticleEmitter::getMinParticleVelocity ( void  ) const
virtual

Returns the minimum particle velocity.

virtual Real Ogre::ParticleEmitter::getMinRepeatDelay ( void  ) const
virtual

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

virtual Real Ogre::ParticleEmitter::getMinTimeToLive ( void  ) const
virtual

Gets the minimum time each particle will live for.

const String& Ogre::ParticleEmitter::getName ( void  ) const

Returns the name of the emitter.

Real Ogre::Particle::getOwnHeight ( void  ) const
inlineinherited

Retrieves the particle's personal width, if hasOwnDimensions is true.

Definition at line 128 of file OgreParticle.h.

Real Ogre::Particle::getOwnWidth ( void  ) const
inlineinherited

Retrieves the particle's personal width, if hasOwnDimensions is true.

Definition at line 125 of file OgreParticle.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  )
inlineinherited

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.

Definition at line 217 of file OgreStringInterface.h.

const ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  ) const
inlineinherited

Definition at line 222 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter ( const String name) const
inlinevirtualinherited

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
nameThe name of the parameter to get
Returns
String value of parameter, blank if not found

Definition at line 270 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().

const ParameterList& Ogre::StringInterface::getParameters ( void  ) const
inherited

Retrieves a list of parameters valid for this object.

Returns
A reference to a static list of ParameterDef objects.
virtual Real Ogre::ParticleEmitter::getParticleVelocity ( void  ) const
virtual

Returns the initial velocity of particles emitted.

virtual const Vector3& Ogre::ParticleEmitter::getPosition ( void  ) const
virtual

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

virtual Real Ogre::ParticleEmitter::getRepeatDelay ( void  ) const
virtual

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

const Radian& Ogre::Particle::getRotation ( void  ) const
inlineinherited

Definition at line 133 of file OgreParticle.h.

virtual Real Ogre::ParticleEmitter::getStartTime ( void  ) const
virtual

Gets the start time of the emitter.

virtual Real Ogre::ParticleEmitter::getTimeToLive ( void  ) const
virtual

Gets the time each particle will live for.

const String& Ogre::ParticleEmitter::getType ( void  ) const
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.

Definition at line 387 of file OgreParticleEmitter.h.

ParticleVisualData* Ogre::Particle::getVisualData ( void  ) const
inlineinherited

Get the optional visual data associated with the class.

Definition at line 144 of file OgreParticle.h.

bool Ogre::Particle::hasOwnDimensions ( void  ) const
inlineinherited

Returns true if this particle deviates from the ParticleSystem's default dimensions (i.e.

if the particle::setDimensions method has been called for this instance).

See also
particle::setDimensions

Definition at line 122 of file OgreParticle.h.

void Ogre::ParticleEmitter::initDurationRepeat ( void  )
protected

Internal method for initialising the duration & repeat of an emitter.

virtual bool Ogre::ParticleEmitter::isEmitted ( void  ) const
virtual

Return true if the emitter is emitted by another emitter.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 90 of file OgreMemoryAllocatedObject.h.

void Ogre::Particle::resetDimensions ( void  )
inherited

Utility method to reset this particle.

Referenced by _initParticle().

virtual void Ogre::ParticleEmitter::setAngle ( const Radian angle)
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, whereas if you set it to 180 degrees or more, particles will be emitted in a sphere, i.e. in all directions.
Parameters
degreesMaximum angle which initial particle direction can deviate from the emitter base direction vector.
virtual 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
colourThe colour which all particles will be given on emission.
virtual 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
colourStartThe start of the colour range
colourEndThe end of the colour range
virtual void Ogre::ParticleEmitter::setColourRangeEnd ( const ColourValue colour)
virtual

Sets the maximum colour of particles to be emitted.

virtual void Ogre::ParticleEmitter::setColourRangeStart ( const ColourValue colour)
virtual

Sets the minimum colour of particles to be emitted.

void Ogre::Particle::setDimensions ( Real  width,
Real  height 
)
inherited

Sets the width and height for this particle.

Remarks
Note that it is most efficient for every particle in a ParticleSystem to have the same dimensions. If you choose to alter the dimensions of an individual particle the set will be less efficient. Do not call this method unless you really need to have different particle dimensions within the same set. Otherwise just call the ParticleSystem::setDefaultDimensions method instead.
virtual 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
directionThe base direction for particles emitted.

Reimplemented in Ogre::AreaEmitter.

virtual 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
durationThe duration in seconds.
virtual 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
minThe minimum duration in seconds.
maxThe minimum duration in seconds.
virtual 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
particlesPerSecondThe number of particles to be emitted every second.
virtual void Ogre::ParticleEmitter::setEmitted ( bool  emitted)
virtual

Set the indication (true/false) to indicate that the emitter is emitted by another emitter.

virtual void Ogre::ParticleEmitter::setEmittedEmitter ( const String emittedEmitter)
virtual

Sets the name of the emitter to be emitted.

virtual 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.
virtual void Ogre::ParticleEmitter::setMaxDuration ( Real  max)
virtual

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

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

Returns the maximum particle velocity.

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

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

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

Sets the maximum time each particle will live for.

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

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

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

Returns the minimum particle velocity.

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

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

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

Sets the minimum time each particle will live for.

virtual void Ogre::ParticleEmitter::setName ( const String newName)
virtual

Sets the name of the emitter.

virtual bool Ogre::StringInterface::setParameter ( const String name,
const String value 
)
virtualinherited

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
nameThe name of the parameter to set
valueString 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)

Referenced by Ogre::StringInterface::copyParametersTo().

virtual void Ogre::StringInterface::setParameterList ( const NameValuePairList paramList)
virtualinherited

Generic multiple parameter setting method.

Remarks
Call this method with a list of name / value pairs 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
paramListName/value pair list
virtual 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
speedThe initial speed in world units per second which every particle emitted starts with.
virtual 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
maxThe maximum speed in world units per second for the initial particle speed on emission.
minThe minimum speed in world units per second for the initial particle speed on emission.
virtual void Ogre::ParticleEmitter::setPosition ( const Vector3 pos)
virtual

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

virtual 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
durationThe duration in seconds.
virtual 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
minThe minimum duration in seconds.
maxThe minimum duration in seconds.
void Ogre::Particle::setRotation ( const Radian rad)
inherited

Sets the current rotation.

virtual 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
startTimeThe time in seconds from the creation or enabling of the emitter.
virtual 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
ttlThe number of seconds each particle will live for.
virtual 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
minTtlThe minimum number of seconds each particle will live for.
maxTtlThe maximum number of seconds each particle will live for.

Member Data Documentation

ColourValue Ogre::Particle::colour
inherited

Current colour.

Definition at line 90 of file OgreParticle.h.

Vector3 Ogre::Particle::direction
inherited

Direction (and speed)

Definition at line 88 of file OgreParticle.h.

Radian Ogre::ParticleEmitter::mAngle
protected

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

Definition at line 112 of file OgreParticleEmitter.h.

ColourValue Ogre::ParticleEmitter::mColourRangeEnd
protected

Initial colour of particles (range end)

Definition at line 124 of file OgreParticleEmitter.h.

ColourValue Ogre::ParticleEmitter::mColourRangeStart
protected

Initial colour of particles (range start)

Definition at line 122 of file OgreParticleEmitter.h.

Vector3 Ogre::ParticleEmitter::mDirection
protected

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

Definition at line 108 of file OgreParticleEmitter.h.

Real Ogre::ParticleEmitter::mDurationMax
protected

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

Definition at line 134 of file OgreParticleEmitter.h.

Real Ogre::ParticleEmitter::mDurationMin
protected

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

Definition at line 132 of file OgreParticleEmitter.h.

Real Ogre::ParticleEmitter::mDurationRemain
protected

Current duration remainder.

Definition at line 136 of file OgreParticleEmitter.h.

Real Ogre::ParticleEmitter::mEmissionRate
protected

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

Definition at line 104 of file OgreParticleEmitter.h.

bool Ogre::ParticleEmitter::mEmitted
protected

Definition at line 155 of file OgreParticleEmitter.h.

String Ogre::ParticleEmitter::mEmittedEmitter
protected

The name of the emitter to be emitted (optional)

Definition at line 151 of file OgreParticleEmitter.h.

bool Ogre::ParticleEmitter::mEnabled
protected

Whether this emitter is currently enabled (defaults to true)

Definition at line 127 of file OgreParticleEmitter.h.

Real Ogre::Particle::mHeight
inherited

Personal height if mOwnDimensions == true.

Definition at line 80 of file OgreParticle.h.

Real Ogre::ParticleEmitter::mMaxSpeed
protected

Max speed of particles.

Definition at line 116 of file OgreParticleEmitter.h.

Real Ogre::ParticleEmitter::mMaxTTL
protected

Initial time-to-live of particles (max)

Definition at line 120 of file OgreParticleEmitter.h.

Real Ogre::ParticleEmitter::mMinSpeed
protected

Min speed of particles.

Definition at line 114 of file OgreParticleEmitter.h.

Real Ogre::ParticleEmitter::mMinTTL
protected

Initial time-to-live of particles (min)

Definition at line 118 of file OgreParticleEmitter.h.

String Ogre::ParticleEmitter::mName
protected

The name of the emitter. The name is optional unless it is used as an emitter that is emitted itself.

Definition at line 148 of file OgreParticleEmitter.h.

bool Ogre::Particle::mOwnDimensions
inherited

Does this particle have it's own dimensions?

Definition at line 76 of file OgreParticle.h.

ParticleSystem* Ogre::ParticleEmitter::mParent
protected

Parent particle system.

Definition at line 100 of file OgreParticleEmitter.h.

ParticleSystem* Ogre::Particle::mParentSystem
protectedinherited

Parent ParticleSystem.

Definition at line 64 of file OgreParticle.h.

Vector3 Ogre::ParticleEmitter::mPosition
protected

Position relative to the center of the ParticleSystem.

Definition at line 102 of file OgreParticleEmitter.h.

Real Ogre::ParticleEmitter::mRemainder
protected

Definition at line 145 of file OgreParticleEmitter.h.

Real Ogre::ParticleEmitter::mRepeatDelayMax
protected

Definition at line 140 of file OgreParticleEmitter.h.

Real Ogre::ParticleEmitter::mRepeatDelayMin
protected

Time between each repeat.

Definition at line 139 of file OgreParticleEmitter.h.

Real Ogre::ParticleEmitter::mRepeatDelayRemain
protected

Repeat delay left.

Definition at line 142 of file OgreParticleEmitter.h.

EmitterCommands::CmdAngle Ogre::ParticleEmitter::msAngleCmd
staticprotected

Definition at line 76 of file OgreParticleEmitter.h.

EmitterCommands::CmdColour Ogre::ParticleEmitter::msColourCmd
staticprotected

Definition at line 77 of file OgreParticleEmitter.h.

EmitterCommands::CmdColourRangeEnd Ogre::ParticleEmitter::msColourRangeEndCmd
staticprotected

Definition at line 79 of file OgreParticleEmitter.h.

EmitterCommands::CmdColourRangeStart Ogre::ParticleEmitter::msColourRangeStartCmd
staticprotected

Definition at line 78 of file OgreParticleEmitter.h.

EmitterCommands::CmdDirection Ogre::ParticleEmitter::msDirectionCmd
staticprotected

Definition at line 80 of file OgreParticleEmitter.h.

EmitterCommands::CmdDuration Ogre::ParticleEmitter::msDurationCmd
staticprotected

Definition at line 89 of file OgreParticleEmitter.h.

EmitterCommands::CmdEmissionRate Ogre::ParticleEmitter::msEmissionRateCmd
staticprotected

Definition at line 81 of file OgreParticleEmitter.h.

EmitterCommands::CmdEmittedEmitter Ogre::ParticleEmitter::msEmittedEmitterCmd
staticprotected

Definition at line 96 of file OgreParticleEmitter.h.

EmitterCommands::CmdMaxDuration Ogre::ParticleEmitter::msMaxDurationCmd
staticprotected

Definition at line 91 of file OgreParticleEmitter.h.

EmitterCommands::CmdMaxRepeatDelay Ogre::ParticleEmitter::msMaxRepeatDelayCmd
staticprotected

Definition at line 94 of file OgreParticleEmitter.h.

EmitterCommands::CmdMaxTTL Ogre::ParticleEmitter::msMaxTTLCmd
staticprotected

Definition at line 82 of file OgreParticleEmitter.h.

EmitterCommands::CmdMaxVelocity Ogre::ParticleEmitter::msMaxVelocityCmd
staticprotected

Definition at line 83 of file OgreParticleEmitter.h.

EmitterCommands::CmdMinDuration Ogre::ParticleEmitter::msMinDurationCmd
staticprotected

Definition at line 90 of file OgreParticleEmitter.h.

EmitterCommands::CmdMinRepeatDelay Ogre::ParticleEmitter::msMinRepeatDelayCmd
staticprotected

Definition at line 93 of file OgreParticleEmitter.h.

EmitterCommands::CmdMinTTL Ogre::ParticleEmitter::msMinTTLCmd
staticprotected

Definition at line 84 of file OgreParticleEmitter.h.

EmitterCommands::CmdMinVelocity Ogre::ParticleEmitter::msMinVelocityCmd
staticprotected

Definition at line 85 of file OgreParticleEmitter.h.

EmitterCommands::CmdName Ogre::ParticleEmitter::msNameCmd
staticprotected

Definition at line 95 of file OgreParticleEmitter.h.

EmitterCommands::CmdPosition Ogre::ParticleEmitter::msPositionCmd
staticprotected

Definition at line 86 of file OgreParticleEmitter.h.

EmitterCommands::CmdRepeatDelay Ogre::ParticleEmitter::msRepeatDelayCmd
staticprotected

Definition at line 92 of file OgreParticleEmitter.h.

Real Ogre::ParticleEmitter::mStartTime
protected

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

Definition at line 130 of file OgreParticleEmitter.h.

EmitterCommands::CmdTTL Ogre::ParticleEmitter::msTTLCmd
staticprotected

Definition at line 87 of file OgreParticleEmitter.h.

EmitterCommands::CmdVelocity Ogre::ParticleEmitter::msVelocityCmd
staticprotected

Definition at line 88 of file OgreParticleEmitter.h.

String Ogre::ParticleEmitter::mType
protected

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

Definition at line 106 of file OgreParticleEmitter.h.

Vector3 Ogre::ParticleEmitter::mUp
protected

Definition at line 110 of file OgreParticleEmitter.h.

ParticleVisualData* Ogre::Particle::mVisual
protectedinherited

Additional visual data you might want to associate with the Particle.

Definition at line 66 of file OgreParticle.h.

Real Ogre::Particle::mWidth
inherited

Personal width if mOwnDimensions == true.

Definition at line 78 of file OgreParticle.h.

ParticleType Ogre::Particle::particleType
inherited

Determines the type of particle.

Definition at line 98 of file OgreParticle.h.

Vector3 Ogre::Particle::position
inherited

World position.

Definition at line 86 of file OgreParticle.h.

Radian Ogre::Particle::rotation
inherited

Current rotation value.

Definition at line 82 of file OgreParticle.h.

Radian Ogre::Particle::rotationSpeed
inherited

Speed of rotation in radians/sec.

Definition at line 96 of file OgreParticle.h.

Real Ogre::Particle::timeToLive
inherited

Time to live, number of seconds left of particles natural life.

Definition at line 92 of file OgreParticle.h.

Real Ogre::Particle::totalTimeToLive
inherited

Total Time to live, number of seconds of particles natural life.

Definition at line 94 of file OgreParticle.h.


The documentation for this class was generated from the following file: