Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound 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>`

Inheritance diagram for Ogre::Billboard:

[legend]
List of all members.

## 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.
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

Vector3 | mPosition
Vector3 | mDirection
BillboardSet * | mParentSet
ColourValue | mColour
Radian | mRotation

## Protected Attributes

bool | mOwnDimensions
Real | mWidth
Real | mHeight

## Friends

class | BillboardSet

## 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. Definition at line 34 of file OgreBillboard.cpp.

Ogre::Billboard::~Billboard | ( |  | ) |

| Default destructor. Definition at line 44 of file OgreBillboard.cpp.

Ogre::Billboard::Billboard | ( | const Vector3 & | position,
|  | BillboardSet * | owner,
|  | const ColourValue & | colour = ColourValue::White
| ) |

| Normal constructor as called by BillboardSet. Definition at line 48 of file OgreBillboard.cpp. References mColour, mOwnDimensions, mParentSet, and mPosition.

## Member Function Documentation

void Ogre::Billboard::_notifyOwner | ( | BillboardSet * | owner | ) |

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

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

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

Real Ogre::Billboard::getOwnHeight | ( | void |  | ) | const

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

Real Ogre::Billboard::getOwnWidth | ( | void |  | ) | const

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

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.

Definition at line 75 of file OgreBillboard.cpp.

References mPosition.

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 90 of file OgreBillboard.h.

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

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

Definition at line 88 of file OgreBillboard.cpp.

References mOwnDimensions.

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

void Ogre::Billboard::resetDimensions | ( | void |  | ) |

| 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 | ) |

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 mColour.

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

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.

Definition at line 80 of file OgreBillboard.cpp.

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

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

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.

Definition at line 68 of file OgreBillboard.cpp.

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

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.

Definition at line 63 of file OgreBillboard.cpp.

References mPosition.

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

void Ogre::Billboard::setRotation | ( | const Radian & | rotation | ) |

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(), mParentSet, and mRotation.

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

## Friends And Related Function Documentation

friend class BillboardSet`[friend]`

| Definition at line 59 of file OgreBillboard.h.

## Member Data Documentation

ColourValue Ogre::Billboard::mColour

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(), Billboard(), Ogre::BillboardSet::genVertices(), getColour(), and setColour().

Vector3 Ogre::Billboard::mDirection

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]`

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

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

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

BillboardSet* Ogre::Billboard::mParentSet

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

Vector3 Ogre::Billboard::mPosition

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().

Radian Ogre::Billboard::mRotation

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

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

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

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

- OgreBillboard.h
- OgreBillboard.cpp

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