001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
006 *
007 * Project Info:  http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it 
010 * under the terms of the GNU Lesser General Public License as published by 
011 * the Free Software Foundation; either version 2.1 of the License, or 
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but 
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
022 * USA.  
023 *
024 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
025 * in the United States and other countries.]
026 *
027 * ---------------
028 * ShipNeedle.java
029 * ---------------
030 * (C) Copyright 2002-2007, by the Australian Antarctic Division and 
031 *                          Contributors.
032 *
033 * Original Author:  Bryan Scott (for the Australian Antarctic Division);
034 * Contributor(s):   David Gilbert (for Object Refinery Limited);
035 *
036 * Changes:
037 * --------
038 * 25-Sep-2002 : Version 1, contributed by Bryan Scott (DG);
039 * 27-Mar-2003 : Implemented Serializable (DG);
040 * 09-Sep-2003 : Added equals() method (DG);
041 * 08-Jun-2005 : Implemented Cloneable (DG);
042 *
043 */
044
045package org.jfree.chart.needle;
046
047import java.awt.Graphics2D;
048import java.awt.geom.Arc2D;
049import java.awt.geom.GeneralPath;
050import java.awt.geom.Point2D;
051import java.awt.geom.Rectangle2D;
052import java.io.Serializable;
053
054/**
055 * A needle in the shape of a ship, for use with the 
056 * {@link org.jfree.chart.plot.CompassPlot} class.
057 */
058public class ShipNeedle extends MeterNeedle 
059                        implements Cloneable, Serializable {
060
061    /** For serialization. */
062    private static final long serialVersionUID = 149554868169435612L;
063    
064    /**
065     * Draws the needle.
066     *
067     * @param g2  the graphics device.
068     * @param plotArea  the plot area.
069     * @param rotate  the rotation point.
070     * @param angle  the angle.
071     */
072    protected void drawNeedle(Graphics2D g2, Rectangle2D plotArea, 
073                              Point2D rotate, double angle) {
074
075        GeneralPath shape = new GeneralPath();
076        shape.append(new Arc2D.Double(-9.0, -7.0, 10, 14, 0.0, 25.5, 
077                Arc2D.OPEN), true);
078        shape.append(new Arc2D.Double(0.0, -7.0, 10, 14, 154.5, 25.5, 
079                Arc2D.OPEN), true);
080        shape.closePath();
081        getTransform().setToTranslation(plotArea.getMinX(), plotArea.getMaxY());
082        getTransform().scale(plotArea.getWidth(), plotArea.getHeight() / 3);
083        shape.transform(getTransform());
084
085        if ((rotate != null) && (angle != 0)) {
086            /// we have rotation
087            getTransform().setToRotation(angle, rotate.getX(), rotate.getY());
088            shape.transform(getTransform());
089        }
090
091        defaultDisplay(g2, shape);
092    }
093
094    /**
095     * Tests another object for equality with this object.
096     * 
097     * @param object  the object to test.
098     * 
099     * @return A boolean.
100     */
101    public boolean equals(Object object) {
102        if (object == null) {
103            return false;
104        }
105        if (object == this) {
106            return true;
107        }
108        if (super.equals(object) && object instanceof ShipNeedle) {
109            return true;
110        }
111        return false;
112    }
113
114    /**
115     * Returns a clone of this needle.
116     * 
117     * @return A clone.
118     * 
119     * @throws CloneNotSupportedException if the <code>ShipNeedle</code> 
120     *     cannot be cloned (in theory, this should not happen).
121     */
122    public Object clone() throws CloneNotSupportedException {
123        return super.clone();   
124    }
125
126}
127