001/* ===========================================================
002 * Orson Charts : a 3D chart library for the Java(tm) platform
003 * ===========================================================
004 * 
005 * (C)opyright 2013-2022, by David Gilbert.  All rights reserved.
006 * 
007 * https://github.com/jfree/orson-charts
008 * 
009 * This program is free software: you can redistribute it and/or modify
010 * it under the terms of the GNU General Public License as published by
011 * the Free Software Foundation, either version 3 of the License, or
012 * (at your option) any later version.
013 *
014 * This program is distributed in the hope that it will be useful,
015 * but WITHOUT ANY WARRANTY; without even the implied warranty of
016 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
017 * GNU General Public License for more details.
018 *
019 * You should have received a copy of the GNU General Public License
020 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
021 * 
022 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
023 * Other names may be trademarks of their respective owners.]
024 * 
025 * If you do not wish to be bound by the terms of the GPL, an alternative
026 * commercial license can be purchased.  For details, please see visit the
027 * Orson Charts home page:
028 * 
029 * http://www.object-refinery.com/orsoncharts/index.html
030 * 
031 */
032
033package org.jfree.chart3d.graphics3d.swing;
034
035import java.awt.event.ActionEvent;
036
037import javax.swing.AbstractAction;
038import javax.swing.Action;
039
040import org.jfree.chart3d.Resources;
041import org.jfree.chart3d.internal.Args;
042
043/**
044 * An action that handles rolling the 3D view clockwise around an
045 * axis from the viewing point to the origin.
046 * <br><br>
047 * NOTE: This class is serializable, but the serialization format is subject 
048 * to change in future releases and should not be relied upon for persisting 
049 * instances of this class. 
050 */
051@SuppressWarnings("serial")
052public class RollRightAction extends AbstractAction {
053
054    private final Panel3D panel;
055  
056    /**
057     * Creates a new action instance.
058     * 
059     * @param panel  the panel ({@code null} not permitted). 
060     */
061    public RollRightAction(Panel3D panel) {
062        super("\uF064");
063        Args.nullNotPermitted(panel, "panel");
064        this.panel = panel;
065        putValue(Action.SHORT_DESCRIPTION, 
066                Resources.localString("ROLL_RIGHT_ACTION_SHORT_DESCRIPTION"));
067    }
068
069    /**
070     * Rotates the orientation of the view point and repaints the panel.
071     * 
072     * @param e  the action event.
073     */
074    @Override
075    public void actionPerformed(ActionEvent e) {
076        this.panel.getViewPoint().roll(this.panel.getRollIncrement());
077        this.panel.repaint();
078    }
079    
080}