deAnimatorRuleVisitorIdentify Class Reference

Animator Rule Visitor Identify. More...

#include <deAnimatorRuleVisitorIdentify.h>

Inheritance diagram for deAnimatorRuleVisitorIdentify:

List of all members.

Public Types
enum	eRuleTypes {   ertUnknown, ertAnimation, ertAnimationDifference, ertBoneRotator,   ertInverseKinematic, ertStateManipulator, ertStateSnapshot, ertForeignState,   ertGroup, ertSubAnimator, ertTouchGround, ertRetarget }
Public Member Functions
Constructors and Destructors
	deAnimatorRuleVisitorIdentify ()
	Creates a new animator rule visitor identify object.
virtual	~deAnimatorRuleVisitorIdentify ()
	Cleans up the animator rule visitor identify.
Management
int	GetType () const
	Retrieves the rule type.
bool	IsUnknown () const
	Determines if this is an unknown rule.
bool	IsAnimation () const
	Determines if this is a Animation rule.
bool	IsAnimationDifference () const
	Determines if this is a Animation Difference rule.
bool	IsBoneRotator () const
	Determines if this is a Bone Rotator rule.
bool	IsInverseKinematic () const
	Determines if this is a Inverse Kinematic rule.
bool	IsStateManipulator () const
	Determines if this is a State Manipulator rule.
bool	IsStateSnapshot () const
	Determines if this is a State Snapshot rule.
bool	IsForeignState () const
	Determines if this is a foreign state rule.
bool	IsGroup () const
	Determines if this is a group rule.
bool	IsSubAnimator () const
	Determines if this is a sub animator rule.
bool	IsTouchGround () const
	Determines if this is a touch ground rule.
bool	IsRetarget () const
	Determines if this is a retarget rule.
deAnimatorRuleAnimation *	CastToAnimation () const
	Cast to a Animation rule.
deAnimatorRuleAnimationDifference *	CastToAnimationDifference () const
	Cast to a Animation Difference rule.
deAnimatorRuleBoneRotator *	CastToBoneRotator () const
	Cast to a Bone Rotator rule.
deAnimatorRuleInverseKinematic *	CastToInverseKinematic () const
	Cast to a Inverse Kinematic rule.
deAnimatorRuleStateManipulator *	CastToStateManipulator () const
	Cast to a State Manipulator rule.
deAnimatorRuleStateSnapshot *	CastToStateSnapshot () const
	Cast to a state snapshot rule.
deAnimatorRuleForeignState *	CastToForeignState () const
	Cast to a foreign state rule.
deAnimatorRuleGroup *	CastToGroup () const
	Cast to a group rule.
deAnimatorRuleSubAnimator *	CastToSubAnimator () const
	Cast to a sub animator rule.
deAnimatorRuleTouchGround *	CastToTouchGround () const
	Cast to a touch ground rule.
deAnimatorRuleRetarget *	CastToRetarget () const
	Cast to a retarget rule.
void	Reset ()
	Resets the visitor.
Visiting
virtual void	VisitRule (deAnimatorRule *rule)
	Visits an animator rule.
virtual void	VisitAnimation (deAnimatorRuleAnimation *rule)
	Visits an animator animation rule.
virtual void	VisitAnimationDifference (deAnimatorRuleAnimationDifference *rule)
	Visits an animator animation difference rule.
virtual void	VisitBoneRotator (deAnimatorRuleBoneRotator *rule)
	Visits an bone rotator animator rule.
virtual void	VisitInverseKinematic (deAnimatorRuleInverseKinematic *rule)
	Visits an inverse kinematic animator rule.
virtual void	VisitStateManipulator (deAnimatorRuleStateManipulator *rule)
	Visits an state manipulator rule.
virtual void	VisitStateSnapshot (deAnimatorRuleStateSnapshot *rule)
	Visits an state snapshot rule.
virtual void	VisitForeignState (deAnimatorRuleForeignState *rule)
	Visits an foreign state rule.
virtual void	VisitGroup (deAnimatorRuleGroup *rule)
	Visits a group rule.
virtual void	VisitSubAnimator (deAnimatorRuleSubAnimator *rule)
	Visits a sub animator rule.
virtual void	VisitTouchGround (deAnimatorRuleTouchGround *rule)
	Visits a touch ground rule.
virtual void	VisitRetarget (deAnimatorRuleRetarget *rule)
	Visits a retarget rule.

---

Detailed Description

Animator Rule Visitor Identify.

Animation rule visitor providing rule identification. After visiting a rule the visitor can be asked what kind of rule has been visited. Useful to identify rules and to carry out actions only for certain rule types. Furthermore save casting is provided. If the cast is not valid an exception is raised.

Author:

Plüss Roland

Version:

1.0

Date:

2008

---

Member Enumeration Documentation

enum deAnimatorRuleVisitorIdentify::eRuleTypes

Enumerator:

ertUnknown
ertAnimation
ertAnimationDifference
ertBoneRotator
ertInverseKinematic
ertStateManipulator
ertStateSnapshot
ertForeignState
ertGroup
ertSubAnimator
ertTouchGround
ertRetarget

---

Constructor & Destructor Documentation

deAnimatorRuleVisitorIdentify::deAnimatorRuleVisitorIdentify

(

)

Creates a new animator rule visitor identify object.

virtual deAnimatorRuleVisitorIdentify::~deAnimatorRuleVisitorIdentify

(

)

[virtual]

Cleans up the animator rule visitor identify.

---

Member Function Documentation

deAnimatorRuleAnimation* deAnimatorRuleVisitorIdentify::CastToAnimation

(

)

const

Cast to a Animation rule.

deAnimatorRuleAnimationDifference* deAnimatorRuleVisitorIdentify::CastToAnimationDifference

(

)

const

Cast to a Animation Difference rule.

deAnimatorRuleBoneRotator* deAnimatorRuleVisitorIdentify::CastToBoneRotator

(

)

const

Cast to a Bone Rotator rule.

deAnimatorRuleForeignState* deAnimatorRuleVisitorIdentify::CastToForeignState

(

)

const

Cast to a foreign state rule.

deAnimatorRuleGroup* deAnimatorRuleVisitorIdentify::CastToGroup

(

)

const

Cast to a group rule.

deAnimatorRuleInverseKinematic* deAnimatorRuleVisitorIdentify::CastToInverseKinematic

(

)

const

Cast to a Inverse Kinematic rule.

deAnimatorRuleRetarget* deAnimatorRuleVisitorIdentify::CastToRetarget

(

)

const

Cast to a retarget rule.

deAnimatorRuleStateManipulator* deAnimatorRuleVisitorIdentify::CastToStateManipulator

(

)

const

Cast to a State Manipulator rule.

deAnimatorRuleStateSnapshot* deAnimatorRuleVisitorIdentify::CastToStateSnapshot

(

)

const

Cast to a state snapshot rule.

deAnimatorRuleSubAnimator* deAnimatorRuleVisitorIdentify::CastToSubAnimator

(

)

const

Cast to a sub animator rule.

deAnimatorRuleTouchGround* deAnimatorRuleVisitorIdentify::CastToTouchGround

(

)

const

Cast to a touch ground rule.

int deAnimatorRuleVisitorIdentify::GetType

(

)

const [inline]

Retrieves the rule type.

bool deAnimatorRuleVisitorIdentify::IsAnimation

(

)

const [inline]

Determines if this is a Animation rule.

bool deAnimatorRuleVisitorIdentify::IsAnimationDifference

(

)

const [inline]

Determines if this is a Animation Difference rule.

bool deAnimatorRuleVisitorIdentify::IsBoneRotator

(

)

const [inline]

Determines if this is a Bone Rotator rule.

bool deAnimatorRuleVisitorIdentify::IsForeignState

(

)

const [inline]

Determines if this is a foreign state rule.

bool deAnimatorRuleVisitorIdentify::IsGroup

(

)

const [inline]

Determines if this is a group rule.

bool deAnimatorRuleVisitorIdentify::IsInverseKinematic

(

)

const [inline]

Determines if this is a Inverse Kinematic rule.

bool deAnimatorRuleVisitorIdentify::IsRetarget

(

)

const [inline]

Determines if this is a retarget rule.

bool deAnimatorRuleVisitorIdentify::IsStateManipulator

(

)

const [inline]

Determines if this is a State Manipulator rule.

bool deAnimatorRuleVisitorIdentify::IsStateSnapshot

(

)

const [inline]

Determines if this is a State Snapshot rule.

bool deAnimatorRuleVisitorIdentify::IsSubAnimator

(

)

const [inline]

Determines if this is a sub animator rule.

bool deAnimatorRuleVisitorIdentify::IsTouchGround

(

)

const [inline]

Determines if this is a touch ground rule.

bool deAnimatorRuleVisitorIdentify::IsUnknown

(

)

const [inline]

Determines if this is an unknown rule.

void deAnimatorRuleVisitorIdentify::Reset

(

)

Resets the visitor.

virtual void deAnimatorRuleVisitorIdentify::VisitAnimation

(

deAnimatorRuleAnimation *

rule )

[virtual]

Visits an animator animation rule.

Reimplemented from deAnimatorRuleVisitor.

virtual void deAnimatorRuleVisitorIdentify::VisitAnimationDifference

(

deAnimatorRuleAnimationDifference *

rule )

[virtual]

Visits an animator animation difference rule.

Reimplemented from deAnimatorRuleVisitor.

virtual void deAnimatorRuleVisitorIdentify::VisitBoneRotator

(

deAnimatorRuleBoneRotator *

rule )

[virtual]

Visits an bone rotator animator rule.

Reimplemented from deAnimatorRuleVisitor.

virtual void deAnimatorRuleVisitorIdentify::VisitForeignState

(

deAnimatorRuleForeignState *

rule )

[virtual]

Visits an foreign state rule.

Reimplemented from deAnimatorRuleVisitor.

virtual void deAnimatorRuleVisitorIdentify::VisitGroup

(

deAnimatorRuleGroup *

rule )

[virtual]

Visits a group rule.

Reimplemented from deAnimatorRuleVisitor.

virtual void deAnimatorRuleVisitorIdentify::VisitInverseKinematic

(

deAnimatorRuleInverseKinematic *

rule )

[virtual]

Visits an inverse kinematic animator rule.

Reimplemented from deAnimatorRuleVisitor.

virtual void deAnimatorRuleVisitorIdentify::VisitRetarget

(

deAnimatorRuleRetarget *

rule )

[virtual]

Visits a retarget rule.

Reimplemented from deAnimatorRuleVisitor.

virtual void deAnimatorRuleVisitorIdentify::VisitRule

(

deAnimatorRule *

rule )

[virtual]

Visits an animator rule.

Reimplemented from deAnimatorRuleVisitor.

virtual void deAnimatorRuleVisitorIdentify::VisitStateManipulator

(

deAnimatorRuleStateManipulator *

rule )

[virtual]

Visits an state manipulator rule.

Reimplemented from deAnimatorRuleVisitor.

virtual void deAnimatorRuleVisitorIdentify::VisitStateSnapshot

(

deAnimatorRuleStateSnapshot *

rule )

[virtual]

Visits an state snapshot rule.

Reimplemented from deAnimatorRuleVisitor.

virtual void deAnimatorRuleVisitorIdentify::VisitSubAnimator

(

deAnimatorRuleSubAnimator *

rule )

[virtual]

Visits a sub animator rule.

Reimplemented from deAnimatorRuleVisitor.

virtual void deAnimatorRuleVisitorIdentify::VisitTouchGround

(

deAnimatorRuleTouchGround *

rule )

[virtual]

Visits a touch ground rule.

Reimplemented from deAnimatorRuleVisitor.

---

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

• deAnimatorRuleVisitorIdentify.h