Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

# Ogre::Particle Class Reference

`#include <OgreParticle.h>`

Inheritance diagram for Ogre::Particle:

[legend]
List of all members.

## Public Methods

| Particle ()
const Radian & | getRotationSpeed (void) const
void | setRotationSpeed (const Radian &rotation)
const Radian & | getRotation (void) const
| Get the rotation of the billboard.
void | setRotation (const Radian &rotation)
| Set the rotation of the billboard.
void | setPosition (const Vector3 &position)
| Set the position of the billboard.
void | setPosition (Real x, Real y, Real z)
| Set the position of the billboard.
const Vector3 & | getPosition (void) const
| Get the position of the billboard.
void | setDimensions (Real width, Real height)
| Sets the width and height for this billboard.
void | resetDimensions (void)
| Resets this Billboard to use the parent BillboardSet's dimensions instead of it's own.
void | setColour (const ColourValue &colour)
| Sets the colour of this billboard.
const ColourValue & | getColour (void) const
| Gets the colour of this billboard.
bool | hasOwnDimensions (void) const
| Returns true if this billboard deviates from the BillboardSet's default dimensions (i.e.
Real | getOwnWidth (void) const
| Retrieves the billboard's personal width, if hasOwnDimensions is true.
Real | getOwnHeight (void) const
| Retrieves the billboard's personal width, if hasOwnDimensions is true.
void | _notifyOwner (BillboardSet *owner)
| Internal method for notifying the billboard of it's owner.

## Public Attributes

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.
Radian | mRotationSpeed
| Speed of rotation in radians.
Vector3 | mPosition
Vector3 | mDirection
BillboardSet * | mParentSet
ColourValue | mColour
Radian | mRotation

## Protected Attributes

bool | mOwnDimensions
Real | mWidth
Real | mHeight

## Constructor & Destructor Documentation

Ogre::Particle::Particle | ( |  | ) |

| Definition at line 50 of file OgreParticle.h.

## Member Function Documentation

void Ogre::Billboard::_notifyOwner | ( | BillboardSet * | owner | ) | `[inherited]`

| Internal method for notifying the billboard of it's owner. Definition at line 93 of file OgreBillboard.cpp. References Ogre::Billboard::mParentSet. Referenced by Ogre::ParticleSystem::addParticle(), and Ogre::BillboardSet::createBillboard().

const ColourValue & Ogre::Billboard::getColour | ( | void |  | ) | const`[inherited]`

| Gets the colour of this billboard. Definition at line 103 of file OgreBillboard.cpp. References Ogre::Billboard::mColour.

Real Ogre::Billboard::getOwnHeight | ( | void |  | ) | const`[inherited]`

| Retrieves the billboard's personal width, if hasOwnDimensions is true. Definition at line 113 of file OgreBillboard.cpp. References Ogre::Billboard::mHeight, and Ogre::Real. Referenced by Ogre::ScaleAffector::_affectParticles().

Real Ogre::Billboard::getOwnWidth | ( | void |  | ) | const`[inherited]`

| Retrieves the billboard's personal width, if hasOwnDimensions is true. Definition at line 108 of file OgreBillboard.cpp. References Ogre::Billboard::mWidth, and Ogre::Real. Referenced by Ogre::ScaleAffector::_affectParticles().

const Vector3 & Ogre::Billboard::getPosition | ( | void |  | ) | const`[inherited]`

Get the position of the billboard.

Remarks:
  This position is relative to a point on the quad which is the billboard. Depending on the BillboardSet, this may be the center of the quad, the top-left etc. See BillboardSet::setBillboardOrigin for more info.

Definition at line 75 of file OgreBillboard.cpp.

References Ogre::Billboard::mPosition.

const Radian& Ogre::Billboard::getRotation | ( | void |  | ) | const`[inherited]`

Get the rotation of the billboard.

Remarks:
  This rotation is relative to the center of the billboard.

Definition at line 90 of file OgreBillboard.h.

Referenced by Ogre::RotationAffector::_affectParticles().

const Radian& Ogre::Particle::getRotationSpeed | ( | void |  | ) | const

| Definition at line 55 of file OgreParticle.h. Referenced by Ogre::RotationAffector::_affectParticles().

bool Ogre::Billboard::hasOwnDimensions | ( | void |  | ) | const`[inherited]`

Returns true if this billboard deviates from the BillboardSet's default dimensions (i.e.

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

See also:
  Billboard::setDimensions

Definition at line 88 of file OgreBillboard.cpp.

References Ogre::Billboard::mOwnDimensions.

Referenced by Ogre::ScaleAffector::_affectParticles().

void Ogre::Billboard::resetDimensions | ( | void |  | ) | `[inherited]`

| Resets this Billboard to use the parent BillboardSet's dimensions instead of it's own. Definition at line 129 of file OgreBillboard.h. Referenced by Ogre::ParticleEmitter::_initParticle(), and Ogre::HollowEllipsoidEmitter::_initParticle().

void Ogre::Billboard::setColour | ( | const ColourValue & | colour | ) | `[inherited]`

Sets the colour of this billboard.

Remarks:
  Billboards can be tinted based on a base colour. This allows variations in colour irresective of the base colour of the material allowing more varied billboards. The default colour is white. The tinting is effected using vertex colours.

Definition at line 98 of file OgreBillboard.cpp.

References Ogre::Billboard::mColour.

Referenced by Ogre::BillboardSet::createBillboard().

void Ogre::Billboard::setDimensions | ( | Real | width,
|  | Real | height
| ) | `[inherited]`

Sets the width and height for this billboard.

Remarks:
  Note that it is most efficient for every billboard in a BillboardSet to have the same dimensions. If you choose to alter the dimensions of an individual billboard the set will be less efficient. Do not call this method unless you really need to have different billboard dimensions within the same set. Otherwise just call the BillboardSet::setDefaultDimensions method instead.

Definition at line 80 of file OgreBillboard.cpp.

References Ogre::BillboardSet::_notifyBillboardResized(), Ogre::Billboard::mHeight, Ogre::Billboard::mOwnDimensions, Ogre::Billboard::mParentSet, Ogre::Billboard::mWidth, and Ogre::Real.

Referenced by Ogre::ScaleAffector::_affectParticles().

void Ogre::Billboard::setPosition | ( | Real | x,
|  | Real | y,
|  | Real | z
| ) | `[inherited]`

Set the position of the billboard.

Remarks:
  This position is relative to a point on the quad which is the billboard. Depending on the BillboardSet, this may be the center of the quad, the top-left etc. See BillboardSet::setBillboardOrigin for more info.

Definition at line 68 of file OgreBillboard.cpp.

References Ogre::Billboard::mPosition, Ogre::Real, Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

void Ogre::Billboard::setPosition | ( | const Vector3 & | position | ) | `[inherited]`

Set the position of the billboard.

Remarks:
  This position is relative to a point on the quad which is the billboard. Depending on the BillboardSet, this may be the center of the quad, the top-left etc. See BillboardSet::setBillboardOrigin for more info.

Definition at line 63 of file OgreBillboard.cpp.

References Ogre::Billboard::mPosition.

Referenced by Ogre::BillboardSet::createBillboard().

void Ogre::Billboard::setRotation | ( | const Radian & | rotation | ) | `[inherited]`

Set the rotation of the billboard.

Remarks:
  This rotation is relative to the center of the billboard.

Definition at line 56 of file OgreBillboard.cpp.

References Ogre::BillboardSet::_notifyBillboardTextureCoordsModified(), Ogre::Billboard::mParentSet, and Ogre::Billboard::mRotation.

Referenced by Ogre::RotationAffector::_affectParticles(), and Ogre::RotationAffector::_initParticle().

void Ogre::Particle::setRotationSpeed | ( | const Radian & | rotation | ) |

| Definition at line 56 of file OgreParticle.h. Referenced by Ogre::RotationAffector::_initParticle().

## Member Data Documentation

ColourValue Ogre::Billboard::mColour`[inherited]`

Definition at line 71 of file OgreBillboard.h.

Referenced by Ogre::ColourInterpolatorAffector::_affectParticles(), Ogre::ColourImageAffector::_affectParticles(), Ogre::ColourFaderAffector2::_affectParticles(), Ogre::ColourFaderAffector::_affectParticles(), Ogre::RingEmitter::_initParticle(), Ogre::PointEmitter::_initParticle(), Ogre::HollowEllipsoidEmitter::_initParticle(), Ogre::EllipsoidEmitter::_initParticle(), Ogre::CylinderEmitter::_initParticle(), Ogre::ColourImageAffector::_initParticle(), Ogre::BoxEmitter::_initParticle(), Ogre::Billboard::Billboard(), Ogre::BillboardSet::genVertices(), Ogre::Billboard::getColour(), and Ogre::Billboard::setColour().

Vector3 Ogre::Billboard::mDirection`[inherited]`

Definition at line 69 of file OgreBillboard.h.

Referenced by Ogre::LinearForceAffector::_affectParticles(), Ogre::ParticleSystem::_applyMotion(), Ogre::RingEmitter::_initParticle(), Ogre::PointEmitter::_initParticle(), Ogre::HollowEllipsoidEmitter::_initParticle(), Ogre::EllipsoidEmitter::_initParticle(), Ogre::CylinderEmitter::_initParticle(), Ogre::BoxEmitter::_initParticle(), Ogre::ParticleSystem::_triggerEmitters(), Ogre::ParticleSystem::genBillboardAxes(), and Ogre::BillboardSet::genBillboardAxes().

Real Ogre::Billboard::mHeight`[protected, inherited]`

| Definition at line 63 of file OgreBillboard.h. Referenced by Ogre::Billboard::getOwnHeight(), and Ogre::Billboard::setDimensions().

bool Ogre::Billboard::mOwnDimensions`[protected, inherited]`

| Definition at line 61 of file OgreBillboard.h. Referenced by Ogre::Billboard::Billboard(), Ogre::Billboard::hasOwnDimensions(), and Ogre::Billboard::setDimensions().

BillboardSet* Ogre::Billboard::mParentSet`[inherited]`

| Definition at line 70 of file OgreBillboard.h. Referenced by Ogre::Billboard::_notifyOwner(), Ogre::Billboard::Billboard(), Ogre::Billboard::setDimensions(), and Ogre::Billboard::setRotation().

Vector3 Ogre::Billboard::mPosition`[inherited]`

Definition at line 67 of file OgreBillboard.h.

Referenced by Ogre::ParticleSystem::_applyMotion(), Ogre::RingEmitter::_initParticle(), Ogre::PointEmitter::_initParticle(), Ogre::HollowEllipsoidEmitter::_initParticle(), Ogre::EllipsoidEmitter::_initParticle(), Ogre::CylinderEmitter::_initParticle(), Ogre::BoxEmitter::_initParticle(), Ogre::ParticleSystem::_triggerEmitters(), Ogre::Billboard::Billboard(), Ogre::BillboardSet::genVertices(), Ogre::Billboard::getPosition(), and Ogre::Billboard::setPosition().

Radian Ogre::Billboard::mRotation`[inherited]`

| Definition at line 72 of file OgreBillboard.h. Referenced by Ogre::BillboardSet::genVertices(), and Ogre::Billboard::setRotation().

Radian Ogre::Particle::mRotationSpeed

| Speed of rotation in radians. Definition at line 47 of file OgreParticle.h.

Real Ogre::Particle::mTimeToLive

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

Definition at line 43 of file OgreParticle.h.

Referenced by Ogre::ColourInterpolatorAffector::_affectParticles(), Ogre::ColourImageAffector::_affectParticles(), Ogre::ColourFaderAffector2::_affectParticles(), Ogre::ParticleSystem::_expire(), Ogre::RingEmitter::_initParticle(), Ogre::PointEmitter::_initParticle(), Ogre::HollowEllipsoidEmitter::_initParticle(), Ogre::EllipsoidEmitter::_initParticle(), Ogre::CylinderEmitter::_initParticle(), and Ogre::BoxEmitter::_initParticle().

Real Ogre::Particle::mTotalTimeToLive

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

Definition at line 45 of file OgreParticle.h.

Referenced by Ogre::ColourInterpolatorAffector::_affectParticles(), Ogre::ColourImageAffector::_affectParticles(), Ogre::RingEmitter::_initParticle(), Ogre::PointEmitter::_initParticle(), Ogre::HollowEllipsoidEmitter::_initParticle(), Ogre::EllipsoidEmitter::_initParticle(), Ogre::CylinderEmitter::_initParticle(), and Ogre::BoxEmitter::_initParticle().

Real Ogre::Billboard::mWidth`[protected, inherited]`

| Definition at line 62 of file OgreBillboard.h. Referenced by Ogre::Billboard::getOwnWidth(), and Ogre::Billboard::setDimensions().

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

- OgreParticle.h

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:51:20 2004