ilog.views.animation

Class IlvManagerAnimator

java.lang.Object

ilog.views.animation.IlvManagerAnimator

public class IlvManagerAnimator
extends Object

An IlvManagerAnimator allows you to animate the content changes in an IlvManager. It can also animate the transformer changes of the IlvManagerView attached to the manager.

The animator must be attached to an IlvManager.

The animator can be used in a single-threaded application or in a multithreaded application. You are recommended to use multithreading for smoother redrawing.

Single-threaded applications are only possible if the manager views are embedded in a Swing component, for instance IlvJManagerViewPanel or IlvJScrollManagerView. In this case, the animation runs directly in the AWT event thread.

In a single-threaded application, the mechanism works as follows:

1. Allocate and attach the animator.
2. Before making the changes, call recordState. This records the start positions of all objects involved in the animation.
3. Change the contents of the manager as needed, for example, by moving some objects or modifying the transformer of the manager view. Make sure that the redraw flag is switched off so that the objects are not drawn during the move (see IlvManager.moveObject(ilog.views.IlvGraphic, double, double, boolean)).
4. Call animate to animate the changes to the manager. This will draw an animated movement for the objects from the positions recorded by recordState to the new object positions.
5. Repeat from step 2.
6. If animation is no longer needed, detach the animator from the manager.

While the animation in single-threaded applications is restricted to manager views embedded in Swing components, multithreaded applications can also use AWT components not wrapped in Swing components.

Multithreaded applications often draw the animated movement more smoothly than single-threaded applications.

In a multithreaded application, the mechanism works as follows:

1. Allocate and attach the animator.
2. Start a new animation thread by calling IlvManagerAnimator.start. This animation thread performs the changes to the IlvManager.
3. Before making the changes, the animation thread calls recordState to record the start positions of all objects involved in the animation.
4. Change the contents of the manager as needed, for example, by moving some objects or modifying the transformer of the manager view. Make sure that the redraw flag is switched off so that the objects are not drawn during the move (see IlvManager.moveObject(ilog.views.IlvGraphic, double, double, boolean)).
5. Call animate within the animation thread to animate the changes to the manager. This will draw an animated movement for the objects from the positions recorded by recordState to the new object positions.
6. Repeat from step 3.
7. If animation is no longer needed, detach the animator from the manager.

Since:

JViews 6.0

Constructor Summary

Constructors

Constructor and Description
IlvManagerAnimator(IlvManager manager) Creates a new IlvManagerAnimator and attaches it to the specified manager.
IlvManagerAnimator(IlvManager manager, boolean resizingObjects) Creates a new IlvManagerAnimator and attaches it to the specified manager.

Method Summary

Modifier and Type	Method and Description
protected void	afterAnimationStep(int i) Called at the end of the ith animation step.
void	animate() Animates all objects in the manager that is displayed in the attached manager view.
void	animateToImages(ImageConsumer imageConsumer, IlvManagerView view) If this method is called instead of animate(), the animation is dumped into a sequence of images.
void	animateToImages(ImageConsumer imageConsumer, int width, int height, IlvTransformer transformer) If this method is called instead of animate(), the animation is dumped into a sequence of images.
protected boolean	animStep(int i) Performs one animation step that moves all objects in the manager.
void	attach(IlvManager manager) Attaches the animator to a manager.
protected IlvObjectAnimator	createGraphicAnimator(IlvGraphic node) This method is called when a new animator property for an IlvGraphic that is a node in the graph is needed.
protected IlvObjectAnimator	createLinkImageAnimator(IlvLinkImage link) This method is called when a new animator property for an IlvLinkImage that is a link in the graph is needed.
protected IlvObjectAnimator	createObjectAnimator(IlvGraphic graphic) This method is called when a new animator property for a graphic is needed.
void	detach() Detaches the animator from its manager.
int	getAnimationAccelerationRate() Returns the number of steps during which the animation speeds up at the beginning of the animation and the number of steps during which the animation slows down at the end of the animation.
int	getAnimationDelay() Returns the interval between drawing steps during animation.
int	getAnimationRate() Returns the animation rate.
Thread	getAnimationThread() Returns the animation thread.
IlvManager	getManager() Returns the animated manager.
IlvObjectAnimator	getObjectAnimator(IlvGraphic graphic, boolean create) Returns the object animator of a graphic.
boolean	isMultiThreading() Returns true if the animator runs in its own thread.
boolean	isResizingObjects() Returns true if the animator resizes the objects.
boolean	isRunning() Returns true if animation is currently running.
void	recordState() Records the current state of all objects in the manager that is displayed in the attached manager view.
void	setAnimationAccelerationRate(int rate) Sets the number of steps during which the animation speeds up at the beginning of the animation and the number of steps during which the animation slows down at the end of the animation.
void	setAnimationDelay(int delayTime) Sets the interval between drawing steps during animation, in milliseconds.
void	setAnimationRate(int rate) Sets the animation rate, that is, the number of drawing steps performed to animate a smooth movement from start state to end state.
void	setResizingObjects(boolean resizing) If resizing is true, the width and height of the graphic objects are changed linearly from the initial size to the final size.
void	start(Runnable runnable) Starts the animation thread.
void	start(Thread thread) Starts the animation thread.
void	unrecordState() Clears the animation state of the manager.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvManagerAnimator

public IlvManagerAnimator(IlvManager manager)

Creates a new IlvManagerAnimator and attaches it to the specified manager.

See Also:

attach(ilog.views.IlvManager), detach()

IlvManagerAnimator

public IlvManagerAnimator(IlvManager manager,
                          boolean resizingObjects)

Creates a new IlvManagerAnimator and attaches it to the specified manager.

Parameters:

manager - The specified manager.

resizingObjects - If true, the graphic objects are moved and resized during animation. If false, the objects are only moved; their size is left unchanged.

See Also:

attach(ilog.views.IlvManager), detach()

Method Detail

attach

public void attach(IlvManager manager)

Attaches the animator to a manager. All views of the manager are set to double-buffering mode to allow animation.

If the animation is multithreaded, this method should not be called by the animation thread but only by the main thread.

Parameters:

manager - The manager.

See Also:

IlvManagerView.setDoubleBuffering(boolean), detach()

detach

public void detach()

Detaches the animator from its manager. This method should be called when no more animation is needed. If multithreading applies, the animation thread must be stopped before detach is called. This method restores the initial state of the manager views and detaches all object animators from the objects managed by the manager.

If animation is multithreaded, this method should not be called by the animation thread but only by the main thread.

See Also:

attach(ilog.views.IlvManager)

getObjectAnimator

public IlvObjectAnimator getObjectAnimator(IlvGraphic graphic,
                                           boolean create)

Returns the object animator of a graphic. If the create flag is true, this method will create a new object animator if there is no animator yet for the specified graphic.

See Also:

attach(ilog.views.IlvManager), createObjectAnimator(ilog.views.IlvGraphic)

createObjectAnimator

protected IlvObjectAnimator createObjectAnimator(IlvGraphic graphic)

This method is called when a new animator property for a graphic is needed. It analyzes whether an animator is needed for a node or a link and calls createGraphicAnimator or createLinkImageAnimator.

Customers that create their own object animators can override this method to create an object animator different from the default animators.

See Also:

getObjectAnimator(ilog.views.IlvGraphic, boolean), createGraphicAnimator(ilog.views.IlvGraphic), createLinkImageAnimator(ilog.views.IlvLinkImage), attach(ilog.views.IlvManager)

createGraphicAnimator

protected IlvObjectAnimator createGraphicAnimator(IlvGraphic node)

This method is called when a new animator property for an IlvGraphic that is a node in the graph is needed.

The default implementation returns a new instance of class IlvGraphicAnimator, which is able to animate changes to the bounding box of a node. Customers that create their own object animators can override this method to create an object animator different from the default animators.

See Also:

createObjectAnimator(ilog.views.IlvGraphic), IlvGraphicAnimator

createLinkImageAnimator

protected IlvObjectAnimator createLinkImageAnimator(IlvLinkImage link)

This method is called when a new animator property for an IlvLinkImage that is a link in the graph is needed.

The default implementation returns a new instance of class IlvLinkImageAnimator, which is able to animate changes to the shape of a link. Customers that create their own object animators can override this method to create an object animator different from the default animators.

See Also:

createObjectAnimator(ilog.views.IlvGraphic), IlvLinkImageAnimator

getManager

public IlvManager getManager()

Returns the animated manager.

See Also:

attach(ilog.views.IlvManager), detach()

setAnimationRate

public void setAnimationRate(int rate)

Sets the animation rate, that is, the number of drawing steps performed to animate a smooth movement from start state to end state. This rate controls how smoothly the movement appears on the screen. The larger the animation rate, the smoother the movement.

The default is 20.

See Also:

getAnimationRate(), setAnimationDelay(int)

getAnimationRate

public int getAnimationRate()

Returns the animation rate.

See Also:

setAnimationRate(int)

setAnimationAccelerationRate

public void setAnimationAccelerationRate(int rate)

Sets the number of steps during which the animation speeds up at the beginning of the animation and the number of steps during which the animation slows down at the end of the animation. The effective animation acceleration rate cannot be larger than half the animation rate. At exactly half the animation rate, movement of animated objects accelerates during the first half of the animation and decelerates during the second half of the animation. If the animation rate is larger than twice the acceleration rate, the animated objects move with constant speed after the acceleration phase and before the deceleration phase.

The default is 0, which means no acceleration or deceleration occurs (animated objects always move with constant speed).

Parameters:

rate - The number of acceleration and deceleration steps.

Since:

JViews 8.6

See Also:

setAnimationRate(int), getAnimationAccelerationRate()

getAnimationAccelerationRate

public int getAnimationAccelerationRate()

Returns the number of steps during which the animation speeds up at the beginning of the animation and the number of steps during which the animation slows down at the end of the animation.

Returns:

The number of animation acceleration (and deceleration) steps.

Since:

JViews 8.6

See Also:

setAnimationAccelerationRate(int)

setAnimationDelay

public void setAnimationDelay(int delayTime)

Sets the interval between drawing steps during animation, in milliseconds. For a given animation rate, this interval controls how fast the animation appears on the screen. The larger the interval, the slower the movement.

The default is 50 milliseconds.

See Also:

getAnimationDelay(), setAnimationRate(int)

getAnimationDelay

public int getAnimationDelay()

Returns the interval between drawing steps during animation. The interval is measured in milliseconds.

See Also:

setAnimationDelay(int)

setResizingObjects

public void setResizingObjects(boolean resizing)

If resizing is true, the width and height of the graphic objects are changed linearly from the initial size to the final size. If resizing is false, the objects are only moved.

The default value is true.

See Also:

isResizingObjects()

isResizingObjects

public boolean isResizingObjects()

Returns true if the animator resizes the objects.

See Also:

setResizingObjects(boolean)

isMultiThreading

public boolean isMultiThreading()

Returns true if the animator runs in its own thread.

See Also:

start(java.lang.Runnable)

getAnimationThread

public Thread getAnimationThread()

Returns the animation thread.

See Also:

start(java.lang.Runnable)

start

public void start(Runnable runnable)

Starts the animation thread.

start

public void start(Thread thread)

Starts the animation thread.

isRunning

public boolean isRunning()

Returns true if animation is currently running. This method returns true immediately after start(Runnable) or start(Thread) has been called. It returns false when animate() has finished or when unrecordState() has been called.

See Also:

start(Runnable), start(Thread), animate(), unrecordState()

recordState

public void recordState()

Records the current state of all objects in the manager that is displayed in the attached manager view. This method must be called before any changes to be animated are done in the manager. An animation sequence always shows the movement between the previous recorded state and the actual state.

Any call to recordState should be followed either by a call to animate or by a call to unrecordState. Both clear the animation status of the manager.

See Also:

getManager(), animate(), unrecordState()

unrecordState

public void unrecordState()

Clears the animation state of the manager. Call this method instead of animate if you have called recordState but you want to cancel animation. Example:

 IlvManagerAnimator animator = ...
 animator.recordState();
 try {
   ... changes to the manager ...
 } finally {
   if (wantAnimation)
     animator.animate();
   else
     animator.unrecordState();
 }
 

See Also:

getManager(), animate(), recordState()

animate

public void animate()

Animates all objects in the manager that is displayed in the attached manager view. This method shows an animation sequence by moving the objects in small steps from the recorded state to the current state. You can set the number of small steps with setAnimationRate(int).

If the animation is multithreaded, a separate drawing thread is responsible for the paint refresh of the manager view. If the animation is single-threaded, the manager view is locked and is painted immediately, during animation, by setting the draw mode IlvManagerView.DIRECT_REDRAW.

See Also:

recordState(), unrecordState(), setAnimationRate(int), setAnimationDelay(int), animStep(int)

animStep

protected boolean animStep(int i)

Performs one animation step that moves all objects in the manager. The number of animation steps is the animation rate. This method returns true if animation must continue, that is, if the objects have not yet reached their final state.

See Also:

animate(), setAnimationRate(int)

afterAnimationStep

protected void afterAnimationStep(int i)

Called at the end of the ith animation step.

animateToImages

public void animateToImages(ImageConsumer imageConsumer,
                            int width,
                            int height,
                            IlvTransformer transformer)

If this method is called instead of animate(), the animation is dumped into a sequence of images. Notice that dumping is usually very slow. The specified image consumer receives the images through setPixels. When each single frame is completed, imageComplete is called on the image consumer passing the status ImageConsumer.SINGLEFRAMEDONE. When the entire animation is completed, imageComplete is called on the image consumer passing the status ImageConsumer.STATICIMAGEDONE.

Parameters:

imageConsumer - The consumer of the image frames.

width - The width of the images

height - The height of the images

transformer - The initial transformer of the animation. The transformer may change during the animation.

animateToImages

public void animateToImages(ImageConsumer imageConsumer,
                            IlvManagerView view)

If this method is called instead of animate(), the animation is dumped into a sequence of images. Notice that dumping is usually very slow. The input image consumer receives the images through setPixels. When each single frame is completed, imageComplete is called on the image consumer passing the status ImageConsumer.SINGLEFRAMEDONE. When the entire animation is completed, imageComplete is called on the image consumer passing the status ImageConsumer.STATICIMAGEDONE.

Parameters:

imageConsumer - The consumer of the image frames.

view - The view used to display the animation. The resulting images have the width and height of this view. This must be a view of the manager to be animated. The view need not be visible. If the view is visible, it must not be touched or resized during animation.