SO3::SSkeleton Class Reference

#include <SO3Skeleton.h>

Inheritance diagram for SO3::SSkeleton:

List of all members.

Public Types
enum	SkeletonAnimationMode { SO3_ANIMBLEND_AVERAGE, SO3_ANIMBLEND_CUMULATIVE }
Public Member Functions
	SSkeleton (SScene *parent, std::string skeletonName, SEntity *parentEntity)
	~SSkeleton ()
void	Initialise ()
void	SetBindingPose ()
SkeletonAnimationMode	GetBlendMode ()
void	SetBlendMode (SkeletonAnimationMode newBlendMode)
unsigned short	GetNumBones ()
SBone *	GetBone (std::string boneName)
SBone *	GetBone (unsigned short boneIndex)
SBoneMap	GetBones () const
Ogre::SkeletonInstance *	GetOgreSkeletonPointer ()
SEntity *	GetParentEntity ()
SBone *	GetRootBone ()
void	_OnBoneDeletion (SBone *boneInstance)
virtual Ogre::Vector3	GetGlobalPosition ()
virtual Ogre::Quaternion	GetGlobalOrientation ()
virtual Ogre::Vector3	GetGlobalScale ()
virtual void	SetGlobalPosition (Ogre::Vector3 pos)
virtual void	SetGlobalOrientation (Ogre::Quaternion quat)
Protected Member Functions
void	AddBone (SBone *existingBone)
void	RemoveBone (SBone *existingBone)
void	RemoveBone (std::string boneName)
Protected Attributes
SEntity *	linkedEntity
Ogre::Entity *	ogreLinkedEntity
Ogre::SkeletonInstance *	O3SkeletonInstance
SBoneMap	boneList
SBoneIndexMap	boneListByIndex
SBone *	rootBone

---

Detailed Description

Definition at line 44 of file SO3Skeleton.h.

---

Member Enumeration Documentation

enum SO3::SSkeleton::SkeletonAnimationMode

Enumerator:

SO3_ANIMBLEND_AVERAGE
SO3_ANIMBLEND_CUMULATIVE

Definition at line 47 of file SO3Skeleton.h.

---

Constructor & Destructor Documentation

SO3::SSkeleton::SSkeleton	(	SScene *	parent,
		std::string	skeletonName,
		SEntity *	parentEntity
	)

Definition at line 17 of file SO3Skeleton.cpp.

SO3::SSkeleton::~SSkeleton

(

)

Definition at line 120 of file SO3Skeleton.cpp.

---

Member Function Documentation

void SO3::SSkeleton::_OnBoneDeletion

(

SBone *

boneInstance

)

Hack to avoid problems at bone destruction, SBone internal use only.

Definition at line 194 of file SO3Skeleton.cpp.

void SO3::SSkeleton::AddBone

(

SBone *

existingBone

)

[protected]

Add a SBone object to the list of handled bones.

Definition at line 154 of file SO3Skeleton.cpp.

SSkeleton::SkeletonAnimationMode SO3::SSkeleton::GetBlendMode

(

)

Definition at line 144 of file SO3Skeleton.cpp.

SBone * SO3::SSkeleton::GetBone

(

unsigned short

boneIndex

)

Definition at line 217 of file SO3Skeleton.cpp.

SBone * SO3::SSkeleton::GetBone

(

std::string

boneName

)

Definition at line 208 of file SO3Skeleton.cpp.

SBoneMap SO3::SSkeleton::GetBones

(

)

const

Definition at line 226 of file SO3Skeleton.cpp.

Ogre::Quaternion SO3::SSkeleton::GetGlobalOrientation

(

)

[virtual]

Get the node orientation in global space terms.

Reimplemented from SO3::SNode.

Definition at line 251 of file SO3Skeleton.cpp.

Ogre::Vector3 SO3::SSkeleton::GetGlobalPosition

(

)

[virtual]

Get the node position in global space terms.

Reimplemented from SO3::SNode.

Definition at line 246 of file SO3Skeleton.cpp.

Ogre::Vector3 SO3::SSkeleton::GetGlobalScale

(

)

[virtual]

Get the node scale in global space terms.

Reimplemented from SO3::SNode.

Definition at line 256 of file SO3Skeleton.cpp.

unsigned short SO3::SSkeleton::GetNumBones

(

)

Definition at line 203 of file SO3Skeleton.cpp.

Ogre::SkeletonInstance * SO3::SSkeleton::GetOgreSkeletonPointer

(

)

Definition at line 231 of file SO3Skeleton.cpp.

SEntity * SO3::SSkeleton::GetParentEntity

(

)

Definition at line 236 of file SO3Skeleton.cpp.

SBone * SO3::SSkeleton::GetRootBone

(

)

Definition at line 241 of file SO3Skeleton.cpp.

void SO3::SSkeleton::Initialise

(

)

Definition at line 33 of file SO3Skeleton.cpp.

void SO3::SSkeleton::RemoveBone

(

std::string

boneName

)

[protected]

Remove a SBone object from the list of handled bones.

Definition at line 175 of file SO3Skeleton.cpp.

void SO3::SSkeleton::RemoveBone

(

SBone *

existingBone

)

[protected]

Remove a SBone object from the list of handled bones.

Definition at line 170 of file SO3Skeleton.cpp.

void SO3::SSkeleton::SetBindingPose

(

)

Definition at line 139 of file SO3Skeleton.cpp.

void SO3::SSkeleton::SetBlendMode

(

SSkeleton::SkeletonAnimationMode

newBlendMode

)

Definition at line 149 of file SO3Skeleton.cpp.

void SO3::SSkeleton::SetGlobalOrientation

(

Ogre::Quaternion

quat

)

[virtual]

Set the node orientation in global space terms.

Reimplemented from SO3::SNode.

Definition at line 266 of file SO3Skeleton.cpp.

void SO3::SSkeleton::SetGlobalPosition

(

Ogre::Vector3

pos

)

[virtual]

Set the node position in global space terms.

Reimplemented from SO3::SNode.

Definition at line 261 of file SO3Skeleton.cpp.

---

Member Data Documentation

SBoneMap SO3::SSkeleton::boneList [protected]

Reimplemented in SO3::SSkeletonFap.

Definition at line 56 of file SO3Skeleton.h.

SBoneIndexMap SO3::SSkeleton::boneListByIndex [protected]

Definition at line 57 of file SO3Skeleton.h.

SEntity* SO3::SSkeleton::linkedEntity [protected]

Definition at line 53 of file SO3Skeleton.h.

Ogre::SkeletonInstance* SO3::SSkeleton::O3SkeletonInstance [protected]

Definition at line 55 of file SO3Skeleton.h.

Ogre::Entity* SO3::SSkeleton::ogreLinkedEntity [protected]

Definition at line 54 of file SO3Skeleton.h.

SBone* SO3::SSkeleton::rootBone [protected]

Definition at line 58 of file SO3Skeleton.h.

---

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

• SO3Engine/SO3SceneGraph/SO3Skeleton.h
• SO3Engine/SO3SceneGraph/SO3Skeleton.cpp