
eu.mihosoft.jcsg.ext.openjfx.utils3d.DragSupport Maven / Gradle / Ivy
/*
* Copyright (c) 2010, 2014, Oracle and/or its affiliates.
* All rights reserved. Use is subject to license terms.
*
* This file is available and licensed under the following license:
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the distribution.
* - Neither the name of Oracle Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package eu.mihosoft.jcsg.ext.openjfx.utils3d;
import javafx.beans.property.Property;
import javafx.event.EventHandler;
import javafx.geometry.Orientation;
import javafx.scene.Scene;
import javafx.scene.input.KeyCode;
import javafx.scene.input.KeyEvent;
import javafx.scene.input.MouseButton;
import javafx.scene.input.MouseEvent;
/**
* Utility class that binds simple mouse gestures to number properties so that
* their values can be controlled with mouse drag events.
*/
public class DragSupport {
public EventHandler keyboardEventHandler;
public EventHandler mouseEventHandler;
private Number anchor;
private double dragAnchor;
private MouseEvent lastMouseEvent;
private Scene target;
/**
* Creates DragSupport instance that attaches EventHandlers to the given scene
* and responds to mouse and keyboard events in order to change given
* property values according to mouse drag events of given orientation
* @param target scene
* @param modifier null if no modifier needed
* @param orientation vertical or horizontal
* @param property number property to control
* @see #DragSupport(javafx.scene.Scene, javafx.scene.input.KeyCode, javafx.geometry.Orientation, javafx.beans.property.Property, double)
*/
public DragSupport(Scene target, final KeyCode modifier, final Orientation orientation, final Property property) {
this(target, modifier, MouseButton.PRIMARY, orientation, property, 1);
}
public DragSupport(Scene target, final KeyCode modifier, MouseButton mouseButton, final Orientation orientation, final Property property) {
this(target, modifier, mouseButton, orientation, property, 1);
}
/**
* Removes event handlers of this DragSupport instance from the target scene
*/
public void detach() {
target.removeEventHandler(MouseEvent.ANY, mouseEventHandler);
target.removeEventHandler(KeyEvent.ANY, keyboardEventHandler);
}
/**
* Creates DragSupport instance that attaches EventHandlers to the given scene
* and responds to mouse and keyboard events in order to change given
* property values according to mouse drag events of given orientation.
* Mouse movement amount is multiplied by given factor.
* @param target scene
* @param modifier null if no modifier needed
* @param orientation vertical or horizontal
* @param property number property to control
* @param factor multiplier for mouse movement amount
*/
public DragSupport(Scene target, final KeyCode modifier, final Orientation orientation, final Property property, final double factor) {
this(target, modifier, MouseButton.PRIMARY, orientation, property, factor);
}
public DragSupport(Scene target, final KeyCode modifier, final MouseButton mouseButton, final Orientation orientation, final Property property, final double factor) {
this.target = target;
mouseEventHandler = t -> {
if (t.getEventType() != MouseEvent.MOUSE_ENTERED_TARGET
&& t.getEventType() != MouseEvent.MOUSE_EXITED_TARGET) {
lastMouseEvent = t;
}
if (t.getEventType() == MouseEvent.MOUSE_PRESSED) {
if (t.getButton() == mouseButton
&& isModifierCorrect(t, modifier)) {
anchor = property.getValue();
dragAnchor = getCoord(t, orientation);
t.consume();
}
} else if (t.getEventType() == MouseEvent.MOUSE_DRAGGED) {
if (t.getButton() == mouseButton
&& isModifierCorrect(t, modifier)) {
property.setValue(anchor.doubleValue()
+ (getCoord(t, orientation) - dragAnchor) * factor);
t.consume();
}
}
};
keyboardEventHandler = t -> {
if (t.getEventType() == KeyEvent.KEY_PRESSED) {
if (t.getCode() == modifier) {
anchor = property.getValue();
if (lastMouseEvent != null) {
dragAnchor = getCoord(lastMouseEvent, orientation);
}
t.consume();
}
} else if (t.getEventType() == KeyEvent.KEY_RELEASED) {
if (t.getCode() != modifier && isModifierCorrect(t, modifier)) {
anchor = property.getValue();
if (lastMouseEvent != null) {
dragAnchor = getCoord(lastMouseEvent, orientation);
}
t.consume();
}
}
};
target.addEventHandler(MouseEvent.ANY, mouseEventHandler);
target.addEventHandler(KeyEvent.ANY, keyboardEventHandler);
}
private boolean isModifierCorrect(KeyEvent t, KeyCode keyCode) {
return (keyCode != KeyCode.ALT ^ t.isAltDown())
&& (keyCode != KeyCode.CONTROL ^ t.isControlDown())
&& (keyCode != KeyCode.SHIFT ^ t.isShiftDown())
&& (keyCode != KeyCode.META ^ t.isMetaDown());
}
private boolean isModifierCorrect(MouseEvent t, KeyCode keyCode) {
return (keyCode != KeyCode.ALT ^ t.isAltDown())
&& (keyCode != KeyCode.CONTROL ^ t.isControlDown())
&& (keyCode != KeyCode.SHIFT ^ t.isShiftDown())
&& (keyCode != KeyCode.META ^ t.isMetaDown());
}
private double getCoord(MouseEvent t, Orientation orientation) {
switch (orientation) {
case HORIZONTAL:
return t.getScreenX();
case VERTICAL:
return t.getScreenY();
default:
throw new IllegalArgumentException("This orientation is not supported: " + orientation);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy