This is the base proxy class for world proxies wrapping functionality of the graphics subsystem. More...

#include <renderableproxy.h>

Inheritance diagram for Mezzanine::Graphics::RenderableProxy:

Collaboration diagram for Mezzanine::Graphics::RenderableProxy:

Public Member Functions
	RenderableProxy (SceneManager *Creator)
	Class constructor. More...

virtual	~RenderableProxy ()
	Class destructor.

virtual Ogre::MovableObject *	_GetBaseGraphicsObject () const =0
	Accessor for the internal graphics object. More...

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 Boolean	GetCastShadows () const
	Gets whether or not this proxy can cast a shadow. More...

virtual WorldManager *	GetCreator () const

virtual String	GetDerivedSerializableName () const
	Gets the most derived serializable name of this WorldProxy. 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 Boolean	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 Boolean	GetVisible () const
	Gets whether or not this proxy is visible. More...

virtual Boolean	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	ProtoDeSerialize (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite 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	ProtoSerialize (XML::Node &ParentNode) const
	Convert 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	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 Boolean 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 Boolean 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 ()
	Class constructor.

virtual	~WorldProxy ()
	Class destructor.

void	_Bind (WorldObject *NewParent)
	Binds this proxy to a WorldObject. More...

virtual WorldObject *	GetParentObject () const
	Gets a pointer to the parent object controlling this proxy. More...

virtual Mezzanine::ProxyType	GetProxyType () const =0
	Accessor for the type of proxy. 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::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 Attributes
Ogre::SceneNode *	GraphicsNode
	A pointer to the internal object storing the proxy transform. More...

Boolean	InWorld
	This stores whether the proxy is currently in the graphics world or not. More...

SceneManager *	Manager
	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
WorldObject *	ParentObject
	Pointer to the Object this proxy belongs to. More...

Detailed Description

This is the base proxy class for world proxies wrapping functionality of the graphics subsystem.

Definition at line 64 of file renderableproxy.h.

Constructor & Destructor Documentation

Mezzanine::Graphics::RenderableProxy::RenderableProxy ( SceneManager * Creator)

Class constructor.

Parameters

Creator A pointer to the manager that created this proxy.

Definition at line 60 of file renderableproxy.cpp.

Member Function Documentation

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

pure virtual

Accessor for the internal graphics object.

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

Implemented in Mezzanine::Graphics::CameraProxy, Mezzanine::Graphics::ParticleSystemProxy, Mezzanine::Graphics::BillboardSetProxy, Mezzanine::Graphics::EntityProxy, and Mezzanine::Graphics::LightProxy.

Ogre::SceneNode * Mezzanine::Graphics::RenderableProxy::_GetGraphicsNode ( ) const

virtual

Accessor for the internal node in the scenegraph for this proxy.

Returns: Returns a pointer to the scenenode storing the transform data of this proxy.

Definition at line 312 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::AddToWorld ( )

virtual

Performs all the necessary task to ensure this object is connected to it's respective world and ready for use.

Implements Mezzanine::WorldProxy.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 82 of file renderableproxy.cpp.

AxisAlignedBox Mezzanine::Graphics::RenderableProxy::GetAABB ( ) const

virtual

Gets this proxies AABB.

Note: This will only return valid values if this proxy is in the world. A proxy outside of the world has no AABB.

Returns: Returns an AxisAlignedBox containing the AABB of this graphics proxy.

Definition at line 79 of file renderableproxy.cpp.

Boolean Mezzanine::Graphics::RenderableProxy::GetCastShadows ( ) const

virtual

Gets whether or not this proxy can cast a shadow.

Returns: Returns true if this proxy can cast a shadow, false otherwise.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 118 of file renderableproxy.cpp.

WorldManager * Mezzanine::Graphics::RenderableProxy::GetCreator ( ) const

virtual

Implements Mezzanine::WorldProxy.

Reimplemented in Mezzanine::Graphics::CameraProxy.

Definition at line 103 of file renderableproxy.cpp.

String Mezzanine::Graphics::RenderableProxy::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::WorldProxy.

Reimplemented in Mezzanine::Graphics::CameraProxy, Mezzanine::Graphics::ParticleSystemProxy, Mezzanine::Graphics::BillboardSetProxy, Mezzanine::Graphics::EntityProxy, and Mezzanine::Graphics::LightProxy.

Definition at line 303 of file renderableproxy.cpp.

UInt32 Mezzanine::Graphics::RenderableProxy::GetLightMask ( ) const

virtual

Gets which types of lights will affect this proxy.

Returns: Returns a bitmask indicating the types of lights that will affect this proxies rendering.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 127 of file renderableproxy.cpp.

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

virtual

Gets this objects current location.

Returns: Returns Vector3 representing the current rotation of this object in parent space.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 167 of file renderableproxy.cpp.

Quaternion Mezzanine::Graphics::RenderableProxy::GetOrientation ( ) const

virtual

Gets this objects current orientation.

Returns: Returns a Quaternion representing the current orientation of this object in parent space.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 176 of file renderableproxy.cpp.

UInt32 Mezzanine::Graphics::RenderableProxy::GetQueryMask ( ) const

virtual

Gets the bitmask that will be used to determine if this object should be counted in scene queries.

Remarks: This bitmask is compared against the bitmask you provide when performing a scene query from the scenemanager.

Returns: Returns a bitmask describing the type of object this will be treated as when discovered in scene queries.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 149 of file renderableproxy.cpp.

Boolean Mezzanine::Graphics::RenderableProxy::GetReceiveShadows ( ) const

virtual

Gets whether or not this proxy can be rendered with a shadow casted on it.

Returns: Returns true if this proxy can receive shadows, false otherwise.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 121 of file renderableproxy.cpp.

Real Mezzanine::Graphics::RenderableProxy::GetRenderDistance ( ) const

virtual

Gets the distance at which the proxy will stop rendering.

Returns: Returns a Real representing the max distance from the camera at which the proxy will be rendered.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 155 of file renderableproxy.cpp.

Vector3 Mezzanine::Graphics::RenderableProxy::GetScale ( ) const

virtual

Gets the scaling currently being applied to this object.

Returns: Returns a Vector3 representing the amount this object is being scaled.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 185 of file renderableproxy.cpp.

String Mezzanine::Graphics::RenderableProxy::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 306 of file renderableproxy.cpp.

UInt32 Mezzanine::Graphics::RenderableProxy::GetVisibilityMask ( ) const

virtual

Gets the bitmask that will be used to determine if this object should be visible when rendering.

Remarks: This bitmask is compared against the bitmask you provide to a viewport for what should be visible during rendering.

Returns: Returns a bitmask describing the type of object this will be treated as when rendering.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 138 of file renderableproxy.cpp.

Boolean Mezzanine::Graphics::RenderableProxy::GetVisible ( ) const

virtual

Gets whether or not this proxy is visible.

Returns: Returns true if this proxy is being rendered, false otherwise.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 112 of file renderableproxy.cpp.

Boolean Mezzanine::Graphics::RenderableProxy::IsInWorld ( ) const

virtual

Gets whether or not this object is inside of it's world.

Returns: Returns true if this proxy is inserted in it's respective subsystems world.

Implements Mezzanine::WorldProxy.

Definition at line 100 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::Pitch ( const Real Angle)

virtual

Rotate the object around the X axis.

Parameters

Angle The angle to rotate this object in radians.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 197 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::ProtoDeSerialize ( const XML::Node & SelfRoot)

virtual

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

Parameters

SelfRoot An XML::Node containing the data to populate this class with.

Reimplemented from Mezzanine::WorldProxy.

Reimplemented in Mezzanine::Graphics::ParticleSystemProxy, Mezzanine::Graphics::BillboardSetProxy, and Mezzanine::Graphics::EntityProxy.

Definition at line 248 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::ProtoDeSerializeProperties ( const XML::Node & SelfRoot)

virtual

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

Parameters

SelfRoot An XML::Node containing the data to populate this class with.

Reimplemented from Mezzanine::WorldProxy.

Reimplemented in Mezzanine::Graphics::CameraProxy, Mezzanine::Graphics::ParticleSystemProxy, Mezzanine::Graphics::BillboardSetProxy, Mezzanine::Graphics::LightProxy, and Mezzanine::Graphics::EntityProxy.

Definition at line 263 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::ProtoSerialize ( XML::Node & ParentNode) const

virtual

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

Parameters

ParentNode The point in the XML hierarchy that all this renderable should be appended to.

Reimplemented from Mezzanine::WorldProxy.

Reimplemented in Mezzanine::Graphics::BillboardSetProxy, Mezzanine::Graphics::ParticleSystemProxy, and Mezzanine::Graphics::EntityProxy.

Definition at line 218 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::ProtoSerializeProperties ( XML::Node & SelfRoot) const

virtual

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

Parameters

SelfRoot The root node containing all the serialized data for this instance.

Reimplemented from Mezzanine::WorldProxy.

Reimplemented in Mezzanine::Graphics::CameraProxy, Mezzanine::Graphics::ParticleSystemProxy, Mezzanine::Graphics::BillboardSetProxy, Mezzanine::Graphics::LightProxy, and Mezzanine::Graphics::EntityProxy.

Definition at line 228 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::RemoveFromWorld ( )

virtual

Unhooks this proxy from it's respective world.

Implements Mezzanine::WorldProxy.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 91 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::Roll ( const Real Angle)

virtual

Rotate the object around the Z axis.

Parameters

Angle The angle to rotate this object in radians.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 200 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::Rotate	(	const Vector3 &	Axis,
		const Real	Angle
	)

virtual

Rotates the object from it's existing rotation.

Note: This method has an additive effect with the objects current rotation. Unlike "SetOrientation" this method does not replace the existing orientation with what you provide.

Parameters

Axis	The axis on which this object will be rotated.
Angle	The angle to rotate this object in radians.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 203 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::Rotate ( const Quaternion & Rotation)

virtual

Rotates the object from it's existing rotation.

Note: This method has an additive effect with the objects current rotation. Unlike "SetOrientation" this method does not replace the existing orientation with what you provide.

Parameters

Rotation The rotation to apply to this object.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 206 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::Scale ( const Vector3 & Scale)

virtual

Scales the object from it's current size.

Note: This method has an additive effect with the objects' current scaling. Unlike "SetScale" this method does not replace the existing scale with what you provide.

Parameters

Scale A Vector3 representing the scaling to apply to this object.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 209 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::Scale	(	const Real	X,
		const Real	Y,
		const Real	Z
	)

virtual

Scales the object from it's current size.

Note: This method has an additive effect with the objects' current scaling. Unlike "SetScale" this method does not replace the existing scale with what you provide.

Parameters

X	The scaling factor to apply on the X axis.
Y	The scaling factor to apply on the Y axis.
Z	The scaling factor to apply on the Z axis.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 212 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::SetCastShadows ( const Boolean CastShadows)

virtual

Sets whether or not this proxy can cast a shadow.

Parameters

CastShadows True to allow this proxy to cast a shadow, false to prevent it from casting a shadow.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 115 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::SetLightMask ( const UInt32 Mask)

virtual

Sets which types of lights will affect this proxy.

Parameters

Mask	A bitmask used to indicate which types of lights will be applied to this proxy.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 124 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::SetLocation ( const Vector3 & Loc)

virtual

Sets the location of this object in parent space.

Parameters

Location A Vector3 representing the location this object is to be set to.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 161 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::SetLocation	(	const Real	X,
		const Real	Y,
		const Real	Z
	)

virtual

Sets the location of this object in parent space via Reals.

Parameters

X	The position on the X axis where this object is to be set.
Y	The position on the Y axis where this object is to be set.
Z	The position on the Z axis where this object is to be set.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 164 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::SetOrientation ( const Quaternion & Ori)

virtual

Sets the orientation of this object in parent space.

Parameters

Orientation A Quaternion representing the rotation this object is to be set to.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 170 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::SetOrientation	(	const Real	X,
		const Real	Y,
		const Real	Z,
		const Real	W
	)

virtual

Sets the orientation of this object in parent space via Reals.

Parameters

X	The X component of the Axis.
Y	The Y component of the Axis.
Z	The Z component of the Axis.
W	Rotation on the Axis X, Y and Z defined.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 173 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::SetQueryMask ( const UInt32 Mask)

virtual

Sets the bitmesk that will be used to determine if this object should be counted in scene queries.

Remarks: This bitmask is compared against the bitmask you provide when performing a scene query from the scenemanager.

Parameters

Mask	The bitmask to be applied.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 141 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::SetRenderDistance ( const Real Distance)

virtual

Sets the distance at which the proxy will stop rendering.

Note: Passing in zero will remove distance checking for this object when rendering.

Parameters

Distance The distance in world units from the camera when the proxy will stop being rendered.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 152 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::SetScale ( const Vector3 & Sc)

virtual

Sets the scaling to be applied to this object.

Parameters

Scale A Vector3 representing the amount of scaling to apply to this object.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 179 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::SetScale	(	const Real	X,
		const Real	Y,
		const Real	Z
	)

virtual

Sets the scaling to be applied to this object via Reals.

Parameters

X	The scaling factor to apply on the X axis.
Y	The scaling factor to apply on the Y axis.
Z	The scaling factor to apply on the Z axis.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 182 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::SetVisibilityMask ( const UInt32 Mask)

virtual

Sets the bitmask that will be used to determine if this object should be visible when rendering.

Remarks: This bitmask is compared against the bitmask you provide to a viewport for what should be visible during rendering.

Parameters

Mask	The bitmask to be applied.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 130 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::SetVisible ( const Boolean Visible)

virtual

Sets whether or not this proxy is visible.

Parameters

Visible True to allow this proxy to render, false otherwise.

Reimplemented in Mezzanine::Graphics::EntityProxy.

Definition at line 109 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::Translate ( const Vector3 & Trans)

virtual

Moves this object from it's current location.

Note: This method has an additive effect with the objects current location. Unlike "SetLocation" this method does not replace the existing location with what you provide.

Parameters

Trans A Vector3 representing the amount of movement to apply to this object.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 188 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::Translate	(	const Real	X,
		const Real	Y,
		const Real	Z
	)

virtual

Moves this object from it's current location.

Note: This method has an additive effect with the objects current location. Unlike "SetLocation" this method does not replace the existing location with what you provide.

Parameters

X	The amount of movement to apply on the X axis.
Y	The amount of movement to apply on the Y axis.
Z	The amount of movement to apply on the Z axis.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 191 of file renderableproxy.cpp.

void Mezzanine::Graphics::RenderableProxy::Yaw ( const Real Angle)

virtual

Rotate the object around the Y axis.

Parameters

Angle The angle to rotate this object in radians.

Warning: Calling this method directly can de-sync a WorldObject. Do NOT do this unless you know exactly what you are doing.

Implements Mezzanine::WorldProxy.

Definition at line 194 of file renderableproxy.cpp.

Member Data Documentation

Ogre::SceneNode* Mezzanine::Graphics::RenderableProxy::GraphicsNode

protected

A pointer to the internal object storing the proxy transform.

Definition at line 69 of file renderableproxy.h.

Boolean Mezzanine::Graphics::RenderableProxy::InWorld

protected

This stores whether the proxy is currently in the graphics world or not.

Definition at line 81 of file renderableproxy.h.

SceneManager* Mezzanine::Graphics::RenderableProxy::Manager

protected

This is a pointer to the scene manager that created and owns this proxy.

Definition at line 72 of file renderableproxy.h.

UInt32 Mezzanine::Graphics::RenderableProxy::QueryMask

protected

This is a bitmask identifying this objects type when being queried. Used for advanced query configuration.

Definition at line 78 of file renderableproxy.h.

UInt32 Mezzanine::Graphics::RenderableProxy::VisibilityMask

protected

This is a bitmask identifying this objects type when being rendered. Used for advanced visibility configuration.

Definition at line 75 of file renderableproxy.h.

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

/home/sqeaky/Code/Mezzanine/Mezzanine/src/Graphics/renderableproxy.h
/home/sqeaky/Code/Mezzanine/Mezzanine/src/Graphics/renderableproxy.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation