Package | com.greensock.data |
Class | public dynamic class TweenMaxVars |
Inheritance | TweenMaxVars TweenLiteVars VarsCore flash.utils.Proxy |
var myVars:TweenMaxVars = new TweenMaxVars();
myVars.addProp("x", 300); // use addProp() to add any property that doesn't already exist in the TweenMaxVars instance.
myVars.tint = 0xFF0000;
myVars.onComplete = myFunction;
TweenMax.to(my_mc, 1, myVars);
NOTES:
Property | Defined by | ||
---|---|---|---|
autoAlpha : Number Same as changing the "alpha" property but with the additional feature of toggling the "visible" property to false when alpha is 0.
| TweenLiteVars | ||
bevelFilter : BevelFilterVars
Applies a BevelFilter tween (use the BevelFilterVars class to define the values).
| TweenLiteVars | ||
bezier : Array Array of Objects, one for each "control point" (see documentation on Flash's curveTo() drawing method for more about how control points work).
| TweenLiteVars | ||
bezierThrough : Array Identical to bezier except that instead of passing Bezier control point values, you pass values through which the Bezier values should move.
| TweenLiteVars | ||
blurFilter : BlurFilterVars
Applies a BlurFilter tween (use the BlurFilterVars class to define the values).
| TweenLiteVars | ||
colorMatrixFilter : ColorMatrixFilterVars
Applies a ColorMatrixFilter tween (use the ColorMatrixFilterVars class to define the values).
| TweenLiteVars | ||
colorTransform : ColorTransformVars
Applies a ColorTransform tween (use the ColorTransformVars class to define the values).
| TweenLiteVars | ||
data : * Any data that you'd like associated with your tween.
| TweenLiteVars | ||
delay : Number The number of seconds (or frames for frames-based tweens) to delay before the tween begins.
| TweenLiteVars | ||
dropShadowFilter : DropShadowFilterVars
Applies a DropShadowFilter tween (use the DropShadowFilterVars class to define the values).
| TweenLiteVars | ||
dynamicProps : Object Allows you to associate a function with a property so that every time the tween is updated, it calls that function to get the end value for the associated property.
| TweenLiteVars | ||
ease : Function An easing function (i.e.
| TweenLiteVars | ||
easeParams : Array An Array of extra parameter values to feed the easing equation (beyond the standard 4).
| TweenLiteVars | ||
endArray : Array An Array containing numeric end values of the target Array.
| TweenLiteVars | ||
frame : int Tweens a MovieClip to a particular frame.
| TweenLiteVars | ||
frameLabel : String Tweens a MovieClip to a particular frame.
| TweenLiteVars | ||
glowFilter : GlowFilterVars
Applies a GlowFilter tween (use the GlowFilterVars class to define the values).
| TweenLiteVars | ||
hexColors : Object Although hex colors are technically numbers, if you try to tween them conventionally, you'll notice that they don't tween smoothly.
| TweenLiteVars | ||
immediateRender : Boolean Normally, zero-duration tweens render immediately and all other tweens begin rendering on the very next frame after they are instantiated, but immediateRender allows you to override that behavior if you prefer.
| TweenLiteVars | ||
motionBlur : Object Applies a motionBlur tween.
| TweenLiteVars | ||
onComplete : Function A function to call when the tween has completed.
| TweenLiteVars | ||
onCompleteListener : Function A function to which the TweenMax instance should dispatch a TweenEvent when it completes.
| TweenMaxVars | ||
onCompleteParams : Array An Array of parameters to pass the onComplete function
| TweenLiteVars | ||
onInit : Function A function that should be called just before the tween inits (renders for the first time).
| TweenLiteVars | ||
onInitParams : Array An Array of parameters to pass the onInit function.
| TweenLiteVars | ||
onRepeat : Function A function that should be called every time the tween repeats
| TweenMaxVars | ||
onRepeatParams : Array An Array of parameters to pass the onRepeat function
| TweenMaxVars | ||
onReverseComplete : Function A function that should be called when the tween has reached its starting point again after having been reversed
| TweenMaxVars | ||
onReverseCompleteParams : Array An Array of parameters to pass the onReverseComplete functions
| TweenMaxVars | ||
onStart : Function A function that should be called when the tween begins (when its currentTime is at 0 and changes to some other value which can happen more than once if the tween is restarted multiple times).
| TweenLiteVars | ||
onStartListener : Function A function to which the TweenMax instance should dispatch a TweenEvent when it begins.
| TweenMaxVars | ||
onStartParams : Array An Array of parameters to pass the onStart function.
| TweenLiteVars | ||
onUpdate : Function A function to call whenever the tweening values are updated (on every frame during the time the tween is active).
| TweenLiteVars | ||
onUpdateListener : Function A function to which the TweenMax instance should dispatch a TweenEvent every time it updates values.
| TweenMaxVars | ||
onUpdateParams : Array An Array of parameters to pass the onUpdate function
| TweenLiteVars | ||
orientToBezier : Array
A common effect that designers/developers want is for a MovieClip/Sprite to orient itself in the direction of a Bezier path (alter its rotation).
| TweenLiteVars | ||
overwrite : int NONE = 0, ALL_IMMEDIATE = 1, AUTO = 2, CONCURRENT = 3, ALL_ONSTART = 4, PREEXISTING = 5 (2 through 5 are only available with the optional OverwriteManager add-on class which must be initted once for TweenLite, like OverwriteManager.init().
| TweenLiteVars | ||
paused : Boolean If true, the tween will be paused initially.
| TweenMaxVars | ||
quaternions : Object An object with properties that correspond to the quaternion properties of the target object.
| TweenLiteVars | ||
removeTint : Boolean To remove the tint from a DisplayObject, set removeTint to true.
| TweenLiteVars | ||
repeat : int Number of times that the tween should repeat (to repeat indefinitely, use -1).
| TweenMaxVars | ||
repeatDelay : Number Amount of time in seconds (or frames for frames-based tween) between repeats.
| TweenMaxVars | ||
reversed : Boolean If true, the tween will be reversed initially.
| TweenMaxVars | ||
roundProps : Array An Array of the names of properties that should be rounded to the nearest integer when tweening
| TweenMaxVars | ||
runBackwards : Boolean When true, the tween will flip the start and end values which is exactly what TweenLite.from() does.
| TweenLiteVars | ||
scrollRect : Object Tweens the scrollRect property of any DisplayObject; you can define any of the following properties in the object: left, right, top, bottom, x, y, width, height.
| TweenLiteVars | ||
setSize : Object An object containing a "width" and/or "height" property which will be tweened over time and applied using setSize() on every frame during the course of the tween.
| TweenLiteVars | ||
shortRotation : Object To tween any rotation property (even multiple properties) of the target object in the shortest direction, use shortRotation.
| TweenLiteVars | ||
startAt : TweenLiteVars
Allows you to define the starting values for each property.
| TweenMaxVars | ||
tint : uint To change a DisplayObject's tint, set this to the hex value of the color you'd like the DisplayObject to end up at(or begin at if you're using TweenLite.from()).
| TweenLiteVars | ||
transformAroundCenter : TransformAroundCenterVars
Applies a transformAroundCenter tween (use the TransformAroundCenterVars class to define the values).
| TweenLiteVars | ||
transformAroundPoint : TransformAroundPointVars
Applies a transformAroundPoint tween (use the TransformAroundPointVars class to define the values).
| TweenLiteVars | ||
useFrames : Boolean If useFrames is set to true, the tweens's timing mode will be based on frames.
| TweenLiteVars | ||
visible : Boolean To set a DisplayObject's "visible" property at the end of the tween, use this special property.
| TweenLiteVars | ||
volume : Number Changes the volume of any object that has a soundTransform property (MovieClip, SoundChannel, NetStream, etc.)
| TweenLiteVars | ||
yoyo : Boolean Works in conjunction with the repeat property, determining the behavior of each cycle.
| TweenMaxVars |
Method | Defined by | ||
---|---|---|---|
TweenMaxVars(vars:Object = null)
| TweenMaxVars | ||
addProp(name:String, value:Number, relative:Boolean = false):void
Adds a dynamic property for tweening and allows you to set whether the end value is relative or not
| TweenLiteVars | ||
Clones the TweenMaxVars object.
| TweenMaxVars |
onCompleteListener | property |
public var onCompleteListener:Function
A function to which the TweenMax instance should dispatch a TweenEvent when it completes. This is the same as doing myTweenMaxInstance.addEventListener(TweenEvent.COMPLETE, myFunction);
onRepeat | property |
public var onRepeat:Function
A function that should be called every time the tween repeats
onRepeatParams | property |
public var onRepeatParams:Array
An Array of parameters to pass the onRepeat function
onReverseComplete | property |
public var onReverseComplete:Function
A function that should be called when the tween has reached its starting point again after having been reversed
onReverseCompleteParams | property |
public var onReverseCompleteParams:Array
An Array of parameters to pass the onReverseComplete functions
onStartListener | property |
public var onStartListener:Function
A function to which the TweenMax instance should dispatch a TweenEvent when it begins. This is the same as doing myTweenMaxInstance.addEventListener(TweenEvent.START, myFunction);
onUpdateListener | property |
public var onUpdateListener:Function
A function to which the TweenMax instance should dispatch a TweenEvent every time it updates values. This is the same as doing myTweenMaxInstance.addEventListener(TweenEvent.UPDATE, myFunction);
paused | property |
paused:Boolean
[read-write]If true, the tween will be paused initially.
Implementation public function get paused():Boolean
public function set paused(value:Boolean):void
repeat | property |
repeat:int
[read-write]Number of times that the tween should repeat (to repeat indefinitely, use -1).
Implementation public function get repeat():int
public function set repeat(value:int):void
repeatDelay | property |
public var repeatDelay:Number
Amount of time in seconds (or frames for frames-based tween) between repeats.
reversed | property |
reversed:Boolean
[read-write]If true, the tween will be reversed initially. This does not swap the starting/ending values in the tween - it literally changes its orientation/direction. Imagine the playhead moving backwards instead of forwards.
Implementation public function get reversed():Boolean
public function set reversed(value:Boolean):void
roundProps | property |
public var roundProps:Array
An Array of the names of properties that should be rounded to the nearest integer when tweening
startAt | property |
public var startAt:TweenLiteVars
Allows you to define the starting values for each property. Typically, TweenMax uses the current value (whatever it happens to be at the time the tween begins) as the start value, but startAt allows you to override that behavior. Simply pass a TweenLiteVars or TweenMaxVars in with whatever properties you'd liketo set just before the tween begins.
yoyo | property |
yoyo:Boolean
[read-write]Works in conjunction with the repeat property, determining the behavior of each cycle. When yoyo is true, the tween will go back and forth, appearing to reverse every other cycle (this has no affect on the "reversed" property though).
Implementation public function get yoyo():Boolean
public function set yoyo(value:Boolean):void
TweenMaxVars | () | constructor |
public function TweenMaxVars(vars:Object = null)
Parameters
vars:Object (default = null ) — An Object containing properties that correspond to the properties you'd like to add to this TweenMaxVars Object. For example, TweenMaxVars({blurFilter:{blurX:10, blurY:20}, onComplete:myFunction})
|
clone | () | method |
public override function clone():TweenLiteVars
Clones the TweenMaxVars object.
ReturnsTweenLiteVars |