Class me.Tween

Defined in: <build/melonJS-0.9.3.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	me.Tween(object) Javascript Tweening Engine Super simple, fast and easy to use tweening engine which incorporates optimised Robert Penner's equation https://github.com/sole/Tween.js

Field Summary
Field Attributes	Field Name and Description
	Easing Easing Function : Easing.Linear.EaseNone Easing.Quadratic.EaseIn Easing.Quadratic.EaseOut Easing.Quadratic.EaseInOut Easing.Cubic.EaseIn Easing.Cubic.EaseOut Easing.Cubic.EaseInOut Easing.Quartic.EaseIn Easing.Quartic.EaseOut Easing.Quartic.EaseInOut Easing.Quintic.EaseIn Easing.Quintic.EaseOut Easing.Quintic.EaseInOut Easing.Sinusoidal.EaseIn Easing.Sinusoidal.EaseOut Easing.Sinusoidal.EaseInOut Easing.Exponential.EaseIn Easing.Exponential.EaseOut Easing.Exponential.EaseInOut Easing.Circular.EaseIn Easing.Circular.EaseOut Easing.Circular.EaseInOut Easing.Elastic.EaseIn Easing.Elastic.EaseOut Easing.Elastic.EaseInOut Easing.Back.EaseIn Easing.Back.EaseOut Easing.Back.EaseInOut Easing.Bounce.EaseIn Easing.Bounce.EaseOut Easing.Bounce.EaseInOut

Method Summary
Method Attributes	Method Name and Description
	chain(chainedTween) chain the tween
	delay(amount) delay the tween
	easing(easing) set the easing function
	onComplete(onCompleteCallback) onComplete callback
	onUpdate(onUpdateCallback) onUpdate callback
	start() start the tween
	stop() stop the tween
	to(prop, duration) object properties to be updated and duration

Class Detail

me.Tween(object)

Javascript Tweening Engine

Super simple, fast and easy to use tweening engine which incorporates optimised Robert Penner's equation

https://github.com/sole/Tween.js

Author: sole, mr.doob, Robert Eisele, Philippe, Robert Penner.

// add a tween to change the object pos.y variable to 200 in 3 seconds
tween = new me.Tween(myObject.pos).to({y: 200}, 3000).onComplete(myFunc);
tween.easing(me.Tween.Easing.Bounce.EaseOut);
tween.start();

Parameters:
{Object} object: object on which to apply the tween

Field Detail

{enum} Easing

Easing Function :

Easing.Linear.EaseNone

Easing.Quadratic.EaseIn

Easing.Quadratic.EaseOut

Easing.Quadratic.EaseInOut

Easing.Cubic.EaseIn

Easing.Cubic.EaseOut

Easing.Cubic.EaseInOut

Easing.Quartic.EaseIn

Easing.Quartic.EaseOut

Easing.Quartic.EaseInOut

Easing.Quintic.EaseIn

Easing.Quintic.EaseOut

Easing.Quintic.EaseInOut

Easing.Sinusoidal.EaseIn

Easing.Sinusoidal.EaseOut

Easing.Sinusoidal.EaseInOut

Easing.Exponential.EaseIn

Easing.Exponential.EaseOut

Easing.Exponential.EaseInOut

Easing.Circular.EaseIn

Easing.Circular.EaseOut

Easing.Circular.EaseInOut

Easing.Elastic.EaseIn

Easing.Elastic.EaseOut

Easing.Elastic.EaseInOut

Easing.Back.EaseIn

Easing.Back.EaseOut

Easing.Back.EaseInOut

Easing.Bounce.EaseIn

Easing.Bounce.EaseOut

Easing.Bounce.EaseInOut

Method Detail

chain(chainedTween)

chain the tween

Parameters:
{me.Tween} chainedTween: Tween to be chained

delay(amount)

delay the tween

Parameters:
{int} amount: delay amount

easing(easing)

set the easing function

Parameters:
{Function} easing: easing function

onComplete(onCompleteCallback)

onComplete callback

Parameters:
{function} onCompleteCallback: callback

onUpdate(onUpdateCallback)

onUpdate callback

Parameters:
{function} onUpdateCallback: callback

start()

start the tween

stop()

stop the tween

to(prop, duration)

object properties to be updated and duration

Parameters:
{Properties} prop: list of properties
{int} duration: tween duration

melonJS

A lightweight HTML5 game engine

API Document Index

Class me.Tween