de.javagl.viewer.painters

Class CoordinateSystemPainter

java.lang.Object

de.javagl.viewer.painters.CoordinateSystemPainter

All Implemented Interfaces:

Painter

public final class CoordinateSystemPainter
extends java.lang.Object
implements Painter

Implementation of the Painter interface that paints a coordinate system, consisting of a grid and labeled coordinate axes.

Constructor Summary

Constructors

Constructor and Description
CoordinateSystemPainter() Creates a new default coordinate system painter

Method Summary

Modifier and Type	Method and Description
LabelPainter	getLabelPainterX() Returns the LabelPainter that is used for painting the labels along the x-axis
LabelPainter	getLabelPainterY() Returns the LabelPainter that is used for painting the labels along the y-axis
void	paint(java.awt.Graphics2D g, java.awt.geom.AffineTransform worldToScreen, double w, double h) Perform the painting operations on the given Graphics.
protected void	paintAxisY(java.awt.Graphics2D g, java.awt.geom.AffineTransform worldToScreen) Paint the y-axis.
void	setAxisColorX(java.awt.Color axisColorX) Set the color for the x-axis.
void	setAxisColorY(java.awt.Color axisColorY) Set the color for the y-axis.
void	setAxisLocationX(double worldYofX) Set the location where the x-axis should be painted
void	setAxisLocationY(double worldXofY) Set the location where the y-axis should be painted
void	setAxisRangeX(double worldMinAxisX, double worldMaxAxisX) Set the range of the x-axis that should be displayed.
void	setAxisRangeY(double worldMinAxisY, double worldMaxAxisY) Set the range of the y-axis that should be displayed.
void	setFixedWorldTickDistanceX(double fixedWorldTickDistanceX) Set the fixed distance between ticks on the x-axis, in world coordinates.
void	setFixedWorldTickDistanceY(double fixedWorldTickDistanceY) Set the fixed distance between ticks on the y-axis, in world coordinates.
void	setGridColorX(java.awt.Color gridColorX) Set the color for the grid lines that should be painted at the x-axis ticks in the background.
void	setGridColorY(java.awt.Color gridColorY) Set the color for the grid lines that should be painted at the y-axis ticks in the background.
void	setLabelFormatterX(java.util.function.DoubleFunction<java.lang.String> labelFormatterX) Set the formatter that will receive x-values for ticks, and return the string that should be painted at this coordinate.
void	setLabelFormatterY(java.util.function.DoubleFunction<java.lang.String> labelFormatterY) Set the formatter that will receive y-values for ticks, and return the string that should be painted at this coordinate.
void	setScreenAxisLayoutX(java.util.function.IntSupplier supplierScreenMinX, java.util.function.IntSupplier supplierScreenMaxX, java.util.function.IntSupplier supplierScreenY) Set the layout for the x-axis.
void	setScreenAxisLayoutY(java.util.function.IntSupplier supplierScreenMinY, java.util.function.IntSupplier supplierScreenMaxY, java.util.function.IntSupplier supplierScreenX) Set the layout for the y-axis.

Methods inherited from class java.lang.Object

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

Constructor Detail

CoordinateSystemPainter

public CoordinateSystemPainter()

Creates a new default coordinate system painter

Method Detail

getLabelPainterX

public LabelPainter getLabelPainterX()

Returns the LabelPainter that is used for painting the labels along the x-axis

Returns:

The LabelPainter

setLabelFormatterX

public void setLabelFormatterX(java.util.function.DoubleFunction<java.lang.String> labelFormatterX)

Set the formatter that will receive x-values for ticks, and return the string that should be painted at this coordinate. This formatter may be null, in which case a string representation of the x-value will be painted.

Parameters:

labelFormatterX - The formatter

getLabelPainterY

public LabelPainter getLabelPainterY()

Returns the LabelPainter that is used for painting the labels along the y-axis

Returns:

The LabelPainter

setLabelFormatterY

public void setLabelFormatterY(java.util.function.DoubleFunction<java.lang.String> labelFormatterY)

Set the formatter that will receive y-values for ticks, and return the string that should be painted at this coordinate. This formatter may be null, in which case a string representation of the y-value will be painted.

Parameters:

labelFormatterY - The formatter

setFixedWorldTickDistanceX

public void setFixedWorldTickDistanceX(double fixedWorldTickDistanceX)

Set the fixed distance between ticks on the x-axis, in world coordinates. If the given value is NaN, then the distance will be computed automatically.

Parameters:

fixedWorldTickDistanceX - The tick distance

Throws:

java.lang.IllegalArgumentException - If the given distance is not positive

setFixedWorldTickDistanceY

public void setFixedWorldTickDistanceY(double fixedWorldTickDistanceY)

Set the fixed distance between ticks on the y-axis, in world coordinates. If the given value is NaN, then the distance will be computed automatically.

Parameters:

fixedWorldTickDistanceY - The tick distance

Throws:

java.lang.IllegalArgumentException - If the given distance is not positive

setGridColorX

public void setGridColorX(java.awt.Color gridColorX)

Set the color for the grid lines that should be painted at the x-axis ticks in the background. If the given color is null, then the grid lines will not be painted.

Parameters:

gridColorX - The grid color

setGridColorY

public void setGridColorY(java.awt.Color gridColorY)

Set the color for the grid lines that should be painted at the y-axis ticks in the background. If the given color is null, then the grid lines will not be painted.

Parameters:

gridColorY - The grid color

setAxisColorX

public void setAxisColorX(java.awt.Color axisColorX)

Set the color for the x-axis. If this is null, then the x-axis will not be painted.

Parameters:

axisColorX - The color for the x-axis

setAxisRangeX

public void setAxisRangeX(double worldMinAxisX,
                          double worldMaxAxisX)

Set the range of the x-axis that should be displayed. If either of the given values is Double.NaN, then the minimum or maximum value of the currently visible world area will be used, respectively

Parameters:

worldMinAxisX - The minimum value, in world coordinates

worldMaxAxisX - The maximum value, in world coordinates

setAxisLocationX

public void setAxisLocationX(double worldYofX)

Set the location where the x-axis should be painted

Parameters:

worldYofX - The y-coordinate where the x-axis should be painted

setScreenAxisLayoutX

public void setScreenAxisLayoutX(java.util.function.IntSupplier supplierScreenMinX,
                                 java.util.function.IntSupplier supplierScreenMaxX,
                                 java.util.function.IntSupplier supplierScreenY)

Set the layout for the x-axis. The given suppliers will provide the screen coordinates that determine how the x-axis should be displayed. If any of the given suppliers is null, then the axis will be painted in world coordinates.

Note that this screen-relative layout is not sensibly applicable when the view is rotated.

Parameters:

supplierScreenMinX - The supplier for the x-coordinate on the screen where the x-axis should start

supplierScreenMaxX - The supplier for the x-coordinate on the screen where the x-axis should end

supplierScreenY - The supplier for the y-coordinate on the screen where the x-axis should be located

setAxisColorY

public void setAxisColorY(java.awt.Color axisColorY)

Set the color for the y-axis. If this is null, then the y-axis will not be painted.

Parameters:

axisColorY - The color for the y-axis

setAxisRangeY

public void setAxisRangeY(double worldMinAxisY,
                          double worldMaxAxisY)

Set the range of the y-axis that should be displayed. If either of the given values is Double.NaN, then the minimum or maximum value of the currently visible world area will be used, respectively

Parameters:

worldMinAxisY - The minimum value, in world coordinates

worldMaxAxisY - The maximum value, in world coordinates

setAxisLocationY

public void setAxisLocationY(double worldXofY)

Set the location where the y-axis should be painted

Parameters:

worldXofY - The x-coordinate where the y-axis should be painted

setScreenAxisLayoutY

public void setScreenAxisLayoutY(java.util.function.IntSupplier supplierScreenMinY,
                                 java.util.function.IntSupplier supplierScreenMaxY,
                                 java.util.function.IntSupplier supplierScreenX)

Set the layout for the y-axis. The given suppliers will provide the screen coordinates that determine how the y-axis should be displayed. If any of the given suppliers is null, then the axis will be painted in world coordinates.

Note that this screen-relative layout is not sensibly applicable when the view is rotated.

Parameters:

supplierScreenMinY - The supplier for the y-coordinate on the screen where the y-axis should start

supplierScreenMaxY - The supplier for the y-coordinate on the screen where the y-axis should end

supplierScreenX - The supplier for the x-coordinate on the screen where the y-axis should be located

paint

public final void paint(java.awt.Graphics2D g,
                        java.awt.geom.AffineTransform worldToScreen,
                        double w,
                        double h)

Description copied from interface: Painter

Perform the painting operations on the given Graphics.

Note that the same Graphics instance will be passed to all painters. No painter should make any assumptions about the state of the Graphics object. Changes in the given Graphics object will affect painters that are called subsequently. This refers to configuration settings, like the rendering hints, but also to the transform of the Graphics.

Settings like the rendering hints will usually be done globally by the Viewer. If a painter modifies these settings, then it should either restore the original settings afterwards, or create a local copy of the Graphics object in order to avoid interferences with other painters.

If the painter needs to transform the Graphics, then it should either use a local copy of the graphics object, or restore the original transform after it finished painting:

 public void paint(
     Graphics2D g, AffineTransform worldToScreen, double w, double h)
 {
     // Store the original transform
     AffineTransform oldAT = g.getTransform();
     
     // Perform custom transforms and painting
     g.translate(100,100);
     g.drawLine(10,20,30,40);
     ...
     
     // Restore the original transform
     g.setTransform(oldAT);
 }
 

The AffineTransform that is passed to this method may also be the same for multiple painters. Usually, the caller should make sure that modifications of this transform do not affect painters that are called subsequently, but in general, it is not recommended to internally store or modify the given affine transform object.

Specified by:

paint in interface Painter

Parameters:

g - The Graphics used for painting

worldToScreen - The world-to-screen transform. This transform encapsulates the translation, rotation and scaling of the viewer to which this painter belongs.

w - The width of the area, in screen coordinates, in which this painter operates. This is the screen size of the viewer to which this painter belongs.

h - The height of the area, in screen coordinates, in which this painter operates. This is the screen size of the viewer to which this painter belongs.

paintAxisY

protected void paintAxisY(java.awt.Graphics2D g,
                          java.awt.geom.AffineTransform worldToScreen)

Paint the y-axis.

Parameters:

g - The graphics to paint to

worldToScreen - The world-to-screen transform