Packagenet.flashpunk.tweens.motion
Classpublic class LinearPath
InheritanceLinearPath Inheritance Motion Inheritance Tween Inheritance Object

Determines linear motion along a set of points.


Public Properties
 PropertyDefined By
 Inheritedactive : Boolean
If the tween should update.
Tween
 Inheritedcomplete : Function
Tween completion callback.
Tween
 Inheriteddelay : Number = 0
Length of time to wait before starting this tween.
Tween
  distance : Number
[read-only] The full length of the path.
LinearPath
 Inheritedobject : Object
Target object for the tween.
Motion
 Inheritedpercent : Number
The completion percentage of the Tween.
Tween
  pointCount : Number
[read-only] How many points are on the path.
LinearPath
 Inheritedscale : Number
[read-only] The current time scale of the Tween (after easer has been applied).
Tween
 Inheritedx : Number
Current x position of the Tween.
Motion
 Inheritedy : Number
Current y position of the Tween.
Motion
Protected Properties
 PropertyDefined By
 Inherited_object : Object
Motion
 Inherited_x : Number = 0
Motion
 Inherited_y : Number = 0
Motion
Public Methods
 MethodDefined By
  
LinearPath(complete:Function = null, type:uint = 0)
Constructor.
LinearPath
  
addPoint(x:Number = 0, y:Number = 0):void
Adds the point to the path.
LinearPath
 Inherited
cancel():void
Immediately stops the Tween and removes it from its Tweener without calling the complete callback.
Tween
  
getPoint(index:uint = 0):Point
Gets a point on the path.
LinearPath
  
setMotion(duration:Number, ease:Function = null):void
Starts moving along the path.
LinearPath
  
setMotionSpeed(speed:Number, ease:Function = null):void
Starts moving along the path at the speed.
LinearPath
 Inherited
start():void
Starts the Tween, or restarts it if it's currently running.
Tween
 Inherited
update():void
Updates the Tween, called by World.
Tween
Public Constants
 ConstantDefined By
 InheritedLOOPING : uint = 1
[static] Looping Tween type, will restart immediately when it finishes.
Tween
 InheritedONESHOT : uint = 2
[static] Oneshot Tween type, will stop and remove itself from its core container when it finishes.
Tween
 InheritedPERSIST : uint = 0
[static] Persistent Tween type, will stop when it finishes.
Tween
Property Detail
distanceproperty
distance:Number  [read-only]

The full length of the path.


Implementation
    public function get distance():Number
pointCountproperty 
pointCount:Number  [read-only]

How many points are on the path.


Implementation
    public function get pointCount():Number
Constructor Detail
LinearPath()Constructor
public function LinearPath(complete:Function = null, type:uint = 0)

Constructor.

Parameters
complete:Function (default = null) — Optional completion callback.
 
type:uint (default = 0) — Tween type.
Method Detail
addPoint()method
public function addPoint(x:Number = 0, y:Number = 0):void

Adds the point to the path.

Parameters

x:Number (default = 0) — X position.
 
y:Number (default = 0) — Y position.

getPoint()method 
public function getPoint(index:uint = 0):Point

Gets a point on the path.

Parameters

index:uint (default = 0) — Index of the point.

Returns
Point — The Point object.
setMotion()method 
public function setMotion(duration:Number, ease:Function = null):void

Starts moving along the path.

Parameters

duration:Number — Duration of the movement.
 
ease:Function (default = null) — Optional easer function.

setMotionSpeed()method 
public function setMotionSpeed(speed:Number, ease:Function = null):void

Starts moving along the path at the speed.

Parameters

speed:Number — Speed of the movement.
 
ease:Function (default = null) — Optional easer function.





Mon Feb 3 2014, 03:22 PM -06:00