Awesome
tween.js
JavaScript tweening engine for easy animations, incorporating optimised Robert Penner's equations.
var coords = { x: 0, y: 0 };
var tween = new TWEEN.Tween(coords)
.to({ x: 100, y: 100 }, 1000)
.onUpdate(function() {
console.log(this.x, this.y);
})
.start();
requestAnimationFrame(animate);
function animate(time) {
requestAnimationFrame(animate);
TWEEN.update(time);
}
Installation
Download the library and include it in your code:
<script src="js/Tween.js"></script>
You can also reference a CDN-hosted version in your code, thanks to cdnjs. For example:
<script src="https://cdnjs.cloudflare.com/ajax/libs/tween.js/16.3.5/Tween.min.js"></script>
See tween.js for more versions.
More advanced users might want to...
Use npm
npm install @tweenjs/tween.js
Then include the Tween.js module with the standard node.js require
:
var TWEEN = require('@tweenjs/tween.js');
And you can use Tween.js as in all other examples--for example:
var t = new TWEEN.Tween( /* etc */ );
t.start();
You will need to use a tool such as browserify
to convert code using this style into something that can be run in the browser (browsers don't know about require
).
Use bower
bower install @tweenjs/tweenjs --save
or install an specific tag. They are git tags, and you can run git tag
in the command line for a list if you have cloned the repository locally, or you can also check out the list in the tween.js tags page. For example, to install v16.3.0
:
bower install @tweenjs/tweenjs#v16.3.0
Then reference the library source:
<script src="bower_components/@tweenjs/tweenjs/src/Tween.js"></script>
Features
- Does one thing and one thing only: tween properties
- Doesn't take care of CSS units (e.g. appending
px
) - Doesn't interpolate colours
- Easing functions are reusable outside of Tween
- Can also use custom easing functions
Documentation
- User guide
- Contributor guide
- Tutorial using tween.js with three.js
- Also: libtween, a port of tween.js to C by jsm174
Examples
<table> <tr> <td> <a href="http://tweenjs.github.io/tween.js/examples/12_graphs_custom_functions.html"> <img src="./assets/examples/03_graphs.png" alt="Custom functions" /> </a> </td> <td> Custom functions<br /> (<a href="examples/12_graphs_custom_functions.html">source</a>) </td> <td> <a href="http://tweenjs.github.io/tween.js/examples/11_stop_all_chained_tweens.html"> <img src="./assets/examples/11_stop_all_chained_tweens.png" alt="Stop all chained tweens" /> </a> </td> <td> Stop all chained tweens<br /> (<a href="examples/11_stop_all_chained_tweens.html">source</a>) </td> </tr> <tr> <td> <a href="http://tweenjs.github.io/tween.js/examples/10_yoyo.html"> <img src="./assets/examples/10_yoyo.png" alt="Yoyo" /> </a> </td> <td> Yoyo<br /> (<a href="examples/10_yoyo.html">source</a>) </td> <td> <a href="http://tweenjs.github.io/tween.js/examples/09_relative_values.html"> <img src="./assets/examples/09_relative.png" alt="Relative values" /> </a> </td> <td> Relative values<br /> (<a href="examples/09_relative_values.html">source</a>) </td> </tr> <tr> <td> <a href="http://tweenjs.github.io/tween.js/examples/08_repeat.html"> <img src="./assets/examples/08_repeat.png" alt="Repeat" /> </a> </td> <td> Repeat<br /> (<a href="examples/08_repeat.html">source</a>) </td> <td> <a href="http://tweenjs.github.io/tween.js/examples/07_dynamic_to.html"> <img src="./assets/examples/07_dynamic_to.png" alt="Dynamic to" /> </a> </td> <td> Dynamic to<br /> (<a href="examples/07_dynamic_to.html">source</a>) </td> </tr> <tr> <td> <a href="http://tweenjs.github.io/tween.js/examples/06_array_interpolation.html"> <img src="./assets/examples/03_graphs.png" alt="Array interpolation" /> </a> </td> <td> Array interpolation<br /> (<a href="examples/06_array_interpolation.html">source</a>) </td> <td> <a href="http://tweenjs.github.io/tween.js/examples/05_video_and_time.html"> <img src="./assets/examples/06_video_and_time.png" alt="Video and time" /> </a> </td> <td> Video and time<br /> (<a href="examples/05_video_and_time.html">source</a>) </td> </tr> <tr> <td> <a href="http://tweenjs.github.io/tween.js/examples/04_simplest.html"> <img src="./assets/examples/04_simplest.png" alt="Simplest possible example" /> </a> </td> <td> Simplest possible example<br /> (<a href="examples/04_simplest.html">source</a>) </td> <td> <a href="http://tweenjs.github.io/tween.js/examples/03_graphs.html"> <img src="./assets/examples/03_graphs.png" alt="Graphs" /> </a> </td> <td> Graphs<br /> (<a href="examples/03_graphs.html">source</a>) </td> </tr> <tr> <td> <a href="http://tweenjs.github.io/tween.js/examples/02_black_and_red.html"> <img src="./assets/examples/02_black_and_red.png" alt="Black and red" /> </a> </td> <td> Black and red<br /> (<a href="examples/02_black_and_red.html">source</a>) </td> <td> <a href="http://tweenjs.github.io/tween.js/examples/01_bars.html"> <img src="./assets/examples/01_bars.png" alt="Bars" /> </a> </td> <td> Bars<br /> (<a href="examples/01_bars.html">source</a>) </td> </tr> <tr> <td> <a href="http://tweenjs.github.io/tween.js/examples/00_hello_world.html"> <img src="./assets/examples/00_hello_world.png" alt="hello world" /> </a> </td> <td> hello world<br /> (<a href="examples/00_hello_world.html">source</a>) </td> </tr> </table>Tests
You need to install npm
first--this comes with node.js, so install that one first. Then, cd to tween.js
's directory and run:
npm install
if running the tests for the first time, to install additional dependencies for running tests, and then run
npm test
every time you want to run the tests.
If you want to add any feature or change existing features, you must run the tests to make sure you didn't break anything else. If you send a pull request (PR) to add something new and it doesn't have tests, or the tests don't pass, the PR won't be accepted. See contributing for more information.