deAnimatorRuleBoneRotator Class Reference

Animator Bone Rotator Rule Class. More...

#include <deAnimatorRuleBoneRotator.h>

Inheritance diagram for deAnimatorRuleBoneRotator:

List of all members.

Public Types
enum	eCoordinateFrames { ecfBoneLocal, ecfComponent, ecfRotationBone }
	Coordinate frame. More...
Public Member Functions
Constructors and Destructors
	deAnimatorRuleBoneRotator ()
	Creates a new animator rule.
virtual	~deAnimatorRuleBoneRotator ()
	Cleans up the animator rule.
Management
const decQuaternion &	GetMinimumRotation () const
	Retrieves the minimum rotation.
void	SetMinimumRotation (const decQuaternion &rotation)
	Sets the minimum rotation.
const decQuaternion &	GetMaximumRotation () const
	Retrieves the maximum rotation.
void	SetMaximumRotation (const decQuaternion &rotation)
	Sets the maximum rotation.
int	GetCoordinateFrame () const
	Retrieves the coordinate frame to rotate around.
void	SetCoordinateFrame (int coordinateFrame)
	Sets the coordinate frame to rotate around.
bool	GetEnablePosition () const
	Determines if position is altered.
void	SetEnablePosition (bool enabled)
	Sets if position is altered.
bool	GetEnableOrientation () const
	Determines if orientation is altered.
void	SetEnableOrientation (bool enabled)
	Sets if orientation is altered.
const char *	GetRotationBone () const
	Retrieves the name of the rotation bone.
void	SetRotationBone (const char *boneName)
	Sets the name of the rotation bone.
deAnimatorControllerTarget &	GetTargetRotation ()
	Retrieves the rotation target.
Visiting
virtual void	Visit (deAnimatorRuleVisitor *visitor)
	Visits the rule.

---

Detailed Description

Animator Bone Rotator Rule Class.

Applies a rotation to the current state of the stored bones. The rotation is considered relative to the component. Often it is useful to use the position of the respective bone as the reference point for applying the rotation. The bone-local parameter indicates this behaviour. As this is the often looked for behavior it is set true by default. The rotation axes are always parallel to the component axes no matter if bone-local rotation is used. If a controller is specified it is used to modulate the rotation from a minimum to a maximum rotation.

Author:

Plüss Roland

Version:

1.0

Date:

2008

---

Member Enumeration Documentation

enum deAnimatorRuleBoneRotator::eCoordinateFrames

Coordinate frame.

Enumerator:

ecfBoneLocal	Bone local coordinate frame.
ecfComponent	Component coordinate frame.
ecfRotationBone	Rotation bone coordinate frame.

---

Constructor & Destructor Documentation

deAnimatorRuleBoneRotator::deAnimatorRuleBoneRotator

(

)

Creates a new animator rule.

virtual deAnimatorRuleBoneRotator::~deAnimatorRuleBoneRotator

(

)

[virtual]

Cleans up the animator rule.

---

Member Function Documentation

int deAnimatorRuleBoneRotator::GetCoordinateFrame

(

)

const [inline]

Retrieves the coordinate frame to rotate around.

bool deAnimatorRuleBoneRotator::GetEnableOrientation

(

)

const [inline]

Determines if orientation is altered.

bool deAnimatorRuleBoneRotator::GetEnablePosition

(

)

const [inline]

Determines if position is altered.

const decQuaternion& deAnimatorRuleBoneRotator::GetMaximumRotation

(

)

const [inline]

Retrieves the maximum rotation.

const decQuaternion& deAnimatorRuleBoneRotator::GetMinimumRotation

(

)

const [inline]

Retrieves the minimum rotation.

const char* deAnimatorRuleBoneRotator::GetRotationBone

(

)

const [inline]

Retrieves the name of the rotation bone.

deAnimatorControllerTarget& deAnimatorRuleBoneRotator::GetTargetRotation

(

)

[inline]

Retrieves the rotation target.

void deAnimatorRuleBoneRotator::SetCoordinateFrame

(

int

coordinateFrame )

Sets the coordinate frame to rotate around.

void deAnimatorRuleBoneRotator::SetEnableOrientation

(

bool

enabled )

Sets if orientation is altered.

void deAnimatorRuleBoneRotator::SetEnablePosition

(

bool

enabled )

Sets if position is altered.

void deAnimatorRuleBoneRotator::SetMaximumRotation

(

const decQuaternion &

rotation )

Sets the maximum rotation.

void deAnimatorRuleBoneRotator::SetMinimumRotation

(

const decQuaternion &

rotation )

Sets the minimum rotation.

void deAnimatorRuleBoneRotator::SetRotationBone

(

const char *

boneName )

Sets the name of the rotation bone.

virtual void deAnimatorRuleBoneRotator::Visit

(

deAnimatorRuleVisitor *

visitor )

[virtual]

Visits the rule.

Reimplemented from deAnimatorRule.

---

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

• deAnimatorRuleBoneRotator.h