VizKit::VisualAnimationComponent Class Reference

Abstract base class for composite implementation of Animation. More...

#include <VisualAnimationComponent.h>

Inheritance diagram for VizKit::VisualAnimationComponent:

List of all members.

Public Member Functions
virtual	~VisualAnimationComponent ()
	The destructor.
virtual VisualAnimationComponent *	clone (void) const =0
	Copies the current VisualAnimationComponent and returns a pointer to a new VisualAnimationComponent.
virtual void	animate (void)=0
	Executes the callback function to animate a property.
virtual void	update (void)=0
	Updates the state of the animation.
virtual bool	isRunning (void) const =0
	Answers the question whether the animation is (still) running.
virtual bool	isReadyToDie (void) const =0
	Answers the question whether the animation ended and is ready to be destroyed.
virtual void	start (void)=0
	Starts the Animation.
virtual void	stop (void)=0
	Stops the Animation.
virtual AnimatedProperty	getAnimatedProperty (void) const =0
	Returns the animated property of the animation.
virtual void	preparePriorToAddingToAsset (VisualAsset &anAsset)=0
	Prepares the animation before it is added to an asset.
virtual const VisualAsset *const	getEnclosingAsset (void) const =0
	Returns the asset the animation has been added to.
virtual void	setIdentifierOfParentCollection (const VisualItemIdentifier &aCollectionIdentifier)=0
	Sets the identifier of the parent collection (the collection which the current animation is part of).
virtual void	setCallbackToPerformAnyAdditionalAction (VisualAnimationPerformAnyAdditionalActionCallback theCallback, void *userData=NULL)=0
	Sets the callback function that is repeatedly called back during animation component's duration time.
virtual void	setCallbackToNotifyBeforeDeath (VisualAnimationWillDieCallback theCallback, void *userData=NULL)=0
	Sets the callback function that is called right before the death of the animation component.
virtual void	handleOneCollectionItemAnimationDied (void)=0
	Executes the appropriate action for the case that one animation of the current collection died.
virtual VisualAnimationComponent *	getVisualAnimation (const VisualItemIdentifier &anAnimationIdentifier)=0
	Returns the VisualAnimation with the specified VisualItemIdentifier.
virtual void	notifyBeforeDeath (void)=0
	Calls any callback functions right before the death of the animation component.
Protected Member Functions
	VisualAnimationComponent ()
	The constructor.
	VisualAnimationComponent (const VisualAnimationComponent &other)
	Copy constructor.

---

Detailed Description

Abstract base class for composite implementation of Animation.

---

Constructor & Destructor Documentation

VisualAnimationComponent::~VisualAnimationComponent

(

)

[virtual]

The destructor.

VisualAnimationComponent::VisualAnimationComponent

(

)

[protected]

The constructor.

VisualAnimationComponent::VisualAnimationComponent

(

const VisualAnimationComponent &

other

)

[protected]

Copy constructor.

Parameters:

other

Reference to another VisualAnimationComponent.

---

Member Function Documentation

virtual void VizKit::VisualAnimationComponent::animate

(

void

)

[pure virtual]

Executes the callback function to animate a property.

Implemented in VizKit::VisualAnimation, VizKit::VisualAnimationCluster, and VizKit::VisualAnimationSequence.

virtual VisualAnimationComponent* VizKit::VisualAnimationComponent::clone

(

void

)

const [pure virtual]

Copies the current VisualAnimationComponent and returns a pointer to a new VisualAnimationComponent.

Remarks:

We are overriding VisualObject's virtual clone() method to ensure to return a VisualAnimationComponent.

Implements VizKit::VisualObject.

Implemented in VizKit::VisualAnimation, VizKit::VisualAnimationCluster, and VizKit::VisualAnimationSequence.

virtual AnimatedProperty VizKit::VisualAnimationComponent::getAnimatedProperty

(

void

)

const [pure virtual]

Returns the animated property of the animation.

Returns:

The animated property of the animation.

Implemented in VizKit::VisualAnimation, VizKit::VisualAnimationCluster, and VizKit::VisualAnimationSequence.

virtual const VisualAsset* const VizKit::VisualAnimationComponent::getEnclosingAsset

(

void

)

const [pure virtual]

Returns the asset the animation has been added to.

Returns:

The asset the animation has been added to.

Implemented in VizKit::VisualAnimation, VizKit::VisualAnimationCluster, and VizKit::VisualAnimationSequence.

virtual VisualAnimationComponent* VizKit::VisualAnimationComponent::getVisualAnimation

(

const VisualItemIdentifier &

anAnimationIdentifier

)

[pure virtual]

Returns the VisualAnimation with the specified VisualItemIdentifier.

Parameters:

anAnimationIdentifier

The identifier of the animation.

Returns:

The VisualAnimation with the specified VisualItemIdentifier.

Remarks:

Return value can be NULL if no VisualAnimation with the specified VisualItemIdentifier is found.

Implemented in VizKit::VisualAnimationCluster, VizKit::VisualAnimationSequence, and VizKit::VisualAnimation.

virtual void VizKit::VisualAnimationComponent::handleOneCollectionItemAnimationDied

(

void

)

[pure virtual]

Executes the appropriate action for the case that one animation of the current collection died.

Remarks:

Only appropriate for collection (like cluster and sequence). VisualAnimation simply returns after printing an error message.

Implemented in VizKit::VisualAnimationCluster, VizKit::VisualAnimationSequence, and VizKit::VisualAnimation.

virtual bool VizKit::VisualAnimationComponent::isReadyToDie

(

void

)

const [pure virtual]

Answers the question whether the animation ended and is ready to be destroyed.

Returns:

True if the animation ended. False otherwise.

Remarks:

The animation is ready to die when the duration is exceeded. VisualAnimationQueue acts on a true return value and deletes the VisualAnimation.

Implemented in VizKit::VisualAnimation, VizKit::VisualAnimationCluster, and VizKit::VisualAnimationSequence.

virtual bool VizKit::VisualAnimationComponent::isRunning

(

void

)

const [pure virtual]

Answers the question whether the animation is (still) running.

Returns:

True is the animation is (still) running. False otherwise.

Implemented in VizKit::VisualAnimation, VizKit::VisualAnimationCluster, and VizKit::VisualAnimationSequence.

virtual void VizKit::VisualAnimationComponent::notifyBeforeDeath

(

void

)

[pure virtual]

Calls any callback functions right before the death of the animation component.

Implemented in VizKit::VisualAnimation, VizKit::VisualAnimationCluster, and VizKit::VisualAnimationSequence.

virtual void VizKit::VisualAnimationComponent::preparePriorToAddingToAsset

(

VisualAsset &

anAsset

)

[pure virtual]

Prepares the animation before it is added to an asset.

Parameters:

anAsset

The asset the animation is supposed to be added to.

Remarks:

Called by VisualAsset.

Implemented in VizKit::VisualAnimation, VizKit::VisualAnimationCluster, and VizKit::VisualAnimationSequence.

virtual void VizKit::VisualAnimationComponent::setCallbackToNotifyBeforeDeath	(	VisualAnimationWillDieCallback	theCallback,
		void *	userData = NULL
	)		[pure virtual]

Sets the callback function that is called right before the death of the animation component.

Parameters:

theCallback	Pointer to c-style function (static class function).
userData	Additional data (e.g. pointer to instance variable of initialized class).

Implemented in VizKit::VisualAnimation, VizKit::VisualAnimationCluster, and VizKit::VisualAnimationSequence.

virtual void VizKit::VisualAnimationComponent::setCallbackToPerformAnyAdditionalAction	(	VisualAnimationPerformAnyAdditionalActionCallback	theCallback,
		void *	userData = NULL
	)		[pure virtual]

Sets the callback function that is repeatedly called back during animation component's duration time.

Parameters:

theCallback	Pointer to c-style function (static class function).
userData	Additional data (e.g. pointer to instance variable of initialized class).

Implemented in VizKit::VisualAnimation, VizKit::VisualAnimationCluster, and VizKit::VisualAnimationSequence.

virtual void VizKit::VisualAnimationComponent::setIdentifierOfParentCollection

(

const VisualItemIdentifier &

aCollectionIdentifier

)

[pure virtual]

Sets the identifier of the parent collection (the collection which the current animation is part of).

Parameters:

aCollectionIdentifier

The identifier of the parent collection.

Implemented in VizKit::VisualAnimationCluster, VizKit::VisualAnimationSequence, and VizKit::VisualAnimation.

virtual void VizKit::VisualAnimationComponent::start

(

void

)

[pure virtual]

Starts the Animation.

Remarks:

In case the start is delayed, the animation is only running after the delaying milliseconds did have passed.

Implemented in VizKit::VisualAnimation, VizKit::VisualAnimationCluster, and VizKit::VisualAnimationSequence.

virtual void VizKit::VisualAnimationComponent::stop

(

void

)

[pure virtual]

Stops the Animation.

Implemented in VizKit::VisualAnimation, VizKit::VisualAnimationCluster, and VizKit::VisualAnimationSequence.

virtual void VizKit::VisualAnimationComponent::update

(

void

)

[pure virtual]

Updates the state of the animation.

Remarks:

Called by VisualAnimationQueue. Updates the current value of the animation. Also tests whether the animation is supposed to be started as the start was delayed.

Implemented in VizKit::VisualAnimation, VizKit::VisualAnimationCluster, and VizKit::VisualAnimationSequence.

---

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

• vizkit/source/Tools/Timing/VisualAnimationComponent.h
• vizkit/source/Tools/Timing/VisualAnimationComponent.cpp