/* ===========================================================
 
* JFreeChart : a free chart library for the Java(tm) platform
 
* ===========================================================
 
*
 
* (C) Copyright 2000-2017, by Object Refinery Limited and Contributors.
 
*
 
* Project Info:
  
http://www.jfree.org/jfreechart/index.html
 
*
 
* 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 Street, Fifth Floor, Boston, MA
  
02110-1301,
 
* USA.
 
*
 
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 
* Other names may be trademarks of their respective owners.]
 
*
 
* ------------------------
 
* XYPointerAnnotation.java
 
* ------------------------
 
* (C) Copyright 2003-2017, by Object Refinery Limited.
 
*
 
* Original Author:
  
David Gilbert (for Object Refinery Limited);
 
* Contributor(s):
   
Peter Kolb (patch 2809117);
 
*
 
* Changes:
 
* --------
 
* 21-May-2003 : Version 1 (DG);
 
* 10-Jun-2003 : Changed BoundsAnchor to TextAnchor (DG);
 
* 02-Jul-2003 : Added accessor methods and simplified constructor (DG);
 
* 19-Aug-2003 : Implemented Cloneable (DG);
 
* 13-Oct-2003 : Fixed bug where arrow paint is not set correctly (DG);
 
* 21-Jan-2004 : Update for renamed method in ValueAxis (DG);
 
* 29-Sep-2004 : Changes to draw() method signature (DG);
 
* ------------- JFREECHART 1.0.x ---------------------------------------------
 
* 20-Feb-2006 : Correction for equals() method (fixes bug 1435160) (DG);
 
* 12-Jul-2006 : Fix drawing for PlotOrientation.HORIZONTAL, thanks to
 
*
               
Skunk (DG);
 
* 12-Feb-2009 : Added support for rotated label, plus background and
 
*
               
outline (DG);
 
* 18-May-2009 : Fixed typo in hashCode() method (DG);
 
* 24-Jun-2009 : Fire change events (see patch 2809117 by PK) (DG);
 
* 02-Jul-2016 : Use ParamChecks (DG);
 
*
 
*/

package org.jfree.chart.annotations;

import java.awt.BasicStroke;
import java.awt.Color;
import java.awt.Graphics2D;
import java.awt.Paint;
import java.awt.Shape;
import java.awt.Stroke;
import java.awt.geom.GeneralPath;
import java.awt.geom.Line2D;
import java.awt.geom.Rectangle2D;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;

import org.jfree.chart.HashUtils;
import org.jfree.chart.axis.ValueAxis;
import org.jfree.chart.event.AnnotationChangeEvent;
import org.jfree.chart.plot.Plot;
import org.jfree.chart.plot.PlotOrientation;
import org.jfree.chart.plot.PlotRenderingInfo;
import org.jfree.chart.plot.XYPlot;
import org.jfree.chart.text.TextUtils;
import org.jfree.chart.ui.RectangleEdge;
import org.jfree.chart.util.ObjectUtils;
import org.jfree.chart.util.Args;
import org.jfree.chart.util.PublicCloneable;
import org.jfree.chart.util.SerialUtils;

/**
 
* An arrow and label that can be placed on an {@link XYPlot}.
  
The arrow is
 
* drawn at a user-definable angle so that it points towards the (x, y)
 
* location for the annotation.
 
* <p>
 
* The arrow length (and its offset from the (x, y) location) is controlled by
 
* the tip radius and the base radius attributes.
  
Imagine two circles around
 
* the (x, y) coordinate: the inner circle defined by the tip radius, and the
 
* outer circle defined by the base radius.
  
Now, draw the arrow starting at
 
* some point on the outer circle (the point is determined by the angle), with
 
* the arrow tip being drawn at a corresponding point on the inner circle.
 
*/

public class XYPointerAnnotation extends XYTextAnnotation
        
implements Cloneable, PublicCloneable, Serializable {

    
/** For serialization. */
    
private static final long serialVersionUID = -4031161445009858551L;

    
/** The default tip radius (in Java2D units). */
    
public static final double DEFAULT_TIP_RADIUS = 10.0;

    
/** The default base radius (in Java2D units). */
    
public static final double DEFAULT_BASE_RADIUS = 30.0;

    
/** The default label offset (in Java2D units). */
    
public static final double DEFAULT_LABEL_OFFSET = 3.0;

    
/** The default arrow length (in Java2D units). */
    
public static final double DEFAULT_ARROW_LENGTH = 5.0;

    
/** The default arrow width (in Java2D units). */
    
public static final double DEFAULT_ARROW_WIDTH = 3.0;

    
/** The angle of the arrow's line (in radians). */
    
private double angle;

    
/**
     
* The radius from the (x, y) point to the tip of the arrow (in Java2D
     
* units).
     
*/

    
private double tipRadius;

    
/**
     
* The radius from the (x, y) point to the start of the arrow line (in
     
* Java2D units).
     
*/

    
private double baseRadius;

    
/** The length of the arrow head (in Java2D units). */
    
private double arrowLength;

    
/** The arrow width (in Java2D units, per side). */
    
private double arrowWidth;

    
/** The arrow stroke. */
    
private transient Stroke arrowStroke;

    
/** The arrow paint. */
    
private transient Paint arrowPaint;

    
/** The radius from the base point to the anchor point for the label. */
    
private double labelOffset;

    
/**
     
* Creates a new label and arrow annotation.
     
*
     
* @param label
  
the label ({@code null} permitted).
     
* @param x
  
the x-coordinate (measured against the chart's domain axis).
     
* @param y
  
the y-coordinate (measured against the chart's range axis).
     
* @param angle
  
the angle of the arrow's line (in radians).
     
*/

    
public XYPointerAnnotation(String label, double x, double y, double angle) {

        
super(label, x, y);
        
this.angle = angle;
        
this.tipRadius = DEFAULT_TIP_RADIUS;
        
this.baseRadius = DEFAULT_BASE_RADIUS;
        
this.arrowLength = DEFAULT_ARROW_LENGTH;
        
this.arrowWidth = DEFAULT_ARROW_WIDTH;
        
this.labelOffset = DEFAULT_LABEL_OFFSET;
        
this.arrowStroke = new BasicStroke(1.0f);
        
this.arrowPaint = Color.BLACK;

    
}

    
/**
     
* Returns the angle of the arrow.
     
*
     
* @return The angle (in radians).
     
*
     
* @see #setAngle(double)
     
*/

    
public double getAngle() {
        
return this.angle;
    
}

    
/**
     
* Sets the angle of the arrow and sends an
     
* {@link AnnotationChangeEvent} to all registered listeners.
     
*
     
* @param angle
  
the angle (in radians).
     
*
     
*
 

     
*/

    
public void setAngle(double angle) {
        
this.angle = angle;
        
fireAnnotationChanged();
    
}

    
/**
     
* Returns the tip radius.
     
*
     
* @return The tip radius (in Java2D units).
     
*
     
* @see #setTipRadius(double)
     
*/

    
public double getTipRadius() {
        
return this.tipRadius;
    
}

    
/**
     
* Sets the tip radius and sends an
     
* {@link AnnotationChangeEvent} to all registered listeners.
     
*
     
* @param radius
  
the radius (in Java2D units).
     
*
     
*
 

     
*/

    
public void setTipRadius(double radius) {
        
this.tipRadius = radius;
        
fireAnnotationChanged();
    
}

    
/**
     
* Returns the base radius.
     
*
     
* @return The base radius (in Java2D units).
     
*
     
* @see #setBaseRadius(double)
     
*/

    
public double getBaseRadius() {
        
return this.baseRadius;
    
}

    
/**
     
* Sets the base radius and sends an
     
* {@link AnnotationChangeEvent} to all registered listeners.
     
*
     
* @param radius
  
the radius (in Java2D units).
     
*
     
*
 

     
*/

    
public void setBaseRadius(double radius) {
        
this.baseRadius = radius;
        
fireAnnotationChanged();
    
}

    
/**
     
* Returns the label offset.
     
*
     
* @return The label offset (in Java2D units).
     
*
     
* @see #setLabelOffset(double)
     
*/

    
public double getLabelOffset() {
        
return this.labelOffset;
    
}

    
/**
     
* Sets the label offset (from the arrow base, continuing in a straight
     
* line, in Java2D units) and sends an
     
* {@link AnnotationChangeEvent} to all registered listeners.
     
*
     
* @param offset
  
the offset (in Java2D units).
     
*
     
*
 

     
*/

    
public void setLabelOffset(double offset) {
        
this.labelOffset = offset;
        
fireAnnotationChanged();
    
}

    
/**
     
* Returns the arrow length.
     
*
     
* @return The arrow length.
     
*
     
* @see #setArrowLength(double)
     
*/

    
public double getArrowLength() {
        
return this.arrowLength;
    
}

    
/**
     
* Sets the arrow length and sends an
     
* {@link AnnotationChangeEvent} to all registered listeners.
     
*
     
* @param length
  
the length.
     
*
     
*
 

     
*/

    
public void setArrowLength(double length) {
        
this.arrowLength = length;
        
fireAnnotationChanged();
    
}

    
/**
     
* Returns the arrow width.
     
*
     
* @return The arrow width (in Java2D units).
     
*
     
* @see #setArrowWidth(double)
     
*/

    
public double getArrowWidth() {
        
return this.arrowWidth;
    
}

    
/**
     
* Sets the arrow width and sends an
     
* {@link AnnotationChangeEvent} to all registered listeners.
     
*
     
* @param width
  
the width (in Java2D units).
     
*
     
*
 

     
*/

    
public void setArrowWidth(double width) {
        
this.arrowWidth = width;
        
fireAnnotationChanged();
    
}

    
/**
     
* Returns the stroke used to draw the arrow line.
     
*
     
* @return The arrow stroke (never {@code null}).
     
*
     
* @see #setArrowStroke(Stroke)
     
*/

    
public Stroke getArrowStroke() {
        
return this.arrowStroke;
    
}

    
/**
     
* Sets the stroke used to draw the arrow line and sends an
     
* {@link AnnotationChangeEvent} to all registered listeners.
     
*
     
* @param stroke
  
the stroke ({@code null} not permitted).
     
*
     
*
 

     
*/

    
public void setArrowStroke(Stroke stroke) {
        
Args.nullNotPermitted(stroke, "stroke");
        
this.arrowStroke = stroke;
        
fireAnnotationChanged();
    
}

    
/**
     
* Returns the paint used for the arrow.
     
*
     
* @return The arrow paint (never {@code null}).
     
*
     
* @see #setArrowPaint(Paint)
     
*/

    
public Paint getArrowPaint() {
        
return this.arrowPaint;
    
}

    
/**
     
* Sets the paint used for the arrow and sends an
     
* {@link AnnotationChangeEvent} to all registered listeners.
     
*
     
* @param paint
  
the arrow paint ({@code null} not permitted).
     
*
     
*
 

     
*/

    
public void setArrowPaint(Paint paint) {
        
Args.nullNotPermitted(paint, "paint");
        
this.arrowPaint = paint;
        
fireAnnotationChanged();
    
}

    
/**
     
* Draws the annotation.
     
*
     
* @param g2
  
the graphics device.
     
* @param plot
  
the plot.
     
* @param dataArea
  
the data area.
     
* @param domainAxis
  
the domain axis.
     
* @param rangeAxis
  
the range axis.
     
* @param rendererIndex
  
the renderer index.
     
* @param info
  
the plot rendering info.
     
*/

    
@Override
    
public void draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea,
            
ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex,
            
PlotRenderingInfo info) {

        
PlotOrientation orientation = plot.getOrientation();
        
RectangleEdge domainEdge = Plot.resolveDomainAxisLocation(
                
plot.getDomainAxisLocation(), orientation);
        
RectangleEdge rangeEdge = Plot.resolveRangeAxisLocation(
                
plot.getRangeAxisLocation(), orientation);
        
double j2DX = domainAxis.valueToJava2D(getX(), dataArea, domainEdge);
        
double j2DY = rangeAxis.valueToJava2D(getY(), dataArea, rangeEdge);
        
if (orientation == PlotOrientation.HORIZONTAL) {
            
double temp = j2DX;
            
j2DX = j2DY;
            
j2DY = temp;
        
}
        
double startX = j2DX + Math.cos(this.angle) * this.baseRadius;
        
double startY = j2DY + Math.sin(this.angle) * this.baseRadius;

        
double endX = j2DX + Math.cos(this.angle) * this.tipRadius;
        
double endY = j2DY + Math.sin(this.angle) * this.tipRadius;

        
double arrowBaseX = endX + Math.cos(this.angle) * this.arrowLength;
        
double arrowBaseY = endY + Math.sin(this.angle) * this.arrowLength;

        
double arrowLeftX = arrowBaseX
                
+ Math.cos(this.angle + Math.PI / 2.0) * this.arrowWidth;
        
double arrowLeftY = arrowBaseY
                
+ Math.sin(this.angle + Math.PI / 2.0) * this.arrowWidth;

        
double arrowRightX = arrowBaseX
                
- Math.cos(this.angle + Math.PI / 2.0) * this.arrowWidth;
        
double arrowRightY = arrowBaseY
                
- Math.sin(this.angle + Math.PI / 2.0) * this.arrowWidth;

        
GeneralPath arrow = new GeneralPath();
        
arrow.moveTo((float) endX, (float) endY);
        
arrow.lineTo((float) arrowLeftX, (float) arrowLeftY);
        
arrow.lineTo((float) arrowRightX, (float) arrowRightY);
        
arrow.closePath();

        
g2.setStroke(this.arrowStroke);
        
g2.setPaint(this.arrowPaint);
        
Line2D line = new Line2D.Double(startX, startY, arrowBaseX, arrowBaseY);
        
g2.draw(line);
        
g2.fill(arrow);

        
// draw the label
        
double labelX = j2DX + Math.cos(this.angle) * (this.baseRadius
                
+ this.labelOffset);
        
double labelY = j2DY + Math.sin(this.angle) * (this.baseRadius
                
+ this.labelOffset);
        
g2.setFont(getFont());
        
Shape hotspot = TextUtils.calculateRotatedStringBounds(
                
getText(), g2, (float) labelX, (float) labelY, getTextAnchor(),
                
getRotationAngle(), getRotationAnchor());
        
if (getBackgroundPaint() != null) {
            
g2.setPaint(getBackgroundPaint());
            
g2.fill(hotspot);
        
}
        
g2.setPaint(getPaint());
        
TextUtils.drawRotatedString(getText(), g2, (float) labelX,
                
(float) labelY, getTextAnchor(), getRotationAngle(),
                
getRotationAnchor());
        
if (isOutlineVisible()) {
            
g2.setStroke(getOutlineStroke());
            
g2.setPaint(getOutlinePaint());
            
g2.draw(hotspot);
        
}

        
String toolTip = getToolTipText();
        
String url = getURL();
        
if (toolTip != null || url != null) {
            
addEntity(info, hotspot, rendererIndex, toolTip, url);
        
}

    
}

    
/**
     
* Tests this annotation for equality with an arbitrary object.
     
*
     
* @param obj
  
the object ({@code null} permitted).
     
*
     
* @return {@code true} or {@code false}.
     
*/

    
@Override
    
public boolean equals(Object obj) {
        
if (obj == this) {
            
return true;
        
}
        
if (!(obj instanceof XYPointerAnnotation)) {
            
return false;
        
}
        
XYPointerAnnotation that = (XYPointerAnnotation) obj;
        
if (this.angle != that.angle) {
            
return false;
        
}
        
if (this.tipRadius != that.tipRadius) {
            
return false;
        
}
        
if (this.baseRadius != that.baseRadius) {
            
return false;
        
}
        
if (this.arrowLength != that.arrowLength) {
            
return false;
        
}
        
if (this.arrowWidth != that.arrowWidth) {
            
return false;
        
}
        
if (!this.arrowPaint.equals(that.arrowPaint)) {
            
return false;
        
}
        
if (!ObjectUtils.equal(this.arrowStroke, that.arrowStroke)) {
            
return false;
        
}
        
if (this.labelOffset != that.labelOffset) {
            
return false;
        
}
        
return super.equals(obj);
    
}

    
/**
     
* Returns a hash code for this instance.
     
*
     
* @return A hash code.
     
*/
    
@Override
    
public int hashCode() {
        
int result = super.hashCode();
        
long temp = Double.doubleToLongBits(this.angle);
        
result = 37 * result + (int) (temp ^ (temp >>> 32));
        
temp = Double.doubleToLongBits(this.tipRadius);
        
result = 37 * result + (int) (temp ^ (temp >>> 32));
        
temp = Double.doubleToLongBits(this.baseRadius);
        
result = 37 * result + (int) (temp ^ (temp >>> 32));
        
temp = Double.doubleToLongBits(this.arrowLength);
        
result = 37 * result + (int) (temp ^ (temp >>> 32));
        
temp = Double.doubleToLongBits(this.arrowWidth);
        
result = 37 * result + (int) (temp ^ (temp >>> 32));
        
result = result * 37 + HashUtils.hashCodeForPaint(this.arrowPaint);
        
result = result * 37 + this.arrowStroke.hashCode();
        
temp = Double.doubleToLongBits(this.labelOffset);
        
result = 37 * result + (int) (temp ^ (temp >>> 32));
        
return result;
    
}

    
/**
     
* Returns a clone of the annotation.
     
*
     
* @return A clone.
     
*
     
* @throws CloneNotSupportedException
  
if the annotation can't be cloned.
     
*/

    
@Override
    
public Object clone() throws CloneNotSupportedException {
        
return super.clone();
    
}

    
/**
     
* Provides serialization support.
     
*
     
* @param stream
  
the output stream.
     
*
     
* @throws IOException if there is an I/O error.
     
*/

    
private void writeObject(ObjectOutputStream stream) throws IOException {
        
stream.defaultWriteObject();
        
SerialUtils.writePaint(this.arrowPaint, stream);
        
SerialUtils.writeStroke(this.arrowStroke, stream);
    
}

    
/**
     
* Provides serialization support.
     
*
     
* @param stream
  
the input stream.
     
*
     
* @throws IOException
  
if there is an I/O error.
     
* @throws ClassNotFoundException
  
if there is a classpath problem.
     
*/

    
private void readObject(ObjectInputStream stream)
        
throws IOException, ClassNotFoundException {
        
stream.defaultReadObject();
        
this.arrowPaint = SerialUtils.readPaint(stream);
        
this.arrowStroke = SerialUtils.readStroke(stream);
    
}

}