MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
Mezzanine::Graphics::Billboard Class Reference

This is the proxy class for placing and manipulating a set of 2D billboards in the scene. More...

#include <billboard.h>

Public Member Functions

 Billboard (Ogre::Billboard *InternalBillboard)
 Internal constructor. More...
 
 ~Billboard ()
 Class destructor.
 
Ogre::Billboard * _GetGraphicsObject () const
 Accessor for the internal billboard. More...
 
Real GetBottomTextureCoord () const
 Gets the Bottom side texture coordinate being used to render this billboard. More...
 
ColourValue GetColour () const
 Gets the base colour of this billboard. More...
 
Vector3 GetDirection () const
 Gets the facing direction of this billboard. Only useful with specific types of BillboardSetProxies. More...
 
Real GetLeftTextureCoord () const
 Gets the Left side texture coordinate being used to render this billboard. More...
 
Vector3 GetLocation () const
 Gets the location of this billboard relative to it's parent set. More...
 
Real GetOwnHeight () const
 Gets the individually configured world unit Height of this billboard. More...
 
Real GetOwnWidth () const
 Gets the individually configured world unit Width of this billboard. More...
 
Real GetRightTextureCoord () const
 Gets the Right side texture coordinate being used to render this billboard. More...
 
Real GetRotation () const
 Gets the rotation of this billboard. More...
 
Real GetTopTextureCoord () const
 Gets the Top side texture coordinate being used to render this billboard. More...
 
Boolean HasOwnDimensions () const
 Gets whether or not this billboard has had it's dimensions individually configured. More...
 
Boolean IsUsingTextureCoordRect () const
 Gets whether or not this billboard is using custom texture coordinates. More...
 
void ProtoDeSerialize (const XML::Node &SelfRoot)
 Take the data stored in an XML Node and overwrite this object with it. More...
 
void ProtoSerialize (XML::Node &ParentNode) const
 Convert this class to an XML::Node ready for serialization. More...
 
void ResetDimensions ()
 Resets whatever dimensions are on this billboard to the default provided to the parent BillboardSetProxy.
 
void SetColour (const ColourValue &Colour)
 Sets the base colour of this billboard. More...
 
void SetDimensions (const Real Width, const Real Height)
 Sets the world unit dimensions of this billboard. More...
 
void SetDirection (const Vector3 &Dir)
 Sets the facing direction of this billboard. Only useful with specific types of BillboardSetProxies. More...
 
void SetLocation (const Vector3 &Loc)
 Sets the location of this billboard relative to it's parent set. More...
 
void SetRotation (const Real Rot)
 Sets the rotation of this billboard. More...
 
void SetTextureCoordRect (const Real Left, const Real Top, const Real Right, const Real Bottom)
 Sets the rect in texture coordinates to use for rendering this billboard. More...
 

Static Public Member Functions

static String GetSerializableName ()
 Get the name of the the XML tag the proxy class will leave behind as its instances are serialized. More...
 

Protected Attributes

Ogre::Billboard * GraphicsBillboard
 A pointer to the internal Billboard. More...
 

Detailed Description

This is the proxy class for placing and manipulating a set of 2D billboards in the scene.

Definition at line 62 of file billboard.h.

Constructor & Destructor Documentation

Mezzanine::Graphics::Billboard::Billboard ( Ogre::Billboard *  InternalBillboard)

Internal constructor.

Parameters
InternalBillboardA pointer to the internal Billboard this instance is based on.

Definition at line 58 of file billboard.cpp.

Member Function Documentation

Ogre::Billboard * Mezzanine::Graphics::Billboard::_GetGraphicsObject ( ) const

Accessor for the internal billboard.

Returns
Returns a pointer to the internal billboard this class is based on.

Definition at line 245 of file billboard.cpp.

Real Mezzanine::Graphics::Billboard::GetBottomTextureCoord ( ) const

Gets the Bottom side texture coordinate being used to render this billboard.

Returns
Returns a Real representing the Bottom texture coordinate to use to render this billboard.

Definition at line 125 of file billboard.cpp.

ColourValue Mezzanine::Graphics::Billboard::GetColour ( ) const

Gets the base colour of this billboard.

Returns
Returns a ColourValue representing the currently set base colour of this billboard.

Definition at line 101 of file billboard.cpp.

Vector3 Mezzanine::Graphics::Billboard::GetDirection ( ) const

Gets the facing direction of this billboard. Only useful with specific types of BillboardSetProxies.

Remarks
This value is only used if the parent billboard is of type: "BBT_Oriented_Self" or "BBT_Perpendicular_Self".
Returns
Returns a Vector3 representing the current facing direction of this billboard.

Definition at line 89 of file billboard.cpp.

Real Mezzanine::Graphics::Billboard::GetLeftTextureCoord ( ) const

Gets the Left side texture coordinate being used to render this billboard.

Returns
Returns a Real representing the Left texture coordinate to use to render this billboard.

Definition at line 116 of file billboard.cpp.

Vector3 Mezzanine::Graphics::Billboard::GetLocation ( ) const

Gets the location of this billboard relative to it's parent set.

Returns
Returns a Vector3 representing the current position of this billboard relative to it's parent.

Definition at line 83 of file billboard.cpp.

Real Mezzanine::Graphics::Billboard::GetOwnHeight ( ) const

Gets the individually configured world unit Height of this billboard.

Returns
Returns a Real representing the Height of this billboard that has been manually set.

Definition at line 110 of file billboard.cpp.

Real Mezzanine::Graphics::Billboard::GetOwnWidth ( ) const

Gets the individually configured world unit Width of this billboard.

Returns
Returns a Real representing the Width of this billboard that has been manually set.

Definition at line 107 of file billboard.cpp.

Real Mezzanine::Graphics::Billboard::GetRightTextureCoord ( ) const

Gets the Right side texture coordinate being used to render this billboard.

Returns
Returns a Real representing the Right texture coordinate to use to render this billboard.

Definition at line 122 of file billboard.cpp.

Real Mezzanine::Graphics::Billboard::GetRotation ( ) const

Gets the rotation of this billboard.

Returns
Returns a Real representing the rotation around the facing axis of this billboard in radians.

Definition at line 95 of file billboard.cpp.

String Mezzanine::Graphics::Billboard::GetSerializableName ( )
static

Get the name of the the XML tag the proxy class will leave behind as its instances are serialized.

Returns
A string containing the name of this class.

Definition at line 239 of file billboard.cpp.

Real Mezzanine::Graphics::Billboard::GetTopTextureCoord ( ) const

Gets the Top side texture coordinate being used to render this billboard.

Returns
Returns a Real representing the top texture coordinate to use to render this billboard.

Definition at line 119 of file billboard.cpp.

Boolean Mezzanine::Graphics::Billboard::HasOwnDimensions ( ) const

Gets whether or not this billboard has had it's dimensions individually configured.

Returns
Returns true if this billboard has had it's dimensions manually altered, false otherwise.

Definition at line 68 of file billboard.cpp.

Boolean Mezzanine::Graphics::Billboard::IsUsingTextureCoordRect ( ) const

Gets whether or not this billboard is using custom texture coordinates.

Returns
Returns true if custom texture coordinates have been set for this billboard, false otherwise.

Definition at line 74 of file billboard.cpp.

void Mezzanine::Graphics::Billboard::ProtoDeSerialize ( const XML::Node SelfRoot)

Take the data stored in an XML Node and overwrite this object with it.

Parameters
SelfRootAn XML::Node containing the data to populate this class with.

Definition at line 169 of file billboard.cpp.

void Mezzanine::Graphics::Billboard::ProtoSerialize ( XML::Node ParentNode) const

Convert this class to an XML::Node ready for serialization.

Parameters
ParentNodeThe point in the XML hierarchy that all this renderable should be appended to.

Definition at line 131 of file billboard.cpp.

void Mezzanine::Graphics::Billboard::SetColour ( const ColourValue Colour)

Sets the base colour of this billboard.

Note
Pure white is default and what you will want to use in most situations as that will preserve the render settings set on the material used to render.
Parameters
ColourThe colour that will become the base colour of this billboard.

Definition at line 98 of file billboard.cpp.

void Mezzanine::Graphics::Billboard::SetDimensions ( const Real  Width,
const Real  Height 
)

Sets the world unit dimensions of this billboard.

Parameters
WidthThe world unit width to be assigned to this specific billboard.
HeightThe world unit height to be assigned to this specific billboard.

Definition at line 104 of file billboard.cpp.

void Mezzanine::Graphics::Billboard::SetDirection ( const Vector3 Dir)

Sets the facing direction of this billboard. Only useful with specific types of BillboardSetProxies.

Remarks
This value is only used if the parent billboard is of type: "BBT_Oriented_Self" or "BBT_Perpendicular_Self".
Parameters
DirThe facing direction of this billboard.

Definition at line 86 of file billboard.cpp.

void Mezzanine::Graphics::Billboard::SetLocation ( const Vector3 Loc)

Sets the location of this billboard relative to it's parent set.

Parameters
LocThe relative location to place this billboard.

Definition at line 80 of file billboard.cpp.

void Mezzanine::Graphics::Billboard::SetRotation ( const Real  Rot)

Sets the rotation of this billboard.

Parameters
RotThe rotation in radians around the facing axis of this billboard to apply.

Definition at line 92 of file billboard.cpp.

void Mezzanine::Graphics::Billboard::SetTextureCoordRect ( const Real  Left,
const Real  Top,
const Real  Right,
const Real  Bottom 
)

Sets the rect in texture coordinates to use for rendering this billboard.

Note
Texture coordinates should always be between 0.0 and 1.0.
Parameters
LeftThe Left texture coordinate to use for rendering this billboard.
TopThe Top texture coordinate to use for rendering this billboard.
RightThe Right texture coordinate to use for rendering this billboard.
BottomThe Bottom texture coordinate to use for rendering this billboard.

Definition at line 113 of file billboard.cpp.

Member Data Documentation

Ogre::Billboard* Mezzanine::Graphics::Billboard::GraphicsBillboard
protected

A pointer to the internal Billboard.

Definition at line 67 of file billboard.h.


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