/* ===========================================================
 
* 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.]
 
*
 
* ---------------------
 
* XYLineAnnotation.java
 
* ---------------------
 
* (C) Copyright 2003-2017, by Object Refinery Limited.
 
*
 
* Original Author:
  
David Gilbert (for Object Refinery Limited);
 
* Contributor(s):
   
Peter Kolb (see patch 2809117);
 
*
 
* Changes:
 
* --------
 
* 02-Apr-2003 : Version 1 (DG);
 
* 19-Aug-2003 : Added equals method, implemented Cloneable, and applied
 
*
               
serialization fixes (DG);
 
* 21-Jan-2004 : Update for renamed method in ValueAxis (DG);
 
* 14-Apr-2004 : Fixed draw() method to handle plot orientation correctly (DG);
 
* 29-Sep-2004 : Added support for tool tips and URLS, now extends
 
*
               
AbstractXYAnnotation (DG);
 
* 04-Oct-2004 : Renamed ShapeUtils --> ShapeUtilities (DG);
 
* 08-Jun-2005 : Fixed equals() method to handle GradientPaint() (DG);
 
* 05-Nov-2008 : Added workaround for JRE bug 6574155, see JFreeChart bug
 
*
               
2221495 (DG);
 
* 02-Jul-2013 : 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.Stroke;
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.axis.ValueAxis;
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.ui.RectangleEdge;
import org.jfree.chart.util.LineUtils;
import org.jfree.chart.util.ObjectUtils;
import org.jfree.chart.util.PaintUtils;
import org.jfree.chart.util.Args;
import org.jfree.chart.util.PublicCloneable;
import org.jfree.chart.util.SerialUtils;
import org.jfree.chart.util.ShapeUtils;

/**
 
* A simple line annotation that can be placed on an {@link XYPlot}.
 
*/

public class XYLineAnnotation extends AbstractXYAnnotation
        
implements Cloneable, PublicCloneable, Serializable {

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

    
/** The x-coordinate. */
    
private double x1;

    
/** The y-coordinate. */
    
private double y1;

    
/** The x-coordinate. */
    
private double x2;

    
/** The y-coordinate. */
    
private double y2;

    
/** The line stroke. */
    
private transient Stroke stroke;

    
/** The line color. */
    
private transient Paint paint;

    
/**
     
* Creates a new annotation that draws a line from (x1, y1) to (x2, y2)
     
* where the coordinates are measured in data space (that is, against the
     
* plot's axes).
     
*
     
* @param x1
  
the x-coordinate for the start of the line.
     
* @param y1
  
the y-coordinate for the start of the line.
     
* @param x2
  
the x-coordinate for the end of the line.
     
* @param y2
  
the y-coordinate for the end of the line.
     
*/

    
public XYLineAnnotation(double x1, double y1, double x2, double y2) {
        
this(x1, y1, x2, y2, new BasicStroke(1.0f), Color.BLACK);
    
}

    
/**
     
* Creates a new annotation that draws a line from (x1, y1) to (x2, y2)
     
* where the coordinates are measured in data space (that is, against the
     
* plot's axes).
     
*
     
* @param x1
  
the x-coordinate for the start of the line.
     
* @param y1
  
the y-coordinate for the start of the line.
     
* @param x2
  
the x-coordinate for the end of the line.
     
* @param y2
  
the y-coordinate for the end of the line.
     
* @param stroke
  
the line stroke ({@code null} not permitted).
     
* @param paint
  
the line color ({@code null} not permitted).
     
*/

    
public XYLineAnnotation(double x1, double y1, double x2, double y2,
                            
Stroke stroke, Paint paint) {

        
super();
        
Args.nullNotPermitted(stroke, "stroke");
        
Args.nullNotPermitted(paint, "paint");
        
this.x1 = x1;
        
this.y1 = y1;
        
this.x2 = x2;
        
this.y2 = y2;
        
this.stroke = stroke;
        
this.paint = paint;

    
}

    
/**
     
* Draws the annotation.
  
This method is called by the {@link XYPlot}
     
* class, you won't normally need to call it yourself.
     
*
     
* @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
  
if supplied, this info object will be populated with
     
*
              
entity information.
     
*/

    
@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);
        
float j2DX1 = 0.0f;
        
float j2DX2 = 0.0f;
        
float j2DY1 = 0.0f;
        
float j2DY2 = 0.0f;
        
if (orientation == PlotOrientation.VERTICAL) {
            
j2DX1 = (float) domainAxis.valueToJava2D(this.x1, dataArea,
                    
domainEdge);
            
j2DY1 = (float) rangeAxis.valueToJava2D(this.y1, dataArea,
                    
rangeEdge);
            
j2DX2 = (float) domainAxis.valueToJava2D(this.x2, dataArea,
                    
domainEdge);
            
j2DY2 = (float) rangeAxis.valueToJava2D(this.y2, dataArea,
                    
rangeEdge);
        
}
        
else if (orientation == PlotOrientation.HORIZONTAL) {
            
j2DY1 = (float) domainAxis.valueToJava2D(this.x1, dataArea,
                    
domainEdge);
            
j2DX1 = (float) rangeAxis.valueToJava2D(this.y1, dataArea,
                    
rangeEdge);
            
j2DY2 = (float) domainAxis.valueToJava2D(this.x2, dataArea,
                    
domainEdge);
            
j2DX2 = (float) rangeAxis.valueToJava2D(this.y2, dataArea,
                    
rangeEdge);
        
}
        
g2.setPaint(this.paint);
        
g2.setStroke(this.stroke);
        
Line2D line = new Line2D.Float(j2DX1, j2DY1, j2DX2, j2DY2);
        
// line is clipped to avoid JRE bug 6574155, for more info
        
// see JFreeChart bug 2221495
        
boolean visible = LineUtils.clipLine(line, dataArea);
        
if (visible) {
            
g2.draw(line);
        
}

        
String toolTip = getToolTipText();
        
String url = getURL();
        
if (toolTip != null || url != null) {
            
addEntity(info, ShapeUtils.createLineRegion(line, 1.0f),
                    
rendererIndex, toolTip, url);
        
}
    
}

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

    
@Override
    
public boolean equals(Object obj) {
        
if (obj == this) {
            
return true;
        
}
        
if (!super.equals(obj)) {
            
return false;
        
}
        
if (!(obj instanceof XYLineAnnotation)) {
            
return false;
        
}
        
XYLineAnnotation that = (XYLineAnnotation) obj;
        
if (this.x1 != that.x1) {
            
return false;
        
}
        
if (this.y1 != that.y1) {
            
return false;
        
}
        
if (this.x2 != that.x2) {
            
return false;
        
}
        
if (this.y2 != that.y2) {
            
return false;
        
}
        
if (!PaintUtils.equal(this.paint, that.paint)) {
            
return false;
        
}
        
if (!ObjectUtils.equal(this.stroke, that.stroke)) {
            
return false;
        
}
        
// seems to be the same...
        
return true;
    
}

    
/**
     
* Returns a hash code.
     
*
     
* @return A hash code.
     
*/
    
@Override
    
public int hashCode() {
        
int result;
        
long temp;
        
temp = Double.doubleToLongBits(this.x1);
        
result = (int) (temp ^ (temp >>> 32));
        
temp = Double.doubleToLongBits(this.x2);
        
result = 29 * result + (int) (temp ^ (temp >>> 32));
        
temp = Double.doubleToLongBits(this.y1);
        
result = 29 * result + (int) (temp ^ (temp >>> 32));
        
temp = Double.doubleToLongBits(this.y2);
        
result = 29 * 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.paint, stream);
        
SerialUtils.writeStroke(this.stroke, 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.paint = SerialUtils.readPaint(stream);
        
this.stroke = SerialUtils.readStroke(stream);
    
}

}