/* * ITracePoint2d.java, interface for trace points. * Copyright (c) 2004 - 2011 Achim Westermann, Achim.Westermann@gmx.de * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * * If you modify or optimize the code in a useful way please let me know. * Achim.Westermann@gmx.de */ package info.monitorenter.gui.chart; import java.util.Set; /** * An interface for trace points. *

* * @author Achim Westermann * @version $Revision: 1.13 $ */ public interface ITracePoint2D extends Comparable, java.io.Serializable, Cloneable { /** * The state flag used to inform the {@link ITrace2D} listener * via {@link ITrace2D#firePointChanged(ITracePoint2D, int)} in * case a point was added. *

*/ public static final int STATE_ADDED = 1; /** * The state flag used to inform the {@link ITrace2D} listener * via {@link ITrace2D#firePointChanged(ITracePoint2D, int)} in * case a point was changed. *

* Will be used by {@link #setLocation(double, double)} and * {@link java.awt.geom.Point2D#setLocation(java.awt.geom.Point2D)}. *

*/ public static final int STATE_CHANGED = 4; /** * The state flag used to inform the {@link ITrace2D} listener * via {@link ITrace2D#firePointChanged(ITracePoint2D, int)} in * case a point was removed. *

*/ public static final int STATE_REMOVED = 2; /** * Adds a point painter that additionally (to the pointer painters of the * trace ({@link ITrace2D#getTracePainters()} )) paint this * point. *

* No clone will be taken. Outside modifications of the argument later on will * also affect this instances state! *

* Caution! This is a low level mechanism that is also used by the * highlighting mechanism. It is being utilized by the * {@link Chart2D#enablePointHighlighting(boolean)} which will * use some mouse motion listener to remove outdated highlighters and add * highlighters to the new point in focus by taking the highlighter configured * in the trace.
* So to use point highlighting for traces you should not re-program it at * this level but just use * {@link ITrace2D#addPointHighlighter(IPointPainter)} and * {@link Chart2D#enablePointHighlighting(boolean)}. *

* * @param pointPainter * a point painter that will additionally (to the trace painter of * the chart) paint this point. * * @return true if this point painter was accepted (not contained before by * the means of {@link IPointPainter#compareTo(Object) } * . */ public boolean addAdditionalPointPainter(IPointPainter< ? > pointPainter); /** * Removes a point painter that additionally (to the pointer painters of the * trace ({@link ITrace2D#getTracePainters()} )) paint this * point. *

* * @param pointPainter * a point painter that currently is used to additionally (to the * trace painter of the chart) paint this point. * * @return true if this point painter was removed (contained before by the * means of {@link IPointPainter#compareTo(Object) } . */ public boolean removeAdditionalPointPainter(IPointPainter< ? > pointPainter); /** * Removes all point painters that additionally (to the pointer painters of * the trace ({@link ITrace2D#getTracePainters()} )) paint this * point. *

* * @return all instances that were used before this call. */ public Set> removeAllAdditionalPointPainters(); /** * Returns a cloned instance (deep copy). *

* * @return a cloned instance (deep copy) */ public Object clone(); /** * Returns the point painter that additionally (to the trace painter of the * chart) paint this point. *

* The original list is returned so painters may be added or removed (even all * painters may be cleared). *

* * @return the point painters that additionally (to the trace painter of the * chart) paint this point. */ public Set> getAdditionalPointPainters(); /** * Returns the Euclid distance of this point's normalized values ( * {@link #getScaledX()}, {@link #getScaledY()}) to the given * normalized coordinates. *

* * @param xNormalized * the normalized x coordinate between 0 and 1.0 to measure the * Euclid distance to. * * @param yNormalized * the normalized y coordinate between 0 and 1.0 to measure the * Euclid distance to. * * @return the Euclid distance of this point's normalized values ( * {@link #getScaledX()}, {@link #getScaledY()}) to the given * normalized coordinates. */ public abstract double getEuclidDistance(final double xNormalized, final double yNormalized); /** * Returns the listener trace connected to this trace point. *

* * @return the listener trace connected to this trace point. */ public abstract ITrace2D getListener(); /** * Returns the Manhattan distance of this point's normalized values ( * {@link #getScaledX()}, {@link #getScaledY()}) to the given * normalized coordinates. *

* * @param xNormalized * the normalized x coordinate between 0 and 1.0 to measure the * Manhattan distance to. * @param yNormalized * the normalized y coordinate between 0 and 1.0 to measure the * Manhattan distance to. * @return the Manhattan distance of this point's normalized values ( * {@link #getScaledX()}, {@link #getScaledY()}) to the given * normalized coordinates. */ public abstract double getManhattanDistance(final double xNormalized, final double yNormalized); /** * Returns the Manhattan distance of this point to the given one. *

* * @param point * the point to measure the Manhattan distance to. * @return the Manhattan distance of this point to the given one. */ public abstract double getManhattanDistance(final ITracePoint2D point); /** * @return the scaledX. */ public abstract double getScaledX(); /** * @return the scaledY. */ public abstract double getScaledY(); /** * Returns the x value. *

* * @return the x value. * * @see java.awt.geom.Point2D#getX() */ public abstract double getX(); /** * Returns the y value. *

* * @return the y value. * * @see java.awt.geom.Point2D#getY() */ public abstract double getY(); /** * Allows ITrace2D instances to register (or de-register) * themselves with this point to receive (or stop receiving) change * information via {@link ITrace2D#firePointChanged(ITracePoint2D, int)} * events. *

* * @param listener * The instance that will be informed about changes or null to * deregister. */ public abstract void setListener(final ITrace2D listener); /** * This method overloads the method of * java.awt.geom.Point2D.Double to fire a property change event * to listeners of the corresponding {@link ITrace2D} instances * via their method * {@link ITrace2D#firePointChanged(ITracePoint2D, int)} (with * int argument set to {@link #STATE_CHANGED}). *

* * @param xValue * the new x-coordinate for this point. * @param yValue * the new y-coordinate for this point. */ public abstract void setLocation(final double xValue, final double yValue); /** * Only intended for Chart2D!!!. *

* * @param scaledX * the scaledX to set */ public abstract void setScaledX(final double scaledX); /** * Only intended for Chart2D!!!. *

* * @param scaledY * the scaledY to set */ public abstract void setScaledY(final double scaledY); }