de.javagl.viewer.painters

Class TooltipPainter

java.lang.Object

de.javagl.viewer.painters.TooltipPainter

All Implemented Interfaces:

Painter

public class TooltipPainter
extends java.lang.Object
implements Painter

A class that can be used to paint a tooltip at a certain location, given in world coordinates

Constructor Summary

Constructors

Constructor and Description
TooltipPainter() Default constructor

Method Summary

Modifier and Type	Method and Description
void	paint(java.awt.Graphics2D g, java.awt.geom.AffineTransform worldToScreen, double w, double h) Perform the painting operations on the given Graphics.
void	set(double worldX, double worldY, java.lang.String text) Set the tooltip that should be painted.
void	setAnchor(double x, double y) Set the anchor point for the tooltip.

Methods inherited from class java.lang.Object

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

Constructor Detail

TooltipPainter

public TooltipPainter()

Default constructor

Method Detail

setAnchor

public void setAnchor(double x,
                      double y)

Set the anchor point for the tooltip. The coordinates will be relative to the size of the tooltip. This means that for (0,0), the anchor point is at the upper left of the tooltip, and for (1,1), the anchor point will be at the lower right. Values outside the range [0,1] are possible, and will cause a line to be drawn from the anchor point to the closest corner.

Parameters:

x - The x-coordinate of the anchor point

y - The y-coordinate of the anchor point

set

public void set(double worldX,
                double worldY,
                java.lang.String text)

Set the tooltip that should be painted. If the given text is null, then nothing will be painted

Parameters:

worldX - The x-coordinate of the world position

worldY - The y-coordinate of the world position

text - The text

paint

public 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.