Action

Action

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

Summary
ActionThe ‘Action’ class represents an action to take place when a specified frame of the timeline that the action belongs to is rendered.
Constants
PROPERTYMeta data for representing the property being animated.
Variables
m_fncForwardThe function to be called when the specified frame of this action is reached while the timeline playhead is moving forward.
m_aParamsForwardHolds an array of parameters to pass to the forward function.
m_fncReverseThe function to be called when the specified frame of this action is reached while the timeline playhead is moving in reverse.
m_aParamsReverseHolds an array of parameters to pass to the reverse function.
m_uFirstFrameThe first frame of the tween.
m_uLastFrameThe last frame of the tween.
m_uPreviousFrameStores the previously rendered frame number.
Functions
ActionConstructor.
cloneCreates a new action object that is a clone of this object.
renderFrameRenders the specified frame.
Properties
firstFrameGets the first frame of the timeline that has a keyframe on it.
lastFrameGets the last frame of the timeline that has a keyframe on it.
targetGets a reference to the target object being tweened.
propertyGets a string of the target property.

Constants

PROPERTY

protected const PROPERTY: String

Meta data for representing the property being animated.

Variables

m_fncForward

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_aParamsForward

protected var m_aParamsForward: Array

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

m_fncReverse

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_aParamsReverse

protected var m_aParamsReverse: Array

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

m_uFirstFrame

protected var m_uFirstFrame: uint

The first frame of the tween.

m_uLastFrame

protected var m_uLastFrame: uint

The last frame of the tween.

m_uPreviousFrame

protected var m_uPreviousFrame: uint

Stores the previously rendered frame number.

Functions

Action

public function Action(fncForward: Function,
aParamsForward: Array,
fncReverse: Function,
aParamsReverse: Array,
uFrame: uint)

Constructor.

Parameters

param fncForward The function that will be called whenever the specified frame is hit while the timeline’s playhead is moving forward.
param aParamsForward An array of parameters to pass to the forward function.
param fncReverse The function that will be called whenever the specified frame is hit while the timeline’s playhead is moving in reverse.
param aParamsReverse An array of parameters to pass to the reverse function.
param uFrame The frame for this action to take place on. 

clone

public function clone():ITween

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

Returns

A new action object. 

renderFrame

public function renderFrame(uFrame: uint):void

Renders the specified frame.

Parameters

param uFrame The frame to render. 

Properties

firstFrame

public function get firstFrame():uint

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

Returns

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

lastFrame

public function get lastFrame():uint

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

Returns

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

target

public function get target():Object

Gets a reference to the target object being tweened.

Returns

A reference to the target object being tweened. 

property

public function get property():String

Gets a string of the target property.

Returns

A string of the target property. 

The ‘ITween’ interface defines a common interface for all tween objects.
protected const PROPERTY: String
Meta data for representing the property being animated.
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.
protected var m_aParamsForward: Array
Holds an array of parameters to pass to the forward function.
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.
protected var m_aParamsReverse: Array
Holds an array of parameters to pass to the reverse function.
protected var m_uFirstFrame: uint
The first frame of the tween.
protected var m_uLastFrame: uint
The last frame of the tween.
protected var m_uPreviousFrame: uint
Stores the previously rendered frame number.
public function Action(fncForward: Function,
aParamsForward: Array,
fncReverse: Function,
aParamsReverse: Array,
uFrame: uint)
Constructor.
public function clone():ITween
Creates a new action object that is a clone of this object.
public function renderFrame(uFrame: uint):void
Renders the specified frame.
public function get firstFrame():uint
Gets the first frame of the timeline that has a keyframe on it.
public function get lastFrame():uint
Gets the last frame of the timeline that has a keyframe on it.
public function get target():Object
Gets a reference to the target object being tweened.
public function get property():String
Gets a string of the target property.
Close