prajna.viz.render

Class TimeNodeRenderer

java.lang.Object

prajna.viz.render.TimeNodeRenderer

All Implemented Interfaces:

Temporal, NodeRenderer

public class TimeNodeRenderer
extends java.lang.Object
implements NodeRenderer, Temporal

Renderer to add support for Sequential nodes. This renderer takes a second renderer in the constructor; this sub-renderer is used for the visible nodes when they are displayed. When a node is not active, this NodeRenderer does not display it. However, if a fadetime is set (and greater than 0), the node will be faded into view as the renderer's current time approaches a time when the node is active. Subclasses of this renderer can easily implement different behaviors by overriding the checkNodeActive and determineFadeFactor methods.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
TimeNodeRenderer(NodeRenderer renderer) Creates a new TimeNodeRenderer object.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkNodeTime(java.lang.Object node, java.util.Date curTime) Return whether the node should be displayed at the given time.
protected double	determineFadeFactor(java.lang.Object node, java.util.Date curTime) Determine the fade factor of the node.
void	drawNode(java.awt.Graphics g, java.lang.Object node, java.awt.Point loc) Draws the node in the graphics context provided.
java.awt.Color	getColor() Gets the color for the Renderer, if any
java.util.Date	getCurTime() Gets the current time as displayed by this NodeRenderer
long	getFadeTime() Returns the fade time
java.awt.Rectangle	getNodeBounds(java.lang.Object node, java.awt.Point loc) Returns the bounding box for the node using this renderer.
void	highlightNode(java.awt.Graphics g, java.lang.Object node, java.awt.Point loc) Highlights the node in the graphics context provided.
boolean	pickNode(java.lang.Object node, java.awt.Point loc, java.awt.Point pickPoint) Checks whether the specified pickpoint is within the drawn area for the node.
void	setColor(java.awt.Color color) Sets the color for the NodeRenderer.
void	setCurTime(java.util.Date curTime) Sets the current time represented by this NodeRenderer
void	setFadeTime(long fadeTimeMillis) Sets the Fade time.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeNodeRenderer

public TimeNodeRenderer(NodeRenderer renderer)

Creates a new TimeNodeRenderer object.

Parameters:

renderer - a sub-Renderer to use for the nodes when visible

Method Detail

checkNodeTime

protected boolean checkNodeTime(java.lang.Object node,
                    java.util.Date curTime)

Return whether the node should be displayed at the given time. This method is exposed so that subclasses can implement data-specific checks for node times. The default implementation returns true if either the node is Sequential object and its time segments either contain the selected time, or if the node is not a Sequential object.

Parameters:

node - the node to check

curTime - the current time for this renderer

Returns:

true if the node should be displayed, false otherwise

determineFadeFactor

protected double determineFadeFactor(java.lang.Object node,
                         java.util.Date curTime)

Determine the fade factor of the node. This method returns a value between 0.0 (invisible) and 1.0 (fully visible) to determine how the node should be rendered. The default implementation calculates the fade factor of a Sequential node based upon the fade time and the time between the current time and any active time spans. If the current time is within one of the time spans of the sequential node, the default implementation returns 1.0. For nodes which are not sequential, the default implementation returns 0.0.

Parameters:

node - the node to check

curTime - the current time for this renderer

Returns:

a value indicating how visible the node should be, from 0 (invisible) to 1 (fully visible)

drawNode

public void drawNode(java.awt.Graphics g,
            java.lang.Object node,
            java.awt.Point loc)

Draws the node in the graphics context provided. This method will check for any Sequential nodes. For any of these nodes, their visibility depends on whether they are active at the Current Time of this renderer. If not, but they fall close to being active - within the fadeTime - the node is faded in using transparency.

Specified by:

drawNode in interface NodeRenderer

Parameters:

g - the Graphics context to display the node

node - the node to display

loc - The node location

getColor

public java.awt.Color getColor()

Gets the color for the Renderer, if any

Specified by:

getColor in interface NodeRenderer

Returns:

the color used by the NodeRenderer

getCurTime

public java.util.Date getCurTime()

Gets the current time as displayed by this NodeRenderer

Specified by:

getCurTime in interface Temporal

Returns:

the current time

getFadeTime

public long getFadeTime()

Returns the fade time

Returns:

the fade time, in milliseconds

getNodeBounds

public java.awt.Rectangle getNodeBounds(java.lang.Object node,
                               java.awt.Point loc)

Returns the bounding box for the node using this renderer. Individual renderers should ensure that the drawn node is created entirely within the bounds returned. If the node has no position defined, Null is returned.

Specified by:

getNodeBounds in interface NodeRenderer

Parameters:

node - the node to be checked

loc - The node location

Returns:

the bounding box for the node

highlightNode

public void highlightNode(java.awt.Graphics g,
                 java.lang.Object node,
                 java.awt.Point loc)

Highlights the node in the graphics context provided. This method simply uses the subrender's highlight method

Specified by:

highlightNode in interface NodeRenderer

Parameters:

g - the Graphics context to display the node

node - the node to display

loc - The node location

pickNode

public boolean pickNode(java.lang.Object node,
               java.awt.Point loc,
               java.awt.Point pickPoint)

Checks whether the specified pickpoint is within the drawn area for the node.

Specified by:

pickNode in interface NodeRenderer

Parameters:

node - the node to check for picking

loc - The node location

pickPoint - the coordinate of the point to check

Returns:

whether the point is in the drawn area for this node

setColor

public void setColor(java.awt.Color color)

Sets the color for the NodeRenderer. If this color is set, it will override any Node color.

Specified by:

setColor in interface NodeRenderer

Parameters:

color - The color for the NodeRenderer

setCurTime

public void setCurTime(java.util.Date curTime)

Sets the current time represented by this NodeRenderer

Specified by:

setCurTime in interface Temporal

Parameters:

curTime - the current time

setFadeTime

public void setFadeTime(long fadeTimeMillis)

Sets the Fade time. This is the time that it takes for a node to fade in or out of view, relative to its active times.

Parameters:

fadeTimeMillis - The fade time, in milliseconds