![]() |
OGRE-Next 3.0.0
Object-Oriented Graphics Rendering Engine
|
Class representing a single particle instance. More...
#include <OgreParticle.h>
Inheritance diagram for Ogre::Particle:Public Types | |
| enum | ParticleType { Visual , Emitter } |
| Type of particle. More... | |
Public Member Functions | |
| 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 () const |
| Retrieves the particle's personal width, if hasOwnDimensions is true. | |
| Real | getOwnWidth () const |
| Retrieves the particle's personal width, if hasOwnDimensions is true. | |
| const Radian & | getRotation () const |
| ParticleVisualData * | getVisualData () const |
| Get the optional visual data associated with the class. | |
| bool | hasOwnDimensions () const |
| Returns true if this particle deviates from the ParticleSystem's default dimensions (i.e. | |
| void | resetDimensions () |
| 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. | |
Public Attributes | |
| 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. | |
Class representing a single particle instance.
|
inline |
References mColour, mDirection, mHeight, mOwnDimensions, mParticleType, mPosition, mRotation, mRotationSpeed, mTimeToLive, mTotalTimeToLive, mWidth, and Visual.
Referenced by Ogre::ParticleEmitter::_initParticle().
| void Ogre::Particle::_notifyOwner | ( | ParticleSystem * | owner | ) |
Internal method for notifying the particle of it's owner.
|
inline |
Internal method for notifying the particle of it's optional visual data.
|
inline |
Retrieves the particle's personal width, if hasOwnDimensions is true.
References mHeight.
|
inline |
Retrieves the particle's personal width, if hasOwnDimensions is true.
References mWidth.
|
inline |
Get the optional visual data associated with the class.
|
inline |
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).
References mOwnDimensions.
| void Ogre::Particle::resetDimensions | ( | ) |
Utility method to reset this particle.
Referenced by Ogre::ParticleEmitter::_initParticle().
Sets the width and height for this particle.
| void Ogre::Particle::setRotation | ( | const Radian & | rad | ) |
Sets the current rotation.
| ColourValue Ogre::Particle::mColour |
Current colour.
Referenced by Particle().
| Vector3 Ogre::Particle::mDirection |
Direction (and speed)
Referenced by Particle().
| Real Ogre::Particle::mHeight |
Personal height if mOwnDimensions == true.
Referenced by Particle(), and getOwnHeight().
| bool Ogre::Particle::mOwnDimensions |
Does this particle have it's own dimensions?
Referenced by Particle(), and hasOwnDimensions().
| ParticleType Ogre::Particle::mParticleType |
Determines the type of particle.
Referenced by Particle().
| Vector3 Ogre::Particle::mPosition |
World position.
Referenced by Particle().
| Radian Ogre::Particle::mRotation |
Current rotation value.
Referenced by Particle(), and getRotation().
| Radian Ogre::Particle::mRotationSpeed |
Speed of rotation in radians/sec.
Referenced by Particle().
| Real Ogre::Particle::mTimeToLive |
Time to live, number of seconds left of particles natural life.
Referenced by Particle().
| Real Ogre::Particle::mTotalTimeToLive |
Total Time to live, number of seconds of particles natural life.
Referenced by Particle().
| Real Ogre::Particle::mWidth |
Personal width if mOwnDimensions == true.
Referenced by Particle(), and getOwnWidth().