Packagecom.flashdynamix.motion
Classpublic class TweensyGroup

The TweensyGroup Class contains a collection of tweens specified by property tweens for an Object instance. Using the TweensyGroup Class to manage tweens is the recommended implementation of Tweensy.

A tween can be executed in one of the following manners : The TweensyGroup Class has events for: These events allow for predefined params to be applied when they are executed. Tweensy favours this method as it allows for predefining the event and the params it requires without all the fussiness of Event listeners.

See also

com.flashdynamix.motion.TweensyTimeline


Public Properties
 PropertyDefined by
  hasTimelines : Boolean
[read-only] Whether the TweensyGroup Class has any TweensyTimeline animations.
TweensyGroup
  lazyMode : Boolean = true
Defines whether the TweensyGroup Class will automatically resolve property tween conflicts.
Property tween conflicts occur when one property tweens time overlaps another.
TweensyGroup
  onComplete : Function
Executed when all tweens are complete.
TweensyGroup
  onCompleteParams : Array
Parameters applied to the onComplete Function.
TweensyGroup
  onUpdate : Function
Executed on each frame update.
TweensyGroup
  onUpdateParams : Array
Parameters applied to the onUpdate Function.
TweensyGroup
  paused : Boolean
[read-only] Whether the TweensyGroup Class is timeline paused.
TweensyGroup
  refreshType : String = "time"
The timing system currently in use.
This can be either :
  • Tweensy.TIME
  • Tweensy.FRAME
TweensyGroup
  secondsPerFrame : Number
Defines how many seconds per frame are added to to each on an ENTER_FRAME when TweensyGroup Class's refreshType is of the Tweensy.FRAME mode.
This property and feature is intended as an alternative to the Tweensy.TIME (time based animation) mode which can result in jumpy effects.
TweensyGroup
  snapToClosest : Boolean = false
Whether the timelines contained within the TweensyGroup class will snap tweened properties to the closest whole number.
TweensyGroup
  timelines : int
[read-only] Total number of animations in progress for the TweensyGroup class.
TweensyGroup
  useObjectPooling : Boolean = false
Defines whether the TweensyGroup Class will use object pooling for instances of TweensyTimeline.
Object Pooling can result in significant performance increase as it descreases the expenses of constructing TweensyTimeline instances but requires the developer to be careful when creating references to pooled instances.
This is because pooled TweensyTimeline instances may be being reused.
TweensyGroup
  useSmartRotate : Boolean = true
Whether the timelines contained within the TweensyGroup class will use smart rotation or not.
Using smart rotation will ensure that when tweening the 'rotation' property it will turn in the shortest rotation direction.
This fixes what may otherwise appear as a visual glitch even though mathimatically it is correct.
TweensyGroup
Public Methods
 MethodDefined by
  
TweensyGroup(lazyMode:Boolean = true, useObjectPooling:Boolean = false, refreshType:String = "time")
TweensyGroup
  
Adds a TweensyTimeline to the TweensyGroup class.
TweensyGroup
  
alphaTo(instance:Object, alpha:Number, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline
This method provides a handy method to do the common task of an alpha tween for an Object instance.
This is equivalent to : tween.to(instance, {alpha:'value'});
TweensyGroup
  
brightnessTo(instance:Object, amount:Number, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline
This method provides a handy method to do the common task of applying brightness to a DisplayObject instance via a ColorTransform.
This is equivalent to : var ct : ColorTransform = new ColorTransform('value', 'value', 'value', 1, 'value' 255, 'value' 255, 'value' 255);
tween.to(instance.transform.colorTransform, ct, 0.5, null, 0, instance);


Brightness can also be applied by using a ColorMarixFilter.
TweensyGroup
  
colorTo(instance:Object, color:uint, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline
This method provides a handy method to do the common task of color transitions for a DisplayObject instance.
This is equivalent to : var ct : ColorTransform = new ColorTransform();
ct.color = 'value';
tween.to(instance.transform.colorTransform, ct, 0.5, null, 0, instance);
TweensyGroup
  
colorTransformTo(instance:Object, color:ColorTransform, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline
This method provides a handy method to do the common task of color transform for a DisplayObject instance.
This is equivalent to : tween.to(instance.transform.colorTransform, new ColorTransform(), 0.5, null, 0, instance);
TweensyGroup
  
contrastTo(instance:Object, amount:Number, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline
This method provides a handy method to do the common task of applying contrast to a DisplayObject instance via a ColorTransform.
This is equivalent to : var ct : ColorTransform = new ColorTransform(1, 1, 1, 1, 'value' 255, 'value' 255, 'value' 255);
tween.to(instance.transform.colorTransform, ct, 0.5, null, 0, instance);


Contrast can also be applied by using a ColorMarixFilter.
TweensyGroup
  
dispose():void
Disposes the TweensyGroup Class instance ready for garbage collection
TweensyGroup
  
filterTo(instance:Object, filter:BitmapFilter, to:Object, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline
This method provides a handy method to do the common task of a tweening BitmapFilter properties and applying them to a DisplayObject instance.
This is equivalent to : tween.to(new DropShadowFilter(), {alpha:1}, 0.5, null, 0, instance);
TweensyGroup
  
from(instance:Object, from:Object, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0, update:Object = null, onComplete:Function = null, onCompleteParams:Array = null):TweensyTimeline
Adds a from based tween using the properties defined in the from Object.
TweensyGroup
  
fromTo(instance:Object, from:Object, to:Object, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0, update:Object = null, onComplete:Function = null, onCompleteParams:Array = null):TweensyTimeline
Adds a from to based tween using the properties defined in the from and to Objects.
TweensyGroup
  
functionTo(instance:Object, to:Object, onUpdate:Function, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline
This method provides a handy method to do the common task of tweening an Object instance and then needing to apply this to an update Function call.
This is equivalent to : var timeline:TweensyTimeline = tween.to(point, {x:50, y:50});
timeline.onUpdate = item.setPoint;
timeline.onUpdateParams = [point];


If requiring not to just set the instance to the Function but rather properties within the instance which are tweening this can be done via the following code example :
var onUpdate:Function = function(current:Object):void{
pane.setSize(current.width, current.height);
}
tween.functionTo({width:pane.width, height:pane.height}, {width:200, height:200}, onUpdate);
TweensyGroup
  
gc():void
[static] Prepares the TweensyGroup class for garbage collection by disposing its Object Pools and making it no longer usable in the Flash application.
TweensyGroup
  
matrixTo(instance:Object, mtx:Matrix, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline
This method provides a handy method to do the common task of a matrix transform for a DisplayObject instance.
This is equivalent to : tween.to(instance.transform.matrix, new Matrix(), 0.5, null, 0, instance);
TweensyGroup
  
pause():void
Pauses all tweens in the TweensyGroup Class.
TweensyGroup
  
Removes a TweensyTimeline from the TweensyGroup class.
TweensyGroup
  
resume():void
Resumes all paused tweens in the TweensyGroup Class.
TweensyGroup
  
rotateTo(instance:Object, rotation:Number, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline
This method provides a handy method to do the common task of rotation for an Object instance.
This is equivalent to : tween.to(instance, {rotation:'value'});
TweensyGroup
  
scaleTo(instance:Object, scale:Number, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline
This method provides a handy method to do the common task of an scaling by x and y for an Object instance.
This is equivalent to tween.to(instance, {scaleX:'value', scaleY:'value'});
TweensyGroup
  
slideTo(instance:Object, x:Number, y:Number, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline
This method provides a handy method to do the common task of an moving by x and y for an Object instance.
This is equivalent to : tween.to(instance, {x:'value', y:'value'});
TweensyGroup
  
soundTransformTo(instance:Object, trans:SoundTransform, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline
This method provides a handy method to do the common task of a sound transforms for a Sprite or SoundChannel instance.
This is equivalent to : tween.to(instance.soundTransform, new SoundTransform(), 0.5, null, 0, instance);
TweensyGroup
  
stop(instance:* = null, ... props):void
Allows for removing tweens via an instance or tween props by the following methods :
  • tween.stop(instance); - stops all property tweens for this instance.
  • tween.stop(instance, "x", "y"); - stops all x,y property tweens for this instance.
  • tween.stop([instance1, instance2]); - stops all property tweens for these instances.
  • tween.stop([instance1, instance2], "x", "y"); - stops all x,y property tweens for these instances.
  • tween.stop(null, "x", "y"); - stops all x,y property tweens.
  • tween.stop(); - stops all tweens though it is recommended to use the stopAll method as this is more efficient.
TweensyGroup
  
stopAll():void
Removes all tweens from the TweensyGroup Class.
TweensyGroup
  
to(instance:Object, to:Object, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0, update:Object = null, onComplete:Function = null, onCompleteParams:Array = null):TweensyTimeline
Adds a to based tween using the properties defined in the target Object.
TweensyGroup
  
toString():String
TweensyGroup
  
updateTo(instance:Object, to:Object):void
Updates a tween for the instance Object to the new target positions defined in the to Object.
TweensyGroup
Property detail
hasTimelinesproperty
hasTimelines:Boolean  [read-only]

Whether the TweensyGroup Class has any TweensyTimeline animations.

Implementation
    public function get hasTimelines():Boolean
lazyModeproperty 
public var lazyMode:Boolean = true

Defines whether the TweensyGroup Class will automatically resolve property tween conflicts.
Property tween conflicts occur when one property tweens time overlaps another.

onCompleteproperty 
public var onComplete:Function

Executed when all tweens are complete.

See also

onCompleteParamsproperty 
public var onCompleteParams:Array

Parameters applied to the onComplete Function.

See also

onUpdateproperty 
public var onUpdate:Function

Executed on each frame update.

See also

onUpdateParamsproperty 
public var onUpdateParams:Array

Parameters applied to the onUpdate Function.

See also

pausedproperty 
paused:Boolean  [read-only]

Whether the TweensyGroup Class is timeline paused.

Implementation
    public function get paused():Boolean
refreshTypeproperty 
public var refreshType:String = "time"

The timing system currently in use.
This can be either :

See also

secondsPerFrameproperty 
public var secondsPerFrame:Number

Defines how many seconds per frame are added to to each on an ENTER_FRAME when TweensyGroup Class's refreshType is of the Tweensy.FRAME mode.
This property and feature is intended as an alternative to the Tweensy.TIME (time based animation) mode which can result in jumpy effects. This is because by using Tweensy.Time rfreshType it ensures that your animation will accurately finish in the time you specify. Instead Tweensy.FRAME ensures that every frame is rendered for the duration of your animation. e.g. If your FLA frame rate is 30 frames per second then set secondsPerFrame to 1 second for every 30 frames (1/30).

See also

snapToClosestproperty 
public var snapToClosest:Boolean = false

Whether the timelines contained within the TweensyGroup class will snap tweened properties to the closest whole number.

timelinesproperty 
timelines:int  [read-only]

Total number of animations in progress for the TweensyGroup class.

Implementation
    public function get timelines():int
useObjectPoolingproperty 
public var useObjectPooling:Boolean = false

Defines whether the TweensyGroup Class will use object pooling for instances of TweensyTimeline.
Object Pooling can result in significant performance increase as it descreases the expenses of constructing TweensyTimeline instances but requires the developer to be careful when creating references to pooled instances.
This is because pooled TweensyTimeline instances may be being reused.

useSmartRotateproperty 
public var useSmartRotate:Boolean = true

Whether the timelines contained within the TweensyGroup class will use smart rotation or not.
Using smart rotation will ensure that when tweening the 'rotation' property it will turn in the shortest rotation direction.
This fixes what may otherwise appear as a visual glitch even though mathimatically it is correct.

Constructor detail
TweensyGroup()constructor
public function TweensyGroup(lazyMode:Boolean = true, useObjectPooling:Boolean = false, refreshType:String = "time")

Parameters
lazyMode:Boolean (default = true) — Whether the tween manager will automatically remove confilcting tweens. This is not the most efficient method for using Tweensy. If lazy mode is turned off (false) then it's the responsibility of the developer to ensure that conflicting tweens don't occur by using the stop method on the instance.
 
useObjectPooling:Boolean (default = false) — Defines whether the TweensyGroup Class will use object pooling for instances of TweensyTimeline.
 
refreshType:String (default = "time") — Can be either "time" or "frame" by default it's Tweensy.TIME. Tweensy.TIME will ensure that your animations finish in the time you specify. Tweensy.FRAME allows you to set the seconds to update per frame by default it's set to 30 FPS which equals in SPF = 0.033333333 or 1/30.

See also

Method detail
add()method
public function add(item:TweensyTimeline):TweensyTimeline

Adds a TweensyTimeline to the TweensyGroup class. This can be useful if you want to prepare an animation and the tweens contained within it but not necessarily have it to Tweening straight away.

Parameters
item:TweensyTimeline

Returns
TweensyTimeline — An instance to the TweensyTimeline.
alphaTo()method 
public function alphaTo(instance:Object, alpha:Number, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline

This method provides a handy method to do the common task of an alpha tween for an Object instance.
This is equivalent to : tween.to(instance, {alpha:'value'});

Parameters
instance:Object
 
alpha:Number
 
duration:Number (default = 0.5)
 
ease:Function (default = null)
 
delayStart:Number (default = 0)

Returns
TweensyTimeline — An instance to the TweensyTimeline.
brightnessTo()method 
public function brightnessTo(instance:Object, amount:Number, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline

This method provides a handy method to do the common task of applying brightness to a DisplayObject instance via a ColorTransform.
This is equivalent to : var ct : ColorTransform = new ColorTransform('value', 'value', 'value', 1, 'value' 255, 'value' 255, 'value' 255);
tween.to(instance.transform.colorTransform, ct, 0.5, null, 0, instance);


Brightness can also be applied by using a ColorMarixFilter.

Parameters
instance:Object — Defines the amount of brightness to apply. The amount can be a value from -1 to 1. An amount of 1 is white, -1 is black and 0 is normal brightness.
 
amount:Number
 
duration:Number (default = 0.5)
 
ease:Function (default = null)
 
delayStart:Number (default = 0)

Returns
TweensyTimeline — An instance to the TweensyTimeline.

See also

com.flashdynamix.motion.extras.ColorMatrixFilter
colorTo()method 
public function colorTo(instance:Object, color:uint, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline

This method provides a handy method to do the common task of color transitions for a DisplayObject instance.
This is equivalent to : var ct : ColorTransform = new ColorTransform();
ct.color = 'value';
tween.to(instance.transform.colorTransform, ct, 0.5, null, 0, instance);

Parameters
instance:Object — The hexadecimal color you would like to be tweened to for the instance.
 
color:uint
 
duration:Number (default = 0.5)
 
ease:Function (default = null)
 
delayStart:Number (default = 0)

Returns
TweensyTimeline — An instance to the TweensyTimeline.
colorTransformTo()method 
public function colorTransformTo(instance:Object, color:ColorTransform, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline

This method provides a handy method to do the common task of color transform for a DisplayObject instance.
This is equivalent to : tween.to(instance.transform.colorTransform, new ColorTransform(), 0.5, null, 0, instance);

Parameters
instance:Object
 
color:ColorTransform
 
duration:Number (default = 0.5)
 
ease:Function (default = null)
 
delayStart:Number (default = 0)

Returns
TweensyTimeline — An instance to the TweensyTimeline.
contrastTo()method 
public function contrastTo(instance:Object, amount:Number, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline

This method provides a handy method to do the common task of applying contrast to a DisplayObject instance via a ColorTransform.
This is equivalent to : var ct : ColorTransform = new ColorTransform(1, 1, 1, 1, 'value' 255, 'value' 255, 'value' 255);
tween.to(instance.transform.colorTransform, ct, 0.5, null, 0, instance);


Contrast can also be applied by using a ColorMarixFilter.

Parameters
instance:Object — Defines the amount of contrast to apply. The amount can be a value from -1 to 1. An amount of 1 is full bright contrast, -1 is full dark contrast and 0 is normal contrast.
 
amount:Number
 
duration:Number (default = 0.5)
 
ease:Function (default = null)
 
delayStart:Number (default = 0)

Returns
TweensyTimeline — An instance to the TweensyTimeline.

See also

com.flashdynamix.motion.extras.ColorMatrixFilter
dispose()method 
public function dispose():void

Disposes the TweensyGroup Class instance ready for garbage collection

filterTo()method 
public function filterTo(instance:Object, filter:BitmapFilter, to:Object, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline

This method provides a handy method to do the common task of a tweening BitmapFilter properties and applying them to a DisplayObject instance.
This is equivalent to : tween.to(new DropShadowFilter(), {alpha:1}, 0.5, null, 0, instance);

Parameters
instance:Object
 
filter:BitmapFilter
 
to:Object
 
duration:Number (default = 0.5)
 
ease:Function (default = null)
 
delayStart:Number (default = 0)

Returns
TweensyTimeline — An instance to the TweensyTimeline.
from()method 
public function from(instance:Object, from:Object, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0, update:Object = null, onComplete:Function = null, onCompleteParams:Array = null):TweensyTimeline

Adds a from based tween using the properties defined in the from Object.

Parameters
instance:Object — The instance Object to be tweened or multiple instances if using the type Array e.g. [item1, item2]
 
from:Object — An Object containing the properties you would like to tween from e.g. {x:50, y:25} or this can be relative e.g. {x:'50', y:'-25'} or can be a random position e.g. {x:'-50, 50', y:'-25, 25'}
 
duration:Number (default = 0.5) — The time in secs you would like the tween to run.
 
ease:Function (default = null) — The ease equation you would like to use, by default this is Quintic.easeOut or the ease equation defined in TweensyTimeline.defaultTween.
 
delayStart:Number (default = 0) — The delay you would like to use at the beginning of the tween and every subsequent REPLAY of a tween.
 
update:Object (default = null) — This param is used when tweening a property in a Object which needs to be applied onto another Object each time the tween occurs.This occurs with tweening ColorTransforms, Matrices, SoundTransforms, BitmapFilters.
For example tween.from(new DropShadowFilter(), {alpha:0}, 0.5, null, 0, myDisplayItem);
Will apply the tweening DropShadowFilter onto the DisplayObject 'myDisplayItem'.
 
onComplete:Function (default = null) — The onComplete event handler you would like to fire once the tween is complete.
 
onCompleteParams:Array (default = null) — The params applied to the onComplete handler.

Returns
TweensyTimeline — An instance of the TweensyTimeline which can used to manage this tween.

See also

fromTo()method 
public function fromTo(instance:Object, from:Object, to:Object, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0, update:Object = null, onComplete:Function = null, onCompleteParams:Array = null):TweensyTimeline

Adds a from to based tween using the properties defined in the from and to Objects.

Parameters
instance:Object — The instance Object to be tweened or multiple instances if using the type Array e.g. [item1, item2]
 
from:Object — An Object containing the properties you would like to tween from e.g. {x:50, y:25} or this can be relative e.g. {x:'50', y:'-25'} or can be a random position e.g. {x:'-50, 50', y:'-25, 25'}
 
to:Object — An Object containing the properties you would like to tween to e.g. {x:50, y:25} or this can be relative e.g. {x:'50', y:'-25'} or can be a random position e.g. {x:'-50, 50', y:'-25, 25'}
 
duration:Number (default = 0.5) — The time in secs you would like the tween to run.
 
ease:Function (default = null) — The ease equation you would like to use, by default this is Quintic.easeOut or the ease equation defined in TweensyTimeline.defaultTween.
 
delayStart:Number (default = 0) — The delay you would like to use at the beginning of the tween and every subsequent REPLAY of a tween.
 
update:Object (default = null) — This param is used when tweening a property in a Object which needs to be applied onto another Object each time the tween occurs.This occurs with tweening ColorTransforms, Matrices, SoundTransforms, BitmapFilters.
For example tween.fromTo(new DropShadowFilter(), {alpha:1}, {alpha:0}, 0.5, null, 0, myDisplayItem);
Will apply the tweening DropShadowFilter onto the DisplayObject 'myDisplayItem'.
 
onComplete:Function (default = null) — The onComplete event handler you would like to fire once the tween is complete.
 
onCompleteParams:Array (default = null) — The params applied to the onComplete handler.

Returns
TweensyTimeline — An instance of the TweensyTimeline which can used to manage this tween.

See also

functionTo()method 
public function functionTo(instance:Object, to:Object, onUpdate:Function, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline

This method provides a handy method to do the common task of tweening an Object instance and then needing to apply this to an update Function call.
This is equivalent to : var timeline:TweensyTimeline = tween.to(point, {x:50, y:50});
timeline.onUpdate = item.setPoint;
timeline.onUpdateParams = [point];


If requiring not to just set the instance to the Function but rather properties within the instance which are tweening this can be done via the following code example :
var onUpdate:Function = function(current:Object):void{
pane.setSize(current.width, current.height);
}
tween.functionTo({width:pane.width, height:pane.height}, {width:200, height:200}, onUpdate);

Parameters
instance:Object
 
to:Object
 
onUpdate:Function
 
duration:Number (default = 0.5)
 
ease:Function (default = null)
 
delayStart:Number (default = 0)

Returns
TweensyTimeline — An instance to the TweensyTimeline.
gc()method 
public static function gc():void

Prepares the TweensyGroup class for garbage collection by disposing its Object Pools and making it no longer usable in the Flash application.

matrixTo()method 
public function matrixTo(instance:Object, mtx:Matrix, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline

This method provides a handy method to do the common task of a matrix transform for a DisplayObject instance.
This is equivalent to : tween.to(instance.transform.matrix, new Matrix(), 0.5, null, 0, instance);

Parameters
instance:Object
 
mtx:Matrix
 
duration:Number (default = 0.5)
 
ease:Function (default = null)
 
delayStart:Number (default = 0)

Returns
TweensyTimeline — An instance to the TweensyTimeline.
pause()method 
public function pause():void

Pauses all tweens in the TweensyGroup Class.

remove()method 
public function remove(item:TweensyTimeline):void

Removes a TweensyTimeline from the TweensyGroup class. This will stop this timeline from being updated but can be re-added to the TweensyGroup class resuming that animation.

Parameters
item:TweensyTimeline
resume()method 
public function resume():void

Resumes all paused tweens in the TweensyGroup Class.

rotateTo()method 
public function rotateTo(instance:Object, rotation:Number, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline

This method provides a handy method to do the common task of rotation for an Object instance.
This is equivalent to : tween.to(instance, {rotation:'value'});

Parameters
instance:Object
 
rotation:Number
 
duration:Number (default = 0.5)
 
ease:Function (default = null)
 
delayStart:Number (default = 0)

Returns
TweensyTimeline — An instance to the TweensyTimeline.

See also

scaleTo()method 
public function scaleTo(instance:Object, scale:Number, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline

This method provides a handy method to do the common task of an scaling by x and y for an Object instance.
This is equivalent to tween.to(instance, {scaleX:'value', scaleY:'value'});

Parameters
instance:Object
 
scale:Number
 
duration:Number (default = 0.5)
 
ease:Function (default = null)
 
delayStart:Number (default = 0)

Returns
TweensyTimeline — An instance to the TweensyTimeline.
slideTo()method 
public function slideTo(instance:Object, x:Number, y:Number, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline

This method provides a handy method to do the common task of an moving by x and y for an Object instance.
This is equivalent to : tween.to(instance, {x:'value', y:'value'});

Parameters
instance:Object
 
x:Number
 
y:Number
 
duration:Number (default = 0.5)
 
ease:Function (default = null)
 
delayStart:Number (default = 0)

Returns
TweensyTimeline — An instance to the TweensyTimeline.
soundTransformTo()method 
public function soundTransformTo(instance:Object, trans:SoundTransform, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0):TweensyTimeline

This method provides a handy method to do the common task of a sound transforms for a Sprite or SoundChannel instance.
This is equivalent to : tween.to(instance.soundTransform, new SoundTransform(), 0.5, null, 0, instance);

Parameters
instance:Object
 
trans:SoundTransform
 
duration:Number (default = 0.5)
 
ease:Function (default = null)
 
delayStart:Number (default = 0)

Returns
TweensyTimeline — An instance to the TweensyTimeline.
stop()method 
public function stop(instance:* = null, ... props):void

Allows for removing tweens via an instance or tween props by the following methods :

Parameters
instance:* (default = null)
 
... props
stopAll()method 
public function stopAll():void

Removes all tweens from the TweensyGroup Class.

to()method 
public function to(instance:Object, to:Object, duration:Number = 0.5, ease:Function = null, delayStart:Number = 0, update:Object = null, onComplete:Function = null, onCompleteParams:Array = null):TweensyTimeline

Adds a to based tween using the properties defined in the target Object.

Parameters
instance:Object — The instance Object to be tweened or multiple instances if using the type Array e.g. [item1, item2]
 
to:Object — An Object containing the properties you would like to tween to e.g. {x:50, y:25} or this can be relative e.g. {x:'50', y:'-25'} or can be a random position e.g. {x:'-50, 50', y:'-25, 25'}
 
duration:Number (default = 0.5) — The time in secs you would like the tween to run.
 
ease:Function (default = null) — The ease equation you would like to use, by default this is Quintic.easeOut or the ease equation defined in TweensyTimeline.defaultTween.
 
delayStart:Number (default = 0) — The delay you would like to use at the beginning of the tween and every subsequent REPLAY of a tween.
 
update:Object (default = null) — This param is used when tweening a property in a Object which needs to be applied onto another Object each time the tween occurs. This occurs with tweening ColorTransforms, Matrices, SoundTransforms, BitmapFilters.
For example tween.to(new DropShadowFilter(), {alpha:0}, 0.5, null, 0, myDisplayItem);
Will apply the tweening DropShadowFilter onto the DisplayObject 'myDisplayItem'.
 
onComplete:Function (default = null) — The onComplete event handler you would like to fire once the tween is complete.
 
onCompleteParams:Array (default = null) — The params applied to the onComplete handler.

Returns
TweensyTimeline — An instance to the TweensyTimeline which can used to manage this tween.

See also

toString()method 
public function toString():String

Returns
String
updateTo()method 
public function updateTo(instance:Object, to:Object):void

Updates a tween for the instance Object to the new target positions defined in the to Object.

Parameters
instance:Object
 
to:Object