This class is the base class for other attachable classes and is responsible for transform updates to attachables. More...

#include <attachable.h>

Inheritance diagram for Mezzanine::AttachableBase:

Public Member Functions
	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 Member Functions
Boole	GetUpdating (AttachableBase *AB) const
	Gets the update status of another attachable. More...

Protected Attributes
Boole	Updating

Detailed Description

This class is the base class for other attachable classes and is responsible for transform updates to attachables.

Definition at line 59 of file attachable.h.

Member Function Documentation

Vector3 Mezzanine::AttachableBase::ConvertGlobalToLocal ( const Vector3 & Location ) const

Converts a point in global space to the same point in local space.

Parameters

Location The point in global space to be converted.

Returns: Returns a Vector3 representing the point in local space corresponding to the provided global space point.

Definition at line 70 of file attachable.cpp.

Quaternion Mezzanine::AttachableBase::ConvertGlobalToLocal ( const Quaternion & Orientation ) const

Converts a rotation in global space to the same rotation in local space.

Parameters

Orientation The rotation in global space to be converted.

Returns: Returns a Quaternion representing the rotation in local space corresponding to the provided global space rotation.

Definition at line 76 of file attachable.cpp.

Vector3 Mezzanine::AttachableBase::ConvertLocalToGlobal ( const Vector3 & Location ) const

Converts a point in local space to the same point in global space.

Parameters

Location The point in local space to be converted.

Returns: Returns a Vector3 representing the point in global space corresponding to the provided local space point.

Definition at line 67 of file attachable.cpp.

Quaternion Mezzanine::AttachableBase::ConvertLocalToGlobal ( const Quaternion & Orientation ) const

Converts a rotation in local space to the same rotation in global space.

Parameters

Orientation The rotation in local space to be converted.

Returns: Returns a Quaternion representing the rotation in global space corresponding to the provided local space rotation.

Definition at line 73 of file attachable.cpp.

virtual Vector3 Mezzanine::AttachableBase::GetLocation ( ) const

pure virtual

Gets the Location of this object.

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

virtual ConstString& Mezzanine::AttachableBase::GetName ( ) const

pure virtual

Gets the name of this attachable.

Returns: Returns a const reference to a string containing the name of this attachable.

virtual Quaternion Mezzanine::AttachableBase::GetOrientation ( ) const

pure virtual

Gets the orientation of this object.

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

virtual Vector3 Mezzanine::AttachableBase::GetScaling ( ) const

pure virtual

Gets the scale of this object.

Returns: Returns a vector3 representing the scale being applied to this object.

virtual WorldObjectType Mezzanine::AttachableBase::GetType ( ) const

pure virtual

Gets the type of World or Scene object this attachable is.

Returns: Returns the type of World or Scene object this attachable is.

Boole Mezzanine::AttachableBase::GetUpdating ( AttachableBase * AB ) const

protected

Gets the update status of another attachable.

Definition at line 61 of file attachable.cpp.

virtual void Mezzanine::AttachableBase::SetLocation ( const Vector3 & Location )

pure virtual

Sets the Location of this object.

Parameters

Location A vector3 representing the location of this object.

virtual void Mezzanine::AttachableBase::SetOrientation ( const Quaternion & Orientation )

pure virtual

Sets the orientation of this object.

Parameters

Orientation A Quaternion representing the orientation of this object.

virtual void Mezzanine::AttachableBase::SetScaling ( const Vector3 & Scale )

pure virtual

Sets the scale of this object.

Parameters

Scale A vector3 representing the scale to be applied to this object.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation