#include <OgreBillboard.h>
Inheritance diagram for Ogre::Billboard:
Public Methods | |
Billboard () | |
Default constructor. More... | |
~Billboard () | |
Default destructor. More... | |
Billboard (const Vector3 &position, BillboardSet *owner, const ColourValue &colour=ColourValue::White) | |
Normal constructor as called by BillboardSet. More... | |
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 | |
Vector3 | mPosition |
Vector3 | mDirection |
BillboardSet * | mParentSet |
ColourValue | mColour |
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.
|
Default constructor.
|
|
Default destructor.
|
|
Normal constructor as called by BillboardSet.
|
|
Internal method for notifying the billboard of it's owner.
|
|
Gets the colour of this billboard.
|
|
Retrieves the billboard's personal width, if hasOwnDimensions is true.
|
|
Retrieves the billboard's personal width, if hasOwnDimensions is true.
|
|
Get the position of the billboard.
|
|
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).
|
|
Sets the colour of this billboard.
|
|
Sets the width and height for this billboard.
|
|
Set the position of the billboard.
|
|
Set the position of the billboard.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Copyright © 2002 by The OGRE Team