PathTweenEx

Extends the PathTween class with dispose, refresh and read-only properties.

Summary
PathTweenExExtends the PathTween class with dispose, refresh and read-only properties.
Internal Members
strokeA ‘weak’ reference to the stroke object defining the advanced value path
Object Manipulation
PathTweenExSee PathTweenEx constructor
cloneMakes a copy of the object.
disposeCleans up resources used by this object.
Tween Data Access
orientToPathRead-only boolean indicating whether the display object is rotated along the path.
tweenPathRead-only access to the path used in the tween.
tweenStrokeRead-only access to the stroke used in the tween.
transitionRead-only string indicating the transition type.
refreshRefresh the path from the stroke.

Internal Members

stroke

private var stroke: Stroke

A ‘weak’ reference to the stroke object defining the advanced value path

Object Manipulation

PathTweenEx

public function PathTweenEx(objToTween: DisplayObject,  
objPath: Path,  
objStroke: Stroke,  
bOrientToPath: Boolean,  
uFirstFrame: uint,  
uLastFrame: uint,  
strTransition: String = DEFAULT_TRANSITION)

See PathTweenEx constructor

clone

public override function clone():ITween

Makes a copy of the object.

Returns

A new tween object that is a clone of this object.

dispose

public function dispose():void

Cleans up resources used by this object.

Tween Data Access

orientToPath

public function get orientToPath():Boolean

Read-only boolean indicating whether the display object is rotated along the path.

Returns

True if oriented along the path, otherwise false

tweenPath

public function get tweenPath():Path

Read-only access to the path used in the tween.

Returns

Tween path

tweenStroke

public function get tweenStroke():Stroke

Read-only access to the stroke used in the tween.

Returns

Tween stroke

transition

public function get transition():String

Read-only string indicating the transition type.

Returns

Transition type string

refresh

public function refresh():void

Refresh the path from the stroke.  Call after the stroke has been changed.

The ‘ITween’ interface defines a common interface for all tween objects.
The ‘PathTween’ class tweens a display object along a path.
Extended tween classes implement this interface to provide access to common properies.
private var stroke: Stroke
A ‘weak’ reference to the stroke object defining the advanced value path
public function PathTweenEx(objToTween: DisplayObject,  
objPath: Path,  
objStroke: Stroke,  
bOrientToPath: Boolean,  
uFirstFrame: uint,  
uLastFrame: uint,  
strTransition: String = DEFAULT_TRANSITION)
See PathTweenEx constructor
public override function clone():ITween
Makes a copy of the object.
public function dispose():void
Cleans up resources used by this object.
public function get orientToPath():Boolean
Read-only boolean indicating whether the display object is rotated along the path.
public function get tweenPath():Path
Read-only access to the path used in the tween.
public function get tweenStroke():Stroke
Read-only access to the stroke used in the tween.
public function get transition():String
Read-only string indicating the transition type.
public function refresh():void
Refresh the path from the stroke.
Close