Packagecom.greensock.motionPaths
Classpublic class PathFollower

A PathFollower is used to associate a particular target object (like a MovieClip, Point, Sprite, etc.) with a MotionPath and it offers a tweenable progress property that manages positioning the target on the path accordingly. The progress property is typically a value between 0 and 1 where 0 is at the beginning of the path, 0.5 is in the middle, and 1 is at the end.


Example
Example AS3 code:
import com.greensock.*;
import com.greensock.motionPaths.*;

//create a circle motion path at coordinates x:150, y:150 with a radius of 100
var circle:Circle2D = new Circle2D(150, 150, 100);

//make the MovieClip "mc" follow the circle and start at a position of 90 degrees (this returns a PathFollower instance)
var follower:PathFollower = circle.addFollower(mc, circle.angleToProgress(90));

//tween the follower clockwise along the path to 315 degrees
TweenLite.to(follower, 2, {progress:circle.followerTween(follower, 315, Direction.CLOCKWISE)});

//tween the follower counter-clockwise to 200 degrees and add an extra revolution
TweenLite.to(follower, 2, {progress:circle.followerTween(follower, 200, Direction.COUNTER_CLOCKWISE, 1)});
NOTES
Copyright 2010, GreenSock. All rights reserved. This work is subject to the terms in http://www.greensock.com/terms_of_use.html or for corporate Club GreenSock members, the software agreement that was issued with the corporate membership.


Public Properties
 PropertyDefined by
  path : MotionPath
The MotionPath instance that this PathFollower should follow
PathFollower
  progress : Number
A value (typically between 0 and 1) that can be used to move all followers along the path.
PathFollower
  target : Object
The target object associated with the PathFollower (like a Sprite, MovieClip, Point, etc.).
PathFollower
Public Methods
 MethodDefined by
  
PathFollower(target:Object)
Constructor
PathFollower
Property detail
pathproperty
public var path:MotionPath

The MotionPath instance that this PathFollower should follow

progressproperty 
progress:Number  [read-write]

A value (typically between 0 and 1) that can be used to move all followers along the path. You can tween to values that are greater than 1 or less than 0 but the values are simply wrapped. So, for example, setting progress to 1.2 is the same as setting it to 0.2 and -0.2 is the same as 0.8. If your goal is to tween the PathFollower around a Circle2D twice completely, you could just add 2 to the progress value or use a relative value in the tween, like:

TweenLite.to(myFollower, 5, {progress:"2"}); //or myFollower.progress + 2

Implementation
    public function get progress():Number
    public function set progress(value:Number):void
targetproperty 
public var target:Object

The target object associated with the PathFollower (like a Sprite, MovieClip, Point, etc.). The object must have x and y properties.

Constructor detail
PathFollower()constructor
public function PathFollower(target:Object)

Constructor

Parameters
target:Object — The target object associated with the PathFollower (like a Sprite, MovieClip, Point, etc.). The object must have x and y properties.