PathTween |
The ‘PathTween’ class tweens a display object along a path.
com.boostworthy.animation.sequence.tweens.ITween, com.boostworthy.geom.Path
| PathTween | The ‘PathTween’ class tweens a display object along a path. |
| Constants | |
| DEFAULT_TRANSITION | The default transition to use for the tween. |
| PROPERTY | Meta data for representing the property being animated. |
| Variables | |
| m_objToTween | A reference to the display object to be tweened. |
| m_objPath | The path the target object is to be animated along. |
| m_bOrientToPath | A value for determining whether or not to orient the object to the paths direction. |
| m_uFirstFrame | The first frame of the tween. |
| m_uLastFrame | The last frame of the tween. |
| m_strTransition | The name of the transition to be used for the tween. |
| m_fncTransition | A reference to the transition being used for the tween. |
| m_bIsDirty | Determines whether or not this tween has changed and needs compared towards it’s target value again. |
| m_nStartRotation | Stores the starting rotational value of the object being tween. |
| Functions | |
| PathTween | Constructor. |
| clone | Creates a new path tween object that is a clone of this object. |
| renderFrame | Renders the specified frame. |
| Properties | |
| firstFrame | Gets the first frame of the timeline that has a keyframe on it. |
| lastFrame | Gets the last frame of the timeline that has a keyframe on it. |
| target | Gets a reference to the target object being tweened. |
| property | Gets a string of the target property. |
public function PathTween( objToTween: DisplayObject, objPath: Path, bOrientToPath: Boolean, uFirstFrame: uint, uLastFrame: uint, strTransition: String = DEFAULT_TRANSITION )
Constructor.
| param | objToTween The display object to be tweened. |
| param | objPath The path the target object is to be animated along. |
| param | bOrientToPath Determines whether or not to orient the object to the paths direction. |
| param | uFirstFrame The first frame of the tween. |
| param | uLastFrame The last frame of the tween. |
| param | strTransition The name of the transition to be used for the tween. |
com.boostworthy.animation.easing.Transitions, com.boostworthy.geom.Path
The default transition to use for the tween.
protected const DEFAULT_TRANSITION: String
Meta data for representing the property being animated.
protected const PROPERTY: String
A reference to the display object to be tweened.
protected var m_objToTween: DisplayObject
The path the target object is to be animated along.
protected var m_objPath: Path
A value for determining whether or not to orient the object to the paths direction.
protected var m_bOrientToPath: Boolean
The first frame of the tween.
protected var m_uFirstFrame: uint
The last frame of the tween.
protected var m_uLastFrame: uint
The name of the transition to be used for the tween.
protected var m_strTransition: String
A reference to the transition being used for the tween.
protected var m_fncTransition: Function
Determines whether or not this tween has changed and needs compared towards it’s target value again.
protected var m_bIsDirty: Boolean
Stores the starting rotational value of the object being tween.
protected var m_nStartRotation: Number
Constructor.
public function PathTween( objToTween: DisplayObject, objPath: Path, bOrientToPath: Boolean, uFirstFrame: uint, uLastFrame: uint, strTransition: String = DEFAULT_TRANSITION )
Creates a new path tween object that is a clone of this object.
public function clone():ITween
Renders the specified frame.
public function renderFrame( uFrame: uint ):void
Gets the first frame of the timeline that has a keyframe on it.
public function get firstFrame():uint
Gets the last frame of the timeline that has a keyframe on it.
public function get lastFrame():uint
Gets a reference to the target object being tweened.
public function get target():Object
Gets a string of the target property.
public function get property():String