Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2010 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.animation; |
| 18 | |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 19 | import java.util.Arrays; |
Yigit Boyar | d422dc3 | 2014-09-25 12:23:35 -0700 | [diff] [blame] | 20 | import java.util.List; |
| 21 | |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 22 | import android.animation.Keyframe.IntKeyframe; |
| 23 | import android.animation.Keyframe.FloatKeyframe; |
| 24 | import android.animation.Keyframe.ObjectKeyframe; |
George Mount | 984011f | 2014-08-21 14:28:01 -0700 | [diff] [blame] | 25 | import android.graphics.Path; |
Chet Haase | 2076316 | 2013-03-15 13:48:53 -0700 | [diff] [blame] | 26 | import android.util.Log; |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 27 | |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 28 | /** |
Chet Haase | a18a86b | 2010-09-07 13:20:00 -0700 | [diff] [blame] | 29 | * This class holds a collection of Keyframe objects and is called by ValueAnimator to calculate |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 30 | * values between those keyframes for a given animation. The class internal to the animation |
| 31 | * package because it is an implementation detail of how Keyframes are stored and used. |
Jorim Jaggi | 787e9dd | 2016-03-15 10:52:40 +0100 | [diff] [blame] | 32 | * @hide |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 33 | */ |
Jorim Jaggi | 787e9dd | 2016-03-15 10:52:40 +0100 | [diff] [blame] | 34 | public class KeyframeSet implements Keyframes { |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 35 | |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 36 | int mNumKeyframes; |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 37 | |
Chet Haase | 70d4ba1 | 2010-10-06 09:46:45 -0700 | [diff] [blame] | 38 | Keyframe mFirstKeyframe; |
| 39 | Keyframe mLastKeyframe; |
| 40 | TimeInterpolator mInterpolator; // only used in the 2-keyframe case |
Yigit Boyar | d422dc3 | 2014-09-25 12:23:35 -0700 | [diff] [blame] | 41 | List<Keyframe> mKeyframes; // only used when there are not 2 keyframes |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 42 | TypeEvaluator mEvaluator; |
| 43 | |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 44 | |
| 45 | public KeyframeSet(Keyframe... keyframes) { |
Chet Haase | 70d4ba1 | 2010-10-06 09:46:45 -0700 | [diff] [blame] | 46 | mNumKeyframes = keyframes.length; |
Yigit Boyar | d422dc3 | 2014-09-25 12:23:35 -0700 | [diff] [blame] | 47 | // immutable list |
| 48 | mKeyframes = Arrays.asList(keyframes); |
| 49 | mFirstKeyframe = keyframes[0]; |
| 50 | mLastKeyframe = keyframes[mNumKeyframes - 1]; |
Chet Haase | 70d4ba1 | 2010-10-06 09:46:45 -0700 | [diff] [blame] | 51 | mInterpolator = mLastKeyframe.getInterpolator(); |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 52 | } |
| 53 | |
Yigit Boyar | 8619f48 | 2014-07-15 17:28:07 -0700 | [diff] [blame] | 54 | /** |
| 55 | * If subclass has variables that it calculates based on the Keyframes, it should reset them |
| 56 | * when this method is called because Keyframe contents might have changed. |
| 57 | */ |
George Mount | 984011f | 2014-08-21 14:28:01 -0700 | [diff] [blame] | 58 | @Override |
| 59 | public void invalidateCache() { |
| 60 | } |
| 61 | |
Yigit Boyar | d422dc3 | 2014-09-25 12:23:35 -0700 | [diff] [blame] | 62 | public List<Keyframe> getKeyframes() { |
George Mount | 984011f | 2014-08-21 14:28:01 -0700 | [diff] [blame] | 63 | return mKeyframes; |
Yigit Boyar | 8619f48 | 2014-07-15 17:28:07 -0700 | [diff] [blame] | 64 | } |
| 65 | |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 66 | public static KeyframeSet ofInt(int... values) { |
| 67 | int numKeyframes = values.length; |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 68 | IntKeyframe keyframes[] = new IntKeyframe[Math.max(numKeyframes,2)]; |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 69 | if (numKeyframes == 1) { |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 70 | keyframes[0] = (IntKeyframe) Keyframe.ofInt(0f); |
| 71 | keyframes[1] = (IntKeyframe) Keyframe.ofInt(1f, values[0]); |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 72 | } else { |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 73 | keyframes[0] = (IntKeyframe) Keyframe.ofInt(0f, values[0]); |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 74 | for (int i = 1; i < numKeyframes; ++i) { |
Chet Haase | 2076316 | 2013-03-15 13:48:53 -0700 | [diff] [blame] | 75 | keyframes[i] = |
| 76 | (IntKeyframe) Keyframe.ofInt((float) i / (numKeyframes - 1), values[i]); |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 77 | } |
| 78 | } |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 79 | return new IntKeyframeSet(keyframes); |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 80 | } |
| 81 | |
| 82 | public static KeyframeSet ofFloat(float... values) { |
Chet Haase | 2076316 | 2013-03-15 13:48:53 -0700 | [diff] [blame] | 83 | boolean badValue = false; |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 84 | int numKeyframes = values.length; |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 85 | FloatKeyframe keyframes[] = new FloatKeyframe[Math.max(numKeyframes,2)]; |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 86 | if (numKeyframes == 1) { |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 87 | keyframes[0] = (FloatKeyframe) Keyframe.ofFloat(0f); |
| 88 | keyframes[1] = (FloatKeyframe) Keyframe.ofFloat(1f, values[0]); |
Chet Haase | 2076316 | 2013-03-15 13:48:53 -0700 | [diff] [blame] | 89 | if (Float.isNaN(values[0])) { |
| 90 | badValue = true; |
| 91 | } |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 92 | } else { |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 93 | keyframes[0] = (FloatKeyframe) Keyframe.ofFloat(0f, values[0]); |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 94 | for (int i = 1; i < numKeyframes; ++i) { |
Chet Haase | 2076316 | 2013-03-15 13:48:53 -0700 | [diff] [blame] | 95 | keyframes[i] = |
| 96 | (FloatKeyframe) Keyframe.ofFloat((float) i / (numKeyframes - 1), values[i]); |
| 97 | if (Float.isNaN(values[i])) { |
| 98 | badValue = true; |
| 99 | } |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 100 | } |
| 101 | } |
Chet Haase | 2076316 | 2013-03-15 13:48:53 -0700 | [diff] [blame] | 102 | if (badValue) { |
| 103 | Log.w("Animator", "Bad value (NaN) in float animator"); |
| 104 | } |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 105 | return new FloatKeyframeSet(keyframes); |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 106 | } |
| 107 | |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 108 | public static KeyframeSet ofKeyframe(Keyframe... keyframes) { |
| 109 | // if all keyframes of same primitive type, create the appropriate KeyframeSet |
| 110 | int numKeyframes = keyframes.length; |
| 111 | boolean hasFloat = false; |
| 112 | boolean hasInt = false; |
| 113 | boolean hasOther = false; |
| 114 | for (int i = 0; i < numKeyframes; ++i) { |
| 115 | if (keyframes[i] instanceof FloatKeyframe) { |
| 116 | hasFloat = true; |
| 117 | } else if (keyframes[i] instanceof IntKeyframe) { |
| 118 | hasInt = true; |
| 119 | } else { |
| 120 | hasOther = true; |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 121 | } |
| 122 | } |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 123 | if (hasFloat && !hasInt && !hasOther) { |
| 124 | FloatKeyframe floatKeyframes[] = new FloatKeyframe[numKeyframes]; |
| 125 | for (int i = 0; i < numKeyframes; ++i) { |
| 126 | floatKeyframes[i] = (FloatKeyframe) keyframes[i]; |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 127 | } |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 128 | return new FloatKeyframeSet(floatKeyframes); |
| 129 | } else if (hasInt && !hasFloat && !hasOther) { |
| 130 | IntKeyframe intKeyframes[] = new IntKeyframe[numKeyframes]; |
| 131 | for (int i = 0; i < numKeyframes; ++i) { |
| 132 | intKeyframes[i] = (IntKeyframe) keyframes[i]; |
| 133 | } |
| 134 | return new IntKeyframeSet(intKeyframes); |
| 135 | } else { |
| 136 | return new KeyframeSet(keyframes); |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 137 | } |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 138 | } |
| 139 | |
| 140 | public static KeyframeSet ofObject(Object... values) { |
| 141 | int numKeyframes = values.length; |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 142 | ObjectKeyframe keyframes[] = new ObjectKeyframe[Math.max(numKeyframes,2)]; |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 143 | if (numKeyframes == 1) { |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 144 | keyframes[0] = (ObjectKeyframe) Keyframe.ofObject(0f); |
| 145 | keyframes[1] = (ObjectKeyframe) Keyframe.ofObject(1f, values[0]); |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 146 | } else { |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 147 | keyframes[0] = (ObjectKeyframe) Keyframe.ofObject(0f, values[0]); |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 148 | for (int i = 1; i < numKeyframes; ++i) { |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 149 | keyframes[i] = (ObjectKeyframe) Keyframe.ofObject((float) i / (numKeyframes - 1), values[i]); |
Chet Haase | 2794eb3 | 2010-10-12 16:29:28 -0700 | [diff] [blame] | 150 | } |
| 151 | } |
| 152 | return new KeyframeSet(keyframes); |
| 153 | } |
| 154 | |
George Mount | 984011f | 2014-08-21 14:28:01 -0700 | [diff] [blame] | 155 | public static PathKeyframes ofPath(Path path) { |
| 156 | return new PathKeyframes(path); |
| 157 | } |
| 158 | |
George Mount | fd3c474 | 2014-09-08 13:23:36 -0700 | [diff] [blame] | 159 | public static PathKeyframes ofPath(Path path, float error) { |
| 160 | return new PathKeyframes(path, error); |
| 161 | } |
| 162 | |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 163 | /** |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 164 | * Sets the TypeEvaluator to be used when calculating animated values. This object |
| 165 | * is required only for KeyframeSets that are not either IntKeyframeSet or FloatKeyframeSet, |
| 166 | * both of which assume their own evaluator to speed up calculations with those primitive |
| 167 | * types. |
| 168 | * |
| 169 | * @param evaluator The TypeEvaluator to be used to calculate animated values. |
| 170 | */ |
| 171 | public void setEvaluator(TypeEvaluator evaluator) { |
| 172 | mEvaluator = evaluator; |
| 173 | } |
| 174 | |
| 175 | @Override |
George Mount | 984011f | 2014-08-21 14:28:01 -0700 | [diff] [blame] | 176 | public Class getType() { |
| 177 | return mFirstKeyframe.getType(); |
| 178 | } |
| 179 | |
| 180 | @Override |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 181 | public KeyframeSet clone() { |
Yigit Boyar | d422dc3 | 2014-09-25 12:23:35 -0700 | [diff] [blame] | 182 | List<Keyframe> keyframes = mKeyframes; |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 183 | int numKeyframes = mKeyframes.size(); |
Yigit Boyar | d422dc3 | 2014-09-25 12:23:35 -0700 | [diff] [blame] | 184 | final Keyframe[] newKeyframes = new Keyframe[numKeyframes]; |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 185 | for (int i = 0; i < numKeyframes; ++i) { |
| 186 | newKeyframes[i] = keyframes.get(i).clone(); |
| 187 | } |
| 188 | KeyframeSet newSet = new KeyframeSet(newKeyframes); |
| 189 | return newSet; |
| 190 | } |
| 191 | |
| 192 | /** |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 193 | * Gets the animated value, given the elapsed fraction of the animation (interpolated by the |
| 194 | * animation's interpolator) and the evaluator used to calculate in-between values. This |
| 195 | * function maps the input fraction to the appropriate keyframe interval and a fraction |
| 196 | * between them and returns the interpolated value. Note that the input fraction may fall |
| 197 | * outside the [0-1] bounds, if the animation's interpolator made that happen (e.g., a |
| 198 | * spring interpolation that might send the fraction past 1.0). We handle this situation by |
| 199 | * just using the two keyframes at the appropriate end when the value is outside those bounds. |
| 200 | * |
| 201 | * @param fraction The elapsed fraction of the animation |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 202 | * @return The animated value. |
| 203 | */ |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 204 | public Object getValue(float fraction) { |
Chet Haase | 70d4ba1 | 2010-10-06 09:46:45 -0700 | [diff] [blame] | 205 | // Special-case optimization for the common case of only two keyframes |
| 206 | if (mNumKeyframes == 2) { |
| 207 | if (mInterpolator != null) { |
| 208 | fraction = mInterpolator.getInterpolation(fraction); |
| 209 | } |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 210 | return mEvaluator.evaluate(fraction, mFirstKeyframe.getValue(), |
Chet Haase | 70d4ba1 | 2010-10-06 09:46:45 -0700 | [diff] [blame] | 211 | mLastKeyframe.getValue()); |
| 212 | } |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 213 | if (fraction <= 0f) { |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 214 | final Keyframe nextKeyframe = mKeyframes.get(1); |
Chet Haase | e0ee2e9 | 2010-10-07 09:06:18 -0700 | [diff] [blame] | 215 | final TimeInterpolator interpolator = nextKeyframe.getInterpolator(); |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 216 | if (interpolator != null) { |
| 217 | fraction = interpolator.getInterpolation(fraction); |
| 218 | } |
Chet Haase | 70d4ba1 | 2010-10-06 09:46:45 -0700 | [diff] [blame] | 219 | final float prevFraction = mFirstKeyframe.getFraction(); |
| 220 | float intervalFraction = (fraction - prevFraction) / |
| 221 | (nextKeyframe.getFraction() - prevFraction); |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 222 | return mEvaluator.evaluate(intervalFraction, mFirstKeyframe.getValue(), |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 223 | nextKeyframe.getValue()); |
| 224 | } else if (fraction >= 1f) { |
| 225 | final Keyframe prevKeyframe = mKeyframes.get(mNumKeyframes - 2); |
Chet Haase | 70d4ba1 | 2010-10-06 09:46:45 -0700 | [diff] [blame] | 226 | final TimeInterpolator interpolator = mLastKeyframe.getInterpolator(); |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 227 | if (interpolator != null) { |
| 228 | fraction = interpolator.getInterpolation(fraction); |
| 229 | } |
Chet Haase | 70d4ba1 | 2010-10-06 09:46:45 -0700 | [diff] [blame] | 230 | final float prevFraction = prevKeyframe.getFraction(); |
| 231 | float intervalFraction = (fraction - prevFraction) / |
| 232 | (mLastKeyframe.getFraction() - prevFraction); |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 233 | return mEvaluator.evaluate(intervalFraction, prevKeyframe.getValue(), |
Chet Haase | 70d4ba1 | 2010-10-06 09:46:45 -0700 | [diff] [blame] | 234 | mLastKeyframe.getValue()); |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 235 | } |
Chet Haase | 70d4ba1 | 2010-10-06 09:46:45 -0700 | [diff] [blame] | 236 | Keyframe prevKeyframe = mFirstKeyframe; |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 237 | for (int i = 1; i < mNumKeyframes; ++i) { |
| 238 | Keyframe nextKeyframe = mKeyframes.get(i); |
| 239 | if (fraction < nextKeyframe.getFraction()) { |
Chet Haase | e0ee2e9 | 2010-10-07 09:06:18 -0700 | [diff] [blame] | 240 | final TimeInterpolator interpolator = nextKeyframe.getInterpolator(); |
Chet Haase | 70d4ba1 | 2010-10-06 09:46:45 -0700 | [diff] [blame] | 241 | final float prevFraction = prevKeyframe.getFraction(); |
| 242 | float intervalFraction = (fraction - prevFraction) / |
| 243 | (nextKeyframe.getFraction() - prevFraction); |
Doris Liu | 6df9905 | 2015-03-30 16:03:59 -0700 | [diff] [blame] | 244 | // Apply interpolator on the proportional duration. |
| 245 | if (interpolator != null) { |
| 246 | intervalFraction = interpolator.getInterpolation(intervalFraction); |
| 247 | } |
Chet Haase | 7c608f2 | 2010-10-22 17:54:04 -0700 | [diff] [blame] | 248 | return mEvaluator.evaluate(intervalFraction, prevKeyframe.getValue(), |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 249 | nextKeyframe.getValue()); |
| 250 | } |
| 251 | prevKeyframe = nextKeyframe; |
| 252 | } |
Chet Haase | 70d4ba1 | 2010-10-06 09:46:45 -0700 | [diff] [blame] | 253 | // shouldn't reach here |
| 254 | return mLastKeyframe.getValue(); |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 255 | } |
Chet Haase | e9140a7 | 2011-02-16 16:23:29 -0800 | [diff] [blame] | 256 | |
| 257 | @Override |
| 258 | public String toString() { |
| 259 | String returnVal = " "; |
| 260 | for (int i = 0; i < mNumKeyframes; ++i) { |
| 261 | returnVal += mKeyframes.get(i).getValue() + " "; |
| 262 | } |
| 263 | return returnVal; |
| 264 | } |
Chet Haase | 3dd207a | 2010-07-20 14:00:01 -0700 | [diff] [blame] | 265 | } |