forked from genail/pulpcore
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAnimation.java
More file actions
390 lines (344 loc) · 13 KB
/
Animation.java
File metadata and controls
390 lines (344 loc) · 13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
/*
Copyright (c) 2008, Interactive Pulp, LLC
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of Interactive Pulp, LLC nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
package pulpcore.animation;
import pulpcore.Build;
/**
An Animation changes state over a specific duration. It is up to subclasses to
implement the {@link #updateState(int)} method to change the state as the Animation is updated
over time. An Animation is updated over time with its {@link #update(int)} method, which is
typically called by a {@link Timeline} or, in the case of a {@link Tween}, by the
{@link Property} it is attached to.
<p>
A simple Animation starts immediately:
<pre>
|===================|
0 duration end
------- time ------->
</pre>
<p>Animations can delay before they start:
<pre>
|--------------|===================|
0 startDelay duration end
---------------- time --------------->
</pre>
<p>Animations can loop:
<pre>
|--------------|===================|===================|===================|
0 startDelay duration duration duration end
----------------------------------- time ------------------------------------>
</pre>
<p>Animations can have a delay between loops:
<pre>
|--------------|================|------|================|------|================|
0 startDelay duration loop duration loop duration end
delay delay
------------------------------------- time ------------------------------------->
</pre>
<p>Also, Animations can have an {@link Easing} to make the Animation look more smooth.
*/
public abstract class Animation {
/**
Value indicating that the Animation loops forever.
@see #loopForever()
@see #getTotalDuration()
*/
public static final int LOOP_FOREVER = -1;
/* package-private */ static final int SECTION_START_DELAY = 0;
/* package-private */ static final int SECTION_ANIMATION = 1;
/* package-private */ static final int SECTION_LOOP_DELAY = 2;
private final Easing easing;
private final int startDelay;
private int duration;
private int numLoops;
private int loopDelay;
private int elapsedTime;
public Animation(int duration) {
this(duration, null, 0);
}
public Animation(int duration, Easing easing) {
this(duration, easing, 0);
}
public Animation(int duration, Easing easing, int startDelay) {
if (Build.DEBUG) {
if (duration < 0) {
throw new IllegalArgumentException("Duration cannot be < 0");
}
if (startDelay < 0) {
throw new IllegalArgumentException("Start delay cannot be < 0");
}
}
this.duration = duration;
this.easing = easing;
this.startDelay = startDelay;
loop(1, 0);
}
/**
Causes this animation to loop indefinitely. Same as {@code loop(LOOP_FOREVER, 0)}.
<p>
If the duration is 0 this call is ignored.
@throws IllegalArgumentException if duration is 0
*/
public final void loopForever() {
loop(LOOP_FOREVER, 0);
}
/**
Causes this animation to loop indefinitely. Same as {@code loop(LOOP_FOREVER, loopDelay)}.
<p>
If the duration is 0 and loopDelay is 0, this call is ignored.
@param loopDelay The delay between the end of a duration and the start of a new one.
@throws IllegalArgumentException if loopDelay is negative.
@throws IllegalArgumentException if duration is 0 and loopDelay is 0.
*/
public final void loopForever(int loopDelay) {
loop(LOOP_FOREVER, loopDelay);
}
/**
Sets the number of loops to play. A value of {@link #LOOP_FOREVER} causes this timeline
to play indefinitely.
<p>
If looping (numLoops != 1), and the duration is 0, this call is ignored.
@param numLoops The number of times to loop the duration. A value of 1 means the duration
is played exactly once.
@throws IllegalArgumentException if numLoops is not LOOP_FOREVER but is < 1.
*/
public final void loop(int numLoops) {
loop(numLoops, 0);
}
/**
Sets the number of loops to play. A value of {@link #LOOP_FOREVER} causes this timeline
to play indefinitely.
<p>
If looping (numLoops != 1), and the duration is 0, and loopDelay is 0, this call is ignored.
@param numLoops The number of times to loop the duration. A value of 1 means the duration
is played exactly once.
@param loopDelay The delay between the end of one duration and the start of the next one.
@throws IllegalArgumentException if numLoops is not LOOP_FOREVER but is < 1.
@throws IllegalArgumentException if loopDelay is negative.
@throws IllegalArgumentException if looping (numLoops != 1), duration is 0, and loopDelay is 0.
*/
public final void loop(int numLoops, int loopDelay) {
if (Build.DEBUG) {
if (!(numLoops == LOOP_FOREVER || numLoops > 0)) {
throw new IllegalArgumentException("numLoops must be > 0 or LOOP_FOREVER");
}
if (loopDelay < 0) {
throw new IllegalArgumentException("Loop delay cannot be < 0");
}
}
if (duration == 0 && numLoops != 1 && loopDelay == 0) {
// Can't loop!
this.numLoops = 1;
//throw new IllegalArgumentException("Loop delay cannot be 0 if duration is 0 and " +
// "numLoops != 1");
}
else {
this.numLoops = numLoops;
this.loopDelay = loopDelay;
}
}
public final int getStartDelay() {
return startDelay;
}
public final int getDuration() {
return duration;
}
public final Easing getEasing() {
return easing;
}
/* package-private */ final void setDuration(int duration) {
this.duration = duration;
}
public final int getNumLoops() {
return numLoops;
}
public final int getLoopDelay() {
return loopDelay;
}
/**
Returns the total duration including the start delay and loops.
*/
public final int getTotalDuration() {
if (numLoops == LOOP_FOREVER) {
return LOOP_FOREVER;
}
else {
return startDelay + duration * numLoops + loopDelay * (numLoops - 1);
}
}
public final int getTime() {
return elapsedTime;
}
private final int getAnimTime() {
return getAnimTime(elapsedTime);
}
private final int getAnimTime(int elapsedTime) {
int animTime = elapsedTime - startDelay;
if (animTime > 0 && numLoops != 1) {
if (numLoops == LOOP_FOREVER) {
animTime %= (duration + loopDelay);
}
else {
int total = getTotalDuration() - startDelay;
if (animTime >= total) {
animTime -= total + duration + loopDelay;
}
else {
animTime %= (duration + loopDelay);
}
}
}
return animTime;
}
/**
Returns -1 if time < startDelay
*/
/* package private */ final int getAnimLoop(int elapsedTime) {
int animTime = elapsedTime - startDelay;
if (animTime < 0) {
return -1;
}
else if (duration + loopDelay <= 0) {
return 0;
}
else {
int loop = animTime / (duration + loopDelay);
if (numLoops == LOOP_FOREVER) {
return loop;
}
else {
return Math.min(numLoops-1, loop);
}
}
}
private final int getLoopStartTime(int loop) {
if (loop < 0) {
return 0;
}
else {
return startDelay + loop * (duration + loopDelay);
}
}
/* package-private */ final int getSection() {
return getSection(elapsedTime);
}
/* package-private */ final int getSection(int elapsedTime) {
int animTime = getAnimTime(elapsedTime);
if (animTime < 0) {
return SECTION_START_DELAY;
}
else if (animTime < duration) {
return SECTION_ANIMATION;
}
else {
return SECTION_LOOP_DELAY;
}
}
public final boolean isFinished() {
if (numLoops == LOOP_FOREVER) {
return false;
}
else {
return elapsedTime >= getTotalDuration();
}
}
/**
Sets the current time to the end of this animation. If this animation loop forever,
the time is set to the end of the current loop.
*/
public final void fastForward() {
if (numLoops == LOOP_FOREVER) {
int loop = 0;
int animTime = elapsedTime - startDelay;
if (animTime >= 0) {
loop = animTime / (duration + loopDelay);
}
this.numLoops = loop;
}
setTime(getTotalDuration());
}
public final void rewind() {
setTime(0);
}
public boolean update(int elapsedTime) {
return update(elapsedTime, false);
}
/* package private */ boolean update(int elapsedTime, boolean parentLooped) {
int newTime = this.elapsedTime + elapsedTime;
int oldLoop = getAnimLoop(this.elapsedTime);
int newLoop = getAnimLoop(newTime);
if (oldLoop != newLoop && elapsedTime > 0) {
// Trigger events
for (int i = oldLoop; i < newLoop; i++) {
if (!setTime(getLoopStartTime(i+1))) {
updateState(duration);
}
}
if (this.elapsedTime != newTime) {
setTime(newTime);
}
return true;
}
else if (parentLooped) {
if (!setTime(newTime)) {
updateState(duration);
}
return true;
}
else {
return setTime(newTime);
}
}
private final boolean setTime(int newTime) {
// Takes care of special case where elapsedTime, startDelay and duration are 0
int oldState = (elapsedTime <= 0) ? SECTION_START_DELAY : getSection();
this.elapsedTime = newTime;
int newState = getSection();
if (newState == SECTION_ANIMATION) {
int animTime = getAnimTime();
if (easing != null) {
animTime = easing.ease(animTime, duration);
}
updateState(animTime);
return true;
}
else if ((newState == SECTION_LOOP_DELAY && oldState != SECTION_LOOP_DELAY) ||
(newState == SECTION_START_DELAY && oldState == SECTION_ANIMATION))
{
updateState(duration);
return true;
}
else {
return false;
}
}
/**
Updates the state based on the animation time, typically from 0 to {@link #getDuration()}.
Note that the duration can be zero.
@param animTime The animation time, typically from 0 to {@link #getDuration()}, although
an {@link Easing} can cause the value to be outside those bounds.
*/
protected abstract void updateState(int animTime);
}