001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2022, by David Gilbert 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 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * -------------
028 * Rotation.java
029 * -------------
030 * (C) Copyright 2000-2022, by David Gilbert and Contributors.
031 *
032 * Original Author:  David Gilbert;
033 * Contributors:     -;
034 */
035
036package org.jfree.chart.api;
037
038/**
039 * Represents a direction of rotation ({@code CLOCKWISE} or 
040 * {@code ANTICLOCKWISE}).
041 */
042public enum Rotation {
043
044    /** Clockwise. */
045    CLOCKWISE(-1.0),
046
047    /** The reverse order renders the primary dataset first. */
048    ANTICLOCKWISE(1.0);
049
050    /**
051     * The factor (-1.0 for {@code CLOCKWISE} and 1.0 for
052     * {@code ANTICLOCKWISE}).
053     */
054    private final double factor;
055
056    /**
057     * Private constructor.
058     *
059     * @param factor  the rotation factor.
060     */
061    Rotation(double factor) {
062        this.factor = factor;
063    }
064
065    /**
066     * Returns the rotation factor, which is -1.0 for {@code CLOCKWISE}
067     * and 1.0 for {@code ANTICLOCKWISE}.
068     *
069     * @return the rotation factor.
070     */
071    public double getFactor() {
072        return this.factor;
073    }
074}
075