Spinning Topp Logo BlackTopp Studios
inc
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Mezzanine::Graphics::BillboardSetProxy Class Reference

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

#include <billboardsetproxy.h>

+ Inheritance diagram for Mezzanine::Graphics::BillboardSetProxy:
+ Collaboration diagram for Mezzanine::Graphics::BillboardSetProxy:

Public Types

typedef std::list< Billboard * > BillboardContainer
 Basic container type for Billboard storage by this class.
 
typedef BillboardContainer::iterator BillboardIterator
 Iterator type for Billboard instances stored by this class.
 
typedef BillboardContainer::const_iterator ConstBillboardIterator
 Const Iterator type for Billboard instances stored by this class.
 

Public Member Functions

 BillboardSetProxy (const UInt32 ID, const UInt32 InitialPoolSize, SceneManager *Creator)
 Class constructor. More...
 
 BillboardSetProxy (const XML::Node &SelfRoot, SceneManager *Creator)
 XML constructor. More...
 
virtual ~BillboardSetProxy ()
 Class destructor.
 
virtual Ogre::MovableObject * _GetBaseGraphicsObject () const
 Accessor for the internal graphics object. More...
 
virtual Ogre::BillboardSet * _GetGraphicsObject () const
 Accessor for the internal billboard set. More...
 
virtual BillboardCreateBillboard (const Vector3 &Location, const ColourValue &Colour=ColourValue::White())
 Creates a new Billboard for this set. More...
 
virtual void DestroyAllBillboards ()
 Deletes all stored Billboard instances.
 
virtual void DestroyBillboard (Billboard *ToBeDestroyed)
 Deletes a Billboard. More...
 
virtual Boole GetAccurateFacing () const
 Gets whether direction vectors are being calculated using a more expensive but more accurate algorithm. More...
 
virtual Boole GetAutoExtend () const
 Gets whether or not this BillboardSetProxy will increase the size of it's billboard pool automatically when it's limit is reached. More...
 
virtual BillboardGetBillboard (UInt32 Index)
 Gets a Billboard instance by index. More...
 
virtual Graphics::BillboardOrigin GetBillboardOrigin () const
 Gets the part of the billboard that is currently being treated as the origin for all children of this set. More...
 
virtual Graphics::BillboardRotation GetBillboardRotation () const
 Gets the type of rotation to apply when a rotation is made to a billboard. More...
 
virtual Graphics::BillboardType GetBillboardType () const
 Gets the type of BillboardSetProxy this is. More...
 
virtual Vector3 GetCommonDirection () const
 Gets the common facing direction for all billboards in this set. More...
 
virtual Vector3 GetCommonUpVector () const
 Gets the common up direction for all billboards in this set. More...
 
virtual Real GetDefaultHeight () const
 Gets the default height all billboards in this set are constructed with. More...
 
virtual Real GetDefaultWidth () const
 Gets the default width all billboards in this set are constructed with. More...
 
virtual String GetDerivedSerializableName () const
 Gets the most derived serializable name of this WorldProxy. More...
 
virtual String GetMaterialName () const
 Gets the name of the material being used by this set. More...
 
virtual UInt32 GetNumBillboards () const
 Gets the number of Billboard instances in this set. More...
 
virtual UInt32 GetPoolSize () const
 Gets the current size of the billboard pool in this set. More...
 
virtual Mezzanine::ProxyType GetProxyType () const
 Accessor for the type of proxy. More...
 
virtual void ProtoDeSerializeBillboards (const XML::Node &SelfRoot)
 Take the data stored in an XML Node and overwrite the Billboards of this object with it. More...
 
virtual void ProtoDeSerializeProperties (const XML::Node &SelfRoot)
 Take the data stored in an XML Node and overwrite the properties of this object with it. More...
 
virtual void ProtoSerializeBillboards (XML::Node &SelfRoot) const
 Convert the Billboards of this class to an XML::Node ready for serialization. More...
 
virtual void ProtoSerializeProperties (XML::Node &SelfRoot) const
 Convert the properties of this class to an XML::Node ready for serialization. More...
 
virtual void SetAccurateFacing (const Boole AccFace)
 Sets whether direction vectors will be calculated using a more expensive but more accurate algorithm. More...
 
virtual void SetAutoExtend (const Boole AutoExtend)
 Sets whether or not this BillboardSetProxy will increase the size of it's billboard pool automatically when it's limit is reached. More...
 
virtual void SetBillboardOrigin (const Graphics::BillboardOrigin Origin)
 Sets the part of the billboard that will be treated as the origin for all children of this set. More...
 
virtual void SetBillboardRotation (const Graphics::BillboardRotation Rotation)
 Sets the type of rotation to apply when a rotation is made to a billboard. More...
 
virtual void SetBillboardType (const Graphics::BillboardType Type)
 Sets the type of BillboardSetProxy this is. More...
 
virtual void SetCommonDirection (const Vector3 &Dir)
 Sets the common facing direction for all billboards in this set. More...
 
virtual void SetCommonUpVector (const Vector3 &UpDir)
 Sets the common up direction for all billboards in this set. More...
 
virtual void SetDefaultDimensions (const Real Width, const Real Height)
 Sets the default width and height all billboards in this set are to be configured with when constructed. More...
 
virtual void SetDefaultHeight (const Real Height)
 Sets the default height all billboards in this set are to be configured with when constructed. More...
 
virtual void SetDefaultWidth (const Real Width)
 Sets the default width all billboards in this set are to be configured with when constructed. More...
 
virtual void SetMaterialName (const String &MatName)
 Sets a material for this set by name. More...
 
virtual void SetPoolSize (const UInt32 Size)
 Sets a new size of the billboard pool in this set. More...
 
- Public Member Functions inherited from Mezzanine::Graphics::RenderableProxy
 RenderableProxy (SceneManager *Creator)
 XML-assist Constructor. More...
 
 RenderableProxy (const UInt32 ID, SceneManager *Creator)
 Normal Constructor. More...
 
virtual ~RenderableProxy ()
 Class destructor.
 
virtual Ogre::SceneNode * _GetGraphicsNode () const
 Accessor for the internal node in the scenegraph for this proxy. More...
 
virtual void AddToWorld ()
 Performs all the necessary task to ensure this object is connected to it's respective world and ready for use. More...
 
virtual AxisAlignedBox GetAABB () const
 Gets this proxies AABB. More...
 
virtual Boole GetCastShadows () const
 Gets whether or not this proxy can cast a shadow. More...
 
virtual WorldManagerGetCreator () const
 Gets a pointer to this proxies creator. More...
 
virtual UInt32 GetLightMask () const
 Gets which types of lights will affect this proxy. More...
 
virtual Vector3 GetLocation () const
 Gets this objects current location. More...
 
virtual Quaternion GetOrientation () const
 Gets this objects current orientation. More...
 
virtual UInt32 GetQueryMask () const
 Gets the bitmask that will be used to determine if this object should be counted in scene queries. More...
 
virtual Boole GetReceiveShadows () const
 Gets whether or not this proxy can be rendered with a shadow casted on it. More...
 
virtual Real GetRenderDistance () const
 Gets the distance at which the proxy will stop rendering. More...
 
virtual Vector3 GetScale () const
 Gets the scaling currently being applied to this object. More...
 
virtual UInt32 GetVisibilityMask () const
 Gets the bitmask that will be used to determine if this object should be visible when rendering. More...
 
virtual Boole GetVisible () const
 Gets whether or not this proxy is visible. More...
 
virtual Boole IsInWorld () const
 Gets whether or not this object is inside of it's world. More...
 
virtual void Pitch (const Real Angle)
 Rotate the object around the X axis. More...
 
virtual void RemoveFromWorld ()
 Unhooks this proxy from it's respective world. More...
 
virtual void Roll (const Real Angle)
 Rotate the object around the Z axis. More...
 
virtual void Rotate (const Vector3 &Axis, const Real Angle)
 Rotates the object from it's existing rotation. More...
 
virtual void Rotate (const Quaternion &Rotation)
 Rotates the object from it's existing rotation. More...
 
virtual void Scale (const Vector3 &Scale)
 Scales the object from it's current size. More...
 
virtual void Scale (const Real X, const Real Y, const Real Z)
 Scales the object from it's current size. More...
 
virtual void SetCastShadows (const Boole CastShadows)
 Sets whether or not this proxy can cast a shadow. More...
 
virtual void SetLightMask (const UInt32 Mask)
 Sets which types of lights will affect this proxy. More...
 
virtual void SetLocation (const Vector3 &Loc)
 Sets the location of this object in parent space. More...
 
virtual void SetLocation (const Real X, const Real Y, const Real Z)
 Sets the location of this object in parent space via Reals. More...
 
virtual void SetOrientation (const Quaternion &Ori)
 Sets the orientation of this object in parent space. More...
 
virtual void SetOrientation (const Real X, const Real Y, const Real Z, const Real W)
 Sets the orientation of this object in parent space via Reals. More...
 
virtual void SetQueryMask (const UInt32 Mask)
 Sets the bitmesk that will be used to determine if this object should be counted in scene queries. More...
 
virtual void SetRenderDistance (const Real Distance)
 Sets the distance at which the proxy will stop rendering. More...
 
virtual void SetScale (const Vector3 &Sc)
 Sets the scaling to be applied to this object. More...
 
virtual void SetScale (const Real X, const Real Y, const Real Z)
 Sets the scaling to be applied to this object via Reals. More...
 
virtual void SetVisibilityMask (const UInt32 Mask)
 Sets the bitmask that will be used to determine if this object should be visible when rendering. More...
 
virtual void SetVisible (const Boole Visible)
 Sets whether or not this proxy is visible. More...
 
virtual void Translate (const Vector3 &Trans)
 Moves this object from it's current location. More...
 
virtual void Translate (const Real X, const Real Y, const Real Z)
 Moves this object from it's current location. More...
 
virtual void Yaw (const Real Angle)
 Rotate the object around the Y axis. More...
 
- Public Member Functions inherited from Mezzanine::WorldProxy
 WorldProxy ()
 Blank constructor.
 
 WorldProxy (const UInt32 ID)
 Normal/ID constructor. More...
 
virtual ~WorldProxy ()
 Class destructor.
 
void _Bind (WorldObject *NewParent)
 Binds this proxy to a WorldObject. More...
 
virtual WorldObjectGetParentObject () const
 Gets a pointer to the parent object controlling this proxy. More...
 
virtual UInt32 GetProxyID () const
 Gets the unique ID of this proxy. More...
 
virtual void ProtoDeSerialize (const XML::Node &SelfRoot)
 Take the data stored in an XML Node and overwrite this object with it. More...
 
virtual void ProtoSerialize (XML::Node &ParentNode) const
 Convert this class to an XML::Node ready for serialization. More...
 
- Public Member Functions inherited from Mezzanine::TransformableObject
virtual ~TransformableObject ()
 Class Destructor.
 
virtual Vector3 ConvertGlobalToLocal (const Vector3 &Location) const
 Converts a point in global space to the same point in local space. More...
 
virtual Quaternion ConvertGlobalToLocal (const Quaternion &Orientation) const
 Converts a rotation in global space to the same rotation in local space. More...
 
virtual Vector3 ConvertLocalToGlobal (const Vector3 &Location) const
 Converts a point in local space to the same point in global space. More...
 
virtual Quaternion ConvertLocalToGlobal (const Quaternion &Orientation) const
 Converts a rotation in local space to the same rotation in global space. 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...
 
- Static Public Member Functions inherited from Mezzanine::Graphics::RenderableProxy
static String GetSerializableName ()
 Get the name of the the XML tag the proxy class will leave behind as its instances are serialized. More...
 
- Static Public Member Functions inherited from Mezzanine::WorldProxy
static String GetSerializableName ()
 Get the name of the the XML tag the proxy class will leave behind as its instances are serialized. More...
 

Protected Member Functions

virtual void CreateBillboardSet (const UInt32 InitialPoolSize)
 Creates an internal BillboardSet to be used by the calling instance. More...
 
virtual void DestroyBillboardSet ()
 Destroys the internal BillboardSet in use by this proxy. More...
 
virtual void ProtoDeSerializeImpl (const XML::Node &SelfRoot)
 Implementation method for deseriailizing additional sets of data. More...
 
virtual void ProtoSerializeImpl (XML::Node &SelfRoot) const
 Implementation method for serializing additional sets of data. More...
 

Protected Attributes

BillboardContainer Billboards
 Container storing all of the Billboard instances created by this proxy. More...
 
Ogre::BillboardSet * GraphicsBillboardSet
 A pointer to the internal BillboardSet this proxy is based on. More...
 
- Protected Attributes inherited from Mezzanine::Graphics::RenderableProxy
Ogre::SceneNode * GraphicsNode
 A pointer to the internal object storing the proxy transform. More...
 
Boole InWorld
 This stores whether the proxy is currently in the graphics world or not. More...
 
SceneManagerManager
 This is a pointer to the scene manager that created and owns this proxy. More...
 
UInt32 QueryMask
 This is a bitmask identifying this objects type when being queried. Used for advanced query configuration. More...
 
UInt32 VisibilityMask
 This is a bitmask identifying this objects type when being rendered. Used for advanced visibility configuration. More...
 
- Protected Attributes inherited from Mezzanine::WorldProxy
WorldObjectParentObject
 Pointer to the Object this proxy belongs to. More...
 
UInt32 ProxyID
 The unique ID assigned to the type of proxy an instance is. More...
 

Detailed Description

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

Definition at line 64 of file billboardsetproxy.h.

Constructor & Destructor Documentation

Mezzanine::Graphics::BillboardSetProxy::BillboardSetProxy ( const UInt32  ID,
const UInt32  InitialPoolSize,
SceneManager Creator 
)

Class constructor.

Parameters
IDThe unique ID assigned to this BillboardSetProxy.
InitialPoolSizeThe number of billboards to reserve space for.
CreatorA pointer to the manager that created this proxy.

Definition at line 164 of file billboardsetproxy.cpp.

Mezzanine::Graphics::BillboardSetProxy::BillboardSetProxy ( const XML::Node SelfRoot,
SceneManager Creator 
)

XML constructor.

Parameters
SelfRootAn XML::Node containing the data to populate this class with.
CreatorA pointer to the manager that created this proxy.

Definition at line 168 of file billboardsetproxy.cpp.

Member Function Documentation

Ogre::MovableObject * Mezzanine::Graphics::BillboardSetProxy::_GetBaseGraphicsObject ( ) const
virtual

Accessor for the internal graphics object.

Returns
Returns a pointer to the internal object of this proxy.

Implements Mezzanine::Graphics::RenderableProxy.

Definition at line 476 of file billboardsetproxy.cpp.

Ogre::BillboardSet * Mezzanine::Graphics::BillboardSetProxy::_GetGraphicsObject ( ) const
virtual

Accessor for the internal billboard set.

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

Definition at line 473 of file billboardsetproxy.cpp.

Billboard * Mezzanine::Graphics::BillboardSetProxy::CreateBillboard ( const Vector3 Location,
const ColourValue Colour = ColourValue::White() 
)
virtual

Creates a new Billboard for this set.

Note
In most situations you will want the colour to stay white. The material will still render normally without modification if it is left white.
Parameters
LocationThe position relative to the center of the set where this billboard will be placed.
ColourThe base colour to give to the created billboard.
Returns
Returns a pointer to the created billboard, or NULL if this set has reached it's max billboards and autoextend is disabled.

Definition at line 218 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::CreateBillboardSet ( const UInt32  InitialPoolSize)
protectedvirtual

Creates an internal BillboardSet to be used by the calling instance.

Parameters
InitialPoolSizeThe number of billboards to reserve space for.

Definition at line 190 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::DestroyBillboard ( Billboard ToBeDestroyed)
virtual

Deletes a Billboard.

Parameters
ToBeDestroyedA pointer to the Billboard you want deleted.

Definition at line 242 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::DestroyBillboardSet ( )
protectedvirtual

Destroys the internal BillboardSet in use by this proxy.

Definition at line 199 of file billboardsetproxy.cpp.

Boole Mezzanine::Graphics::BillboardSetProxy::GetAccurateFacing ( ) const
virtual

Gets whether direction vectors are being calculated using a more expensive but more accurate algorithm.

Returns
Returns true if this BillboardSetProxy is using the more accurate and more expensive method for directional vectors, false otherwise.

Definition at line 278 of file billboardsetproxy.cpp.

Boole Mezzanine::Graphics::BillboardSetProxy::GetAutoExtend ( ) const
virtual

Gets whether or not this BillboardSetProxy will increase the size of it's billboard pool automatically when it's limit is reached.

Returns
Returns true if the billboard pool will automatically be resized when it reaches it's limit, false otherwise.

Definition at line 272 of file billboardsetproxy.cpp.

Billboard * Mezzanine::Graphics::BillboardSetProxy::GetBillboard ( UInt32  Index)
virtual

Gets a Billboard instance by index.

Parameters
IndexThe index of the Billboard to be retrieved.
Returns
Returns a pointer to the Billboard at the specified index.

Definition at line 225 of file billboardsetproxy.cpp.

Graphics::BillboardOrigin Mezzanine::Graphics::BillboardSetProxy::GetBillboardOrigin ( ) const
virtual

Gets the part of the billboard that is currently being treated as the origin for all children of this set.

Returns
Returns a BillboardOrigin enum value expressing which part of the billboard is being treated as the origin.

Definition at line 290 of file billboardsetproxy.cpp.

Graphics::BillboardRotation Mezzanine::Graphics::BillboardSetProxy::GetBillboardRotation ( ) const
virtual

Gets the type of rotation to apply when a rotation is made to a billboard.

Returns
Returns a BillboardRotation enum value expressing how billboards in this set are to be rotated.

Definition at line 296 of file billboardsetproxy.cpp.

Graphics::BillboardType Mezzanine::Graphics::BillboardSetProxy::GetBillboardType ( ) const
virtual

Gets the type of BillboardSetProxy this is.

Returns
Returns a BillboardType enum value expressing how billboards in this set are being oriented.

Definition at line 302 of file billboardsetproxy.cpp.

Vector3 Mezzanine::Graphics::BillboardSetProxy::GetCommonDirection ( ) const
virtual

Gets the common facing direction for all billboards in this set.

Returns
Returns a Vector3 representing the forward axis of billboards in this set.

Definition at line 323 of file billboardsetproxy.cpp.

Vector3 Mezzanine::Graphics::BillboardSetProxy::GetCommonUpVector ( ) const
virtual

Gets the common up direction for all billboards in this set.

Returns
Returns a Vector3 representing the up axis of billboards in this set.

Definition at line 329 of file billboardsetproxy.cpp.

Real Mezzanine::Graphics::BillboardSetProxy::GetDefaultHeight ( ) const
virtual

Gets the default height all billboards in this set are constructed with.

Returns
Returns a Real representing the default height of all billboards in this set in world units.

Definition at line 317 of file billboardsetproxy.cpp.

Real Mezzanine::Graphics::BillboardSetProxy::GetDefaultWidth ( ) const
virtual

Gets the default width all billboards in this set are constructed with.

Returns
Returns a Real representing the default width of all billboards in this set in world units.

Definition at line 311 of file billboardsetproxy.cpp.

String Mezzanine::Graphics::BillboardSetProxy::GetDerivedSerializableName ( ) const
virtual

Gets the most derived serializable name of this WorldProxy.

Note
When creating a new WorldProxy class verify this method has a valid return for it in order for serialization to work properly.
Returns
Returns the name of the XML tag from the most derived class of "this".

Reimplemented from Mezzanine::Graphics::RenderableProxy.

Definition at line 464 of file billboardsetproxy.cpp.

String Mezzanine::Graphics::BillboardSetProxy::GetMaterialName ( ) const
virtual

Gets the name of the material being used by this set.

Todo:
These by-name methods should be removed when we have a working material wrapper.
Returns
Returns a string containing the name of the material being used to render this BillboardSetProxy.

Definition at line 335 of file billboardsetproxy.cpp.

UInt32 Mezzanine::Graphics::BillboardSetProxy::GetNumBillboards ( ) const
virtual

Gets the number of Billboard instances in this set.

Returns
Returns a UInt32 representing the number of Billboard instances contained in this set.

Definition at line 237 of file billboardsetproxy.cpp.

UInt32 Mezzanine::Graphics::BillboardSetProxy::GetPoolSize ( ) const
virtual

Gets the current size of the billboard pool in this set.

Returns
Returns a UInt32 representing the current size of the billboard pool in this set.

Definition at line 284 of file billboardsetproxy.cpp.

Mezzanine::ProxyType Mezzanine::Graphics::BillboardSetProxy::GetProxyType ( ) const
virtual

Accessor for the type of proxy.

Returns
Returns enum value for the type of proxy this object is.

Implements Mezzanine::WorldProxy.

Definition at line 210 of file billboardsetproxy.cpp.

String Mezzanine::Graphics::BillboardSetProxy::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 467 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::ProtoDeSerializeBillboards ( const XML::Node SelfRoot)
virtual

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

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

Definition at line 447 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::ProtoDeSerializeImpl ( const XML::Node SelfRoot)
protectedvirtual

Implementation method for deseriailizing additional sets of data.

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

Reimplemented from Mezzanine::WorldProxy.

Definition at line 184 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::ProtoDeSerializeProperties ( const XML::Node SelfRoot)
virtual

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

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

Reimplemented from Mezzanine::Graphics::RenderableProxy.

Definition at line 383 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::ProtoSerializeBillboards ( XML::Node SelfRoot) const
virtual

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

Parameters
SelfRootThe root node containing all the serialized data for this instance.

Definition at line 369 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::ProtoSerializeImpl ( XML::Node SelfRoot) const
protectedvirtual

Implementation method for serializing additional sets of data.

Parameters
SelfRootThe root node containing all the serialized data for this instance.

Reimplemented from Mezzanine::WorldProxy.

Definition at line 178 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::ProtoSerializeProperties ( XML::Node SelfRoot) const
virtual

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

Parameters
SelfRootThe root node containing all the serialized data for this instance.

Reimplemented from Mezzanine::Graphics::RenderableProxy.

Definition at line 341 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::SetAccurateFacing ( const Boole  AccFace)
virtual

Sets whether direction vectors will be calculated using a more expensive but more accurate algorithm.

Parameters
AccFaceTrue to increase accuracy of billboard directions, false for the more efficient method.

Definition at line 275 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::SetAutoExtend ( const Boole  AutoExtend)
virtual

Sets whether or not this BillboardSetProxy will increase the size of it's billboard pool automatically when it's limit is reached.

Parameters
AutoExtendA Boole indicating whether or not this proxy is allowed to resize it's own billboard pool.

Definition at line 269 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::SetBillboardOrigin ( const Graphics::BillboardOrigin  Origin)
virtual

Sets the part of the billboard that will be treated as the origin for all children of this set.

Parameters
OriginA BillboardOrigin enum value expressing which part of the billboard will be considered the origin for all billboards in this set.

Definition at line 287 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::SetBillboardRotation ( const Graphics::BillboardRotation  Rotation)
virtual

Sets the type of rotation to apply when a rotation is made to a billboard.

Parameters
RotationA BillboardRotation enum value expressing the underlying method for rotation in billboards belonging to this set.

Definition at line 293 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::SetBillboardType ( const Graphics::BillboardType  Type)
virtual

Sets the type of BillboardSetProxy this is.

Parameters
TypeA BillboardType enum value expressing how billboards in this set are to be oriented.

Definition at line 299 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::SetCommonDirection ( const Vector3 Dir)
virtual

Sets the common facing direction for all billboards in this set.

Remarks
This only needs to be set if this billboard type is set to "BBT_Oriented_Common" or "BBT_Perpendicular_Common".
Parameters
DirThe facing axis for all billboards in this set.

Definition at line 320 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::SetCommonUpVector ( const Vector3 UpDir)
virtual

Sets the common up direction for all billboards in this set.

Remarks
This only needs to be set if this billboard type is set to "BBT_Perpendicular_Common" or "BBT_Perpendicular_Self".
Parameters
UpDirThe up axis for all billboards in this set.

Definition at line 326 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::SetDefaultDimensions ( const Real  Width,
const Real  Height 
)
virtual

Sets the default width and height all billboards in this set are to be configured with when constructed.

Parameters
WidthThe default width in world units.
HeightThe default height in world units.

Definition at line 305 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::SetDefaultHeight ( const Real  Height)
virtual

Sets the default height all billboards in this set are to be configured with when constructed.

Parameters
HeightThe default height in world units.

Definition at line 314 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::SetDefaultWidth ( const Real  Width)
virtual

Sets the default width all billboards in this set are to be configured with when constructed.

Parameters
WidthThe default width in world units.

Definition at line 308 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::SetMaterialName ( const String MatName)
virtual

Sets a material for this set by name.

Todo:
These by-name methods should be removed when we have a working material wrapper.
Parameters
MatNameThe name of the material to apply.

Definition at line 332 of file billboardsetproxy.cpp.

void Mezzanine::Graphics::BillboardSetProxy::SetPoolSize ( const UInt32  Size)
virtual

Sets a new size of the billboard pool in this set.

Parameters
SizeThe size the billboard pool in this set should be resized to.

Definition at line 281 of file billboardsetproxy.cpp.

Member Data Documentation

BillboardContainer Mezzanine::Graphics::BillboardSetProxy::Billboards
protected

Container storing all of the Billboard instances created by this proxy.

Definition at line 76 of file billboardsetproxy.h.

Ogre::BillboardSet* Mezzanine::Graphics::BillboardSetProxy::GraphicsBillboardSet
protected

A pointer to the internal BillboardSet this proxy is based on.

Definition at line 79 of file billboardsetproxy.h.


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