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 * WindNeedle.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 * 09-Sep-2003 : Added equals() method (DG);
040 *
041 */
042
043package org.jfree.chart.needle;
044
045import java.awt.Graphics2D;
046import java.awt.geom.Point2D;
047import java.awt.geom.Rectangle2D;
048import java.io.Serializable;
049
050/**
051 * A needle that indicates wind direction, for use with the
052 * {@link org.jfree.chart.plot.CompassPlot} class.
053 */
054public class WindNeedle extends ArrowNeedle 
055                                implements Cloneable, Serializable {
056
057    /** For serialization. */
058    private static final long serialVersionUID = -2861061368907167834L;
059    
060    /**
061     * Default constructor.
062     */
063    public WindNeedle() {
064        super(false);  // isArrowAtTop
065    }
066
067    /**
068     * Draws the needle.
069     *
070     * @param g2  the graphics device.
071     * @param plotArea  the plot area.
072     * @param rotate  the rotation point.
073     * @param angle  the angle.
074     */
075    protected void drawNeedle(Graphics2D g2, Rectangle2D plotArea, 
076                              Point2D rotate, double angle) {
077
078        super.drawNeedle(g2, plotArea, rotate, angle);
079        if ((rotate != null) && (plotArea != null)) {
080
081            int spacing = getSize() * 3;
082            Rectangle2D newArea = new Rectangle2D.Double();
083
084            Point2D newRotate = rotate;
085            newArea.setRect(plotArea.getMinX() - spacing, plotArea.getMinY(),
086                    plotArea.getWidth(), plotArea.getHeight());
087            super.drawNeedle(g2, newArea, newRotate, angle);
088
089            newArea.setRect(plotArea.getMinX() + spacing, 
090                    plotArea.getMinY(), plotArea.getWidth(), 
091                    plotArea.getHeight());
092            super.drawNeedle(g2, newArea, newRotate, angle);
093
094        }
095    }
096
097    /**
098     * Tests another object for equality with this object.
099     * 
100     * @param object  the object to test.
101     * 
102     * @return A boolean.
103     */
104    public boolean equals(Object object) {
105        if (object == null) {
106            return false;
107        }
108        if (object == this) {
109            return true;
110        }
111        if (super.equals(object) && object instanceof WindNeedle) {
112            return true;
113        }
114        return false;
115    }
116
117}
118