ilog.views.animation

Class IlvLinkImageAnimator

java.lang.Object

ilog.views.animation.IlvLinkImageAnimator

All Implemented Interfaces:

IlvObjectAnimator, IlvApplyObject

public class IlvLinkImageAnimator
extends Object
implements IlvObjectAnimator, IlvApplyObject

An IlvLinkImageAnimator allows you to animate changes in the shape of an IlvLinkImage in an IlvManager. When an IlvManagerAnimator is attached to the IlvManager, an IlvLinkImageAnimator is created for each link managed by the manager to support animation.

Since:

JViews 6.0

See Also:

IlvManagerAnimator, IlvManagerAnimator.createLinkImageAnimator(ilog.views.IlvLinkImage)

Constructor Summary

Constructors

Constructor and Description
IlvLinkImageAnimator(IlvLinkImage l) Creates a new IlvLinkImageAnimator.

Method Summary

Modifier and Type	Method and Description
void	animCleanup() Cleans up animation.
void	animInit() Initializes animation.
boolean	animStep(IlvManager manager, int i, int maxI) This method is called in the ith animation step.
void	apply(IlvGraphic obj, Object arg) Reshapes the link.
double	getNewLineWidth() Returns the line width of the link that should be reached at the end of the sequence of animation steps.
IlvPoint[]	getNewLinkPoints() Returns the new link points of the link, which define the shape that should be reached at the end of the sequence of animation steps.
double	getOldLineWidth() Returns the line width that was recorded for the link.
IlvPoint[]	getOldLinkPoints() Returns the old link points recorded for the link.
void	recordState() Records the current state of the link in the link animator.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvLinkImageAnimator

public IlvLinkImageAnimator(IlvLinkImage l)

Creates a new IlvLinkImageAnimator.

Parameters:

l - The link image to be animated.

Method Detail

getOldLinkPoints

public IlvPoint[] getOldLinkPoints()

Returns the old link points recorded for the link. The first and last points in the array are the connection points of the link at the incident nodes. The remaining points in the array are the intermediate link points. This method gives the shape of the link when drawn at the start of a sequence of animation steps.

See Also:

recordState(), animStep(ilog.views.IlvManager, int, int), IlvLinkImage.getLinkPoints(ilog.views.IlvTransformer), IlvLinkImage.getConnectionPoints(ilog.views.IlvPoint, ilog.views.IlvPoint, ilog.views.IlvTransformer), IlvLinkImage.setIntermediateLinkPoints(ilog.views.IlvPoint[], int, int)

getNewLinkPoints

public IlvPoint[] getNewLinkPoints()

Returns the new link points of the link, which define the shape that should be reached at the end of the sequence of animation steps. The first and last points in the array are the connection points of the link at the incident nodes. The remaining points in the array are the intermediate link points. The new link points are updated at the beginning of IlvManagerAnimator.animate(), when animInit() is called; they are cleaned up at the end of IlvManagerAnimator.animate(), when animCleanup() is called.

See Also:

animInit(), animStep(ilog.views.IlvManager, int, int), animCleanup(), IlvLinkImage.getLinkPoints(ilog.views.IlvTransformer), IlvLinkImage.getConnectionPoints(ilog.views.IlvPoint, ilog.views.IlvPoint, ilog.views.IlvTransformer), IlvLinkImage.setIntermediateLinkPoints(ilog.views.IlvPoint[], int, int)

getOldLineWidth

public double getOldLineWidth()

Returns the line width that was recorded for the link. This is the line width of the link when drawn at the start of a sequence of animation steps.

See Also:

recordState(), animStep(ilog.views.IlvManager, int, int), IlvLinkImage.getLineWidth()

getNewLineWidth

public double getNewLineWidth()

Returns the line width of the link that should be reached at the end of the sequence of animation steps. This width is updated at the beginning of IlvManagerAnimator.animate(), when animInit() is called.

See Also:

animInit(), animStep(ilog.views.IlvManager, int, int), IlvLinkImage.getLineWidth()

recordState

public void recordState()

Records the current state of the link in the link animator. This method is called by IlvManagerAnimator.recordState(). It updates the old link points and the old line width. An animation sequence always shows the movement between the previous recorded state and the current state.

Specified by:

recordState in interface IlvObjectAnimator

See Also:

IlvManagerAnimator.recordState(), getOldLinkPoints(), getOldLineWidth()

animInit

public void animInit()

Initializes animation. This is called before the first step of animate is performed. It updates the new link points and the new line width.

Specified by:

animInit in interface IlvObjectAnimator

See Also:

IlvManagerAnimator.animate(), getNewLinkPoints(), getNewLineWidth()

animCleanup

public void animCleanup()

Cleans up animation. This is called after the last step of animate is performed. It cleans up the memory.

Specified by:

animCleanup in interface IlvObjectAnimator

See Also:

IlvManagerAnimator.animate(), getNewLinkPoints()

animStep

public boolean animStep(IlvManager manager,
                        int i,
                        int maxI)

This method is called in the ith animation step. It is called in a loop from i = 1 to i = maxI by IlvManagerAnimator.animate() to show animated movement, for example, moving or resizing objects in small steps. It returns true if animation must continue for this object, and false if animation is finished for this object after the ith step.

Specified by:

animStep in interface IlvObjectAnimator

Parameters:

manager - The manager that contains the graphic to be animated.

i - The number of the current animation step.

maxI - The maximum number of animation steps.

See Also:

IlvManagerAnimator.animate(), IlvManagerAnimator.animStep(int)

apply

public void apply(IlvGraphic obj,
                  Object arg)

Reshapes the link. This method is here only for internal implementation reasons. Geometric changes in links are only allowed through IlvManager.applyToObject(ilog.views.IlvGraphic, ilog.views.IlvApplyObject, java.lang.Object, boolean), which calls IlvApplyObject.apply(ilog.views.IlvGraphic, java.lang.Object). Therefore the link animator implements the IlvApplyObject interface.

Specified by:

apply in interface IlvApplyObject

Parameters:

obj - The link.

arg - Unused.

See Also:

IlvApplyObject