#include <OgreBillboard.h>
Inheritance diagram for Ogre::Billboard:
Public Methods | |
Billboard () | |
Default constructor. | |
~Billboard () | |
Default destructor. | |
Billboard (const Vector3 &position, BillboardSet *owner, const ColourValue &colour=ColourValue::White) | |
Normal constructor as called by BillboardSet. | |
Real | getRotation (void) const |
Get the rotation of the billboard. | |
void | setRotation (Real 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 | |
Vector3 | mPosition |
Vector3 | mDirection |
BillboardSet * | mParentSet |
ColourValue | mColour |
Real | mRotation |
Protected Attributes | |
bool | mOwnDimensions |
Real | mWidth |
Real | mHeight |
Friends | |
class | BillboardSet |
Billboards have their geometry generated every frame depending on where the camera is. It is most beneficial for all billboards in a set to be identically sized since Ogre can take advantage of this and save some calculations - useful when you have sets of hundreds of billboards as is possible with special effects. You can deviate from this if you wish (example: a smoke effect would probably have smoke puffs expanding as they rise, so each billboard will legitimately have it's own size) but be aware the extra overhead this brings and try to avoid it if you can.
Billboards are just the mechanism for rendering a range of effects such as particles. It is other classes which use billboards to create their individual effects, so the methods here are quite generic.
Definition at line 57 of file OgreBillboard.h.
|
Default constructor.
Definition at line 34 of file OgreBillboard.cpp. |
|
Default destructor.
Definition at line 44 of file OgreBillboard.cpp. |
|
Normal constructor as called by BillboardSet.
Definition at line 48 of file OgreBillboard.cpp. References mColour, mOwnDimensions, mParentSet, and mPosition. |
|
Internal method for notifying the billboard of it's owner.
Definition at line 98 of file OgreBillboard.cpp. References mParentSet. Referenced by Ogre::ParticleSystem::addParticle(), and Ogre::BillboardSet::createBillboard(). |
|
Gets the colour of this billboard.
Definition at line 108 of file OgreBillboard.cpp. References mColour. |
|
Retrieves the billboard's personal width, if hasOwnDimensions is true.
Definition at line 118 of file OgreBillboard.cpp. References mHeight, and Ogre::Real. Referenced by Ogre::ScaleAffector::_affectParticles(). |
|
Retrieves the billboard's personal width, if hasOwnDimensions is true.
Definition at line 113 of file OgreBillboard.cpp. References mWidth, and Ogre::Real. Referenced by Ogre::ScaleAffector::_affectParticles(). |
|
Get the position of the billboard.
Definition at line 80 of file OgreBillboard.cpp. References mPosition. |
|
Get the rotation of the billboard.
Definition at line 56 of file OgreBillboard.cpp. References mRotation, and Ogre::Real. Referenced by Ogre::RotationAffector::_affectParticles(). |
|
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).
Definition at line 93 of file OgreBillboard.cpp. References mOwnDimensions. Referenced by Ogre::ScaleAffector::_affectParticles(). |
|
Resets this Billboard to use the parent BillboardSet's dimensions instead of it's own.
Definition at line 131 of file OgreBillboard.h. Referenced by Ogre::ParticleEmitter::_initParticle(), and Ogre::HollowEllipsoidEmitter::_initParticle(). |
|
Sets the colour of this billboard.
Definition at line 103 of file OgreBillboard.cpp. References mColour. Referenced by Ogre::BillboardSet::createBillboard(). |
|
Sets the width and height for this billboard.
Definition at line 85 of file OgreBillboard.cpp. References Ogre::BillboardSet::_notifyBillboardResized(), mHeight, mOwnDimensions, mParentSet, mWidth, and Ogre::Real. Referenced by Ogre::ScaleAffector::_affectParticles(). |
|
Set the position of the billboard.
Definition at line 73 of file OgreBillboard.cpp. References mPosition, Ogre::Real, Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z. |
|
Set the position of the billboard.
Definition at line 68 of file OgreBillboard.cpp. References mPosition. Referenced by Ogre::BillboardSet::createBillboard(). |
|
Set the rotation of the billboard.
Definition at line 61 of file OgreBillboard.cpp. References Ogre::BillboardSet::_notifyBillboardTextureCoordsModified(), mParentSet, mRotation, and Ogre::Real. Referenced by Ogre::RotationAffector::_affectParticles(), and Ogre::RotationAffector::_initParticle(). |
|
Definition at line 59 of file OgreBillboard.h. |
|
|
|
Definition at line 63 of file OgreBillboard.h. Referenced by getOwnHeight(), and setDimensions(). |
|
Definition at line 61 of file OgreBillboard.h. Referenced by Billboard(), hasOwnDimensions(), and setDimensions(). |
|
Definition at line 70 of file OgreBillboard.h. Referenced by _notifyOwner(), Billboard(), setDimensions(), and setRotation(). |
|
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(), Billboard(), Ogre::BillboardSet::genVertices(), getPosition(), and setPosition(). |
|
Definition at line 72 of file OgreBillboard.h. Referenced by Ogre::BillboardSet::genVertices(), getRotation(), and setRotation(). |
|
Definition at line 62 of file OgreBillboard.h. Referenced by getOwnWidth(), and setDimensions(). |
Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:16:48 2004