deAnimator Class Reference

Animator Class. More...

#include <deAnimator.h>

Inheritance diagram for deAnimator:

Public Types
typedef deTObjectReference< deAnimator >	Ref
	Type holding strong reference. More...
Public Types inherited from deResource
typedef deTObjectReference< deResource >	Ref
	Type holding strong reference. More...
Public Types inherited from deObject
typedef deTObjectReference< deObject >	Ref
	Type holding strong reference. More...

Public Member Functions
Management
deRig *	GetRig () const
	Rig or NULL. More...
void	SetRig (deRig *rig)
	Set rig or NULL. More...
deAnimation *	GetAnimation () const
	Animation or NULL. More...
void	SetAnimation (deAnimation *animation)
	Set animation or NULL. More...
decStringSet &	GetListBones ()
	Bones. More...
const decStringSet &	GetListBones () const
void	NotifyBonesChanged ()
	Notify peers list of bones changed. More...
decStringSet &	GetListVertexPositionSets ()
	Vertex position sets. More...
const decStringSet &	GetListVertexPositionSets () const
void	NotifyVertexPositionSetsChanged ()
	Notify peers list of vertex position sets changed. More...
Controller Management
int	GetControllerCount () const
	Count of controllers. More...
deAnimatorController *	GetControllerAt (int index) const
	Controller at index. More...
int	IndexOfController (deAnimatorController *controller) const
	Index of controller or -1 if absent. More...
int	IndexOfControllerNamed (const char *controller) const
	Index of named controller or -1 if absent. More...
bool	HasController (deAnimatorController *controller) const
	Controller is present. More...
void	AddController (deAnimatorController *controller)
	Add controller. More...
void	RemoveController (deAnimatorController *controller)
	Remove controller. More...
void	RemoveAllControllers ()
	Remove all controllers. More...
void	NotifyControllerChangedAt (int index)
	Notify peers controller changed. More...
Link Management
int	GetLinkCount () const
	Count of links. More...
deAnimatorLink *	GetLinkAt (int index) const
	Link at index. More...
int	IndexOfLink (deAnimatorLink *link) const
	Index of link or -1 if absent. More...
bool	HasLink (deAnimatorLink *link) const
	Link is present. More...
void	AddLink (deAnimatorLink *link)
	Add link. More...
void	RemoveLink (deAnimatorLink *link)
	Remove link. More...
void	RemoveAllLinks ()
	Remove all links. More...
void	NotifyLinkChangedAt (int index)
	Notify peers link changed. More...
Rule Management
int	GetRuleCount () const
	Count of rules. More...
deAnimatorRule *	GetRuleAt (int index) const
	Rule at index. More...
int	IndexOfRule (deAnimatorRule *rule) const
	Index of rule or -1 if absent. More...
bool	HasRule (deAnimatorRule *rule) const
	Rule is present. More...
void	AddRule (deAnimatorRule *rule)
	Add rule. More...
void	RemoveRule (deAnimatorRule *rule)
	Remove rule. More...
void	RemoveAllRules ()
	Remove all rules. More...
void	NotifyRulesChanged ()
	Notify peers one or more rules changed. More...
Public Member Functions inherited from deResource
deResourceManager *	GetResourceManager () const
	Resource manager or NULL if resource is leaking. More...
deEngine *	GetEngine () const
	Game engine object from resource manager. More...
deResource *	GetLLManagerPrev () const
	Previous resource in the resource manager linked list. More...
void	SetLLManagerPrev (deResource *resource)
	Set next resource in the resource manager linked list. More...
deResource *	GetLLManagerNext () const
	Next resource in the resource manager linked list. More...
void	SetLLManagerNext (deResource *resource)
	Set next resource in the resource manager linked list. More...
void	MarkLeaking ()
	Marks the resource leaking. More...
	deResource (deResourceManager *resourceManager)
	Create resource. More...
Public Member Functions inherited from deObject
int	GetRefCount () const
	Reference count. More...
void	AddReference ()
	Add reference increasing reference count by 1. More...
void	FreeReference ()
	Decrease reference count by one and delete object if count reaches 0. More...
	deObject ()
	Create object with reference count of 1. More...

Constructors and Destructors
	deAnimator (deAnimatorManager *manager)
	Create animator. More...
virtual	~deAnimator ()
	Clean up animator. More...

System Peers
deBaseAnimatorAnimator *	GetPeerAnimator () const
	Animator system peer. More...
void	SetPeerAnimator (deBaseAnimatorAnimator *peer)
	Set animator system peer. More...

Additional Inherited Members
Protected Member Functions inherited from deResource
virtual	~deResource ()
	Clean up resource. More...
Protected Member Functions inherited from deObject
virtual	~deObject ()
	Clean up object. More...

Detailed Description

Animator Class.

Animators are objects capable of producing an animation state for a component. Every animator composes of a set of rules and controllers which indicate how the final animation state is produced from a set animation. Some rules can also produce animations without the help of the animation but external information like for example where another object is located or a reference state captured before. Controllers provide the values required by rules and one controller can be attached to more than one rule. The animator object has peers into the animator module. This way the creation of animations can be accelerated if possible.

Member Typedef Documentation

Ref

typedef deTObjectReference<deAnimator> deAnimator::Ref

Type holding strong reference.

Constructor & Destructor Documentation

deAnimator()

deAnimator::deAnimator

(

deAnimatorManager *

manager

)

Create animator.

~deAnimator()

virtual deAnimator::~deAnimator ( )

protectedvirtual

Clean up animator.

Note

Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.

Member Function Documentation

AddController()

void deAnimator::AddController

(

deAnimatorController *

controller

)

Add controller.

AddLink()

void deAnimator::AddLink

(

deAnimatorLink *

link

)

Add link.

AddRule()

void deAnimator::AddRule

(

deAnimatorRule *

rule

)

Add rule.

GetAnimation()

deAnimation* deAnimator::GetAnimation ( ) const

inline

Animation or NULL.

GetControllerAt()

deAnimatorController* deAnimator::GetControllerAt

(

int

index

)

const

Controller at index.

GetControllerCount()

int deAnimator::GetControllerCount ( ) const

inline

Count of controllers.

GetLinkAt()

deAnimatorLink* deAnimator::GetLinkAt

(

int

index

)

const

Link at index.

GetLinkCount()

int deAnimator::GetLinkCount ( ) const

inline

Count of links.

GetListBones() [1/2]

decStringSet& deAnimator::GetListBones ( )

inline

Bones.

GetListBones() [2/2]

const decStringSet& deAnimator::GetListBones ( ) const

inline

GetListVertexPositionSets() [1/2]

decStringSet& deAnimator::GetListVertexPositionSets ( )

inline

Vertex position sets.

GetListVertexPositionSets() [2/2]

const decStringSet& deAnimator::GetListVertexPositionSets ( ) const

inline

GetPeerAnimator()

deBaseAnimatorAnimator* deAnimator::GetPeerAnimator ( ) const

inline

Animator system peer.

GetRig()

deRig* deAnimator::GetRig ( ) const

inline

Rig or NULL.

GetRuleAt()

deAnimatorRule* deAnimator::GetRuleAt

(

int

index

)

const

Rule at index.

GetRuleCount()

int deAnimator::GetRuleCount

(

)

const

Count of rules.

HasController()

bool deAnimator::HasController

(

deAnimatorController *

controller

)

const

Controller is present.

HasLink()

bool deAnimator::HasLink

(

deAnimatorLink *

link

)

const

Link is present.

HasRule()

bool deAnimator::HasRule

(

deAnimatorRule *

rule

)

const

Rule is present.

IndexOfController()

int deAnimator::IndexOfController

(

deAnimatorController *

controller

)

const

Index of controller or -1 if absent.

IndexOfControllerNamed()

int deAnimator::IndexOfControllerNamed

(

const char *

controller

)

const

Index of named controller or -1 if absent.

IndexOfLink()

int deAnimator::IndexOfLink

(

deAnimatorLink *

link

)

const

Index of link or -1 if absent.

IndexOfRule()

int deAnimator::IndexOfRule

(

deAnimatorRule *

rule

)

const

Index of rule or -1 if absent.

NotifyBonesChanged()

void deAnimator::NotifyBonesChanged

(

)

Notify peers list of bones changed.

NotifyControllerChangedAt()

void deAnimator::NotifyControllerChangedAt

(

int

index

)

Notify peers controller changed.

NotifyLinkChangedAt()

void deAnimator::NotifyLinkChangedAt

(

int

index

)

Notify peers link changed.

NotifyRulesChanged()

void deAnimator::NotifyRulesChanged

(

)

Notify peers one or more rules changed.

NotifyVertexPositionSetsChanged()

void deAnimator::NotifyVertexPositionSetsChanged

(

)

Notify peers list of vertex position sets changed.

RemoveAllControllers()

void deAnimator::RemoveAllControllers

(

)

Remove all controllers.

RemoveAllLinks()

void deAnimator::RemoveAllLinks

(

)

Remove all links.

RemoveAllRules()

void deAnimator::RemoveAllRules

(

)

Remove all rules.

RemoveController()

void deAnimator::RemoveController

(

deAnimatorController *

controller

)

Remove controller.

RemoveLink()

void deAnimator::RemoveLink

(

deAnimatorLink *

link

)

Remove link.

RemoveRule()

void deAnimator::RemoveRule

(

deAnimatorRule *

rule

)

Remove rule.

SetAnimation()

void deAnimator::SetAnimation

(

deAnimation *

animation

)

Set animation or NULL.

SetPeerAnimator()

void deAnimator::SetPeerAnimator

(

deBaseAnimatorAnimator *

peer

)

Set animator system peer.

SetRig()

void deAnimator::SetRig

(

deRig *

rig

)

Set rig or NULL.

---

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

• deAnimator.h