API Documentation for: 0.4.1
Show:

MotionGuidePlugin Class

Defined in: MotionGuidePlugin:33
Module: TweenJS

A TweenJS plugin for working with motion guides.

To use, install the plugin after TweenJS has loaded. Next tween the 'guide' property with an object as detailed below.

  createjs.MotionGuidePlugin.install();

Example

 // Using a Motion Guide
    createjs.Tween.get(target).to({guide:{ path:[0,0, 0,200,200,200, 200,0,0,0] }},7000);
    // Visualizing the line
    graphics.moveTo(0,0).curveTo(0,200,200,200).curveTo(200,0,0,0);

Each path needs pre-computation to ensure there's fast performance. Because of the pre-computation there's no built in support for path changes mid tween. These are the Guide Object's properties:

  • path: Required, Array : The x/y points used to draw the path with a moveTo and 1 to n curveTo calls.
  • start: Optional, 0-1 : Initial position, default 0 except for when continuing along the same path.
  • end: Optional, 0-1 : Final position, default 1 if not specified.
  • orient: Optional, bool : Set the target's rotation parallel to the curve at its position.
Guide objects should not be shared between tweens even if all properties are identical, the library stores information on these objects in the background and sharing them can cause unexpected behaviour. Values outside 0-1 range of tweens will be a "best guess" from the appropriate part of the defined curve.

Constructor

MotionGuidePlugin

()

Item Index

Methods

Properties

Methods

init

() protected static

Defined in init:83

install

() static

Defined in install:73

Installs this plugin for use with TweenJS. Call this once after TweenJS is loaded to enable this plugin.

step

() protected static

Defined in step:96

tween

() protected static

Defined in tween:147

Properties

priority

Unknown protected static

Defined in priority:66