Mezzanine::Graphics::Skeleton Class Reference

This class encapsulates the Skeletal animation functionality of a Mesh. More...

#include <skeleton.h>

Collaboration diagram for Mezzanine::Graphics::Skeleton:

Public Types
typedef std::vector< Bone * >	BoneContainer
typedef BoneContainer::iterator	BoneIterator
typedef BoneContainer::const_iterator	ConstBoneIterator
typedef NamedBoneContainer::const_iterator	ConstNamedBoneIterator
typedef std::map< String, Bone * >	NamedBoneContainer
typedef NamedBoneContainer::iterator	NamedBoneIterator

Public Member Functions
	Skeleton (Ogre::SkeletonPtr InternalSkeleton)
	Internal constructor. More...
	~Skeleton ()
	Class destructor.
Bone *	_CreateBoneWrapper (Ogre::Bone *InternalBone)
	Creates a bone wrapper for a pre-made internal bone. More...
Ogre::SkeletonPtr	_GetInternalSkeleton () const
	Gets the internal Skeleton pointer. More...
BoneIterator	BoneBegin ()
	Gets an iterator to the first Bone. More...
ConstBoneIterator	BoneBegin () const
	Gets a const iterator to the first Bone. More...
BoneIterator	BoneEnd ()
	Gets an iterator to one passed the last Bone. More...
ConstBoneIterator	BoneEnd () const
	Gets an iterator to one passed the last Bone. More...
ConstString &	GetGroup () const
	Gets the resource group this Skeleton belongs to. More...
ConstString &	GetName () const
	Gets the Name of this Skeleton. More...
UInt16	GetNumBones () const
	Gets the number of bones contained in this skeleton. More...

Protected Attributes
BoneContainer	Bones
InternalSkeletonData *	ISD

Detailed Description

This class encapsulates the Skeletal animation functionality of a Mesh.

Definition at line 63 of file skeleton.h.

Constructor & Destructor Documentation

Mezzanine::Graphics::Skeleton::Skeleton

(

Ogre::SkeletonPtr

InternalSkeleton

)

Internal constructor.

Parameters

InternalSkeleton

The internal skeleton this skeleton is based upon.

Definition at line 65 of file skeleton.cpp.

Member Function Documentation

Bone * Mezzanine::Graphics::Skeleton::_CreateBoneWrapper

(

Ogre::Bone *

InternalBone

)

Creates a bone wrapper for a pre-made internal bone.

Parameters

InternalBone

The internal bone this Bone is based on.

Definition at line 135 of file skeleton.cpp.

Ogre::SkeletonPtr Mezzanine::Graphics::Skeleton::_GetInternalSkeleton

(

)

const

Gets the internal Skeleton pointer.

Returns

Returns a shared pointer pointing to the internal Skeleton.

Definition at line 142 of file skeleton.cpp.

Skeleton::BoneIterator Mezzanine::Graphics::Skeleton::BoneBegin

(

)

Gets an iterator to the first Bone.

Returns

Returns an iterator to the first Bone being stored by this Skeleton.

Definition at line 94 of file skeleton.cpp.

Skeleton::ConstBoneIterator Mezzanine::Graphics::Skeleton::BoneBegin

(

)

const

Gets a const iterator to the first Bone.

Returns

Returns a const iterator to the first Bone being stored by this Skeleton.

Definition at line 104 of file skeleton.cpp.

Skeleton::BoneIterator Mezzanine::Graphics::Skeleton::BoneEnd

(

)

Gets an iterator to one passed the last Bone.

Returns

Returns an iterator to one passed the last Bone being stored by this Skeleton.

Definition at line 99 of file skeleton.cpp.

Skeleton::ConstBoneIterator Mezzanine::Graphics::Skeleton::BoneEnd

(

)

const

Gets an iterator to one passed the last Bone.

Returns

Returns an iterator to one passed the last Bone being stored by this Skeleton.

Definition at line 109 of file skeleton.cpp.

ConstString & Mezzanine::Graphics::Skeleton::GetGroup

(

)

const

Gets the resource group this Skeleton belongs to.

Returns

Returns a const string reference containing the group this Skeleton belongs to.

Definition at line 127 of file skeleton.cpp.

ConstString & Mezzanine::Graphics::Skeleton::GetName

(

)

const

Gets the Name of this Skeleton.

Todo:

Implement these

Note

If this Skeleton originated from a file, usually the name of the Skeleton will be the file name.

Returns

Returns a const string reference containing the name of this Skeleton.

Todo:

Implement these

Definition at line 122 of file skeleton.cpp.

UInt16 Mezzanine::Graphics::Skeleton::GetNumBones

(

)

const

Gets the number of bones contained in this skeleton.

Returns

Returns a UInt16 representing the number of bones in this skeleton.

Definition at line 89 of file skeleton.cpp.

---

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

• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Graphics/skeleton.h
• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Graphics/skeleton.cpp