SO3::SBone Class Reference

#include <SO3Bone.h>

Inheritance diagram for SO3::SBone:

Public Member Functions
	SBone (SScene parent, std::string boneName, SSkeleton skeleton, unsigned short id)
	~SBone ()
Ogre::Bone *	GetOgreBonePointer ()
virtual void	Rotate (Ogre::Vector3 axis, float radianAngle, SNode::NodeTransformSpace relativeTo=SNode::SO3_LOCAL_TS)
virtual void	SetOrientation (Ogre::Quaternion quat)
virtual void	AddOrientation (Ogre::Quaternion quat)
virtual void	ResetToInitialOrientation ()
virtual void	SetPosition (Ogre::Vector3 pos)
virtual void	Translate (Ogre::Vector3 d, SNode::NodeTransformSpace relativeTo=SNode::SO3_PARENT_TS)
virtual void	SetScale (Ogre::Vector3 scale)
virtual Ogre::Vector3	GetPosition ()
virtual Ogre::Quaternion	GetOrientation ()
virtual Ogre::Vector3	GetScale ()
virtual Ogre::Vector3	GetInitialPosition ()
virtual Ogre::Quaternion	GetInitialOrientation ()
virtual Ogre::Vector3	GetInitialScale ()
virtual Ogre::Vector3	GetGlobalPosition ()
virtual Ogre::Quaternion	GetGlobalOrientation ()
virtual Ogre::Vector3	GetGlobalScale ()
virtual void	SetGlobalPosition (Ogre::Vector3 pos)
virtual void	SetGlobalOrientation (Ogre::Quaternion quat)
virtual void	SetGlobalScale (Ogre::Vector3 pos)
virtual Ogre::Matrix4	GetTransformationMatrix ()
virtual void	Pitch (float radianAngle, SNode::NodeTransformSpace relativeTo=SNode::SO3_LOCAL_TS)
virtual void	Yaw (float radianAngle, SNode::NodeTransformSpace relativeTo=SNode::SO3_LOCAL_TS)
virtual void	Roll (float radianAngle, SNode::NodeTransformSpace relativeTo=SNode::SO3_LOCAL_TS)
virtual int	GetNumChildren ()
virtual void	StoreInitialPRS ()
virtual void	ResetToInitialPRS ()
unsigned short	GetIndex ()
Ogre::Quaternion	ConvertWorldToLocalOrientation (Ogre::Quaternion quat)
virtual void	SetInheritOrientation (bool state)
virtual bool	GetInheritOrientation ()
virtual void	ResetOrientation ()
Protected Member Functions
void	AttachToBone (SNode *newChild)
void	DetachFromBone (SNode *existingChild)
Protected Attributes
SSkeleton *	parentSkeleton
Ogre::Bone *	O3Bone
Ogre::Entity *	ogreLinkedEntity
unsigned short	boneIndex
Friends
class	SNode

Detailed Description

Definition at line 44 of file SO3Bone.h.

Constructor & Destructor Documentation

SO3::SBone::SBone	(	SScene *	parent,
		std::string	boneName,
		SSkeleton *	skeleton,
		unsigned short	id
	)

Definition at line 15 of file SO3Bone.cpp.

SO3::SBone::~SBone ( )

Definition at line 54 of file SO3Bone.cpp.

Member Function Documentation

void SO3::SBone::AddOrientation ( Ogre::Quaternion quat ) [virtual]

Add a rotation to the node in local space terms.

Reimplemented from SO3::SNode.

Definition at line 88 of file SO3Bone.cpp.

void SO3::SBone::AttachToBone ( SNode * newChild ) [protected]

Definition at line 323 of file SO3Bone.cpp.

Ogre::Quaternion SO3::SBone::ConvertWorldToLocalOrientation ( Ogre::Quaternion quat )

Definition at line 375 of file SO3Bone.cpp.

void SO3::SBone::DetachFromBone ( SNode * existingChild ) [protected]

Definition at line 341 of file SO3Bone.cpp.

Ogre::Quaternion SO3::SBone::GetGlobalOrientation ( ) [virtual]

Get the node orientation in global space terms.

Reimplemented from SO3::SNode.

Definition at line 178 of file SO3Bone.cpp.

Ogre::Vector3 SO3::SBone::GetGlobalPosition ( ) [virtual]

Get the node position in global space terms.

Reimplemented from SO3::SNode.

Definition at line 164 of file SO3Bone.cpp.

Ogre::Vector3 SO3::SBone::GetGlobalScale ( ) [virtual]

Get the node scale in global space terms.

Reimplemented from SO3::SNode.

Definition at line 193 of file SO3Bone.cpp.

unsigned short SO3::SBone::GetIndex ( )

Definition at line 318 of file SO3Bone.cpp.

bool SO3::SBone::GetInheritOrientation ( ) [virtual]

Reimplemented from SO3::SNode.

Definition at line 385 of file SO3Bone.cpp.

Ogre::Quaternion SO3::SBone::GetInitialOrientation ( ) [virtual]

Get the node orientation before "play".

Reimplemented from SO3::SNode.

Definition at line 153 of file SO3Bone.cpp.

Ogre::Vector3 SO3::SBone::GetInitialPosition ( ) [virtual]

Get the node position before "play".

Reimplemented from SO3::SNode.

Definition at line 148 of file SO3Bone.cpp.

Ogre::Vector3 SO3::SBone::GetInitialScale ( ) [virtual]

Get the node scale before "play".

Reimplemented from SO3::SNode.

Definition at line 158 of file SO3Bone.cpp.

int SO3::SBone::GetNumChildren ( ) [virtual]

Reimplemented from SO3::SNode.

Definition at line 299 of file SO3Bone.cpp.

Ogre::Bone * SO3::SBone::GetOgreBonePointer ( )

Definition at line 64 of file SO3Bone.cpp.

Ogre::Quaternion SO3::SBone::GetOrientation ( ) [virtual]

Get the node orientation in local space terms.

Reimplemented from SO3::SNode.

Definition at line 138 of file SO3Bone.cpp.

Ogre::Vector3 SO3::SBone::GetPosition ( ) [virtual]

Get the node position in local space terms.

Reimplemented from SO3::SNode.

Definition at line 133 of file SO3Bone.cpp.

Ogre::Vector3 SO3::SBone::GetScale ( ) [virtual]

Get the node scale in local space terms.

Reimplemented from SO3::SNode.

Definition at line 143 of file SO3Bone.cpp.

Ogre::Matrix4 SO3::SBone::GetTransformationMatrix ( ) [virtual]

Reimplemented from SO3::SNode.

Definition at line 270 of file SO3Bone.cpp.

void SO3::SBone::Pitch	(	float	radianAngle,
		SNode::NodeTransformSpace	relativeTo = `SNode::SO3_LOCAL_TS`
	)			`[virtual]`

Reimplemented from SO3::SNode.

Definition at line 275 of file SO3Bone.cpp.

void SO3::SBone::ResetOrientation ( ) [virtual]

Reimplemented from SO3::SNode.

Definition at line 390 of file SO3Bone.cpp.

void SO3::SBone::ResetToInitialOrientation ( ) [virtual]

Reset the node Orientation as it was before "play" (as it was when "StoreInitialPRS" was called).

Reimplemented from SO3::SNode.

Definition at line 101 of file SO3Bone.cpp.

void SO3::SBone::ResetToInitialPRS ( ) [virtual]

Reset the node Position, Rotation and Scale as it was before "play" (as it was when "StoreInitialPRS" was called).

Reimplemented from SO3::SNode.

Definition at line 311 of file SO3Bone.cpp.

void SO3::SBone::Roll	(	float	radianAngle,
		SNode::NodeTransformSpace	relativeTo = `SNode::SO3_LOCAL_TS`
	)			`[virtual]`

Reimplemented from SO3::SNode.

Definition at line 291 of file SO3Bone.cpp.

void SO3::SBone::Rotate	(	Ogre::Vector3	axis,
		float	radianAngle,
		SNode::NodeTransformSpace	relativeTo = `SNode::SO3_LOCAL_TS`
	)			`[virtual]`

Reimplemented from SO3::SNode.

Definition at line 69 of file SO3Bone.cpp.

void SO3::SBone::SetGlobalOrientation ( Ogre::Quaternion quat ) [virtual]

Set the node orientation in global space terms.

Reimplemented from SO3::SNode.

Definition at line 235 of file SO3Bone.cpp.

void SO3::SBone::SetGlobalPosition ( Ogre::Vector3 pos ) [virtual]

Set the node position in global space terms.

Reimplemented from SO3::SNode.

Definition at line 209 of file SO3Bone.cpp.

void SO3::SBone::SetGlobalScale ( Ogre::Vector3 pos ) [virtual]

Set the node scale in global space terms.

Reimplemented from SO3::SNode.

Definition at line 255 of file SO3Bone.cpp.

void SO3::SBone::SetInheritOrientation ( bool state ) [virtual]

Reimplemented from SO3::SNode.

Definition at line 380 of file SO3Bone.cpp.

void SO3::SBone::SetOrientation ( Ogre::Quaternion quat ) [virtual]

Set the node orientation in local space terms.

Reimplemented from SO3::SNode.

Definition at line 78 of file SO3Bone.cpp.

void SO3::SBone::SetPosition ( Ogre::Vector3 pos ) [virtual]

Set the node position in local space terms.

Reimplemented from SO3::SNode.

Definition at line 109 of file SO3Bone.cpp.

void SO3::SBone::SetScale ( Ogre::Vector3 scale ) [virtual]

Set the node scale in local space terms.

Reimplemented from SO3::SNode.

Definition at line 125 of file SO3Bone.cpp.

void SO3::SBone::StoreInitialPRS ( ) [virtual]

Store the node actual Position, Rotation and Scale before "play".

Reimplemented from SO3::SNode.

Definition at line 304 of file SO3Bone.cpp.

void SO3::SBone::Translate	(	Ogre::Vector3	d,
		SNode::NodeTransformSpace	relativeTo = `SNode::SO3_PARENT_TS`
	)			`[virtual]`

Reimplemented from SO3::SNode.

Definition at line 117 of file SO3Bone.cpp.

void SO3::SBone::Yaw	(	float	radianAngle,
		SNode::NodeTransformSpace	relativeTo = `SNode::SO3_LOCAL_TS`
	)			`[virtual]`

Reimplemented from SO3::SNode.

Definition at line 283 of file SO3Bone.cpp.

Friends And Related Function Documentation

friend class SNode [friend]

Definition at line 46 of file SO3Bone.h.

Member Data Documentation

unsigned short SO3::SBone::boneIndex [protected]

Definition at line 52 of file SO3Bone.h.

Ogre::Bone* SO3::SBone::O3Bone [protected]

Definition at line 50 of file SO3Bone.h.

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

Definition at line 51 of file SO3Bone.h.

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

Definition at line 49 of file SO3Bone.h.

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

SO3Engine/SO3SceneGraph/SO3Bone.h
SO3Engine/SO3SceneGraph/SO3Bone.cpp

SO3::SBone Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation