Releases: paperjs/paper.js
v0.11.0
Changed
- Separate
paper
module on NPM into:paper
,paper-jsdom
and
paper-jsdom-canvas
(#1252):paper
is the main library, and can be used directly in a browser
context, e.g. a web browser or worker.paper-jsdom
is a shim module for Node.js, offering headless use with SVG
importing and exporting through jsdom.paper-jsdom-canvas
is a shim module for Node.js, offering canvas
rendering through Node-Canvas
as well as SVG importing and exporting through
jsdom.
Added
- PaperScript: Support newer, external versions of Acorn.js for PaperScript
parsing, opening the doors to ES 2015 (#1183, #1275). - Hit Tests: Implement
options.position
to hitItem#position
(#1249). - Split
Item#copyTo()
into#addTo()
and#copyTo()
.
Fixed
- Intersections: Bring back special handling of curve end-points (#1284).
- Intersections: Correctly handle
Item#applyMatrix = false
(#1289). - Boolean: Bring back on-path winding handling (#1281).
- Boolean: Pass on options in
PathItem#subtract(path, options)
(#1221). - Boolean: Implement
options.trace
as a way to perform boolean operations on
the strokes / traces instead of the fills / areas of the involved paths
(#1221). - Boolean: Always return `CompoundPath items (#1221).
- Style: Fix handling of gradient matrices when
Item#applyMatrix = false
(#1238). - Style: Prevent cleaning pre-existing styles when setting
Item#style
to an
object (#1277). - Mouse Events: Only handle dragItem if the hitItem responds to
mousedrag
events (#1247, #1286). - Bounds: Clear parent's bounds cache when item's visibility changes (#1248).
- Bounds: Fix calculation of internal bounds with children and
Item#applyMatrix = false
(#1250). - Hit-Tests: Fix issue with non-invertible matrices ( #1271).
- SVG Import: Improve handling of sizes in percent (#1242).
- Rectangle: Improve handling of dimension properties, dealing better with
left
/top
/right
/bottom
/center
values (#1147). - Scene Graph: Do not allow inserting same item as child multiple times.
- Path: Fix handling of
insert = false
innew Path.Constructor()
initialization (#1305). - PaperScript: Fix positive unary operator.
- Docs: Fix parameter sequence in Matrix constructor (#1273).
- Docs: Add documentation for options.bound and options.matrix in
#exportSVG()
(#1254). - Docs: Fix wrong
@link
references to bean properties.
v0.10.3
Changed
- Node.js: Support v7, and keep testing v4 up to v7 in Travis CI.
- Node.js: Loosely couple Node.js / Electron code to
Canvas
module, and treat
its absence like a headless web worker context in the browser (#1103). - Clean up handling of
Item#_set()
,#set()
and#initialize()
:- Use
#_set()
for actually setting internal properties, e.g. onPoint
,
Size
, so that derived classes can reuse other parts without having to
override each individual function (e.g. inSegmentPoint
) - Define
#set()
as a shortcut to#initialize()
on all basic types, to
offer the same amount of flexibility when setting values, accepting object
literals as well as lists of value arguments.
- Use
- SVG Export: Add support for shorter
h
/v
commands for horizontal /
vertical lines in SVG output. - JSON Import / Export: Implement new and shorter segments array notation:
- Close paths by including
true
as the last entry - Allow nested segment arrays to be passed to
PathItem.create()
as well as
theCompoundPath
constructor to create all sub-paths.
- Close paths by including
- Reflect
View#zoom
andView#center
through matrix decomposition, and
implement additional decomposed properties such as#scaling
and#rotation
. - Reduce various internal epsilon values for general improved precision while
maintaining reliability. - Split
PathItem#resolveCrossings()
into#resolveCrossings()
and
#reorient()
(#973).
Added
- Implement
Path#divideAt(location)
, in analogy toCurve#divideAt(location)
. - Add
PathItem#compare()
as a way to compare the geometry of two paths to see
if they describe the same shape, handling cases where paths start in different
segments or use different amounts of curves to describe the same shape. - Implement
Curve#hasLength()
as an optimized check for curve-length (#1109). - Implement
Curve#classify()
to determine the type of cubic Bézier curve via
discriminant classification, based on an approach described by Loop and Blinn,
and use it to simplify curve self-intersection handling (#773, #1074, #1235). - Add
Curve.getPeaks()
as a fast way to retrieve points that are often similar
to the more costly curvature extrema for use in curve offsetting. - Expose
Curve. getCurveLineIntersections()
for use in curve offsetting. - Add
Line.getDistance()
and use it inCurve.getOverlaps()
(#1253). - Implement
Segment#isSmooth()
and use it in handling of stroke-joins. - Bring back caching of
Item#rotation
and#scaling
, but only allow matrix
decomposition-based properties on items with#applyMatrix = false
(#1004, #1177).
Fixed
- Many improvements to boolean operations:
- Improve performance of boolean operations when there no actual crossings
between the paths, but paths may be contained within each other. - Improve path tracing approach by implementing a branching structure and
sorting segments according to their reliability as starting points for
traces (#1073). - Improve calculation and reliability of winding contributions.
- Improve code that resolves crossings and reorients compound-paths based
on how the sub-paths are nested. - Fix issue where unite operation wrongly fills inner path (#1075).
- Better handle cases where one
Path
is open and the other closed (#1089). - Solve
null
exceptions during complex boolean operations (#1091). - Improve bidirectional curve-time rescaling in
divideLocations()
(#1191). - Improve handling of intersections between touching curves (#1165).
- Improve reliability of
Curve#getIntersections()
(#1174). - Fix
getOverlaps()
to always return overlaps in correct sequence (#1223). - Improve handling of multiple crossings on the same curve.
- Improve performance of boolean operations when there no actual crossings
- Improve tangent direction handling in
CurveLocation#isCrossing()
, by finding
unambiguous vectors, taking the curve's loop, cusp, inflection, and "peak"
points into account (#1073, #1074). - Prevent
Path#getStrokeBounds(matrix)
from accidentally modifying segments
(#1102). - Improve compatibility with JSPM (#1104).
- SVG Import: Correctly handle multiple sequential move commands (#1134).
- SVG Export: Properly handle generated IDs (#1138).
- SVG Export: Support multiple gradient offsets at 0 (#1241).
- Fix imprecision in
Numerical.findRoot()
(#1149). - PaperScript: Prevent invalid JavaScript in assignment operators (#1151).
- Hit Tests: Improve handling of SymbolItem in#hitTestAll() (#1199).
- Hit Tests: Fix stroke hit-testing for rounded shape items (#1207).
- Fix matrix cloning for groups with
#applyMatrix = false
( #1225). - Correctly handle offset in
Curve#divideAt(offset)
(#1230). - Fix issue with
Curve#isStraight()
where handles were checked incorrectly
for collinearity (#1269). - Fix
Line#getSide()
imprecisions when points are on the line. - Docs: Fix documentation of
Project#hitTestAll()
(#536). - Docs: Improve description of
option.class
value inProject#hitTest()
(#632).
Removed
- Remove
Numerical.TOLERANCE = 1e-6
as there is no internal use for it
anymore.
v0.10.2
v0.10.1
v0.10.0
Preamble
This is a huge release for Paper.js as we aim for a version 1.0.0
release
later this year. As of this version, all notable changes are documented in the
change-log following common CHANGELOG conventions.
Paper.js now also adheres to Semantic Versioning.
There are many items in the changelog (and many more items not in the changelog)
so here a high-level overview to frame the long list of changes:
-
Boolean operations have been improved and overhauled for reliability and
efficiency. These include the path functions to unite, intersect, subtract,
exclude, and divide with another path. -
There was a large amount of work implementing test coverage under QUnit.
-
Mouse and key handling has been re-engineered and extended to work with view.
Many outstanding bugs have been fixed with mouse and key handling. -
Many SVG-handling enhancements and bug-fixes, including handling browser-
specific interpretations of the SVG standard, have been added. -
There are API name changes for more consistency as well as some required by
changes in the EcmaScript 6 standard (e.g.,Symbol
→SymbolDefinition
). -
Even though it is not new, since version
0.9.22
Paper.js no longer resizes
the canvas to match the view. The canvas must be resized independently.
Thank you all for using Paper.js, submitting bugs and ideas, and all those that
contribute to the code.
Changed
- Significant overhaul and improvements of boolean path operations
PathItem#unite()
,#subtract()
,#intersect()
,#exclude()
,#divide()
:- Improve handling of self-intersecting paths and non-zero fill-rules.
- Handle operations on identical paths.
- Improve handling of near-collinear lines.
- Handle self-intersecting paths that merely "touch" themselves.
- Handle situations where all encountered intersections are part of overlaps.
- Methods that accepted a
time
parameter or boolean second parameter causing
the argument to be interpreted as curve-time instead of offset are now
separate functions with distinct names (#563):Curve#getNormalAt(time, true)
→#getNormalAtTime(true)
Curve#divide()
→#divideAt(offset)
/#divideAtTime(time)
Curve#split()
→#splitAt(offset)
/#splitAtTime(time)
Curve#getParameterAt(offset)
→#getTimeAt(offset)
Curve#getParameterOf(point)
→getTimeOf(point)
Curve#getPointAt(time, true)
→#getPointAtTime(time)
Curve#getTangentAt(time, true)
→#getTangenttTime(time)
Curve#getNormalAt(time, true)
→#getNormalAtTime(time)
Curve#getCurvatureAt(time, true)
→#getCurvatureAtTime(time)
CurveLocation#parameter
→#time
Path#split(offset/location)
→#splitAt(offset/location)
- Significant improvement of reliability of bezier fat-line clipping code in
PathItem#getIntersections()
and#getCrossings()
. PathItem#smooth()
now accepts anoptions.type
string specifying which
smoothing algorithm to use:'asymmetric'
(default),'continuous'
,
'catmull-rom'
, and'geometric'
(#338).PathItem#flatten()
: argument has been changed fromtolerance
(maximum
allowed distance between points) toflatness
(maximum allowed error) (#618).- Update internal Acorn JavaScript parser to
0.5.0
, the last small version. - Transition to Gulp based build process.
- Update QUnit to
1.20.0
. - Update to JSDOM
8.3.0
, to benefit from integrated image and canvas support. - Complete refactoring of keyboard event handling to increase reliably when
handling special keys. - Complete refactoring of mouse-event handling on item and view, to better
handle event propagation, default behavior andItem#removeOn()
calls. - Simplify and streamline the mouse-handling code on
Tool
(#595). - Mouse handlers can to return
false
to callevent.stop()
, stopping event
propagation and prevent the default browser behavior. event.preventDefault()
is called by default after any handled mouse mouse
events, except'mousemove'
, and only on a'mousedown'
event if the view
or tool respond to'mouseup'
.- Switch to the new HTML5 Page Visibility API when detecting invisible documents
and canvases. - Rename
#windingRule
to#fillRule
onItem
andStyle
. - Do not replace existing named child reference on
Item#children
with new one
when the name is identical. - Limit the effects of
#strokeScaling
toPathItem
andShape
(#721). - Throw an exception if arguments to
#smooth()
are segments or curves from
incorrect paths. - Rename
Matrix#concatenate()
to#append()
andpreConcatenate()
to
#prepend()
. - Make
Matrix#shiftless()
and#orNullIfIdentity()
internal functions. - De-bounce internal
View#update()
calls to minimize the number of times a
canvas is redrawn (#830, #925). Symbol
now clashes with ES6 definition of Symbol and has been changed
(#770):Symbol
→SymbolDefinition
PlacedSymbol
→SymbolItem
Symbol#definition
→SymbolDefinition#item
PlacedSymbol#symbol
→SymbolItem#definition
- Don't serialize deprecated
Style#font
property. - Don't serialize text-styles in non-text items (#934).
- Changed argument
parameter
totime
for Postscript-style drawing commands. Item#clone()
: optional argument is now an options object with defaults
{insert: true, deep: true}
.insert
controls whether the clone is inserted
into the project anddeep
controls whether the item's children are cloned.
The previous boolean optional argument is still interpreted as theinsert
option (#941).Matrix
properties#b
and#c
have been reversed to match common standard.#importSVG()
: improve handling of style inheritance for nested<defs>
.- Move
PaperScript#execute()
URL argument intooptions.url
(#902). - PaperScript: Only translate
==
toequals() calls for
Point,
Sizeand
Color` (#1043).
Added
- Use unified code-base for browsers, Node.js, Electron, and anything
in-between, and enable npm install for browser use (#739). - Start using automatic code testing and deployment of prebuilt versions through
Travis CI. - Reach JSHint compliance and include regular linting in Travis CI tests.
- Use QUnit tests for leaked globals.
- Define code format standards in .editorconfig file
- Add support for running without a canvas for Web Workers, Node.js
(#561, #582, #634). - Add support for all common mouse events to
View
. - Add support for
'keydown'
and'keyup'
events toView
(#896). - Add
View#requestUpdate()
function to minimize number of actual canvas
redraw. - Add
View#matrix
to allow matrix transformation to be accessed and modified
directly on the view (#832). - Multiple additions to SVG export (
#exportSVG()
):- Support
{ precision: value }
option. - Support
#fillRule
through the SVGfill-rule
attribute. - Support
#blendMode
through the CSSmix-blend-mode
attribute.
- Support
- Various additions to
#getItems()
onProject
andItem
:- Add support for
{ recursive: false }
as a way to prevent iterating over
all children of children. - Add support for
{ match: function() {} }
, so the match function can be
passed in combination with other options.
- Add support for
- Add
Item#copyAttributes()
andItem#copyContent()
, and use them in
Item#clone()
. - Add optional
insert
boolean argument toPath#toShape()
,Shape#toPath()
,
Item#rasterize()
. Default is to insert, set tofalse
to prevent the
created item from being inserted into the scene graph. - Add visual item comparison to QUnit, through rasterization and Resemble.js
diffing. - Add many unit tests for known edge cases in boolean operations and curve
intersections. - Add
Project#addLayer()
andProject#insertLayer()
(#903). - Layers may now be given names and be accessed through
project.layers[name]
(#491). - Add
Matrix#prepended()
and#appended()
to return copies of the modified
matrix. Shape#hitTest()
: Add boolean optionoptions.stroke
(#911).- Insert version number into docs.
- Support
Raster#onLoad()
events onRaster#setImage()
now (#924). - Add
Raster#onError()
event support (#849). - Allow the control of automatic updating of the canvas through
View#autoUpdate
(default:true
)(#921). - Set
1px
defaultstrokeWidth
for SVG imports to fix IE/Edge default (#467). ImportSVG()
passes imported SVG data toonLoad
callback as second
parameter.- Add
#interpolate
forSegment
,Path
, andCompoundPath
(#624). - Implement
CompoundPath#flatten()
,#simplify()
,#smooth()
(#727). - Implement
#hitTestAll()
to return all items that were hit (#536). #importSVG()
implementsoption.onError
callback (#969).settings.insertItems
controls whether newly created items are inserted or
not (default:true
).- Add
#importSVG()
option.insert
(default:true
) to control insertion
(#763). - Add new options to
#exportSVG()
to control output bounds and transformation
matrix (#972). - Allow
Item#position
to be selected viaItem#position.selected
(#980). - Add
tolerance
argument toPath#join(path, tolerance)
. - Add
Curve#getOffsetAtTime(time)
, as the reverse of
Curve#getTimeAt(offset)
. - Add
Raster#loaded
to reflect the loading state of its image.
Fixed
- Fix calculations of
Item#strokeBounds
for all possible combinations of
Item#strokeScaling
andItem#applyMatrix
forPath
,Shape
and
SymbolItem
, along with correct handling of such strokes in Item#hitTest()
(#697, #856, #1014). - Make new code-base unified for Node.js/browser work with module bundlers like
Webpack (#986). - Improve hit-testing and
#contains()
checks on path with horizontal l...