prajna.viz.render

Class CubeNodeRenderer

java.lang.Object

prajna.viz.render.CubeNodeRenderer

All Implemented Interfaces:

java.awt.image.ImageObserver, Animatable, NodeRenderer

public class CubeNodeRenderer
extends java.lang.Object
implements Animatable, java.awt.image.ImageObserver, NodeRenderer

Implementation of a NodeRenderer which represents individual nodes by 3D boxes. The boxes can animate when changing positions, and rotate around the Y axis. The box shape is determined by the aspect ratio; the node's size is used for half the box width (not including the 3D shadow effect). This renderer also includes an optional background image to use for the node face.

Author:

Edward Swing

Nested Class Summary

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

Animatable.Animation

Field Summary

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
CubeNodeRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	drawAnimationStep(java.awt.Graphics g, java.lang.Object node, java.awt.Point loc) Draws the intermediate animation step.
protected void	drawBox(java.awt.Graphics g, int x, int y, int width, int height, java.awt.Color color) Draws the box with side and top.
void	drawNode(java.awt.Graphics g, java.lang.Object node, java.awt.Point loc) Draws the node into the Graphics Context.
protected void	drawNodeText(java.awt.Graphics g, java.lang.Object node, int startX, int startY, int width, int height) draws the text associated with the node on the box.
protected void	drawRotateStep(java.awt.Graphics g, java.lang.Object node, java.awt.Point location) Draws an intermediate rotation step in an animation.
protected java.lang.String	fitString(java.lang.String inString, int maxwidth, java.awt.FontMetrics metrics) Attempt to fit a string on the front face of the cube.
Animatable.Animation	getAnimationFlag() returns the animation type flag
double	getAnimationStep() returns the fractional step along the animation
double	getAspect() Gets the aspect ratio used for the boxes when drawn.
java.awt.Color	getColor() Gets the color for the Renderer, if any
int	getCurrentFace() Gets the index of the current face.
java.awt.Font	getFont() Gets the font used by the NodeRenderer.
protected java.awt.Image	getImage(int face) Get the image associated with the specified face.
java.awt.Rectangle	getNodeBounds(java.lang.Object node, java.awt.Point loc) Returns the bounding box for the node using this renderer.
protected java.awt.Color	getNodeColor(java.lang.Object node) Get the color used for the node.
protected int	getNodeSize(java.lang.Object node) Get the size used for the cube node.
java.awt.Color	getSelectColor() Gets the selection color.
double	getShadowFactor() Returns the shadow factor.
java.awt.Color	getTextColor() Get the text color for the node being rendered.
void	highlightNode(java.awt.Graphics g, java.lang.Object node, java.awt.Point loc) Draws the node into the Graphics Context in a highlighted fashion.
boolean	imageUpdate(java.awt.Image img, int infoflags, int x, int y, int width, int height) This method is called when information about an image which was previously requested using an asynchronous interface becomes available.
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	setAnimationFlag(Animatable.Animation flag) sets a flag indicating the type of transformation.
void	setAnimationStep(double frac) sets the fractional step along the animation.
void	setAspect(double aspectRatio) Sets the aspect ratio used for the boxes when drawn.
void	setBackgroundImage(java.awt.Image image) Sets the background image that is rendered on the boxes.
void	setColor(java.awt.Color color) Set the surface color to be used for rendering nodes.
void	setCurrentFace(int newFace) Sets the index of the current face.
void	setFont(java.awt.Font newFont) Sets the font used by the NodeRenderer.
void	setSelectColor(java.awt.Color newColor) Sets the selection color.
void	setShadowFactor(double shadowFactor) Sets the amount the shadow (the side face) extends beyond the side of the node.
void	setTextColor(java.awt.Color color) Set the text color for the node being rendered.

Methods inherited from class java.lang.Object

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

Constructor Detail

CubeNodeRenderer

public CubeNodeRenderer()

Method Detail

drawAnimationStep

protected void drawAnimationStep(java.awt.Graphics g,
                     java.lang.Object node,
                     java.awt.Point loc)

Draws the intermediate animation step. When the node is in an intermediate step, not all features need to be drawn. In this case, only the box is displayed.

Parameters:

g - the Graphics context to display the node

node - the node to display

drawBox

protected void drawBox(java.awt.Graphics g,
           int x,
           int y,
           int width,
           int height,
           java.awt.Color color)

Draws the box with side and top.

Parameters:

g - the Graphics context to display the node

x - the upper left X coordinate of the box front face

y - the upper left Y coordinate of the box front face

width - the width of the box

height - the height of the box

color - the base color to use for the box's front face.

drawNode

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

Draws the node into the Graphics Context. This renderer will draw the node as a 3D box, with width equal to twice the node size. The 3D effect is determined by the renderer color or the node color. This method calls drawBox, drawNodeImage and drawNodeText, in that order.

Specified by:

drawNode in interface NodeRenderer

Parameters:

g - the Graphics context to display the node

node - the node to display

loc - The node location

drawNodeText

protected void drawNodeText(java.awt.Graphics g,
                java.lang.Object node,
                int startX,
                int startY,
                int width,
                int height)

draws the text associated with the node on the box. The default implementation simply invokes toString() on the node.

Parameters:

g - the Graphics context to display the node

node - the node to display the image on

startX - the x start point to draw the text

startY - the y start point to draw the text

width - the maximum width to draw the image

height - the maximum height to draw the image

drawRotateStep

protected void drawRotateStep(java.awt.Graphics g,
                  java.lang.Object node,
                  java.awt.Point location)

Draws an intermediate rotation step in an animation. Done by calculating where the box edge should appear.

Parameters:

g - the Graphics context to display the node

node - the node to display the image on

location - the node's location, interpolated if in the middle of a translation

fitString

protected java.lang.String fitString(java.lang.String inString,
                         int maxwidth,
                         java.awt.FontMetrics metrics)

Attempt to fit a string on the front face of the cube.

Parameters:

inString - the string to display on the cube

maxwidth - The maximum width allowed for the text.

metrics - FontMetrics corresponding to the font used for text on the cube face

Returns:

the string to display on the cube face

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

getAspect

public double getAspect()

Gets the aspect ratio used for the boxes when drawn.

Returns:

the current aspect ratio

getColor

public java.awt.Color getColor()

Gets the color for the Renderer, if any

Specified by:

getColor in interface NodeRenderer

Returns:

the color for this renderer

getCurrentFace

public int getCurrentFace()

Gets the index of the current face.

Returns:

the index of the current face.

getFont

public java.awt.Font getFont()

Gets the font used by the NodeRenderer.

Returns:

the current font

getImage

protected java.awt.Image getImage(int face)

Get the image associated with the specified face. The default implementation simply returns the background image for all faces. This method can be overridden to provide the ability for subclasses to display images on each face.

Parameters:

face - which face the image is requested for

Returns:

the image for the face

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 check

loc - The node location

Returns:

the bounding box for the node

getNodeColor

protected java.awt.Color getNodeColor(java.lang.Object node)

Get the color used for the node. Defaults to returning the node color set for the renderer in general. Subclasses can override this behavior, providing colors for nodes based upon attributes.

Parameters:

node - the node to query for the color

Returns:

the color of the node

getNodeSize

protected int getNodeSize(java.lang.Object node)

Get the size used for the cube node. Defaults to returning 25, but this can be overridden by a subclass

Parameters:

node - the node to query for the size

Returns:

25

getSelectColor

public java.awt.Color getSelectColor()

Gets the selection color. The selection Color is used to draw a box-highlight around a selected node

Returns:

the selection color

getShadowFactor

public double getShadowFactor()

Returns the shadow factor.

Returns:

the Shadow factor

getTextColor

public java.awt.Color getTextColor()

Get the text color for the node being rendered.

Returns:

Text color for node being renderer.

highlightNode

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

Draws the node into the Graphics Context in a highlighted fashion.

Specified by:

highlightNode in interface NodeRenderer

Parameters:

g - the Graphics context to display the node

node - the node to display

loc - The node location

imageUpdate

public boolean imageUpdate(java.awt.Image img,
                  int infoflags,
                  int x,
                  int y,
                  int width,
                  int height)

This method is called when information about an image which was previously requested using an asynchronous interface becomes available.

Specified by:

imageUpdate in interface java.awt.image.ImageObserver

Parameters:

img - the image being observed.

infoflags - the bitwise inclusive OR of the following flags: WIDTH, HEIGHT, PROPERTIES, SOMEBITS, FRAMEBITS, ALLBITS, ERROR, ABORT.

x - the x coordinate.

y - the y coordinate.

width - the width.

height - the height.

Returns:

false if the infoflags indicate that the image is completely loaded; true otherwise.

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

setAnimationFlag

public void setAnimationFlag(Animatable.Animation flag)

sets a flag indicating the type of transformation. 0=no animation, any other value indicates translation (moving).

Specified by:

setAnimationFlag in interface Animatable

Parameters:

flag - indicates the type of transformation

setAnimationStep

public void setAnimationStep(double frac)

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:

frac - the fractional step along the animation

setAspect

public void setAspect(double aspectRatio)

Sets the aspect ratio used for the boxes when drawn. The aspect ratio is defined to be the height/width; the node is always drawn with the width equal to twice the node size. Therefore, an aspect ratio > 1.0 will result in tall nodes. The default is 0.75.

Parameters:

aspectRatio - the new aspect ratio

setBackgroundImage

public void setBackgroundImage(java.awt.Image image)

Sets the background image that is rendered on the boxes. If there is a background image specified, then the node color will be obscured except for the top and sides of the box.

Parameters:

image - the new background image

setColor

public void setColor(java.awt.Color color)

Set the surface color to be used for rendering nodes. Calculates the colors to use for top and side of the box based on base color

Specified by:

setColor in interface NodeRenderer

Parameters:

color - Surface background color.

setCurrentFace

public void setCurrentFace(int newFace)

Sets the index of the current face. The faces are numbered so that initially face 0 is in front, face 1 is on the right, face 2 is the back, and face 3 is on the left.

Parameters:

newFace - the new current face.

setFont

public void setFont(java.awt.Font newFont)

Sets the font used by the NodeRenderer.

Parameters:

newFont - the new font

setSelectColor

public void setSelectColor(java.awt.Color newColor)

Sets the selection color. The selection Color is used to draw a box-highlight around a selected node

Parameters:

newColor - the selection color

setShadowFactor

public void setShadowFactor(double shadowFactor)

Sets the amount the shadow (the side face) extends beyond the side of the node. A value of 0 means there is no shadow; a value of 1 means that the shadow is the same size as the front face. The default value is 0.1.

Parameters:

shadowFactor - the new Shadow factor

setTextColor

public void setTextColor(java.awt.Color color)

Set the text color for the node being rendered.

Parameters:

color - Text color for node being renderer.