prajna.viz.display

Class AnimateCanvas<N,E>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

prajna.viz.display.AbstractGraphDisplay<N,E>

prajna.viz.display.GraphCanvas<N,E>

prajna.viz.display.AnimateCanvas<N,E>

Type Parameters:

N - The class of nodes in the graph

E - The class of edges in the graph

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, Animatable, GraphDisplay<N,E>

public class AnimateCanvas<N,E>
extends GraphCanvas<N,E>
implements Animatable

The AnimateCanvas class augments the GraphCanvas with support for Animated displays. This class double-buffers animated displays. When it first animates a display, it tries to guess the number of steps needed for the specified ideal animation time; it will adjust further animations as necessary

Author:

Edward Swing

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface prajna.data.Animatable

Animatable.Animation

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
AnimateCanvas() Constructs an AnimateCanvas with an empty graph
AnimateCanvas(Graph<N,E> graph) Constructs a AnimateCanvas with the specified graph

Method Summary

Methods

Modifier and Type	Method and Description
void	animate() Animate this canvas.
void	arrange() Arranges the graph using the current arrangement
Animatable.Animation	getAnimationFlag() returns the animation type flag
double	getAnimationStep() returns the fractional step along the animation
E	getEdgeAt(java.awt.Point pickPoint) Returns the edge located at the pickPoint.
N	getNodeAt(java.awt.Point pickPoint) Returns the node located at the pickPoint.
protected void	processComponentEvent(java.awt.event.ComponentEvent event) Processes any resize event.
protected void	redrawEdge(E edge, java.awt.Graphics g) Redraws an individual edge.
protected void	redrawNode(N node, java.awt.Graphics g) Redraws an individual node.
void	setAnimationFlag(Animatable.Animation flag) Sets a flag indicating the type of transformation.
void	setAnimationStep(double animationStep) Sets the fractional step along the animation.
void	setAnimationTime(long millis) Sets the ideal animation time for the time to animate the change of display.
void	setGraphArrangement(GraphArrangement<N,E> arrangement) Set the current graph arrangement.

Methods inherited from class prajna.viz.display.GraphCanvas

getArrangement, getEdgeRenderer, getNodeRenderer, paintComponent, redrawEdge, redrawNode, renderGraph, setEdgeRenderer, setGraph, setNodeRenderer, updateGraph, validateArrangement

Methods inherited from class prajna.viz.display.AbstractGraphDisplay

addHoverListener, addItemListener, fireHoverStateChanged, fireItemStateChanged, getGraph, getSelectedEdge, getSelectedNode, getSelectedObjects, isEdgeDisplayable, isEdgeSelectable, isHighlighted, isNodeDisplayable, processMouseEvent, removeHoverListener, removeItemListener, selectEdge, selectNode, setEdgeSelectable

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

AnimateCanvas

public AnimateCanvas()

Constructs an AnimateCanvas with an empty graph

AnimateCanvas

public AnimateCanvas(Graph<N,E> graph)

Constructs a AnimateCanvas with the specified graph

Parameters:

graph - the graph to display in the canvas

Method Detail

animate

public void animate()

Animate this canvas. This method steps through a series of steps, and attempts to interpolate the positions of the nodes. It will be able to animate nodes if the NodeRenderer supports animation.

arrange

public void arrange()
             throws ArrangementException

Arranges the graph using the current arrangement

Overrides:

arrange in class GraphCanvas<N,E>

Throws:

ArrangementException - exception thrown if the graph cannot be properly arranged

getAnimationFlag

public Animatable.Animation getAnimationFlag()

returns the animation type flag

Specified by:

getAnimationFlag in interface Animatable

Returns:

the flag indicating the type of transformation

getAnimationStep

public double getAnimationStep()

returns the fractional step along the animation

Specified by:

getAnimationStep in interface Animatable

Returns:

the fractional step along the animation

getEdgeAt

public E getEdgeAt(java.awt.Point pickPoint)

Returns the edge located at the pickPoint. If multiple edges are overlapping at the pickPoint, this method will assume they were drawn in order, and that the last edge in the list has been drawn above the earlier edges, and therefore will return the last one in the graph.

Overrides:

getEdgeAt in class GraphCanvas<N,E>

Parameters:

pickPoint - the point in the canvas to pick for edges.

Returns:

the edge at the pickPoint

getNodeAt

public N getNodeAt(java.awt.Point pickPoint)

Returns the node located at the pickPoint. If multiple nodes are overlapping at the pickPoint, this method will assume they were drawn in order, and that the last node in the list has been drawn above the earlier nodes, and therefore will return the last one in the graph.

Overrides:

getNodeAt in class GraphCanvas<N,E>

Parameters:

pickPoint - the point in the canvas to pick for nodes.

Returns:

the node at the pickPoint

processComponentEvent

protected void processComponentEvent(java.awt.event.ComponentEvent event)

Processes any resize event. Makes sure that the image buffer is the same size as the actual canvas.

Overrides:

processComponentEvent in class java.awt.Component

Parameters:

event - the component event

redrawEdge

protected void redrawEdge(E edge,
              java.awt.Graphics g)

Redraws an individual edge. This method attempts to interpolate the edge locations if the canvas is being animated. Otherwise, it simply draws the edge from the origin to the destination.

Overrides:

redrawEdge in class GraphCanvas<N,E>

Parameters:

edge - the edge to redraw

g - the graphics context

redrawNode

protected void redrawNode(N node,
              java.awt.Graphics g)

Redraws an individual node. This method attempts to interpolate the node location if the canvas is being animated. Otherwise, it simply draws the node at its location.

Overrides:

redrawNode in class GraphCanvas<N,E>

Parameters:

node - the node to redraw

setAnimationFlag

public void setAnimationFlag(Animatable.Animation flag)

Sets a flag indicating the type of transformation. The default is Animation.MOVE

Specified by:

setAnimationFlag in interface Animatable

Parameters:

flag - indicating the type of transformation

setAnimationStep

public void setAnimationStep(double animationStep)

Sets the fractional step along the animation. if frac=0.0, then the animation is at the start position; a value of 1.0 is at the end position.

Specified by:

setAnimationStep in interface Animatable

Parameters:

animationStep - the fractional step along the animation

setAnimationTime

public void setAnimationTime(long millis)

Sets the ideal animation time for the time to animate the change of display. This value is the total time for an animation, not a per-step time. The default is 2 seconds (2000 millis).

Parameters:

millis - the animation time, in milliseconds

setGraphArrangement

public void setGraphArrangement(GraphArrangement<N,E> arrangement)

Set the current graph arrangement. This method causes the graph to redraw, updating the node and edge locations according to the new arrangement. The previous locations are stored as animation start points, so this canvas can animate from the old positions to the new ones.

Overrides:

setGraphArrangement in class GraphCanvas<N,E>

Parameters:

arrangement - the new graph arrangement