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

Ogre::Billboard Class Reference

A billboard is a primitive which always faces the camera in every frame. More...

#include <OgreBillboard.h>

List of all members.

Public Member Functions

 Billboard ()
 Default constructor.

 ~Billboard ()
 Default destructor.

 Billboard (const Vector3 &position, BillboardSet *owner, const ColourValue &colour=ColourValue::White)
 Normal constructor as called by BillboardSet.

const RadiangetRotation (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 Vector3getPosition (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 ColourValuegetColour (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.

bool isUseTexcoordRect (void) const
 Returns true if this billboard use individual texture coordinate rect (i.e.

void setTexcoordIndex (uint16 texcoordIndex)
 setTexcoordIndex() sets which texture coordinate rect this billboard will use when rendering.

uint16 getTexcoordIndex (void) const
 getTexcoordIndex() returns the previous value set by setTexcoordIndex().

void setTexcoordRect (const FloatRect &texcoordRect)
 setTexcoordRect() sets the individual texture coordinate rect of this billboard will use when rendering.

void setTexcoordRect (Real u0, Real v0, Real u1, Real v1)
 setTexcoordRect() sets the individual texture coordinate rect of this billboard will use when rendering.

const FloatRectgetTexcoordRect (void) const
 getTexcoordRect() returns the previous value set by setTexcoordRect().


Public Attributes

Vector3 mPosition
Vector3 mDirection
BillboardSetmParentSet
ColourValue mColour
Radian mRotation

Protected Attributes

bool mOwnDimensions
bool mUseTexcoordRect
uint16 mTexcoordIndex
FloatRect mTexcoordRect
Real mWidth
Real mHeight

Friends

class BillboardSet
class BillboardParticleRenderer


Detailed Description

A billboard is a primitive which always faces the camera in every frame.

Remarks:
Billboards can be used for special effects or some other trickery which requires the triangles to always facing the camera no matter where it is. Ogre groups billboards into sets for efficiency, so you should never create a billboard on it's own (it's ok to have a set of one if you need it).
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.
See also:
BillboardSet

Definition at line 57 of file OgreBillboard.h.


Constructor & Destructor Documentation

Ogre::Billboard::Billboard  ) 
 

Default constructor.

Ogre::Billboard::~Billboard  ) 
 

Default destructor.

Ogre::Billboard::Billboard const Vector3 position,
BillboardSet owner,
const ColourValue colour = ColourValue::White
 

Normal constructor as called by BillboardSet.


Member Function Documentation

void Ogre::Billboard::_notifyOwner BillboardSet owner  ) 
 

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

const ColourValue& Ogre::Billboard::getColour void   )  const
 

Gets the colour of this billboard.

Real Ogre::Billboard::getOwnHeight void   )  const
 

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

Real Ogre::Billboard::getOwnWidth void   )  const
 

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

const Vector3& Ogre::Billboard::getPosition void   )  const
 

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.

const Radian& Ogre::Billboard::getRotation void   )  const
 

Get the rotation of the billboard.

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

Definition at line 94 of file OgreBillboard.h.

uint16 Ogre::Billboard::getTexcoordIndex void   )  const
 

getTexcoordIndex() returns the previous value set by setTexcoordIndex().

The default value is 0, which is always a valid texture coordinate set.

Remarks:
This value is useful only when isUseTexcoordRect return false.

Definition at line 188 of file OgreBillboard.h.

References Ogre::uint16.

const FloatRect& Ogre::Billboard::getTexcoordRect void   )  const
 

getTexcoordRect() returns the previous value set by setTexcoordRect().

Remarks:
This value is useful only when isUseTexcoordRect return true.

Definition at line 208 of file OgreBillboard.h.

References Ogre::FloatRect.

bool Ogre::Billboard::hasOwnDimensions void   )  const
 

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

bool Ogre::Billboard::isUseTexcoordRect void   )  const
 

Returns true if this billboard use individual texture coordinate rect (i.e.

if the Billboard::setTexcoordRect method has been called for this instance), or returns false if use texture coordinates defined in the parent BillboardSet's texture coordinates array (i.e. if the Billboard::setTexcoordIndex method has been called for this instance).

See also:
Billboard::setTexcoordIndex() Billboard::setTexcoordRect()

Definition at line 172 of file OgreBillboard.h.

void Ogre::Billboard::resetDimensions void   ) 
 

Resets this Billboard to use the parent BillboardSet's dimensions instead of it's own.

Definition at line 133 of file OgreBillboard.h.

void Ogre::Billboard::setColour const ColourValue colour  ) 
 

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
 

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
 

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  ) 
 

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::setRotation const Radian rotation  ) 
 

Set the rotation of the billboard.

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

void Ogre::Billboard::setTexcoordIndex uint16  texcoordIndex  ) 
 

setTexcoordIndex() sets which texture coordinate rect this billboard will use when rendering.

The parent billboard set may contain more than one, in which case a billboard can be textured with different pieces of a larger texture sheet very efficiently.

See also:
BillboardSet::setTextureCoords()

void Ogre::Billboard::setTexcoordRect Real  u0,
Real  v0,
Real  u1,
Real  v1
 

setTexcoordRect() sets the individual texture coordinate rect of this billboard will use when rendering.

The parent billboard set may contain more than one, in which case a billboard can be textured with different pieces of a larger texture sheet very efficiently.

void Ogre::Billboard::setTexcoordRect const FloatRect texcoordRect  ) 
 

setTexcoordRect() sets the individual texture coordinate rect of this billboard will use when rendering.

The parent billboard set may contain more than one, in which case a billboard can be textured with different pieces of a larger texture sheet very efficiently.


Friends And Related Function Documentation

friend class BillboardParticleRenderer [friend]
 

Definition at line 60 of file OgreBillboard.h.

friend class BillboardSet [friend]
 

Definition at line 59 of file OgreBillboard.h.


Member Data Documentation

ColourValue Ogre::Billboard::mColour
 

Definition at line 75 of file OgreBillboard.h.

Vector3 Ogre::Billboard::mDirection
 

Definition at line 73 of file OgreBillboard.h.

Real Ogre::Billboard::mHeight [protected]
 

Definition at line 67 of file OgreBillboard.h.

bool Ogre::Billboard::mOwnDimensions [protected]
 

Definition at line 62 of file OgreBillboard.h.

BillboardSet* Ogre::Billboard::mParentSet
 

Definition at line 74 of file OgreBillboard.h.

Vector3 Ogre::Billboard::mPosition
 

Definition at line 71 of file OgreBillboard.h.

Radian Ogre::Billboard::mRotation
 

Definition at line 76 of file OgreBillboard.h.

uint16 Ogre::Billboard::mTexcoordIndex [protected]
 

Definition at line 64 of file OgreBillboard.h.

FloatRect Ogre::Billboard::mTexcoordRect [protected]
 

Definition at line 65 of file OgreBillboard.h.

bool Ogre::Billboard::mUseTexcoordRect [protected]
 

Definition at line 63 of file OgreBillboard.h.

Real Ogre::Billboard::mWidth [protected]
 

Definition at line 66 of file OgreBillboard.h.


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

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:38:08 2006