VizKit::VisualAnimationQueue Class Reference

#include <VisualAnimationQueue.h>

List of all members.

Static Public Member Functions
static void	dispose (void)
static void	push (const VisualAnimationComponent &anAnimation, const VisualItemIdentifier &anOwnerIdentifier)
static size_t	size (void)
static void	removeVisualAnimationsWithOwnerIdentifier (const VisualItemIdentifier &anOwnerIdentifier, const AnimatedProperty anAnimatedProperty)
static void	removeVisualAnimationsWithOwnerIdentifier (const VisualItemIdentifier &anOwnerIdentifier)
static void	removeVisualAnimationsOfAsset (const VisualAsset *const anAsset)
static void	copyAnimationsFromAssetToAsset (const VisualAsset &sourceAsset, VisualAsset &destinationAsset)
static void	removeVisualAnimation (const VisualItemIdentifier &animationIdentifier)
static VisualAnimationComponent *	getVisualAnimation (const VisualItemIdentifier &anAnimationIdentifier)
static const VisualAnimationComponent *const	getFirstVisualAnimationWithOwnerIdentifier (const VisualItemIdentifier &anOwnerIdentifier, const AnimatedProperty &anAnimatedProperty)
static void	processAnimations (void)
Private Types
typedef std::multimap < VisualItemIdentifier, VisualAnimationComponent * >	AnimationQueue
typedef AnimationQueue::iterator	AnimationQueueIterator
typedef AnimationQueue::const_iterator	ConstAnimationQueueIterator
Private Member Functions
	VisualAnimationQueue ()
	~VisualAnimationQueue ()
	VisualAnimationQueue (const VisualAnimationQueue &other)
VisualAnimationQueue &	operator= (const VisualAnimationQueue &other)
Static Private Member Functions
static VisualAnimationQueue *	getInstance (void)
Private Attributes
AnimationQueue	animationQueue
Static Private Attributes
static VisualAnimationQueue *	theVisualAnimationQueue = NULL

---

Detailed Description

Queue of animations. Singleton. All methods are static for convenient access.

---

Member Typedef Documentation

typedef std::multimap<VisualItemIdentifier, VisualAnimationComponent*> VizKit::VisualAnimationQueue::AnimationQueue [private]

An AnimationQueue is a queue of animations.

Remarks:

The VisualAnimationQueue stores its events as pointers to VisualAnimationComponents and VisualItemIdentifiers as keys for later retrieval.

typedef AnimationQueue::iterator VizKit::VisualAnimationQueue::AnimationQueueIterator [private]

A AnimationQueueIterator is an iterator of a AnimationQueue.

typedef AnimationQueue::const_iterator VizKit::VisualAnimationQueue::ConstAnimationQueueIterator [private]

A ConstAnimationQueueIterator is a constant iterator of a AnimationQueue.

---

Constructor & Destructor Documentation

VisualAnimationQueue::VisualAnimationQueue

(

)

[private]

The constructor. VisualAnimationQueue is a singleton class. The constructor is private. New instance of class can only be created internally.

VisualAnimationQueue::~VisualAnimationQueue

(

)

[private]

The destructor. VisualAnimationQueue is a singleton class. The destructor is private. Instance of class can only be destructed internally.

VizKit::VisualAnimationQueue::VisualAnimationQueue

(

const VisualAnimationQueue &

other

)

[private]

Copy constructor.

Parameters:

other

Another VisualAnimationQueue.

Remarks:

Explicitely declared in private section and not implemented to enforce uniqueness of singleton pattern.

---

Member Function Documentation

void VisualAnimationQueue::copyAnimationsFromAssetToAsset	(	const VisualAsset &	sourceAsset,
		VisualAsset &	destinationAsset
	)		[static]

Copies animations from one asset to another.

Parameters:

sourceAsset	The source asset (the asset from which the animations are copied).
destinationAsset	The destination asset (the asset to which the animations are copied).

void VisualAnimationQueue::dispose

(

void

)

[static]

Cleans up the VisualAnimationQueue singleton.

const VisualAnimationComponent *const VisualAnimationQueue::getFirstVisualAnimationWithOwnerIdentifier	(	const VisualItemIdentifier &	anOwnerIdentifier,
		const AnimatedProperty &	anAnimatedProperty
	)		[static]

Returns the VisualAnimation where the VisualItemIdentifier and the animated property matches.

Parameters:

anOwnerIdentifier	An identifier that is connected with the animation.
anAnimatedProperty	Parameter that specifies the animated property of the animations.

Returns:

The VisualAnimation where the VisualItemIdentifier and the animated property matches.

Remarks:

Return value can be NULL.

VisualAnimationQueue * VisualAnimationQueue::getInstance

(

void

)

[static, private]

Returns a pointer to the instance. Initializes the VisualAnimationQueue class if neccessary. The VisualAnimationQueue is of singleton type.

Returns:

A pointer to the initialized VisualAnimationQueue.

VisualAnimationComponent * VisualAnimationQueue::getVisualAnimation

(

const VisualItemIdentifier &

anAnimationIdentifier

)

[static]

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.

VisualAnimationQueue& VizKit::VisualAnimationQueue::operator=

(

const VisualAnimationQueue &

other

)

[private]

Assignment operator.

Remarks:

Explicitely declared in private section and not implemented to enforce uniqueness of singleton pattern.

void VisualAnimationQueue::processAnimations

(

void

)

[static]

Processes te animations of the queue.

Remarks:

Called by VisualStageControl prior to show of ensemble.

void VisualAnimationQueue::push	(	const VisualAnimationComponent &	anAnimation,
		const VisualItemIdentifier &	anOwnerIdentifier
	)		[static]

Pushes a pointer to a VisualAnimationComponent at the end of the VisualAnimationQueue.

Parameters:

anAnimation	The animation.
anOwnerIdentifier	Identifier associated with the animation.

Remarks:

The animation is copied by calling clone() before it is added to the queue.

void VisualAnimationQueue::removeVisualAnimation

(

const VisualItemIdentifier &

animationIdentifier

)

[static]

Removes the VisualAnimation where the VisualItemIdentifier matches.

Parameters:

animationIdentifier

The identifier of the VisualAnimation which should be removed.

void VisualAnimationQueue::removeVisualAnimationsOfAsset

(

const VisualAsset *const

anAsset

)

[static]

Removes VisualAnimations of an asset.

Parameters:

anAsset

The asset.

void VisualAnimationQueue::removeVisualAnimationsWithOwnerIdentifier	(	const VisualItemIdentifier &	anOwnerIdentifier,
		const AnimatedProperty	anAnimatedProperty
	)		[static]

Removes all VisualAnimations where the associated VisualItemIdentifier matches.

Parameters:

anOwnerIdentifier	An identifier that is connected with the animation.
anAnimatedProperty	The animated property of the animation.

void VisualAnimationQueue::removeVisualAnimationsWithOwnerIdentifier

(

const VisualItemIdentifier &

anOwnerIdentifier

)

[static]

Removes all VisualAnimations where the associated VisualItemIdentifier matches.

Parameters:

anOwnerIdentifier

An identifier that is connected with the animation.

size_t VisualAnimationQueue::size

(

void

)

[static]

Returns the number of animations currently stored in VisualAnimationQueue.

---

Member Data Documentation

AnimationQueue VizKit::VisualAnimationQueue::animationQueue [private]

The queue of the animations.

VisualAnimationQueue * VisualAnimationQueue::theVisualAnimationQueue = NULL [static, private]

VisualAnimationQueue is a singleton class. Pointer to private instance is handled internally.

---

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

• source/Tools/Timing/VisualAnimationQueue.h
• source/Tools/Timing/VisualAnimationQueue.cpp