| /* |
| * Copyright (C) 2010 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package android.animation; |
| |
| import android.util.Log; |
| |
| import java.lang.reflect.Method; |
| import java.util.ArrayList; |
| |
| /** |
| * This subclass of {@link ValueAnimator} provides support for animating properties on target objects. |
| * The constructors of this class take parameters to define the target object that will be animated |
| * as well as the name of the property that will be animated. Appropriate set/get functions |
| * are then determined internally and the animation will call these functions as necessary to |
| * animate the property. |
| * |
| * @see #setPropertyName(String) |
| * |
| */ |
| public final class ObjectAnimator extends ValueAnimator { |
| private static final boolean DBG = false; |
| |
| // The target object on which the property exists, set in the constructor |
| private Object mTarget; |
| |
| private String mPropertyName; |
| |
| /** |
| * Sets the name of the property that will be animated. This name is used to derive |
| * a setter function that will be called to set animated values. |
| * For example, a property name of <code>foo</code> will result |
| * in a call to the function <code>setFoo()</code> on the target object. If either |
| * <code>valueFrom</code> or <code>valueTo</code> is null, then a getter function will |
| * also be derived and called. |
| * |
| * <p>For best performance of the mechanism that calls the setter function determined by the |
| * name of the property being animated, use <code>float</code> or <code>int</code> typed values, |
| * and make the setter function for those properties have a <code>void</code> return value. This |
| * will cause the code to take an optimized path for these constrained circumstances. Other |
| * property types and return types will work, but will have more overhead in processing |
| * the requests due to normal reflection mechanisms.</p> |
| * |
| * <p>Note that the setter function derived from this property name |
| * must take the same parameter type as the |
| * <code>valueFrom</code> and <code>valueTo</code> properties, otherwise the call to |
| * the setter function will fail.</p> |
| * |
| * <p>If this ObjectAnimator has been set up to animate several properties together, |
| * using more than one PropertyValuesHolder objects, then setting the propertyName simply |
| * sets the propertyName in the first of those PropertyValuesHolder objects.</p> |
| * |
| * @param propertyName The name of the property being animated. |
| */ |
| public void setPropertyName(String propertyName) { |
| // mValues could be null if this is being constructed piecemeal. Just record the |
| // propertyName to be used later when setValues() is called if so. |
| if (mValues != null) { |
| PropertyValuesHolder valuesHolder = mValues[0]; |
| String oldName = valuesHolder.getPropertyName(); |
| valuesHolder.setPropertyName(propertyName); |
| mValuesMap.remove(oldName); |
| mValuesMap.put(propertyName, valuesHolder); |
| } |
| mPropertyName = propertyName; |
| // New property/values/target should cause re-initialization prior to starting |
| mInitialized = false; |
| } |
| |
| /** |
| * Gets the name of the property that will be animated. This name will be used to derive |
| * a setter function that will be called to set animated values. |
| * For example, a property name of <code>foo</code> will result |
| * in a call to the function <code>setFoo()</code> on the target object. If either |
| * <code>valueFrom</code> or <code>valueTo</code> is null, then a getter function will |
| * also be derived and called. |
| */ |
| public String getPropertyName() { |
| return mPropertyName; |
| } |
| |
| /** |
| * Determine the setter or getter function using the JavaBeans convention of setFoo or |
| * getFoo for a property named 'foo'. This function figures out what the name of the |
| * function should be and uses reflection to find the Method with that name on the |
| * target object. |
| * |
| * @param prefix "set" or "get", depending on whether we need a setter or getter. |
| * @return Method the method associated with mPropertyName. |
| */ |
| private Method getPropertyFunction(String prefix, Class valueType) { |
| // TODO: faster implementation... |
| Method returnVal = null; |
| String firstLetter = mPropertyName.substring(0, 1); |
| String theRest = mPropertyName.substring(1); |
| firstLetter = firstLetter.toUpperCase(); |
| String setterName = prefix + firstLetter + theRest; |
| Class args[] = null; |
| if (valueType != null) { |
| args = new Class[1]; |
| args[0] = valueType; |
| } |
| try { |
| returnVal = mTarget.getClass().getMethod(setterName, args); |
| } catch (NoSuchMethodException e) { |
| Log.e("ObjectAnimator", |
| "Couldn't find setter/getter for property " + mPropertyName + ": " + e); |
| } |
| return returnVal; |
| } |
| |
| /** |
| * Creates a new ObjectAnimator object. This default constructor is primarily for |
| * use internally; the other constructors which take parameters are more generally |
| * useful. |
| */ |
| public ObjectAnimator() { |
| } |
| |
| /** |
| * A constructor that takes a single property name and set of values. This constructor is |
| * used in the simple case of animating a single property. |
| * |
| * @param target The object whose property is to be animated. This object should |
| * have a public method on it called <code>setName()</code>, where <code>name</code> is |
| * the value of the <code>propertyName</code> parameter. |
| * @param propertyName The name of the property being animated. |
| */ |
| private ObjectAnimator(Object target, String propertyName) { |
| mTarget = target; |
| setPropertyName(propertyName); |
| } |
| |
| /** |
| * Constructs and returns an ObjectAnimator that animates between int values. A single |
| * value implies that that value is the one being animated to. However, this is not typically |
| * useful in a ValueAnimator object because there is no way for the object to determine the |
| * starting value for the animation (unlike ObjectAnimator, which can derive that value |
| * from the target object and property being animated). Therefore, there should typically |
| * be two or more values. |
| * |
| * @param target The object whose property is to be animated. This object should |
| * have a public method on it called <code>setName()</code>, where <code>name</code> is |
| * the value of the <code>propertyName</code> parameter. |
| * @param propertyName The name of the property being animated. |
| * @param values A set of values that the animation will animate between over time. |
| * @return A ValueAnimator object that is set up to animate between the given values. |
| */ |
| public static ObjectAnimator ofInt(Object target, String propertyName, int... values) { |
| ObjectAnimator anim = new ObjectAnimator(target, propertyName); |
| anim.setIntValues(values); |
| return anim; |
| } |
| |
| /** |
| * Constructs and returns an ObjectAnimator that animates between float values. A single |
| * value implies that that value is the one being animated to. However, this is not typically |
| * useful in a ValueAnimator object because there is no way for the object to determine the |
| * starting value for the animation (unlike ObjectAnimator, which can derive that value |
| * from the target object and property being animated). Therefore, there should typically |
| * be two or more values. |
| * |
| * @param target The object whose property is to be animated. This object should |
| * have a public method on it called <code>setName()</code>, where <code>name</code> is |
| * the value of the <code>propertyName</code> parameter. |
| * @param propertyName The name of the property being animated. |
| * @param values A set of values that the animation will animate between over time. |
| * @return A ValueAnimator object that is set up to animate between the given values. |
| */ |
| public static ObjectAnimator ofFloat(Object target, String propertyName, float... values) { |
| ObjectAnimator anim = new ObjectAnimator(target, propertyName); |
| anim.setFloatValues(values); |
| return anim; |
| } |
| |
| /** |
| * A constructor that takes <code>PropertyValueHolder</code> values. This constructor should |
| * be used when animating several properties at once with the same ObjectAnimator, since |
| * PropertyValuesHolder allows you to associate a set of animation values with a property |
| * name. |
| * |
| * @param target The object whose property is to be animated. This object should |
| * have public methods on it called <code>setName()</code>, where <code>name</code> is |
| * the name of the property passed in as the <code>propertyName</code> parameter for |
| * each of the PropertyValuesHolder objects. |
| * @param propertyName The name of the property being animated. |
| * @param evaluator A TypeEvaluator that will be called on each animation frame to |
| * provide the ncessry interpolation between the Object values to derive the animated |
| * value. |
| * @param values The PropertyValuesHolder objects which hold each the property name and values |
| * to animate that property between. |
| */ |
| public static ObjectAnimator ofObject(Object target, String propertyName, |
| TypeEvaluator evaluator, Object... values) { |
| ObjectAnimator anim = new ObjectAnimator(target, propertyName); |
| anim.setObjectValues(values); |
| anim.setEvaluator(evaluator); |
| return anim; |
| } |
| |
| /** |
| * Constructs and returns an ObjectAnimator that animates between the sets of values |
| * specifed in <code>PropertyValueHolder</code> objects. This variant should |
| * be used when animating several properties at once with the same ObjectAnimator, since |
| * PropertyValuesHolder allows you to associate a set of animation values with a property |
| * name. |
| * |
| * @param target The object whose property is to be animated. This object should |
| * have public methods on it called <code>setName()</code>, where <code>name</code> is |
| * the name of the property passed in as the <code>propertyName</code> parameter for |
| * each of the PropertyValuesHolder objects. |
| * @param values A set of PropertyValuesHolder objects whose values will be animated |
| * between over time. |
| * @return A ValueAnimator object that is set up to animate between the given values. |
| */ |
| public static ObjectAnimator ofPropertyValuesHolder(Object target, |
| PropertyValuesHolder... values) { |
| ObjectAnimator anim = new ObjectAnimator(); |
| anim.mTarget = target; |
| anim.setValues(values); |
| return anim; |
| } |
| |
| @Override |
| public void setIntValues(int... values) { |
| if (mValues == null || mValues.length == 0) { |
| // No values yet - this animator is being constructed piecemeal. Init the values with |
| // whatever the current propertyName is |
| setValues(PropertyValuesHolder.ofInt(mPropertyName, values)); |
| } else { |
| super.setIntValues(values); |
| } |
| } |
| |
| @Override |
| public void setFloatValues(float... values) { |
| if (mValues == null || mValues.length == 0) { |
| // No values yet - this animator is being constructed piecemeal. Init the values with |
| // whatever the current propertyName is |
| setValues(PropertyValuesHolder.ofFloat(mPropertyName, values)); |
| } else { |
| super.setFloatValues(values); |
| } |
| } |
| |
| @Override |
| public void setObjectValues(Object... values) { |
| if (mValues == null || mValues.length == 0) { |
| // No values yet - this animator is being constructed piecemeal. Init the values with |
| // whatever the current propertyName is |
| setValues(PropertyValuesHolder.ofObject(mPropertyName, (TypeEvaluator)null, values)); |
| } else { |
| super.setObjectValues(values); |
| } |
| } |
| |
| @Override |
| public void start() { |
| if (DBG) { |
| Log.d("ObjectAnimator", "Anim target, duration" + mTarget + ", " + getDuration()); |
| for (int i = 0; i < mValues.length; ++i) { |
| PropertyValuesHolder pvh = mValues[i]; |
| ArrayList<Keyframe> keyframes = pvh.mKeyframeSet.mKeyframes; |
| Log.d("ObjectAnimator", " Values[" + i + "]: " + |
| pvh.getPropertyName() + ", " + keyframes.get(0).getValue() + ", " + |
| keyframes.get(pvh.mKeyframeSet.mNumKeyframes - 1).getValue()); |
| } |
| } |
| super.start(); |
| } |
| |
| /** |
| * This function is called immediately before processing the first animation |
| * frame of an animation. If there is a nonzero <code>startDelay</code>, the |
| * function is called after that delay ends. |
| * It takes care of the final initialization steps for the |
| * animation. This includes setting mEvaluator, if the user has not yet |
| * set it up, and the setter/getter methods, if the user did not supply |
| * them. |
| * |
| * <p>Overriders of this method should call the superclass method to cause |
| * internal mechanisms to be set up correctly.</p> |
| */ |
| @Override |
| void initAnimation() { |
| if (!mInitialized) { |
| // mValueType may change due to setter/getter setup; do this before calling super.init(), |
| // which uses mValueType to set up the default type evaluator. |
| int numValues = mValues.length; |
| for (int i = 0; i < numValues; ++i) { |
| mValues[i].setupSetterAndGetter(mTarget); |
| } |
| super.initAnimation(); |
| } |
| } |
| |
| /** |
| * Sets the length of the animation. The default duration is 300 milliseconds. |
| * |
| * @param duration The length of the animation, in milliseconds. |
| * @return ObjectAnimator The object called with setDuration(). This return |
| * value makes it easier to compose statements together that construct and then set the |
| * duration, as in |
| * <code>ObjectAnimator.ofInt(target, propertyName, 0, 10).setDuration(500).start()</code>. |
| */ |
| @Override |
| public ObjectAnimator setDuration(long duration) { |
| super.setDuration(duration); |
| return this; |
| } |
| |
| |
| /** |
| * The target object whose property will be animated by this animation |
| * |
| * @return The object being animated |
| */ |
| public Object getTarget() { |
| return mTarget; |
| } |
| |
| /** |
| * Sets the target object whose property will be animated by this animation |
| * |
| * @param target The object being animated |
| */ |
| @Override |
| public void setTarget(Object target) { |
| if (mTarget != target) { |
| final Object oldTarget = mTarget; |
| mTarget = target; |
| if (oldTarget != null && target != null && oldTarget.getClass() == target.getClass()) { |
| return; |
| } |
| // New target type should cause re-initialization prior to starting |
| mInitialized = false; |
| } |
| } |
| |
| @Override |
| public void setupStartValues() { |
| initAnimation(); |
| int numValues = mValues.length; |
| for (int i = 0; i < numValues; ++i) { |
| mValues[i].setupStartValue(mTarget); |
| } |
| } |
| |
| @Override |
| public void setupEndValues() { |
| initAnimation(); |
| int numValues = mValues.length; |
| for (int i = 0; i < numValues; ++i) { |
| mValues[i].setupEndValue(mTarget); |
| } |
| } |
| |
| /** |
| * This method is called with the elapsed fraction of the animation during every |
| * animation frame. This function turns the elapsed fraction into an interpolated fraction |
| * and then into an animated value (from the evaluator. The function is called mostly during |
| * animation updates, but it is also called when the <code>end()</code> |
| * function is called, to set the final value on the property. |
| * |
| * <p>Overrides of this method must call the superclass to perform the calculation |
| * of the animated value.</p> |
| * |
| * @param fraction The elapsed fraction of the animation. |
| */ |
| @Override |
| void animateValue(float fraction) { |
| super.animateValue(fraction); |
| int numValues = mValues.length; |
| for (int i = 0; i < numValues; ++i) { |
| mValues[i].setAnimatedValue(mTarget); |
| } |
| } |
| |
| @Override |
| public ObjectAnimator clone() { |
| final ObjectAnimator anim = (ObjectAnimator) super.clone(); |
| return anim; |
| } |
| } |