com.yworks.yfiles.view

Class ViewportAnimation

java.lang.Object

com.yworks.yfiles.view.ViewportAnimation

All Implemented Interfaces:

IAnimation

public class ViewportAnimation
extends Object
implements IAnimation

Animates changing the viewport bounds and the zoom factor for a CanvasControl.

Constructor Summary

Constructors

Constructor and Description
ViewportAnimation(CanvasControl canvas, RectD targetBounds, Duration preferredDuration) Creates a new instance of ViewportAnimation.

Method Summary

Modifier and Type	Method and Description
void	animate(double time) Does the animation according to the relative animation time.
protected void	applyCenterPoint(PointD focus) Effectively applies the center point value.
protected void	applyViewPoint(PointD focus) Effectively applies the view point value.
protected void	applyZoom(double value) Effectively applies the zoom value.
void	cancel() Cancels this viewport animation so that subsequent calls to animate(double) or cleanup() won't affect the viewport anymore.
void	cleanup() Cleans up after the animation.
double	getMaximumTargetZoom() Gets the maximum zoom level to use after the animation.
Duration	getPreferredDuration() Gets the preferred duration of the animation.
ScrollPane.ScrollBarPolicy	getScrollBarVisibility() Gets the scroll bar visibility that will be used during the animation.
RectD	getTargetBounds() Gets the target world bounds.
InsetsD	getTargetViewMargins() Gets the margins in view coordinate dimensions to use at the target zoom level.
void	initialize() Initializes this animation.
boolean	isViewportLimiterConsiderationEnabled() Whether to respect the ViewportLimiter of the CanvasControl whose Viewport is animated.
void	setMaximumTargetZoom(double value) Sets the maximum zoom level to use after the animation.
void	setPreferredDuration(Duration value) Sets the preferred duration of the animation.
void	setScrollBarVisibility(ScrollPane.ScrollBarPolicy value) Sets the scroll bar visibility that will be used during the animation.
void	setTargetBounds(RectD value) Sets the target world bounds.
void	setTargetViewMargins(InsetsD value) Sets the margins in view coordinate dimensions to use at the target zoom level.
void	setViewportLimiterConsiderationEnabled(boolean value) Whether to respect the ViewportLimiter of the CanvasControl whose Viewport is animated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yworks.yfiles.view.IAnimation

createEasedAnimation, createEasedAnimation, createEasedAnimation, createEdgeSegmentAnimation, createGraphAnimation, createLabelAnimation, createNodeAnimation, createParallelAnimation, createParallelAnimation, createParallelAnimation, createParallelAnimation, createParallelAnimation, createPathAnimation, createPortAnimation, createTableAnimation

Constructor Detail

ViewportAnimation

public ViewportAnimation(CanvasControl canvas,
                         RectD targetBounds,
                         Duration preferredDuration)

Creates a new instance of ViewportAnimation.

Parameters:

canvas - The canvas control.

targetBounds - The target world bounds for the animation.

preferredDuration - The preferred duration.

Method Detail

animate

public void animate(double time)

Description copied from interface: IAnimation

Does the animation according to the relative animation time.

The animation starts with the time 0 and ends with time 1.

Specified by:

animate in interface IAnimation

Parameters:

time - the animation time [0,1]

applyCenterPoint

protected void applyCenterPoint(PointD focus)

Effectively applies the center point value.

applyViewPoint

protected void applyViewPoint(PointD focus)

Effectively applies the view point value.

applyZoom

protected void applyZoom(double value)

Effectively applies the zoom value.

cancel

public void cancel()

Cancels this viewport animation so that subsequent calls to animate(double) or cleanup() won't affect the viewport anymore.

cleanup

public void cleanup()

Cleans up after the animation.

Specified by:

cleanup in interface IAnimation

getMaximumTargetZoom

public final double getMaximumTargetZoom()

Gets the maximum zoom level to use after the animation.

The default is Double.POSITIVE_INFINITY.

Returns:

The maximum target zoom.

See Also:

setMaximumTargetZoom(double)

getPreferredDuration

public final Duration getPreferredDuration()

Gets the preferred duration of the animation.

Specified by:

getPreferredDuration in interface IAnimation

Returns:

The PreferredDuration.

See Also:

setPreferredDuration(Duration)

getScrollBarVisibility

public final ScrollPane.ScrollBarPolicy getScrollBarVisibility()

Gets the scroll bar visibility that will be used during the animation.

Returns:

The scroll bar visibility to use during animation. The default is hidden.

See Also:

setScrollBarVisibility(ScrollPane.ScrollBarPolicy)

getTargetBounds

public final RectD getTargetBounds()

Gets the target world bounds.

Returns:

The TargetBounds.

See Also:

setTargetBounds(RectD)

getTargetViewMargins

public final InsetsD getTargetViewMargins()

Gets the margins in view coordinate dimensions to use at the target zoom level.

Returns:

The target view margins. The default is (0,0,0,0)

See Also:

setTargetViewMargins(InsetsD)

initialize

public void initialize()

Initializes this animation.

This has to be called once before any calls to animate(double). An instance of ViewportAnimation can be reused after an animation by setting new TargetBounds or a new PreferredDuration and calling Initialize() again.

Specified by:

initialize in interface IAnimation

isViewportLimiterConsiderationEnabled

public final boolean isViewportLimiterConsiderationEnabled()

Whether to respect the ViewportLimiter of the CanvasControl whose Viewport is animated.

Default is false.

Returns:

true if the ViewportLimiter should be considered, otherwise false.

See Also:

setViewportLimiterConsiderationEnabled(boolean)

setMaximumTargetZoom

public final void setMaximumTargetZoom(double value)

Sets the maximum zoom level to use after the animation.

The default is Double.POSITIVE_INFINITY.

Parameters:

value - The maximum target zoom.

See Also:

getMaximumTargetZoom()

setPreferredDuration

public final void setPreferredDuration(Duration value)

Sets the preferred duration of the animation.

Parameters:

value - The PreferredDuration to set.

See Also:

getPreferredDuration()

setScrollBarVisibility

public final void setScrollBarVisibility(ScrollPane.ScrollBarPolicy value)

Sets the scroll bar visibility that will be used during the animation.

Parameters:

value - The scroll bar visibility to use during animation. The default is hidden.

See Also:

getScrollBarVisibility()

setTargetBounds

public final void setTargetBounds(RectD value)

Sets the target world bounds.

Parameters:

value - The TargetBounds to set.

See Also:

getTargetBounds()

setTargetViewMargins

public final void setTargetViewMargins(InsetsD value)

Sets the margins in view coordinate dimensions to use at the target zoom level.

Parameters:

value - The target view margins. The default is (0,0,0,0)

See Also:

getTargetViewMargins()

setViewportLimiterConsiderationEnabled

public final void setViewportLimiterConsiderationEnabled(boolean value)

Whether to respect the ViewportLimiter of the CanvasControl whose Viewport is animated.

Default is false.

Parameters:

value - true if the ViewportLimiter should be considered, otherwise false.

See Also:

isViewportLimiterConsiderationEnabled()