Packagecom.gskinner.motion
Classpublic class GTweenFilter
InheritanceGTweenFilter Inheritance GTween Inheritance flash.events.EventDispatcher

GTweenFilter ©2008 Grant Skinner, gskinner.com. Visit www.gskinner.com/blog for documentation, updates and more free code. Licensed under the MIT license. See the source file header for more information.
GTweenFilter is an extension to GTween, a light-weight instance oriented tween engine. It allows you to tween the properties of filters on display objects. Using GTweenFilter is almost identical to using GTween. The only major difference is that you can specify a filterIndex (which defaults to 0) to indicate which filter in the target objects .filters array will be affected by the Tween. You can use multiple instances of GTweenFilter with different filterIndexes to tween multiple filters on a single target. GTweenFilter adds ~0.3kb above GTween.


Public Properties
 PropertyDefined by
 InheritedactiveTicker : ITicker
[static] The currently active Ticker object.
GTween
 InheritedautoPlay : Boolean = true
Indicates whether the tween should automatically play when an end value is changed.
GTween
 InheritedautoRotation : Boolean = false
When true, the tween will always rotate in the shortest direction to reach an end rotation value.
GTween
 InheritedautoVisible : Boolean = true
Indicates whether the target's visible property should automatically be set to false when its alpha value is tweened to 0 or less.
GTween
 Inheriteddata : *
Allows you to associate arbitrary data with your tween.
GTween
 InheriteddefaultEase : Function
[static] Specifies the default easing function to use with new tweens.
GTween
 Inheriteddelay : Number
The length of the delay in frames or seconds (depending on the timingMode).
GTween
 Inheritedduration : Number = 1
The length of the tween in frames or seconds (depending on the timingMode).
GTween
 Inheritedease : Function
The easing function to use for calculating the tween.
GTween
  filterIndex : uint = 0
Indicates the index of the filter in the target's .filters array to apply the tween to.
GTweenFilter
 InheritedlockStartProperties : Boolean
If set to true, this prevents the tween from reinitializing its start properties automatically (ex.
GTween
 InheritednextTween : GTween
Specifies another GTween instance that will have paused=false called on it when this tween completes.
GTween
 InheritedpauseAll : Boolean = false
[static] Setting this to true pauses all tween instances.
GTween
 Inheritedpaused : Boolean
Indicates whether the tween is currently paused.
GTween
 Inheritedposition : Number
Gets and sets the position in the tween in frames or seconds (depending on the timingMode).
GTween
  propertyTarget : Object
[read-only]
GTweenFilter
 Inheritedproxy : Object
The proxy object allows you to work with the properties and methods of the target object directly through GTween.
GTween
 Inheritedreflect : Boolean = false
Indicates whether the tween should use the reflect mode when repeating.
GTween
 Inheritedrepeat : int = 0
The number of times this tween will repeat.
GTween
 Inheritedreversed : Boolean
Indicates whether a tween should run in reverse.
GTween
 InheritedrotationProperties : Object
[static] A hash table specifying properties that should be affected by autoRotation.
GTween
 Inheritedsnapping : Boolean = false
If set to true, tweened values specified by snappingProperties will be rounded (snapped) before they are assigned to the target.
GTween
 InheritedsnappingProperties : Object
[static] A hash table specifying properties that should have their value rounded (snapped) before being applied.
GTween
 Inheritedstate : String
Returns the current positional state of the tween.
GTween
 Inheritedtarget : Object
The target object to tween.
GTween
 InheritedtimeInterval : uint
[static] Sets the time in milliseconds between updates when timingMode is set to GTween.TIME ("time").
GTween
 InheritedtimingMode : String
[static] Indicates how GTween should deal with timing.
GTween
 InheritedtweenPosition : Number
Returns the calculated absolute position in the tween.
GTween
Public Methods
 MethodDefined by
  
GTweenFilter(target:Object = null, duration:Number = 10, properties:Object = null, tweenProperties:Object = null)
Constructs a new GTweenFilter instance.
GTweenFilter
 Inherited
beginning():void
Jumps the tween to its beginning.
GTween
 Inherited
deleteProperty(name:String):Boolean
Removes a end value from the tween.
GTween
 Inherited
end():void
Jumps the tween to its end.
GTween
 Inherited
getProperties():Object
Returns the hash table of all end properties and their values.
GTween
 Inherited
getProperty(name:String):Number
Returns the end value for the specified property if one exists.
GTween
 Inherited
getStartProperties():Object
Returns the hash table of all start properties and their values.
GTween
 Inherited
invalidate():void
Invalidate forces the tween to repopulate all of the initial properties from the target object, and start playing if autoplay is set to true.
GTween
 Inherited
linearEase(t:Number, b:Number, c:Number, d:Number):Number
[static] The default easing function used by GTween.
GTween
 Inherited
pause():void
Pauses the tween by stopping tick from being automatically called.
GTween
 Inherited
play():void
Plays a tween by incrementing the position property each frame.
GTween
 Inherited
reverse(suppressEvents:Boolean = true):void
Toggles the reversed property and inverts the current tween position.
GTween
 Inherited
setAssignment(assignmentTarget:Object = null, assignmentProperty:String = null):void
Allows you to tween objects that require re-assignment whenever they are modified by reassigning the target object to a specified property of another object.
GTween
 Inherited
setPosition(position:Number, suppressEvents:Boolean = true):void
Sets the position of the tween.
GTween
 Inherited
setProperties(properties:Object):void
Shorthand method for making multiple setProperty calls quickly.
GTween
 Inherited
setProperty(name:String, value:Number):void
Sets the numeric end value for a property on the target object that you would like to tween.
GTween
 Inherited
setStartProperties(properties:Object):void
Allows you to manually assign the start property values for a tween.
GTween
 Inherited
setTweenProperties(properties:Object):void
Shortcut method for setting multiple properties on the tween instance quickly.
GTween
Events
 EventSummaryDefined by
 Inherited
change
This event is dispatched each time the tween updates properties on its target.GTween
 Inherited
complete
Dispatched when a tween ends (its position equals its duration).GTween
 Inherited
init
Dispatched when a tween copies its initial properties and starts tweening.GTween
Public Constants
 ConstantDefined by
 InheritedDELAY : String = "delay"
[static] Constant for the DELAY state.
GTween
 InheritedEND : String = "end"
[static] Constant for the END state.
GTween
 InheritedFRAME : String = "frame"
[static] Constant for the FRAME timingMode.
GTween
 InheritedHYBRID : String = "hybrid"
[static] Constant for the HYBRID timingMode.
GTween
 InheritedSTART : String = "start"
[static] Constant for the START state.
GTween
 InheritedTIME : String = "time"
[static] Constant for the TIME timingMode.
GTween
 InheritedTWEEN : String = "tween"
[static] Constant for the TWEEN state.
GTween
Property detail
filterIndexproperty
public var filterIndex:uint = 0

Indicates the index of the filter in the target's .filters array to apply the tween to. Defaults to 0, which will tween the first filter in the target's filters array.

propertyTargetproperty 
propertyTarget:Object  [read-only]Implementation
    public function get propertyTarget():Object
Constructor detail
GTweenFilter()constructor
public function GTweenFilter(target:Object = null, duration:Number = 10, properties:Object = null, tweenProperties:Object = null)

Constructs a new GTweenFilter instance. See the GTween documentation for a description of the parameters.

Parameters
target:Object (default = null)
 
duration:Number (default = 10)
 
properties:Object (default = null)
 
tweenProperties:Object (default = null)