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 * PointerNeedle.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 * 26-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.GeneralPath;
049import java.awt.geom.Point2D;
050import java.awt.geom.Rectangle2D;
051import java.io.Serializable;
052
053/**
054 * A needle in the shape of a pointer, for use with the
055 * {@link org.jfree.chart.plot.CompassPlot} class.
056 */
057public class PointerNeedle extends MeterNeedle 
058                           implements Cloneable, Serializable {
059
060    /** For serialization. */
061    private static final long serialVersionUID = -4744677345334729606L;
062    
063    /**
064     * Draws the needle.
065     *
066     * @param g2  the graphics device.
067     * @param plotArea  the plot area.
068     * @param rotate  the rotation point.
069     * @param angle  the angle.
070     */
071    protected void drawNeedle(Graphics2D g2, Rectangle2D plotArea, 
072                              Point2D rotate, double angle) {
073
074        GeneralPath shape1 = new GeneralPath();
075        GeneralPath shape2 = new GeneralPath();
076        float minX = (float) plotArea.getMinX();
077        float minY = (float) plotArea.getMinY();
078        float maxX = (float) plotArea.getMaxX();
079        float maxY = (float) plotArea.getMaxY();
080        float midX = (float) (minX + (plotArea.getWidth() / 2));
081        float midY = (float) (minY + (plotArea.getHeight() / 2));
082
083        shape1.moveTo(minX, midY);
084        shape1.lineTo(midX, minY);
085        shape1.lineTo(maxX, midY);
086        shape1.closePath();
087
088        shape2.moveTo(minX, midY);
089        shape2.lineTo(midX, maxY);
090        shape2.lineTo(maxX, midY);
091        shape2.closePath();
092
093        if ((rotate != null) && (angle != 0)) {
094            /// we have rotation huston, please spin me
095            getTransform().setToRotation(angle, rotate.getX(), rotate.getY());
096            shape1.transform(getTransform());
097            shape2.transform(getTransform());
098        }
099
100        if (getFillPaint() != null) {
101            g2.setPaint(getFillPaint());
102            g2.fill(shape1);
103        }
104
105        if (getHighlightPaint() != null) {
106            g2.setPaint(getHighlightPaint());
107            g2.fill(shape2);
108        }
109
110        if (getOutlinePaint() != null) {
111            g2.setStroke(getOutlineStroke());
112            g2.setPaint(getOutlinePaint());
113            g2.draw(shape1);
114            g2.draw(shape2);
115        }
116    }
117
118    /**
119     * Tests another object for equality with this object.
120     * 
121     * @param obj  the object to test (<code>null</code> permitted).
122     * 
123     * @return A boolean.
124     */
125    public boolean equals(Object obj) {
126        if (obj == this) {
127            return true;
128        }
129        if (!(obj instanceof PointerNeedle)) {
130            return false;   
131        }
132        if (!super.equals(obj)) {
133            return false;
134        }
135        return true;
136    }
137
138    /**
139     * Returns a clone of this needle.
140     * 
141     * @return A clone.
142     * 
143     * @throws CloneNotSupportedException if the <code>PointerNeedle</code> 
144     *     cannot be cloned (in theory, this should not happen).
145     */
146    public Object clone() throws CloneNotSupportedException {
147        return super.clone();   
148    }
149
150}