de.erichseifert.gral.plots.axes

Class AbstractAxisRenderer2D

java.lang.Object

de.erichseifert.gral.plots.axes.AbstractAxisRenderer2D

All Implemented Interfaces:

AxisRenderer, java.io.Serializable

Direct Known Subclasses:

LinearRenderer2D, LogarithmicRenderer2D

public abstract class AbstractAxisRenderer2D
extends java.lang.Object
implements AxisRenderer, java.io.Serializable

Abstract class that provides function for rendering axes in two-dimensional space.

Functionality includes:

• Calculating tick positions of an axis
• Calculating tick normals
• Administration of settings

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractAxisRenderer2D() Initializes a new instance with default settings.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.Double,java.lang.String>	getCustomTicks() Returns custom ticks with their respective position and label.
java.lang.Number	getIntersection() Returns the intersection point of the axis.
Label	getLabel() Returns the label of the axis.
double	getLabelDistance() Returns the distance from the axis to the label.
double	getMinorTickAlignment() Returns the alignment of minor ticks.
java.awt.Paint	getMinorTickColor() Returns the paint used to draw the shapes of minor ticks.
double	getMinorTickLength() Returns the length of minor tick strokes.
int	getMinorTicksCount() Returns the count of minor ticks.
java.awt.Stroke	getMinorTickStroke() Returns the stroke used to draw all minor ticks.
PointND<java.lang.Double>	getNormal(Axis axis, java.lang.Number value, boolean extrapolate, boolean forceLinear) Returns the normal vector at the position of the specified value.
PointND<java.lang.Double>	getPosition(Axis axis, java.lang.Number value, boolean extrapolate, boolean forceLinear) Returns the position of the specified value on the axis.
Drawable	getRendererComponent(Axis axis) Returns a component that displays the specified axis.
java.awt.Shape	getShape() Returns the shape of the axis.
java.awt.Paint	getShapeColor() Returns the paint used to draw the axis, its ticks and its labels.
java.awt.Stroke	getShapeStroke() Returns the stroke which defines the shape of the axis.
double	getTickAlignment() Returns the alignment of major ticks relative to the axis.
java.awt.Paint	getTickColor() Returns the paint used to draw the shapes of major ticks.
java.awt.Font	getTickFont() Returns the font used to display the text of major ticks.
double	getTickLabelDistance() Returns the distance of labels to their ticks.
java.text.Format	getTickLabelFormat() Returns the format which converts the tick values to labels.
double	getTickLabelRotation() Returns the rotation of the tick labels.
double	getTickLength() Returns the length of major tick strokes.
java.util.List<Tick>	getTicks(Axis axis) Returns a list of all tick element on the axis.
java.lang.Number	getTickSpacing() Returns the interval for major ticks.
java.awt.Stroke	getTickStroke() Returns the stroke which is used to draw all major ticks.
boolean	isMinorTicksVisible() Returns whether minor ticks are drawn.
boolean	isShapeDirectionSwapped() Returns whether the axis direction is changed.
boolean	isShapeNormalOrientationClockwise() Returns whether the normal vector of the shape is calculated using clockwise or counterclockwise rotation.
boolean	isShapeVisible() Returns whether the shape of the axis will be drawn.
boolean	isTickLabelsOutside() Returns whether the tick labels are drawn outside of the plot.
boolean	isTickLabelsVisible() Returns whether tick labels will be shown.
boolean	isTicksAutoSpaced() Returns whether the interval for major and minor ticks is chosen automatically.
boolean	isTicksVisible() Returns whether major ticks are drawn.
void	setCustomTicks(java.util.Map<java.lang.Double,java.lang.String> positionsAndLabels) Sets custom ticks with their respective position and label.
void	setIntersection(java.lang.Number intersection) Sets the intersection point of the axis.
void	setLabel(Label label) Sets the label of the axis.
void	setLabelDistance(double distance) Sets the distance from the axis to the label.
void	setMinorTickAlignment(double alignment) Sets the alignment of minor ticks.
void	setMinorTickColor(java.awt.Paint color) Sets the paint used to draw the shapes of minor ticks.
void	setMinorTickLength(double length) Sets the length of minor tick strokes.
void	setMinorTicksCount(int count) Sets the count of minor ticks.
void	setMinorTickStroke(java.awt.Stroke stroke) Sets the stroke used to draw all minor ticks.
void	setMinorTicksVisible(boolean minorTicksVisible) Sets whether minor ticks are drawn.
void	setShape(java.awt.Shape shape) Sets the shape of the axis.
void	setShapeColor(java.awt.Paint color) Sets the paint used to draw the axis, its ticks and its labels.
void	setShapeDirectionSwapped(boolean directionSwapped) Sets whether the axis direction will be changed.
void	setShapeNormalOrientationClockwise(boolean clockwise) Sets whether the normal vector of the shape is calculated using clockwise or counterclockwise rotation.
void	setShapeStroke(java.awt.Stroke stroke) Sets the stroke which defines the shape of the axis.
void	setShapeVisible(boolean shapeVisible) Sets whether the shape of the axis will be drawn.
void	setTickAlignment(double alignment) Sets the alignment of major ticks relative to the axis.
void	setTickColor(java.awt.Paint color) Sets the paint used to draw the shapes of major ticks.
void	setTickFont(java.awt.Font font) Sets the font used to display the text of major ticks.
void	setTickLabelDistance(double distance) Sets the distance of labels to their ticks.
void	setTickLabelFormat(java.text.Format format) Sets the format which converts the tick values to labels.
void	setTickLabelRotation(double angle) Sets the rotation of the tick labels.
void	setTickLabelsOutside(boolean labelsOutside) Sets whether the tick labels are drawn outside of the plot.
void	setTickLabelsVisible(boolean tickLabelsVisible) Sets whether tick labels will be shown.
void	setTickLength(double length) Sets the length of major tick strokes.
void	setTicksAutoSpaced(boolean autoSpaced) Sets whether the interval for major and minor ticks is chosen automatically.
void	setTickSpacing(java.lang.Number spacing) Sets the interval for major ticks.
void	setTickStroke(java.awt.Stroke stroke) Sets the stroke which is used to draw all major ticks.
void	setTicksVisible(boolean ticksVisible) Sets whether major ticks will be drawn.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.erichseifert.gral.plots.axes.AxisRenderer

viewToWorld, worldToView

Constructor Detail

AbstractAxisRenderer2D

public AbstractAxisRenderer2D()

Initializes a new instance with default settings.

Method Detail

getRendererComponent

public Drawable getRendererComponent(Axis axis)

Returns a component that displays the specified axis.

Specified by:

getRendererComponent in interface AxisRenderer

Parameters:

axis - axis to be displayed

Returns:

component displaying the axis

See Also:

Axis

getTicks

public java.util.List<Tick> getTicks(Axis axis)

Returns a list of all tick element on the axis.

Specified by:

getTicks in interface AxisRenderer

Parameters:

axis - Axis

Returns:

A list of Tick instances

getNormal

public PointND<java.lang.Double> getNormal(Axis axis,
                                           java.lang.Number value,
                                           boolean extrapolate,
                                           boolean forceLinear)

Returns the normal vector at the position of the specified value. The vector is normalized.

Specified by:

getNormal in interface AxisRenderer

Parameters:

axis - Axis

value - World coordinate value to convert

extrapolate - Option to activate extrapolation value that are not on the axis

forceLinear - Force linear interpolation.

Returns:

N-dimensional normal vector at the position

getPosition

public PointND<java.lang.Double> getPosition(Axis axis,
                                             java.lang.Number value,
                                             boolean extrapolate,
                                             boolean forceLinear)

Returns the position of the specified value on the axis. The value is returned in view coordinates.

Specified by:

getPosition in interface AxisRenderer

Parameters:

axis - Axis

value - World coordinate value to convert

extrapolate - Option to activate extrapolation value that are not on the axis

forceLinear - Force linear interpolation.

Returns:

N-dimensional point of the value

getIntersection

public java.lang.Number getIntersection()

Description copied from interface: AxisRenderer

Returns the intersection point of the axis.

Specified by:

getIntersection in interface AxisRenderer

Returns:

Point at which this axis intersects other axes.

setIntersection

public void setIntersection(java.lang.Number intersection)

Description copied from interface: AxisRenderer

Sets the intersection point of the axis.

Specified by:

setIntersection in interface AxisRenderer

Parameters:

intersection - Point at which this axis intersects other axes.

getShape

public java.awt.Shape getShape()

Description copied from interface: AxisRenderer

Returns the shape of the axis.

Specified by:

getShape in interface AxisRenderer

Returns:

Shape used for drawing.

setShape

public void setShape(java.awt.Shape shape)

Description copied from interface: AxisRenderer

Sets the shape of the axis.

Specified by:

setShape in interface AxisRenderer

Parameters:

shape - Shape used for drawing.

isShapeVisible

public boolean isShapeVisible()

Description copied from interface: AxisRenderer

Returns whether the shape of the axis will be drawn. This doesn't influence ticks or labels.

Specified by:

isShapeVisible in interface AxisRenderer

Returns:

true if the shape should be drawn, false otherwise.

setShapeVisible

public void setShapeVisible(boolean shapeVisible)

Description copied from interface: AxisRenderer

Sets whether the shape of the axis will be drawn. This doesn't influence ticks or labels.

Specified by:

setShapeVisible in interface AxisRenderer

Parameters:

shapeVisible - true if the shape should be drawn, false otherwise.

isShapeNormalOrientationClockwise

public boolean isShapeNormalOrientationClockwise()

Description copied from interface: AxisRenderer

Returns whether the normal vector of the shape is calculated using clockwise or counterclockwise rotation.

Specified by:

isShapeNormalOrientationClockwise in interface AxisRenderer

Returns:

true if the orientation is clockwise, false if it is counterclockwise.

setShapeNormalOrientationClockwise

public void setShapeNormalOrientationClockwise(boolean clockwise)

Description copied from interface: AxisRenderer

Sets whether the normal vector of the shape is calculated using clockwise or counterclockwise rotation.

Specified by:

setShapeNormalOrientationClockwise in interface AxisRenderer

Parameters:

clockwise - true if the orientation is clockwise, false if it is counterclockwise.

getShapeColor

public java.awt.Paint getShapeColor()

Description copied from interface: AxisRenderer

Returns the paint used to draw the axis, its ticks and its labels.

Specified by:

getShapeColor in interface AxisRenderer

Returns:

Paint used for drawing.

setShapeColor

public void setShapeColor(java.awt.Paint color)

Description copied from interface: AxisRenderer

Sets the paint used to draw the axis, its ticks and its labels.

Specified by:

setShapeColor in interface AxisRenderer

Parameters:

color - Paint used for drawing.

getShapeStroke

public java.awt.Stroke getShapeStroke()

Description copied from interface: AxisRenderer

Returns the stroke which defines the shape of the axis.

Specified by:

getShapeStroke in interface AxisRenderer

Returns:

Stroke used for drawing the shape.

setShapeStroke

public void setShapeStroke(java.awt.Stroke stroke)

Description copied from interface: AxisRenderer

Sets the stroke which defines the shape of the axis.

Specified by:

setShapeStroke in interface AxisRenderer

Parameters:

stroke - Stroke used for drawing the shape.

isShapeDirectionSwapped

public boolean isShapeDirectionSwapped()

Description copied from interface: AxisRenderer

Returns whether the axis direction is changed.

Specified by:

isShapeDirectionSwapped in interface AxisRenderer

Returns:

true if the shape of the axis is inverted, false otherwise.

setShapeDirectionSwapped

public void setShapeDirectionSwapped(boolean directionSwapped)

Description copied from interface: AxisRenderer

Sets whether the axis direction will be changed.

Specified by:

setShapeDirectionSwapped in interface AxisRenderer

Parameters:

directionSwapped - true if the shape of the axis should be inverted, false otherwise.

isTicksVisible

public boolean isTicksVisible()

Description copied from interface: AxisRenderer

Returns whether major ticks are drawn.

Specified by:

isTicksVisible in interface AxisRenderer

Returns:

true if major ticks are drawn, false otherwise.

setTicksVisible

public void setTicksVisible(boolean ticksVisible)

Description copied from interface: AxisRenderer

Sets whether major ticks will be drawn.

Specified by:

setTicksVisible in interface AxisRenderer

Parameters:

ticksVisible - true if major ticks should be drawn, false otherwise.

getTickSpacing

public java.lang.Number getTickSpacing()

Description copied from interface: AxisRenderer

Returns the interval for major ticks.

Specified by:

getTickSpacing in interface AxisRenderer

Returns:

Distance on axis in which major ticks are drawn.

setTickSpacing

public void setTickSpacing(java.lang.Number spacing)

Description copied from interface: AxisRenderer

Sets the interval for major ticks.

Specified by:

setTickSpacing in interface AxisRenderer

Parameters:

spacing - Distance on axis in which major ticks are drawn.

isTicksAutoSpaced

public boolean isTicksAutoSpaced()

Description copied from interface: AxisRenderer

Returns whether the interval for major and minor ticks is chosen automatically.

Specified by:

isTicksAutoSpaced in interface AxisRenderer

Returns:

true if auto-spacing is enabled, false otherwise.

setTicksAutoSpaced

public void setTicksAutoSpaced(boolean autoSpaced)

Description copied from interface: AxisRenderer

Sets whether the interval for major and minor ticks is chosen automatically.

Specified by:

setTicksAutoSpaced in interface AxisRenderer

Parameters:

autoSpaced - true if auto-spacing is enabled, false otherwise.

getTickLength

public double getTickLength()

Description copied from interface: AxisRenderer

Returns the length of major tick strokes.

Specified by:

getTickLength in interface AxisRenderer

Returns:

Tick length relative to the font height.

setTickLength

public void setTickLength(double length)

Description copied from interface: AxisRenderer

Sets the length of major tick strokes.

Specified by:

setTickLength in interface AxisRenderer

Parameters:

length - Tick length relative to the font height.

getTickStroke

public java.awt.Stroke getTickStroke()

Description copied from interface: AxisRenderer

Returns the stroke which is used to draw all major ticks.

Specified by:

getTickStroke in interface AxisRenderer

Returns:

Stroke used for major tick drawing.

setTickStroke

public void setTickStroke(java.awt.Stroke stroke)

Description copied from interface: AxisRenderer

Sets the stroke which is used to draw all major ticks.

Specified by:

setTickStroke in interface AxisRenderer

Parameters:

stroke - Stroke used for major tick drawing.

getTickAlignment

public double getTickAlignment()

Description copied from interface: AxisRenderer

Returns the alignment of major ticks relative to the axis. 0.0 means outside the plotting area, 0.5 means centered on the axis, 1.0 means inside the plotting area.

Specified by:

getTickAlignment in interface AxisRenderer

Returns:

Major tick alignment relative to the axis.

setTickAlignment

public void setTickAlignment(double alignment)

Description copied from interface: AxisRenderer

Sets the alignment of major ticks relative to the axis. 0.0 means outside the plotting area, 0.5 means centered on the axis, 1.0 means inside the plotting area.

Specified by:

setTickAlignment in interface AxisRenderer

Parameters:

alignment - Major tick alignment relative to the axis.

getTickFont

public java.awt.Font getTickFont()

Description copied from interface: AxisRenderer

Returns the font used to display the text of major ticks.

Specified by:

getTickFont in interface AxisRenderer

Returns:

Font used for tick labels.

setTickFont

public void setTickFont(java.awt.Font font)

Description copied from interface: AxisRenderer

Sets the font used to display the text of major ticks.

Specified by:

setTickFont in interface AxisRenderer

Parameters:

font - Font used for tick labels.

getTickColor

public java.awt.Paint getTickColor()

Description copied from interface: AxisRenderer

Returns the paint used to draw the shapes of major ticks.

Specified by:

getTickColor in interface AxisRenderer

Returns:

Paint used for major tick drawing.

setTickColor

public void setTickColor(java.awt.Paint color)

Description copied from interface: AxisRenderer

Sets the paint used to draw the shapes of major ticks.

Specified by:

setTickColor in interface AxisRenderer

Parameters:

color - Paint used for major tick drawing.

isTickLabelsVisible

public boolean isTickLabelsVisible()

Description copied from interface: AxisRenderer

Returns whether tick labels will be shown.

Specified by:

isTickLabelsVisible in interface AxisRenderer

Returns:

true if tick labels will be drawn, false otherwise.

setTickLabelsVisible

public void setTickLabelsVisible(boolean tickLabelsVisible)

Description copied from interface: AxisRenderer

Sets whether tick labels will be shown.

Specified by:

setTickLabelsVisible in interface AxisRenderer

Parameters:

tickLabelsVisible - true if tick labels will be drawn, false otherwise.

getTickLabelFormat

public java.text.Format getTickLabelFormat()

Description copied from interface: AxisRenderer

Returns the format which converts the tick values to labels.

Specified by:

getTickLabelFormat in interface AxisRenderer

Returns:

Format used for tick labels.

setTickLabelFormat

public void setTickLabelFormat(java.text.Format format)

Description copied from interface: AxisRenderer

Sets the format which converts the tick values to labels.

Specified by:

setTickLabelFormat in interface AxisRenderer

Parameters:

format - Format used for tick labels.

getTickLabelDistance

public double getTickLabelDistance()

Description copied from interface: AxisRenderer

Returns the distance of labels to their ticks.

Specified by:

getTickLabelDistance in interface AxisRenderer

Returns:

Label distance relative to the font height.

setTickLabelDistance

public void setTickLabelDistance(double distance)

Description copied from interface: AxisRenderer

Sets the distance of labels to their ticks.

Specified by:

setTickLabelDistance in interface AxisRenderer

Parameters:

distance - Label distance relative to the font height.

isTickLabelsOutside

public boolean isTickLabelsOutside()

Description copied from interface: AxisRenderer

Returns whether the tick labels are drawn outside of the plot.

Specified by:

isTickLabelsOutside in interface AxisRenderer

Returns:

true if the labels are drawn outside of the plot, false otherwise.

setTickLabelsOutside

public void setTickLabelsOutside(boolean labelsOutside)

Description copied from interface: AxisRenderer

Sets whether the tick labels are drawn outside of the plot.

Specified by:

setTickLabelsOutside in interface AxisRenderer

Parameters:

labelsOutside - true if the labels are drawn outside of the plot, false otherwise.

getTickLabelRotation

public double getTickLabelRotation()

Description copied from interface: AxisRenderer

Returns the rotation of the tick labels.

Specified by:

getTickLabelRotation in interface AxisRenderer

Returns:

Tick label rotation in degrees.

setTickLabelRotation

public void setTickLabelRotation(double angle)

Description copied from interface: AxisRenderer

Sets the rotation of the tick labels.

Specified by:

setTickLabelRotation in interface AxisRenderer

Parameters:

angle - Tick label rotation in degrees.

isMinorTicksVisible

public boolean isMinorTicksVisible()

Description copied from interface: AxisRenderer

Returns whether minor ticks are drawn.

Specified by:

isMinorTicksVisible in interface AxisRenderer

Returns:

true if minor ticks are drawn, false otherwise.

setMinorTicksVisible

public void setMinorTicksVisible(boolean minorTicksVisible)

Description copied from interface: AxisRenderer

Sets whether minor ticks are drawn.

Specified by:

setMinorTicksVisible in interface AxisRenderer

Parameters:

minorTicksVisible - true if minor ticks are drawn, false otherwise.

getMinorTicksCount

public int getMinorTicksCount()

Description copied from interface: AxisRenderer

Returns the count of minor ticks.

Specified by:

getMinorTicksCount in interface AxisRenderer

Returns:

Number of minor ticks between two major ticks.

setMinorTicksCount

public void setMinorTicksCount(int count)

Description copied from interface: AxisRenderer

Sets the count of minor ticks.

Specified by:

setMinorTicksCount in interface AxisRenderer

Parameters:

count - Number of minor ticks between two major ticks.

getMinorTickLength

public double getMinorTickLength()

Description copied from interface: AxisRenderer

Returns the length of minor tick strokes.

Specified by:

getMinorTickLength in interface AxisRenderer

Returns:

Tick length relative to font height.

setMinorTickLength

public void setMinorTickLength(double length)

Description copied from interface: AxisRenderer

Sets the length of minor tick strokes.

Specified by:

setMinorTickLength in interface AxisRenderer

Parameters:

length - Tick length relative to font height.

getMinorTickStroke

public java.awt.Stroke getMinorTickStroke()

Description copied from interface: AxisRenderer

Returns the stroke used to draw all minor ticks.

Specified by:

getMinorTickStroke in interface AxisRenderer

Returns:

Stroke used for minor tick drawing.

setMinorTickStroke

public void setMinorTickStroke(java.awt.Stroke stroke)

Description copied from interface: AxisRenderer

Sets the stroke used to draw all minor ticks.

Specified by:

setMinorTickStroke in interface AxisRenderer

Parameters:

stroke - Stroke used for minor tick drawing.

getMinorTickAlignment

public double getMinorTickAlignment()

Description copied from interface: AxisRenderer

Returns the alignment of minor ticks. 0.0 means outside the plotting area, 0.5 means centered on the axis, 1.0 means inside the plotting area.

Specified by:

getMinorTickAlignment in interface AxisRenderer

Returns:

Minor tick alignment relative to the axis.

setMinorTickAlignment

public void setMinorTickAlignment(double alignment)

Description copied from interface: AxisRenderer

Sets the alignment of minor ticks. 0.0 means outside the plotting area, 0.5 means centered on the axis, 1.0 means inside the plotting area.

Specified by:

setMinorTickAlignment in interface AxisRenderer

Parameters:

alignment - Minor tick alignment relative to the axis.

getMinorTickColor

public java.awt.Paint getMinorTickColor()

Description copied from interface: AxisRenderer

Returns the paint used to draw the shapes of minor ticks.

Specified by:

getMinorTickColor in interface AxisRenderer

Returns:

Paint used for minor tick drawing.

setMinorTickColor

public void setMinorTickColor(java.awt.Paint color)

Description copied from interface: AxisRenderer

Sets the paint used to draw the shapes of minor ticks.

Specified by:

setMinorTickColor in interface AxisRenderer

Parameters:

color - Paint used for minor tick drawing.

getCustomTicks

public java.util.Map<java.lang.Double,java.lang.String> getCustomTicks()

Description copied from interface: AxisRenderer

Returns custom ticks with their respective position and label.

Specified by:

getCustomTicks in interface AxisRenderer

Returns:

A map of custom tick positions and labels.

setCustomTicks

public void setCustomTicks(java.util.Map<java.lang.Double,java.lang.String> positionsAndLabels)

Description copied from interface: AxisRenderer

Sets custom ticks with their respective position and label.

Specified by:

setCustomTicks in interface AxisRenderer

Parameters:

positionsAndLabels - A map of custom tick positions and labels.

getLabel

public Label getLabel()

Description copied from interface: AxisRenderer

Returns the label of the axis.

Specified by:

getLabel in interface AxisRenderer

Returns:

Axis label.

setLabel

public void setLabel(Label label)

Description copied from interface: AxisRenderer

Sets the label of the axis.

Specified by:

setLabel in interface AxisRenderer

Parameters:

label - Axis label.

getLabelDistance

public double getLabelDistance()

Description copied from interface: AxisRenderer

Returns the distance from the axis to the label.

Specified by:

getLabelDistance in interface AxisRenderer

Returns:

Distance relative to font height.

setLabelDistance

public void setLabelDistance(double distance)

Description copied from interface: AxisRenderer

Sets the distance from the axis to the label.

Specified by:

setLabelDistance in interface AxisRenderer

Parameters:

distance - Distance relative to font height.