Mezzanine::AttachableChild Class Reference

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

#include <attachable.h>

Inheritance diagram for Mezzanine::AttachableChild:

List of all members.

Public Member Functions
	AttachableChild ()
	Class constructor.
virtual	~AttachableChild ()
	Class destructor.
void	_RecalculateGlobalTransform (bool FromParent=false)
	Recalculates objects global transform from parent.
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.
Quaternion	GetLocalOrientation () const
	Gets the orientation of this object in local space.
AttachableParent *	GetParent () const
	Gets the parent of this child.
virtual void	SetLocalLocation (const Vector3 &Location)=0
	Sets the Location of this object in local space.
virtual void	SetLocalOrientation (const Quaternion &Orientation)=0
	Sets the orientation of this object in local space.
Protected Attributes
bool	GlobalTransformDirty
bool	LocalTransformDirty
Transform	LocalXform
AttachableParent *	Parent
Friends
class	AttachableParent

---

Detailed Description

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

Definition at line 205 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 216 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 203 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 208 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 195 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.

Implemented in Mezzanine::AreaEffect, Mezzanine::Camera, Mezzanine::Entity, Mezzanine::Light, Mezzanine::ParticleEffect, and Mezzanine::WorldNode.

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.

Implemented in Mezzanine::AreaEffect, Mezzanine::Camera, Mezzanine::Entity, Mezzanine::Light, Mezzanine::ParticleEffect, and Mezzanine::WorldNode.

---

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

• attachable.h
• attachable.cpp