ilog.views.animation

Class IlvGraphicAnimator

java.lang.Object

ilog.views.animation.IlvGraphicAnimator

All Implemented Interfaces:

IlvObjectAnimator

public class IlvGraphicAnimator
extends Object
implements IlvObjectAnimator

An IlvGraphicAnimator allows you to animate changes in the position and size of an IlvGraphic (a node) in an IlvManager. When an IlvManagerAnimator is attached to the IlvManager, an IlvGraphicAnimator is created for each node managed by the manager to support animation.

Since:

JViews 6.0

See Also:

IlvManagerAnimator, IlvManagerAnimator.createGraphicAnimator(ilog.views.IlvGraphic)

Constructor Summary

Constructors

Constructor and Description
IlvGraphicAnimator(IlvGraphic g) Creates a new IlvGraphicAnimator.

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.
IlvRect	getNewBoundingBox() Returns the bounding box of the object that should be reached at the end of the sequence of animation steps.
IlvRect	getOldBoundingBox() Returns the bounding box that was recorded for the object.
boolean	isResizeAllowed() Returns true if resizing the animated object during animation is allowed.
void	recordState() Records the current state of the object in the object animator.
void	setResizeAllowed(boolean enable) Sets whether resizing the animated object during animation is allowed.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvGraphicAnimator

public IlvGraphicAnimator(IlvGraphic g)

Creates a new IlvGraphicAnimator.

Parameters:

g - The graphic to be animated.

Method Detail

getOldBoundingBox

public IlvRect getOldBoundingBox()

Returns the bounding box that was recorded for the object. This is the bounding box where the object is drawn at the start of a sequence of animation steps.

See Also:

recordState(), animStep(ilog.views.IlvManager, int, int), IlvGraphic.boundingBox(ilog.views.IlvTransformer)

getNewBoundingBox

public IlvRect getNewBoundingBox()

Returns the bounding box of the object that should be reached at the end of the sequence of animation steps. This box is updated at the beginning of IlvManagerAnimator.animate() when animInit() is called; it is cleaned up at the end of IlvManagerAnimator.animate(), when animCleanup() is called.

See Also:

animInit(), animCleanup(), animStep(ilog.views.IlvManager, int, int), IlvGraphic.boundingBox(ilog.views.IlvTransformer)

setResizeAllowed

public void setResizeAllowed(boolean enable)

Sets whether resizing the animated object during animation is allowed. It is allowed by default. If this flag is disabled, then the object is moved during the animation, but not resized. If the animated object is a subgrapher of a nested graph, you are recommended to disable resizing because the size of the subgrapher depends on the bounding box of its contents.

isResizeAllowed

public boolean isResizeAllowed()

Returns true if resizing the animated object during animation is allowed.

recordState

public void recordState()

Records the current state of the object in the object animator. This method is called by IlvManagerAnimator.recordState(). It updates the old bounding box. 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(), getOldBoundingBox()

animInit

public void animInit()

Initializes animation. This method is called before the first step of animate is performed. It updates the new bounding box.

Specified by:

animInit in interface IlvObjectAnimator

See Also:

IlvManagerAnimator.animate(), getNewBoundingBox()

animCleanup

public void animCleanup()

Cleans up animation. This method 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(), getNewBoundingBox()

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 an 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)