/* ===========================================================

 * JFreeChart : a free chart library for the Java(tm) platform

 * ===========================================================

 *

 * (C) Copyright 2000-2004, by Object Refinery Limited and Contributors.

 *

 * Project Info:  http://www.jfree.org/jfreechart/index.html

 *

 * This library is free software; you can redistribute it and/or modify it under the terms

 * of the GNU Lesser General Public License as published by the Free Software Foundation;

 * either version 2.1 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;

 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

 * See the GNU Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public License along with this

 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,

 * Boston, MA 02111-1307, USA.

 *

 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 

 * in the United States and other countries.]

 *

 * -----------------

 * NumberAxis3D.java

 * -----------------

 * (C) Copyright 2001-2004, by Serge V. Grachov and Contributors.

 *

 * Original Author:  Serge V. Grachov;

 * Contributor(s):   David Gilbert (for Object Refinery Limited);

 *                   Jonathan Nash;

 *                   Richard Atkinson;

 *                   Tin Luu;

 *

 * $Id: NumberAxis3D.java,v 1.1 2004/08/31 14:30:23 mungady Exp $

 *

 * Changes

 * -------

 * 31-Oct-2001 : Version 1 contributed by Serge V. Grachov (DG);

 * 23-Nov-2001 : Overhauled auto tick unit code for all axes (DG);

 * 12-Dec-2001 : Minor change due to grid lines bug fix (DG);

 * 08-Jan-2002 : Added flag allowing the axis to be 'inverted'.  That is, run from positive to

 *               negative.  Added default values to constructors (DG);

 * 16-Jan-2002 : Added an optional crosshair, based on the implementation by Jonathan Nash (DG);

 * 25-Feb-2002 : Updated constructors for new autoRangeStickyZero flag (DG);

 * 19-Apr-2002 : drawVerticalString(...) is now drawRotatedString(...) in RefineryUtilities (DG);

 * 25-Jun-2002 : Removed redundant import (DG);

 * 25-Jul-2002 : Changed order of parameters in ValueAxis constructor (DG);

 * 06-Aug-2002 : Modified draw method to not draw axis label if label is empty String (RA);

 * 05-Sep-2002 : Updated constructor for changes in the Axis class, and changed draw method to

 *               observe tickMarkPaint (DG);

 * 22-Sep-2002 : Fixed errors reported by Checkstyle (DG);

 * 08-Nov-2002 : Moved to new package com.jrefinery.chart.axis (DG);

 * 20-Jan-2003 : Removed unnecessary constructors (DG);

 * 26-Mar-2003 : Implemented Serializable (DG);

 * 13-May-2003 : Merged HorizontalNumberAxis3D and VerticalNumberAxis3D (DG);

 * 21-Aug-2003 : Updated draw(...) method signature (DG);

 * 07-Nov-2003 : Modified refreshTicks method signature (DG);

 *

 */



package org.jfree.chart.axis;



import java.awt.Graphics2D;

import java.awt.geom.Rectangle2D;

import java.io.Serializable;

import java.util.List;



import org.jfree.chart.Effect3D;

import org.jfree.chart.plot.CategoryPlot;

import org.jfree.chart.plot.PlotRenderingInfo;

import org.jfree.ui.RectangleEdge;



/**

 * A standard linear value axis, for values displayed vertically.

 *

 * @author Serge V. Grachov

 */

public class NumberAxis3D extends NumberAxis implements Serializable {



    /**

     * Default constructor.

     */

    public NumberAxis3D() {

        this(null);    

    }

    

    /**

     * Constructs a new axis.

     *

     * @param label  the axis label (<code>null</code> permitted).

     */

    public NumberAxis3D(String label) {

        super(label);

        setAxisLineVisible(false);

    }



    /**

     * Draws the axis on a Java 2D graphics device (such as the screen or a printer).

     *

     * @param g2  the graphics device.

     * @param cursor  the cursor.

     * @param plotArea  the area for drawing the axes and data.

     * @param dataArea  the area for drawing the data (a subset of the plotArea).

     * @param edge  the axis location.

     * @param plotState  collects information about the plot (<code>null</code> permitted).

     * 

     * @return The updated cursor value.

     */

    public AxisState draw(Graphics2D g2, 

                          double cursor,

                          Rectangle2D plotArea, 

                          Rectangle2D dataArea, 

                          RectangleEdge edge,

                          PlotRenderingInfo plotState) {



        // if the axis is not visible, don't draw it...

        if (!isVisible()) {

            AxisState state = new AxisState(cursor);

            // even though the axis is not visible, we need ticks for the gridlines...

            List ticks = refreshTicks(g2, state, plotArea, dataArea, edge); 

            state.setTicks(ticks);

            return state;

        }



        // calculate the adjusted data area taking into account the 3D effect...

        CategoryPlot plot = (CategoryPlot) getPlot();



        Effect3D e3D = (Effect3D) plot.getRenderer();

        double adjustedX = dataArea.getMinX();

        double adjustedY = dataArea.getMinY();

        double adjustedW = dataArea.getWidth() - e3D.getXOffset();

        double adjustedH = dataArea.getHeight() - e3D.getYOffset();



        if (edge == RectangleEdge.LEFT || edge == RectangleEdge.BOTTOM) {

            adjustedY += e3D.getYOffset();

        }

        else if (edge == RectangleEdge.RIGHT || edge == RectangleEdge.TOP) {

            adjustedX += e3D.getXOffset();

        }

        Rectangle2D adjustedDataArea = new Rectangle2D.Double(adjustedX, adjustedY,

                                                              adjustedW, adjustedH);



        // draw the tick marks and labels...

        AxisState info = drawTickMarksAndLabels(g2, cursor, plotArea, adjustedDataArea, edge);

       

        // draw the axis label...

        info = drawLabel(getLabel(), g2, plotArea, dataArea, edge, info);



        return info;

        

    }



}

