Luciad.Animations.AnimationManager Class Reference

Class that starts, updates and stops IAnimation objects that are assigned to it. More...

Inheritance diagram for Luciad.Animations.AnimationManager:

Classes
struct	OngoingAnimation
	This struct represents an animation that has been started in AnimationManager and has not been stopped yet. More...

Public Member Functions
void	Dispose ()
override bool	Equals (object obj)
Luciad.Animations.AnimationManager.? OngoingAnimation	GetCurrentAnimation (string key)
	Returns the currently ongoing animation if present or null if no animation with that key is ongoing.
override int	GetHashCode ()
void	StartAnimation (string key, Luciad.Animations.IAnimation animation)
	Starts a new animation.
void	StopAnimation (string key)
	Stops the animation that was added with the given key, if present.

Detailed Description

Class that starts, updates and stops IAnimation objects that are assigned to it.

This class is used by the Map class. See Map.AnimationManager.

Since

2021.1

Member Function Documentation

Dispose()

void Luciad.Animations.AnimationManager.Dispose ( )

inline

Equals()

override bool Luciad.Animations.AnimationManager.Equals ( object obj )

inline

GetCurrentAnimation()

Luciad.Animations.AnimationManager.? OngoingAnimation Luciad.Animations.AnimationManager.GetCurrentAnimation ( string key )

inline

Returns the currently ongoing animation if present or null if no animation with that key is ongoing.

Parameters

key	The key attached to an animation

Returns

the currently ongoing animation if present or null if no animation with that key is ongoing.

GetHashCode()

override int Luciad.Animations.AnimationManager.GetHashCode ( )

inline

StartAnimation()

void Luciad.Animations.AnimationManager.StartAnimation ( string key, Luciad.Animations.IAnimation animation )

inline

Starts a new animation.

Upon starting, the animation manager invokes IAnimation.OnStart on the IAnimation.

Each animation has a key attached to it. You can stop an animation by invoking AnimationManager.StopAnimation with this key or you can replace the animation by invoking AnimationManager.StartAnimation with the same key.

Parameters

key	The key attached to that animation. If an animation is already playing with that key, the manager stops it before starting the new animation.
animation	The IAnimation object to be played, cannot be null.

Exceptions

System.ArgumentNullException

when the passed animation is null.

StopAnimation()

void Luciad.Animations.AnimationManager.StopAnimation ( string key )

inline

Stops the animation that was added with the given key, if present.

If an animation is currently playing with that key, the manager invokes IAnimation.OnStop on that animation.

Parameters

key	The key attached to the animation that should be removed.