com.yworks.yfiles.view

Class Animator

java.lang.Object

com.yworks.yfiles.view.Animator

public class Animator
extends Object

Runs animations in a CanvasControl.

For running IAnimation instances, the methods animate(IAnimation, IEventHandler) or animateAndWait(IAnimation) can be used. For simpler cases of custom animations there are also overloads of both methods that take an IAnimationCallback.

See Also:

IAnimation, IAnimationCallback

Constructor Summary

Constructors

Constructor and Description
Animator(CanvasControl canvas) Initializes a new instance of the Animator class using the given CanvasControl's Dispatcher to run the animations.

Method Summary

Modifier and Type	Method and Description
void	animate(IAnimation animation) Animates the given animation instance and triggers the callback upon completion.
void	animate(IAnimationCallback callback, Duration duration) Starts animating the given animation for the specified duration.
void	animate(IAnimationCallback callback, Duration duration, IEventHandler<IEventArgs> finishedCallback) Starts animating the given animation for the specified duration.
void	animate(IAnimation animation, IEventHandler<IEventArgs> finishedCallback) Animates the given animation instance and triggers the callback upon completion.
void	animateAndWait(IAnimation animation) Animates the given animation instance.
void	animateAndWait(IAnimationCallback callback, Duration duration) Starts to animate the given animation for the specified duration.
void	destroy() Stops all running animations.
CanvasControl	getControl() The control the animations are run on.
boolean	isAutoUpdateEnabled() Gets a value indicating whether to automatically invalidate the control this instance has been created for.
boolean	isUserInteractionAllowed() Determines whether user interaction should be allowed during the animation.
void	setAutoUpdateEnabled(boolean value) Sets a value indicating whether to automatically invalidate the control this instance has been created for.
void	setUserInteractionAllowed(boolean value) Determines whether user interaction should be allowed during the animation.
protected void	updateControl() Invalidates the control if AutoUpdateEnabled is set to true.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Animator

public Animator(CanvasControl canvas)

Initializes a new instance of the Animator class using the given CanvasControl's Dispatcher to run the animations.

Using this constructor this instance will query an instance of WaitInputMode from the canvas's context to automatically set the Waiting property during animations if UserInteractionAllowed is set to false. The animation is not started until animate(IAnimation, IEventHandler) or animate(IAnimationCallback, Duration, IEventHandler) is called.

Parameters:

canvas - The canvas control.

Method Detail

animate

public final void animate(IAnimation animation)

Animates the given animation instance and triggers the callback upon completion.

The animation will be performed asynchronously during each drawn frame. Thus this method cannot block until the operation is completed if it is started from the Dispatcher that is associated with the control this instance has been created for. It will return before the animation has finished. Upon animation end the finishedCallback will be triggered.

Parameters:

animation - The animation to perform.

See Also:

animateAndWait(IAnimation)

animate

public final void animate(IAnimationCallback callback,
                          Duration duration)

Starts animating the given animation for the specified duration.

The animation will be performed asynchronously during each drawn frame. This method will not block until the operation is completed but might return before the animation has been finished.

Parameters:

callback - The callback to use for the animation.

duration - The duration in milliseconds that the animation should last.

See Also:

animateAndWait(IAnimationCallback, Duration)

animate

public final void animate(IAnimationCallback callback,
                          Duration duration,
                          IEventHandler<IEventArgs> finishedCallback)

Starts animating the given animation for the specified duration.

The animation will be performed asynchronously during each drawn frame. This method will not block until the operation is completed but might return before the animation has been finished.

Parameters:

callback - The callback to use for the animation.

duration - The duration in milliseconds that the animation should last.

finishedCallback - A callback that will be triggered on the Control's Thread once the animation ended.

See Also:

animateAndWait(IAnimationCallback, Duration)

animate

public final void animate(IAnimation animation,
                          IEventHandler<IEventArgs> finishedCallback)

Animates the given animation instance and triggers the callback upon completion.

The animation will be performed asynchronously during each drawn frame. Thus this method cannot block until the operation is completed if it is started from the Dispatcher that is associated with the control this instance has been created for. It will return before the animation has finished. Upon animation end the finishedCallback will be triggered.

Parameters:

animation - The animation to perform.

finishedCallback - A callback that will be triggered on the Control's Thread once the animation ended. The source of the event will be the animation instance.

See Also:

animateAndWait(IAnimation)

animateAndWait

public final void animateAndWait(IAnimation animation)

Animates the given animation instance.

The animation will be performed synchronously. Unless this method is called from the thread associated with the Dispatcher of the control this instance has been created for, this method will use the draw frame event to process the animation. Otherwise it will directly execute the animation from within this thread. It will block until the operation is completed and will return after the animation has been finished.

Parameters:

animation - The animation to perform.

See Also:

animate(IAnimation, IEventHandler)

animateAndWait

public final void animateAndWait(IAnimationCallback callback,
                                 Duration duration)

Starts to animate the given animation for the specified duration.

The animation will be performed asynchronously during each drawn frame. This method will block until the operation is completed and will return after the animation has been finished.

Parameters:

callback - The callback to use for the animation callbacks.

duration - The duration in milliseconds that the animation should last.

destroy

public void destroy()

Stops all running animations.

getControl

public final CanvasControl getControl()

The control the animations are run on.

Returns:

The Control.

isAutoUpdateEnabled

public final boolean isAutoUpdateEnabled()

Gets a value indicating whether to automatically invalidate the control this instance has been created for.

The default is true.

Returns:

true if invalidation should happen automatically; false otherwise.

See Also:

setAutoUpdateEnabled(boolean)

isUserInteractionAllowed

public final boolean isUserInteractionAllowed()

Determines whether user interaction should be allowed during the animation.

If false, the WaitInputMode is queried from the CanvasControl and Waiting is enabled during the animation. The default is false.

Returns:

The UserInteractionAllowed.

See Also:

setUserInteractionAllowed(boolean)

setAutoUpdateEnabled

public final void setAutoUpdateEnabled(boolean value)

Sets a value indicating whether to automatically invalidate the control this instance has been created for.

The default is true.

Parameters:

value - true if invalidation should happen automatically; false otherwise.

See Also:

isAutoUpdateEnabled()

setUserInteractionAllowed

public final void setUserInteractionAllowed(boolean value)

Determines whether user interaction should be allowed during the animation.

If false, the WaitInputMode is queried from the CanvasControl and Waiting is enabled during the animation. The default is false.

Parameters:

value - The UserInteractionAllowed to set.

See Also:

isUserInteractionAllowed()

updateControl

protected void updateControl()

Invalidates the control if AutoUpdateEnabled is set to true.

In this implementation the control is invalidated or updated directly, depending on whether the corresponding dispatcher provides com.yworks.yfiles.view.Dispatcher.checkAccess().