org.refcodes.graphical.ext.javafx.impls.FxDragSpriteEventHandlerImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of refcodes-graphical-ext-javafx Show documentation
Artifact with JavaFX based extensions of the refcodes-graphical artifact.
There is a newer version: 3.3.9
Show newest version
// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// /////////////////////////////////////////////////////////////////////////////
// This code is copyright (c) by Siegfried Steiner, Munich, Germany and licensed
// under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// -----------------------------------------------------------------------------
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// -----------------------------------------------------------------------------
// Apache License, v2.0 ("http://www.apache.org/licenses/LICENSE-2.0")
// -----------------------------------------------------------------------------
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////

package org.refcodes.graphical.ext.javafx.impls;

import org.refcodes.graphical.Dimension;
import org.refcodes.graphical.FieldDimension;
import org.refcodes.graphical.GraphicalConsts;
import org.refcodes.graphical.MoveMode;
import org.refcodes.graphical.ext.javafx.FxDragSpriteEventHandler;
import org.refcodes.logger.RuntimeLogger;
import org.refcodes.logger.impls.RuntimeLoggerFactorySingleton;

import javafx.animation.TranslateTransition;
import javafx.application.Platform;
import javafx.event.EventHandler;
import javafx.scene.Node;
import javafx.scene.input.MouseEvent;
import javafx.scene.layout.Pane;
import javafx.util.Duration;

public class FxDragSpriteEventHandlerImpl implements FxDragSpriteEventHandler {

	private static RuntimeLogger LOGGER = RuntimeLoggerFactorySingleton.createRuntimeLogger();

	// /////////////////////////////////////////////////////////////////////////
	// VARIABLES:
	// /////////////////////////////////////////////////////////////////////////

	private double _sceneX;
	private double _sceneY;
	public double _posX;
	private double _posY;
	private Node _sprite;
	private Pane _scene;
	private int _fieldWidth = 1;
	private int _fieldHeight = 1;
	private int _fieldGap = 0;
	private double _prevOpacity = 1;
	private double _dragOpacity = GraphicalConsts.DEFAULT_DRAG_OPACITY;
	private MoveMode _moveMode = MoveMode.SMOOTH;
	private int _offsetY = 0;
	private int _offsetX = 0;

	// /////////////////////////////////////////////////////////////////////////
	// CONSTRUCTORS:
	// /////////////////////////////////////////////////////////////////////////

	public FxDragSpriteEventHandlerImpl( Node aSprite, Pane aScene ) {
		aSprite.setOnMousePressed( _onMousePressedEventHandler );
		aSprite.setOnMouseDragged( _onMouseDraggedEventHandler );
		aSprite.setOnMouseReleased( _onMouseReleasedEventHandler );
		_sprite = aSprite;
		_scene = aScene;
	}

	// /////////////////////////////////////////////////////////////////////////
	// METHODS:
	// /////////////////////////////////////////////////////////////////////////

	@Override
	public int getFieldWidth() {
		return _fieldWidth;
	}

	@Override
	public int getFieldHeight() {
		return _fieldHeight;
	}

	@Override
	public int getFieldGap() {
		return _fieldGap;
	}

	@Override
	public void setFieldWidth( int aWidth ) {
		_fieldWidth = aWidth;
	}

	@Override
	public FxDragSpriteEventHandlerImpl withFieldWidth( int aWidth ) {
		_fieldWidth = aWidth;
		return this;
	}

	@Override
	public void setFieldHeight( int aHeight ) {
		_fieldHeight = aHeight;
	}

	@Override
	public int getOffsetX() {
		return _offsetX;
	}

	@Override
	public int getOffsetY() {
		return _offsetY;
	}

	@Override
	public FxDragSpriteEventHandlerImpl withFieldHeight( int aHeight ) {
		_fieldHeight = aHeight;
		return this;
	}

	@Override
	public FxDragSpriteEventHandlerImpl withFieldDimension( int aWidth, int aHeight ) {
		setFieldDimension( aWidth, aHeight );
		return this;
	}

	@Override
	public FxDragSpriteEventHandlerImpl withFieldDimension( int aWidth, int aHeight, int aGap ) {
		setFieldDimension( aWidth, aHeight, aGap );
		return this;
	}

	@Override
	public FxDragSpriteEventHandlerImpl withFieldDimension( FieldDimension aDimension ) {
		setFieldDimension( aDimension );
		return this;
	}

	@Override
	public void setFieldDimension( int aWidth, int aHeight ) {
		_fieldWidth = aWidth;
		_fieldHeight = aHeight;
	}

	@Override
	public void setFieldDimension( int aWidth, int aHeight, int aGap ) {
		_fieldWidth = aWidth;
		_fieldHeight = aHeight;
		_fieldGap = aGap;
	}

	@Override
	public void setFieldDimension( FieldDimension aDimension ) {
		_fieldWidth = aDimension.getFieldWidth();
		_fieldHeight = aDimension.getFieldHeight();
		_fieldGap = aDimension.getFieldGap();
	}

	@Override
	public FxDragSpriteEventHandlerImpl withFieldDimension( Dimension aDimension ) {
		setFieldDimension( aDimension.getWidth(), aDimension.getHeight() );
		return this;
	}

	@Override
	public void setFieldDimension( Dimension aDimension ) {
		_fieldWidth = aDimension.getWidth();
		_fieldHeight = aDimension.getHeight();
	}

	@Override
	public void setFieldGap( int aFieldGap ) {
		_fieldGap = aFieldGap;

	}

	@Override
	public FxDragSpriteEventHandlerImpl withFieldGap( int aFieldGap ) {
		setFieldGap( aFieldGap );
		return this;
	}

	@Override
	public double getDragOpacity() {
		return _dragOpacity;
	}

	@Override
	public void setDragOpacity( double aOpacity ) {
		_dragOpacity = aOpacity;

	}

	@Override
	public FxDragSpriteEventHandler withDragOpacity( double aOpacity ) {
		setDragOpacity( aOpacity );
		return this;
	}

	@Override
	public Node getSprite() {
		return _sprite;
	}

	@Override
	public MoveMode getMoveMode() {
		return _moveMode;
	}

	@Override
	public void setMoveMode( MoveMode aMoveMode ) {
		_moveMode = aMoveMode;

	}

	@Override
	public FxDragSpriteEventHandler withMoveMode( MoveMode aMoveMode ) {
		setMoveMode( aMoveMode );
		return this;
	}

	// /////////////////////////////////////////////////////////////////////////
	// LIFECYCLE:
	// /////////////////////////////////////////////////////////////////////////

	@Override
	public void dispose() {
		_sprite.setOnMousePressed( null );
		_sprite.setOnMouseDragged( null );
		_sprite.setOnMouseReleased( null );
		_sprite = null;
	}

	// /////////////////////////////////////////////////////////////////////////
	// EVENT-HANDLER:
	// /////////////////////////////////////////////////////////////////////////

	private EventHandler _onMousePressedEventHandler = new EventHandler() {
		@Override
		public void handle( MouseEvent aEvent ) {
			Node theSprite = (Node) (aEvent.getSource());
			_prevOpacity = theSprite.getOpacity();
			theSprite.setOpacity( _dragOpacity );
			_sceneX = aEvent.getSceneX();
			_sceneY = aEvent.getSceneY();
			_posX = theSprite.getTranslateX();
			_posY = theSprite.getTranslateY();
			LOGGER.debug( "Sprite mouse press X := " + aEvent.getSceneX() );
			LOGGER.debug( "Sprite mouse press Y := " + aEvent.getSceneY() );
			aEvent.consume();
		}
	};

	private EventHandler _onMouseDraggedEventHandler = new EventHandler() {
		@Override
		public void handle( MouseEvent aEvent ) {
			Node theSprite = (Node) (aEvent.getSource());
			double theSceneOffsetX = aEvent.getSceneX() - _sceneX;
			double theSceneOffsetY = aEvent.getSceneY() - _sceneY;
			double theTranslateX = _posX + theSceneOffsetX;
			double theTranslateY = _posY + theSceneOffsetY;

			switch ( _moveMode ) {
			case SMOOTH:
				theTranslateX = toBoundsX( theTranslateX, theSprite );
				theTranslateY = toBoundsY( theTranslateY, theSprite );
				break;
			case JUMPY:
				theTranslateX = toSnapX( theTranslateX, theSprite );
				theTranslateY = toSnapY( theTranslateY, theSprite );
				break;
			}

			theSprite.setTranslateX( theTranslateX );
			theSprite.setTranslateY( theTranslateY );

			_offsetX = (int) Math.round( theTranslateX / (getFieldWidth() + getFieldGap()) );
			_offsetY = (int) Math.round( theTranslateY / (getFieldHeight() + getFieldGap()) );

			aEvent.consume();
		}
	};

	private EventHandler _onMouseReleasedEventHandler = new EventHandler() {
		@Override
		public void handle( MouseEvent aEvent ) {
			Node theSprite = (Node) (aEvent.getSource());
			double theSceneOffsetX = aEvent.getSceneX() - _sceneX;
			double theSceneOffsetY = aEvent.getSceneY() - _sceneY;
			double theTranslateX = _posX + theSceneOffsetX;
			double theTranslateY = _posY + theSceneOffsetY;
			final double theToX = toSnapX( theTranslateX, theSprite );
			final double theToY = toSnapY( theTranslateY, theSprite );

			theSprite.setOpacity( _prevOpacity );

			switch ( _moveMode ) {
			case SMOOTH:
				Runnable theRunner = new Runnable() {
					@Override
					public void run() {
						TranslateTransition theTransition = new TranslateTransition( Duration.millis( 150 ), theSprite );
						theTransition.setToX( theToX );
						theTransition.setToY( theToY );
						theTransition.setCycleCount( 1 );
						theTransition.setAutoReverse( false );
						theTransition.play();
					}
				};
				if ( Platform.isFxApplicationThread() ) {
					theRunner.run();
				}
				else {
					Platform.runLater( theRunner );
				}
				break;
			case JUMPY:
				theSprite.setTranslateX( theToX );
				theSprite.setTranslateY( theToY );
				break;
			}

			LOGGER.debug( "Sprite mouse release X := " + aEvent.getSceneX() );
			LOGGER.debug( "Sprite mouse release Y := " + aEvent.getSceneY() );
			LOGGER.debug( "Sprite mouse release offset X := " + theSceneOffsetX );
			LOGGER.debug( "Sprite mouse release offset Y := " + theSceneOffsetY );
			LOGGER.debug( "Sprite translate X := " + theTranslateX );
			LOGGER.debug( "Sprite translate Y := " + theTranslateY );
			aEvent.consume();
		}
	};

	// /////////////////////////////////////////////////////////////////////////
	// HELPER:
	// /////////////////////////////////////////////////////////////////////////

	private double toBoundsX( double aTranslateX, Node aSprite ) {
		return toBounds( aTranslateX, aSprite.getBoundsInParent().getWidth(), _scene.getWidth() );
	}

	private double toBoundsY( double aTranslateY, Node aSprite ) {
		return toBounds( aTranslateY, aSprite.getBoundsInParent().getHeight(), _scene.getHeight() );
	}

	private double toBounds( double aTranslateSize, double aSpriteSize, double aBackgroundSize ) {
		// The sprite (=sprite) is smaller than the scene:
		if ( aSpriteSize < aBackgroundSize ) {
			if ( aSpriteSize + aTranslateSize > aBackgroundSize ) aTranslateSize = aBackgroundSize - aSpriteSize;
			if ( aTranslateSize < 0 ) aTranslateSize = 0;
		}
		// The sprite (=background) is larger than the scene:
		else {
			if ( aSpriteSize + aTranslateSize < aBackgroundSize ) aTranslateSize = aBackgroundSize - aSpriteSize;
			if ( aTranslateSize > 0 ) aTranslateSize = 0;
		}
		return aTranslateSize;
	}

	private double toSnapX( double aTranslateX, Node aSprite ) {
		return toSnap( aTranslateX, aSprite.getBoundsInParent().getWidth(), getFieldWidth(), _scene.getWidth() );
	}

	private double toSnapY( double aTranslateY, Node aSprite ) {
		return toSnap( aTranslateY, aSprite.getBoundsInParent().getHeight(), getFieldHeight(), _scene.getHeight() );
	}

	private double toSnap( double aTranslateSize, double aSpriteSize, int aFieldSize, double aBackgroundSize ) {
		if ( aSpriteSize > aBackgroundSize && aSpriteSize + aTranslateSize == aBackgroundSize ) { return aTranslateSize; }
		return toBounds( Math.round( aTranslateSize / (aFieldSize + getFieldGap()) ) * (aFieldSize + getFieldGap()), aSpriteSize, aBackgroundSize );
	}
}