AtomsCore::Joint Class Reference

Joint class. More...

#include <Joint.h>

Public Member Functions
	Joint ()
	Constructor.
	Joint (const Joint &rhs)
	Copy constructor.
	~Joint ()
	Destructor.
Joint &	operator= (const Joint &ptr)
	Assign operator.
const std::string &	name () const
	Gets the joint name. More...
void	setName (const std::string &name)
	Sets the joint name. More...
unsigned short	id () const
	Gets the joint id. More...
void	setId (unsigned short id)
	Sets the joint id. More...
const Quaternion &	rotation () const
	Gets the joint rotation. More...
void	setRotation (const Quaternion &rotation)
	Sets the joint rotation. More...
const Vector3 &	scale () const
	Gets the joint scale. More...
void	setScale (const Vector3 &scale)
	Sets the joint scale. More...
const Vector3 &	translation () const
	Gets the joint translation. More...
void	setTranslation (const Vector3 &translation)
	Sets the joint translation. More...
Matrix	matrix () const
	Gets the joint matrix. More...
void	setMatrix (const Matrix &matrix)
	Sets the joint matrix. More...
JointCPtr	parent () const
	Gets the parent joint. More...
JointPtr	parent ()
	Gets the parent joint. More...
void	setParent (JointPtr parent)
	Sets the parent joint. More...
unsigned short	numChildren () const
	Gets the number of children. More...
JointPtr	child (unsigned short i)
	Gets a child joint. More...
JointCPtr	child (unsigned short i) const
	Gets a child joint. More...
bool	addChild (JointPtr joint)
	Adds a child joint. More...
bool	removeChild (unsigned short index)
	Removes a child joint. More...
void	removeChildren ()
	Removes children.
bool	isChildOf (unsigned short index) const
	Check if this joint is a child of index.

Detailed Description

Joint class.

Member Function Documentation

addChild()

bool AtomsCore::Joint::addChild

(

JointPtr

joint

)

Adds a child joint.

Parameters

joint

Child joint

child() [1/2]

JointPtr AtomsCore::Joint::child

(

unsigned short

i

)

Gets a child joint.

Parameters

i	Child index

Returns

Child joint at index i

child() [2/2]

JointCPtr AtomsCore::Joint::child

(

unsigned short

i

)

const

Gets a child joint.

Parameters

i	Child index

Returns

Child joint at index i

id()

unsigned short AtomsCore::Joint::id ( ) const

inline

Gets the joint id.

Returns

Joint id

matrix()

Matrix AtomsCore::Joint::matrix

(

)

const

Gets the joint matrix.

Returns

Joint matrix

name()

const std::string & AtomsCore::Joint::name ( ) const

inline

Gets the joint name.

Returns

Joint name

numChildren()

unsigned short AtomsCore::Joint::numChildren ( ) const

inline

Gets the number of children.

Returns

Number of children

parent() [1/2]

JointPtr AtomsCore::Joint::parent ( )

inline

Gets the parent joint.

Returns

Parent joint

parent() [2/2]

JointCPtr AtomsCore::Joint::parent ( ) const

inline

Gets the parent joint.

Returns

Parent joint

removeChild()

bool AtomsCore::Joint::removeChild

(

unsigned short

index

)

Removes a child joint.

Parameters

index

Child joint index

rotation()

const Quaternion & AtomsCore::Joint::rotation ( ) const

inline

Gets the joint rotation.

Returns

Quaternion Joint rotation

scale()

const Vector3 & AtomsCore::Joint::scale ( ) const

inline

Gets the joint scale.

Returns

Joint scale

setId()

void AtomsCore::Joint::setId ( unsigned short  id )

inline

Sets the joint id.

Parameters

id

Joint id

setMatrix()

void AtomsCore::Joint::setMatrix

(

const Matrix &

matrix

)

Sets the joint matrix.

Parameters

matrix

Joint matrix

setName()

void AtomsCore::Joint::setName ( const std::string &  name )

inline

Sets the joint name.

Parameters

name	Joint name

setParent()

void AtomsCore::Joint::setParent ( JointPtr  parent )

inline

Sets the parent joint.

Parameters

parent

Parent joint

setRotation()

void AtomsCore::Joint::setRotation ( const Quaternion &  rotation )

inline

Sets the joint rotation.

Parameters

rotation

joint rotation

setScale()

void AtomsCore::Joint::setScale ( const Vector3 &  scale )

inline

Sets the joint scale.

Parameters

scale

Joint scale

setTranslation()

void AtomsCore::Joint::setTranslation ( const Vector3 &  translation )

inline

Sets the joint translation.

Parameters

translation

Joint translation

translation()

const Vector3 & AtomsCore::Joint::translation ( ) const

inline

Gets the joint translation.

Returns

Joint translation

---

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

• C:/projects/AtomsVFX/Atoms/Public/AtomsCore/Joint.h
• C:/projects/AtomsVFX/Atoms/Public/AtomsCore/Joint.impl.h