tween.js user guide

NOTE this is a work in progress, please excuse the gaps. Wherever you see something marked as TODO, it's not done yet. If you find that something is unclear or missing details, please file an issue and help make this guide better. Or feel free to submit clarifications or improvements of your own if you feel you can help too!

What is a tween? How do they work? Why do you want to use them?

A tween (from in-between) is a concept that allows you to change the values of the properties of an object in a smooth way. You just tell it which properties you want to change, which final values should they have when the tween finishes running, and how long should this take, and the tweening engine will take care of finding the intermediate values from the starting to the ending point. For example, suppose you have a position object with x and y coordinates:

var position = { x: 100, y: 0 }

If you wanted to change the x value from 100 to 200, you'd do this:

// Create a tween for position first
var tween = new TWEEN.Tween(position);

// Then tell the tween we want to animate the x property over 1000 milliseconds
tween.to({ x: 200 }, 1000);

Actually this won't do anything yet. The tween has been created but it's not active. You need to start it:

// And set it to start
tween.start();

Finally in order to run as smoothly as possible you should call the TWEEN.update function in the same main loop you're using for animating. This generally looks like this:

animate();

function animate() {
	requestAnimationFrame(animate);
	// [...]
	TWEEN.update();
	// [...]
}

This will take care of updating all active tweens; after 1 second (i.e. 1000 milliseconds) position.x will be 200.

But unless you print the value of x to the console, you can't see its value changing. You might want to use the onUpdate callback:

tween.onUpdate(function(object) {
	console.log(object.x);
});

This function will be called each time the tween is updated; how often this happens depends on many factors--how fast (and how busy!) your computer or device is, for example.

So far we've only used tweens to print values to the console, but you could use it for things such as animating positions of three.js objects:

var tween = new TWEEN.Tween(cube.position)
		.to({ x: 100, y: 100, z: 100 }, 10000)
		.start();

animate();

function animate() {
	requestAnimationFrame(animate);
	TWEEN.update();

	threeRenderer.render(scene, camera);
}

In this case, because the three.js renderer will look at the object's position before rendering, you don't need to use an explicit onUpdate callback.

You might have noticed something different here too: we're chaining the tween function calls! Each tween function returns the tween instance, so you can rewrite the following code:

var tween = new TWEEN.Tween(position);
tween.to({ x: 200 }, 1000);
tween.start();

into this

var tween = new TWEEN.Tween(position)
	.to({ x: 200 }, 1000)
	.start();

You'll see this a lot in the examples, so it's good to be familiar with it! Check 04-simplest for a working example.

Animating with tween.js

Tween.js doesn't run by itself. You need to tell it when to run, by explicitly calling the update method. The recommended method is to do this inside your main animation loop, which should be called with requestAnimationFrame for getting the best graphics performance:

We've seen this example before:

animate();

function animate() {
	requestAnimationFrame(animate);
	// [...]
	TWEEN.update();
	// [...]
}

If called without parameters, update will determine the current time in order to find out how long has it been since the last time it ran.

However you can also pass an explicit time parameter to update. Thus,

TWEEN.update(100);

means "update with time = 100 milliseconds". You can use this to make sure that all the time-dependent functions in your code are using the very same time value. For example suppose you've got a player and want to run tweens in sync. Your animate code could look like this:

var currentTime = player.currentTime;
TWEEN.update(currentTime);

We use explicit time values for the unit tests. You can have a look at tests.js to see how we call TWEEN.update() with different values in order to simulate time passing.

Controlling a tween

`start` and `stop`

So far we've learnt about the Tween.start method, but there are more methods that control individual tweens. Probably the most important one is the start counterpart: stop. If you want to cancel a tween, just call this method over an individual tween:

tween.stop();

Stopping a tween that was never started or that has already been stopped has no effect. No errors are thrown either.

The start method also accepts a time parameter. If you use it, the tween won't start until that particular moment in time; otherwise it will start as soon as possible (i.e. on the next call to TWEEN.update).

`update`

Individual tweens also have an update method---this is in fact called by TWEEN.update. You generally don't need to call this directly, but might be useful if you're doing crazy hacks.

`chain`

Things get more interesting when you sequence different tweens in order, i.e. setup one tween to start once a previous one has finished. We call this chaining tweens, and it's done with the chain method. Thus, to make tweenB start after tweenA finishes:

tweenA.chain(tweenB);

Or, for an infinite chain, set tweenA to start once tweenB finishes:

tweenA.chain(tweenB);
tweenB.chain(tweenA);

Check Hello world to see an example of these infinite chains.

In other cases, you may want to chain multiple tweens to another tween in a way that they (the chained tweens) all start animating at the same time:

tweenA.chain(tweenB,tweenC);

WARNING: Calling tweenA.chain(tweenB) actually modifies tweenA so that tweenB is always started when tweenA finishes. The return value of chain is just tweenA, not a new tween.

`repeat`

If you wanted a tween to repeat forever you could chain it to itself, but a better way is to use the repeat method. It accepts a parameter that describes how many repetitions you want after the first tween is completed:

tween.repeat(10); // repeats 10 times after the first tween and stops
tween.repeat(Infinity); // repeats forever

The total number of tweens will be the repeat parameter plus one for the initial tween. Check the Repeat example.

`yoyo`

This function only has effect if used along with repeat. When active, the behaviour of the tween will be like a yoyo, i.e. it will bounce to and from the start and end values, instead of just repeating the same sequence from the beginning.

`delay`

More complex arrangements might require delaying a tween before it actually starts running. You can do that using the delay method:

tween.delay(1000);
tween.start();

will start executing 1 second after the start method has been called.

Controlling all the tweens

The following methods are found in the TWEEN global object, and you generally won't need to use most of them, except for update.

`TWEEN.update(time)`

We've already talked about this method. It is used to update all the active tweens.

If time is not specified, it will use the current time.

`TWEEN.getAll` and `TWEEN.removeAll`

Used to get a reference to the active tweens array and to remove all of them from the array with just one call, respectively.

`TWEEN.add(tween)` and `TWEEN.remove(tween)`

Used to add a tween to the list of active tweens, or to remove an specific one from the list, respectively.

These methods are usually used internally only, but are exposed just in case you want to do something funny.

Controlling groups of tweens

Using the TWEEN singleton to manage your tweens can cause issues in large apps with many components. In these cases, you may want to create your own smaller groups of tweens.

Example: cross-component conflict

A conflict can occur if you have multiple components using TWEEN, and each component wants to manage its own set of tweens. If one component calls TWEEN.update() or TWEEN.removeAll() the tweens of other components will also be updated or removed.

Creating your own tween groups

To solve this, each component can make their own instance of TWEEN.Group (which is what the global TWEEN object uses internally). These groups can be passed in as a second optional parameter when instantiating a new tween:

var groupA = new TWEEN.Group();
var groupB = new TWEEN.Group();

var tweenA = new TWEEN.Tween({ x: 1 }, groupA)
	.to({ x: 10 }, 100)
	.start();

var tweenB = new TWEEN.Tween({ x: 1 }, groupB)
	.to({ x: 10 }, 100)
	.start();

var tweenC = new TWEEN.Tween({ x: 1 })
	.to({ x: 10 }, 100)
	.start();

groupA.update(); // only updates tweenA
groupB.update(); // only updates tweenB
TWEEN.update(); // only updates tweenC

groupA.removeAll(); // only removes tweenA
groupB.removeAll(); // only removes tweenB
TWEEN.removeAll(); // only removes tweenC

In this way, each component can handle creating, updating, and destroying its own set of tweens.

Changing the easing function (AKA make it bouncy)

Tween.js will perform the interpolation between values (i.e. the easing) in a linear manner, so the change will be directly proportional to the elapsed time. This is predictable but also quite uninteresting visually wise. Worry not--this behaviour can be easily changed using the easing method. For example:

tween.easing(TWEEN.Easing.Quadratic.In);

This will result in the tween slowly starting to change towards the final value, accelerating towards the middle, and then quickly reaching its final value. In contrast, TWEEN.Easing.Quadratic.Out would start changing quickly towards the value, but then slow down as it approaches the final value.

Available easing functions: `TWEEN.Easing`

There are a few existing easing functions provided with tween.js. They are grouped by the type of equation they represent: Linear, Quadratic, Cubic, Quartic, Quintic, Sinusoidal, Exponential, Circular, Elastic, Back and Bounce, and then by the easing type: In, Out and InOut.

Probably the names won't be saying anything to you unless you're familiar with these concepts already, so it is probably the time to check the Graphs example, which graphs all the curves in one page so you can compare how they look at a glance.

Credit where credit is due: these functions are derived from the original set of equations that Robert Penner graciously made available as free software a few years ago, but have been optimised to play nicely with JavaScript.

Using a custom easing function

Not only can you use any of the existing functions, but you can also provide your own, as long as it follows a couple of conventions:

it must accept one parameter:
- k: the easing progress, or how far along the duration of the tween we are. Allowed values are in the range [0, 1].
it must return a value based on the input parameters.

The easing function is only called once per tween on each update, no matter how many properties are to be changed. The result is then used with the initial value and the difference (the deltas) between this and the final values, as in this pseudocode:

easedElapsed = easing(k);
for each property:
	newPropertyValue = initialPropertyValue + propertyDelta * easedElapsed;

For the performance obsessed people out there: the deltas are calculated only when start() is called on a tween.

So let's suppose you wanted to use a custom easing function that eased the values but appplied a Math.floor to the output, so only the integer part would be returned, resulting in a sort of step-ladder output:

function tenStepEasing(k) {
	return Math.floor(k * 10) / 10;
}

And you could use it in a tween by simply calling its easing method, as we've seen before:

tween.easing(tenStepEasing);

Check the graphs for custom easing functions example to see this in action (and also some metaprogramming for generating step functions).

Callbacks

Another powerful feature is to be able to run your own functions at specific times in each tween's life cycle. This is usually required when changing properties is not enough.

For example, suppose you're trying to animate some object whose properties can't be accessed directly but require you to call a setter instead. You can use an update callback to read the new updated values and then manually call the setters. All callbacks are passed the tweened object as the only parameter.

var trickyObjTween = new TWEEN.Tween({
	propertyA: trickyObj.getPropertyA(),
	propertyB: trickyObj.getPropertyB()
})
	.to({ propertyA: 100, propertyB: 200 })
	.onUpdate(function(object) {
		object.setA( object.propertyA );
		object.setB( object.propertyB );
	});

Or imagine you want to play a sound when a tween is started. You can use an start callback:

var tween = new TWEEN.Tween(obj)
	.to({ x: 100 })
	.onStart(function() {
		sound.play();
	});

The scope for each callback is the tweened object--in this case, obj.

onStart

Executed right before the tween starts--i.e. before the deltas are calculated. This will be executed only once per tween, i.e. it will not be run when the tween is repeated via repeat().

It is great for synchronising to other events or triggering actions you want to happen when a tween starts.

The tweened object is passed in as the first parameter.

onStop

Executed when a tween is explicitly stopped via stop(), but not when it is completed normally, and before stopping any possible chained tween.

The tweened object is passed in as the first parameter.

onUpdate

Executed each time the tween is updated, after the values have been actually updated.

The tweened object is passed in as the first parameter.

onComplete

Executed when a tween is finished normally (i.e. not stopped).

The tweened object is passed in as the first parameter.

Advanced tweening

Relative values

You can also use relative values when using the to method. When the tween is started, Tween.js will read the current property values and apply the relative values to find out the new final values. But you need to use quotes or the values will be taken as absolute. Let's see this with an example:

// This will make the `x` property be 100, always
var absoluteTween = new TWEEN.Tween(absoluteObj).to({ x: 100 });

// Suppose absoluteObj.x is 0 now
absoluteTween.start(); // Makes x go to 100

// Suppose absoluteObj.x is -100 now
absoluteTween.start(); // Makes x go to 100

// In contrast...

// This will make the `x` property be 100 units more,
// relative to the actual value when it starts
var relativeTween = new TWEEN.Tween(relativeObj).to({ x: "+100" });

// Suppose relativeObj.x is 0 now
relativeTween.start(); // Makes x go to 0 +100 = 100

// Suppose relativeObj.x is -100 now
relativeTween.start(); // Makes x go to -100 +100 = 0

Check 09_relative_values for an example.

Tweening to arrays of values

In addition to tweening to an absolute or a relative value, you can also have Tween.js change properties across a series of values. To do this, you just need to specify an array of values instead of a single value for a property. For example:

var tween = new TWEEN.Tween(relativeObj).to({ x: [0, -100, 100] });

will make x go from its initial value to 0, -100 and 100.

The way these values are calculated is as follows:

first the tween progress is calculated as usual
the progress (from 0 to 1) is used as input for the interpolation function
based on the progress and the array of values, an interpolated value is generated

For example, when the tween has just started (progress is 0), the interpolation function will return the first value in the array. When the tween is halfway, the interpolation function will return a value approximately in the middle of the array, and when the tween is at the end, the interpolation function will return the last value.

You can change the interpolation function with the interpolation method. For example:

tween.interpolation( TWEEN.Interpolation.Bezier );

The following values are available:

TWEEN.Interpolation.Linear
TWEEN.Interpolation.Bezier
TWEEN.Interpolation.CatmullRom

The default is Linear.

Note that the interpolation function is global to all properties that are tweened with arrays in the same tween. You can't make property A change with an array and a Linear function, and property B with an array too and a Bezier function using the same tween; you should use two tween objects running over the same object but modifying different properties and using different interpolation functions.

Check 06_array_interpolation for an example.

Getting the best performance

While Tween.js tries to be performant on its own, nothing prevents you from using it in a way that is counterperformant. Here are some of the ways you can avoid slowing down your projects when using Tween.js (or when animating in the web, in general).

Use performant CSS

When you try to animate the position of an element in the page, the easiest solution is to animate the top and left style properties, like this:

var element = document.getElementById('myElement');
var tween = new TWEEN.Tween({ top: 0, left: 0 })
	.to({ top: 100, left: 100 }, 1000)
	.onUpdate(function(object) {
		element.style.top = object.top + 'px';
		element.style.left = object.left + 'px';
	});

but this is really inefficient because altering these properties forces the browser to recalculate the layout on each update, and this is a very costly operation. Instead of using these, you should use transform, which doesn't invalidate the layout and will also be hardware accelerated when possible, like this:

var element = document.getElementById('myElement');
var tween = new TWEEN.Tween({ top: 0, left: 0 })
	.to({ top: 100, left: 100 }, 1000)
	.onUpdate(function(object) {
		element.style.transform = 'translate(' + object.left + 'px, ' + object.top + 'px);';
	});

If you want to read more about this, have a look at this article.

However, if your animation needs are that simple, it might be better to just use CSS animations or transitions, where applicable, so that the browser can optimise as much as possible. Tween.js is most useful when your animation needs involve complex arrangements, i.e. you need to sync several tweens together, have some start after one has finished, loop them a number of times, etc.

Be good to the Garbage collector (alias the GC)

If you use an onUpdate callback, you need to be very careful with what you put on it. This function will be called many times per second, so if you're doing costly operations on each update, you might block the main thread and cause horrible jank, or---if your operations involve memory allocations, you'll end up getting the garbage collector to run too often, and cause jank too. So just don't do either of those things. Keep your onUpdate callbacks very lightweight, and be sure to also use a memory profiler while you're developing.

Crazy tweening

This is something you might not use often, but you can use the tweening equations outside of Tween.js. They're just functions, after all. So you could use them to calculate smooth curves as input data. For example, they're used to generate audio data in this experiment.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

user_guide.md

user_guide.md

tween.js user guide

What is a tween? How do they work? Why do you want to use them?

Animating with tween.js

Controlling a tween

`start` and `stop`

`update`

`chain`

`repeat`

`yoyo`

`delay`

Controlling all the tweens

`TWEEN.update(time)`

`TWEEN.getAll` and `TWEEN.removeAll`

`TWEEN.add(tween)` and `TWEEN.remove(tween)`

Controlling groups of tweens

Example: cross-component conflict

Creating your own tween groups

Changing the easing function (AKA make it bouncy)

Available easing functions: `TWEEN.Easing`

Using a custom easing function

Callbacks

onStart

onStop

onUpdate

onComplete

Advanced tweening

Relative values

Tweening to arrays of values

Getting the best performance

Use performant CSS

Be good to the Garbage collector (alias the GC)

Crazy tweening

Files

user_guide.md

Latest commit

History

user_guide.md

File metadata and controls

tween.js user guide

What is a tween? How do they work? Why do you want to use them?

Animating with tween.js

Controlling a tween

start and stop

update

chain

repeat

yoyo

delay

Controlling all the tweens

TWEEN.update(time)

TWEEN.getAll and TWEEN.removeAll

TWEEN.add(tween) and TWEEN.remove(tween)

Controlling groups of tweens

Example: cross-component conflict

Creating your own tween groups

Changing the easing function (AKA make it bouncy)

Available easing functions: TWEEN.Easing

Using a custom easing function

Callbacks

onStart

onStop

onUpdate

onComplete

Advanced tweening

Relative values

Tweening to arrays of values

Getting the best performance

Use performant CSS

Be good to the Garbage collector (alias the GC)

Crazy tweening

`start` and `stop`

`update`

`chain`

`repeat`

`yoyo`

`delay`

`TWEEN.update(time)`

`TWEEN.getAll` and `TWEEN.removeAll`

`TWEEN.add(tween)` and `TWEEN.remove(tween)`

Available easing functions: `TWEEN.Easing`