Source for org.jfree.chart.needle.ShipNeedle

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * ---------------
  28:  * ShipNeedle.java
  29:  * ---------------
  30:  * (C) Copyright 2002-2007, by the Australian Antarctic Division and 
  31:  *                          Contributors.
  32:  *
  33:  * Original Author:  Bryan Scott (for the Australian Antarctic Division);
  34:  * Contributor(s):   David Gilbert (for Object Refinery Limited);
  35:  *
  36:  * Changes:
  37:  * --------
  38:  * 25-Sep-2002 : Version 1, contributed by Bryan Scott (DG);
  39:  * 27-Mar-2003 : Implemented Serializable (DG);
  40:  * 09-Sep-2003 : Added equals() method (DG);
  41:  * 08-Jun-2005 : Implemented Cloneable (DG);
  42:  * 22-Nov-2007 : Implemented hashCode() (DG);
  43:  *
  44:  */
  45: 
  46: package org.jfree.chart.needle;
  47: 
  48: import java.awt.Graphics2D;
  49: import java.awt.geom.Arc2D;
  50: import java.awt.geom.GeneralPath;
  51: import java.awt.geom.Point2D;
  52: import java.awt.geom.Rectangle2D;
  53: import java.io.Serializable;
  54: 
  55: /**
  56:  * A needle in the shape of a ship, for use with the 
  57:  * {@link org.jfree.chart.plot.CompassPlot} class.
  58:  */
  59: public class ShipNeedle extends MeterNeedle 
  60:                         implements Cloneable, Serializable {
  61: 
  62:     /** For serialization. */
  63:     private static final long serialVersionUID = 149554868169435612L;
  64:     
  65:     /**
  66:      * Draws the needle.
  67:      *
  68:      * @param g2  the graphics device.
  69:      * @param plotArea  the plot area.
  70:      * @param rotate  the rotation point.
  71:      * @param angle  the angle.
  72:      */
  73:     protected void drawNeedle(Graphics2D g2, Rectangle2D plotArea, 
  74:                               Point2D rotate, double angle) {
  75: 
  76:         GeneralPath shape = new GeneralPath();
  77:         shape.append(new Arc2D.Double(-9.0, -7.0, 10, 14, 0.0, 25.5, 
  78:                 Arc2D.OPEN), true);
  79:         shape.append(new Arc2D.Double(0.0, -7.0, 10, 14, 154.5, 25.5, 
  80:                 Arc2D.OPEN), true);
  81:         shape.closePath();
  82:         getTransform().setToTranslation(plotArea.getMinX(), plotArea.getMaxY());
  83:         getTransform().scale(plotArea.getWidth(), plotArea.getHeight() / 3);
  84:         shape.transform(getTransform());
  85: 
  86:         if ((rotate != null) && (angle != 0)) {
  87:             /// we have rotation
  88:             getTransform().setToRotation(angle, rotate.getX(), rotate.getY());
  89:             shape.transform(getTransform());
  90:         }
  91: 
  92:         defaultDisplay(g2, shape);
  93:     }
  94: 
  95:     /**
  96:      * Tests another object for equality with this object.
  97:      * 
  98:      * @param object  the object to test.
  99:      * 
 100:      * @return A boolean.
 101:      */
 102:     public boolean equals(Object object) {
 103:         if (object == null) {
 104:             return false;
 105:         }
 106:         if (object == this) {
 107:             return true;
 108:         }
 109:         if (super.equals(object) && object instanceof ShipNeedle) {
 110:             return true;
 111:         }
 112:         return false;
 113:     }
 114: 
 115:     /**
 116:      * Returns a hash code for this instance.
 117:      * 
 118:      * @return A hash code.
 119:      */
 120:     public int hashCode() {
 121:         return super.hashCode();
 122:     }
 123: 
 124:     /**
 125:      * Returns a clone of this needle.
 126:      * 
 127:      * @return A clone.
 128:      * 
 129:      * @throws CloneNotSupportedException if the <code>ShipNeedle</code> 
 130:      *     cannot be cloned (in theory, this should not happen).
 131:      */
 132:     public Object clone() throws CloneNotSupportedException {
 133:         return super.clone();   
 134:     }
 135: 
 136: }
 137: