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, Node Package Manager:
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.x
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 npm install two.js
Now in a JavaScript file setup your Two.js scenegraph and save out frames whenever you need to:
var { createCanvas, Image } = require('canvas'); var Two = require('two.js') var fs = require('fs'); var path = require('path'); var width = 800; var height = 600; var canvas = createCanvas(width, height); Two.Utils.shim(canvas, Image); var time = Date.now(); var two = new Two({ width: width, height: height, domElement: canvas }); var rect = two.makeRectangle(width / 2, height / 2, 50, 50); rect.fill = 'rgb(255, 100, 100)'; rect.noStroke(); two.render(); var settings = { compressionLevel: 3, filters: canvas.PNG_FILTER_NONE }; fs.writeFileSync(path.resolve(__dirname, './images/rectangle.png'), canvas.toBuffer('image/png', settings)); console.log('Finished rendering. Time took: ', Date.now() - time); process.exit();
Change Log
Nightly
- Added
Two.makeArrow
for Simple Triangular Tipped Arrows @mike168m - Improved
Two.Matrix
efficiency of calculations - Added
Two.Path.dashes.offset
andTwo.Text.dashes.offset
properties for animating dashed strokes in all renderers - Fixed
Two.Path.corner
method to not be additive on successive invocations - Split
Two.Matrix.toArray
into two different functions. One for 2D transforms and one for a plain object (JSON) representation - Added
Two.Matrix.toTransformArray
intended for 2D transformation use internally WebGLRenderer
more robustly supports displaying bitmap content- Added
<g />
attributes to be inherited by children in SVG interpretation - Added
offscreenElement
as an option when constructing WebGL Renderers for WebWorker compatibility - Added
Two.Shape.position
accessor toTwo.Shape.translation
for ease of use with matter.js - Added
Two.Path.dashes
andTwo.Text.dashes
support to WebGL and Canvas Renderers
v0.7.0-beta.3
December 8, 2018- Canvas Renderer supports dashed and non dashed paths
- Enforce
Two.Rectangle
has fourvertices
- Fixed
Two.Path.closed
on latestending
calculations
v0.7.0-beta.2
November 18, 2018- Updated Two.js compatibility with webpack and node-canvas 2.0.0+
v0.7.0-beta.1
November 3, 2018- Altered
Two.Path.clone
andTwo.Text.clone
to use references where possible and to_update()
on return - Improved multi-decimal and arc SVG interpretation
- Added
Two.Commands.arc
for better arc rendering across all renderers Two.Path
andTwo.Text
now havedashes
property to define stroke dashing behavior @danvanordenTwo.Vector
arithmetic methods made more consistent — still need to improve performanceTwo.Path.vertices
will not clone vectors, improving developer clarity- Two.js clone methods do not force adding to a parent
Two.ImageSequence
,Two.Sprite
, andTwo.Rectangle
haveorigin
properties for offset renderingTwo.Group.getBoundingClientRect
will pass-through on effects instead of breakTwo.interpret
apply SVG nodestyle
attributes to paths. Inherits from groupsand infers SVGviewBox
attribute against Two.js instanceTwo.interpret
improves multi-decimal formattedd
attributesTwo.ZUI
added through the new/extras
folderTwo.Text.getBoundingClientRect
now returns an estimated bounding box objectTwo.interpret
properly assigns back calculatedZ
coordinatesTwo.load
now immediately returns aTwo.Group
for use without callbacks if desired- Added
Two.Group.length
to return the calculated length of all child paths Two.Group.beginning
andTwo.Group.ending
calculate based on childTwo.Path
s for intuitive grouped animating- Added
Two.Utils.shim
to properly handlecanvas
andimage
element spoofing in headless environments - Improved conformance between primitive shapes
Two.Path.getBoundingClientRect
considers control points from bezier curvesTwo.Path.beginning
andTwo.Path.ending
calculate based on distance increasing accuracy for animation, but also performance load- Moved
Two.Path._vertices
underlying to list of rendered points toTwo.Path._renderer.vertices
- Improved accuracy of
Two.Path.ending
andTwo.Path.beginning
on open paths - Added specific
clone
method toTwo.ArcSegment
,Two.Circle
,Two.Ellipse
,Two.Polygon
,Two.Rectangle
,Two.RoundedRectangle
, andTwo.Star
primitives - Added ability to read
viewBox
property from root SVG node inTwo.interpret
- Added more reliable transform getter in
Two.interpret
- Added
rx
andry
property reading onTwo.Utils.read.rect
- Added
Two.Utils.read['rounded-rect']
to interpret Rounded Rectangles - Added ability for
Two.RoundedRectangle.radius
to be aTwo.Vector
for x, y component styling - Added ES6 compatible
./build/two.module.js
for importing library - Improved
Q
SVG interpretation Two.Texture
,Two.Sprite
, andTwo.ImageSequence
implemented inWebGLRenderer
- Added
className
property toTwo.Shape
s for easier CSS styling inSVGRenderer
@fr0 Two.Events.resize
is now bound to a renderer'ssetSize
function giving a more generic solution to change scenegraph items based on dimensions changing
v0.7.0-alpha.1
December 1, 2017- Fixed closed
Two.Path.getPointAt
method to clamp properly - Added
Two.Texture.repeat
for describing pattern invocations - Added
Two.Texture
,Two.Sprite
, andTwo.ImageSequence
- Removed
Two.Shape
inheritance forTwo.Gradient
s - Added
Two.Vector.rotate
method @ferm10n - Objects clone to parent only if parent exists @ferm10n
- Vendor agnostic
requestAnimationFrame
@ferm10n Two.Utils.Events.listenTo
andTwo.Utils.Events.stopListening
@ferm10nTwo.Utils.Events
added toTwo.Path.prototype
for event inheritance @ferm10n- Enhanced
Two.Shape.scale
to allow both numbers andTwo.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
— makeTwo.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 insvg
,canvas
, andwebgl
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 toTwo.Text
- Fixed ordering on same parent additions for
Two.Group
v0.6.0
February 9, 2016- Updated
Two.CanvasRenderer.ctx.imageSmoothingEnabled
to not use deprecated invocation, issue 178 - Fixed
Two.Group.mask
inSVGRenderer
to append to DOM correctly - Updated
require
imports to be compatible with require.js - Added
Two.Text
for programmatically writing text in Two.js
v0.5.0
October 1, 2015- Added support for
two.interpret
to importsvg
's gradients - Added
Two.Utils.xhr
andtwo.load
methods to asynchronously load SVG files - Added
Two.Gradient
,Two.LinearGradient
, andTwo.RadialGradient
- Added dependency check to ensure ASM loading in environments like NPM as well as in the browser
- Properly deleted
webgl
textures on removal ofTwo.Path
- Added support for
two.interpret
to importsvg
's Elliptical Arcs - Added
Two.ArcSegment
andTwo.SineRing
as new shapes invoked likeTwo.Path
@chrisdelbuck - Added
Two.Line
,Two.Rectangle
,Two.RoundedRectangle
,Two.Ellipse
,Two.Polygon
, andTwo.Star
as new shapes invoked likeTwo.Path
- Breaking: renamed
Two.Polygon
toTwo.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 fromTwo.Collection
effectively making it an array instead of a map Leo Koppelkamm- The map can still be accessed at
Two.Group.children.ids
- The map can still be accessed at
v0.4.0
July 22, 2014- Updated
Two.interpret
to handle polybezier path data - Added
Two.Group.mask
andTwo.Polygon.clip
in order to create clipping masks Two.Group
has ownopacity
property Leo Koppelkamm- Rendering optimizations Leo Koppelkamm
Two.noConflict
non-destructive command internally to the libraryTwo.interpret
decomposestransform
attribute of source tagTwo.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
andTwo.Group.getByClassName
methods for convenient selection Leo Koppelkamm - Added
classList
to allTwo.Shape
s 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 andTwo.Polygon._updateLength
method to calculate length of curve/line - Updated
Two.Group.prototype
observable properties onTwo.Polygon.Properties
to ensure each property is considered unique Two.Polygon.vertices
first and last vertex create automated control points whenTwo.Polygon.curved = true
- Updated
Two.Polygon.subdivide
method to accommodateTwo.makeEllipse
- Enabled
id
to be properly interpreted from SVG elements @chrisdelbuck - Updated
webgl
renderergetBoundingClientRect
to accommodaterelative
anchors - Updated
beginning
andending
to clamp to each other - Reorganized
Two.Polygon._update
andTwo.Polygon.plot
in order to handlebeginning
andending
properties - Updated
Two.getComputedMatrix
andTwo.Polygon.getBoundingClientRect
to adhere to nested transformations - Updated
Two.Anchor
to changecontrol
points relatively by default throughanchor.relative
property - Updated
Two.Polygon.subdivide
method to accommodatecurved = false
circumstances - Updated
svg
,canvas
, andwebgl
renderers to properly reflect holes in curvedTwo.Polygon
s - Updated
Two.Group
clone
method - Added
toObject
method toTwo.Group
,Two.Polygon
,Two.Anchor
Two.Polygon
initializespolygon.cap = 'butt'
andpolygon.join = 'miter'
based on Adobe Illustrator defaultsTwo.Polygon.subdivide
method now works withTwo.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
andflagReset
methods toTwo.Shape
,Two.Group
, andTwo.Polygon
- Decoupled
canvas
andwebgl
renderers and are now independent - Added
_matrix.manual
to override the default behavior of aTwo.Polygon
transformation - Localized variables per file as much as possible to reduce Garbage Collection on runtime
v0.3.0
October 25, 2013- Can properly pass
domElement
on construction of new instance of two - Added
overdraw
boolean towebgl
renderer @arodic - Added support for ie9 svg interpretation @tomconroy
- Added
subdivide
method forTwo.Polygon
andTwo.Group
- Ensure sure that
manual
properly is set on construction ofTwo.Polygon
that it bindsTwo.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 thatpolygon.vertices
inherit @fchasen - Added
Two.Events.insert
andTwo.Events.remove
for use withTwo.Utils.Collection
- Properly recurses
getBoundingClientRect
for bothTwo.Group
andTwo.Polygon
- Added
Two.Version
to clarify forthcoming builds - Updated hierarchy ordering of
group.children
incanvas
andwebgl
renderers - Updated shallow and bidirectional
remove
method forTwo.Group
andTwo.Polygon
- Added
corner
method toTwo.Group
andTwo.Polygon
allowing anchoring along the upper lefthand corner of the form - Modified
center
method ofTwo.Group
andTwo.Polygon
to not affect thetranslation
property to stay inline withcorner
method and any future orientation and anchoring logic - Added automatic High DPI support for
canvas
renderer - Added
overdraw
boolean tocanvas
renderer - Added AMD loader compatibility @thomasrudin
- Deferred
two.update();
to account for canvas and webgl - Added
remove
andclear
methods totwo
instance - Updated svg interpretation for
webgl
context Added matrix property to allTwo.Shape
's for advanced transformations- Added
inverse
method toTwo.Matrix
- Remove execution path dependency on utils/build.js @masonblier
- Added
timeDelta
property to everytwo
instance - Added gruntfile, package.json for more integration with
npm
, and dependency free build (build/two.clean.js
) @iros - Crossbrowser compatibility with
noStroke
andnoFill
commands
v0.2.0
May 3, 2013- First alpha release
v0.1.0-alpha
Jan 29, 2013- Proof of Concept built from Three.js