Package | com.boostworthy.animation.sequence.tweens |
Class | public class PathTween |
Implements | ITween |
See also
Property | Defined 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 |
Property | Defined 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 |
Method | Defined 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 |
Constant | Defined 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 |
firstFrame | property |
firstFrame:uint
[read-only]Gets the first frame of the timeline that has a keyframe on it.
Implementation public function get firstFrame():uint
lastFrame | property |
lastFrame:uint
[read-only]Gets the last frame of the timeline that has a keyframe on it.
Implementation public function get lastFrame():uint
m_bIsDirty | property |
protected var m_bIsDirty:Boolean
Determines whether or not this tween has changed and needs compared towards it's target value again.
m_bOrientToPath | property |
protected var m_bOrientToPath:Boolean
A value for determining whether or not to orient the object to the paths direction.
m_fncTransition | property |
protected var m_fncTransition:Function
A reference to the transition being used for the tween.
m_nStartRotation | property |
protected var m_nStartRotation:Number
Stores the starting rotational value of the object being tween.
m_objPath | property |
protected var m_objPath:Path
The path the target object is to be animated along.
m_objToTween | property |
protected var m_objToTween:DisplayObject
A reference to the display object to be tweened.
m_strTransition | property |
protected var m_strTransition:String
The name of the transition to be used for the tween.
m_uFirstFrame | property |
protected var m_uFirstFrame:uint
The first frame of the tween.
m_uLastFrame | property |
protected var m_uLastFrame:uint
The last frame of the tween.
property | property |
property:String
[read-only]Gets a string of the target property.
Implementation public function get property():String
target | property |
target:Object
[read-only]Gets a reference to the target object being tweened.
Implementation public function get target():Object
PathTween | () | constructor |
public function PathTween(objToTween:DisplayObject, objPath:Path, bOrientToPath:Boolean, uFirstFrame:uint, uLastFrame:uint, strTransition:String)
Constructor.
ParametersobjToTween: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
clone | () | method |
public function clone():ITween
Creates a new path tween object that is a clone of this object.
ReturnsITween —
A new path tween object.
|
renderFrame | () | method |
public function renderFrame(uFrame:uint):void
Renders the specified frame.
ParametersuFrame:uint — The frame to render.
|
DEFAULT_TRANSITION | constant |
protected const DEFAULT_TRANSITION:String = "linear"
The default transition to use for the tween.
PROPERTY | constant |
protected const PROPERTY:String = "x, y"
Meta data for representing the property being animated.