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

The 'AdvancedTween' class tweens the property of an object using a path as a graph. The 'x' axis of the path represents the frames and the 'y' axis represents the value of the property.

See also

com.boostworthy.animation.sequence.tweens.ITween
com.boostworthy.geom.Path


Public Properties
 PropertyDefined by
  firstFrame : uint
[read-only] Gets the first frame of the timeline that has a keyframe on it.
AdvancedTween
  lastFrame : uint
[read-only] Gets the last frame of the timeline that has a keyframe on it.
AdvancedTween
  property : String
[read-only] Gets a string of the target property.
AdvancedTween
  target : Object
[read-only] Gets a reference to the target object being tweened.
AdvancedTween
Protected Properties
 PropertyDefined by
  m_bIsDirty : Boolean
Determines whether or not this tween has changed and needs compared towards it's target value again.
AdvancedTween
  m_fncTransition : Function
A reference to the transition being used for the tween.
AdvancedTween
  m_objPath : Path
Holds a path object whose 'x' axis represents the frame number and 'y' axis represents the property value.
AdvancedTween
  m_objToTween : Object
A reference to the object to be tweened.
AdvancedTween
  m_strProperty : String
The object's property that is getting tweened.
AdvancedTween
  m_strTransition : String
The name of the transition to be used for the tween.
AdvancedTween
  m_uFirstFrame : uint
The first frame of the tween.
AdvancedTween
  m_uLastFrame : uint
The last frame of the tween.
AdvancedTween
Public Methods
 MethodDefined by
  
AdvancedTween(objToTween:Object, strProperty:String, objPath:Path, strTransition:String)
Constructor.
AdvancedTween
  
Creates a new advanced tween object that is a clone of this object.
AdvancedTween
  
renderFrame(uFrame:uint):void
Renders the specified frame.
AdvancedTween
Protected Constants
 ConstantDefined by
  DEFAULT_TRANSITION : String = "linear"
The default transition to use for the tween.
AdvancedTween
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_bIsDirtyproperty 
protected var m_bIsDirty:Boolean

Determines whether or not this tween has changed and needs compared towards it's target value again.

m_fncTransitionproperty 
protected var m_fncTransition:Function

A reference to the transition being used for the tween.

m_objPathproperty 
protected var m_objPath:Path

Holds a path object whose 'x' axis represents the frame number and 'y' axis represents the property value.

m_objToTweenproperty 
protected var m_objToTween:Object

A reference to the object to be tweened.

m_strPropertyproperty 
protected var m_strProperty:String

The object's property that is getting tweened.

m_strTransitionproperty 
protected var m_strTransition:String

The name of the transition to be used for the tween.

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.

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
AdvancedTween()constructor
public function AdvancedTween(objToTween:Object, strProperty:String, objPath:Path, strTransition:String)

Constructor.

Parameters
objToTween:Object — The object to be tweened.
 
strProperty:String — The object's property that is getting tweened.
 
objPath:Path — The path object to use as data for this tween. The 'x' axis of the path represents the frame number and the 'y' axis represents the property value.
 
strTransition:String — The name of the transition to be used for the tween.

See also

Method detail
clone()method
public function clone():ITween

Creates a new advanced tween object that is a clone of this object.

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

Renders the specified frame.

Parameters
uFrame:uint — The frame to render.
Constant detail
DEFAULT_TRANSITIONconstant
protected const DEFAULT_TRANSITION:String = "linear"

The default transition to use for the tween.