delay special property for everything which would
* make future edits far more tedius. Here is a basic example:
* mc.x to 100, then mc.y to 50, and finally
* mc.alpha to 0 (notice the delay in all but the first tween). But
* imagine if you wanted to increase the duration of the first tween to 1.5 - you'd need to
* adjust every delay thereafter. And what if you want to pause() the whole
* sequence or restart() it or reverse() it on-the-fly or repeat
* it twice? This becomes quite messy (or flat-out impossible), but TimelineMax makes it
* incredibly simple:
*
* to() method and chaining to make it even shorter:
* Now you can feel free to adjust any of the tweens without worrying about trickle-down * changes to delays. Increase the duration of that first tween and everything automatically * adjusts.
* *Here are some other benefits and features of TimelineMax:
* *myTimeline.add( myObject.animateIn() ).add( myObject.animateOut(), "+=4").add( myObject2.animateIn(), "-=0.5")...timeScale() method.
* You can even tween it to gradually speed up or slow down the animation smoothly.progress() or
* totalProgress() methods. For example, to skip to the halfway point,
* set myTimeline.progress(0.5);time, totalTime, progress, or totalProgress to
* fastforward/rewind the timeline. You could even attach a slider to one of these to give the
* user the ability to drag forward/backward through the timeline.onComplete, onStart, onUpdate, onRepeat and/or onReverseComplete
* callbacks using the constructor's vars object like
* var tl = new TimelineMax({onComplete:myFunction});kill(null, target)
* or get the tweens of an object with getTweensOf() or get all the tweens/timelines
* in the timeline with getChildren()useFrames:true in the vars parameter, you can
* base the timing on frames instead of seconds. Please note, however, that
* the timeline's timing mode dictates its childrens' timing mode as well. currentLabel() or find labels at various positions in the timeline
* using getLabelAfter() and getLabelBefore()TimelineLite.exportRoot() so that
* you can pause() them all or reverse() or alter their
* timeScale, etc. without affecting tweens/timelines that you create in
* the future. Imagine a game that has all its animation driven by the GreenSock
* Animation Platform and it needs to pause or slow down while a status screen pops up.
* Very easy.SPECIAL PROPERTIES:
*You can optionally use the constructor's vars parameter to define any of
* the special properties below (syntax example: new TimelineMax({onComplete:myFunction, repeat:2, repeatDelay:1, yoyo:true});
true, the timeline will pause itself immediately upon creation (by default,
* timelines automatically begin playing immediately). If you plan to create a TimelineMax and
* then populate it later (after one or more frames elapse), it is typically best to set
* paused:true and then play() after you populate it.onComplete function. For example,
* new TimelineMax({onComplete:myFunction, onCompleteParams:["param1", "param2"]});
* To self-reference the timeline instance itself in one of the parameters, use "{self}",
* like: onCompleteParams:["{self}", "param2"]useFrames is true, the timelines's timing will be
* based on frames instead of seconds because it is intially added to the root
* frames-based timeline. This causes both its duration
* and delay to be based on frames. An animations's timing mode is
* always determined by its parent timeline.tweens
* 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 add() method.tweens special property when multiple
* tweens are to be inserted immediately. The value simply gets passed to the
* add() method. The default is "normal".
* Options are:
* "sequence": aligns the tweens one-after-the-other in a sequence"start": aligns the start times of all of the tweens (ignores delays)"normal": aligns the start times of all the tweens (honors delays)align special property does not force all child
* tweens/timelines to maintain relative positioning, so for example, if you use
* "sequence" and then later change the duration of one of the nested tweens,
* it does not force all subsequent timelines to change their position.
* The align special property only affects the alignment of the tweens that are
* initially placed into the timeline through the tweens special property of
* the vars object.tweens 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 "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 "sequence",
* there would be 0.5 seconds added between each tween. This value simply gets
* passed to the add() method. Default is 0.time
* changes from 0 to some other value which can happen more than once if the
* timeline is restarted multiple times).onStart function. For example,
* new TimelineMax({onStart:myFunction, onStartParams:["param1", "param2"]});
* To self-reference the timeline instance itself in one of the parameters, use "{self}",
* like: onStartParams:["{self}", "param2"]onUpdate function. For example,
* new TimelineMax({onUpdate:myFunction, onUpdateParams:["param1", "param2"]});
* To self-reference the timeline instance itself in one of the parameters, use "{self}",
* like: onUpdateParams:["{self}", "param2"]reverse() is called, the timeline will move
* back towards its beginning and when its time reaches 0, onReverseComplete
* will be called. This can also happen if the timeline is placed in a TimelineLite or TimelineMax
* instance that gets reversed and plays the timeline backwards to (or past) the beginning.onReverseComplete function. For example,
* new TimelineMax({onReverseComplete:myFunction, onReverseCompleteParams:["param1", "param2"]});
* To self-reference the timeline instance itself in one of the parameters, use "{self}",
* like: onReverseCompleteParams:["{self}", "param2"]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
* reverse() or set the progress lower, etc.). It can, however,
* improve speed and memory management. The root timelines use autoRemoveChildren:true.startTime) in order to maintain smooth playback when
* properties are changed on-the-fly. For example, imagine that the timeline's playhead is
* on a child tween that is 75% complete, moving mc.x from 0 to 100 and then that tween's
* reverse() method is called. If smoothChildTiming is false
* (the default except for the root timelines), the tween would flip in place, keeping its
* startTime consistent. Therefore the playhead of the timeline would now be
* at the tween's 25% completion point instead of 75%. Remember, the timeline's playhead
* position and direction are unaffected by child tween/timeline changes. mc.x would jump
* from 75 to 25, but the tween's position in the timeline would remain consistent. However,
* if smoothChildTiming is true, that child tween's
* startTime would be adjusted so that the timeline's playhead intersects
* with the same spot on the tween (75% complete) as it had immediately before
* reverse() was called, thus playback appears perfectly smooth. mc.x
* would still be 75 and it would continue from there as the playhead moves on, but
* since the tween is reversed now mc.x will travel back towards 0 instead of 100.
* Ultimately it's a decision between prioritizing smooth on-the-fly playback
* (true) or consistent position(s) of child tweens/timelines
* (false).
*
* Some examples of on-the-fly changes to child tweens/timelines that could cause their
* startTime to change when smoothChildTiming is true
* are: reversed, timeScale, progress, totalProgress, time, totalTime, delay, pause,
* resume, duration, and totalDuration.repeat is 1, the timeline will play a total of twice (the initial play
* plus 1 repeat). To repeat indefinitely, use -1. repeat should always be an integer.repeat is 2 and repeatDelay is 1, the timeline will play initially,
* then wait for 1 second before it repeats, then play again, then wait 1 second again before
* doing its final repeat.true, every other repeat cycle will run in the opposite
* direction so that the timeline appears to go back and forth (forward then backward).
* This has no affect on the "reversed" property though. So if repeat
* is 2 and yoyo is false, it will look like:
* start - 1 - 2 - 3 - 1 - 2 - 3 - 1 - 2 - 3 - end. But if yoyo is true,
* it will look like: start - 1 - 2 - 3 - 3 - 2 - 1 - 1 - 2 - 3 - end.new TimelineMax({repeat:3, onRepeat:myFunction, onRepeatParams:[mc, "param2"]});
* To self-reference the timeline instance itself in one of the parameters, use "{self}",
* like: onRepeatParams:["{self}", "param2"]totalTime changes from 0 to some other value which can happen more
* than once if the timeline is restarted multiple times). Identical to onStart except
* that the function will always be passed an event parameter whose target property points
* to the timeline. It's the same as doing myTimeline.addEventListener("start", myFunction);.
* Unless you need the event parameter, it's better/faster to use onStart.onUpdate except
* that the function will always be passed an event parameter whose target property points
* to the timeline. It's the same as doing myTimeline.addEventListener("update", myFunction);.
* Unless you need the event parameter, it's better/faster to use onUpdate.onComplete except that the function will always be passed an event
* parameter whose target property points to the timeline. It's the same as doing
* myTimeline.addEventListener("complete", myFunction);.
* Unless you need the event parameter, it's better/faster to use onComplete.reverse() is called
* the timeline will move back towards its beginning and when its totalTime reaches 0,
* onReverseCompleteListener will be called. This can also happen if the timeline is placed
* in another TimelineLite or TimelineMax instance that gets reversed and plays the timeline backwards to
* (or past) the beginning. Identical to onReverseComplete except that the function
* will always be passed an event parameter whose target property points to the timeline.
* It's the same as doing myTimeline.addEventListener("reverseComplete", myFunction);.
* Unless you need the event parameter, it's better/faster to use onReverseComplete.onRepeat except that the function will always be passed an event
* parameter whose target property points to the timeline. It's the same as doing
* myTimeline.addEventListener("repeat", myFunction);.
* Unless you need the event parameter, it's better/faster to use onRepeat.How do timelines work? What are the mechanics like?
*Every animation (tween and timeline) is placed on a parent timeline (except the 2 root timelines - there's one for normal tweens and another for "useFrames" ones). * In a sense, they all have their own playheads (that's what its "time" refers to, or "totalTime" which is identical except that it includes repeats and repeatDelays) * but generally they're not independent because they're sitting on a timeline whose playhead moves. * When the parent's playhead moves to a new position, it updates the childrens' too.
* *When a timeline renders at a particular time, it loops through its children and says "okay, you should render as if your playhead is at ____" and if that child * is a timeline with children, it does the same to its children, right on down the line.
* *The only exception is when the tween/timeline is paused in which case its internal playhead acts like it's "locked". So in that case,
* it's possible (likely in fact) that the child's playhead would not be synced with the parent's.
* When you unpause it (resume()), it essentially picks it up and moves it so that its internal playhead
* is synchronized with wherever the parent's playhead is at that moment, thus things play perfectly smoothly.
* That is, unless the timeline's smoothChildTiming is to false in which case it won't move -
* its startTime will remain locked to where it was.
So basically, when smoothChildTiming is true, the engine will rearrange things on
* the fly to ensure the playheads line up so that playback is seamless and smooth. The same thing happens when you reverse()
* or alter the timeScale, etc. But sometimes you might not want that behavior - you prefer to have tight
* control over exactly where your tweens line up in the timeline - that's when smoothChildTiming:false is handy.
One more example: let's say you've got a 10-second tween that's just sitting on the root timeline and you're 2-seconds into the tween.
* Let's assume it started at exactly 0 on the root to make this easy, and then when it's at 2-seconds, you do tween.seek(5).
* The playhead of the root isn't affected - it keeps going exactly as it always did, but in order to make that tween jump to 5 seconds
* and play appropriately, the tween's startTime gets changed to -3. That way, the tween's playhead and the root
* playhead are perfectly aligned.
Copyright 2008-2014, GreenSock. All rights reserved. This work is subject to the terms in http://www.greensock.com/terms_of_use.html or for Club GreenSock members, the software agreement that was issued with the membership.
* * @author Jack Doyle, jack@greensock.com * **/ public class TimelineMax extends TimelineLite implements IEventDispatcher { /** @private **/ public static const version:String = "12.1.5"; /** @private **/ protected static var _listenerLookup:Object = {onCompleteListener:TweenEvent.COMPLETE, onUpdateListener:TweenEvent.UPDATE, onStartListener:TweenEvent.START, onRepeatListener:TweenEvent.REPEAT, onReverseCompleteListener:TweenEvent.REVERSE_COMPLETE}; /** @private **/ protected static var _easeNone:Ease = new Ease(null, null, 1, 0); /** @private **/ protected var _repeat:int; /** @private **/ protected var _repeatDelay:Number; /** @private **/ protected var _cycle:int = 0; /** @private **/ protected var _locked:Boolean; /** @private **/ protected var _dispatcher:EventDispatcher; /** @private **/ protected var _hasUpdateListener:Boolean; /** * @private * Works in conjunction with the repeat property, determining the behavior of each cycle; whenyoyo is true,
* the timeline will go back and forth, appearing to reverse every other cycle (this has no affect on the reversed property though).
* So if repeat is 2 and yoyo is false, it will look like: start - 1 - 2 - 3 - 1 - 2 - 3 - 1 - 2 - 3 - end.
* But if repeat is 2 and yoyo is true, it will look like: start - 1 - 2 - 3 - 3 - 2 - 1 - 1 - 2 - 3 - end.
**/
protected var _yoyo:Boolean;
/**
* Constructor.
*
* SPECIAL PROPERTIES
*The following special properties may be passed in via the constructor's vars parameter, like
* new TimelineMax({paused:true, onComplete:myFunction, repeat:2, yoyo:true})
true, the timeline will pause itself immediately upon creation (by default,
* timelines automatically begin playing immediately). If you plan to create a TimelineMax and
* then populate it later (after one or more frames elapse), it is typically best to set
* paused:true and then play() after you populate it.onComplete function. For example,
* new TimelineMax({onComplete:myFunction, onCompleteParams:["param1", "param2"]});useFrames is true, the timelines's timing will be
* based on frames instead of seconds because it is intially added to the root
* frames-based timeline. This causes both its duration
* and delay to be based on frames. An animations's timing mode is
* always determined by its parent timeline.tweens
* 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 add() method.tweens special property when multiple
* tweens are to be inserted immediately. The value simply gets passed to the
* add() method. The default is "normal".
* Options are:
* "sequence": aligns the tweens one-after-the-other in a sequence"start": aligns the start times of all of the tweens (ignores delays)"normal": aligns the start times of all the tweens (honors delays)align special property does not force all child
* tweens/timelines to maintain relative positioning, so for example, if you use
* "sequence" and then later change the duration of one of the nested tweens,
* it does not force all subsequent timelines to change their position.
* The align special property only affects the alignment of the tweens that are
* initially placed into the timeline through the tweens special property of
* the vars object.tweens 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 "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 "sequence",
* there would be 0.5 seconds added between each tween. This value simply gets
* passed to the add() method. Default is 0.time
* changes from 0 to some other value which can happen more than once if the
* timeline is restarted multiple times).onStart function. For example,
* new TimelineMax({onStart:myFunction, onStartParams:["param1", "param2"]});onUpdate function. For example,
* new TimelineMax({onUpdate:myFunction, onUpdateParams:["param1", "param2"]});reverse() is called, the timeline will move
* back towards its beginning and when its time reaches 0, onReverseComplete
* will be called. This can also happen if the timeline is placed in a TimelineLite or TimelineMax
* instance that gets reversed and plays the timeline backwards to (or past) the beginning.onReverseComplete function. For example,
* new TimelineMax({onReverseComplete:myFunction, onReverseCompleteParams:["param1", "param2"]});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
* reverse() or set the progress lower, etc.). It can, however,
* improve speed and memory management. The root timelines use autoRemoveChildren:true.startTime) in order to maintain smooth playback when
* properties are changed on-the-fly. For example, imagine that the timeline's playhead is
* on a child tween that is 75% complete, moving mc.x from 0 to 100 and then that tween's
* reverse() method is called. If smoothChildTiming is false
* (the default except for the root timelines), the tween would flip in place, keeping its
* startTime consistent. Therefore the playhead of the timeline would now be
* at the tween's 25% completion point instead of 75%. Remember, the timeline's playhead
* position and direction are unaffected by child tween/timeline changes. mc.x would jump
* from 75 to 25, but the tween's position in the timeline would remain consistent. However,
* if smoothChildTiming is true, that child tween's
* startTime would be adjusted so that the timeline's playhead intersects
* with the same spot on the tween (75% complete) as it had immediately before
* reverse() was called, thus playback appears perfectly smooth. mc.x
* would still be 75 and it would continue from there as the playhead moves on, but
* since the tween is reversed now mc.x will travel back towards 0 instead of 100.
* Ultimately it's a decision between prioritizing smooth on-the-fly playback
* (true) or consistent position(s) of child tweens/timelines
* (false).
*
* Some examples of on-the-fly changes to child tweens/timelines that could cause their
* startTime to change when smoothChildTiming is true
* are: reversed, timeScale, progress, totalProgress, time, totalTime, delay, pause,
* resume, duration, and totalDuration.repeat is 1, the timeline will play a total of twice (the initial play
* plus 1 repeat). To repeat indefinitely, use -1. repeat should always be an integer.repeat is 2 and repeatDelay is 1, the timeline will play initially,
* then wait for 1 second before it repeats, then play again, then wait 1 second again before
* doing its final repeat.true, every other repeat cycle will run in the opposite
* direction so that the timeline appears to go back and forth (forward then backward).
* This has no affect on the "reversed" property though. So if repeat
* is 2 and yoyo is false, it will look like:
* start - 1 - 2 - 3 - 1 - 2 - 3 - 1 - 2 - 3 - end. But if yoyo is true,
* it will look like: start - 1 - 2 - 3 - 3 - 2 - 1 - 1 - 2 - 3 - end.new TimelineMax({repeat:3, onRepeat:myFunction, onRepeatParams:[mc, "param2"]});totalTime changes from 0 to some other value which can happen more
* than once if the timeline is restarted multiple times). Identical to onStart except
* that the function will always be passed an event parameter whose target property points
* to the timeline. It's the same as doing myTimeline.addEventListener("start", myFunction);.
* Unless you need the event parameter, it's better/faster to use onStart.onUpdate except
* that the function will always be passed an event parameter whose target property points
* to the timeline. It's the same as doing myTimeline.addEventListener("update", myFunction);.
* Unless you need the event parameter, it's better/faster to use onUpdate.onComplete except that the function will always be passed an event
* parameter whose target property points to the timeline. It's the same as doing
* myTimeline.addEventListener("complete", myFunction);.
* Unless you need the event parameter, it's better/faster to use onComplete.reverse() is called
* the timeline will move back towards its beginning and when its totalTime reaches 0,
* onReverseCompleteListener will be called. This can also happen if the timeline is placed
* in another TimelineLite or TimelineMax instance that gets reversed and plays the timeline backwards to
* (or past) the beginning. Identical to onReverseComplete except that the function
* will always be passed an event parameter whose target property points to the timeline.
* It's the same as doing myTimeline.addEventListener("reverseComplete", myFunction);.
* Unless you need the event parameter, it's better/faster to use onReverseComplete.onRepeat except that the function will always be passed an event
* parameter whose target property points to the timeline. It's the same as doing
* myTimeline.addEventListener("repeat", myFunction);.
* Unless you need the event parameter, it's better/faster to use onRepeat.getChildren() there will be a tween returned for each callback.
* You can discern a callback from other tweens by the fact that its target is a function matching
* its vars.onComplete and its duration is zero.
*
* If your goal is to append the callback to the end of the timeline, it would be easier
* (more concise) to use the call() method. Technically the add() method
* can accommodate adding a callback too (like myTimeline.add(myFunction, 2)
* or myTimeline.add(myFunction, "+=2")) but add() doesn't accommodate parameters.
JavaScript and AS2 note: - Due to the way JavaScript and AS2 don't
* maintain scope (what "this" refers to, or the context) in function calls,
* it can be useful to define the scope specifically. Therefore, in the JavaScript and AS2
* versions accept an extra (4th) parameter for scope.
myTimeline.addCallback(myFunction, 3) would call myFunction() 3 seconds into the timeline, and myTimeline.addCallback(myFunction, "myLabel") would call it at the "myLabel" label. myTimeline.addCallback(myFunction, "+=2") would insert the callback 2 seconds after the end of the timeline.
* @param params An Array of parameters to pass the callback
* @return self (makes chaining easier)
*
* @see #call()
* @see #add()
* @see #removeCallback()
*/
public function addCallback(callback:Function, position:*, params:Array=null):TimelineMax {
return add( TweenLite.delayedCall(0, callback, params), position) as TimelineMax;
}
/**
* Removes a callback. If the position parameter
* is null, all callbacks of that function are removed from the timeline.
*
* @param function callback function to be removed
* @param position the time in seconds (or frames for frames-based timelines) or label from which the callback should be removed. For example, myTimeline.removeCallback(myFunction, 3) would remove the callback from 3-seconds into the timeline, and myTimeline.removeCallback(myFunction, "myLabel") would remove it from the "myLabel" label, and myTimeline.removeCallback(myFunction, null) would remove ALL callbacks of that function regardless of where they are on the timeline.
* @return self (makes chaining easier)
*
* @see #addCallback()
* @see #call()
* @see #kill()
*/
public function removeCallback(callback:Function, position:*=null):TimelineMax {
if (callback != null) {
if (position == null) {
_kill(null, callback);
} else {
var a:Array = getTweensOf(callback, false),
i:int = a.length,
time:Number = _parseTimeOrLabel(position);
while (--i > -1) {
if (a[i]._startTime === time) {
a[i]._enabled(false, false);
}
}
}
}
return this;
}
/**
* Creates a linear tween that essentially scrubs the playhead to a particular time or label and
* then stops. For example, to make the TimelineMax play to the "myLabel2" label, simply do:
*
*
* myTimeline.tweenTo("myLabel2");
*
If you want advanced control over the tween, like adding an onComplete or changing the ease or
* adding a delay, just pass in a vars object with the appropriate properties. For example,
* to tween to the 5-second point on the timeline and then call a function named myFunction
* and pass in a parameter that's references this TimelineMax and use a Strong.easeOut ease, you'd do:
* myTimeline.tweenTo(5, {onComplete:myFunction, onCompleteParams:[myTimeline], ease:Strong.easeOut});
*
Remember, this method simply creates a TweenLite instance that pauses the timeline and then tweens
* the time() of the timeline. So you can store a reference to that tween if you want, and
* you can kill() it anytime. Also note that tweenTo() does NOT affect the timeline's
* reversed state. So if your timeline is oriented normally (not reversed) and you tween to
* a time/label that precedes the current time, it will appear to go backwards but the reversed
* state will not change to true. Also note that tweenTo()
* pauses the timeline immediately before tweening its time(), and it does not automatically
* resume after the tween completes. If you need to resume playback, you could always use an onComplete
* to call the timeline's resume() method.
If you plan to sequence multiple playhead tweens one-after-the-other, it is typically better to use
* tweenFromTo() so that you can define the starting point and ending point, allowing the
* duration to be accurately determined immediately.
myTimeline.tweenTo(5) would play from wherever the timeline is currently to the 5-second point whereas myTimeline.tweenTo("myLabel") would play to wherever "myLabel" is on the timeline.
* @param vars An optional vars object that will be passed to the TweenLite instance. This allows you to define an onComplete, ease, delay, or any other TweenLite special property.
* @return A TweenLite instance that handles tweening the timeline to the desired time/label.
*
* @see #tweenFromTo()
* @see #seek()
*/
public function tweenTo(position:*, vars:Object=null):TweenLite {
vars = vars || {};
var copy:Object = {ease:_easeNone, overwrite:(vars.delay ? 2 : 1), useFrames:usesFrames(), immediateRender:false};
for (var p:String in vars) {
copy[p] = vars[p];
}
copy.time = _parseTimeOrLabel(position);
var duration:Number = (Math.abs(Number(copy.time) - _time) / _timeScale) || 0.001;
var t:TweenLite = new TweenLite(this, duration, copy);
copy.onStart = function():void {
t.target.paused(true);
if (t.vars.time != t.target.time() && duration === t.duration()) { //don't make the duration zero - if it's supposed to be zero, don't worry because it's already initting the tween and will complete immediately, effectively making the duration zero anyway. If we make duration zero, the tween won't run at all.
t.duration( Math.abs( t.vars.time - t.target.time()) / t.target._timeScale );
}
if (vars.onStart) { //in case the user had an onStart in the vars - we don't want to overwrite it.
vars.onStart.apply(null, vars.onStartParams);
}
}
return t;
}
/**
* Creates a linear tween that essentially scrubs the playhead from a particular time or label
* to another time or label and then stops. If you plan to sequence multiple playhead tweens
* one-after-the-other, tweenFromTo() is better to use than tweenTo()
* because it allows the duration to be determined immediately, ensuring that subsequent tweens
* that are appended to a sequence are positioned appropriately. For example, to make the
* TimelineMax play from the label "myLabel1" to the "myLabel2" label, and then from "myLabel2"
* back to the beginning (a time of 0), simply do:
*
* If you want advanced control over the tween, like adding an onComplete or changing the ease
* or adding a delay, just pass in a vars object with the appropriate properties. For example,
* to tween from the start (0) to the 5-second point on the timeline and then call a function
* named myFunction and pass in a parameter that references this TimelineMax and
* use a Strong.easeOut ease, you'd do:
* myTimeline.tweenFromTo(0, 5, {onComplete:myFunction, onCompleteParams:[myTimeline], ease:Strong.easeOut});
*
Remember, this method simply creates a TweenLite instance that tweens the time()
* of your timeline. So you can store a reference to that tween if you want, and you can kill()
* it anytime. Also note that tweenFromTo() does NOT affect the timeline's
* reversed property. So if your timeline is oriented normally (not reversed) and you
* tween to a time/label that precedes the current time, it will appear to go backwards but the
* reversed property will not change to true. Also note that
* tweenFromTo() pauses the timeline immediately before tweening its time(),
* and it does not automatically resume after the tween completes. If you need to resume playback,
* you can always use an onComplete to call the resume() method.
Like all from-type methods in GSAP, immediateRender is true by default,
* meaning the timeline will immediately jump to the "from" time/label unless you set immediateRender:false
myTimeline.tweenTo(0, 5) would play from 0 (the beginning) to the 5-second point whereas myTimeline.tweenFromTo("myLabel1", "myLabel2") would play from "myLabel1" to "myLabel2".
* @param toPosition The destination time in seconds (or frame if the timeline is frames-based) or label to which the timeline should play. For example, myTimeline.tweenTo(0, 5) would play from 0 (the beginning) to the 5-second point whereas myTimeline.tweenFromTo("myLabel1", "myLabel2") would play from "myLabel1" to "myLabel2".
* @param vars An optional vars object that will be passed to the TweenLite instance. This allows you to define an onComplete, ease, delay, or any other TweenLite special property. onInit is the only special property that is not available (tweenFromTo() sets it internally)
* @return TweenLite instance that handles tweening the timeline between the desired times/labels.
*
* @see #tweenTo()
* @see #seek()
*/
public function tweenFromTo(fromPosition:*, toPosition:*, vars:Object=null):TweenLite {
vars = vars || {};
fromPosition = _parseTimeOrLabel(fromPosition);
vars.startAt = {onComplete:seek, onCompleteParams:[fromPosition]};
vars.immediateRender = (vars.immediateRender !== false);
var t:TweenLite = tweenTo(toPosition, vars);
return t.duration((Math.abs( t.vars.time - fromPosition) / _timeScale) || 0.001) as TweenLite;
}
/** @private **/
override public function render(time:Number, suppressEvents:Boolean=false, force:Boolean=false):void {
if (_gc) {
_enabled(true, false);
}
var totalDur:Number = (!_dirty) ? _totalDuration : totalDuration(),
prevTime:Number = _time,
prevTotalTime:Number = _totalTime,
prevStart:Number = _startTime,
prevTimeScale:Number = _timeScale,
prevRawPrevTime:Number = _rawPrevTime,
prevPaused:Boolean = _paused,
prevCycle:int = _cycle,
tween:Animation, isComplete:Boolean, next:Animation, dur:Number, callback:String, internalForce:Boolean;
if (time >= totalDur) {
if (!_locked) {
_totalTime = totalDur;
_cycle = _repeat;
}
if (!_reversed) if (!_hasPausedChild()) {
isComplete = true;
callback = "onComplete";
if (_duration === 0) if (time === 0 || _rawPrevTime < 0 || _rawPrevTime === _tinyNum) if (_rawPrevTime !== time && _first != null) {
internalForce = true;
if (_rawPrevTime > _tinyNum) {
callback = "onReverseComplete";
}
}
}
_rawPrevTime = (_duration || !suppressEvents || time !== 0 || _rawPrevTime === time) ? time : _tinyNum; //when the playhead arrives at EXACTLY time 0 (right on top) of a zero-duration timeline or tween, we need to discern if events are suppressed so that when the playhead moves again (next time), it'll trigger the callback. If events are NOT suppressed, obviously the callback would be triggered in this render. Basically, the callback should fire either when the playhead ARRIVES or LEAVES this exact spot, not both. Imagine doing a timeline.seek(0) and there's a callback that sits at 0. Since events are suppressed on that seek() by default, nothing will fire, but when the playhead moves off of that position, the callback should fire. This behavior is what people intuitively expect. We set the _rawPrevTime to be a precise tiny number to indicate this scenario rather than using another property/variable which would increase memory usage. This technique is less readable, but more efficient.
if (_yoyo && (_cycle & 1) != 0) {
_time = time = 0;
} else {
_time = _duration;
time = _duration + 0.0001; //to avoid occasional floating point rounding errors in Flash - sometimes child tweens/timelines were not being fully completed (their progress might be 0.999999999999998 instead of 1 because when Flash performed _time - tween._startTime, floating point errors would return a value that was SLIGHTLY off)
}
} else if (time < 0.0000001) { //to work around occasional floating point math artifacts, round super small values to 0.
if (!_locked) {
_totalTime = _cycle = 0;
}
_time = 0;
if (prevTime !== 0 || (_duration === 0 && _rawPrevTime !== _tinyNum && (_rawPrevTime > 0 || (time < 0 && _rawPrevTime >= 0)) && !_locked)) {
callback = "onReverseComplete";
isComplete = _reversed;
}
if (time < 0) {
_active = false;
if (_rawPrevTime >= 0 && _first) { //zero-duration timelines are tricky because we must discern the momentum/direction of time in order to determine whether the starting values should be rendered or the ending values. If the "playhead" of its timeline goes past the zero-duration tween in the forward direction or lands directly on it, the end values should be rendered, but if the timeline's "playhead" moves past it in the backward direction (from a postitive time to a negative time), the starting values must be rendered.
internalForce = true;
}
_rawPrevTime = time;
} else {
_rawPrevTime = (_duration || !suppressEvents || time !== 0 || _rawPrevTime === time) ? time : _tinyNum; //when the playhead arrives at EXACTLY time 0 (right on top) of a zero-duration timeline or tween, we need to discern if events are suppressed so that when the playhead moves again (next time), it'll trigger the callback. If events are NOT suppressed, obviously the callback would be triggered in this render. Basically, the callback should fire either when the playhead ARRIVES or LEAVES this exact spot, not both. Imagine doing a timeline.seek(0) and there's a callback that sits at 0. Since events are suppressed on that seek() by default, nothing will fire, but when the playhead moves off of that position, the callback should fire. This behavior is what people intuitively expect. We set the _rawPrevTime to be a precise tiny number to indicate this scenario rather than using another property/variable which would increase memory usage. This technique is less readable, but more efficient.
time = 0; //to avoid occasional floating point rounding errors (could cause problems especially with zero-duration tweens at the very beginning of the timeline)
if (!_initted) {
internalForce = true;
}
}
} else {
if (_duration === 0 && _rawPrevTime < 0) { //without this, zero-duration repeating timelines (like with a simple callback nested at the very beginning and a repeatDelay) wouldn't render the first time through.
internalForce = true;
}
_time = _rawPrevTime = time;
if (!_locked) {
_totalTime = time;
if (_repeat != 0) {
var cycleDuration:Number = _duration + _repeatDelay;
_cycle = (_totalTime / cycleDuration) >> 0; //originally _totalTime % cycleDuration but floating point errors caused problems, so I normalized it. (4 % 0.8 should be 0 but Flash reports it as 0.79999999!)
if (_cycle !== 0) if (_cycle === _totalTime / cycleDuration) {
_cycle--; //otherwise when rendered exactly at the end time, it will act as though it is repeating (at the beginning)
}
_time = _totalTime - (_cycle * cycleDuration);
if (_yoyo) if ((_cycle & 1) != 0) {
_time = _duration - _time;
}
if (_time > _duration) {
_time = _duration;
time = _duration + 0.0001; //to avoid occasional floating point rounding errors in Flash - sometimes child tweens/timelines were not being fully completed (their progress might be 0.999999999999998 instead of 1 because when Flash performed _time - tween._startTime, floating point errors would return a value that was SLIGHTLY off)
} else if (_time < 0) {
_time = time = 0;
} else {
time = _time;
}
}
}
}
if (_cycle != prevCycle) if (!_locked) {
/*
make sure children at the end/beginning of the timeline are rendered properly. If, for example,
a 3-second long timeline rendered at 2.9 seconds previously, and now renders at 3.2 seconds (which
would get transated to 2.8 seconds if the timeline yoyos or 0.2 seconds if it just repeats), there
could be a callback or a short tween that's at 2.95 or 3 seconds in which wouldn't render. So
we need to push the timeline to the end (and/or beginning depending on its yoyo value). Also we must
ensure that zero-duration tweens at the very beginning or end of the TimelineMax work.
*/
var backwards:Boolean = (_yoyo && (prevCycle & 1) !== 0),
wrap:Boolean = (backwards == (_yoyo && (_cycle & 1) !== 0)),
recTotalTime:Number = _totalTime,
recCycle:int = _cycle,
recRawPrevTime:Number = _rawPrevTime,
recTime:Number = _time;
_totalTime = prevCycle * _duration;
if (_cycle < prevCycle) {
backwards = !backwards;
} else {
_totalTime += _duration;
}
_time = prevTime; //temporarily revert _time so that render() renders the children in the correct order. Without this, tweens won't rewind correctly. We could arhictect things in a "cleaner" way by splitting out the rendering queue into a separate method but for performance reasons, we kept it all inside this method.
_rawPrevTime = prevRawPrevTime;
_cycle = prevCycle;
_locked = true; //prevents changes to totalTime and skips repeat/yoyo behavior when we recursively call render()
prevTime = (backwards) ? 0 : _duration;
render(prevTime, suppressEvents, false);
if (!suppressEvents) if (!_gc) {
if (vars.onRepeat) {
vars.onRepeat.apply(null, vars.onRepeatParams);
}
if (_dispatcher) {
_dispatcher.dispatchEvent(new TweenEvent(TweenEvent.REPEAT));
}
}
if (wrap) {
prevTime = (backwards) ? _duration + 0.0001 : -0.0001;
render(prevTime, true, false);
}
_locked = false;
if (_paused && !prevPaused) { //if the render() triggered callback that paused this timeline, we should abort (very rare, but possible)
return;
}
_time = recTime;
_totalTime = recTotalTime;
_cycle = recCycle;
_rawPrevTime = recRawPrevTime;
}
if ((_time == prevTime || !_first) && !force && !internalForce) {
if (prevTotalTime !== _totalTime) if (_onUpdate != null) if (!suppressEvents) { //so that onUpdate fires even during the repeatDelay - as long as the totalTime changed, we should trigger onUpdate.
_onUpdate.apply(vars.onUpdateScope || this, vars.onUpdateParams);
}
return;
} else if (!_initted) {
_initted = true;
}
if (!_active) if (!_paused && _totalTime !== prevTotalTime && time > 0) {
_active = true; //so that if the user renders the timeline (as opposed to the parent timeline rendering it), it is forced to re-render and align it with the proper time/frame on the next rendering cycle. Maybe the timeline already finished but the user manually re-renders it as halfway done, for example.
}
if (prevTotalTime == 0) if (_totalTime != 0) if (!suppressEvents) {
if (vars.onStart) {
vars.onStart.apply(this, vars.onStartParams);
}
if (_dispatcher) {
_dispatcher.dispatchEvent(new TweenEvent(TweenEvent.START));
}
}
if (_time >= prevTime) {
tween = _first;
while (tween) {
next = tween._next; //record it here because the value could change after rendering...
if (_paused && !prevPaused) { //in case a tween pauses the timeline when rendering
break;
} else if (tween._active || (tween._startTime <= _time && !tween._paused && !tween._gc)) {
if (!tween._reversed) {
tween.render((time - tween._startTime) * tween._timeScale, suppressEvents, force);
} else {
tween.render(((!tween._dirty) ? tween._totalDuration : tween.totalDuration()) - ((time - tween._startTime) * tween._timeScale), suppressEvents, force);
}
}
tween = next;
}
} else {
tween = _last;
while (tween) {
next = tween._prev; //record it here because the value could change after rendering...
if (_paused && !prevPaused) { //in case a tween pauses the timeline when rendering
break;
} else if (tween._active || (tween._startTime <= prevTime && !tween._paused && !tween._gc)) {
if (!tween._reversed) {
tween.render((time - tween._startTime) * tween._timeScale, suppressEvents, force);
} else {
tween.render(((!tween._dirty) ? tween._totalDuration : tween.totalDuration()) - ((time - tween._startTime) * tween._timeScale), suppressEvents, force);
}
}
tween = next;
}
}
if (_onUpdate != null) if (!suppressEvents) {
_onUpdate.apply(null, vars.onUpdateParams);
}
if (_hasUpdateListener) if (!suppressEvents) {
_dispatcher.dispatchEvent(new TweenEvent(TweenEvent.UPDATE));
}
if (callback) if (!_locked) if (!_gc) if (prevStart === _startTime || prevTimeScale !== _timeScale) if (_time === 0 || totalDur >= totalDuration()) { //if one of the tweens that was rendered altered this timeline's startTime (like if an onComplete reversed the timeline), it probably isn't complete. If it is, don't worry, because whatever call altered the startTime would complete if it was necessary at the new time. The only exception is the timeScale property. Also check _gc because there's a chance that kill() could be called in an onUpdate
if (isComplete) {
if (_timeline.autoRemoveChildren) {
_enabled(false, false);
}
_active = false;
}
if (!suppressEvents) {
if (vars[callback]) {
vars[callback].apply(null, vars[callback + "Params"]);
}
if (_dispatcher) {
_dispatcher.dispatchEvent(new TweenEvent(((callback == "onComplete") ? TweenEvent.COMPLETE : TweenEvent.REVERSE_COMPLETE)));
}
}
}
}
/**
* Returns the tweens/timelines that are currently active in the timeline, meaning the timeline's
* playhead is positioned on the child tween/timeline and the child isn't paused.
*
* @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 child timelines (TimelineLite and TimelineMax instances) should be included in the results
* @return an Array of active tweens/timelines
*/
public function getActive(nested:Boolean=true, tweens:Boolean=true, timelines:Boolean=false):Array {
var a:Array = [],
all:Array = getChildren(nested, tweens, timelines),
cnt:int = 0,
l:int = all.length,
i:int, tween:Animation;
for (i = 0; i < l; i++) {
tween = all[i];
//note: we cannot just check tween.active because timelines that contain paused children will continue to have "active" set to true even after the playhead passes their end point (technically a timeline can only be considered complete after all of its children have completed too, but paused tweens are...well...just waiting and until they're unpaused we don't know where their end point will be).
if (!tween._paused) if (tween._timeline._time >= tween._startTime) if (tween._timeline._time < tween._startTime + tween._totalDuration / tween._timeScale) if (!_getGlobalPaused(tween._timeline)) {
a[cnt++] = tween;
}
}
return a;
}
/** @private **/
protected static function _getGlobalPaused(tween:Animation):Boolean {
while (tween) {
if (tween._paused) {
return true;
}
tween = tween._timeline;
}
return false;
}
/**
* Returns the next label (if any) that occurs after the time parameter.
* It makes no difference if the timeline is reversed ("after" means later in the timeline's local time zone).
* A label that is positioned exactly at the same time as the time parameter will be ignored.
*
* You could use getLabelAfter() in conjunction with tweenTo() to make
* the timeline tween to the next label like this:
* myTimeline.tweenTo( myTimeline.getLabelAfter() );
*
time parameter.
* It makes no difference if the timeline is reversed ("before" means earlier in the timeline's local time zone).
* A label that is positioned exactly at the same time as the time parameter will be ignored.
*
* You could use getLabelBefore() in conjunction with tweenTo() to make
* the timeline tween back to the previous label like this:
* myTimeline.tweenTo( myTimeline.getLabelBefore() );
*
Note: changing the values in this array will have no effect on the actual labels inside the TimelineMax. To add/remove labels,
* use the corresponding methods (addLabel(), removeLabel()).
"complete" or "update". The function will be passed a single "event"
* parameter whose "target" property refers to the timeline. Typically it is more efficient
* to use callbacks like onComplete, onUpdate, onStart, onReverseComplete, and onRepeat
* unless you need the event parameter or if you need to register more than one listener for the same
* type of event.
*
* If you no longer need an event listener, remove it by calling removeEventListener(), or memory
* problems could result. Event listeners are not automatically removed from memory because the garbage
* collector does not remove the listener as long as the dispatching object exists (unless the
* useWeakReference parameter is set to true).
*
* @param type The type of event
* @param listener The listener function that processes the event. This function must accept an Event object as its only parameter
* @param useCapture (not typically used) Determines whether the listener works in the capture phase or the target and bubbling phases. If useCapture is set to true, the listener processes the event only during the capture phase and not in the target or bubbling phase. If useCapture is false, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call addEventListener twice, once with useCapture set to true, then again with useCapture set to false.
* @param priority The priority level of the event listener. The priority is designated by a signed 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.
* @param useWeakReference Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not.
* @see #removeEventListener()
**/
public function addEventListener(type:String, listener:Function, useCapture:Boolean=false, priority:int=0, useWeakReference:Boolean=false):void {
if (_dispatcher == null) {
_dispatcher = new EventDispatcher(this);
}
if (type == TweenEvent.UPDATE) {
_hasUpdateListener = true;
}
_dispatcher.addEventListener(type, listener, useCapture, priority, useWeakReference);
}
/**
* (AS3 only)
* Removes a listener from the EventDispatcher object. If there is no matching listener registered
* with the EventDispatcher object, a call to this method has no effect.
*
* @param type The type of event
* @param listener The listener object to remove.
* @param useCapture Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to removeEventListener() are required to remove both, one call with useCapture() set to true, and another call with useCapture() set to false.
**/
public function removeEventListener(type:String, listener:Function, useCapture:Boolean=false):void {
if (_dispatcher != null) {
_dispatcher.removeEventListener(type, listener, useCapture);
}
}
/** @private **/
public function hasEventListener(type:String):Boolean {
return (_dispatcher == null) ? false : _dispatcher.hasEventListener(type);
}
/** @private **/
public function willTrigger(type:String):Boolean {
return (_dispatcher == null) ? false : _dispatcher.willTrigger(type);
}
/** @private **/
public function dispatchEvent(event:Event):Boolean {
return (_dispatcher == null) ? false : _dispatcher.dispatchEvent(event);
}
//---- GETTERS / SETTERS -------------------------------------------------------------------------------------------------------
/**
* Gets or sets the timeline's progress which is a value between 0 and 1 indicating the position
* of the virtual playhead (excluding repeats) where 0 is at the beginning, 0.5 is halfway complete,
* and 1 is complete. If the timeline has a non-zero repeat defined, progress
* and totalProgress will be different because progress doesn't include any
* repeats or repeatDelays whereas totalProgress does. For example, if a TimelineMax instance
* is set to repeat once, at the end of the first cycle totalProgress would only be 0.5
* whereas progress would be 1. If you watched both properties over the course of the entire
* animation, you'd see progress go from 0 to 1 twice (once for each cycle) in the
* same time it takes the totalProgress to go from 0 to 1 once.
*
* This method serves as both a getter and setter. Omitting the parameter returns the current
* value (getter), whereas defining the parameter sets the value (setter) and returns the instance
* itself for easier chaining, like myTimeline.progress(0.5).play();
true, no events or callbacks will be triggered when the playhead moves to the new position.
* @return Omitting the parameter returns the current value (getter), whereas defining the parameter sets the value (setter) and returns the instance itself for easier chaining.
*
* @see #totalProgress()
* @see #seek()
* @see #time()
* @see #totalTime()
**/
override public function progress(value:Number=NaN, suppressEvents:Boolean=false):* {
return (!arguments.length) ? _time / duration() : totalTime( duration() * ((_yoyo && (_cycle & 1) !== 0) ? 1 - value : value) + (_cycle * (_duration + _repeatDelay)), suppressEvents);
}
/**
* Gets or sets the timeline's total progress which is a value between 0 and 1 indicating the position
* of the virtual playhead (including repeats) where 0 is at the beginning, 0.5 is
* at the halfway point, and 1 is at the end (complete). If the timeline has a non-zero repeat defined,
* progress() and totalProgress() will be different because progress()
* doesn't include the repeat or repeatDelay whereas totalProgress() does. For example,
* if a TimelineMax instance is set to repeat once, at the end of the first cycle totalProgress()
* would only be 0.5 whereas progress would be 1. If you watched both properties over the
* course of the entire animation, you'd see progress go from 0 to 1 twice (once for
* each cycle) in the same time it takes the totalProgress() to go from 0 to 1 once.
*
* This method serves as both a getter and setter. Omitting the parameter returns the current
* value (getter), whereas defining the parameter sets the value (setter) and returns the instance
* itself for easier chaining, like myAnimation.totalProgress(0.5).play();
true, no events or callbacks will be triggered when the playhead moves to the new position.
* @return Omitting the parameter returns the current value (getter), whereas defining the parameter sets the value (setter) and returns the instance itself for easier chaining.
*
* @see #progress()
* @see #seek()
* @see #time()
* @see #totalTime()
**/
override public function totalProgress(value:Number=NaN, suppressEvents:Boolean=true):* {
return (!arguments.length) ? _totalTime / totalDuration() : totalTime( totalDuration() * value, suppressEvents);
}
/**
* Gets or sets the total duration of the timeline in seconds (or frames for frames-based timelines)
* including any repeats or repeatDelays. duration, by contrast, does
* NOT include repeats and repeatDelays. For example, if the timeline has a
* duration of 10, a repeat of 1 and a repeatDelay of 2,
* the totalDuration would be 22.
*
* This method serves as both a getter and setter. Omitting the parameter returns the current * value (getter), whereas defining the parameter sets the value (setter) and returns the instance * itself for easier chaining.
* *repeat, its time
* goes back to zero upon repeating even though the totalTime continues forward linearly
* (or if yoyo is true, the time alternates between moving forward
* and backward). time never exceeds the duration whereas the totalTime reflects
* the overall time including any repeats and repeatDelays.
*
* For example, if a TimelineMax instance has a duration of 2 and a repeat of 3,
* totalTime will go from 0 to 8 during the course of the timeline (plays once then
* repeats 3 times, making 4 total cycles) whereas time would go from 0 to 2 a
* total of 4 times.
This method serves as both a getter and setter. Omitting the parameter returns the current * value (getter), whereas defining the parameter sets the value (setter) and returns the instance * itself for easier chaining.
* *true, no events or callbacks will be triggered when the playhead moves to the new position defined in the value parameter.
* @return Omitting the parameter returns the current value (getter), whereas defining the parameter sets the value (setter) and returns the instance itself for easier chaining.
*
* @see #seek()
* @see #play()
* @see #reverse()
* @see #pause()
* @see #totalTime()
**/
override public function time(value:Number=NaN, suppressEvents:Boolean=false):* {
if (!arguments.length) {
return _time;
}
if (_dirty) {
totalDuration();
}
if (value > _duration) {
value = _duration;
}
if (_yoyo && (_cycle & 1) !== 0) {
value = (_duration - value) + (_cycle * (_duration + _repeatDelay));
} else if (_repeat != 0) {
value += _cycle * (_duration + _repeatDelay);
}
return totalTime(value, suppressEvents);
}
/**
* Gets or sets the number of times that the timeline should repeat after its first iteration. For
* example, if repeat is 1, the timeline will play a total of twice (the initial play
* plus 1 repeat). To repeat indefinitely, use -1. repeat should always be an integer.
*
* To cause the repeats to alternate between forward and backward, set yoyo to
* true. To add a time gap between repeats, use repeatDelay. You can
* set the initial repeat value via the vars parameter, like:
* var tl = new TimelineMax({repeat:2});
*
This method serves as both a getter and setter. Omitting the parameter returns the current
* value (getter), whereas defining the parameter sets the value (setter) and returns the instance
* itself for easier chaining, like myTimeline.repeat(2).yoyo(true).play();
repeat is 2 and repeatDelay is 1, the timeline will
* play initially, then wait for 1 second before it repeats, then play again, then wait 1 second
* again before doing its final repeat. You can set the initial repeatDelay value
* via the vars parameter, like:
*
*
* var tl = new TimelineMax({repeat:2, repeatDelay:1});
*
This method serves as both a getter and setter. Omitting the parameter returns the current
* value (getter), whereas defining the parameter sets the value (setter) and returns the instance
* itself for easier chaining, like myTimeline.repeat(2).yoyo(true).repeatDelay(0.5).play();
yoyo state, where true causes
* the timeline to go back and forth, alternating backward and forward on each
* repeat. yoyo works in conjunction with repeat,
* where repeat controls how many times the timeline repeats, and yoyo
* controls whether or not each repeat alternates direction. So in order to make a timeline yoyo,
* you must set its repeat to a non-zero value.
* Yoyo-ing, has no affect on the timeline's "reversed" property. For example,
* if repeat is 2 and yoyo is false, it will look like:
* start - 1 - 2 - 3 - 1 - 2 - 3 - 1 - 2 - 3 - end. But if yoyo is true,
* it will look like: start - 1 - 2 - 3 - 3 - 2 - 1 - 1 - 2 - 3 - end.
*
* You can set the yoyo property initially by passing yoyo:true
* in the vars parameter, like: new TimelineMax({repeat:1, yoyo:true});
This method serves as both a getter and setter. Omitting the parameter returns the current
* value (getter), whereas defining the parameter sets the value (setter) and returns the instance
* itself for easier chaining, like myTimeline.yoyo(true).repeat(3).timeScale(2).play(0.5);
This method serves as both a getter and setter. Omitting the parameter returns the current * value (getter), whereas defining the parameter sets the value (setter) and returns the instance * itself for easier chaining.
* * @param value Omitting the parameter returns the current value (getter), whereas defining the parameter sets the value (setter) and returns the instance itself for easier chaining. * @return Omitting the parameter returns the current value (getter), whereas defining the parameter sets the value (setter) and returns the instance itself for easier chaining. * * @see #getLabelAfter() * @see #getLabelBefore() **/ public function currentLabel(value:String=null):* { if (!arguments.length) { return getLabelBefore(_time + 0.00000001); } return seek(value, true); } } }