com.imsl.chart3d
Class Axis3D

java.lang.Object
  com.imsl.chart.AbstractChartNode
      com.imsl.chart3d.ChartNode3D
          com.imsl.chart3d.Axis3D

All Implemented Interfaces:

Serializable, Cloneable

public class Axis3D
extends ChartNode3D
implements Serializable

An x-axis, y-axis or a z-axis.

Axis3D is created by AxisXYZ as its child. It can be retrieved using the method AxisXYZ.getAxisX() or AxisXYZ.getAxisY() or AxisXYZ.getAxisZ().

It in turn creates the following child nodes: AxisLine, AxisLabel, AxisTitle and MajorTick.

The number of tick marks ("Number" attribute) is set to 4, but autoscaling can change this value.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.imsl.chart3d.ChartNode3D

AXIS_TITLE_AT_END, AXIS_TITLE_PARALLEL, DATA_TYPE_LINE, DATA_TYPE_MARKER, DATA_TYPE_PICTURE, DATA_TYPE_TUBE, MARKER_TYPE_CUBE, MARKER_TYPE_CUSTOM, MARKER_TYPE_PLUS, MARKER_TYPE_SIMPLE_CUBE, MARKER_TYPE_SIMPLE_PLUS, MARKER_TYPE_SIMPLE_TETRAHEDRON, MARKER_TYPE_SPHERE, MARKER_TYPE_TETRAHEDRON

Fields inherited from class com.imsl.chart.AbstractChartNode

AUTOSCALE_DATA, AUTOSCALE_DENSITY, AUTOSCALE_NUMBER, AUTOSCALE_OFF, AUTOSCALE_WINDOW, AXIS_X, AXIS_Y, AXIS_Z, LABEL_TYPE_NONE, LABEL_TYPE_TITLE, LABEL_TYPE_X, LABEL_TYPE_Y, LABEL_TYPE_Z, TRANSFORM_CUSTOM, TRANSFORM_LINEAR, TRANSFORM_LOG

Method Summary

protected void	addToSceneGraph(Group parent) Called to add this object to the scene graph.
AxisLabel	getAxisLabel() Returns the label node associated with this axis.
AxisLine	getAxisLine() Returns the axis line node associated with this axis.
AxisTitle	getAxisTitle() Returns the title node associated with this axis.
double	getFirstTick() Convenience routine to get the "FirstTick" attribute.
MajorTick	getMajorTick() Returns the major tick node associated with this axis.
double	getTickInterval() Retrieves the tick interval.
double[]	getTicks() Returns the value of the "Ticks" attribute, if set.
int	getType() Returns the axis type.
double[]	getWindow() Returns the window for an Axis1D.
void	setFirstTick(double firstTick) Convenience routine to set the "FirstTick" attribute.
void	setTickInterval(double tickInterval) Sets the tick interval.
void	setTicks(double[] ticks) Sets the value of the "Ticks" attribute.
void	setWindow(double[] window) Sets the window for an Axis1D.
void	setWindow(double min, double max) Sets the window for an Axis1D.

Methods inherited from class com.imsl.chart3d.ChartNode3D

getAxisTitlePosition, getBoundingSphere, getChildren, getColorFunction, getConcatenatedViewport, getDataType, getLightingEnabled, getMarkerPulsingCycle, getMarkerPulsingCycleOffset, getMarkerPulsingMaximumScale, getMarkerPulsingMinimumScale, getMarkerRotatingAxis, getMarkerRotatingCycle, getMarkerRotatingCycleOffset, getMarkerType, getMaterial, getParent, getTitle, getViewport, getVirtualUniverse, getZ, setAxisTitlePosition, setBoundingSphere, setColorFunction, setDataType, setLightingEnabled, setMarkerPulsingCycle, setMarkerPulsingCycleOffset, setMarkerPulsingMaximumScale, setMarkerPulsingMinimumScale, setMarkerRotatingAxis, setMarkerRotatingCycle, setMarkerRotatingCycleOffset, setMarkerType, setMaterial, setTitle, setViewport, setViewport, setZ

Methods inherited from class com.imsl.chart.AbstractChartNode

clone, clone, clone, clone, getAbstractParent, getAttribute, getAutoscaleInput, getAutoscaleMinimumTimeInterval, getAutoscaleOutput, getBooleanAttribute, getChildList, getColorAttribute, getCustomTransform, getDensity, getDoubleAttribute, getFillColor, getFont, getFontName, getFontSize, getFontStyle, getImage, getIntegerAttribute, getLabelType, getLightColor, getLineColor, getLineWidth, getLocale, getMarkerColor, getMarkerSize, getName, getNumber, getPaint, getStringAttribute, getTextColor, getTextFormat, getTickLength, getTransform, getX, getY, isAncestorOf, isAttributeSet, isAttributeSetAtThisNode, isBitSet, parseColor, remove, setAttribute, setAutoscaleInput, setAutoscaleMinimumTimeInterval, setAutoscaleOutput, setCustomTransform, setDensity, setFillColor, setFillColor, setFont, setFontName, setFontSize, setFontStyle, setImage, setLabelType, setLightColor, setLightColor, setLineColor, setLineColor, setLineWidth, setLocale, setMarkerColor, setMarkerColor, setMarkerSize, setName, setNumber, setPaint, setTextColor, setTextColor, setTextFormat, setTextFormat, setTickLength, setTransform, setX, setY, toString

Methods inherited from class java.lang.Object

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

Method Detail

addToSceneGraph

protected void addToSceneGraph(Group parent)

Description copied from class: ChartNode3D

Called to add this object to the scene graph.

Specified by:

addToSceneGraph in class ChartNode3D

Parameters:

parent - is the node in the scene graph at which this object is to be added.

getAxisLabel

public AxisLabel getAxisLabel()

Returns the label node associated with this axis.

Returns:

the AxisLabel node created as a child by this node

getAxisLine

public AxisLine getAxisLine()

Returns the axis line node associated with this axis.

Returns:

the AxisLine node created as a child by this node

getAxisTitle

public AxisTitle getAxisTitle()

Returns the title node associated with this axis.

Returns:

the AxisTitle node created as a child by this node

getFirstTick

public double getFirstTick()

Convenience routine to get the "FirstTick" attribute.

Returns:

the double value of the "FirstTick" attribute, if defined. Otherwise, window[0] is returned.

getMajorTick

public MajorTick getMajorTick()

Returns the major tick node associated with this axis.

Returns:

the MajorTick node created as a child by this node

getTickInterval

public double getTickInterval()

Retrieves the tick interval.

Returns:

a double which specifies the tick interval

getTicks

public double[] getTicks()

Returns the value of the "Ticks" attribute, if set. If not set, then computed tick values are returned.

Returns:

the double value of the "Ticks" attribute, if defined. Otherwise, the computed tick values are returned.

getType

public int getType()

Returns the axis type.

Returns:

an int which specifies the node type; can be AXIS_X, AXIS_Y, or AXIS_Z

See Also:

AbstractChartNode.AXIS_X, AbstractChartNode.AXIS_Y, AbstractChartNode.AXIS_Z

getWindow

public double[] getWindow()

Returns the window for an Axis1D.

Returns:

an array of length two containing the range of this axis.

setFirstTick

public void setFirstTick(double firstTick)

Convenience routine to set the "FirstTick" attribute.

Parameters:

firstTick - a double, the location of the first tick

setTickInterval

public void setTickInterval(double tickInterval)

Sets the tick interval.

Parameters:

tickInterval - a double which specifies a tick interval

setTicks

public void setTicks(double[] ticks)

Sets the value of the "Ticks" attribute. The attribute Number is set to the length of the array.

Parameters:

ticks - an array of doubles which contain the location, in user coordinates, of the major tick marks. If set, this attribute overrides the automatic computation of the tick values.

setWindow

public void setWindow(double[] window)

Sets the window for an Axis1D.

Parameters:

window - is an array of length two containing the range of this axis.

setWindow

public void setWindow(double min,
                      double max)

Sets the window for an Axis1D.

Parameters:

min - is the value of the left/bottom end of the axis.

max - is the value of the right/top end of the axis.