Class PlotMark is a class for drawing a geometric
* shape or mark at a specified point in a graphics context or for
* painting a Paintable at such a point.
In 2.4.0, the class was completely refactored to use the class
* PlotMarkAlgorithm so that it is possible for the
* user to define a new plot mark.
*
*
In 2.4.0, the alternative to use a Paintable as a
* mark was also introduced.
When a plot mark is defined via a plot mark algorithm then the * paint used for drawing is that determined by the graphics context. * When a plot mark is defined by a paintable, then the paintable * controls the entire drawing process.
* *In 2.4.0, it was decided to remove options that would permit a
* PlotMark to be modified after construction. In other
* words, a PlotMark is immutable. Instead, there are
* now constructors available that permit a PlotMark to
* be fully or partially cloned.
This class provides several static instances of itself. The * constant names are chosen to promote compatibility with earlier * versions of the class although the actual objects referenced by * these constants are quite different.
* *In 2.6.0, the mark method was changed to always
* stroke the boundary of a plot mark defined by a plot mark algorithm
* whether or not the internal fill is set to true. This
* was done since a pure fill may draw an asymmetric boundary. As a
* consequence of this decision, a mark has the same boundary whether
* filled or unfilled. Also, anti-aliasing is turned off when using a
* plot mark algorithm because that will destroy the desired symmetry.
Also, in 2.6.0, we cache the Shape that corresponds
* to the internal PlotMarkAlgorithm, the size, and the
* standard location (0,0). This makes painting a bit faster.
Finally, in 2.6.0, we allow the plot mark size to be as small as * 0 to enable the base case for certain plot mark shapes.
* * @author Richard Rasala * @version 2.6.0 * @since 1.0 */ public class PlotMark { /** The horizontal bar plot mark. */ public static final PlotMark H_BAR = new PlotMark(PlotMarkAlgorithm.HBar, false); /** The vertical bar plot mark. */ public static final PlotMark V_BAR = new PlotMark(PlotMarkAlgorithm.VBar, false); /** The plus plot mark. */ public static final PlotMark PLUS = new PlotMark(PlotMarkAlgorithm.Plus, false); /** The cross plot mark. */ public static final PlotMark CROSS = new PlotMark(PlotMarkAlgorithm.Cross, false); /** The asterisk plot mark. */ public static final PlotMark ASTERISK = new PlotMark(PlotMarkAlgorithm.Asterisk, false); /** The square plot mark. */ public static final PlotMark SQUARE = new PlotMark(PlotMarkAlgorithm.Square, false); /** The diamond plot mark. */ public static final PlotMark DIAMOND = new PlotMark(PlotMarkAlgorithm.Diamond, false); /** *The circle plot mark.
* *See comments in PlotMarkAlgorithm.BetterCircle.
The filled circle plot mark.
* *See comments in PlotMarkAlgorithm.BetterCircle.
PlotMarkAlgorithm.Square. */
private static final PlotMarkAlgorithm DEFAULT_ALGORITHM =
PlotMarkAlgorithm.Square;
/** Default plot mark size: 3. */
private static final int DEFAULT_SIZE = 3;
/** Default plot mark fill: true. */
private static final boolean DEFAULT_FILL = true;
/** The standard stroke: BasicStroke(1). */
private static final Stroke standardStroke = new BasicStroke(1);
// member data
/** The plot mark algorithm. */
private PlotMarkAlgorithm algorithm = DEFAULT_ALGORITHM;
/** The plot mark size. */
private int size = DEFAULT_SIZE;
/** The plot mark fill. */
private boolean fill = DEFAULT_FILL;
/** The plot mark shape. */
private Shape shape = null;
/** The paintable if used instead of an algorithm. */
private Paintable paintable = null;
//////////////////
// Constructors //
//////////////////
/**
* Constructs a plot mark using the defaults.
* *Algorithm: PlotMarkAlgorithm.Square
Size: 3
Fill: true
The default plot mark is a copy of the static constant
* plot mark FILLED_SQUARE.
Constructs a plot mark using the given algorithm and * the defaults listed below.
* *Size: 3
Fill: true
If the algorithm is null, it is set to
* PlotMarkAlgorithm.Square.
Constructs a plot mark using the given algorithm, the * given size, and the default listed below.
* *Fill: true
If the algorithm is null, it is set to
* PlotMarkAlgorithm.Square.
If the size is less than 0, it is set to 0.
* * @param algorithm the plot mark algorithm * @param size the plot mark size setting */ public PlotMark(PlotMarkAlgorithm algorithm, int size) { initializePlotMark( algorithm, size, DEFAULT_FILL, null); } /** *Constructs a plot mark using the given algorithm, the * given fill setting, and the default listed below.
* *Size: 3
If the algorithm is null, it is set to
* PlotMarkAlgorithm.Square.
Constructs a plot mark using the given algorithm, the * given size, and the given fill setting.
* *If the algorithm is null, it is set to
* PlotMarkAlgorithm.Square.
If the size is less than 0, it is set to 0.
* * @param algorithm the plot mark algorithm * @param size the plot mark size setting * @param fill the plot mark fill setting */ public PlotMark(PlotMarkAlgorithm algorithm, int size, boolean fill) { initializePlotMark( algorithm, size, fill, null); } /** *Constructs a plot mark by cloning the given plot mark.
* *If the plot mark is null, it is set to
* PlotMark.FILLED_SQUARE.
If the plot mark is set by a paintable then the new * plot mark is set by the same paintable.
* * @param plotmark the plot mark to clone */ public PlotMark(PlotMark plotmark) { if (plotmark == null) plotmark = FILLED_SQUARE; initializePlotMark (plotmark.algorithm, plotmark.size, plotmark.fill, plotmark.paintable); } /** *Constructs a plot mark using the given plot mark but * changing the specified setting.
* *If the plot mark is null, it is set to
* PlotMark.FILLED_SQUARE.
If the plot mark is set by a paintable then the new * plot mark is set by the same paintable.
* *If the size is less than 0, it is set to 0.
* * @param plotmark the plot mark to partially clone * @param size the plot mark size setting */ public PlotMark(PlotMark plotmark, int size) { if (plotmark == null) plotmark = FILLED_SQUARE; initializePlotMark (plotmark.algorithm, size, plotmark.fill, plotmark.paintable); } /** *Constructs a plot mark using the given plot mark but * changing the specified setting.
* *If the plot mark is null, it is set to
* PlotMark.FILLED_SQUARE.
If the plot mark is set by a paintable then the new * plot mark is set by the same paintable.
* * @param plotmark the plot mark to partially clone * @param fill the plot mark fill setting */ public PlotMark(PlotMark plotmark, boolean fill) { if (plotmark == null) plotmark = FILLED_SQUARE; initializePlotMark (plotmark.algorithm, plotmark.size, fill, plotmark.paintable); } /** *Constructs a plot mark using the given plot mark but * changing the specified settings.
* *If the plot mark is null, it is set to
* PlotMark.FILLED_SQUARE.
If the plot mark is set by a paintable then the new * plot mark is set by the same paintable.
* *If the size is less than 0, it is set to 0.
* * @param plotmark the plot mark to partially clone * @param size the plot mark size setting * @param fill the plot mark fill setting */ public PlotMark(PlotMark plotmark, int size, boolean fill) { if (plotmark == null) plotmark = FILLED_SQUARE; initializePlotMark (plotmark.algorithm, size, fill, plotmark.paintable); } /** *Constructs a plot mark using the given paintable.
* *Uses the default plot mark algorithm and settings
* if the given paintable is null.
The common initialization code for a plot mark.
* * @param algorithm the plot mark algorithm if used * @param size the plot mark size setting * @param fill the plot mark fill setting * @param paintable the plot mark paintable if used */ private void initializePlotMark (PlotMarkAlgorithm algorithm, int size, boolean fill, Paintable paintable) { if (paintable != null) { this.algorithm = null; this.paintable = paintable; return; } if (algorithm == null) algorithm = PlotMarkAlgorithm.Square; this.algorithm = algorithm; if (size < 0) size = 0; this.size = size; this.fill = fill; } /** *Draws, fills, or paints a mark at the given plot point.
* *If this plot mark is defined by a plot mark algorithm, then * proceed as follows:
* *Shape.true.BasicStroke(1) as the stroke setting.Paint as-is.Otherwise, if the plot mark is defined by a paintable, then * make the call:
* *paintable.paintAt(g, the-plot-point)Does nothing if the given plot point is null.
*
* @param g the graphics context
* @param p the plot point
*/
public final void mark(Graphics g, Point2D p) {
if (g == null)
return;
if (p == null)
return;
mark(g, p.getX(), p.getY());
}
/**
*
Draws, fills, or paints a mark at the given plot point.
* *If this plot mark is defined by a plot mark algorithm, then * proceed as follows:
* *Shape.true.BasicStroke(1) as the stroke setting.Paint as-is.Otherwise, if the plot mark is defined by a paintable, then * make the call:
* *paintable.paintAt(g, the-plot-point)Draws, fills, or paints a mark at the plot point which is * obtained by applying the transform to the given point.
* *In all cases, find the plot point by applying the transform * to the given point.
* *If this plot mark is defined by a plot mark algorithm, then * proceed as follows:
* *Shape.true.BasicStroke(1) as the stroke setting.Paint as-is.Otherwise, if the plot mark is defined by a paintable, then * make the call:
* *paintable.paintAt(g, the-plot-point)Does nothing if the original point is null.
*
* @param g the graphics context
* @param T the affine transform to apply to the original point
* @param p the original point
*/
public final void mark(Graphics g, AffineTransform T, Point2D p) {
if (g == null)
return;
if (p == null)
return;
mark(g, T, p.getX(), p.getY());
}
/**
*
Draws, fills, or paints a mark at the plot point which is * obtained by applying the transform to the given point.
* *In all cases, find the plot point by applying the transform * to the given point.
* *If this plot mark is defined by a plot mark algorithm, then * proceed as follows:
* *Shape.true.BasicStroke(1) as the stroke setting.Paint as-is.Otherwise, if the plot mark is defined by a paintable, then * make the call:
* *paintable.paintAt(g, the-plot-point)PlotMarkAlgorithm
* or null if an algorithm is not used.
*/
public final PlotMarkAlgorithm getAlgorithm() { return algorithm; }
/**
* Returns the size setting. This will not be used if
* the plot mark is defined by a paintable.
*
*/
public final int getSize() { return size; }
/**
* Returns the fill setting. This will not be used if
* the plot mark is defined by a paintable.
*
*/
public final boolean getFill() { return fill; }
/**
* Returns the internal Paintable
* or null if a paintable is not used.
*/
public final Paintable getPaintable() { return paintable; }
}