Source for org.jfree.chart.plot.dial.DialScale

   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:  * DialScale.java
  29:  * --------------
  30:  * (C) Copyright 2006-2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 03-Nov-2006 : Version 1 (DG);
  38:  * 17-Oct-2007 : Made this an extension of the DialLayer interface (DG);
  39:  * 
  40:  */
  41: 
  42: package org.jfree.chart.plot.dial;
  43: 
  44: /**
  45:  * A dial scale is a specialised layer that has the ability to convert data 
  46:  * values into angles.
  47:  * 
  48:  * @since 1.0.7
  49:  */
  50: public interface DialScale extends DialLayer {
  51:     
  52:     /**
  53:      * Converts a data value to an angle (in degrees, using the same 
  54:      * specification as Java's Arc2D class).
  55:      *
  56:      * @param value  the data value.
  57:      *
  58:      * @return The angle in degrees.
  59:      * 
  60:      * @see #angleToValue(double)
  61:      */
  62:     public double valueToAngle(double value);
  63:     
  64:     /**
  65:      * Converts an angle (in degrees) to a data value.
  66:      *
  67:      * @param angle  the angle (in degrees).
  68:      *
  69:      * @return The data value.
  70:      * 
  71:      * @see #valueToAngle(double)
  72:      */
  73:     public double angleToValue(double angle);
  74:     
  75: }