Luciad.Animations.AnimationManager Class Reference

Class that starts, updates and stops luciad::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 ()
Luciad.Animations.AnimationManager.? OngoingAnimation	GetCurrentAnimation (string key)
	Returns the currently ongoing animation if present or std::nullopt if no animation with that key is ongoing. More...
void	StartAnimation (string key, Luciad.Animations.IAnimation animation)
	Starts a new animation. More...
void	StopAnimation (string key)
	Stops the animation that was added with the given key, if present. More...

Detailed Description

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

This class is used by the Map class. See luciad::Map::getAnimationManager. 2021.1

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::AnimationManager.

Member Function Documentation

Dispose()

void Luciad.Animations.AnimationManager.Dispose ( )

inline

GetCurrentAnimation()

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

inline

Returns the currently ongoing animation if present or std::nullopt if no animation with that key is ongoing.

key

The key attached to an animation

the currently ongoing animation if present or std::nullopt if no animation with that key is ongoing.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::AnimationManager::getCurrentAnimation.

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 luciad::AnimationManager::stopAnimation with this key or you can replace the animation by invoking luciad::AnimationManager::startAnimation with the same key.

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 luciad::IAnimation object to be played, cannot be nullptr.

luciad::NullArgumentException

when the passed animation is nullptr.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::AnimationManager::startAnimation.

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.

key

The key attached to the animation that should be removed.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::AnimationManager::stopAnimation.