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 * PinNeedle.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.Area;
049import java.awt.geom.Ellipse2D;
050import java.awt.geom.GeneralPath;
051import java.awt.geom.Point2D;
052import java.awt.geom.Rectangle2D;
053import java.io.Serializable;
054
055/**
056 * A needle that is drawn as a pin shape.
057 */
058public class PinNeedle extends MeterNeedle 
059                       implements Cloneable, Serializable {
060
061    /** For serialization. */
062    private static final long serialVersionUID = -3787089953079863373L;
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        Area shape;
076        GeneralPath pointer = new GeneralPath();
077
078        int minY = (int) (plotArea.getMinY());
079        //int maxX = (int) (plotArea.getMaxX());
080        int maxY = (int) (plotArea.getMaxY());
081        int midX = (int) (plotArea.getMinX() + (plotArea.getWidth() / 2));
082        //int midY = (int) (plotArea.getMinY() + (plotArea.getHeight() / 2));
083        int lenX = (int) (plotArea.getWidth() / 10);
084        if (lenX < 2) {
085            lenX = 2;
086        }
087
088        pointer.moveTo(midX - lenX, maxY - lenX);
089        pointer.lineTo(midX + lenX, maxY - lenX);
090        pointer.lineTo(midX, minY + lenX);
091        pointer.closePath();
092
093        lenX = 4 * lenX;
094        Ellipse2D circle = new Ellipse2D.Double(midX - lenX / 2, 
095                plotArea.getMaxY() - lenX, lenX, lenX);
096
097        shape = new Area(circle);
098        shape.add(new Area(pointer));
099        if ((rotate != null) && (angle != 0)) {
100            /// we have rotation
101            getTransform().setToRotation(angle, rotate.getX(), rotate.getY());
102            shape.transform(getTransform());
103        }
104
105        defaultDisplay(g2, shape);
106
107    }
108
109    /**
110     * Tests another object for equality with this object.
111     * 
112     * @param obj  the object to test (<code>null</code> permitted).
113     * 
114     * @return A boolean.
115     */
116    public boolean equals(Object obj) {
117        if (obj == this) {
118            return true;
119        }
120        if (!(obj instanceof PinNeedle)) {
121            return false;   
122        }
123        if (!super.equals(obj)) {
124            return false;
125        }
126        return true;
127    }
128    
129    /**
130     * Returns a clone of this needle.
131     * 
132     * @return A clone.
133     * 
134     * @throws CloneNotSupportedException if the <code>PinNeedle</code> 
135     *     cannot be cloned (in theory, this should not happen).
136     */
137    public Object clone() throws CloneNotSupportedException {
138        return super.clone();   
139    }
140
141}