---

Ogre::Particle Class Reference

#include <OgreParticle.h>

Inheritance diagram for Ogre::Particle:

List of all members.

Public Methods
	Particle ()
void	setPosition (const Vector3 &position)
	Set the position of the billboard. More...
void	setPosition (Real x, Real y, Real z)
	Set the position of the billboard. More...
const Vector3 &	getPosition (void) const
	Get the position of the billboard. More...
void	setDimensions (Real width, Real height)
	Sets the width and height for this billboard. More...
void	setColour (const ColourValue &colour)
	Sets the colour of this billboard. More...
const ColourValue &	getColour (void) const
	Gets the colour of this billboard. More...
bool	hasOwnDimensions (void) const
	Returns true if this billboard deviates from the BillboardSet's default dimensions (i.e. More...
Real	getOwnWidth (void)
	Retrieves the billboard's personal width, if hasOwnDimensions is true. More...
Real	getOwnHeight (void)
	Retrieves the billboard's personal width, if hasOwnDimensions is true. More...
void	_notifyOwner (BillboardSet *owner)
	Internal method for notifying the billboard of it's owner. More...
Public Attributes
Real	mTimeToLive
	Time to live, number of seconds left of particles natural life. More...
Vector3	mPosition
Vector3	mDirection
BillboardSet *	mParentSet
ColourValue	mColour
Protected Attributes
bool	mOwnDimensions
Real	mWidth
Real	mHeight

---

Constructor & Destructor Documentation

Ogre::Particle::Particle (    )  [inline]

---

Member Function Documentation

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

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

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

Gets the colour of this billboard.

Real Ogre::Billboard::getOwnHeight (  void    )  [inherited]

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

Real Ogre::Billboard::getOwnWidth (  void    )  [inherited]

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

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.

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

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.

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.

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.

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.

---

Member Data Documentation

ColourValue Ogre::Billboard::mColour [inherited]

Vector3 Ogre::Billboard::mDirection [inherited]

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

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

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

Vector3 Ogre::Billboard::mPosition [inherited]

Real Ogre::Particle::mTimeToLive

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

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

Copyright © 2002 by The OGRE Team