SkeletonPose Class Reference

Instance of a skeleton, contains the pose the current skeleton is in. More...

#include <SkeletonPose.h>

Classes
struct	DrawSettings
	Draw settings. More...

Public Types
using	JointState = SkeletalAnimation::JointState
using	JointStateVector = Array<JointState>
using	Mat44Vector = Array<Mat44>

Public Member Functions
void	SetRootOffset (RVec3Arg inOffset)
	Extra offset applied to the root (and therefore also to all of its children)
RVec3	GetRootOffset () const
void	CalculateJointMatrices ()
	Convert the joint states to joint matrices.
void	CalculateJointStates ()
	Convert joint matrices to joint states.
void	CalculateLocalSpaceJointMatrices (Mat44 *outMatrices) const
	Outputs the joint matrices in local space (ensure that outMatrices has GetJointCount() elements, assumes that values in GetJoints() is up to date)
void	Draw (const DrawSettings &inDrawSettings, DebugRenderer *inRenderer, RMat44Arg inOffset=RMat44::sIdentity()) const
	Draw current pose.
Skeleton
void	SetSkeleton (const Skeleton *inSkeleton)
const Skeleton *	GetSkeleton () const
Properties of the joints
uint	GetJointCount () const
const JointStateVector &	GetJoints () const
JointStateVector &	GetJoints ()
const JointState &	GetJoint (int inJoint) const
JointState &	GetJoint (int inJoint)
Joint matrices
const Mat44Vector &	GetJointMatrices () const
Mat44Vector &	GetJointMatrices ()
const Mat44 &	GetJointMatrix (int inJoint) const
Mat44 &	GetJointMatrix (int inJoint)

Detailed Description

Instance of a skeleton, contains the pose the current skeleton is in.

Member Typedef Documentation

JointState

using SkeletonPose::JointState = SkeletalAnimation::JointState

JointStateVector

using SkeletonPose::JointStateVector = Array<JointState>

Mat44Vector

using SkeletonPose::Mat44Vector = Array<Mat44>

Member Function Documentation

CalculateJointMatrices()

void SkeletonPose::CalculateJointMatrices

(

)

Convert the joint states to joint matrices.

CalculateJointStates()

void SkeletonPose::CalculateJointStates

(

)

Convert joint matrices to joint states.

CalculateLocalSpaceJointMatrices()

void SkeletonPose::CalculateLocalSpaceJointMatrices

(

Mat44 *

outMatrices

)

const

Outputs the joint matrices in local space (ensure that outMatrices has GetJointCount() elements, assumes that values in GetJoints() is up to date)

Draw()

void SkeletonPose::Draw	(	const DrawSettings &	inDrawSettings,
		DebugRenderer *	inRenderer,
		RMat44Arg	inOffset = RMat44::sIdentity() ) const

Draw current pose.

GetJoint() [1/2]

JointState & SkeletonPose::GetJoint ( int inJoint )

inline

GetJoint() [2/2]

const JointState & SkeletonPose::GetJoint ( int inJoint ) const

inline

GetJointCount()

uint SkeletonPose::GetJointCount ( ) const

inline

GetJointMatrices() [1/2]

Mat44Vector & SkeletonPose::GetJointMatrices ( )

inline

GetJointMatrices() [2/2]

const Mat44Vector & SkeletonPose::GetJointMatrices ( ) const

inline

GetJointMatrix() [1/2]

Mat44 & SkeletonPose::GetJointMatrix ( int inJoint )

inline

GetJointMatrix() [2/2]

const Mat44 & SkeletonPose::GetJointMatrix ( int inJoint ) const

inline

GetJoints() [1/2]

JointStateVector & SkeletonPose::GetJoints ( )

inline

GetJoints() [2/2]

const JointStateVector & SkeletonPose::GetJoints ( ) const

inline

GetRootOffset()

RVec3 SkeletonPose::GetRootOffset ( ) const

inline

GetSkeleton()

const Skeleton * SkeletonPose::GetSkeleton ( ) const

inline

SetRootOffset()

void SkeletonPose::SetRootOffset ( RVec3Arg inOffset )

inline

Extra offset applied to the root (and therefore also to all of its children)

SetSkeleton()

JPH_NAMESPACE_BEGIN void SkeletonPose::SetSkeleton

(

const Skeleton *

inSkeleton

)

---

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

• Jolt/Skeleton/SkeletonPose.h
• Jolt/Skeleton/SkeletonPose.cpp