deAnimatorRuleInverseKinematic Class Reference

Animator Inverse Kinematic Rule Class. More...

#include <deAnimatorRuleInverseKinematic.h>

Inheritance diagram for deAnimatorRuleInverseKinematic:

List of all members.

Public Member Functions
Constructors and Destructors
	deAnimatorRuleInverseKinematic ()
	Creates a new animator rule.
virtual	~deAnimatorRuleInverseKinematic ()
	Cleans up the animator rule.
Management
const decVector &	GetGoalPosition () const
	Retrieves the goal position.
void	SetGoalPosition (const decVector &position)
	Sets the the goal position.
const decQuaternion &	GetGoalOrientation () const
	Retrieves the goal orientation.
void	SetGoalOrientation (const decQuaternion &orientation)
	Sets the the goal orientation.
const decVector &	GetLocalPosition () const
	Retrieves the local position.
void	SetLocalPosition (const decVector &position)
	Sets the the local position.
const decQuaternion &	GetLocalOrientation () const
	Retrieves the local orientation.
void	SetLocalOrientation (const decQuaternion &orientation)
	Sets the the local orientation.
bool	GetAdjustOrientation () const
	Determines if the orientation is adjusted.
void	SetAdjustOrientation (bool adjustOrientation)
	Sets if the orientation is adjusted.
deAnimatorControllerTarget &	GetTargetGoalPosition ()
	Retrieves the goal position target.
deAnimatorControllerTarget &	GetTargetGoalOrientation ()
	Retrieves the goal orientation target.
deAnimatorControllerTarget &	GetTargetLocalPosition ()
	Retrieves the local position target.
deAnimatorControllerTarget &	GetTargetLocalOrientation ()
	Retrieves the local orientation target.
bool	GetUseSolverBone () const
	Determines if the solver bone is used to obtain the target position and orientation instead of the controller links.
void	SetUseSolverBone (bool useSolverBone)
	Sets if the solver bone is used to obtain the target position and orientation instead of the controller links.
const char *	GetSolverBone () const
	Retrieves the name of the solver bone if used.
void	SetSolverBone (const char *boneName)
	Sets the name of the solver bone.
Visiting
virtual void	Visit (deAnimatorRuleVisitor *visitor)
	Visits the rule.

---

Detailed Description

Animator Inverse Kinematic Rule Class.

Inverse kinematic is the process of adjusting a set of bones in a way that the end of the bone-chain is located at a given point in space. A typical application is to make an actor push a button no matter where in relation to the button he is standing. This rule provides this behavior. You specify the reference-point in component-space and a reference-offset in the bone-space of the tail bone ( the distance of the reference-point to the bone ). Then you need to also specify which bones make up the bone-chain. For this you need to specify two bones one being the start of the chain and the other the end of it. The chain made up by those two is then adjusted to make the reference-point coincident with an imaginary point located reference-offset from the tail bone ( this imaginary point would be the finger tip ). There are no additional controllers in this rule.

Author:

Plüss Roland

Version:

1.0

Date:

2008

---

Constructor & Destructor Documentation

deAnimatorRuleInverseKinematic::deAnimatorRuleInverseKinematic

(

)

Creates a new animator rule.

virtual deAnimatorRuleInverseKinematic::~deAnimatorRuleInverseKinematic

(

)

[virtual]

Cleans up the animator rule.

---

Member Function Documentation

bool deAnimatorRuleInverseKinematic::GetAdjustOrientation

(

)

const [inline]

Determines if the orientation is adjusted.

const decQuaternion& deAnimatorRuleInverseKinematic::GetGoalOrientation

(

)

const [inline]

Retrieves the goal orientation.

const decVector& deAnimatorRuleInverseKinematic::GetGoalPosition

(

)

const [inline]

Retrieves the goal position.

const decQuaternion& deAnimatorRuleInverseKinematic::GetLocalOrientation

(

)

const [inline]

Retrieves the local orientation.

const decVector& deAnimatorRuleInverseKinematic::GetLocalPosition

(

)

const [inline]

Retrieves the local position.

const char* deAnimatorRuleInverseKinematic::GetSolverBone

(

)

const [inline]

Retrieves the name of the solver bone if used.

deAnimatorControllerTarget& deAnimatorRuleInverseKinematic::GetTargetGoalOrientation

(

)

[inline]

Retrieves the goal orientation target.

deAnimatorControllerTarget& deAnimatorRuleInverseKinematic::GetTargetGoalPosition

(

)

[inline]

Retrieves the goal position target.

deAnimatorControllerTarget& deAnimatorRuleInverseKinematic::GetTargetLocalOrientation

(

)

[inline]

Retrieves the local orientation target.

deAnimatorControllerTarget& deAnimatorRuleInverseKinematic::GetTargetLocalPosition

(

)

[inline]

Retrieves the local position target.

bool deAnimatorRuleInverseKinematic::GetUseSolverBone

(

)

const [inline]

Determines if the solver bone is used to obtain the target position and orientation instead of the controller links.

void deAnimatorRuleInverseKinematic::SetAdjustOrientation

(

bool

adjustOrientation )

Sets if the orientation is adjusted.

void deAnimatorRuleInverseKinematic::SetGoalOrientation

(

const decQuaternion &

orientation )

Sets the the goal orientation.

void deAnimatorRuleInverseKinematic::SetGoalPosition

(

const decVector &

position )

Sets the the goal position.

void deAnimatorRuleInverseKinematic::SetLocalOrientation

(

const decQuaternion &

orientation )

Sets the the local orientation.

void deAnimatorRuleInverseKinematic::SetLocalPosition

(

const decVector &

position )

Sets the the local position.

void deAnimatorRuleInverseKinematic::SetSolverBone

(

const char *

boneName )

Sets the name of the solver bone.

void deAnimatorRuleInverseKinematic::SetUseSolverBone

(

bool

useSolverBone )

Sets if the solver bone is used to obtain the target position and orientation instead of the controller links.

virtual void deAnimatorRuleInverseKinematic::Visit

(

deAnimatorRuleVisitor *

visitor )

[virtual]

Visits the rule.

Reimplemented from deAnimatorRule.

---

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

• deAnimatorRuleInverseKinematic.h