Java tutorial
/* * Copyright (c) 2010, 2017, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package javafx.animation; import javafx.beans.property.DoubleProperty; import javafx.beans.property.ObjectProperty; import javafx.beans.property.ObjectPropertyBase; import javafx.beans.property.SimpleDoubleProperty; import javafx.beans.property.SimpleObjectProperty; import javafx.scene.Node; import javafx.util.Duration; /** * This {@code Transition} creates a move/translate animation that spans its * {@link #durationProperty() duration}. This is done by updating the {@code translateX}, * {@code translateY} and {@code translateZ} variables of the {@code node} at * regular interval. * <p> * It starts from the ({@code fromX}, {@code fromY}, {@code fromZ}) value if * provided else uses the {@code node}'s ({@code translateX}, {@code translateY}, {@code translateZ}) value. * <p> * It stops at the ({@code toX}, {@code toY}, {@code toZ}) value if provided * else it will use start value plus ({@code byX}, {@code byY}, {@code byZ}) * value. * <p> * The ({@code toX}, {@code toY}, {@code toZ}) value takes precedence if both ( * {@code toX}, {@code toY}, {@code toZ}) and ({@code byX}, {@code byY}, * {@code byZ}) values are specified. * * <p> * Code Segment Example: * </p> * * <pre> * <code> * import javafx.scene.shape.*; * import javafx.animation.*; * * ... * * Rectangle rect = new Rectangle (100, 40, 100, 100); * rect.setArcHeight(50); * rect.setArcWidth(50); * rect.setFill(Color.VIOLET); * * TranslateTransition tt = new TranslateTransition(Duration.millis(2000), rect); * tt.setByX(200f); * tt.setCycleCount(4f); * tt.setAutoReverse(true); * * tt.play(); * * ... * * </code> * </pre> * * @see Transition * @see Animation * * @since JavaFX 2.0 */ public final class TranslateTransition extends Transition { private static final double EPSILON = 1e-12; private double startX; private double startY; private double startZ; private double deltaX; private double deltaY; private double deltaZ; /** * The target node of this {@code TranslateTransition}. * <p> * It is not possible to change the target {@code node} of a running * {@code TranslateTransition}. If the value of {@code node} is changed for * a running {@code TranslateTransition}, the animation has to be stopped * and started again to pick up the new value. */ private ObjectProperty<Node> node; private static final Node DEFAULT_NODE = null; public final void setNode(Node value) { if ((node != null) || (value != null /* DEFAULT_NODE */)) { nodeProperty().set(value); } } public final Node getNode() { return (node == null) ? DEFAULT_NODE : node.get(); } public final ObjectProperty<Node> nodeProperty() { if (node == null) { node = new SimpleObjectProperty<Node>(this, "node", DEFAULT_NODE); } return node; } private Node cachedNode; /** * The duration of this {@code TranslateTransition}. * <p> * It is not possible to change the {@code duration} of a running * {@code TranslateTransition}. If the value of {@code duration} is changed * for a running {@code TranslateTransition}, the animation has to be * stopped and started again to pick up the new value. * <p> * Note: While the unit of {@code duration} is a millisecond, the * granularity depends on the underlying operating system and will in * general be larger. For example animations on desktop systems usually run * with a maximum of 60fps which gives a granularity of ~17 ms. * * Setting duration to value lower than {@link Duration#ZERO} will result * in {@link IllegalArgumentException}. * * @defaultValue 400ms */ private ObjectProperty<Duration> duration; private static final Duration DEFAULT_DURATION = Duration.millis(400); public final void setDuration(Duration value) { if ((duration != null) || (!DEFAULT_DURATION.equals(value))) { durationProperty().set(value); } } public final Duration getDuration() { return (duration == null) ? DEFAULT_DURATION : duration.get(); } public final ObjectProperty<Duration> durationProperty() { if (duration == null) { duration = new ObjectPropertyBase<Duration>(DEFAULT_DURATION) { @Override public void invalidated() { try { setCycleDuration(getDuration()); } catch (IllegalArgumentException e) { if (isBound()) { unbind(); } set(getCycleDuration()); throw e; } } @Override public Object getBean() { return TranslateTransition.this; } @Override public String getName() { return "duration"; } }; } return duration; } /** * Specifies the start X coordinate value of this * {@code TranslateTransition}. * <p> * It is not possible to change {@code fromX} of a running * {@code TranslateTransition}. If the value of {@code fromX} is changed for * a running {@code TranslateTransition}, the animation has to be stopped * and started again to pick up the new value. * * @defaultValue {@code Double.NaN} */ private DoubleProperty fromX; private static final double DEFAULT_FROM_X = Double.NaN; public final void setFromX(double value) { if ((fromX != null) || (!Double.isNaN(value))) { fromXProperty().set(value); } } public final double getFromX() { return (fromX == null) ? DEFAULT_FROM_X : fromX.get(); } public final DoubleProperty fromXProperty() { if (fromX == null) { fromX = new SimpleDoubleProperty(this, "fromX", DEFAULT_FROM_X); } return fromX; } /** * Specifies the start Y coordinate value of this * {@code TranslateTransition}. * <p> * It is not possible to change {@code fromY} of a running * {@code TranslateTransition}. If the value of {@code fromY} is changed for * a running {@code TranslateTransition}, the animation has to be stopped * and started again to pick up the new value. * * @defaultValue {@code Double.NaN} */ private DoubleProperty fromY; private static final double DEFAULT_FROM_Y = Double.NaN; public final void setFromY(double value) { if ((fromY != null) || (!Double.isNaN(value))) { fromYProperty().set(value); } } public final double getFromY() { return (fromY == null) ? DEFAULT_FROM_Y : fromY.get(); } public final DoubleProperty fromYProperty() { if (fromY == null) { fromY = new SimpleDoubleProperty(this, "fromY", DEFAULT_FROM_Y); } return fromY; } /** * Specifies the start Z coordinate value of this * {@code TranslateTransition}. * <p> * It is not possible to change {@code fromZ} of a running * {@code TranslateTransition}. If the value of {@code fromZ} is changed for * a running {@code TranslateTransition}, the animation has to be stopped * and started again to pick up the new value. * * @defaultValue {@code Double.NaN} */ private DoubleProperty fromZ; private static final double DEFAULT_FROM_Z = Double.NaN; public final void setFromZ(double value) { if ((fromZ != null) || (!Double.isNaN(value))) { fromZProperty().set(value); } } public final double getFromZ() { return (fromZ == null) ? DEFAULT_FROM_Z : fromZ.get(); } public final DoubleProperty fromZProperty() { if (fromZ == null) { fromZ = new SimpleDoubleProperty(this, "fromZ", DEFAULT_FROM_Z); } return fromZ; } /** * Specifies the stop X coordinate value of this {@code TranslateTransition}. * <p> * It is not possible to change {@code toX} of a running * {@code TranslateTransition}. If the value of {@code toX} is changed for a * running {@code TranslateTransition}, the animation has to be stopped and * started again to pick up the new value. * * @defaultValue {@code Double.NaN} */ private DoubleProperty toX; private static final double DEFAULT_TO_X = Double.NaN; public final void setToX(double value) { if ((toX != null) || (!Double.isNaN(value))) { toXProperty().set(value); } } public final double getToX() { return (toX == null) ? DEFAULT_TO_X : toX.get(); } public final DoubleProperty toXProperty() { if (toX == null) { toX = new SimpleDoubleProperty(this, "toX", DEFAULT_TO_X); } return toX; } /** * Specifies the stop Y coordinate value of this {@code TranslateTransition}. * <p> * It is not possible to change {@code toY} of a running * {@code TranslateTransition}. If the value of {@code toY} is changed for a * running {@code TranslateTransition}, the animation has to be stopped and * started again to pick up the new value. * * @defaultValue {@code Double.NaN} */ private DoubleProperty toY; private static final double DEFAULT_TO_Y = Double.NaN; public final void setToY(double value) { if ((toY != null) || (!Double.isNaN(value))) { toYProperty().set(value); } } public final double getToY() { return (toY == null) ? DEFAULT_TO_Y : toY.get(); } public final DoubleProperty toYProperty() { if (toY == null) { toY = new SimpleDoubleProperty(this, "toY", DEFAULT_TO_Y); } return toY; } /** * Specifies the stop Z coordinate value of this {@code TranslateTransition}. * <p> * It is not possible to change {@code toZ} of a running * {@code TranslateTransition}. If the value of {@code toZ} is changed for a * running {@code TranslateTransition}, the animation has to be stopped and * started again to pick up the new value. * * @defaultValue {@code Double.NaN} */ private DoubleProperty toZ; private static final double DEFAULT_TO_Z = Double.NaN; public final void setToZ(double value) { if ((toZ != null) || (!Double.isNaN(value))) { toZProperty().set(value); } } public final double getToZ() { return (toZ == null) ? DEFAULT_TO_Z : toZ.get(); } public final DoubleProperty toZProperty() { if (toZ == null) { toZ = new SimpleDoubleProperty(this, "toZ", DEFAULT_TO_Z); } return toZ; } /** * Specifies the incremented stop X coordinate value, from the start, of * this {@code TranslateTransition}. * <p> * It is not possible to change {@code byX} of a running * {@code TranslateTransition}. If the value of {@code byX} is changed for a * running {@code TranslateTransition}, the animation has to be stopped and * started again to pick up the new value. */ private DoubleProperty byX; private static final double DEFAULT_BY_X = 0.0; public final void setByX(double value) { if ((byX != null) || (Math.abs(value - DEFAULT_BY_X) > EPSILON)) { byXProperty().set(value); } } public final double getByX() { return (byX == null) ? DEFAULT_BY_X : byX.get(); } public final DoubleProperty byXProperty() { if (byX == null) { byX = new SimpleDoubleProperty(this, "byX", DEFAULT_BY_X); } return byX; } /** * Specifies the incremented stop Y coordinate value, from the start, of * this {@code TranslateTransition}. * <p> * It is not possible to change {@code byY} of a running * {@code TranslateTransition}. If the value of {@code byY} is changed for a * running {@code TranslateTransition}, the animation has to be stopped and * started again to pick up the new value. */ private DoubleProperty byY; private static final double DEFAULT_BY_Y = 0.0; public final void setByY(double value) { if ((byY != null) || (Math.abs(value - DEFAULT_BY_Y) > EPSILON)) { byYProperty().set(value); } } public final double getByY() { return (byY == null) ? DEFAULT_BY_Y : byY.get(); } public final DoubleProperty byYProperty() { if (byY == null) { byY = new SimpleDoubleProperty(this, "byY", DEFAULT_BY_Y); } return byY; } /** * Specifies the incremented stop Z coordinate value, from the start, of * this {@code TranslateTransition}. * <p> * It is not possible to change {@code byZ} of a running * {@code TranslateTransition}. If the value of {@code byZ} is changed for a * running {@code TranslateTransition}, the animation has to be stopped and * started again to pick up the new value. */ private DoubleProperty byZ; private static final double DEFAULT_BY_Z = 0.0; public final void setByZ(double value) { if ((byZ != null) || (Math.abs(value - DEFAULT_BY_Z) > EPSILON)) { byZProperty().set(value); } } public final double getByZ() { return (byZ == null) ? DEFAULT_BY_Z : byZ.get(); } public final DoubleProperty byZProperty() { if (byZ == null) { byZ = new SimpleDoubleProperty(this, "byZ", DEFAULT_BY_Z); } return byZ; } /** * The constructor of {@code TranslateTransition} * * @param duration * The duration of the {@code TranslateTransition} * @param node * The {@code node} which will be translated */ public TranslateTransition(Duration duration, Node node) { setDuration(duration); setNode(node); setCycleDuration(duration); } /** * The constructor of {@code TranslateTransition} * * @param duration * The duration of the {@code TranslateTransition} */ public TranslateTransition(Duration duration) { this(duration, null); } /** * The constructor of {@code TranslateTransition} */ public TranslateTransition() { this(DEFAULT_DURATION, null); } /** * {@inheritDoc} */ @Override public void interpolate(double frac) { if (!Double.isNaN(startX)) { cachedNode.setTranslateX(startX + frac * deltaX); } if (!Double.isNaN(startY)) { cachedNode.setTranslateY(startY + frac * deltaY); } if (!Double.isNaN(startZ)) { cachedNode.setTranslateZ(startZ + frac * deltaZ); } } private Node getTargetNode() { final Node node = getNode(); return (node != null) ? node : getParentTargetNode(); } @Override boolean startable(boolean forceSync) { return super.startable(forceSync) && ((getTargetNode() != null) || (!forceSync && (cachedNode != null))); } @Override void sync(boolean forceSync) { super.sync(forceSync); if (forceSync || (cachedNode == null)) { cachedNode = getTargetNode(); final double _fromX = getFromX(); final double _fromY = getFromY(); final double _fromZ = getFromZ(); final double _toX = getToX(); final double _toY = getToY(); final double _toZ = getToZ(); final double _byX = getByX(); final double _byY = getByY(); final double _byZ = getByZ(); if (Double.isNaN(_fromX) && Double.isNaN(_toX) && (Math.abs(_byX) < EPSILON)) { startX = Double.NaN; } else { startX = (!Double.isNaN(_fromX)) ? _fromX : cachedNode.getTranslateX(); deltaX = (!Double.isNaN(_toX)) ? _toX - startX : _byX; } if (Double.isNaN(_fromY) && Double.isNaN(_toY) && (Math.abs(_byY) < EPSILON)) { startY = Double.NaN; } else { startY = (!Double.isNaN(_fromY)) ? _fromY : cachedNode.getTranslateY(); deltaY = (!Double.isNaN(_toY)) ? _toY - startY : getByY(); } if (Double.isNaN(_fromZ) && Double.isNaN(_toZ) && (Math.abs(_byZ) < EPSILON)) { startZ = Double.NaN; } else { startZ = (!Double.isNaN(_fromZ)) ? _fromZ : cachedNode.getTranslateZ(); deltaZ = (!Double.isNaN(_toZ)) ? _toZ - startZ : getByZ(); } } } }