net.talvi.puffinplot.plots

Interface PlotPoint

public interface PlotPoint

PlotPoint represents a point on a PuffinPlot Plot. A "point" in this context refers to any graphical element associated with a treatment step or sample; for example, it may be a small shape used to indicate a precise position on a plot, or a line of text giving information about a sample or step.

See Also:

Plot

Method Summary

Modifier and Type	Method and Description
void	draw(java.awt.Graphics2D graphics) Draws this point in a supplied graphics context.
void	drawWithPossibleLine(java.awt.Graphics2D graphics, PlotPoint prev, boolean annotate) Draws this point in a specified graphics context, possibly drawing a line from a supplied previous point to this one.
java.awt.geom.Point2D	getCentre()
Sample	getSample()
java.awt.Shape	getShape()
TreatmentStep	getTreatmentStep()
boolean	isNear(java.awt.geom.Point2D point, double distance) Report whether this point is near to a supplied Point2D.

Method Detail

draw

void draw(java.awt.Graphics2D graphics)

Draws this point in a supplied graphics context.

Parameters:

graphics - the graphics context in which to draw

drawWithPossibleLine

void drawWithPossibleLine(java.awt.Graphics2D graphics,
                          PlotPoint prev,
                          boolean annotate)

Draws this point in a specified graphics context, possibly drawing a line from a supplied previous point to this one. Whether the line is actually drawn is dependent on the implementing class and on the state of the object implementing the method.

Parameters:

graphics - the graphics context in which to draw

prev - the previous point from which to draw the line to this one

annotate - if true, annotate the point textually with implementation-dependent additional information

getTreatmentStep

TreatmentStep getTreatmentStep()

Returns:

the treatment step associated with this point, or null if there is no associated treatment step

getSample

Sample getSample()

Returns:

the sample associated with this point, or null if there is no associated sample

getShape

java.awt.Shape getShape()

Returns:

the shape of this point

getCentre

java.awt.geom.Point2D getCentre()

Returns:

the position of the centre of this point

isNear

boolean isNear(java.awt.geom.Point2D point,
               double distance)

Report whether this point is near to a supplied Point2D. The exact behaviour is implementation-dependent. If this point represents a precise position on a plot, distance indicates the maximum distance which should be considered "near". If the point consists of a larger area (e.g. a line of text) whose exact position does not represent a property of the associated sample or step, the distance argument may be ignored and the method may return true only if the supplied Point2D lies within this PlotPoint's extent.

Parameters:

point - the point whose nearness to this point should be determined

distance - the maximum distance at which the two points should be considered "near"

Returns:

true if and only if the supplied point is near to this point