SSkeleton Class Reference

#include <SO3Skeleton.h>

Inheritance diagram for 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)
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 41 of file SO3Skeleton.h.

---

Member Enumeration Documentation

enum SSkeleton::SkeletonAnimationMode

Enumerator:

SO3_ANIMBLEND_AVERAGE
SO3_ANIMBLEND_CUMULATIVE

Definition at line 44 of file SO3Skeleton.h.

---

Constructor & Destructor Documentation

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

Definition at line 14 of file SO3Skeleton.cpp.

SSkeleton::~SSkeleton

(

)

Definition at line 117 of file SO3Skeleton.cpp.

---

Member Function Documentation

void SSkeleton::_OnBoneDeletion

(

SBone *

boneInstance )

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

Definition at line 191 of file SO3Skeleton.cpp.

void SSkeleton::AddBone

(

SBone *

existingBone )

[protected]

Add a SBone object to the list of handled bones.

Definition at line 151 of file SO3Skeleton.cpp.

SSkeleton::SkeletonAnimationMode SSkeleton::GetBlendMode

(

)

Definition at line 141 of file SO3Skeleton.cpp.

SBone * SSkeleton::GetBone

(

std::string

boneName )

Definition at line 205 of file SO3Skeleton.cpp.

SBone * SSkeleton::GetBone

(

unsigned short

boneIndex )

Definition at line 214 of file SO3Skeleton.cpp.

SBoneMap SSkeleton::GetBones

(

)

const

Definition at line 223 of file SO3Skeleton.cpp.

unsigned short SSkeleton::GetNumBones

(

)

Definition at line 200 of file SO3Skeleton.cpp.

Ogre::SkeletonInstance * SSkeleton::GetOgreSkeletonPointer

(

)

Definition at line 228 of file SO3Skeleton.cpp.

SEntity * SSkeleton::GetParentEntity

(

)

Definition at line 233 of file SO3Skeleton.cpp.

SBone * SSkeleton::GetRootBone

(

)

Definition at line 238 of file SO3Skeleton.cpp.

void SSkeleton::Initialise

(

)

Definition at line 30 of file SO3Skeleton.cpp.

void SSkeleton::RemoveBone

(

std::string

boneName )

[protected]

Remove a SBone object from the list of handled bones.

Definition at line 172 of file SO3Skeleton.cpp.

void SSkeleton::RemoveBone

(

SBone *

existingBone )

[protected]

Remove a SBone object from the list of handled bones.

Definition at line 167 of file SO3Skeleton.cpp.

void SSkeleton::SetBindingPose

(

)

Definition at line 136 of file SO3Skeleton.cpp.

void SSkeleton::SetBlendMode

(

SSkeleton::SkeletonAnimationMode

newBlendMode )

Definition at line 146 of file SO3Skeleton.cpp.

---

Member Data Documentation

SBoneMap SSkeleton::boneList [protected]

Reimplemented in SSkeletonFap.

Definition at line 53 of file SO3Skeleton.h.

SBoneIndexMap SSkeleton::boneListByIndex [protected]

Definition at line 54 of file SO3Skeleton.h.

SEntity* SSkeleton::linkedEntity [protected]

Definition at line 50 of file SO3Skeleton.h.

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

Definition at line 52 of file SO3Skeleton.h.

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

Definition at line 51 of file SO3Skeleton.h.

SBone* SSkeleton::rootBone [protected]

Definition at line 55 of file SO3Skeleton.h.

---

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

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