scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2025-01-03 19:45:44 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Write documentation for Item#anchor.

Browse source
This commit is contained in:
Jürg Lehni 2013-12-11 16:23:30 +01:00
parent 42788a5bf7
commit 97f7204eab
1 changed files with 18 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
src/item/Item.js
View file

@ -726,8 +726,9 @@ var Item = Base.extend(Callback, /** @lends Item# */{
/**
* {@grouptitle Position and Bounding Boxes}
*
* The item's position within the project. This is the
* {@link Rectangle#center} of the item's {@link #bounds} rectangle.
* The item's position within the parent item's coordinate system. By
* default, this is the {@link Rectangle#center} of the item's
* {@link #bounds} rectangle.
*
* @type Point
* @bean
@ -788,8 +789,19 @@ var Item = Base.extend(Callback, /** @lends Item# */{
this.translate(Point.read(arguments).subtract(this.getPosition(true)));
},
_anchor: null,
/**
* The item's anchor point specified in the item coordinate system, defining
* the reference point for {@link #position}, as well as the pivot point for
* all transformations. By default, it is set to {@code null}, meaning the
* {@link Rectangle#center} of the item's {@link #bounds} rectangle is used
* as the anchor.
*
* @type Point
* @bean
* @default null
*
* @example {@paperscript}
*/
getAnchor: function(/* dontLink */) {
var anchor = this._anchor;
if (anchor) {
@ -805,6 +817,8 @@ var Item = Base.extend(Callback, /** @lends Item# */{
delete this._position;
},
_anchor: null,
// TODO: Keep these around for a bit since it was introduced on the mailing
// list, then remove in a while.
getRegistration: '#getAnchor',