This class is the base class for objects that can be attached to AttachableParent. More...

#include <attachable.h>

Inheritance diagram for Mezzanine::AttachableChild:

Collaboration diagram for Mezzanine::AttachableChild:

Public Member Functions
	AttachableChild ()
	Class constructor.

virtual	~AttachableChild ()
	Class destructor.

void	_RecalculateGlobalTransform (bool FromParent=false)
	Recalculates objects global transform from parent. More...

void	_RecalculateLocalTransform ()
	Recalculates this objects local transform based on it's current global position.

Vector3	GetLocalLocation () const
	Gets the Location of this object in local space. More...

Quaternion	GetLocalOrientation () const
	Gets the orientation of this object in local space. More...

AttachableParent *	GetParent () const
	Gets the parent of this child. More...

virtual void	SetLocalLocation (const Vector3 &Location)=0
	Sets the Location of this object in local space. More...

virtual void	SetLocalOrientation (const Quaternion &Orientation)=0
	Sets the orientation of this object in local space. More...

Public Member Functions inherited from Mezzanine::AttachableBase
	AttachableBase ()
	Class constructor.

virtual	~AttachableBase ()
	Class destructor.

Vector3	ConvertGlobalToLocal (const Vector3 &Location) const
	Converts a point in global space to the same point in local space. More...

Quaternion	ConvertGlobalToLocal (const Quaternion &Orientation) const
	Converts a rotation in global space to the same rotation in local space. More...

Vector3	ConvertLocalToGlobal (const Vector3 &Location) const
	Converts a point in local space to the same point in global space. More...

Quaternion	ConvertLocalToGlobal (const Quaternion &Orientation) const
	Converts a rotation in local space to the same rotation in global space. More...

virtual Vector3	GetLocation () const =0
	Gets the Location of this object. More...

virtual ConstString &	GetName () const =0
	Gets the name of this attachable. More...

virtual Quaternion	GetOrientation () const =0
	Gets the orientation of this object. More...

virtual Vector3	GetScaling () const =0
	Gets the scale of this object. More...

virtual WorldObjectType	GetType () const =0
	Gets the type of World or Scene object this attachable is. More...

virtual void	SetLocation (const Vector3 &Location)=0
	Sets the Location of this object. More...

virtual void	SetOrientation (const Quaternion &Orientation)=0
	Sets the orientation of this object. More...

virtual void	SetScaling (const Vector3 &Scale)=0
	Sets the scale of this object. More...

Protected Attributes
bool	GlobalTransformDirty

bool	LocalTransformDirty

Transform	LocalXform

AttachableParent *	Parent

Protected Attributes inherited from Mezzanine::AttachableBase
bool	Updating

Friends
class	AttachableParent

Additional Inherited Members
Protected Member Functions inherited from Mezzanine::AttachableBase
bool	GetUpdating (AttachableBase *AB) const
	Gets the update status of another attachable. More...

Detailed Description

This class is the base class for objects that can be attached to AttachableParent.

Definition at line 204 of file attachable.h.

Member Function Documentation

void Mezzanine::AttachableChild::_RecalculateGlobalTransform ( bool FromParent = false)

Recalculates objects global transform from parent.

Parameters

FromParent Whether this is being invoked from the parent of this attachable.

Definition at line 193 of file attachable.cpp.

Vector3 Mezzanine::AttachableChild::GetLocalLocation ( ) const

Gets the Location of this object in local space.

Returns: Returns a vector3 representing the location of this object.

Definition at line 184 of file attachable.cpp.

Quaternion Mezzanine::AttachableChild::GetLocalOrientation ( ) const

Gets the orientation of this object in local space.

Returns: Returns a quaternion representing the orientation of this object.

Definition at line 187 of file attachable.cpp.

AttachableParent * Mezzanine::AttachableChild::GetParent ( ) const

Gets the parent of this child.

Returns: Returns a pointer to the parent this object is attached to or NULL if it's not attached to anything.

Definition at line 178 of file attachable.cpp.

virtual void Mezzanine::AttachableChild::SetLocalLocation ( const Vector3 & Location)

pure virtual

Sets the Location of this object in local space.

Parameters

Location A vector3 representing the location of this object.

virtual void Mezzanine::AttachableChild::SetLocalOrientation ( const Quaternion & Orientation)

pure virtual

Sets the orientation of this object in local space.

Parameters

Orientation A Quaternion representing the orientation of this object.

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

/home/sqeaky/Code/Mezzanine/Mezzanine/src/attachable.h
/home/sqeaky/Code/Mezzanine/Mezzanine/src/attachable.cpp

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation