1 /*
   2  * Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javafx.animation;
  27 
  28 import com.sun.javafx.animation.TickCalculation;
  29 import com.sun.scenario.animation.shared.InterpolationInterval;
  30 import javafx.beans.property.Property;
  31 import javafx.beans.property.SimpleLongProperty;
  32 import javafx.util.Duration;
  33 import static org.junit.Assert.assertEquals;
  34 
  35 import org.junit.Test;
  36 
  37 public class InterpolatorTest {
  38 
  39     private static final double EPSILON = 1e-12;
  40     private static final float EPSILON_FLOAT = 1e-6f;
  41     private static final DummyInterpolatable START = new DummyInterpolatable(0);
  42     private static final DummyInterpolatable END   = new DummyInterpolatable(10);
  43     
  44     @Test
  45     public void testInterpolateWithObjects() {
  46         final DummyInterpolatable i1 = new DummyInterpolatable(1);
  47         final DummyInterpolatable i2 = new DummyInterpolatable(4);
  48         final Object o = new Object();
  49         
  50         assertEquals(Double.valueOf(2.5), (Double)Interpolator.LINEAR.interpolate(Double.valueOf(1), Integer.valueOf(4), 0.5), EPSILON);
  51         assertEquals(Double.valueOf(2.5), (Double)Interpolator.LINEAR.interpolate(Integer.valueOf(4), Double.valueOf(1), 0.5), EPSILON);
  52         assertEquals(Float.valueOf(2.5f), (Float)Interpolator.LINEAR.interpolate(Float.valueOf(1), Integer.valueOf(4), 0.5), EPSILON_FLOAT);
  53         assertEquals(Float.valueOf(2.5f), (Float)Interpolator.LINEAR.interpolate(Integer.valueOf(4), Float.valueOf(1), 0.5), EPSILON_FLOAT);
  54         assertEquals(Long.valueOf(3L), Interpolator.LINEAR.interpolate(Long.valueOf(1), Integer.valueOf(4),  0.5));
  55         assertEquals(Long.valueOf(3L), Interpolator.LINEAR.interpolate(Integer.valueOf(4), Long.valueOf(1), 0.5));
  56         assertEquals(Integer.valueOf(3), Interpolator.LINEAR.interpolate(Integer.valueOf(1), Integer.valueOf(4), 0.5));
  57         assertEquals(2.5, ((DummyInterpolatable)Interpolator.LINEAR.interpolate(i1, i2, 0.5)).value, EPSILON);
  58         
  59         assertEquals(o, Interpolator.LINEAR.interpolate(o, Integer.MIN_VALUE, 1.0-2*EPSILON));
  60         assertEquals(Integer.MIN_VALUE, Interpolator.LINEAR.interpolate(o, Integer.MIN_VALUE, 1.0));
  61         
  62         assertEquals(Integer.MIN_VALUE, Interpolator.LINEAR.interpolate(Integer.MIN_VALUE, o, 1.0-2*EPSILON));
  63         assertEquals(o, Interpolator.LINEAR.interpolate(Integer.MIN_VALUE, o, 1.0));
  64         
  65         assertEquals(i1, Interpolator.LINEAR.interpolate(i1, o, 1.0-2*EPSILON));
  66         assertEquals(o, Interpolator.LINEAR.interpolate(i1, o, 1.0));
  67     }
  68 
  69     @Test
  70     public void testDISCRETE() {
  71         assertEquals(false, Interpolator.DISCRETE.interpolate(false, true, 1.0-2*EPSILON));
  72         assertEquals(true, Interpolator.DISCRETE.interpolate(false, true, 1.0));
  73                 
  74         assertEquals(1.0, Interpolator.DISCRETE.interpolate(1.0, 2.0, 1.0-2*EPSILON), EPSILON);
  75         assertEquals(2.0, Interpolator.DISCRETE.interpolate(1.0, 2.0, 1.0), EPSILON);
  76 
  77         assertEquals(-3, Interpolator.DISCRETE.interpolate(-3, 7, 1.0-2*EPSILON));
  78         assertEquals( 7, Interpolator.DISCRETE.interpolate(-3, 7, 1.0));
  79 
  80         assertEquals(  12L, Interpolator.DISCRETE.interpolate(12L, -201L, 1.0-2*EPSILON));
  81         assertEquals(-201L, Interpolator.DISCRETE.interpolate(12L, -201L, 1.0));
  82 
  83         assertEquals( 0, ((DummyInterpolatable)Interpolator.DISCRETE.interpolate(START, END, 1.0-2*EPSILON)).value, EPSILON);
  84         assertEquals(10, ((DummyInterpolatable)Interpolator.DISCRETE.interpolate(START, END, 1.0)).value, EPSILON);
  85     }
  86 
  87     @Test
  88     public void testLINEAR() {
  89         assertEquals(false, Interpolator.LINEAR.interpolate(false, true, 0.0));
  90         assertEquals(false, Interpolator.LINEAR.interpolate(false, true, 0.1));
  91         assertEquals(false, Interpolator.LINEAR.interpolate(false, true, 0.5));
  92         assertEquals(false, Interpolator.LINEAR.interpolate(false, true, 0.9));
  93         assertEquals(true, Interpolator.LINEAR.interpolate(false, true, 1.0));
  94 
  95         assertEquals(1.0, Interpolator.LINEAR.interpolate(1.0, 2.0, 0.0), EPSILON);
  96         assertEquals(1.1, Interpolator.LINEAR.interpolate(1.0, 2.0, 0.1), EPSILON);
  97         assertEquals(1.5, Interpolator.LINEAR.interpolate(1.0, 2.0, 0.5), EPSILON);
  98         assertEquals(1.9, Interpolator.LINEAR.interpolate(1.0, 2.0, 0.9), EPSILON);
  99         assertEquals(2.0, Interpolator.LINEAR.interpolate(1.0, 2.0, 1.0), EPSILON);
 100 
 101         assertEquals(-3, Interpolator.LINEAR.interpolate(-3, 7, 0.0));
 102         assertEquals(-2, Interpolator.LINEAR.interpolate(-3, 7, 0.1));
 103         assertEquals( 2, Interpolator.LINEAR.interpolate(-3, 7, 0.5));
 104         assertEquals( 6, Interpolator.LINEAR.interpolate(-3, 7, 0.9));
 105         assertEquals( 7, Interpolator.LINEAR.interpolate(-3, 7, 1.0));
 106 
 107         assertEquals(-3L, Interpolator.LINEAR.interpolate(-3L, 7L, 0.0));
 108         assertEquals(-2L, Interpolator.LINEAR.interpolate(-3L, 7L, 0.1));
 109         assertEquals( 2L, Interpolator.LINEAR.interpolate(-3L, 7L, 0.5));
 110         assertEquals( 6L, Interpolator.LINEAR.interpolate(-3L, 7L, 0.9));
 111         assertEquals( 7L, Interpolator.LINEAR.interpolate(-3L, 7L, 1.0));
 112 
 113         assertEquals( 0, ((DummyInterpolatable)Interpolator.LINEAR.interpolate(START, END, 0.0)).value, EPSILON);
 114         assertEquals( 1, ((DummyInterpolatable)Interpolator.LINEAR.interpolate(START, END, 0.1)).value, EPSILON);
 115         assertEquals( 5, ((DummyInterpolatable)Interpolator.LINEAR.interpolate(START, END, 0.5)).value, EPSILON);
 116         assertEquals( 9, ((DummyInterpolatable)Interpolator.LINEAR.interpolate(START, END, 0.9)).value, EPSILON);
 117         assertEquals(10, ((DummyInterpolatable)Interpolator.LINEAR.interpolate(START, END, 1.0)).value, EPSILON);
 118     }
 119 
 120     @Test
 121     public void testEASE_BOTH() {
 122         // Expected results calculated with JavaFX SDK 1.3
 123         
 124         assertEquals(false, Interpolator.EASE_BOTH.interpolate(false, true, 0.0));
 125         assertEquals(false, Interpolator.EASE_BOTH.interpolate(false, true, 0.1));
 126         assertEquals(false, Interpolator.EASE_BOTH.interpolate(false, true, 0.5));
 127         assertEquals(false, Interpolator.EASE_BOTH.interpolate(false, true, 0.9));
 128         assertEquals(true, Interpolator.EASE_BOTH.interpolate(false, true, 1.0));
 129         
 130         assertEquals(1.0,   Interpolator.EASE_BOTH.interpolate(1.0, 2.0, 0.0), EPSILON);
 131         assertEquals(1.125, Interpolator.EASE_BOTH.interpolate(1.0, 2.0, 0.2), EPSILON);
 132         assertEquals(1.5,   Interpolator.EASE_BOTH.interpolate(1.0, 2.0, 0.5), EPSILON);
 133         assertEquals(1.875, Interpolator.EASE_BOTH.interpolate(1.0, 2.0, 0.8), EPSILON);
 134         assertEquals(2.0,   Interpolator.EASE_BOTH.interpolate(1.0, 2.0, 1.0), EPSILON);
 135 
 136         assertEquals(-3, Interpolator.EASE_BOTH.interpolate(-3, 7, 0.0));
 137         assertEquals(-2, Interpolator.EASE_BOTH.interpolate(-3, 7, 0.2));
 138         assertEquals( 2, Interpolator.EASE_BOTH.interpolate(-3, 7, 0.5));
 139         assertEquals( 6, Interpolator.EASE_BOTH.interpolate(-3, 7, 0.8));
 140         assertEquals( 7, Interpolator.EASE_BOTH.interpolate(-3, 7, 1.0));
 141 
 142         assertEquals(-3L, Interpolator.EASE_BOTH.interpolate(-3L, 7L, 0.0));
 143         assertEquals(-2L, Interpolator.EASE_BOTH.interpolate(-3L, 7L, 0.2));
 144         assertEquals( 2L, Interpolator.EASE_BOTH.interpolate(-3L, 7L, 0.5));
 145         assertEquals( 6L, Interpolator.EASE_BOTH.interpolate(-3L, 7L, 0.8));
 146         assertEquals( 7L, Interpolator.EASE_BOTH.interpolate(-3L, 7L, 1.0));
 147 
 148         assertEquals( 0,    ((DummyInterpolatable)Interpolator.EASE_BOTH.interpolate(START, END, 0.0)).value, EPSILON);
 149         assertEquals( 1.25, ((DummyInterpolatable)Interpolator.EASE_BOTH.interpolate(START, END, 0.2)).value, EPSILON);
 150         assertEquals( 5,    ((DummyInterpolatable)Interpolator.EASE_BOTH.interpolate(START, END, 0.5)).value, EPSILON);
 151         assertEquals( 8.75, ((DummyInterpolatable)Interpolator.EASE_BOTH.interpolate(START, END, 0.8)).value, EPSILON);
 152         assertEquals(10,    ((DummyInterpolatable)Interpolator.EASE_BOTH.interpolate(START, END, 1.0)).value, EPSILON);
 153     }
 154 
 155     @Test
 156     public void testEASE_IN() {
 157         // Expected results calculated with JavaFX SDK 1.3
 158         
 159         assertEquals(false, Interpolator.EASE_IN.interpolate(false, true, 0.0));
 160         assertEquals(false, Interpolator.EASE_IN.interpolate(false, true, 0.1));
 161         assertEquals(false, Interpolator.EASE_IN.interpolate(false, true, 0.5));
 162         assertEquals(false, Interpolator.EASE_IN.interpolate(false, true, 0.9));
 163         assertEquals(true, Interpolator.EASE_IN.interpolate(false, true, 1.0));
 164         
 165         assertEquals(1.0,      Interpolator.EASE_IN.interpolate(1.0, 2.0, 0.0), EPSILON);
 166         assertEquals(1.1111111111111112, Interpolator.EASE_IN.interpolate(1.0, 2.0, 0.2), EPSILON);
 167         assertEquals(1.4444444444444444, Interpolator.EASE_IN.interpolate(1.0, 2.0, 0.5), EPSILON);
 168         assertEquals(1.777777777777778, Interpolator.EASE_IN.interpolate(1.0, 2.0, 0.8), EPSILON);
 169         assertEquals(2.0,      Interpolator.EASE_IN.interpolate(1.0, 2.0, 1.0), EPSILON);
 170 
 171         assertEquals(-3, Interpolator.EASE_IN.interpolate(-3, 7, 0.0));
 172         assertEquals(-2, Interpolator.EASE_IN.interpolate(-3, 7, 0.2));
 173         assertEquals( 1, Interpolator.EASE_IN.interpolate(-3, 7, 0.5));
 174         assertEquals( 5, Interpolator.EASE_IN.interpolate(-3, 7, 0.8));
 175         assertEquals( 7, Interpolator.EASE_IN.interpolate(-3, 7, 1.0));
 176 
 177         assertEquals(-3L, Interpolator.EASE_IN.interpolate(-3L, 7L, 0.0));
 178         assertEquals(-2L, Interpolator.EASE_IN.interpolate(-3L, 7L, 0.2));
 179         assertEquals( 1L, Interpolator.EASE_IN.interpolate(-3L, 7L, 0.5));
 180         assertEquals( 5L, Interpolator.EASE_IN.interpolate(-3L, 7L, 0.8));
 181         assertEquals( 7L, Interpolator.EASE_IN.interpolate(-3L, 7L, 1.0));
 182 
 183         assertEquals( 0,        ((DummyInterpolatable)Interpolator.EASE_IN.interpolate(START, END, 0.0)).value, EPSILON);
 184         assertEquals( 1.1111111111111114, ((DummyInterpolatable)Interpolator.EASE_IN.interpolate(START, END, 0.2)).value, EPSILON);
 185         assertEquals( 4.444444444444445, ((DummyInterpolatable)Interpolator.EASE_IN.interpolate(START, END, 0.5)).value, EPSILON);
 186         assertEquals( 7.777777777777779, ((DummyInterpolatable)Interpolator.EASE_IN.interpolate(START, END, 0.8)).value, EPSILON);
 187         assertEquals(10,        ((DummyInterpolatable)Interpolator.EASE_IN.interpolate(START, END, 1.0)).value, EPSILON);
 188     }
 189 
 190     @Test
 191     public void testEASE_OUT() {
 192         // Expected results calculated with JavaFX SDK 1.3
 193         
 194         assertEquals(false, Interpolator.EASE_OUT.interpolate(false, true, 0.0));
 195         assertEquals(false, Interpolator.EASE_OUT.interpolate(false, true, 0.1));
 196         assertEquals(false, Interpolator.EASE_OUT.interpolate(false, true, 0.5));
 197         assertEquals(false, Interpolator.EASE_OUT.interpolate(false, true, 0.9));
 198         assertEquals(true, Interpolator.EASE_OUT.interpolate(false, true, 1.0));
 199         
 200         assertEquals(1.0,      Interpolator.EASE_OUT.interpolate(1.0, 2.0, 0.0), EPSILON);
 201         assertEquals(1.2222222222222223, Interpolator.EASE_OUT.interpolate(1.0, 2.0, 0.2), EPSILON);
 202         assertEquals(1.5555555555555556, Interpolator.EASE_OUT.interpolate(1.0, 2.0, 0.5), EPSILON);
 203         assertEquals(1.8888888888888888, Interpolator.EASE_OUT.interpolate(1.0, 2.0, 0.8), EPSILON);
 204         assertEquals(2.0,      Interpolator.EASE_OUT.interpolate(1.0, 2.0, 1.0), EPSILON);
 205 
 206         assertEquals(-3, Interpolator.EASE_OUT.interpolate(-3, 7, 0.0));
 207         assertEquals(-1, Interpolator.EASE_OUT.interpolate(-3, 7, 0.2));
 208         assertEquals( 3, Interpolator.EASE_OUT.interpolate(-3, 7, 0.5));
 209         assertEquals( 6, Interpolator.EASE_OUT.interpolate(-3, 7, 0.8));
 210         assertEquals( 7, Interpolator.EASE_OUT.interpolate(-3, 7, 1.0));
 211 
 212         assertEquals(-3L, Interpolator.EASE_OUT.interpolate(-3L, 7L, 0.0));
 213         assertEquals(-1L, Interpolator.EASE_OUT.interpolate(-3L, 7L, 0.2));
 214         assertEquals( 3L, Interpolator.EASE_OUT.interpolate(-3L, 7L, 0.5));
 215         assertEquals( 6L, Interpolator.EASE_OUT.interpolate(-3L, 7L, 0.8));
 216         assertEquals( 7L, Interpolator.EASE_OUT.interpolate(-3L, 7L, 1.0));
 217 
 218         assertEquals( 0,        ((DummyInterpolatable)Interpolator.EASE_OUT.interpolate(START, END, 0.0)).value, EPSILON);
 219         assertEquals( 2.2222222222222223, ((DummyInterpolatable)Interpolator.EASE_OUT.interpolate(START, END, 0.2)).value, EPSILON);
 220         assertEquals( 5.555555555555555, ((DummyInterpolatable)Interpolator.EASE_OUT.interpolate(START, END, 0.5)).value, EPSILON);
 221         assertEquals( 8.88888888888889, ((DummyInterpolatable)Interpolator.EASE_OUT.interpolate(START, END, 0.8)).value, EPSILON);
 222         assertEquals(10,        ((DummyInterpolatable)Interpolator.EASE_OUT.interpolate(START, END, 1.0)).value, EPSILON);
 223     }
 224 
 225     @Test
 226     public void testSPLINE_Concave() {
 227         Interpolator i = Interpolator.SPLINE(0.0, 0.5, 0.5, 1.0);
 228         assertEquals(1.0, i.interpolate(1.0, 2.0, 0.0), EPSILON);
 229         assertEquals(1.5573742287206063, i.interpolate(1.0, 2.0, 0.2), EPSILON);
 230         assertEquals(1.8400223953585164, i.interpolate(1.0, 2.0, 0.5), EPSILON);
 231         assertEquals(1.9742173260814238, i.interpolate(1.0, 2.0, 0.8), EPSILON);
 232         assertEquals(2.0, i.interpolate(1.0, 2.0, 1.0), EPSILON);
 233     }
 234 
 235     @Test
 236     public void testSPLINE_Convex() {
 237         Interpolator i = Interpolator.SPLINE(0.5, 0.0, 1.0, 0.5);
 238         assertEquals(1.0, i.interpolate(1.0, 2.0, 0.0), EPSILON);
 239         assertEquals(1.0257826739185762, i.interpolate(1.0, 2.0, 0.2), EPSILON);
 240         assertEquals(1.1599776046414838, i.interpolate(1.0, 2.0, 0.5), EPSILON);
 241         assertEquals(1.4426257712793937, i.interpolate(1.0, 2.0, 0.8), EPSILON);
 242         assertEquals(2.0, i.interpolate(1.0, 2.0, 1.0), EPSILON);
 243     }
 244 
 245     @Test
 246     public void testSPLINE_WithInflectionPoint() {
 247         Interpolator i = Interpolator.SPLINE(0.0, 1.0, 1.0, 0.0);
 248 
 249         assertEquals(1.0, i.interpolate(1.0, 2.0, 0.0), EPSILON);
 250         assertEquals(1.4614221762502215, i.interpolate(1.0, 2.0, 0.2), EPSILON);
 251         assertEquals(1.5, i.interpolate(1.0, 2.0, 0.5), EPSILON);
 252         assertEquals(1.5385778237497787, i.interpolate(1.0, 2.0, 0.8), EPSILON);
 253         assertEquals(2.0, i.interpolate(1.0, 2.0, 1.0), EPSILON);
 254     }
 255 
 256     @Test
 257     public void testSPLINE_Linear() {
 258         Interpolator i = Interpolator.SPLINE(1/3, 1/3, 2/3, 2/3);
 259 
 260         assertEquals(1.0, i.interpolate(1.0, 2.0, 0.0), EPSILON);
 261         assertEquals(1.2, i.interpolate(1.0, 2.0, 0.2), EPSILON);
 262         assertEquals(1.5, i.interpolate(1.0, 2.0, 0.5), EPSILON);
 263         assertEquals(1.8, i.interpolate(1.0, 2.0, 0.8), EPSILON);
 264         assertEquals(2.0, i.interpolate(1.0, 2.0, 1.0), EPSILON);
 265     }
 266 
 267     @Test
 268     public void testTANGENT_Linear() {
 269         SimpleLongProperty property = new SimpleLongProperty();
 270 
 271         Interpolator i0 = Interpolator.TANGENT(Duration.seconds(1), 20);
 272         Interpolator i1 = Interpolator.TANGENT(Duration.seconds(1), 40);
 273 
 274         InterpolationInterval interval = InterpolationInterval.create(new KeyValue(property, 60L, i1),
 275                 TickCalculation.fromDuration(Duration.seconds(3)),
 276                 new KeyValue(property, 0L, i0), TickCalculation.fromDuration(Duration.seconds(3)));
 277 
 278         interval.interpolate(1.0/3.0);
 279         assertEquals(20L, (long)property.getValue());
 280         interval.interpolate(1.0/2.0);
 281         assertEquals(30L, (long)property.getValue());
 282         interval.interpolate(2.0/3.0);
 283         assertEquals(40L, (long)property.getValue());
 284     }
 285     
 286     private static class DummyInterpolatable implements Interpolatable<DummyInterpolatable> {
 287 
 288         final double value;
 289 
 290         private DummyInterpolatable(double value) {
 291                 this.value = value;
 292         }
 293 
 294         @Override
 295         public DummyInterpolatable interpolate(DummyInterpolatable endVal, double t) {
 296                 if (Math.abs(t) < EPSILON) {
 297                         return this;
 298                 } else if (Math.abs(t-1.0) < EPSILON) {
 299                         return endVal;
 300                 } else {
 301                         return new DummyInterpolatable(value + t * (endVal.value - value));
 302                 }
 303         }
 304     }
 305 }