de.javagl.viewer.painters

Class LabelPainter.LabelPaintState

java.lang.Object

de.javagl.viewer.painters.LabelPainter.LabelPaintState

Enclosing class:

LabelPainter

public static class LabelPainter.LabelPaintState
extends java.lang.Object

A class describing the state of a label that is about to be painted. An instance of this class will be passed to the label painting condition predicate that may have been set with LabelPainter.setLabelPaintingCondition(Predicate), to determine whether the label should be painted.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLabel() Returns the label that is about to be painted
java.awt.geom.Rectangle2D	getLabelBounds() Returns a reference to the bounds of the label that is about to be painted.
java.awt.geom.AffineTransform	getLabelTransform() Returns a reference to the affine transform that will be applied to the graphics context before the label is painted at the origin.
java.awt.geom.AffineTransform	getWorldToScreenTransform() Returns a reference to an affine transform that is equal to the transform that was passed to the painting method of the LabelPainter

Methods inherited from class java.lang.Object

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

Method Detail

getLabel

public java.lang.String getLabel()

Returns the label that is about to be painted

Returns:

The label

getLabelBounds

public java.awt.geom.Rectangle2D getLabelBounds()

Returns a reference to the bounds of the label that is about to be painted. These are the untransformed bounds, and thus, only depend on the font and contents of the label.

Returns:

The label bounds

getLabelTransform

public java.awt.geom.AffineTransform getLabelTransform()

Returns a reference to the affine transform that will be applied to the graphics context before the label is painted at the origin. If the calling LabelPainter is transforming the labels, then this will include the world to screen transform.

Returns:

The affine transform

getWorldToScreenTransform

public java.awt.geom.AffineTransform getWorldToScreenTransform()

Returns a reference to an affine transform that is equal to the transform that was passed to the painting method of the LabelPainter

Returns:

The affine transform