#include <VisualAnimationCluster.h>

Inheritance diagram for VizKit::VisualAnimationCluster:

Public Member Functions
	VisualAnimationCluster ()
	~VisualAnimationCluster ()
	VisualAnimationCluster (const VisualAnimationCluster &other)
VisualAnimationCluster &	operator= (const VisualAnimationCluster &other)
virtual VisualAnimationComponent *	clone (void) const
void	add (VisualAnimationComponent &anAnimation)
virtual void	animate (void)
virtual void	update (void)
virtual bool	isRunning (void) const
virtual bool	isReadyToDie (void) const
virtual void	start (void)
virtual void	stop (void)
virtual AnimatedProperty	getAnimatedProperty (void) const
virtual void	preparePriorToAddingToAsset (VisualAsset &visualAsset)
virtual const VisualAsset *const	getEnclosingAsset (void) const
virtual void	setIdentifierOfParentCollection (const VisualItemIdentifier &aCollectionIdentifier)
virtual void	handleOneCollectionItemAnimationDied (void)
virtual void	setCallbackToPerformAnyAdditionalAction (VisualAnimationPerformAnyAdditionalActionCallback theCallback, void *userData=NULL)
virtual void	setCallbackToNotifyBeforeDeath (VisualAnimationWillDieCallback theCallback, void *userData=NULL)
virtual void	notifyBeforeDeath (void)
virtual VisualAnimationComponent *	getVisualAnimation (const VisualItemIdentifier &anAnimationIdentifier)
Private Types
typedef std::vector < VisualAnimationComponent * >	AnimationVector
typedef AnimationVector::iterator	AnimationVectorIterator
typedef AnimationVector::const_iterator	AnimationVectorConstIterator
Private Member Functions
void	copy (const VisualAnimationCluster &other)
Private Attributes
AnimationVector	animationVector
VisualItemIdentifier *	parentCollectionIdentifier
const VisualAsset *	enclosingAsset
VisualAnimationPerformAnyAdditionalActionCallback	performAnyAdditionalActionCallback
void *	performAnyAdditionalActionCallbackUserData
VisualAnimationWillDieCallback	willDieCallback
void *	willDieCallbackUserData

Detailed Description

A VisualAnimationCluster is a collection of animations where the animations run concurrently. Animations are added by calling add().

Member Typedef Documentation

typedef std::vector<VisualAnimationComponent*> VizKit::VisualAnimationCluster::AnimationVector [private]

Animations are collected as a vector of pointers to VisualAnimationComponents.

typedef AnimationVector::const_iterator VizKit::VisualAnimationCluster::AnimationVectorConstIterator [private]

The AnimationVectorConstIterator is a const iterator of a AnimationVector.

typedef AnimationVector::iterator VizKit::VisualAnimationCluster::AnimationVectorIterator [private]

The AnimationVectorIterator is an iterator of a AnimationVector.

Constructor & Destructor Documentation

VisualAnimationCluster::VisualAnimationCluster ( )

The constructor.

VisualAnimationCluster::~VisualAnimationCluster ( )

The destructor.

VisualAnimationCluster::VisualAnimationCluster ( const VisualAnimationCluster & other )

Copy constructor.

Parameters:

other Reference to another VisualAnimationCluster.

Member Function Documentation

void VisualAnimationCluster::add ( VisualAnimationComponent & anAnimation )

Adds an animation to the collection.

Parameters:

anAnimation Reference to an animation (single VisualAnimation or clustered/sequenced composite collection of multiple VisualAnimations).

void VisualAnimationCluster::animate ( void ) [virtual]

Executes the callback function to animate a property.

Implements VizKit::VisualAnimationComponent.

VisualAnimationComponent * VisualAnimationCluster::clone ( void ) const [virtual]

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

Implements VizKit::VisualAnimationComponent.

void VisualAnimationCluster::copy ( const VisualAnimationCluster & other ) [private]

Copy method for assignment operator and copy constructor.

Parameters:

other Another VisualAnimationCluster.

AnimatedProperty VisualAnimationCluster::getAnimatedProperty ( void ) const [virtual]

Returns the animated property of the animation.

Returns:: The animated property of the animation.

Remarks:: In case the collection only contains one animation, the animated property of the contained single animation is returned. Otherwise kUndefinedAnimatedProperty is returned.

Implements VizKit::VisualAnimationComponent.

const VisualAsset *const VisualAnimationCluster::getEnclosingAsset ( void ) const [virtual]

Returns the asset the animation has been added to.

Returns:: The asset the animation has been added to.

Implements VizKit::VisualAnimationComponent.

VisualAnimationComponent * VisualAnimationCluster::getVisualAnimation ( const VisualItemIdentifier & anAnimationIdentifier ) [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.

Implements VizKit::VisualAnimationComponent.

void VisualAnimationCluster::handleOneCollectionItemAnimationDied ( void ) [virtual]

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

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

Implements VizKit::VisualAnimationComponent.

bool VisualAnimationCluster::isReadyToDie ( void ) const [virtual]

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

Returns:: True is the animation ended. False otherwise.

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

Implements VizKit::VisualAnimationComponent.

bool VisualAnimationCluster::isRunning ( void ) const [virtual]

Answers the question whether at least one animation is (still) running.

Returns:: True if at least one of the animations is (still) running. False otherwise.

Implements VizKit::VisualAnimationComponent.

void VisualAnimationCluster::notifyBeforeDeath ( void ) [virtual]

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

Implements VizKit::VisualAnimationComponent.

VisualAnimationCluster & VisualAnimationCluster::operator= ( const VisualAnimationCluster & other )

Assignment operator.

Parameters:

other Reference to another VisualAnimationCluster.

void VisualAnimationCluster::preparePriorToAddingToAsset ( VisualAsset & visualAsset ) [virtual]

Prepares the animation before it is added to an asset.

Parameters:

visualAsset The asset the animation is supposed to be added to..

Implements VizKit::VisualAnimationComponent.

void VisualAnimationCluster::setCallbackToNotifyBeforeDeath	(	VisualAnimationWillDieCallback	theCallback,
		void *	userData = `NULL`
	)		`[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).

Implements VizKit::VisualAnimationComponent.

void VisualAnimationCluster::setCallbackToPerformAnyAdditionalAction	(	VisualAnimationPerformAnyAdditionalActionCallback	theCallback,
		void *	userData = `NULL`
	)		`[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).

Implements VizKit::VisualAnimationComponent.

void VisualAnimationCluster::setIdentifierOfParentCollection ( const VisualItemIdentifier & aCollectionIdentifier ) [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.

Implements VizKit::VisualAnimationComponent.

void VisualAnimationCluster::start ( void ) [virtual]

Starts the Animation collection.

Remarks:: Each contained animation is sent a call to start().

Implements VizKit::VisualAnimationComponent.

void VisualAnimationCluster::stop ( void ) [virtual]

Stops the Animation collection.

Implements VizKit::VisualAnimationComponent.

void VisualAnimationCluster::update ( void ) [virtual]

Updates the state of the animation cluster.

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

Implements VizKit::VisualAnimationComponent.