Pose class. More...

#include <Pose.h>

Public Types
typedef std::map< unsigned short, MapMetadata >	JointMetadataMap
	Joint metadata map.

Public Member Functions
	Pose ()
	Constructor.

	Pose (const Skeleton *skeleton, bool inParentSpace=false)
	Constructor. More...

	Pose (const Pose &rhs)
	Copy constructor.

	~Pose ()
	Destructor.

Pose &	operator= (const Pose &rhs)
	Assign operator.

void	setNumberJoints (unsigned short n)
	Sets the number of joints. More...

unsigned short	numJoints () const
	Gets the number of joints. More...

JointPose &	jointPose (unsigned short index)
	Gets the joint pose. More...

const JointPose &	jointPose (unsigned short index) const
	Gets the joint pose. More...

void	setJointPose (unsigned short index, const JointPose &jointPose)
	Sets the joint pose. More...

void	clearAllPose ()
	Clears all pose.

void	setDirection (const AtomsCore::Vector3 &direction)
	Sets the pose direction. More...

const AtomsCore::Vector3 &	getDirection () const
	Gets the pose direction. More...

bool	jointHasMetadata (unsigned short index) const
	Checks if a joint has some metadata. More...

JointMetadataMap &	jointsMetadata ()
	Gets the joints metadata map. More...

const JointMetadataMap &	jointsMetadata () const
	Gets the joints metadata map. More...

MapMetadata &	jointMetadata (unsigned short index)
	Gets the joint metadata. More...

const MapMetadata &	jointMetadata (unsigned short index) const
	Gets the joint metadata. More...

void	setJointMetadata (unsigned short index, const MapMetadata &data)
	Adds joint metadata. More...

void	addJointMetadata (unsigned short index, const std::string &key, Metadata *data)
	Adds joint metadata. More...

void	addJointMetadata (unsigned short index, const std::string &key, const AtomsPtr< Metadata > data)
	Adds joint metadata. More...

void	clearJointMetadata (unsigned short index)
	Clears joint metadata. More...

MapMetadata &	poseMetadata ()
	Gets the pose metadata map. More...

const MapMetadata &	poseMetadata () const
	Gets the pose metadata map. More...

void	addPoseMetadata (const std::string &key, Metadata *data)
	Adds the pose metadata. More...

void	clearPoseMetadata ()
	Clears the pose metadata.

void	clearJointsMetadata ()
	Clears all joint metadata.

size_t	memSize () const
	Gets the memory size.

std::vector< unsigned short >	jointMetadataIds () const
	Gets the ids of the joints that have some metadatas.

size_t	hash (short roundBits=10) const
	Return the hash of this pose. More...

void	resetActiveJoints ()

void	setActiveJoints (const std::vector< short > &flags)

void	setActiveJoint (size_t index, bool value)

bool	isJointActive (size_t index) const

void	setInParentSpace (bool flag)
	Sets use parent space flag.

bool	inParentSpace () const
	Gets the parent space flag.

void	convertToParentSpace (const Skeleton *skeleton)
	Converts this pose to parent space.

void	convertToLocalSpace (const Skeleton *skeleton)
	Converts this pose to local space.

Detailed Description

Pose class.

A pose defines the transformations and metadatas of a set of joints.

Constructor & Destructor Documentation

◆ Pose()

AtomsCore::Pose::Pose	(	const Skeleton *	skeleton,
		bool	inParentSpace = `false`
	)

Constructor.

Parameters

skeleton Skeleton

Member Function Documentation

◆ addJointMetadata() [1/2]

void AtomsCore::Pose::addJointMetadata	(	unsigned short	index,
		const std::string &	key,
		const AtomsPtr< Metadata >	data
	)

inline

Adds joint metadata.

Parameters

index	Joint index
key	metadata map key
data	metadata

◆ addJointMetadata() [2/2]

void AtomsCore::Pose::addJointMetadata	(	unsigned short	index,
		const std::string &	key,
		Metadata *	data
	)

inline

Adds joint metadata.

Parameters

index	Joint index
key	metadata map key
data	metadata

◆ addPoseMetadata()

void AtomsCore::Pose::addPoseMetadata	(	const std::string &	key,
		Metadata *	data
	)

inline

Adds the pose metadata.

Parameters

key	metadata key
data	metadata

◆ clearJointMetadata()

void AtomsCore::Pose::clearJointMetadata ( unsigned short index )

Clears joint metadata.

Parameters

index Joint index

◆ getDirection()

const AtomsCore::Vector3 & AtomsCore::Pose::getDirection ( ) const

inline

Gets the pose direction.

Returns: pose direction

◆ hash()

size_t AtomsCore::Pose::hash ( short roundBits = 10 ) const

Return the hash of this pose.

The hash is computed without the root joint

◆ jointHasMetadata()

bool AtomsCore::Pose::jointHasMetadata ( unsigned short index ) const

Checks if a joint has some metadata.

Parameters

index Joint index

Returns: Return true if joint has some metadata

◆ jointMetadata() [1/2]

MapMetadata & AtomsCore::Pose::jointMetadata ( unsigned short index )

inline

Gets the joint metadata.

Parameters

index Joint index

Returns: Joint metadata map

◆ jointMetadata() [2/2]

const MapMetadata& AtomsCore::Pose::jointMetadata ( unsigned short index ) const

Gets the joint metadata.

Parameters

index Joint index

Returns: Joint metadata map

◆ jointPose() [1/2]

JointPose & AtomsCore::Pose::jointPose ( unsigned short index )

inline

Gets the joint pose.

Returns: Joint pose

◆ jointPose() [2/2]

const JointPose & AtomsCore::Pose::jointPose ( unsigned short index ) const

inline

Gets the joint pose.

Returns: Joint pose

◆ jointsMetadata() [1/2]

Pose::JointMetadataMap & AtomsCore::Pose::jointsMetadata ( )

inline

Gets the joints metadata map.

Returns: Joints metadata map

◆ jointsMetadata() [2/2]

const Pose::JointMetadataMap & AtomsCore::Pose::jointsMetadata ( ) const

inline

Gets the joints metadata map.

Returns: Joints metadata map

◆ numJoints()

unsigned short AtomsCore::Pose::numJoints ( ) const

inline

Gets the number of joints.

Returns: Number of joints

◆ poseMetadata() [1/2]

MapMetadata & AtomsCore::Pose::poseMetadata ( )

inline

Gets the pose metadata map.

Returns: Pose metadata map

◆ poseMetadata() [2/2]

const MapMetadata & AtomsCore::Pose::poseMetadata ( ) const

inline

Gets the pose metadata map.

Returns: Pose metadata map

◆ setDirection()

void AtomsCore::Pose::setDirection ( const AtomsCore::Vector3 & direction )

inline

Sets the pose direction.

Parameters

direction pelvis direction

◆ setJointMetadata()

void AtomsCore::Pose::setJointMetadata	(	unsigned short	index,
		const MapMetadata &	data
	)

inline

Adds joint metadata.

Parameters

index	Joint index
data	Joint metadata map

◆ setJointPose()

void AtomsCore::Pose::setJointPose	(	unsigned short	index,
		const JointPose &	jointPose
	)

inline

Sets the joint pose.

Parameters

index	joint index
jointPose	Joint pose

◆ setNumberJoints()

void AtomsCore::Pose::setNumberJoints ( unsigned short n )

Sets the number of joints.

Sets the number of joints this pose contains. All the data previosly stored is deleted before reallocate the space for the new number of joints

Parameters

n	Number of joint

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

C:/projects/AtomsVFX/Atoms/Public/AtomsCore/Pose.h
C:/projects/AtomsVFX/Atoms/Public/AtomsCore/Pose.impl.h

Public Types

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Pose()

Member Function Documentation

◆ addJointMetadata() [1/2]

◆ addJointMetadata() [2/2]

◆ addPoseMetadata()

◆ clearJointMetadata()

◆ getDirection()

◆ hash()

◆ jointHasMetadata()

◆ jointMetadata() [1/2]

◆ jointMetadata() [2/2]

◆ jointPose() [1/2]

◆ jointPose() [2/2]

◆ jointsMetadata() [1/2]

◆ jointsMetadata() [2/2]

◆ numJoints()

◆ poseMetadata() [1/2]

◆ poseMetadata() [2/2]

◆ setDirection()

◆ setJointMetadata()

◆ setJointPose()

◆ setNumberJoints()