/*

* Paper.js - The Swiss Army Knife of Vector Graphics Scripting.

* http://paperjs.org/

*

* Copyright (c) 2011 - 2013, Juerg Lehni & Jonathan Puckey

* http://lehni.org/ & http://jonathanpuckey.com/

*

* Distributed under the MIT license. See LICENSE file for details.

*

* All rights reserved.

*/

/**

* @name PlacedSymbol

*

* @class A PlacedSymbol represents an instance of a symbol which has been

* placed in a Paper.js project.

*

* @extends Item

*/

var PlacedSymbol = Item.extend(/** @lends PlacedSymbol# */{

_class: 'PlacedSymbol',

_transformContent: false,

// PlacedSymbol uses strokeBounds for bounds

_boundsGetter: { getBounds: 'getStrokeBounds' },

_boundsSelected: true,

_serializeFields: {

symbol: null

},

/**

* Creates a new PlacedSymbol Item.

*

* @param {Symbol} symbol the symbol to place

* @param {Point} [point] the center point of the placed symbol

*

* @example {@paperscript split=true height=240}

* // Placing 100 instances of a symbol:

* // Create a star shaped path at {x: 0, y: 0}:

* var path = new Path.Star({

* center: new Point(0, 0),

* points: 6,

* radius1: 5,

* radius2: 13,

* fillColor: 'white',

* strokeColor: 'black'

* });

*

* // Create a symbol from the path:

* var symbol = new Symbol(path);

*

* // Remove the path:

* path.remove();

*

* // Place 100 instances of the symbol:

* for (var i = 0; i < 100; i++) {

* // Place an instance of the symbol in the project:

* var instance = new PlacedSymbol(symbol);

*

* // Move the instance to a random position within the view:

* instance.position = Point.random() * view.size;

*

* // Rotate the instance by a random amount between

* // 0 and 360 degrees:

* instance.rotate(Math.random() * 360);

*

* // Scale the instance between 0.25 and 1:

* instance.scale(0.25 + Math.random() * 0.75);

* }

*/

initialize: function PlacedSymbol(arg0, arg1) {

// Support two forms of item initialization: Passing one object literal

// describing all the different properties to be set, or a symbol (arg0)

// and a point where it should be placed (arg1).

// If _initialize can set properties through object literal, we're done.

// Otherwise we need to set symbol from arg0.

if (!this._initialize(arg0,

arg1 !== undefined && Point.read(arguments, 1)))

this.setSymbol(arg0 instanceof Symbol ? arg0 : new Symbol(arg0));

},

_equals: function(item) {

return this._symbol === item._symbol;

},

/**

* The symbol that the placed symbol refers to.

*

* @type Symbol

* @bean

*/

getSymbol: function() {

return this._symbol;

},

setSymbol: function(symbol) {

// Remove from previous symbol's instances

if (this._symbol)

delete this._symbol._instances[this._id];

this._symbol = symbol;

// Add to the new one's

symbol._instances[this._id] = this;

},

clone: function(insert) {

return this._clone(new PlacedSymbol({

symbol: this.symbol,

insert: false

}), insert);

},

isEmpty: function() {

return this._symbol._definition.isEmpty();

},

_getBounds: function(getter, matrix) {

// Redirect the call to the symbol definition to calculate the bounds

// TODO: Implement bounds caching through passing on of cacheItem, so

// that Symbol#_changed() notification become unnecessary!

return this.symbol._definition._getCachedBounds(getter, matrix);

},

_hitTest: function(point, options, matrix) {

var result = this._symbol._definition._hitTest(point, options, matrix);

// TODO: When the symbol's definition is a path, should hitResult

// contain information like HitResult#curve?

if (result)

result.item = this;

return result;

},

_draw: function(ctx, param) {

this.symbol._definition.draw(ctx, param);

}

// TODO: PlacedSymbol#embed()

});