|
OGRE
1.9.0
|
Abstract class defining the interface to be implemented by particle emitters. More...
#include <OgreParticleEmitter.h>

Public Types | |
| enum | ParticleType { Visual , Emitter } |
| Type of particle. More... | |
Public Member Functions | |
| ParticleEmitter (ParticleSystem *psys) | |
| virtual | ~ParticleEmitter () |
| Virtual destructor essential. | |
| virtual unsigned short | _getEmissionCount (Real timeElapsed)=0 |
| Gets the number of particles which this emitter would like to emit based on the time elapsed. | |
| virtual void | _initParticle (Particle *pParticle) |
| Initialises a particle based on the emitter's approach and parameters. | |
| 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. | |
| virtual void | copyParametersTo (StringInterface *dest) const |
| Method for copying this object's parameters to another object. | |
| 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. | |
| 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. | |
| ParamDictionary * | getParamDictionary (void) |
| Retrieves the parameter dictionary for this class. | |
| const ParamDictionary * | getParamDictionary (void) const |
| virtual String | getParameter (const String &name) const |
| Generic parameter retrieval method. | |
| const ParameterList & | getParameters (void) const |
| Retrieves a list of parameters valid for this object. | |
| 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. | |
| const Radian & | getRotation (void) const |
| 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. | |
| ParticleVisualData * | getVisualData (void) const |
| Get the optional visual data associated with the class. | |
| bool | hasOwnDimensions (void) const |
| Returns true if this particle deviates from the ParticleSystem's default dimensions (i.e. | |
| virtual bool | isEmitted (void) const |
| Return true if the emitter is emitted by another emitter. | |
| void | operator delete (void *ptr) |
| void | operator delete (void *ptr) |
| void | operator delete (void *ptr, const char *, int, const char *) |
| void | operator delete (void *ptr, const char *, int, const char *) |
| void | operator delete (void *ptr, void *) |
| void | operator delete (void *ptr, void *) |
| void | operator delete[] (void *ptr) |
| void | operator delete[] (void *ptr) |
| void | operator delete[] (void *ptr, const char *, int, const char *) |
| void | operator delete[] (void *ptr, const char *, int, const char *) |
| void * | operator new (size_t sz) |
| void * | operator new (size_t sz) |
| void * | operator new (size_t sz, const char *file, int line, const char *func) |
| operator new, with debug line info | |
| void * | operator new (size_t sz, const char *file, int line, const char *func) |
| operator new, with debug line info | |
| void * | operator new (size_t sz, void *ptr) |
| placement operator new | |
| void * | operator new (size_t sz, void *ptr) |
| placement operator new | |
| void * | operator new[] (size_t sz) |
| void * | operator new[] (size_t sz) |
| void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
| array operator new, with debug line info | |
| void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
| array operator new, with debug line info | |
| void | resetDimensions (void) |
| Utility method to reset this particle. | |
| 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. | |
| void | setDimensions (Real width, Real height) |
| Sets the width and height for this particle. | |
| virtual void | setDirection (const Vector3 &direction) |
| Sets the direction of the emitter. | |
| 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 bool | setParameter (const String &name, const String &value) |
| Generic parameter setting method. | |
| virtual void | setParameterList (const NameValuePairList ¶mList) |
| Generic multiple parameter setting method. | |
| 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. | |
| void | setRotation (const Radian &rad) |
| Sets the current rotation. | |
| 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. | |
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. | |
Public Attributes | |
| ColourValue | colour |
| Current colour. | |
| Vector3 | direction |
| Direction (and speed) | |
| Real | mHeight |
| Personal height if mOwnDimensions == true. | |
| bool | mOwnDimensions |
| Does this particle have it's own dimensions? | |
| Real | mWidth |
| Personal width if mOwnDimensions == true. | |
| ParticleType | particleType |
| Determines the type of particle. | |
| Vector3 | position |
| World position. | |
| Radian | rotation |
| Current rotation value. | |
| Radian | rotationSpeed |
| Speed of rotation in radians/sec. | |
| Real | timeToLive |
| Time to live, number of seconds left of particles natural life. | |
| Real | totalTimeToLive |
| Total Time to live, number of seconds of particles natural life. | |
Protected Member Functions | |
| void | addBaseParameters (void) |
| Internal method for setting up the basic parameter definitions for a subclass. | |
| bool | createParamDictionary (const String &className) |
| Internal method for creating a parameter dictionary for the class, if it does not already exist. | |
| virtual unsigned short | genConstantEmissionCount (Real timeElapsed) |
| Internal utility method for generating an emission count based on a constant emission rate. | |
| virtual void | genEmissionColour (ColourValue &destColour) |
| Internal utility method for generating a colour for a particle. | |
| virtual void | genEmissionDirection (const Vector3 &particlePos, Vector3 &destVector) |
| Internal utility method for generating particle exit direction. | |
| virtual Real | genEmissionTTL (void) |
| Internal utility method for generating a time-to-live for a particle. | |
| virtual void | genEmissionVelocity (Vector3 &destVector) |
| Internal utility method to apply velocity to a particle direction. | |
| void | initDurationRepeat (void) |
| Internal method for initialising the duration & repeat of an emitter. | |
Protected Attributes | |
| Radian | mAngle |
| Angle around direction which particles may be emitted, internally radians but angleunits for interface. | |
| ColourValue | mColourRangeEnd |
| Initial colour of particles (range end) | |
| ColourValue | mColourRangeStart |
| Initial colour of particles (range start) | |
| Vector3 | mDirection |
| Base direction of the emitter, may not be used by some emitters. | |
| Vector3 | mDirPositionRef |
| Real | mDurationMax |
| Maximum length of time the emitter will run for (0 = forever) | |
| Real | mDurationMin |
| Minimum length of time emitter will run for (0 = forever) | |
| Real | mDurationRemain |
| Current duration remainder. | |
| Real | mEmissionRate |
| Rate in particles per second at which this emitter wishes to emit particles. | |
| bool | mEmitted |
| String | mEmittedEmitter |
| The name of the emitter to be emitted (optional) | |
| bool | mEnabled |
| Whether this emitter is currently enabled (defaults to true) | |
| Real | mMaxSpeed |
| Max speed of particles. | |
| Real | mMaxTTL |
| Initial time-to-live of particles (max) | |
| Real | mMinSpeed |
| Min speed of particles. | |
| Real | mMinTTL |
| Initial time-to-live of particles (min) | |
| String | mName |
| The name of the emitter. The name is optional unless it is used as an emitter that is emitted itself. | |
| ParticleSystem * | mParent |
| Parent particle system. | |
| ParticleSystem * | mParentSystem |
| Parent ParticleSystem. | |
| Vector3 | mPosition |
| Position relative to the center of the ParticleSystem. | |
| Real | mRemainder |
| Real | mRepeatDelayMax |
| Real | mRepeatDelayMin |
| Time between each repeat. | |
| Real | mRepeatDelayRemain |
| Repeat delay left. | |
| Real | mStartTime |
| Start time (in seconds from start of first call to ParticleSystem to update) | |
| String | mType |
| Name of the type of emitter, MUST be initialised by subclasses. | |
| Vector3 | mUp |
| Notional up vector, used to speed up generation of variant directions, and also to orient some emitters. | |
| bool | mUseDirPositionRef |
| When true, mDirPositionRef is used instead of mDirection to generate particles. | |
| ParticleVisualData * | mVisual |
| Additional visual data you might want to associate with the Particle. | |
Private Member Functions | |
| OGRE_STATIC_MUTEX (msDictionaryMutex) | |
Private Attributes | |
| ParamDictionary * | mParamDict |
| String | mParamDictName |
| Class name for this instance to be used as a lookup (must be initialised by subclasses) | |
Static Private Attributes | |
| static ParamDictionaryMap | msDictionary |
| Dictionary of parameters. | |
Abstract class defining the interface to be implemented by particle emitters.
Definition at line 72 of file OgreParticleEmitter.h.
|
inherited |
| Ogre::ParticleEmitter::ParticleEmitter | ( | ParticleSystem * | psys | ) |
|
virtual |
Virtual destructor essential.
|
pure virtual |
Gets the number of particles which this emitter would like to emit based on the time elapsed.
|
virtual |
Initialises a particle based on the emitter's approach and 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. |
Definition at line 420 of file OgreParticleEmitter.h.
References Ogre::Particle::Particle(), and Ogre::Particle::resetDimensions().
|
inherited |
Internal method for notifying the particle of it's owner.
|
inherited |
Internal method for notifying the particle of it's optional visual data.
Definition at line 142 of file OgreParticle.h.
References mVisual.
|
protected |
Internal method for setting up the basic parameter definitions for a subclass.
|
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.
|
virtualinherited |
Method for copying this object's parameters to another object.
| dest | Pointer to object to have it's parameters set the same as this object. |
Definition at line 303 of file OgreStringInterface.h.
References StringInterface(), getParamDictionary(), getParameter(), Ogre::ParamDictionary::mParamDefs, and setParameter().
|
protectedinherited |
Internal method for creating a parameter dictionary for the class, if it does not already exist.
| className | the name of the class using the dictionary |
Definition at line 186 of file OgreStringInterface.h.
References mParamDict, mParamDictName, msDictionary, and OGRE_LOCK_MUTEX.
|
protectedvirtual |
Internal utility method for generating an emission count based on a constant emission rate.
|
protectedvirtual |
Internal utility method for generating a colour for a particle.
|
protectedvirtual |
Internal utility method for generating particle exit direction.
| destVector | Reference to vector to complete with new direction (normalised) |
|
protectedvirtual |
Internal utility method for generating a time-to-live for a particle.
|
protectedvirtual |
Internal utility method to apply velocity to a particle direction.
| 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. |
|
virtual |
Returns the maximum angle which the initial particle direction can deviate from the emitters base direction.
|
virtual |
Gets the colour of particles to be emitted.
|
virtual |
Gets the maximum colour of particles to be emitted.
|
virtual |
Gets the minimum colour of particles to be emitted.
|
virtual |
Returns the base direction of the emitter.
|
virtual |
Returns the position reference to generate direction of emitted particles.
|
virtual |
Returns whether direction or position reference is used.
|
virtual |
Gets the duration of the emitter from when it is created or re-enabled.
|
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 |
Gets the flag indicating if this emitter is enabled or not.
|
virtual |
Gets the maximum duration of this emitter in seconds (see setDuration for more details)
|
virtual |
Returns the maximum particle velocity.
|
virtual |
Gets the maximum duration of this emitter in seconds (see setRepeatDelay for more details)
|
virtual |
Gets the maximum time each particle will live for.
|
virtual |
Gets the minimum duration of this emitter in seconds (see setDuration for more details)
|
virtual |
Returns the minimum particle velocity.
|
virtual |
Gets the minimum duration of this emitter in seconds (see setRepeatDelay for more details)
|
virtual |
Gets the minimum time each particle will live for.
| const String & Ogre::ParticleEmitter::getName | ( | void | ) | const |
Returns the name of the emitter.
|
inherited |
Retrieves the particle's personal width, if hasOwnDimensions is true.
Definition at line 129 of file OgreParticle.h.
References mHeight.
|
inherited |
Retrieves the particle's personal width, if hasOwnDimensions is true.
Definition at line 126 of file OgreParticle.h.
References mWidth.
|
inherited |
Retrieves the parameter dictionary for this class.
Definition at line 219 of file OgreStringInterface.h.
References mParamDict.
Referenced by copyParametersTo(), and getParameter().
|
inherited |
Definition at line 224 of file OgreStringInterface.h.
References mParamDict.
Generic parameter retrieval method.
| name | The name of the parameter to get |
Definition at line 272 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), Ogre::ParamDictionary::getParamCommand(), and getParamDictionary().
Referenced by copyParametersTo().
|
inherited |
Retrieves a list of parameters valid for this object.
|
virtual |
Returns the initial velocity of particles emitted.
|
virtual |
Returns the position of this emitter relative to the center of the particle system.
|
virtual |
Gets the duration of the emitter from when it is created or re-enabled.
|
inherited |
Definition at line 134 of file OgreParticle.h.
References rotation.
|
virtual |
Gets the start time of the emitter.
|
virtual |
Gets the time each particle will live for.
| const String & Ogre::ParticleEmitter::getType | ( | void | ) | const |
Returns the name of the type of emitter.
Definition at line 431 of file OgreParticleEmitter.h.
References mType.
|
virtual |
Returns the up vector of the emitter.
|
inherited |
Get the optional visual data associated with the class.
Definition at line 145 of file OgreParticle.h.
References mVisual.
|
inherited |
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).
Definition at line 123 of file OgreParticle.h.
References mOwnDimensions.
|
protected |
Internal method for initialising the duration & repeat of an emitter.
|
virtual |
Return true if the emitter is emitted by another emitter.
|
privateinherited |
|
inherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inherited |
Utility method to reset this particle.
Referenced by Ogre::ParticleEmitter::_initParticle().
|
virtual |
Sets the maximum angle away from the emitter direction which particle will be emitted.
| angle | Maximum angle which initial particle direction can deviate from the emitter base direction vector. |
|
virtual |
Sets the initial colour of particles emitted.
| colour | The colour which all particles will be given on emission. |
References Ogre::Particle::colour.
|
virtual |
Sets the range of colours for emitted particles.
| colourStart | The start of the colour range |
| colourEnd | The end of the colour range |
|
virtual |
Sets the maximum colour of particles to be emitted.
References Ogre::Particle::colour.
|
virtual |
Sets the minimum colour of particles to be emitted.
References Ogre::Particle::colour.
Sets the width and height for this particle.
|
virtual |
Sets the direction of the emitter.
| direction | The base direction for particles emitted. |
References Ogre::Particle::direction.
|
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 |
References Ogre::Particle::position.
|
virtual |
Sets the duration of the emitter.
| duration | The duration in seconds. |
Sets the range of random duration for this emitter.
| min | The minimum duration in seconds. |
| max | The minimum duration in seconds. |
|
virtual |
Sets the emission rate for this emitter.
| particlesPerSecond | The number of particles to be emitted every second. |
|
virtual |
Set the indication (true/false) to indicate that the emitter is emitted by another emitter.
|
virtual |
Sets the name of the emitter to be emitted.
|
virtual |
Sets whether or not the emitter is enabled.
|
virtual |
Sets the maximum duration of this emitter in seconds (see setDuration for more details)
|
virtual |
Returns the maximum particle velocity.
|
virtual |
Sets the maximum duration of this emitter in seconds (see setRepeatDelay for more details)
|
virtual |
Sets the maximum time each particle will live for.
|
virtual |
Sets the minimum duration of this emitter in seconds (see setDuration for more details)
|
virtual |
Returns the minimum particle velocity.
|
virtual |
Sets the minimum duration of this emitter in seconds (see setRepeatDelay for more details)
|
virtual |
Sets the minimum time each particle will live for.
|
virtual |
Sets the name of the emitter.
|
virtualinherited |
Generic parameter setting method.
| 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. |
Referenced by copyParametersTo().
|
virtualinherited |
Generic multiple parameter setting method.
| paramList | Name/value pair list |
Sets the initial velocity range of particles emitted.
| 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 |
Sets the initial velocity of particles emitted.
| speed | The initial speed in world units per second which every particle emitted starts with. |
|
virtual |
Sets the position of this emitter relative to the particle system center.
|
virtual |
Sets the time between repeats of the emitter.
| duration | The duration in seconds. |
Sets the range of random duration for this emitter.
| min | The minimum duration in seconds. |
| max | The minimum duration in seconds. |
|
inherited |
Sets the current rotation.
|
virtual |
Sets the 'start time' of this emitter.
| startTime | The time in seconds from the creation or enabling of the emitter. |
Sets the range of lifetime for particles emitted.
| minTtl | The minimum number of seconds each particle will live for. |
| maxTtl | The maximum number of seconds each particle will live for. |
|
virtual |
Sets the lifetime of all particles emitted.
| ttl | The number of seconds each particle will live for. |
|
virtual |
Sets the notional up vector of the emitter.
| up | The base direction for particles emitted. It must be perpendicular to the direction vector. |
|
inherited |
Current colour.
Definition at line 91 of file OgreParticle.h.
Referenced by Particle(), Ogre::ParticleEmitter::setColour(), Ogre::ParticleEmitter::setColourRangeEnd(), and Ogre::ParticleEmitter::setColourRangeStart().
|
inherited |
Direction (and speed)
Definition at line 89 of file OgreParticle.h.
Referenced by Particle(), and Ogre::ParticleEmitter::setDirection().
|
protected |
Angle around direction which particles may be emitted, internally radians but angleunits for interface.
Definition at line 120 of file OgreParticleEmitter.h.
|
protected |
Initial colour of particles (range end)
Definition at line 132 of file OgreParticleEmitter.h.
|
protected |
Initial colour of particles (range start)
Definition at line 130 of file OgreParticleEmitter.h.
|
protected |
Base direction of the emitter, may not be used by some emitters.
Definition at line 111 of file OgreParticleEmitter.h.
|
protected |
Definition at line 118 of file OgreParticleEmitter.h.
|
protected |
Maximum length of time the emitter will run for (0 = forever)
Definition at line 142 of file OgreParticleEmitter.h.
|
protected |
Minimum length of time emitter will run for (0 = forever)
Definition at line 140 of file OgreParticleEmitter.h.
|
protected |
Current duration remainder.
Definition at line 144 of file OgreParticleEmitter.h.
|
protected |
Rate in particles per second at which this emitter wishes to emit particles.
Definition at line 107 of file OgreParticleEmitter.h.
|
protected |
Definition at line 163 of file OgreParticleEmitter.h.
|
protected |
The name of the emitter to be emitted (optional)
Definition at line 159 of file OgreParticleEmitter.h.
|
protected |
Whether this emitter is currently enabled (defaults to true)
Definition at line 135 of file OgreParticleEmitter.h.
|
inherited |
Personal height if mOwnDimensions == true.
Definition at line 81 of file OgreParticle.h.
Referenced by getOwnHeight().
|
protected |
Max speed of particles.
Definition at line 124 of file OgreParticleEmitter.h.
|
protected |
Initial time-to-live of particles (max)
Definition at line 128 of file OgreParticleEmitter.h.
|
protected |
Min speed of particles.
Definition at line 122 of file OgreParticleEmitter.h.
|
protected |
Initial time-to-live of particles (min)
Definition at line 126 of file OgreParticleEmitter.h.
|
protected |
The name of the emitter. The name is optional unless it is used as an emitter that is emitted itself.
Definition at line 156 of file OgreParticleEmitter.h.
|
inherited |
Does this particle have it's own dimensions?
Definition at line 77 of file OgreParticle.h.
Referenced by Particle(), and hasOwnDimensions().
|
privateinherited |
Definition at line 173 of file OgreStringInterface.h.
Referenced by StringInterface(), createParamDictionary(), getParamDictionary(), and getParamDictionary().
|
privateinherited |
Class name for this instance to be used as a lookup (must be initialised by subclasses)
Definition at line 172 of file OgreStringInterface.h.
Referenced by createParamDictionary().
|
protected |
Parent particle system.
Definition at line 103 of file OgreParticleEmitter.h.
|
protectedinherited |
|
protected |
Position relative to the center of the ParticleSystem.
Definition at line 105 of file OgreParticleEmitter.h.
|
protected |
Definition at line 153 of file OgreParticleEmitter.h.
|
protected |
Definition at line 148 of file OgreParticleEmitter.h.
|
protected |
Time between each repeat.
Definition at line 147 of file OgreParticleEmitter.h.
|
protected |
Repeat delay left.
Definition at line 150 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 77 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 78 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 80 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 79 of file OgreParticleEmitter.h.
|
staticprivateinherited |
Dictionary of parameters.
Definition at line 169 of file OgreStringInterface.h.
Referenced by createParamDictionary().
|
staticprotected |
Definition at line 81 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 83 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 92 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 84 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 99 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 94 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 97 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 85 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 86 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 93 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 96 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 87 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 88 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 98 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 89 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 95 of file OgreParticleEmitter.h.
|
protected |
Start time (in seconds from start of first call to ParticleSystem to update)
Definition at line 138 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 90 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 82 of file OgreParticleEmitter.h.
|
staticprotected |
Definition at line 91 of file OgreParticleEmitter.h.
|
protected |
Name of the type of emitter, MUST be initialised by subclasses.
Definition at line 109 of file OgreParticleEmitter.h.
Referenced by getType().
|
protected |
Notional up vector, used to speed up generation of variant directions, and also to orient some emitters.
Definition at line 113 of file OgreParticleEmitter.h.
|
protected |
When true, mDirPositionRef is used instead of mDirection to generate particles.
Definition at line 115 of file OgreParticleEmitter.h.
|
protectedinherited |
Additional visual data you might want to associate with the Particle.
Definition at line 67 of file OgreParticle.h.
Referenced by Particle(), _notifyVisualData(), and getVisualData().
|
inherited |
Personal width if mOwnDimensions == true.
Definition at line 79 of file OgreParticle.h.
Referenced by getOwnWidth().
|
inherited |
Determines the type of particle.
Definition at line 99 of file OgreParticle.h.
Referenced by Particle().
|
inherited |
World position.
Definition at line 87 of file OgreParticle.h.
Referenced by Particle(), and Ogre::ParticleEmitter::setDirPositionReference().
|
inherited |
Current rotation value.
Definition at line 83 of file OgreParticle.h.
Referenced by Particle(), and getRotation().
|
inherited |
Speed of rotation in radians/sec.
Definition at line 97 of file OgreParticle.h.
Referenced by Particle().
|
inherited |
Time to live, number of seconds left of particles natural life.
Definition at line 93 of file OgreParticle.h.
Referenced by Particle().
|
inherited |
Total Time to live, number of seconds of particles natural life.
Definition at line 95 of file OgreParticle.h.
Referenced by Particle().
1.13.2