mirror of
https://github.com/scratchfoundation/paper.js.git
synced 2025-01-09 22:32:48 -05:00
481 lines
15 KiB
JavaScript
481 lines
15 KiB
JavaScript
/*
|
||
* Paper.js - The Swiss Army Knife of Vector Graphics Scripting.
|
||
* http://paperjs.org/
|
||
*
|
||
* Copyright (c) 2011 - 2014, Juerg Lehni & Jonathan Puckey
|
||
* http://scratchdisk.com/ & http://jonathanpuckey.com/
|
||
*
|
||
* Distributed under the MIT license. See LICENSE file for details.
|
||
*
|
||
* All rights reserved.
|
||
*/
|
||
|
||
/**
|
||
* @name Project
|
||
*
|
||
* @class A Project object in Paper.js is what usually is referred to as the
|
||
* document: The top level object that holds all the items contained in the
|
||
* scene graph. As the term document is already taken in the browser context,
|
||
* it is called Project.
|
||
*
|
||
* Projects allow the manipluation of the styles that are applied to all newly
|
||
* created items, give access to the selected items, and will in future versions
|
||
* offer ways to query for items in the scene graph defining specific
|
||
* requirements, and means to persist and load from different formats, such as
|
||
* SVG and PDF.
|
||
*
|
||
* The currently active project can be accessed through the
|
||
* {@link PaperScope#project} variable.
|
||
*
|
||
* An array of all open projects is accessible through the
|
||
* {@link PaperScope#projects} variable.
|
||
*/
|
||
var Project = PaperScopeItem.extend(/** @lends Project# */{
|
||
_class: 'Project',
|
||
_list: 'projects',
|
||
_reference: 'project',
|
||
|
||
// TODO: Add arguments to define pages
|
||
/**
|
||
* Creates a Paper.js project containing one empty {@link Layer}, referenced
|
||
* by {@link Project#activeLayer}.
|
||
*
|
||
* Note that when working with PaperScript, a project is automatically
|
||
* created for us and the {@link PaperScope#project} variable points to it.
|
||
*
|
||
* @param {HTMLCanvasElement} element an HTML anvas element that should be
|
||
* used as the element for the view.
|
||
*/
|
||
initialize: function Project(element) {
|
||
// Activate straight away by passing true to PaperScopeItem constructor,
|
||
// so paper.project is set, as required by Layer and DoumentView
|
||
// constructors.
|
||
PaperScopeItem.call(this, true);
|
||
this.layers = [];
|
||
this.symbols = [];
|
||
this._currentStyle = new Style(null, null, this);
|
||
this.activeLayer = new Layer();
|
||
// If no view is provided, we create a 1x1 px canvas view just so we
|
||
// have something to do size calculations with.
|
||
// (e.g. PointText#_getBounds)
|
||
this._view = View.create(this,
|
||
element || CanvasProvider.getCanvas(1, 1));
|
||
this._selectedItems = {};
|
||
this._selectedItemCount = 0;
|
||
// See Item#draw() for an explanation of _updateVersion
|
||
this._updateVersion = 0;
|
||
// Change tracking, not in use for now. Activate once required:
|
||
// this._changes = [];
|
||
// this._changesById = {};
|
||
},
|
||
|
||
_serialize: function(options, dictionary) {
|
||
// Just serialize layers to an array for now, they will be unserialized
|
||
// into the active project automatically. We might want to add proper
|
||
// project serialization later, but deserialization of a layers array
|
||
// will always work.
|
||
// Pass true for compact, so 'Project' does not get added as the class
|
||
return Base.serialize(this.layers, options, true, dictionary);
|
||
},
|
||
|
||
/**
|
||
* Activates this project, so all newly created items will be placed
|
||
* in it.
|
||
*
|
||
* @name Project#activate
|
||
* @function
|
||
*/
|
||
|
||
// DOCS: Project#clear()
|
||
|
||
clear: function() {
|
||
for (var i = this.layers.length - 1; i >= 0; i--)
|
||
this.layers[i].remove();
|
||
this.symbols = [];
|
||
},
|
||
|
||
/**
|
||
* Specifies whether the project has any content or not. Note that since
|
||
* projects by default are created with one empty layer, this returns alos
|
||
* {@code true} if that layer exists but is itself empty.
|
||
*
|
||
* @return Boolean
|
||
*/
|
||
isEmpty: function() {
|
||
return this.layers.length <= 1
|
||
&& (!this.activeLayer || this.activeLayer.isEmpty());
|
||
},
|
||
|
||
/**
|
||
* Removes this project from the {@link PaperScope#projects} list, and also
|
||
* removes its view, if one was defined.
|
||
*/
|
||
remove: function remove() {
|
||
if (!remove.base.call(this))
|
||
return false;
|
||
if (this._view)
|
||
this._view.remove();
|
||
return true;
|
||
},
|
||
|
||
/**
|
||
* The reference to the project's view.
|
||
* @name Project#view
|
||
* @type View
|
||
* @bean
|
||
*/
|
||
getView: function() {
|
||
return this._view;
|
||
},
|
||
|
||
/**
|
||
* The currently active path style. All selected items and newly
|
||
* created items will be styled with this style.
|
||
*
|
||
* @type Style
|
||
* @bean
|
||
*
|
||
* @example {@paperscript}
|
||
* project.currentStyle = {
|
||
* fillColor: 'red',
|
||
* strokeColor: 'black',
|
||
* strokeWidth: 5
|
||
* }
|
||
*
|
||
* // The following paths will take over all style properties of
|
||
* // the current style:
|
||
* var path = new Path.Circle(new Point(75, 50), 30);
|
||
* var path2 = new Path.Circle(new Point(175, 50), 20);
|
||
*
|
||
* @example {@paperscript}
|
||
* project.currentStyle.fillColor = 'red';
|
||
*
|
||
* // The following path will take over the fill color we just set:
|
||
* var path = new Path.Circle(new Point(75, 50), 30);
|
||
* var path2 = new Path.Circle(new Point(175, 50), 20);
|
||
*/
|
||
getCurrentStyle: function() {
|
||
return this._currentStyle;
|
||
},
|
||
|
||
setCurrentStyle: function(style) {
|
||
// TODO: Style selected items with the style:
|
||
this._currentStyle.initialize(style);
|
||
},
|
||
|
||
/**
|
||
* The index of the project in the {@link PaperScope#projects} list.
|
||
*
|
||
* @type Number
|
||
* @bean
|
||
*/
|
||
getIndex: function() {
|
||
return this._index;
|
||
},
|
||
|
||
// Helper function used in Item#copyTo and Layer#initialize
|
||
// It's called the same as Item#addChild so Item#copyTo does not need to
|
||
// make the distinction.
|
||
// TODO: Consider private function with alias in Item?
|
||
addChild: function(child) {
|
||
if (child instanceof Layer) {
|
||
Base.splice(this.layers, [child]);
|
||
// Also activate this layer if there was none before
|
||
if (!this.activeLayer)
|
||
this.activeLayer = child;
|
||
} else if (child instanceof Item) {
|
||
// Anything else than layers needs to be added to a layer first
|
||
(this.activeLayer
|
||
// NOTE: If there is no layer and this project is not the active
|
||
// one, passing insert: false and calling addChild on the
|
||
// project will handle it correctly.
|
||
|| this.addChild(new Layer(Item.NO_INSERT))).addChild(child);
|
||
} else {
|
||
child = null;
|
||
}
|
||
return child;
|
||
},
|
||
|
||
/**
|
||
* The selected items contained within the project.
|
||
*
|
||
* @type Item[]
|
||
* @bean
|
||
*/
|
||
getSelectedItems: function() {
|
||
// TODO: Return groups if their children are all selected,
|
||
// and filter out their children from the list.
|
||
// TODO: The order of these items should be that of their
|
||
// drawing order.
|
||
var items = [];
|
||
for (var id in this._selectedItems) {
|
||
var item = this._selectedItems[id];
|
||
if (item.isInserted())
|
||
items.push(item);
|
||
}
|
||
return items;
|
||
},
|
||
|
||
/**
|
||
* Gives access to the project's configurable options.
|
||
*
|
||
* @type Object
|
||
* @bean
|
||
* @deprecated use {@link PaperScope#settings} instead.
|
||
*/
|
||
getOptions: function() {
|
||
return this._scope.settings;
|
||
},
|
||
|
||
// TODO: Implement setSelectedItems?
|
||
_updateSelection: function(item) {
|
||
var id = item._id,
|
||
selectedItems = this._selectedItems;
|
||
if (item._selected) {
|
||
if (selectedItems[id] !== item) {
|
||
this._selectedItemCount++;
|
||
selectedItems[id] = item;
|
||
}
|
||
} else if (selectedItems[id] === item) {
|
||
this._selectedItemCount--;
|
||
delete selectedItems[id];
|
||
}
|
||
},
|
||
|
||
/**
|
||
* Selects all items in the project.
|
||
*/
|
||
selectAll: function() {
|
||
var layers = this.layers;
|
||
for (var i = 0, l = layers.length; i < l; i++)
|
||
layers[i].setFullySelected(true);
|
||
},
|
||
|
||
/**
|
||
* Deselects all selected items in the project.
|
||
*/
|
||
deselectAll: function() {
|
||
var selectedItems = this._selectedItems;
|
||
for (var i in selectedItems)
|
||
selectedItems[i].setFullySelected(false);
|
||
},
|
||
|
||
/**
|
||
* Perform a hit test on the items contained within the project at the
|
||
* location of the specified point.
|
||
*
|
||
* The options object allows you to control the specifics of the hit test
|
||
* and may contain a combination of the following values:
|
||
* <b>options.tolerance:</b> {@code Number} – the tolerance of the hit test
|
||
* in points, can also be controlled through
|
||
* {@link Project#options}{@code .hitTolerance}.
|
||
* <b>options.type:</b> Only hit test again a certain item type:
|
||
* {@code Group, Layer, Path, CompoundPath, Shape, Raster, PlacedSymbol,
|
||
* PointText}, etc.
|
||
* <b>options.fill:</b> {@code Boolean} – hit test the fill of items.
|
||
* <b>options.stroke:</b> {@code Boolean} – hit test the curves of path
|
||
* items, taking into account stroke width.
|
||
* <b>options.segments:</b> {@code Boolean} – hit test for
|
||
* {@link Segment#point} of {@link Path} items.
|
||
* <b>options.handles:</b> {@code Boolean} – hit test for the handles
|
||
* ({@link Segment#handleIn} / {@link Segment#handleOut}) of path segments.
|
||
* <b>options.ends:</b> {@code Boolean} – only hit test for the first or
|
||
* last segment points of open path items.
|
||
* <b>options.bounds:</b> {@code Boolean} – hit test the corners and
|
||
* side-centers of the bounding rectangle of items ({@link Item#bounds}).
|
||
* <b>options.center:</b> {@code Boolean} – hit test the
|
||
* {@link Rectangle#center} of the bounding rectangle of items
|
||
* ({@link Item#bounds}).
|
||
* <b>options.guides:</b> {@code Boolean} – hit test items that have
|
||
* {@link Item#guide} set to {@code true}.
|
||
* <b>options.selected:</b> {@code Boolean} – only hit selected items.
|
||
*
|
||
* @param {Point} point The point where the hit test should be performed
|
||
* @param {Object} [options={ fill: true, stroke: true, segments: true,
|
||
* tolerance: true }]
|
||
* @return {HitResult} a hit result object that contains more
|
||
* information about what exactly was hit or {@code null} if nothing was
|
||
* hit
|
||
*/
|
||
hitTest: function(/* point, options */) {
|
||
// We don't need to do this here, but it speeds up things since we won't
|
||
// repeatetly convert in Item#hitTest() then.
|
||
var point = Point.read(arguments),
|
||
options = HitResult.getOptions(Base.read(arguments));
|
||
// Loop backwards, so layers that get drawn last are tested first
|
||
for (var i = this.layers.length - 1; i >= 0; i--) {
|
||
var res = this.layers[i].hitTest(point, options);
|
||
if (res) return res;
|
||
}
|
||
return null;
|
||
},
|
||
|
||
// DOCS: Project#getItems
|
||
getItems: function(match) {
|
||
return Item._getItems(this.layers, match, true);
|
||
},
|
||
|
||
// DOCS: Project#getItems
|
||
getItem: function(match) {
|
||
return Item._getItems(this.layers, match, false);
|
||
},
|
||
|
||
/**
|
||
* {@grouptitle Importing / Exporting JSON and SVG}
|
||
*
|
||
* Exports (serializes) the project with all its layers and child items to
|
||
* a JSON data string.
|
||
*
|
||
* The options object offers control over some aspects of the SVG export:
|
||
* <b>options.asString:</b> {@code Boolean} – wether the JSON is returned as
|
||
* a {@code Object} or a {@code String}.
|
||
* <b>options.precision:</b> {@code Number} – the amount of fractional
|
||
* digits in numbers used in JSON data.
|
||
*
|
||
* @name Project#exportJSON
|
||
* @function
|
||
* @param {Object} [options={ asString: true, precision: 5 }] the
|
||
* serialization options
|
||
* @return {String} the exported JSON data
|
||
*/
|
||
|
||
/**
|
||
* Imports (deserializes) the stored JSON data into the project.
|
||
* Note that the project is not cleared first. You can call
|
||
* {@link Project#clear()} to do so.
|
||
*
|
||
* @param {String} json the JSON data to import from.
|
||
*/
|
||
importJSON: function(json) {
|
||
this.activate();
|
||
// Provide the activeLayer as a possible target for layers, but only if
|
||
// it's empty.
|
||
var layer = this.activeLayer;
|
||
return Base.importJSON(json, layer && layer.isEmpty() && layer);
|
||
},
|
||
|
||
/**
|
||
* Exports the project with all its layers and child items as an SVG DOM,
|
||
* all contained in one top level SVG group node.
|
||
*
|
||
* The options object offers control over some aspects of the SVG export:
|
||
* <b>options.asString:</b> {@code Boolean} – wether a SVG node or a
|
||
* {@code String} is to be returned.
|
||
* <b>options.precision:</b> {@code Number} – the amount of fractional
|
||
* digits in numbers used in SVG data.
|
||
* <b>options.matchShapes:</b> {@code Boolean} – wether imported path
|
||
* items should tried to be converted to shape items, if their geometries
|
||
* match.
|
||
*
|
||
* @name Project#exportSVG
|
||
* @function
|
||
* @param {Object} [options={ asString: false, precision: 5,
|
||
* matchShapes: false }] the export options.
|
||
* @return {SVGSVGElement} the project converted to an SVG node
|
||
*/
|
||
|
||
// DOCS: Document importSVG('file.svg', callback);
|
||
/**
|
||
* Converts the provided SVG content into Paper.js items and adds them to
|
||
* the active layer of this project.
|
||
* Note that the project is not cleared first. You can call
|
||
* {@link Project#clear()} to do so.
|
||
*
|
||
* The options object offers control over some aspects of the SVG import:
|
||
* <b>options.expandShapes:</b> {@code Boolean} – wether imported shape
|
||
* items should be expanded to path items.
|
||
*
|
||
* @name Project#importSVG
|
||
* @function
|
||
* @param {SVGSVGElement|String} svg the SVG content to import
|
||
* @param {Object} [options={ expandShapes: false }] the import options
|
||
* @return {Item} the imported Paper.js parent item
|
||
*/
|
||
|
||
/**
|
||
* {@grouptitle Project Hierarchy}
|
||
*
|
||
* The layers contained within the project.
|
||
*
|
||
* @name Project#layers
|
||
* @type Layer[]
|
||
*/
|
||
|
||
/**
|
||
* The layer which is currently active. New items will be created on this
|
||
* layer by default.
|
||
*
|
||
* @name Project#activeLayer
|
||
* @type Layer
|
||
*/
|
||
|
||
/**
|
||
* The symbols contained within the project.
|
||
*
|
||
* @name Project#symbols
|
||
* @type Symbol[]
|
||
*/
|
||
|
||
draw: function(ctx, matrix, pixelRatio) {
|
||
// Increase the _updateVersion before the draw-loop. After that, items
|
||
// that are visible will have their _updateVersion set to the new value.
|
||
this._updateVersion++;
|
||
ctx.save();
|
||
matrix.applyToContext(ctx);
|
||
// Use new Base() so we can use param.extend() to easily override
|
||
// values
|
||
var param = new Base({
|
||
offset: new Point(0, 0),
|
||
pixelRatio: pixelRatio,
|
||
// Tell the drawing routine that we want to track nested matrices
|
||
// in param.transforms, and that we want it to set _globalMatrix
|
||
// as used below. Item#rasterize() and Raster#getAverageColor() do
|
||
// not need to set this.
|
||
trackTransforms: true
|
||
});
|
||
for (var i = 0, l = this.layers.length; i < l; i++)
|
||
this.layers[i].draw(ctx, param);
|
||
ctx.restore();
|
||
|
||
// Draw the selection of the selected items in the project:
|
||
if (this._selectedItemCount > 0) {
|
||
ctx.save();
|
||
ctx.strokeWidth = 1;
|
||
for (var id in this._selectedItems) {
|
||
var item = this._selectedItems[id],
|
||
globalMatrix = item._globalMatrix,
|
||
size = this._scope.settings.handleSize;
|
||
half = size / 2;
|
||
if (item._updateVersion === this._updateVersion
|
||
&& (item._drawSelected || item._boundsSelected)
|
||
&& globalMatrix) {
|
||
// Allow definition of selected color on a per item and per
|
||
// layer level, with a fallback to #009dec
|
||
var color = item.getSelectedColor()
|
||
|| item.getLayer().getSelectedColor();
|
||
ctx.strokeStyle = ctx.fillStyle = color
|
||
? color.toCanvasStyle(ctx) : '#009dec';
|
||
var mx = matrix.clone().concatenate(globalMatrix);
|
||
if (item._drawSelected)
|
||
item._drawSelected(ctx, mx);
|
||
if (item._boundsSelected) {
|
||
var coords = mx._transformCorners(
|
||
item.getInternalBounds());
|
||
// Now draw a rectangle that connects the transformed
|
||
// bounds corners, and draw the corners.
|
||
ctx.beginPath();
|
||
for (var i = 0; i < 8; i++)
|
||
ctx[i === 0 ? 'moveTo' : 'lineTo'](
|
||
coords[i], coords[++i]);
|
||
ctx.closePath();
|
||
ctx.stroke();
|
||
for (var i = 0; i < 8; i++)
|
||
ctx.fillRect(coords[i] - half, coords[++i] - half,
|
||
size, size);
|
||
}
|
||
}
|
||
}
|
||
ctx.restore();
|
||
}
|
||
}
|
||
});
|