Packagecom.boostworthy.animation.sequence.tweens
Classpublic class Action
ImplementsITween

The 'Action' class represents an action to take place when a specified frame of the timeline that the action belongs to is rendered. Using an action, functions can be called (and passed parameters) seperately for forward and/or reverse playback.

See also

com.boostworthy.animation.sequence.tweens.ITween


Public Properties
 PropertyDefined by
  firstFrame : uint
[read-only] Gets the first frame of the timeline that has a keyframe on it.
Action
  lastFrame : uint
[read-only] Gets the last frame of the timeline that has a keyframe on it.
Action
  property : String
[read-only] Gets a string of the target property.
Action
  target : Object
[read-only] Gets a reference to the target object being tweened.
Action
Protected Properties
 PropertyDefined by
  m_aParamsForward : Array
Holds an array of parameters to pass to the forward function.
Action
  m_aParamsReverse : Array
Holds an array of parameters to pass to the reverse function.
Action
  m_fncForward : Function
The function to be called when the specified frame of this action is reached while the timeline playhead is moving forward.
Action
  m_fncReverse : Function
The function to be called when the specified frame of this action is reached while the timeline playhead is moving in reverse.
Action
  m_uFirstFrame : uint
The first frame of the tween.
Action
  m_uLastFrame : uint
The last frame of the tween.
Action
  m_uPreviousFrame : uint
Stores the previously rendered frame number.
Action
Public Methods
 MethodDefined by
  
Action(fncForward:Function, aParamsForward:Array, fncReverse:Function, aParamsReverse:Array, uFrame:uint)
Constructor.
Action
  
Creates a new action object that is a clone of this object.
Action
  
renderFrame(uFrame:uint):void
Renders the specified frame.
Action
Protected Constants
 ConstantDefined by
  PROPERTY : String = "action"
Meta data for representing the property being animated.
Action
Property detail
firstFrameproperty
firstFrame:uint  [read-only]

Gets the first frame of the timeline that has a keyframe on it.

Implementation
    public function get firstFrame():uint
lastFrameproperty 
lastFrame:uint  [read-only]

Gets the last frame of the timeline that has a keyframe on it.

Implementation
    public function get lastFrame():uint
m_aParamsForwardproperty 
protected var m_aParamsForward:Array

Holds an array of parameters to pass to the forward function.

m_aParamsReverseproperty 
protected var m_aParamsReverse:Array

Holds an array of parameters to pass to the reverse function.

m_fncForwardproperty 
protected var m_fncForward:Function

The function to be called when the specified frame of this action is reached while the timeline playhead is moving forward.

m_fncReverseproperty 
protected var m_fncReverse:Function

The function to be called when the specified frame of this action is reached while the timeline playhead is moving in reverse.

m_uFirstFrameproperty 
protected var m_uFirstFrame:uint

The first frame of the tween.

m_uLastFrameproperty 
protected var m_uLastFrame:uint

The last frame of the tween.

m_uPreviousFrameproperty 
protected var m_uPreviousFrame:uint

Stores the previously rendered frame number.

propertyproperty 
property:String  [read-only]

Gets a string of the target property.

Implementation
    public function get property():String
targetproperty 
target:Object  [read-only]

Gets a reference to the target object being tweened.

Implementation
    public function get target():Object
Constructor detail
Action()constructor
public function Action(fncForward:Function, aParamsForward:Array, fncReverse:Function, aParamsReverse:Array, uFrame:uint)

Constructor.

Parameters
fncForward:Function — The function that will be called whenever the specified frame is hit while the timeline's playhead is moving forward.
 
aParamsForward:Array — An array of parameters to pass to the forward function.
 
fncReverse:Function — The function that will be called whenever the specified frame is hit while the timeline's playhead is moving in reverse.
 
aParamsReverse:Array — An array of parameters to pass to the reverse function.
 
uFrame:uint — The frame for this action to take place on.
Method detail
clone()method
public function clone():ITween

Creates a new action object that is a clone of this object.

Returns
ITween — A new action object.
renderFrame()method 
public function renderFrame(uFrame:uint):void

Renders the specified frame.

Parameters
uFrame:uint — The frame to render.
Constant detail
PROPERTYconstant
protected const PROPERTY:String = "action"

Meta data for representing the property being animated.