Class createjs.Tween

Extends .

Defined in: tween.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	createjs.Tween(target) A class that implements a tween.

Field Summary
Field Attributes	Field Name and Description
	id An ID for this tween.
<static>	createjs.Tween.id_ IDs assigned to tweens.
	loop_ Whether the tween loops when it reaches the end.

Method Summary
Method Attributes	Method Name and Description
	call(callback, opt_params, opt_scope) Queues an action to call the specified function.
<static>	createjs.Tween.Command() An inner interface used by the createjs.Tween class to execute an animation command.
<static>	createjs.Tween.get(target, opt_properties, opt_pluginData, opt_override) Returns a new createjs.Tween instance.
	getDuration() Returns the duration (or total play time) of this tween.
	getPosition() Retrieves the current play offset of this tween.
	getTarget() Returns the target object of this tween.
	handleLoopChanged(value)
	handleTick(time)
<static>	createjs.Tween.hasActiveTweens(opt_target) Returns whether there are any active Tweens attached to the specified target or returns whether there are any registered Tweens.
<static>	createjs.Tween.installPlugin(plugin, properties) Installs a plug-in.
	isEnded()
	pause(tween) Queues an action to to pause the specified tween.
	play(tween) Queues an action to to play (unpause) the specified tween.
	playTween(time)
<static>	createjs.Tween.removeAllTweens() Removes all existing Tweens.
<static>	createjs.Tween.removeTweens(target) Removes all existing tweens from a target.
	set(properties, opt_target) Queues an action to set the specified properties on the specified target.
	setPaused(value) Pauses or plays this tween.
	setPosition(position, mode)
	setProperties(loop, position, single)
	setProxy(proxy, targets)
	stopTween(time)
	to(properties, duration, opt_ease) Queues a tween from the current values to the target properties.
	updateTween(time, flag, next)
	wait(duration, opt_passive) Queues a wait (essentially an empty tween).

Class Detail

createjs.Tween(target)

A class that implements a tween.

Parameters:
{createjs.TweenTarget} target

Field Detail

An ID for this tween.

<static> createjs.Tween.id_

IDs assigned to tweens.

loop_

Whether the tween loops when it reaches the end.

Method Detail

{createjs.Tween} call(callback, opt_params, opt_scope)

Queues an action to call the specified function.

Parameters:
{Function} callback
{Array=} opt_params
{Object=} opt_scope

Returns:: {createjs.Tween}

<static> createjs.Tween.Command()

An inner interface used by the createjs.Tween class to execute an animation command.

<static> {createjs.Tween} createjs.Tween.get(target, opt_properties, opt_pluginData, opt_override)

Returns a new createjs.Tween instance. This is a factory method for createjs.Tween objects.

Parameters:
{createjs.TweenTarget} target
{Object=} opt_properties
{Object=} opt_pluginData
{boolean=} opt_override

Returns:: {createjs.Tween}

{number} getDuration()

Returns the duration (or total play time) of this tween.

Returns:: {number}

{number} getPosition()

Retrieves the current play offset of this tween.

Returns:: {number}

{createjs.TweenTarget} getTarget()

Returns the target object of this tween.

Returns:: {createjs.TweenTarget}

handleLoopChanged(value)

Parameters:
value

handleTick(time)

Parameters:
time

<static> {boolean} createjs.Tween.hasActiveTweens(opt_target)

Returns whether there are any active Tweens attached to the specified target or returns whether there are any registered Tweens.

Parameters:
{createjs.TweenTarget=} opt_target

Returns:: {boolean}

<static> createjs.Tween.installPlugin(plugin, properties)

Installs a plug-in.

Parameters:
{Object} plugin
{Array} properties

isEnded()

{createjs.Tween} pause(tween)

Queues an action to to pause the specified tween.

Parameters:
{createjs.Tween} tween

Returns:: {createjs.Tween}

{createjs.Tween} play(tween)

Queues an action to to play (unpause) the specified tween.

Parameters:
{createjs.Tween} tween

Returns:: {createjs.Tween}

playTween(time)

Parameters:
time

<static> createjs.Tween.removeAllTweens()

Removes all existing Tweens.

<static> createjs.Tween.removeTweens(target)

Removes all existing tweens from a target.

Parameters:
{createjs.TweenTarget} target

{createjs.Tween} set(properties, opt_target)

Queues an action to set the specified properties on the specified target.

Parameters:
{Object} properties
{createjs.TweenTarget=} opt_target

Returns:: {createjs.Tween}

{createjs.TweenObject} setPaused(value)

Pauses or plays this tween.

Parameters:
{boolean} value

Returns:: {createjs.TweenObject}

setPosition(position, mode)

Parameters:
position
mode

setProperties(loop, position, single)

Parameters:
loop
position
single

setProxy(proxy, targets)

Parameters:
proxy
targets

stopTween(time)

Parameters:
time

{createjs.Tween} to(properties, duration, opt_ease)

Queues a tween from the current values to the target properties.

Parameters:
{Object} properties
{number} duration
{createjs.Ease.Delegate=} opt_ease

Returns:: {createjs.Tween}

updateTween(time, flag, next)

Parameters:
time
flag
next

{createjs.Tween} wait(duration, opt_passive)

Queues a wait (essentially an empty tween).

Parameters:
{number} duration
{boolean=} opt_passive

Returns:: {createjs.Tween}

Classes

Class createjs.Tween