Two.js

A two-dimensional drawing api meant for modern browsers. It is renderer agnostic enabling the same api to render in multiple contexts: webgl, canvas2d, and svg.

Home • Examples • Documentation • Help

Usage

Download the latest minified library and include it in your html.

<script src="js/two.min.js"></script>

It can also be installed via npm

npm install --save two.js

Alternatively see how to build the library yourself.

Here is boilerplate html in order to draw a spinning rectangle in two.js:

<!doctype html>
<html>
  <head>
    <meta charset="utf-8">
    <script src="js/two.min.js"></script>
  </head>
  <body>
    <script>
      var two = new Two({
        fullscreen: true,
        autostart: true
      }).appendTo(document.body);
      var rect = two.makeRectangle(two.width / 2, two.height / 2, 50 ,50);
      two.bind('update', function() {
        rect.rotation += 0.001;
      });
    </script>
  </body>
</html>

Custom Build

Two.js uses nodejs in order to build source files. You'll first want to install that. Once installed open up a terminal and head to the repository folder:

cd ~/path-to-repo/two.js
npm install

This will give you a number of libraries that the development of Two.js relies on. If for instance you only use the SvgRenderer then you can really cut down on the file size by excluding the other renderers. To do this, modify /utils/build.js to only add the files you'd like. Then run:

node ./utils/build

And the resulting /build/two.js and /build/two.min.js will be updated to your specification.

Running in Headless Environments

As of version v0.7.0 Two.js can also run in a headless environment, namely running on the server with the help of a library called Node Canvas. We don't add Node Canvas to dependencies of Two.js because it's not necessary to run it in the browser. However, it has all the hooks setup to run in a cloud environment. To get started follow the installation instructions on Automattic's readme. After you've done that run:

npm install canvas

Now in a JavaScript file setup your Two.js scenegraph and save out frames whenever you need to:

var Two = require('../build/two.js'); // Or from npm, `require('two.js');`
var Canvas = require('canvas');
var Image = Canvas.Image;
var fs = require('fs');
var path = require('path');

var width = 800;
var height = 600;

var canvas = new Canvas();
Two[Two.Types.canvas].Utils.shim(canvas);

var time = Date.now();

var two = new Two({
  type: Two.Types.canvas,
  width: 800,
  height: 600,
  domElement: canvas
});

var rect = two.makeRectangle(width / 2, height / 2, 50, 50);
rect.fill = 'rgb(255, 100, 100)';
rect.noStroke();

two.update();

fs.writeFileSync(path.resolve(__dirname, './images/rectangle.png'), canvas.toBuffer());
console.log('Finished rendering. Time took: ', Date.now() - time);

process.exit();

Change Log

Nightly

Improved Q SVG interpretation
Two.Texture, Two.Sprite, and Two.ImageSequence implemented in WebGLRenderer
Added className property to Two.Shapes for easier CSS styling in SVGRenderer @fr0
Two.Events.resize is now bound to a renderer's setSize function giving a more generic solution to change scenegraph items based on dimensions changing

December 1, 2017 v0.7.0-alpha.1

Fixed closed Two.Path.getPointAt method to clamp properly
Added Two.Texture.repeat for describing pattern invocations
Added Two.Texture, Two.Sprite, and Two.ImageSequence
Removed Two.Shape inheritance for Two.Gradients
Added Two.Vector.rotate method @ferm10n
Objects clone to parent only if parent exists @ferm10n
Vendor agnostic requestAnimationFrame @ferm10n
Two.Utils.Events.listenTo and Two.Utils.Events.stopListening @ferm10n
Two.Utils.Events added to Two.Path.prototype for event inheritance @ferm10n
Enhanced Two.Shape.scale to allow both numbers and Two.Vector as property value
Made Two.interpret use latest primitives
Added Two.Circle primitive
Two.Shape.translation is now a getter/setter and can be replaced
Fixed translation interpretation to strip out 'px' strings
Removed Two.SineRing — make Two.Star.curved = true and it's the same effect
Enhanced Two.ArcSegment, Two.Ellipse, Two.Polygon, Two.Rectangle, Two.RoundedRectangle, Two.Star
Fixed Two.Anchor.relative interpretation in svg, canvas, and webgl renderers
Made Getters / Setters enumerable for iteration compatibility
Fixed Two.Utils.Collection.splice method and added additional test
Added compatibility with node.js, browserify, and node-canvas
Removed third party dependencies
Added remove method to Two.Text
Fixed ordering on same parent additions for Two.Group

February 9, 2016 v0.6.0

Updated Two.CanvasRenderer.ctx.imageSmoothingEnabled to not use deprecated invokation, issue 178
Fixed Two.Group.mask in SVGRenderer to append to DOM correctly
Updated require imports to be compatible with require.js
Added Two.Text for programmatically writing text in Two.js

October 1, 2015 v0.5.0

Added support for two.interpret to import svg's gradients
Added Two.Utils.xhr and two.load methods to asynchronously load SVG files
Added Two.Gradient, Two.LinearGradient, and Two.RadialGradient
Added dependency check to ensure ASM loading in environments like NPM as well as in the browser
Properly deleted webgl textures on removal of Two.Path
Added support for two.interpret to import svg's Elliptical Arcs
Added Two.ArcSegment and Two.SineRing as new shapes invoked like Two.Path @chrisdelbuck
Added Two.Line, Two.Rectangle, Two.RoundedRectangle, Two.Ellipse, Two.Polygon, and Two.Star as new shapes invoked like Two.Path
Breaking: renamed Two.Polygon to Two.Path
Performance enhancements to webgl renderer
Performance enhancements to canvas renderer Leo Koppelkamm
Enabled render ordering in Two.Group.children based on previous augmentation
Augmented Two.Group.children to inherit from Two.Collection effectively making it an array instead of a map Leo Koppelkamm
- The map can still be accessed at Two.Group.children.ids

July 22, 2014 v0.4.0

Updated Two.interpret to handle polybezier path data
Added Two.Group.mask and Two.Polygon.clip in order to create clipping masks
Two.Group has own opacity property Leo Koppelkamm
Rendering optimizations Leo Koppelkamm
Two.noConflict non-destructive command internally to the library
Two.interpret decomposes transform attribute of source tag
Two.interpret handles item irregularities from Inkscape
Changed Two.Identifier to use underscores instead of hyphens for dot-notation access Leo Koppelkamm
Added Two.Group.getById and Two.Group.getByClassName methods for convenient selection Leo Koppelkamm
Added classList to all Two.Shapes Leo Koppelkamm
Enabled inference of applied styles on imported svgs Leo Koppelkamm
Added Two.Polygon.getPointAt method to get coordinates on a curve/line
Added Two.Polygon.length property and Two.Polygon._updateLength method to calculate length of curve/line
Updated Two.Group.prototype observable properties on Two.Polygon.Properties to ensure each property is considered unique
~~Two.Polygon.vertices first and last vertex create automated control points when Two.Polygon.curved = true~~
Updated Two.Polygon.subdivide method to accommodate Two.makeEllipse
Enabled id to be properly interpreted from SVG elements @chrisdelbuck
Updated webgl renderer getBoundingClientRect to accommodate relative anchors
Updated beginning and ending to clamp to each other
Reorganized Two.Polygon._update and Two.Polygon.plot in order to handle beginning and ending properties
Updated Two.getComputedMatrix and Two.Polygon.getBoundingClientRect to adhere to nested transformations
Updated Two.Anchor to change control points relatively by default through anchor.relative property
Updated Two.Polygon.subdivide method to accommodate curved = false circumstances
Updated svg, canvas, and webgl renderers to properly reflect holes in curved Two.Polygons
Updated Two.Group clone method
Added toObject method to Two.Group, Two.Polygon, Two.Anchor
Two.Polygon initializes polygon.cap = 'butt' and polygon.join = 'miter' based on Adobe Illustrator defaults
Two.Polygon.subdivide method now works with Two.Commands.move for noncontiguous polygons
Internally update matrices on getBoundingClientRect in order to remove the need to defer or wait for internal variables to be up-to-date
Refactor of renderers and scenegraph for performance optimization and lower memory footprint
- Relinquished internal events for flags
- Prototypical declaration of Object.defineProperty
- Added _update and flagReset methods to Two.Shape, Two.Group, and Two.Polygon
- Decoupled canvas and webgl renderers and are now independent
- Added _matrix.manual to override the default behavior of a Two.Polygon transformation
- Localized variables per file as much as possible to reduce Garbage Collection on runtime

October 25, 2013 v0.3.0

Can properly pass domElement on construction of new instance of two
Added overdraw boolean to webgl renderer @arodic
Added support for ie9 svg interpretation @tomconroy
Added subdivide method for Two.Polygon and Two.Group
Ensure sure that manual properly is set on construction of Two.Polygon that it binds Two.Anchor.controls change events
Added automatic High DPI support for webgl renderer
Updated two.interpret(svg) to handle compound paths
Added Two.Anchor which represents all anchor points drawn in two.js
Modified source to not have any instances of window for node use
Updated to underscore.js 1.5.1
Added Two.Utils.getReflection method to properly get reflection's in svg interpretation
Made Two.Vector inherently not broadcast events and now needs to be explicity bound to in order to broadcast events, which two.js does internally for you
Created Two.Utils.Collection an observable array-like class that polygon.vertices inherit @fchasen
Added Two.Events.insert and Two.Events.remove for use with Two.Utils.Collection
Properly recurses getBoundingClientRect for both Two.Group and Two.Polygon
Added Two.Version to clarify forthcoming builds
Updated hierarchy ordering of group.children in canvas and webgl renderers
Updated shallow and bidirectional remove method for Two.Group and Two.Polygon
Added corner method to Two.Group and Two.Polygon allowing anchoring along the upper lefthand corner of the form
Modified center method of Two.Group and Two.Polygon to not affect the translation property to stay inline with corner method and any future orientation and anchoring logic
Added automatic High DPI support for canvas renderer
Added overdraw boolean to canvas renderer
Added AMD loader compatibility @thomasrudin
Deferred two.update(); to account for canvas and webgl
Added remove and clear methods to two instance
Updated svg interpretation for webgl context
~~Added matrix property to all Two.Shape's for advanced transformations~~
Added inverse method to Two.Matrix
Remove execution path dependency on utils/build.js @masonblier
Added timeDelta property to every two instance
Added gruntfile, package.json for more integration with npm, and dependency free build (build/two.clean.js) @iros
Crossbrowser compatibility with noStroke and noFill commands

May 3, 2013 v0.2.0

First alpha release

Jan 29, 2013 v0.1.0-alpha

Proof of Concept built from Three.js

montymole/two.js