    001/* ===========================================================
    002 * Orson Charts : a 3D chart library for the Java(tm) platform
    003 * ===========================================================
    004 *
    005 * (C)opyright 2013-2016, by Object Refinery Limited.  All rights reserved.
    006 *
    007 * http://www.object-refinery.com/orsoncharts/index.html
    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 com.orsoncharts.interaction.fx;
    034
    035import com.orsoncharts.fx.Chart3DViewer;
    036import com.orsoncharts.graphics3d.RenderedElement;
    037import javafx.event.Event;
    038import javafx.event.EventType;
    039import javafx.scene.input.MouseEvent;
    040
    041/**
    042 * A chart mouse event for the {@link Chart3DViewer} component.
    043 *
    044 * @since 1.4
    045 */
    046public class FXChart3DMouseEvent extends Event {
    047
    048    /** Mouse clicked event type. */
    049    public static final EventType<FXChart3DMouseEvent> MOUSE_CLICKED
    050            = new EventType<FXChart3DMouseEvent>("FXChart3DMouseEvent.CLICKED");
    051
    052    /** Mouse moved event type. */
    053    public static final EventType<FXChart3DMouseEvent> MOUSE_MOVED
    054            = new EventType<FXChart3DMouseEvent>("FXChart3DMouseEvent.MOVED");
    055
    056    /** The chart element under the mouse pointer. */
    057    private final RenderedElement element;
    058
    059    /** The JavaFX mouse event that triggered this event. */
    060    private final MouseEvent trigger;
    061
    062    /**
    063     * Creates a new event.
    064     *
    065     * @param source  the event source.
    066     * @param eventType  the event type.
    067     * @param element  the chart element under the mouse pointer.
    068     * @param trigger  the mouse event that triggered this event.
    069     */
    070    public FXChart3DMouseEvent(Object source,
    071            EventType<? extends Event> eventType,
    072            RenderedElement element, MouseEvent trigger) {
    073        super(eventType);
    074        this.element = element;
    075        this.trigger = trigger;
    076    }
    077
    078    /**
    079     * Returns the chart element under the mouse pointer.
    080     *
    081     * @return The chart element.
    082     */
    083    public RenderedElement getElement() {
    084        return this.element;
    085    }
    086
    087    /**
    088     * Returns the mouse event that triggered this event.
    089     *
    090     * @return The mouse event.
    091     */
    092    public MouseEvent getTrigger() {
    093        return this.trigger;
    094    }
    095}