Packageorg.as3lib.kitchensync.action.tweentarget
Classpublic class TimelineController
ImplementsITweenTarget

A TweenTarget that controls a timeline animation in a MovieClip.



Public Properties
 PropertyDefined by
  currentValue : Number
The current frame of the movieclip.
TimelineController
  differenceInValues : Number
[read-only] The total amount of change between the start and end values.
TimelineController
  endValue : Number
The number of the frame to end on
TimelineController
  startValue : Number
The number of the frame to begin at
TimelineController
  target : MovieClip
The target movieclip that will be tweened.
TimelineController
Protected Properties
 PropertyDefined by
  _endValue : int
TimelineController
  _startValue : int = 1
TimelineController
  _target : MovieClip
TimelineController
Public Methods
 MethodDefined by
  
TimelineController(target:MovieClip, startFrame:Object = null, endFrame:Object = null)
Constructor.
TimelineController
  
TimelineController
  
reset():void
TimelineController
  
updateTween(percentComplete:Number):Number
TimelineController
Protected Methods
 MethodDefined by
  
evaluateFrameLabel(frameLabel:Object):int
Determines the frame number based on an unknown object.
TimelineController
  
getFrameNumberFromString(matchLabel:String):int
Returns a frame number based on a string label.
TimelineController
Property detail
currentValueproperty
currentValue:Number  [read-write]

The current frame of the movieclip. Setting it causes the MC to gotoAndStop() at that frame.

Implementation
    public function get currentValue():Number
    public function set currentValue(value:Number):void
differenceInValuesproperty 
differenceInValues:Number  [read-only]

The total amount of change between the start and end values. (used internally)

Implementation
    public function get differenceInValues():Number
_endValueproperty 
protected var _endValue:int
endValueproperty 
endValue:Number  [read-write]

The number of the frame to end on

Implementation
    public function get endValue():Number
    public function set endValue(value:Number):void
_startValueproperty 
protected var _startValue:int = 1
startValueproperty 
startValue:Number  [read-write]

The number of the frame to begin at

Implementation
    public function get startValue():Number
    public function set startValue(value:Number):void
_targetproperty 
protected var _target:MovieClip
targetproperty 
target:MovieClip  [read-write]

The target movieclip that will be tweened.

Implementation
    public function get target():MovieClip
    public function set target(value:MovieClip):void
Constructor detail
TimelineController()constructor
public function TimelineController(target:MovieClip, startFrame:Object = null, endFrame:Object = null)

Constructor.

Parameters
target:MovieClip — The MovieClip object to animate.
 
startFrame:Object (default = null) — The frame to begin at. Can be of types String, FrameLabel or a numerical type. Defaults to 1.
 
endFrame:Object (default = null) — The frame to end on. Can be of types String, FrameLabel or a numerical type. Defaults to the last frame in the MovieClip.
Method detail
clone()method
public function clone():ITweenTarget

Returns
ITweenTarget
evaluateFrameLabel()method 
protected function evaluateFrameLabel(frameLabel:Object):int

Determines the frame number based on an unknown object.

Parameters
frameLabel:Object — An unknown object that can be of type int, uint, Number, FrameLabel, or String.

Returns
int — the frame number as an int
getFrameNumberFromString()method 
protected function getFrameNumberFromString(matchLabel:String):int

Returns a frame number based on a string label.

Parameters
matchLabel:String — frame label you're looking for as a string.

Returns
int — int number of the frame or throws an error.
reset()method 
public function reset():void
updateTween()method 
public function updateTween(percentComplete:Number):NumberParameters
percentComplete:Number

Returns
Number