This class encapsulates the bones contained in a skeleton used for animation. More...

#include <bone.h>

Inheritance diagram for Mezzanine::Graphics::Bone:

Collaboration diagram for Mezzanine::Graphics::Bone:

Public Member Functions
Ogre::Bone *	_GetInternalBone () const
	Gets the internal bone pointer. More...

Bone *	CreateChild (const UInt16 Handle, const Vector3 &Trans, const Quaternion &Rot)
	Creates a new bone in the parent skeleton as a child of this bone. More...

Bone *	GetChild (const UInt16 Index) const
	Gets a child bone by it's index. More...

Bone *	GetChild (const String &Name) const
	Gets a child bone by it's name. More...

UInt16	GetHandle () const
	Gets the unique identifying number belonging to this bone. More...

Skeleton *	GetHost () const
	Gets the host skeleton this bone belongs to. More...

Vector3	GetLocation () const
	Gets this objects current location. More...

Boole	GetManuallyControlled () const
	Gets whether or not this bone is being manually controlled. More...

const String &	GetName () const
	Gets the name of this Bone. More...

UInt16	GetNumChildren () const
	Gets the number of child bones contained by this bone. More...

Quaternion	GetOrientation () const
	Gets this objects current orientation. More...

Vector3	GetScale () const
	Gets the scaling currently being applied to this object. More...

void	Pitch (const Real Angle, const Mezzanine::TransformSpace Space=Mezzanine::TS_Parent)
	Rotate the object around the X axis. More...

void	RemoveChild (Bone *ToBeRemoved)
	Removes a bone from this bone. More...

void	RemoveChild (const UInt16 Index)
	Removes a bone from this bone by index. More...

void	RemoveChild (const String &Name)
	Removes a bone from this bone. More...

void	Roll (const Real Angle, const Mezzanine::TransformSpace Space=Mezzanine::TS_Parent)
	Rotate the object around the Z axis. More...

void	Rotate (const Vector3 &Axis, const Real Angle, const Mezzanine::TransformSpace Space=Mezzanine::TS_Parent)
	Rotates the object from it's existing rotation. More...

void	Rotate (const Quaternion &Rotation, const Mezzanine::TransformSpace Space=Mezzanine::TS_Parent)
	Rotates the object from it's existing rotation. More...

void	Scale (const Vector3 &Scale)
	Scales the object from it's current size. More...

void	Scale (const Real X, const Real Y, const Real Z)
	Scales the object from it's current size. More...

void	SetLocation (const Vector3 &Loc)
	Sets the location of this object in parent space. More...

void	SetLocation (const Real X, const Real Y, const Real Z)
	Sets the location of this object in parent space via Reals. More...

void	SetManuallyControlled (Boole Manual)
	Sets whether or not this bone is to be manually controlled. More...

void	SetOrientation (const Quaternion &Ori)
	Sets the orientation of this object in parent space. More...

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...

void	SetScale (const Vector3 &Sc)
	Sets the scaling to be applied to this object. More...

void	SetScale (const Real X, const Real Y, const Real Z)
	Sets the scaling to be applied to this object via Reals. More...

void	Translate (const Vector3 &Trans, const Mezzanine::TransformSpace Space=Mezzanine::TS_Parent)
	Moves this object from it's current location. More...

void	Translate (const Real X, const Real Y, const Real Z, const Mezzanine::TransformSpace Space=Mezzanine::TS_Parent)
	Moves this object from it's current location. More...

void	Yaw (const Real Angle, const Mezzanine::TransformSpace Space=Mezzanine::TS_Parent)
	Rotate the object around the Y axis. More...

Public Member Functions inherited from Mezzanine::TransformableChildObject
virtual	~TransformableChildObject ()
	Class Destructor.

Protected Member Functions
	Bone (Skeleton HostSkel, Ogre::Bone InternalBone)
	Internal constructor. More...

	~Bone ()
	Class destructor.

Protected Attributes
Ogre::Bone *	GraphicsBone
	The pointer to the internal Bone this is based on. More...

Skeleton *	Host
	The host skeleton this bone belongs to. More...

Friends
class	Skeleton

Detailed Description

This class encapsulates the bones contained in a skeleton used for animation.

Definition at line 59 of file bone.h.

Constructor & Destructor Documentation

Mezzanine::Graphics::Bone::Bone	(	Skeleton *	HostSkel,
		Ogre::Bone *	InternalBone
	)

protected

Internal constructor.

Parameters

HostSkel	The parent skeleton this bone blongs to.
InternalBone	The internal bone this Bone is based on.

Definition at line 68 of file bone.cpp.

Member Function Documentation

Ogre::Bone * Mezzanine::Graphics::Bone::_GetInternalBone ( ) const

Gets the internal bone pointer.

Returns: Returns a shared pointer pointing to the internal bone.

Definition at line 182 of file bone.cpp.

Bone * Mezzanine::Graphics::Bone::CreateChild	(	const UInt16	Handle,
		const Vector3 &	Trans,
		const Quaternion &	Rot
	)

Creates a new bone in the parent skeleton as a child of this bone.

Parameters

Handle	The handle to be given to the bone being created. Must be unique to the parent skeleton.
Trans	The translation to apply to the created bone.
Rot	The rotation to apply to the created bone.

Returns: Returns a pointer to the created child bone.

Definition at line 101 of file bone.cpp.

Bone * Mezzanine::Graphics::Bone::GetChild ( const UInt16 Index ) const

Gets a child bone by it's index.

Parameters

Index The index of the bone to retrieve.

Returns: Returns a pointer to the requested Bone.

Definition at line 107 of file bone.cpp.

Bone * Mezzanine::Graphics::Bone::GetChild ( const String & Name ) const

Gets a child bone by it's name.

Parameters

Name	The name of the bone to retrieve.

Returns: Returns a pointer to the requested Bone.

Definition at line 110 of file bone.cpp.

UInt16 Mezzanine::Graphics::Bone::GetHandle ( ) const

Gets the unique identifying number belonging to this bone.

Returns: Returns a UInt16 representing the identifier unique to this bone within it's parent skeleton.

Definition at line 89 of file bone.cpp.

Skeleton * Mezzanine::Graphics::Bone::GetHost ( ) const

Gets the host skeleton this bone belongs to.

Returns: Returns a pointer to the parent skeleton.

Definition at line 83 of file bone.cpp.

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

virtual

Gets this objects current location.

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

Implements Mezzanine::TransformableChildObject.

Definition at line 131 of file bone.cpp.

Boole Mezzanine::Graphics::Bone::GetManuallyControlled ( ) const

Gets whether or not this bone is being manually controlled.

Returns: Returns true if this bone can be directly manipulated, false otherwise.

Definition at line 95 of file bone.cpp.

const String & Mezzanine::Graphics::Bone::GetName ( ) const

Gets the name of this Bone.

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

Definition at line 86 of file bone.cpp.

UInt16 Mezzanine::Graphics::Bone::GetNumChildren ( ) const

Gets the number of child bones contained by this bone.

Returns: Returns a UInt16 containing the number of bones that are children of this bone.

Definition at line 104 of file bone.cpp.

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

virtual

Gets this objects current orientation.

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

Implements Mezzanine::TransformableChildObject.

Definition at line 140 of file bone.cpp.

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

virtual

Gets the scaling currently being applied to this object.

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

Implements Mezzanine::TransformableChildObject.

Definition at line 149 of file bone.cpp.

void Mezzanine::Graphics::Bone::Pitch	(	const Real	Angle,
		const Mezzanine::TransformSpace	Space = `Mezzanine::TS_Parent`
	)

virtual

Rotate the object around the X axis.

Parameters

Angle	The angle to rotate this object in radians.
Space	The transform space in which to apply this rotation.

Implements Mezzanine::TransformableChildObject.

Definition at line 161 of file bone.cpp.

void Mezzanine::Graphics::Bone::RemoveChild ( Bone * ToBeRemoved )

Removes a bone from this bone.

Note: This does not remove the bone from the skeleton.

Parameters

ToBeRemoved The child bone to be removed from this bone.

Definition at line 113 of file bone.cpp.

void Mezzanine::Graphics::Bone::RemoveChild ( const UInt16 Index )

Removes a bone from this bone by index.

Note: This does not remove the bone from the skeleton.

Parameters

Index The index of the child bone to be removed from this bone.

Definition at line 116 of file bone.cpp.

void Mezzanine::Graphics::Bone::RemoveChild ( const String & Name )

Removes a bone from this bone.

Note: This does not remove the bone from the skeleton.

Parameters

Name	The name of the child bone to be removed from this bone.

Definition at line 119 of file bone.cpp.

void Mezzanine::Graphics::Bone::Roll	(	const Real	Angle,
		const Mezzanine::TransformSpace	Space = `Mezzanine::TS_Parent`
	)

virtual

Rotate the object around the Z axis.

Parameters

Angle	The angle to rotate this object in radians.
Space	The transform space in which to apply this rotation.

Implements Mezzanine::TransformableChildObject.

Definition at line 164 of file bone.cpp.

void Mezzanine::Graphics::Bone::Rotate	(	const Vector3 &	Axis,
		const Real	Angle,
		const Mezzanine::TransformSpace	Space = `Mezzanine::TS_Parent`
	)

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.
Space	The transform space in which to apply this rotation.

Implements Mezzanine::TransformableChildObject.

Definition at line 167 of file bone.cpp.

void Mezzanine::Graphics::Bone::Rotate	(	const Quaternion &	Rotation,
		const Mezzanine::TransformSpace	Space = `Mezzanine::TS_Parent`
	)

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.
Space	The transform space in which to apply this rotation.

Implements Mezzanine::TransformableChildObject.

Definition at line 170 of file bone.cpp.

void Mezzanine::Graphics::Bone::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.

Implements Mezzanine::TransformableChildObject.

Definition at line 173 of file bone.cpp.

void Mezzanine::Graphics::Bone::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.

Implements Mezzanine::TransformableChildObject.

Definition at line 176 of file bone.cpp.

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

virtual

Sets the location of this object in parent space.

Parameters

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

Implements Mezzanine::TransformableChildObject.

Definition at line 125 of file bone.cpp.

void Mezzanine::Graphics::Bone::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.

Implements Mezzanine::TransformableChildObject.

Definition at line 128 of file bone.cpp.

void Mezzanine::Graphics::Bone::SetManuallyControlled ( Boole Manual )

Sets whether or not this bone is to be manually controlled.

Parameters

Manual True to allow this bone to be explicitly altered, false to make it only accept animation updates.

Definition at line 92 of file bone.cpp.

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

virtual

Sets the orientation of this object in parent space.

Parameters

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

Implements Mezzanine::TransformableChildObject.

Definition at line 134 of file bone.cpp.

void Mezzanine::Graphics::Bone::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.

Implements Mezzanine::TransformableChildObject.

Definition at line 137 of file bone.cpp.

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

virtual

Sets the scaling to be applied to this object.

Parameters

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

Implements Mezzanine::TransformableChildObject.

Definition at line 143 of file bone.cpp.

void Mezzanine::Graphics::Bone::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.

Implements Mezzanine::TransformableChildObject.

Definition at line 146 of file bone.cpp.

void Mezzanine::Graphics::Bone::Translate	(	const Vector3 &	Trans,
		const Mezzanine::TransformSpace	Space = `Mezzanine::TS_Parent`
	)

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.
Space	The transform space in which to apply this translation.

Implements Mezzanine::TransformableChildObject.

Definition at line 152 of file bone.cpp.

void Mezzanine::Graphics::Bone::Translate	(	const Real	X,
		const Real	Y,
		const Real	Z,
		const Mezzanine::TransformSpace	Space = `Mezzanine::TS_Parent`
	)

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.
Space	The transform space in which to apply this translation.

Implements Mezzanine::TransformableChildObject.

Definition at line 155 of file bone.cpp.

void Mezzanine::Graphics::Bone::Yaw	(	const Real	Angle,
		const Mezzanine::TransformSpace	Space = `Mezzanine::TS_Parent`
	)

virtual

Rotate the object around the Y axis.

Parameters

Angle	The angle to rotate this object in radians.
Space	The transform space in which to apply this rotation.

Implements Mezzanine::TransformableChildObject.

Definition at line 158 of file bone.cpp.

Member Data Documentation

Ogre::Bone* Mezzanine::Graphics::Bone::GraphicsBone

protected

The pointer to the internal Bone this is based on.

Definition at line 65 of file bone.h.

Skeleton* Mezzanine::Graphics::Bone::Host

protected

The host skeleton this bone belongs to.

Definition at line 68 of file bone.h.

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

/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Graphics/bone.h
/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Graphics/bone.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation