Add initial support for reading values in MotionSpec

PiperOrigin-RevId: 239298785

Author: gsajith

lib/java/com/google/android/material/animation/MotionSpec.java

@@ -19,13 +19,16 @@
 import android.animation.AnimatorInflater;
 import android.animation.AnimatorSet;
 import android.animation.ObjectAnimator;
+import android.animation.PropertyValuesHolder;
 import android.content.Context;
 import android.content.res.TypedArray;
 import androidx.annotation.AnimatorRes;
 import androidx.annotation.Nullable;
 import androidx.annotation.StyleableRes;
 import androidx.collection.SimpleArrayMap;
 import android.util.Log;
+import android.util.Property;
+import android.view.View;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -65,6 +68,8 @@ public class MotionSpec {
   private static final String TAG = "MotionSpec";
 
   private final SimpleArrayMap<String, MotionTiming> timings = new SimpleArrayMap<>();
+  private final SimpleArrayMap<String, PropertyValuesHolder[]> propertyValues =
+      new SimpleArrayMap<>();
 
   /** Returns whether this motion spec contains a MotionTiming with the given name. */
   public boolean hasTiming(String name) {
@@ -87,6 +92,39 @@ public void setTiming(String name, @Nullable MotionTiming timing) {
     timings.put(name, timing);
   }
 
+  /**
+   * Returns whether this motion spec contains a {@link PropertyValuesHolder[]} with the given name.
+   */
+  public boolean hasPropertyValues(String name) {
+    return propertyValues.get(name) != null;
+  }
+
+  public PropertyValuesHolder[] getPropertyValues(String name) {
+    if (!hasPropertyValues(name)) {
+      throw new IllegalArgumentException();
+    }
+    return clonePropertyValuesHolder(propertyValues.get(name));
+  }
+
+  public void setPropertyValues(String name, PropertyValuesHolder[] values) {
+    propertyValues.put(name, values);
+  }
+
+  private PropertyValuesHolder[] clonePropertyValuesHolder(PropertyValuesHolder[] values) {
+    PropertyValuesHolder[] ret = new PropertyValuesHolder[values.length];
+    for (int i = 0; i < values.length; i++) {
+      ret[i] = values[i].clone();
+    }
+    return ret;
+  }
+
+  public ObjectAnimator getAnimator(String name, View view, Property<View, Float> property) {
+    ObjectAnimator animator = ObjectAnimator.ofPropertyValuesHolder(view, getPropertyValues(name));
+    animator.setProperty(property);
+    getTiming(name).apply(animator);
+    return animator;
+  }
+
   /**
    * Returns the total duration of this motion spec, which is the maximum delay+duration of its
    * motion timings.
@@ -140,14 +178,15 @@ public static MotionSpec createFromResource(Context context, @AnimatorRes int id
   private static MotionSpec createSpecFromAnimators(List<Animator> animators) {
     MotionSpec spec = new MotionSpec();
     for (int i = 0, count = animators.size(); i < count; i++) {
-      addTimingFromAnimator(spec, animators.get(i));
+      addInfoFromAnimator(spec, animators.get(i));
     }
     return spec;
   }
 
-  private static void addTimingFromAnimator(MotionSpec spec, Animator animator) {
+  private static void addInfoFromAnimator(MotionSpec spec, Animator animator) {
     if (animator instanceof ObjectAnimator) {
       ObjectAnimator anim = (ObjectAnimator) animator;
+      spec.setPropertyValues(anim.getPropertyName(), anim.getValues());
       spec.setTiming(anim.getPropertyName(), MotionTiming.createFromAnimator(anim));
     } else {
       throw new IllegalArgumentException("Animator must be an ObjectAnimator: " + animator);

testing/java/com/google/android/material/testapp/animation/res/animator/valid_set_of_object_animator_motion_spec.xml

@@ -20,14 +20,25 @@
       android:propertyName="alpha"
       android:startOffset="3"
       android:duration="5"
+      android:valueFrom="0.2"
+      android:valueTo="0.8"
+      android:valueType="floatType"
       android:interpolator="@interpolator/mtrl_fast_out_linear_in"
       android:repeatCount="7"
       android:repeatMode="restart"/>
   <objectAnimator
       android:propertyName="translation"
       android:startOffset="11"
       android:duration="13"
+      android:valueFrom="0"
+      android:valueTo="101"
+      android:valueType="intType"
       android:interpolator="@interpolator/mtrl_fast_out_slow_in"
       android:repeatCount="17"
       android:repeatMode="reverse"/>
+  <objectAnimator
+      android:propertyName="foo"
+      android:duration="10"
+      android:valueType="floatType"
+      android:interpolator="@interpolator/mtrl_fast_out_slow_in"/>
 </set>

tests/javatests/com/google/android/material/animation/MotionSpecTest.java

@@ -20,13 +20,18 @@
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertThat;
+import static org.junit.Assert.assertTrue;
 
+import android.animation.Animator;
+import android.animation.ObjectAnimator;
+import android.animation.PropertyValuesHolder;
 import android.animation.ValueAnimator;
 import android.content.res.TypedArray;
 import android.os.Build.VERSION;
 import android.os.Build.VERSION_CODES;
 import com.google.android.material.testapp.animation.R;
 import androidx.appcompat.app.AppCompatActivity;
+import android.view.View;
 import android.view.animation.PathInterpolator;
 import androidx.interpolator.view.animation.FastOutLinearInInterpolator;
 import androidx.interpolator.view.animation.FastOutSlowInInterpolator;
@@ -56,12 +61,14 @@ public void loadMotionSpec() {
   }
 
   @Test
-  public void setOfObjectAnimatorMotionSpecHasAlphaAndTranslationTimings() {
+  public void setOfObjectAnimatorMotionSpecHasAlphaAndTranslationTimingsAndValues() {
     MotionSpec spec =
         MotionSpec.createFromResource(
             activityTestRule.getActivity(), R.animator.valid_set_of_object_animator_motion_spec);
     assertNotNull(spec.getTiming("alpha"));
     assertNotNull(spec.getTiming("translation"));
+    assertEquals(1, spec.getPropertyValues("alpha").length);
+    assertEquals(1, spec.getPropertyValues("translation").length);
   }
 
   @Test
@@ -96,6 +103,17 @@ public void validateSetOfObjectAnimatorAlphaMotionTiming() {
     assertEquals(ValueAnimator.RESTART, alpha.getRepeatMode());
   }
 
+  @Test
+  public void validateSetOfObjectAnimatorAlphaMotionValues() {
+    MotionSpec spec =
+        MotionSpec.createFromResource(
+            activityTestRule.getActivity(), R.animator.valid_set_of_object_animator_motion_spec);
+    View view = new View(activityTestRule.getActivity());
+    Animator alphaAnimator = spec.getAnimator("alpha", view, View.ALPHA);
+    PropertyValuesHolder propertyValuesHolder = ((ObjectAnimator) alphaAnimator).getValues()[0];
+    assertTrue(fromAndToValuesMatch(propertyValuesHolder, "0.2", "0.8"));
+  }
+
   @Test
   public void validateSetOfObjectAnimatorTranslationMotionTiming() {
     MotionSpec spec =
@@ -114,6 +132,30 @@ public void validateSetOfObjectAnimatorTranslationMotionTiming() {
     assertEquals(ValueAnimator.REVERSE, translation.getRepeatMode());
   }
 
+  @Test
+  public void validateSetOfObjectAnimatorTranslationMotionValues() {
+    MotionSpec spec =
+        MotionSpec.createFromResource(
+            activityTestRule.getActivity(), R.animator.valid_set_of_object_animator_motion_spec);
+    View view = new View(activityTestRule.getActivity());
+    Animator translationAnimator = spec.getAnimator("translation", view, View.TRANSLATION_X);
+    PropertyValuesHolder propertyValuesHolder =
+        ((ObjectAnimator) translationAnimator).getValues()[0];
+    assertTrue(fromAndToValuesMatch(propertyValuesHolder, "0", "101"));
+  }
+
+  @Test
+  public void validateSetOfObjectAnimatorEmptyMotionValues() {
+    MotionSpec spec =
+        MotionSpec.createFromResource(
+            activityTestRule.getActivity(), R.animator.valid_set_of_object_animator_motion_spec);
+    View view = new View(activityTestRule.getActivity());
+    Animator translationAnimator = spec.getAnimator("foo", view, View.TRANSLATION_X);
+    PropertyValuesHolder propertyValuesHolder =
+        ((ObjectAnimator) translationAnimator).getValues()[0];
+    assertTrue(fromAndToValuesMatch(propertyValuesHolder, "0.0", "0.0"));
+  }
+
   public void inflateInvalidSetOfSetMotionSpec() {
     assertNull(
         MotionSpec.createFromResource(
@@ -125,4 +167,19 @@ public void inflateInvalidSetOfValueAnimatorMotionSpec() {
         MotionSpec.createFromResource(
             activityTestRule.getActivity(), R.animator.invalid_set_of_value_animator_motion_spec));
   }
+
+  @SuppressWarnings("StringSplitter")
+  private boolean fromAndToValuesMatch(
+      PropertyValuesHolder propertyValuesHolder, String fromValue, String toValue) {
+    String[] valueStringTokens = propertyValuesHolder.toString().split("\\s+");
+    int length = valueStringTokens.length;
+    if (length >= 2) {
+      if (valueStringTokens[length - 2].equals(fromValue)
+          && valueStringTokens[length - 1].equals(toValue)) {
+        return true;
+      }
+    }
+
+    return false;
+  }
 }