TimelineLite.as
54.1 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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
/**
* VERSION: 1.382
* DATE: 2010-05-25
* AS3 (AS2 version is also available)
* UPDATES AND DOCUMENTATION AT: http://www.greensock.com/timelinelite/
**/
package com.greensock {
import com.greensock.core.*;
import flash.utils.*;
/**
* TimelineLite is a lightweight, intuitive timeline class for building and managing sequences of
* TweenLite, TweenMax, TimelineLite, and/or TimelineMax instances. You can think of a TimelineLite instance
* like a virtual MovieClip timeline or a container where you place tweens (or other timelines) over the
* course of time. You can:
* <ul>
* <li> build sequences easily by adding tweens with the append(), prepend(), insert(), appendMultiple(), prependMultiple(),
* and insertMultiple() methods. Tweens can overlap as much as you want and you have complete control over where
* they get placed on the timeline.</li>
*
* <li> add labels, play(), stop(), gotoAndPlay(), gotoAndStop(), restart(), and even reverse() smoothly anytime. </li>
*
* <li> nest timelines within timelines as deeply as you want.</li>
*
* <li> set the progress of the timeline using its <code>currentProgress</code> property. For example, to skip to
* the halfway point, set <code>myTimeline.currentProgress = 0.5</code>. </li>
*
* <li> tween the <code>currentTime</code> or <code>currentProgress</code> property to fastforward/rewind
* the timeline. You could even attach a slider to one of these properties to give the user the ability
* to drag forwards/backwards through the timeline.</li>
*
* <li> speed up or slow down the entire timeline with its timeScale property. You can even tween
* this property to gradually speed up or slow down.</li>
*
* <li> add onComplete, onStart, onUpdate, and/or onReverseComplete callbacks using the constructor's <code>vars</code> object.</li>
*
* <li> use the <code>insertMultiple()</code> or <code>appendMultiple()</code> methods to create complex sequences including
* various alignment modes and staggering capabilities.</li>
*
* <li> base the timing on frames instead of seconds if you prefer. Please note, however, that
* the timeline's timing mode dictates its childrens' timing mode as well. </li>
*
* <li> kill the tweens of a particular object with <code>killTweensOf()</code> or get the tweens of an object
* with <code>getTweensOf()</code> or get all the tweens/timelines in the timeline with <code>getChildren()</code></li>
*
* <li> If you need even more features like AS3 event listeners, <code>repeat, repeatDelay, yoyo, currentLabel,
* getLabelAfter(), getLabelBefore(), addCallback(), removeCallback(), getActive()</code> and more, check out
* TimelineMax which extends TimelineLite.</li>
* </ul>
*
* <b>EXAMPLE:</b><br /><br /><code>
*
* import com.greensock.~~;<br /><br />
*
* //create the timeline and add an onComplete callback that will call myFunction() when the timeline completes<br />
* var myTimeline:TimelineLite = new TimelineLite({onComplete:myFunction});<br /><br />
*
* //add a tween<br />
* myTimeline.append(new TweenLite(mc, 1, {x:200, y:100}));<br /><br />
*
* //add another tween at the end of the timeline (makes sequencing easy)<br />
* myTimeline.append(new TweenLite(mc, 0.5, {alpha:0}));<br /><br />
*
* //reverse anytime<br />
* myTimeline.reverse();<br /><br />
*
* //Add a "spin" label 3-seconds into the timeline<br />
* myTimeline.addLabel("spin", 3);<br /><br />
*
* //insert a rotation tween at the "spin" label (you could also define the insert point as the time instead of a label)<br />
* myTimeline.insert(new TweenLite(mc, 2, {rotation:"360"}), "spin"); <br /><br />
*
* //go to the "spin" label and play the timeline from there<br />
* myTimeline.gotoAndPlay("spin");<br /><br />
*
* //add a tween to the beginning of the timeline, pushing all the other existing tweens back in time<br />
* myTimeline.prepend(new TweenMax(mc, 1, {tint:0xFF0000}));<br /><br />
*
* //nest another TimelineLite inside your timeline...<br />
* var nestedTimeline:TimelineLite = new TimelineLite();<br />
* nestedTimeline.append(new TweenLite(mc2, 1, {x:200}));<br />
* myTimeline.append(nestedTimeline);<br /><br /></code>
*
*
* insertMultiple() and appendMultiple() provide some very powerful sequencing tools, allowing you to add an Array of
* tweens or timelines and optionally align them with SEQUENCE or START modes, and even stagger them if you want.
* For example, to insert 3 tweens into the timeline, aligning their start times but staggering them by 0.2 seconds, <br /><br /><code>
*
* myTimeline.insertMultiple([new TweenLite(mc, 1, {y:"100"}),
* new TweenLite(mc2, 1, {x:20}),
* new TweenLite(mc3, 1, {alpha:0.5})],
* 0,
* TweenAlign.START,
* 0.2);</code><br /><br />
*
* You can use the constructor's "vars" object to do virtually all the setup too, like this sequence:<br /><br /><code>
*
* var myTimeline:TimelineLite = new TimelineLite({tweens:[new TweenLite(mc1, 1, {y:"100"}), TweenMax.to(mc2, 1, {tint:0xFF0000})], align:TweenAlign.SEQUENCE, onComplete:myFunction});</code><br /><br />
*
* If that confuses you, don't worry. Just use the <code>append(), insert()</code>, and <code>prepend()</code> methods to build your
* sequence. But power users will likely appreciate the quick, compact way they can set up sequences now. <br /><br />
*
*
* <b>NOTES:</b>
* <ul>
* <li> TimelineLite automatically inits the OverwriteManager class to prevent unexpected overwriting behavior in sequences.
* The default mode is <code>AUTO</code>, but you can set it to whatever you want with <code>OverwriteManager.init()</code>
* (see <a href="http://www.greensock.com/overwritemanager/">http://www.greensock.com/overwritemanager/</a>)</li>
* <li> TimelineLite adds about 2.6k to your SWF (3.3kb including OverwriteManager).</li>
* </ul>
*
* <b>Copyright 2010, GreenSock. All rights reserved.</b> This work is subject to the terms in <a href="http://www.greensock.com/terms_of_use.html">http://www.greensock.com/terms_of_use.html</a> or for corporate Club GreenSock members, the software agreement that was issued with the corporate membership.
*
* @author Jack Doyle, jack@greensock.com
**/
public class TimelineLite extends SimpleTimeline {
/** @private **/
public static const version:Number = 1.382;
/** @private **/
private static var _overwriteMode:int = (OverwriteManager.enabled) ? OverwriteManager.mode : OverwriteManager.init(2); //Ensures that TweenLite instances don't overwrite each other before being put into the timeline/sequence.
/** @private **/
protected var _labels:Object;
/** @private Just stores the first and last tweens when the timeline is disabled (enabled=false). We do this in an Array in order to avoid circular references which can cause garbage collection issues (timeline referencing TweenCore, and TweenCore referencing timeline) **/
protected var _endCaps:Array;
/**
* Constructor. <br /><br />
*
* <b>SPECIAL PROPERTIES</b><br />
* The following special properties may be passed in via the constructor's vars parameter, like
* <code>new TimelineLite({paused:true, onComplete:myFunction})</code>
*
* <ul>
* <li><b> delay : Number</b> Amount of delay in seconds (or frames for frames-based timelines) before the timeline should begin.</li>
*
* <li><b> paused : Boolean</b> Sets the initial paused state of the timeline (by default, timelines automatically begin playing immediately)</li>
*
* <li><b> useFrames : Boolean</b> If useFrames is set to true, the timeline's timing mode will be based on frames.
* Otherwise, it will be based on seconds/time. NOTE: a TimelineLite's timing mode is
* always determined by its parent timeline. </li>
*
* <li><b> reversed : Boolean</b> If true, the timeline will be reversed initially. This does NOT force it to the very end and start
* playing backwards. It simply affects the orientation of the timeline, so if reversed is set to
* true initially, it will appear not to play because it is already at the beginning. To cause it to
* play backwards from the end, set reversed to true and then set the <code>currentProgress</code> property to 1 immediately
* after creating the timeline.</li>
*
* <li><b> tweens : Array</b> To immediately insert several tweens into the timeline, use the <code>tweens</code> special property
* to pass in an Array of TweenLite/TweenMax/TimelineLite/TimelineMax instances. You can use this in conjunction
* with the align and stagger special properties to set up complex sequences with minimal code.
* These values simply get passed to the insertMultiple() method.</li>
*
* <li><b> align : String</b> Only used in conjunction with the <code>tweens</code> special property when multiple tweens are
* to be inserted immediately. The value simply gets passed to the
* <code>insertMultiple()</code> method. The default is <code>TweenAlign.NORMAL</code>. Options are:
* <ul>
* <li><b> TweenAlign.SEQUENCE:</b> aligns the tweens one-after-the-other in a sequence</li>
* <li><b> TweenAlign.START:</b> aligns the start times of all of the tweens (ignores delays)</li>
* <li><b> TweenAlign.NORMAL:</b> aligns the start times of all the tweens (honors delays)</li>
* </ul>The <code>align</code> special property does <b>not</b> force all child tweens/timelines to maintain
* relative positioning, so for example, if you use TweenAlign.SEQUENCE and then later change the duration
* of one of the nested tweens, it does <b>not</b> force all subsequent timelines to change their position
* on the timeline. The <code>align</code> special property only affects the alignment of the tweens that are
* initially placed into the timeline through the <code>tweens</code> special property of the <code>vars</code> object.</li>
*
* <li><b> stagger : Number</b> Only used in conjunction with the <code>tweens</code> special property when multiple tweens are
* to be inserted immediately. It staggers the tweens by a set amount of time (in seconds) (or
* in frames if "useFrames" is true). For example, if the stagger value is 0.5 and the "align"
* property is set to TweenAlign.START, the second tween will start 0.5 seconds after the first one
* starts, then 0.5 seconds later the third one will start, etc. If the align property is
* TweenAlign.SEQUENCE, there would be 0.5 seconds added between each tween. This value simply gets
* passed to the insertMultiple() method. Default is 0.</li>
*
* <li><b> onStart : Function</b> A function that should be called when the timeline begins (the <code>currentProgress</code> won't necessarily
* be zero when <code>onStart</code> is called. For example, if the timeline is created and then its <code>currentProgress</code>
* property is immediately set to 0.5 or if its <code>currentTime</code> property is set to something other than zero,
* <code>onStart</code> will still get fired because it is the first time the timeline is getting rendered.)</li>
*
* <li><b> onStartParams : Array</b> An Array of parameters to pass the onStart function.</li>
*
* <li><b> onUpdate : Function</b> A function that should be called every time the timeline's time/position is updated
* (on every frame while the timeline is active)</li>
*
* <li><b> onUpdateParams : Array</b> An Array of parameters to pass the onUpdate function</li>
*
* <li><b> onComplete : Function</b> A function that should be called when the timeline has finished </li>
*
* <li><b> onCompleteParams : Array</b> An Array of parameters to pass the onComplete function</li>
*
* <li><b> onReverseComplete : Function</b> A function that should be called when the timeline has reached its starting point again after having been reversed </li>
*
* <li><b> onReverseCompleteParams : Array</b> An Array of parameters to pass the onReverseComplete functions</li>
*
* <li><b> autoRemoveChildren : Boolean</b> If autoRemoveChildren is set to true, as soon as child tweens/timelines complete,
* they will automatically get killed/removed. This is normally undesireable because
* it prevents going backwards in time (like if you want to <code>reverse()</code> or set the
* <code>currentProgress</code> value to a lower value, etc.). It can, however, improve speed and memory
* management. TweenLite's root timelines use <code>autoRemoveChildren:true</code>.</li>
* </ul>
*
* @param vars optionally pass in special properties like <code>useFrames, onComplete, onCompleteParams, onUpdate, onUpdateParams, onStart, onStartParams, tweens, align, stagger, delay, reversed,</code> and/or <code>autoRemoveChildren</code>.
*/
public function TimelineLite(vars:Object=null) {
super(vars);
_endCaps = [null, null];
_labels = {};
this.autoRemoveChildren = Boolean(this.vars.autoRemoveChildren == true);
_hasUpdate = Boolean(typeof(this.vars.onUpdate) == "function");
if (this.vars.tweens is Array) {
this.insertMultiple(this.vars.tweens, 0, (this.vars.align != null) ? this.vars.align : "normal", (this.vars.stagger) ? Number(this.vars.stagger) : 0);
}
}
/**
* @private
* Adds a TweenLite, TweenMax, TimelineLite, or TimelineMax instance to this timeline.
* Typically it is best to use the insert(), append(), or prepend() methods to add a tween
* or timeline, though. addChild() should generally be avoided (it is used primarily by other
* classes in the GreenSock tweening platform).
*
* @param tween TweenLite, TweenMax, TimelineLite, or TimelineMax instance
*/
override public function addChild(tween:TweenCore):void {
if (!tween.cachedOrphan && tween.timeline) {
tween.timeline.remove(tween, true); //removes from existing timeline so that it can be properly added to this one. Even if the timeline is this, it still needs to be removed so that it can be added in the appropriate order (required for proper rendering)
}
tween.timeline = this;
if (tween.gc) {
tween.setEnabled(true, true);
}
setDirtyCache(true);
//now make sure it is inserted in the proper order...
var first:TweenCore = (this.gc) ? _endCaps[0] : _firstChild;
var last:TweenCore = (this.gc) ? _endCaps[1] : _lastChild;
if (last == null) {
first = last = tween;
tween.nextNode = tween.prevNode = null;
} else {
var curTween:TweenCore = last, st:Number = tween.cachedStartTime;
while (curTween != null && st <= curTween.cachedStartTime) {
curTween = curTween.prevNode;
}
if (curTween == null) {
first.prevNode = tween;
tween.nextNode = first;
tween.prevNode = null;
first = tween;
} else {
if (curTween.nextNode) {
curTween.nextNode.prevNode = tween;
} else if (curTween == last) {
last = tween;
}
tween.prevNode = curTween;
tween.nextNode = curTween.nextNode;
curTween.nextNode = tween;
}
}
tween.cachedOrphan = false;
if (this.gc) {
_endCaps[0] = first;
_endCaps[1] = last;
} else {
_firstChild = first;
_lastChild = last;
}
}
/**
* Removes a TweenLite, TweenMax, TimelineLite, or TimelineMax instance from the timeline.
*
* @param tween TweenLite, TweenMax, TimelineLite, or TimelineMax instance to remove
* @param skipDisable If false (the default), the TweenLite/Max/TimelineLite/Max instance is disabled. This is primarily used internally - there's really no reason to set it to true.
*/
override public function remove(tween:TweenCore, skipDisable:Boolean=false):void {
if (tween.cachedOrphan) {
return; //already removed!
} else if (!skipDisable) {
tween.setEnabled(false, true);
}
var first:TweenCore = (this.gc) ? _endCaps[0] : _firstChild;
var last:TweenCore = (this.gc) ? _endCaps[1] : _lastChild;
if (tween.nextNode) {
tween.nextNode.prevNode = tween.prevNode;
} else if (last == tween) {
last = tween.prevNode;
}
if (tween.prevNode) {
tween.prevNode.nextNode = tween.nextNode;
} else if (first == tween) {
first = tween.nextNode;
}
if (this.gc) {
_endCaps[0] = first;
_endCaps[1] = last;
} else {
_firstChild = first;
_lastChild = last;
}
tween.cachedOrphan = true;
//don't null nextNode and prevNode, otherwise the chain could break in rendering loops.
setDirtyCache(true);
}
/**
* Inserts a TweenLite, TweenMax, TimelineLite, or TimelineMax instance into the timeline at a specific time, frame, or label.
* If you insert at a label that doesn't exist yet, one is created at the end of the timeline.
*
* @param tween TweenLite, TweenMax, TimelineLite, or TimelineMax instance to insert
* @param timeOrLabel The time in seconds (or frames for frames-based timelines) or label at which the tween/timeline should be inserted. For example, myTimeline.insert(myTween, 3) would insert myTween 3-seconds into the timeline, and myTimeline.insert(myTween, "myLabel") would insert it at the "myLabel" label.
*/
public function insert(tween:TweenCore, timeOrLabel:*=0):void {
if (typeof(timeOrLabel) == "string") {
if (!(timeOrLabel in _labels)) {
addLabel(timeOrLabel, this.duration);
}
timeOrLabel = Number(_labels[timeOrLabel]);
}
/* Possible addition - this would avoid situations where a TimelineLite/Max is created as a class variable and then much later the children are added to it - without this line, the timeline would never start because it would finish immediately with no tweens.
if (_firstChild == null && _endCaps[0] == null && (this.timeline == TweenLite.rootTimeline || this.timeline == TweenLite.rootFramesTimeline)) {
this.startTime = this.timeline.cachedTime;
}
*/
tween.cachedStartTime = Number(timeOrLabel) + tween.delay;
addChild(tween);
}
/**
* Inserts a TweenLite, TweenMax, TimelineLite, or TimelineMax instance at the <strong>end</strong> of the timeline,
* optionally offsetting its insertion point by a certain amount (to make it overlap with the end of
* the timeline or leave a gap before its insertion point).
* This makes it easy to build sequences by continuing to append() tweens or timelines.
*
* @param tween TweenLite, TweenMax, TimelineLite, or TimelineMax instance to append.
* @param offset Amount of seconds (or frames for frames-based timelines) to offset the insertion point of the tween from the end of the timeline. For example, to append a tween 3 seconds after the end of the timeline (leaving a 3-second gap), set the offset to 3. Or to have the tween appended so that it overlaps with the last 2 seconds of the timeline, set the offset to -2. The default is 0 so that the insertion point is exactly at the end of the timeline.
*/
public function append(tween:TweenCore, offset:Number=0):void {
insert(tween, this.duration + offset);
}
/**
* Inserts a TweenLite, TweenMax, TimelineLite, or TimelineMax instance at the beginning of the timeline,
* pushing all existing tweens back in time to make room for the newly inserted one. You can optionally
* affect the positions of labels too.
*
* @param tween TweenLite, TweenMax, TimelineLite, or TimelineMax instance to prepend
* @param adjustLabels If true, all existing labels will be adjusted back in time along with the existing tweens to keep them aligned. (default is false)
*/
public function prepend(tween:TweenCore, adjustLabels:Boolean=false):void {
shiftChildren((tween.totalDuration / tween.cachedTimeScale) + tween.delay, adjustLabels, 0);
insert(tween, 0);
}
/**
* Inserts multiple tweens/timelines into the timeline at once, optionally aligning them (as a sequence for example)
* and/or staggering the timing. This is one of the most powerful methods in TimelineLite because it accommodates
* advanced timing effects and builds complex sequences with relatively little code.<br /><br />
*
* @param tweens an Array containing any or all of the following: TweenLite, TweenMax, TimelineLite, and/or TimelineMax instances
* @param timeOrLabel time in seconds (or frame if the timeline is frames-based) or label that serves as the point of insertion. For example, the number 2 would insert the tweens beginning at 2-seconds into the timeline, or "myLabel" would ihsert them wherever "myLabel" is.
* @param align determines how the tweens will be aligned in relation to each other before getting inserted. Options are: TweenAlign.SEQUENCE (aligns the tweens one-after-the-other in a sequence), TweenAlign.START (aligns the start times of all of the tweens (ignores delays)), and TweenAlign.NORMAL (aligns the start times of all the tweens (honors delays)). The default is NORMAL.
* @param stagger staggers the tweens by a set amount of time (in seconds) (or in frames for frames-based timelines). For example, if the stagger value is 0.5 and the "align" property is set to TweenAlign.START, the second tween will start 0.5 seconds after the first one starts, then 0.5 seconds later the third one will start, etc. If the align property is TweenAlign.SEQUENCE, there would be 0.5 seconds added between each tween. Default is 0.
*/
public function insertMultiple(tweens:Array, timeOrLabel:*=0, align:String="normal", stagger:Number=0):void {
var i:int, tween:TweenCore, curTime:Number = Number(timeOrLabel) || 0, l:uint = tweens.length;
if (typeof(timeOrLabel) == "string") {
if (!(timeOrLabel in _labels)) {
addLabel(timeOrLabel, this.duration);
}
curTime = _labels[timeOrLabel];
}
for (i = 0; i < l; i++) {
tween = tweens[i] as TweenCore;
insert(tween, curTime);
if (align == "sequence") {
curTime = tween.cachedStartTime + (tween.totalDuration / tween.cachedTimeScale);
} else if (align == "start") {
tween.cachedStartTime -= tween.delay;
}
curTime += stagger;
}
}
/**
* Appends multiple tweens/timelines at the end of the timeline at once, optionally offsetting the insertion point by a certain amount,
* aligning them (as a sequence for example), and/or staggering their relative timing. This is one of the most powerful methods in
* TimelineLite because it accommodates advanced timing effects and builds complex sequences with relatively little code.<br /><br />
*
* @param tweens an Array containing any or all of the following: TweenLite, TweenMax, TimelineLite, and/or TimelineMax instances
* @param offset Amount of seconds (or frames for frames-based timelines) to offset the insertion point of the tweens from the end of the timeline. For example, to start appending the tweens 3 seconds after the end of the timeline (leaving a 3-second gap), set the offset to 3. Or to have the tweens appended so that the insertion point overlaps with the last 2 seconds of the timeline, set the offset to -2. The default is 0 so that the insertion point is exactly at the end of the timeline.
* @param align determines how the tweens will be aligned in relation to each other before getting appended. Options are: TweenAlign.SEQUENCE (aligns the tweens one-after-the-other in a sequence), TweenAlign.START (aligns the start times of all of the tweens (ignores delays)), and TweenAlign.NORMAL (aligns the start times of all the tweens (honors delays)). The default is NORMAL.
* @param stagger staggers the tweens by a set amount of time (in seconds) (or in frames for frames-based timelines). For example, if the stagger value is 0.5 and the "align" property is set to TweenAlign.START, the second tween will start 0.5 seconds after the first one starts, then 0.5 seconds later the third one will start, etc. If the align property is TweenAlign.SEQUENCE, there would be 0.5 seconds added between each tween. Default is 0.
*/
public function appendMultiple(tweens:Array, offset:Number=0, align:String="normal", stagger:Number=0):void {
insertMultiple(tweens, this.duration + offset, align, stagger);
}
/**
* Prepends multiple tweens/timelines to the beginning of the timeline at once, moving all existing children back to make
* room, and optionally aligning the new children (as a sequence for example) and/or staggering the timing.<br /><br />
*
* @param tweens an Array containing any or all of the following: TweenLite, TweenMax, TimelineLite, and/or TimelineMax instances
* @param align determines how the tweens will be aligned in relation to each other before getting prepended. Options are: TweenAlign.SEQUENCE (aligns the tweens one-after-the-other in a sequence), TweenAlign.START (aligns the start times of all of the tweens (ignores delays)), and TweenAlign.NORMAL (aligns the start times of all the tweens (honors delays)). The default is NORMAL.
* @param stagger staggers the tweens by a set amount of time (in seconds) (or in frames for frames-based timelines). For example, if the stagger value is 0.5 and the "align" property is set to TweenAlign.START, the second tween will start 0.5 seconds after the first one starts, then 0.5 seconds later the third one will start, etc. If the align property is TweenAlign.SEQUENCE, there would be 0.5 seconds added between each tween. Default is 0.
*/
public function prependMultiple(tweens:Array, align:String="normal", stagger:Number=0, adjustLabels:Boolean=false):void {
var tl:TimelineLite = new TimelineLite({tweens:tweens, align:align, stagger:stagger}); //dump them into a new temporary timeline initially so that we can determine the overall duration.
shiftChildren(tl.duration, adjustLabels, 0);
insertMultiple(tweens, 0, align, stagger);
tl.kill();
}
/**
* Adds a label to the timeline, making it easy to mark important positions/times. gotoAndStop() and gotoAndPlay()
* allow you to skip directly to any label. This works just like timeline labels in the Flash IDE.
*
* @param label The name of the label
* @param time The time in seconds (or frames for frames-based timelines) at which the label should be added. For example, myTimeline.addLabel("myLabel", 3) adds the label "myLabel" at 3 seconds into the timeline.
*/
public function addLabel(label:String, time:Number):void {
_labels[label] = time;
}
/**
* Removes a label from the timeline and returns the time of that label.
*
* @param label The name of the label to remove
* @return Time associated with the label that was removed
*/
public function removeLabel(label:String):Number {
var n:Number = _labels[label];
delete _labels[label];
return n;
}
/**
* Returns the time associated with a particular label. If the label isn't found, -1 is returned.
*
* @param label Label name
* @return Time associated with the label (or -1 if there is no such label)
*/
public function getLabelTime(label:String):Number {
return (label in _labels) ? Number(_labels[label]) : -1;
}
/** @private **/
protected function parseTimeOrLabel(timeOrLabel:*):Number {
if (typeof(timeOrLabel) == "string") {
if (!(timeOrLabel in _labels)) {
throw new Error("TimelineLite error: the " + timeOrLabel + " label was not found.");
return 0;
}
return getLabelTime(String(timeOrLabel));
}
return Number(timeOrLabel);
}
/** Pauses the timeline (same as pause() - added stop() for consistency with Flash's MovieClip.stop() functionality) **/
public function stop():void {
this.paused = true;
}
/**
* Skips to a particular time, frame, or label and plays the timeline forwards from there (unpausing it)
*
* @param timeOrLabel time in seconds (or frame if the timeline is frames-based) or label to skip to. For example, myTimeline.gotoAndPlay(2) will skip to 2-seconds into a timeline, and myTimeline.gotoAndPlay("myLabel") will skip to wherever "myLabel" is.
* @param suppressEvents If true, no events or callbacks will be triggered as the "virtual playhead" moves to the new position (onComplete, onUpdate, onReverseComplete, etc. of this timeline and any of its child tweens/timelines won't be triggered, nor will any of the associated events be dispatched)
*/
public function gotoAndPlay(timeOrLabel:*, suppressEvents:Boolean=true):void {
setTotalTime(parseTimeOrLabel(timeOrLabel), suppressEvents);
play();
}
/**
* Skips to a particular time, frame, or label and stops the timeline (pausing it)
*
* @param timeOrLabel time in seconds (or frame if the timeline is frames-based) or label to skip to. For example, myTimeline.gotoAndStop(2) will skip to 2-seconds into a timeline, and myTimeline.gotoAndStop("myLabel") will skip to wherever "myLabel" is.
* @param suppressEvents If true, no events or callbacks will be triggered as the "virtual playhead" moves to the new position (onComplete, onUpdate, onReverseComplete, etc. of this timeline and any of its child tweens/timelines won't be triggered, nor will any of the associated events be dispatched)
*/
public function gotoAndStop(timeOrLabel:*, suppressEvents:Boolean=true):void {
setTotalTime(parseTimeOrLabel(timeOrLabel), suppressEvents);
this.paused = true;
}
/**
* Skips to a particular time, frame, or label without changing the paused state of the timeline
*
* @param timeOrLabel time in seconds (or frame if the timeline is frames-based) or label to skip to. For example, myTimeline.goto(2) will skip to 2-seconds into a timeline, and myTimeline.goto("myLabel") will skip to wherever "myLabel" is.
* @param suppressEvents If true, no events or callbacks will be triggered as the "virtual playhead" moves to the new position (onComplete, onUpdate, onReverseComplete, etc. of this timeline and any of its child tweens/timelines won't be triggered, nor will any of the associated events be dispatched)
*/
public function goto(timeOrLabel:*, suppressEvents:Boolean=true):void {
setTotalTime(parseTimeOrLabel(timeOrLabel), suppressEvents);
}
/**
* @private
* Renders all tweens and sub-timelines in the state they'd be at a particular time (or frame for frames-based timelines).
*
* @param time time in seconds (or frames for frames-based timelines) that should be rendered.
* @param suppressEvents If true, no events or callbacks will be triggered for this render (like onComplete, onUpdate, onReverseComplete, etc.)
* @param force Normally the tween will skip rendering if the time matches the cachedTotalTime (to improve performance), but if force is true, it forces a render. This is primarily used internally for tweens with durations of zero in TimelineLite/Max instances.
*/
override public function renderTime(time:Number, suppressEvents:Boolean=false, force:Boolean=false):void {
if (this.gc) {
this.setEnabled(true, false);
} else if (!this.active && !this.cachedPaused) {
this.active = true; //so that if the user renders a tween (as opposed to the timeline rendering it), the timeline is forced to re-render and align it with the proper time/frame on the next rendering cycle. Maybe the tween already finished but the user manually re-renders it as halfway done.
}
var totalDur:Number = (this.cacheIsDirty) ? this.totalDuration : this.cachedTotalDuration, prevTime:Number = this.cachedTime, prevStart:Number = this.cachedStartTime, prevTimeScale:Number = this.cachedTimeScale, tween:TweenCore, isComplete:Boolean, rendered:Boolean, next:TweenCore, dur:Number, prevPaused:Boolean = this.cachedPaused;
if (time >= totalDur) {
if (_rawPrevTime <= totalDur && _rawPrevTime != time) {
this.cachedTotalTime = this.cachedTime = totalDur;
forceChildrenToEnd(totalDur, suppressEvents);
isComplete = !this.hasPausedChild();
rendered = true;
if (this.cachedDuration == 0 && isComplete && (time == 0 || _rawPrevTime < 0)) { //In order to accommodate zero-duration timelines, we must discern the momentum/direction of time in order to render values properly when the "playhead" goes past 0 in the forward direction or lands directly on it, and also when it moves past it in the backward direction (from a postitive time to a negative time).
force = true;
}
}
} else if (time <= 0) {
if (time < 0) {
this.active = false;
if (this.cachedDuration == 0 && _rawPrevTime > 0) { //In order to accommodate zero-duration timelines, we must discern the momentum/direction of time in order to render values properly when the "playhead" goes past 0 in the forward direction or lands directly on it, and also when it moves past it in the backward direction (from a postitive time to a negative time).
force = true;
isComplete = true;
}
}
if (_rawPrevTime >= 0 && _rawPrevTime != time) {
forceChildrenToBeginning(0, suppressEvents);
this.cachedTotalTime = 0;
this.cachedTime = 0;
rendered = true;
if (this.cachedReversed) {
isComplete = true;
}
}
} else {
this.cachedTotalTime = this.cachedTime = time;
}
_rawPrevTime = time;
if (this.cachedTime == prevTime && !force) {
return;
} else if (!this.initted) {
this.initted = true;
}
if (prevTime == 0 && this.vars.onStart && this.cachedTime != 0 && !suppressEvents) {
this.vars.onStart.apply(null, this.vars.onStartParams);
}
if (rendered) {
//already rendered
} else if (this.cachedTime - prevTime > 0) {
tween = _firstChild;
while (tween) {
next = tween.nextNode; //record it here because the value could change after rendering...
if (this.cachedPaused && !prevPaused) { //in case a tween pauses the timeline when rendering
break;
} else if (tween.active || (!tween.cachedPaused && tween.cachedStartTime <= this.cachedTime && !tween.gc)) {
if (!tween.cachedReversed) {
tween.renderTime((this.cachedTime - tween.cachedStartTime) * tween.cachedTimeScale, suppressEvents, false);
} else {
dur = (tween.cacheIsDirty) ? tween.totalDuration : tween.cachedTotalDuration;
tween.renderTime(dur - ((this.cachedTime - tween.cachedStartTime) * tween.cachedTimeScale), suppressEvents, false);
}
}
tween = next;
}
} else {
tween = _lastChild;
while (tween) {
next = tween.prevNode; //record it here because the value could change after rendering...
if (this.cachedPaused && !prevPaused) { //in case a tween pauses the timeline when rendering
break;
} else if (tween.active || (!tween.cachedPaused && tween.cachedStartTime <= prevTime && !tween.gc)) {
if (!tween.cachedReversed) {
tween.renderTime((this.cachedTime - tween.cachedStartTime) * tween.cachedTimeScale, suppressEvents, false);
} else {
dur = (tween.cacheIsDirty) ? tween.totalDuration : tween.cachedTotalDuration;
tween.renderTime(dur - ((this.cachedTime - tween.cachedStartTime) * tween.cachedTimeScale), suppressEvents, false);
}
}
tween = next;
}
}
if (_hasUpdate && !suppressEvents) {
this.vars.onUpdate.apply(null, this.vars.onUpdateParams);
}
if (isComplete && (prevStart == this.cachedStartTime || prevTimeScale != this.cachedTimeScale) && (totalDur >= this.totalDuration || this.cachedTime == 0)) { //if one of the tweens that was rendered altered this timeline's startTime (like if an onComplete reversed the timeline), we shouldn't run complete() because it probably isn't complete. If it is, don't worry, because whatever call altered the startTime would have called complete() if it was necessary at the new time. The only exception is the timeScale property.
complete(true, suppressEvents);
}
}
/**
* @private
* Due to occassional floating point rounding errors in Flash, sometimes child tweens/timelines were not being
* rendered at the very beginning (their currentProgress might be 0.000000000001 instead of 0 because when Flash
* performed this.cachedTime - tween.startTime, floating point errors would return a value that
* was SLIGHTLY off). This method forces them to the beginning.
*
* @param time Time that should be rendered (either zero or a negative number). The reason a negative number could be important is because if there are zero-duration tweens at the very beginning (startTime=0), we need a way to sense when the timeline has gone backwards BEYOND zero so that the tweens know to render their starting values instead of their ending values. If the time is exactly zero, those tweens would render their end values.
* @param suppressEvents If true, no events or callbacks will be triggered for this render (like onComplete, onUpdate, onReverseComplete, etc.)
*/
protected function forceChildrenToBeginning(time:Number, suppressEvents:Boolean=false):Number {
var tween:TweenCore = _lastChild, next:TweenCore, dur:Number;
var prevPaused:Boolean = this.cachedPaused;
while (tween) {
next = tween.prevNode; //record it here because the value could change after rendering...
if (this.cachedPaused && !prevPaused) { //in case a tween pauses the timeline when rendering
break;
} else if (tween.active || (!tween.cachedPaused && !tween.gc && (tween.cachedTotalTime != 0 || tween.cachedDuration == 0))) {
if (time == 0 && (tween.cachedDuration != 0 || tween.cachedStartTime == 0)) {
tween.renderTime(tween.cachedReversed ? tween.cachedTotalDuration : 0, suppressEvents, false);
} else if (!tween.cachedReversed) {
tween.renderTime((time - tween.cachedStartTime) * tween.cachedTimeScale, suppressEvents, false);
} else {
dur = (tween.cacheIsDirty) ? tween.totalDuration : tween.cachedTotalDuration;
tween.renderTime(dur - ((time - tween.cachedStartTime) * tween.cachedTimeScale), suppressEvents, false);
}
}
tween = next;
}
return time;
}
/**
* @private
* Due to occassional floating point rounding errors in Flash, sometimes child tweens/timelines were not being
* fully completed (their currentProgress might be 0.999999999999998 instead of 1 because when Flash
* performed this.cachedTime - tween.startTime, floating point errors would return a value that
* was SLIGHTLY off). This method forces them to completion.
*
* @param time Time that should be rendered (either this.totalDuration or greater). The reason a greater number could be important is because if there are reversed zero-duration tweens at the very end, we need a way to sense when the timeline has gone BEYOND the end so that the tweens know to render their starting values instead of their ending values. If the time is exactly this.totalDuration, those reversed zero-duration tweens would render their end values.
* @param suppressEvents If true, no events or callbacks will be triggered for this render (like onComplete, onUpdate, onReverseComplete, etc.)
*/
protected function forceChildrenToEnd(time:Number, suppressEvents:Boolean=false):Number {
var tween:TweenCore = _firstChild, next:TweenCore, dur:Number;
var prevPaused:Boolean = this.cachedPaused;
while (tween) {
next = tween.nextNode; //record it here because the value could change after rendering...
if (this.cachedPaused && !prevPaused) { //in case a tween pauses the timeline when rendering
break;
} else if (tween.active || (!tween.cachedPaused && !tween.gc && (tween.cachedTotalTime != tween.cachedTotalDuration || tween.cachedDuration == 0))) {
if (time == this.cachedDuration && (tween.cachedDuration != 0 || tween.cachedStartTime == this.cachedDuration)) {
tween.renderTime(tween.cachedReversed ? 0 : tween.cachedTotalDuration, suppressEvents, false);
} else if (!tween.cachedReversed) {
tween.renderTime((time - tween.cachedStartTime) * tween.cachedTimeScale, suppressEvents, false);
} else {
dur = (tween.cacheIsDirty) ? tween.totalDuration : tween.cachedTotalDuration;
tween.renderTime(dur - ((time - tween.cachedStartTime) * tween.cachedTimeScale), suppressEvents, false);
}
}
tween = next;
}
return time;
}
/**
* @private
* Checks the timeline to see if it has any paused children (tweens/timelines).
*
* @return Indicates whether or not the timeline contains any paused children
*/
public function hasPausedChild():Boolean {
var tween:TweenCore = (this.gc) ? _endCaps[0] : _firstChild;
while (tween) {
if (tween.cachedPaused || ((tween is TimelineLite) && (tween as TimelineLite).hasPausedChild())) {
return true;
}
tween = tween.nextNode;
}
return false;
}
/**
* Provides an easy way to get all of the tweens and/or timelines nested in this timeline (as an Array).
*
* @param nested determines whether or not tweens and/or timelines that are inside nested timelines should be returned. If you only want the "top level" tweens/timelines, set this to false.
* @param tweens determines whether or not tweens (TweenLite and TweenMax instances) should be included in the results
* @param timelines determines whether or not timelines (TimelineLite and TimelineMax instances) should be included in the results
* @param ignoreBeforeTime All children with start times that are less than this value will be ignored.
* @return an Array containing the child tweens/timelines.
*/
public function getChildren(nested:Boolean=true, tweens:Boolean=true, timelines:Boolean=true, ignoreBeforeTime:Number=-9999999999):Array {
var a:Array = [], cnt:uint = 0, tween:TweenCore = (this.gc) ? _endCaps[0] : _firstChild;
while (tween) {
if (tween.cachedStartTime < ignoreBeforeTime) {
//do nothing
} else if (tween is TweenLite) {
if (tweens) {
a[cnt++] = tween;
}
} else {
if (timelines) {
a[cnt++] = tween;
}
if (nested) {
a = a.concat(TimelineLite(tween).getChildren(true, tweens, timelines));
}
}
tween = tween.nextNode;
}
return a;
}
/**
* Returns the tweens of a particular object that are inside this timeline.
*
* @param target the target object of the tweens
* @param nested determines whether or not tweens that are inside nested timelines should be returned. If you only want the "top level" tweens/timelines, set this to false.
* @return an Array of TweenLite and TweenMax instances
*/
public function getTweensOf(target:Object, nested:Boolean=true):Array {
var tweens:Array = getChildren(nested, true, false), a:Array = [], i:int;
var l:uint = tweens.length;
var cnt:uint = 0;
for (i = 0; i < l; i++) {
if (TweenLite(tweens[i]).target == target) {
a[cnt++] = tweens[i];
}
}
return a;
}
/**
* Shifts the startTime of the timeline's children by a certain amount and optionally adjusts labels too. This can be useful
* when you want to prepend children or splice them into a certain spot, moving existing ones back to make room for the new ones.
*
* @param amount Number of seconds (or frames for frames-based timelines) to move each child.
* @param adjustLabels If true, the timing of all labels will be adjusted as well.
* @param ignoreBeforeTime All children that begin at or after the startAtTime will be affected by the shift (the default is 0, causing all children to be affected). This provides an easy way to splice children into a certain spot on the timeline, pushing only the children after that point back to make room.
*/
public function shiftChildren(amount:Number, adjustLabels:Boolean=false, ignoreBeforeTime:Number=0):void {
var tween:TweenCore = (this.gc) ? _endCaps[0] : _firstChild;
while (tween) {
if (tween.cachedStartTime >= ignoreBeforeTime) {
tween.cachedStartTime += amount;
}
tween = tween.nextNode;
}
if (adjustLabels) {
for (var p:String in _labels) {
if (_labels[p] >= ignoreBeforeTime) {
_labels[p] += amount;
}
}
}
this.setDirtyCache(true);
}
/**
* Kills all the tweens (or certain tweening properties) of a particular object inside this TimelineLite,
* optionally completing them first. If, for example, you want to kill all tweens of the "mc" object, you'd do:<br /><br /><code>
*
* myTimeline.killTweensOf(mc);<br /><br /></code>
*
* But if you only want to kill all the "alpha" and "x" portions of mc's tweens, you'd do:<br /><br /><code>
*
* myTimeline.killTweensOf(mc, false, {alpha:true, x:true});<br /><br /></code>
*
* Killing a tween also removes it from the timeline.
*
* @param target the target object of the tweens
* @param nested determines whether or not tweens that are inside nested timelines should be affected. If you only want the "top level" tweens/timelines to be affected, set this to false.
* @param vars An object defining which tweening properties should be killed (null causes all properties to be killed). For example, if you only want to kill "alpha" and "x" tweens of object "mc", you'd do <code>myTimeline.killTweensOf(mc, true, {alpha:true, x:true})</code>. If there are no tweening properties remaining in a tween after the indicated properties are killed, the entire tween is killed, meaning any onComplete, onUpdate, onStart, etc. won't fire.
*/
public function killTweensOf(target:Object, nested:Boolean=true, vars:Object=null):Boolean {
var tweens:Array = getTweensOf(target, nested);
var i:int = tweens.length;
var tween:TweenLite;
while (--i > -1) {
tween = tweens[i];
if (vars != null) {
tween.killVars(vars);
}
if (vars == null || (tween.cachedPT1 == null && tween.initted)) {
tween.setEnabled(false, false);
}
}
return Boolean(tweens.length > 0);
}
/** @inheritDoc **/
override public function invalidate():void {
var tween:TweenCore = (this.gc) ? _endCaps[0] : _firstChild;
while (tween) {
tween.invalidate();
tween = tween.nextNode;
}
}
/**
* Empties the timeline of all child tweens/timelines, or you can optionally pass an Array containing specific
* tweens/timelines to remove. So <code>myTimeline.clear()</code> would remove all children whereas
* <code>myTimeline.clear([tween1, tween2])</code> would only remove tween1 and tween2. You could even clear only
* the tweens of a particular object with <code>myTimeline.clear(myTimeline.getTweensOf(myObject));</code>
*
* @param tweens (optional) An Array containing specific children to remove.
*/
public function clear(tweens:Array=null):void {
if (tweens == null) {
tweens = getChildren(false, true, true);
}
var i:int = tweens.length;
while (--i > -1) {
TweenCore(tweens[i]).setEnabled(false, false);
}
}
/** @private **/
override public function setEnabled(enabled:Boolean, ignoreTimeline:Boolean=false):Boolean {
if (enabled == this.gc) {
var tween:TweenCore, next:TweenCore;
/*
NOTE: To avoid circular references (TweenCore.timeline and SimpleTimeline._firstChild/_lastChild) which cause garbage collection
problems, store the _firstChild and _lastChild in the _endCaps Array when the timeline is disabled.
*/
if (enabled) {
_firstChild = tween = _endCaps[0];
_lastChild = _endCaps[1];
_endCaps = [null, null];
} else {
tween = _firstChild;
_endCaps = [_firstChild, _lastChild];
_firstChild = _lastChild = null;
}
while (tween) {
tween.setEnabled(enabled, true);
tween = tween.nextNode;
}
}
return super.setEnabled(enabled, ignoreTimeline);
}
//---- GETTERS / SETTERS -------------------------------------------------------------------------------------------------------
/**
* Value between 0 and 1 indicating the progress of the timeline according to its duration
* where 0 is at the beginning, 0.5 is halfway finished, and 1 is finished. <code>totalProgress</code>,
* by contrast, describes the overall progress according to the timeline's <code>totalDuration</code>
* which includes repeats and repeatDelays (if there are any). Since TimelineLite doesn't offer
* "repeat" and "repeatDelay" functionality, <code>currentProgress</code> and <code>totalProgress</code> are always the same
* but in TimelineMax, they could be different. For example, if a TimelineMax instance
* is set to repeat once, at the end of the first cycle <code>totalProgress</code> would only be 0.5
* whereas <code>currentProgress</code> would be 1. If you tracked both properties over the course of the
* tween, you'd see <code>currentProgress</code> go from 0 to 1 twice (once for each cycle) in the same
* time it takes the <code>totalProgress</code> property to go from 0 to 1 once.
**/
public function get currentProgress():Number {
return this.cachedTime / this.duration;
}
public function set currentProgress(n:Number):void {
setTotalTime(this.duration * n, false);
}
/**
* Duration of the timeline in seconds (or frames for frames-based timelines) not including any repeats
* or repeatDelays. <code>totalDuration</code>, by contrast, does include repeats and repeatDelays but since TimelineLite
* doesn't offer "repeat" and "repeatDelay" functionality, <code>duration</code> and <code>totalDuration</code> will always be the same.
* In TimelineMax, however, they could be different.
**/
override public function get duration():Number {
if (this.cacheIsDirty) {
var d:Number = this.totalDuration; //just triggers recalculation
}
return this.cachedDuration;
}
override public function set duration(n:Number):void {
if (this.duration != 0 && n != 0) {
this.timeScale = this.duration / n;
}
}
/**
* Duration of the timeline in seconds (or frames for frames-based timelines) including any repeats
* or repeatDelays. <code>duration</code>, by contrast, does NOT include repeats and repeatDelays. Since TimelineLite
* doesn't offer "repeat" and "repeatDelay" functionality, <code>duration</code> and <code>totalDuration</code> will always be the same.
* In TimelineMax, however, they could be different.
**/
override public function get totalDuration():Number {
if (this.cacheIsDirty) {
var max:Number = 0, end:Number, tween:TweenCore = (this.gc) ? _endCaps[0] : _firstChild, prevStart:Number = -Infinity, next:TweenCore;
while (tween) {
next = tween.nextNode; //record it here in case the tween changes position in the sequence...
if (tween.cachedStartTime < prevStart) { //in case one of the tweens shifted out of order, it needs to be re-inserted into the correct position in the sequence
this.addChild(tween);
prevStart = tween.prevNode.cachedStartTime;
} else {
prevStart = tween.cachedStartTime;
}
if (tween.cachedStartTime < 0) { //children aren't allowed to have negative startTimes, so adjust here if one is found.
max -= tween.cachedStartTime;
this.shiftChildren(-tween.cachedStartTime, false, -9999999999);
}
end = tween.cachedStartTime + (tween.totalDuration / tween.cachedTimeScale);
if (end > max) {
max = end;
}
tween = next;
}
this.cachedDuration = this.cachedTotalDuration = max;
this.cacheIsDirty = false;
}
return this.cachedTotalDuration;
}
override public function set totalDuration(n:Number):void {
if (this.totalDuration != 0 && n != 0) {
this.timeScale = this.totalDuration / n;
}
}
/** Multiplier describing the speed of the timeline where 1 is normal speed, 0.5 is half-speed, 2 is double speed, etc. **/
public function get timeScale():Number {
return this.cachedTimeScale;
}
public function set timeScale(n:Number):void {
if (n == 0) { //can't allow zero because it'll throw the math off
n = 0.0001;
}
var tlTime:Number = (_pauseTime || _pauseTime == 0) ? _pauseTime : this.timeline.cachedTotalTime;
this.cachedStartTime = tlTime - ((tlTime - this.cachedStartTime) * this.cachedTimeScale / n);
this.cachedTimeScale = n;
setDirtyCache(false);
}
/**
* Indicates whether or not the timeline's timing mode is frames-based as opposed to time-based.
* This can only be set via the vars object in the constructor, or by attaching it to a timeline with the desired
* timing mode (a timeline's timing mode is always determined by its parent timeline)
**/
public function get useFrames():Boolean {
var tl:SimpleTimeline = this.timeline;
while (tl.timeline) {
tl = tl.timeline;
}
return Boolean(tl == TweenLite.rootFramesTimeline);
}
/**
* @private
* Reports the totalTime of the timeline without capping the number at the totalDuration (max) and zero (minimum) which can be useful when
* unpausing tweens/timelines. Imagine a case where a paused tween is in a timeline that has already reached the end, but then
* the tween gets unpaused - it needs a way to place itself accurately in time AFTER what was previously the timeline's end time.
*
* @return The totalTime of the timeline without capping the number at the totalDuration (max) and zero (minimum)
*/
override public function get rawTime():Number {
if ((this.cachedTotalTime != 0 && this.cachedTotalTime != this.cachedTotalDuration)) { //note: don't use this.totalDuration because if other tweens get unpaused before this one, the totalDuration could change.
return this.cachedTotalTime;
} else {
return (this.timeline.rawTime - this.cachedStartTime) * this.cachedTimeScale;
}
}
}
}