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

The 'PathTween' class tweens a display object along a path.

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.
PathTween
  lastFrame : uint
[read-only] Gets the last frame of the timeline that has a keyframe on it.
PathTween
  property : String
[read-only] Gets a string of the target property.
PathTween
  target : Object
[read-only] Gets a reference to the target object being tweened.
PathTween
Protected Properties
 PropertyDefined by
  m_bIsDirty : Boolean
Determines whether or not this tween has changed and needs compared towards it's target value again.
PathTween
  m_bOrientToPath : Boolean
A value for determining whether or not to orient the object to the paths direction.
PathTween
  m_fncTransition : Function
A reference to the transition being used for the tween.
PathTween
  m_nStartRotation : Number
Stores the starting rotational value of the object being tween.
PathTween
  m_objPath : Path
The path the target object is to be animated along.
PathTween
  m_objToTween : DisplayObject
A reference to the display object to be tweened.
PathTween
  m_strTransition : String
The name of the transition to be used for the tween.
PathTween
  m_uFirstFrame : uint
The first frame of the tween.
PathTween
  m_uLastFrame : uint
The last frame of the tween.
PathTween
Public Methods
 MethodDefined by
  
PathTween(objToTween:DisplayObject, objPath:Path, bOrientToPath:Boolean, uFirstFrame:uint, uLastFrame:uint, strTransition:String)
Constructor.
PathTween
  
Creates a new path tween object that is a clone of this object.
PathTween
  
renderFrame(uFrame:uint):void
Renders the specified frame.
PathTween
Protected Constants
 ConstantDefined by
  DEFAULT_TRANSITION : String = "linear"
The default transition to use for the tween.
PathTween
  PROPERTY : String = "x, y"
Meta data for representing the property being animated.
PathTween
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_bOrientToPathproperty 
protected var m_bOrientToPath:Boolean

A value for determining whether or not to orient the object to the paths direction.

m_fncTransitionproperty 
protected var m_fncTransition:Function

A reference to the transition being used for the tween.

m_nStartRotationproperty 
protected var m_nStartRotation:Number

Stores the starting rotational value of the object being tween.

m_objPathproperty 
protected var m_objPath:Path

The path the target object is to be animated along.

m_objToTweenproperty 
protected var m_objToTween:DisplayObject

A reference to the display object to be 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
PathTween()constructor
public function PathTween(objToTween:DisplayObject, objPath:Path, bOrientToPath:Boolean, uFirstFrame:uint, uLastFrame:uint, strTransition:String)

Constructor.

Parameters
objToTween:DisplayObject — The display object to be tweened.
 
objPath:Path — The path the target object is to be animated along.
 
bOrientToPath:Boolean — Determines whether or not to orient the object to the paths direction.
 
uFirstFrame:uint — The first frame of the tween.
 
uLastFrame:uint — The last frame of the tween.
 
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 path tween object that is a clone of this object.

Returns
ITween — A new path 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.

PROPERTYconstant 
protected const PROPERTY:String = "x, y"

Meta data for representing the property being animated.