A billboard is a primitive which always faces the camera in every frame. More...
#include <OgreBillboard.h>

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 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. | |
| 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 FloatRect & | getTexcoordRect (void) const |
| getTexcoordRect() returns the previous value set by setTexcoordRect(). | |
| void * | operator new (size_t sz, const char *file, int line, const char *func) |
| operator new, with debug line info | |
| void * | operator new (size_t sz) |
| void * | operator new (size_t sz, void *ptr) |
| placement operator new | |
| void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
| array operator new, with debug line info | |
| void * | operator new[] (size_t sz) |
| 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 *) |
Public Attributes | |
| Vector3 | mPosition |
| Vector3 | mDirection |
| BillboardSet * | mParentSet |
| ColourValue | mColour |
| Radian | mRotation |
Protected Attributes | |
| bool | mOwnDimensions |
| bool | mUseTexcoordRect |
| uint16 | mTexcoordIndex |
| FloatRect | mTexcoordRect |
| Real | mWidth |
| Real | mHeight |
Friends | |
| class | BillboardSet |
| class | BillboardParticleRenderer |
A billboard is a primitive which always faces the camera in every frame.
Definition at line 66 of file OgreBillboard.h.
Default constructor.
Default destructor.
| Ogre::Billboard::Billboard | ( | const Vector3 & | position, |
| BillboardSet * | owner, | ||
| const ColourValue & | colour = ColourValue::White |
||
| ) |
Normal constructor as called by BillboardSet.
| 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.
| const Radian& Ogre::Billboard::getRotation | ( | void | ) | const |
Get the rotation of the billboard.
Definition at line 103 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.
Definition at line 197 of file OgreBillboard.h.
| const FloatRect& Ogre::Billboard::getTexcoordRect | ( | void | ) | const |
getTexcoordRect() returns the previous value set by setTexcoordRect().
Definition at line 217 of file OgreBillboard.h.
| 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).
| 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).
Definition at line 181 of file OgreBillboard.h.
| void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, |
| void * | |||
| ) | [inherited] |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, |
| const char * | , | ||
| int | , | ||
| const char * | |||
| ) | [inherited] |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, |
| const char * | , | ||
| int | , | ||
| const char * | |||
| ) | [inherited] |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
| 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 67 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, |
| void * | ptr | ||
| ) | [inherited] |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
| 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 85 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
| void Ogre::Billboard::resetDimensions | ( | void | ) |
Resets this Billboard to use the parent BillboardSet's dimensions instead of it's own.
Definition at line 142 of file OgreBillboard.h.
| void Ogre::Billboard::setColour | ( | const ColourValue & | colour | ) |
Sets the colour of this billboard.
| void Ogre::Billboard::setDimensions | ( | Real | width, |
| Real | height | ||
| ) |
Sets the width and height for this billboard.
| void Ogre::Billboard::setPosition | ( | const Vector3 & | position | ) |
Set the position of the billboard.
| void Ogre::Billboard::setPosition | ( | Real | x, |
| Real | y, | ||
| Real | z | ||
| ) |
Set the position of the billboard.
| void Ogre::Billboard::setRotation | ( | const Radian & | rotation | ) |
Set the rotation 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.
| 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.
| 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.
friend class BillboardParticleRenderer [friend] |
Definition at line 69 of file OgreBillboard.h.
friend class BillboardSet [friend] |
Definition at line 68 of file OgreBillboard.h.
Definition at line 84 of file OgreBillboard.h.
Definition at line 82 of file OgreBillboard.h.
Real Ogre::Billboard::mHeight [protected] |
Definition at line 76 of file OgreBillboard.h.
bool Ogre::Billboard::mOwnDimensions [protected] |
Definition at line 71 of file OgreBillboard.h.
Definition at line 83 of file OgreBillboard.h.
Definition at line 80 of file OgreBillboard.h.
Definition at line 85 of file OgreBillboard.h.
uint16 Ogre::Billboard::mTexcoordIndex [protected] |
Definition at line 73 of file OgreBillboard.h.
FloatRect Ogre::Billboard::mTexcoordRect [protected] |
Definition at line 74 of file OgreBillboard.h.
bool Ogre::Billboard::mUseTexcoordRect [protected] |
Definition at line 72 of file OgreBillboard.h.
Real Ogre::Billboard::mWidth [protected] |
Definition at line 75 of file OgreBillboard.h.
Copyright © 2012 Torus Knot Software Ltd

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:26