Ogre::Billboard Class Reference
Core » Effects

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

`#include <OgreBillboard.h>`

Inheritance diagram for Ogre::Billboard:
[legend]

## Public Member Functions

| Billboard ()
| Default constructor. More...
| Billboard (const Vector3 &position, BillboardSet *owner, const ColourValue &colour=ColourValue::White)
| Normal constructor as called by BillboardSet. More...
| ~Billboard ()
| Default destructor. More...
void | _notifyOwner (BillboardSet *owner)
| Internal method for notifying the billboard of it's owner. More...
const ColourValue & | getColour (void) const
| Gets the colour of this billboard. More...
Real | getOwnHeight (void) const
| Retrieves the billboard's personal height, if hasOwnDimensions is true. More...
Real | getOwnWidth (void) const
| Retrieves the billboard's personal width, if hasOwnDimensions is true. More...
const Vector3 & | getPosition (void) const
| Get the position of the billboard. More...
const Radian & | getRotation (void) const
| Get the rotation of the billboard. More...
uint16 | getTexcoordIndex (void) const
| getTexcoordIndex() returns the previous value set by setTexcoordIndex(). More...
const FloatRect & | getTexcoordRect (void) const
| getTexcoordRect() returns the previous value set by setTexcoordRect(). More...
bool | hasOwnDimensions (void) const
| Returns true if this billboard deviates from the BillboardSet's default dimensions (i.e. More...
bool | isUseTexcoordRect (void) const
| Returns true if this billboard use individual texture coordinate rect (i.e. More...
void | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info More...
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new More...
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info More...
void * | operator new[] (size_t sz)
void | resetDimensions (void)
| Resets this Billboard to use the parent BillboardSet's dimensions instead of it's own. More...
void | setColour (const ColourValue &colour)
| Sets the colour of this billboard. More...
void | setDimensions (Real width, Real height)
| Sets the width and height for this billboard. 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...
void | setRotation (const Radian &rotation)
| Set the rotation of the billboard. More...
void | setTexcoordIndex (uint16 texcoordIndex)
| setTexcoordIndex() sets which texture coordinate rect this billboard will use when rendering. More...
void | setTexcoordRect (const FloatRect &texcoordRect)
| setTexcoordRect() sets the individual texture coordinate rect of this billboard will use when rendering. More...
void | setTexcoordRect (Real u0, Real v0, Real u1, Real v1)
| setTexcoordRect() sets the individual texture coordinate rect of this billboard will use when rendering. More...

## Public Attributes

ColourValue | mColour
Vector3 | mDirection
| Normalised direction vector. More...
BillboardSet * | mParentSet
Vector3 | mPosition
Radian | mRotation

## Protected Attributes

Real | mHeight
bool | mOwnDimensions
uint16 | mTexcoordIndex
FloatRect | mTexcoordRect
| Index into the BillboardSet array of texture coordinates. More...
bool | mUseTexcoordRect
Real | mWidth
| Individual texture coordinates. More...

## Friends

class | BillboardParticleRenderer
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 67 of file OgreBillboard.h.

## Constructor & Destructor Documentation

## Billboard() [1/2]

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

Default constructor.

## ~Billboard()

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

Default destructor.

## Billboard() [2/2]

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

Normal constructor as called by BillboardSet.

## Member Function Documentation

## _notifyOwner()

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

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

## getColour()

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

Gets the colour of this billboard.

## getOwnHeight()

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

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

## getOwnWidth()

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

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

## getPosition()

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.

## getRotation()

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

## getTexcoordIndex()

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

## getTexcoordRect()

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

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

Remarks
  This value is useful only when isUseTexcoordRect returns true.

Definition at line 218 of file OgreBillboard.h.

## hasOwnDimensions()

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

## isUseTexcoordRect()

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

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr
| ) |  |

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) |

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## resetDimensions()

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

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

Definition at line 143 of file OgreBillboard.h.

## setColour()

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 irrespective of the base colour of the material allowing more varied billboards. The default colour is white. The tinting is effected using vertex colours.

## setDimensions()

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.

## setPosition() [1/2]

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.

## setPosition() [2/2]

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.

## setRotation()

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

Set the rotation of the billboard.

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

## setTexcoordIndex()

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

## setTexcoordRect() [1/2]

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.

## setTexcoordRect() [2/2]

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.

## Friends And Related Function Documentation

## BillboardParticleRenderer

friend class BillboardParticleRenderer

friend

Definition at line 70 of file OgreBillboard.h.

## BillboardSet

friend class BillboardSet

friend

Definition at line 69 of file OgreBillboard.h.

## Member Data Documentation

## mColour

ColourValue Ogre::Billboard::mColour

Definition at line 85 of file OgreBillboard.h.

## mDirection

Vector3 Ogre::Billboard::mDirection

Normalised direction vector.

Definition at line 83 of file OgreBillboard.h.

## mHeight

Real Ogre::Billboard::mHeight

protected

Definition at line 77 of file OgreBillboard.h.

## mOwnDimensions

bool Ogre::Billboard::mOwnDimensions

protected

Definition at line 72 of file OgreBillboard.h.

## mParentSet

BillboardSet* Ogre::Billboard::mParentSet

Definition at line 84 of file OgreBillboard.h.

## mPosition

Vector3 Ogre::Billboard::mPosition

Definition at line 81 of file OgreBillboard.h.

## mRotation

Radian Ogre::Billboard::mRotation

Definition at line 86 of file OgreBillboard.h.

## mTexcoordIndex

uint16 Ogre::Billboard::mTexcoordIndex

protected

Definition at line 74 of file OgreBillboard.h.

## mTexcoordRect

FloatRect Ogre::Billboard::mTexcoordRect

protected

Index into the BillboardSet array of texture coordinates.

Definition at line 75 of file OgreBillboard.h.

## mUseTexcoordRect

bool Ogre::Billboard::mUseTexcoordRect

protected

Definition at line 73 of file OgreBillboard.h.

## mWidth

Real Ogre::Billboard::mWidth

protected

Individual texture coordinates.

Definition at line 76 of file OgreBillboard.h.

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

- OgreBillboard.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.