PLMesh::Joint Class Reference

Skeleton joint element. More...

#include <Joint.h>

Inheritance diagram for PLMesh::Joint:

List of all members.

Public Member Functions
PLMESH_API	Joint (const PLCore::String &sName="", PLCore::ElementManager< Joint > *pManager=nullptr)
	Constructor.
virtual PLMESH_API	~Joint ()
	Destructor.
PLMESH_API int	GetID () const
	Get the ID of this joint.
PLMESH_API void	SetID (int nID=-1)
	Set the ID this joint.
PLMESH_API int	GetParent () const
	Get the parent joint number of this joint.
PLMESH_API void	SetParent (int nParent=-1)
	Set the parent joint number of this joint.
PLMESH_API const PLCore::Array < PLCore::uint32 > &	GetChildren () const
	Gets an array with the child joints.
PLMESH_API Joint &	operator= (const Joint &cSource)
	Copy operator.
PLMESH_API bool	operator== (const Joint &cJoint) const
	Compares two joints.

---

Detailed Description

Skeleton joint element.

---

Constructor & Destructor Documentation

PLMESH_API PLMesh::Joint::Joint	(	const PLCore::String &	sName = "",
		PLCore::ElementManager< Joint > *	pManager = nullptr
	)

Constructor.

Parameters:

[in]	sName	Element name to set
[in]	pManager	Element manager using this element, can be a null pointer

virtual PLMESH_API PLMesh::Joint::~Joint

(

)

[virtual]

Destructor.

---

Member Function Documentation

PLMESH_API int PLMesh::Joint::GetID

(

)

const

Get the ID of this joint.

Returns:

ID of this joint, < 0 normally means this is an unused ID

Reimplemented from PLCore::Element< Joint >.

PLMESH_API void PLMesh::Joint::SetID

(

int

nID = -1

)

Set the ID this joint.

Parameters:

[in]

nID

ID of this joint

PLMESH_API int PLMesh::Joint::GetParent

(

)

const

Get the parent joint number of this joint.

Returns:

Number of the parent joint number, if < 0 no parent

PLMESH_API void PLMesh::Joint::SetParent

(

int

nParent = -1

)

Set the parent joint number of this joint.

Parameters:

[in]

nParent

Number of the parent joint number, if < 0 no parent

PLMESH_API const PLCore::Array<PLCore::uint32>& PLMesh::Joint::GetChildren

(

)

const

Gets an array with the child joints.

Returns:

Child joints array

Note:

• Call Skeleton::UpdateJointInformation() after changing parent/child joints!

PLMESH_API Joint& PLMesh::Joint::operator=

(

const Joint &

cSource

)

Copy operator.

Parameters:

[in]

cSource

Source to copy from

Returns:

This joint

PLMESH_API bool PLMesh::Joint::operator==

(

const Joint &

cJoint

)

const

Compares two joints.

Parameters:

[in]

cJoint

Joint to compare with

Returns:

'true' if both joints are equal, else 'false'

---

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

• PLMesh/include/PLMesh/Joint.h