CanvasShape.js revision 9eaaa502227248d304ac9170902697d02158c1d9
/**
* Base class for creating shapes.
*
* @class CanvasShape
*/
var SHAPE = "canvasShape",
AttributeLite = Y.AttributeLite,
PluginHost = Y.Plugin.Host,
CanvasPath,
CanvasRect,
CanvasEllipse,
CanvasCircle,
CanvasShape = function(cfg)
{
var host = this,
PluginHost = Y.Plugin && Y.Plugin.Host;
if (host._initPlugins && PluginHost) {
PluginHost.call(host);
}
host.name = host.constructor.NAME;
host._eventPrefix = host.constructor.EVENT_PREFIX || host.constructor.NAME;
AttributeLite.call(host);
host.addAttrs(cfg);
host.init.apply(this, arguments);
if (host._initPlugins) {
// Need to initPlugins manually, to handle constructor parsing, static Plug parsing
host._initPlugins(cfg);
}
host.initialized = true;
};
CanvasShape.NAME = "canvasShape";
CanvasShape.prototype = Y.merge(Y.CanvasDrawing.prototype, {
init: function()
{
this.initializer.apply(this, arguments);
},
/**
* Initializes the shape
*
* @private
* @method _initialize
*/
initializer: function(cfg)
{
var host = this;
host.createNode();
host._graphic = cfg.graphic;
host._xcoords = [0];
host._ycoords = [0];
/*
host.get("stroke");
host.get("fill");
node.setAttribute("width", host.get("width"));
node.setAttribute("height", host.get("height"));
*/
host._updateHandler();
},
/**
* Add a class name to each node.
*
* @method addClass
* @param {String} className the class name to add to the node's class attribute
*/
addClass: function(className)
{
var node = Y.one(this.get("node"));
node.addClass(className);
},
/**
* Removes a class name from each node.
*
* @method removeClass
* @param {String} className the class name to remove from the node's class attribute
*/
removeClass: function(className)
{
var node = Y.one(this.get("node"));
node.removeClass(className);
},
/**
* Gets the current position of the node in page coordinates.
*
* @method getXY
* @return Array The XY position of the shape.
*/
getXY: function()
{
var graphic = this.get("graphic"),
parentXY = graphic.getXY(),
x = this.get("x"),
y = this.get("y");
return [parentXY[0] + x, parentXY[1] + y];
},
/**
* Set the position of the shape in page coordinates, regardless of how the node is positioned.
*
* @method setXY
* @param {Array} Contains X & Y values for new position (coordinates are page-based)
*/
setXY: function(xy)
{
var graphic = this.get("graphic"),
parentXY = graphic.getXY(),
x = xy[0] - parentXY[0],
y = xy[1] - parentXY[1];
this._set("x", x);
this._set("y", y);
this._updateNodePosition(x, y);
},
/**
* Determines whether the node is an ancestor of another HTML element in the DOM hierarchy.
*
* @method contains
* @param {CanvasShape | HTMLElement} needle The possible node or descendent
* @return Boolean Whether or not this shape is the needle or its ancestor.
*/
contains: function(needle)
{
return needle === Y.one(this.node);
},
/**
* Test if the supplied node matches the supplied selector.
*
* @method test
* @param {String} selector The CSS selector to test against.
* @return Boolean Wheter or not the shape matches the selector.
*/
test: function(selector)
{
return Y.one(this.get("node")).test(selector);
//return Y.Selector.test(this.node, selector);
},
/**
* Compares nodes to determine if they match.
* Node instances can be compared to each other and/or HTMLElements.
* @method compareTo
* @param {HTMLElement | Node} refNode The reference node to compare to the node.
* @return {Boolean} True if the nodes match, false if they do not.
*/
compareTo: function(refNode) {
var node = this.node;
return node === refNode;
},
/**
* Value function for fill attribute
*
* @private
* @method _getDefaultFill
* @return Object
*/
_getDefaultFill: function() {
return {
type: "solid",
cx: 0.5,
cy: 0.5,
fx: 0.5,
fy: 0.5,
r: 0.5
};
},
/**
* Value function for stroke attribute
*
* @private
* @method _getDefaultStroke
* @return Object
*/
_getDefaultStroke: function()
{
return {
weight: 1,
dashstyle: "none",
color: "#000",
opacity: 1.0
};
},
/**
* Left edge of the path
*
* @private
*/
_left: 0,
/**
* Right edge of the path
*
* @private
*/
_right: 0,
/**
* Top edge of the path
*
* @private
*/
_top: 0,
/**
* Bottom edge of the path
*
* @private
*/
_bottom: 0,
/**
* Creates the dom node for the shape.
*
* @private
* @return HTMLElement
*/
createNode: function()
{
var node = Y.config.doc.createElement('canvas'),
id = this.get("id");
this._context = node.getContext('2d');
node.setAttribute("class", "yui3-" + SHAPE);
node.setAttribute("class", "yui3-" + this.name);
node.setAttribute("id", id);
id = "#" + id;
this.node = node;
},
/**
* @private
*/
isMouseEvent: function(type)
{
if(type.indexOf('mouse') > -1 || type.indexOf('click') > -1)
{
return true;
}
return false;
},
/**
* @private
*/
before: function(type, fn)
{
if(this.isMouseEvent(type))
{
return Y.before(type, fn, "#" + this.get("id"));
}
return Y.on.apply(this, arguments);
},
/**
* @private
*/
on: function(type, fn)
{
if(this.isMouseEvent(type))
{
return Y.on(type, fn, "#" + this.get("id"));
}
return Y.on.apply(this, arguments);
},
/**
* @private
*/
after: function(type, fn)
{
if(this.isMouseEvent(type))
{
return Y.after(type, fn, "#" + this.get("id"));
}
return Y.on.apply(this, arguments);
},
/**
* Adds a stroke to the shape node.
*
* @method _strokeChangeHandler
* @private
*/
_setStrokeProps: function(stroke)
{
var color = stroke.color,
weight = stroke.weight,
opacity = stroke.opacity,
linejoin = stroke.linejoin || "round",
linecap = stroke.linecap || "butt",
dashstyle = stroke.dashstyle;
this._miterlimit = null;
this._dashstyle = (dashstyle && Y.Lang.isArray(dashstyle) && dashstyle.length > 1) ? dashstyle : null;
this._strokeWeight = weight;
if (weight)
{
this._stroke = 1;
}
else
{
this._stroke = 0;
}
if (opacity) {
this._strokeStyle = this._2RGBA(color, opacity);
}
else
{
this._strokeStyle = color;
}
this._linecap = linecap;
if(linejoin == "round" || linejoin == "square")
{
this._linejoin = linejoin;
}
else
{
linejoin = parseInt(linejoin, 10);
if(Y.Lang.isNumber(linejoin))
{
this._miterlimit = Math.max(linejoin, 1);
this._linejoin = "miter";
}
}
},
set: function()
{
var host = this,
val = arguments[0];
AttributeLite.prototype.set.apply(host, arguments);
if(host.initialized && val != "x" && val != "y")
{
host._updateHandler();
}
},
/**
* Adds a fill to the shape node.
*
* @method _fillChangeHandler
* @private
*/
_setFillProps: function(fill)
{
var isNumber = Y.Lang.isNumber,
color = fill.color,
opacity,
type = fill.type;
if(type == "linear" || type == "radial")
{
this._fillType = type;
}
else if(color)
{
opacity = fill.opacity;
if (isNumber(opacity))
{
opacity = Math.max(0, Math.min(1, opacity));
color = this._2RGBA(color, opacity);
}
else
{
color = this._2RGB(color);
}
this._fillColor = color;
this._fillType = 'solid';
}
else
{
this._fillColor = null;
}
},
/**
* Applies translate transformation.
*
* @method translate
* @param {Number} x The x-coordinate
* @param {Number} y The y-coordinate
* @protected
*/
translate: function(x, y)
{
var translate = "translate(" + x + "px, " + y + "px)";
this._updateTransform("translate", /translate\(.*\)/, translate);
},
/**
* Applies a skew to the x-coordinate
*
* @method skewX:q
* @param {Number} x x-coordinate
*/
skewX: function(x)
{
},
/**
* Applies a skew to the x-coordinate
*
* @method skewX:q
* @param {Number} x x-coordinate
*/
skewY: function(y)
{
},
/**
* @private
*/
_rotation: 0,
/**
* Applies a rotation.
*
* @method rotate
* @param
*/
rotate: function(deg)
{
var rotate = "rotate(" + deg + "deg)";
this._rotation = deg;
this._updateTransform("rotate", /rotate\(.*\)/, rotate);
},
/**
* An array of x, y values which indicates the transformOrigin in which to rotate the shape. Valid values range between 0 and 1 representing a
* fraction of the shape's corresponding bounding box dimension. The default value is [0.5, 0.5].
*
* @attribute transformOrigin
* @type Array
*/
_transformOrigin: function(x, y)
{
var node = this.get("node");
node.style.MozTransformOrigin = (100 * x) + "% " + (100 * y) + "%";
},
/**
* Applies a scale transform
*
* @method scale
* @param {Number} val
*/
scale: function(val)
{
},
/**
* Applies a matrix transformation
*
* @method matrix
*/
matrix: function(a, b, c, d, e, f)
{
},
/**
* @private
*/
_updateTransform: function(type, test, val)
{
var node = this.get("node"),
transform = node.style.MozTransform || node.style.webkitTransform || node.style.msTransform || node.style.OTransform,
transformOrigin = this.get("transformOrigin");
if(transform && transform.length > 0)
{
if(transform.indexOf(type) > -1)
{
transform = transform.replace(test, val);
}
else
{
transform += " " + val;
}
}
else
{
transform = val;
}
transformOrigin = (100 * transformOrigin[0]) + "% " + (100 * transformOrigin[1]) + "%";
node.style.MozTransformOrigin = transformOrigin;
node.style.webkitTransformOrigin = transformOrigin;
node.style.msTransformOrigin = transformOrigin;
node.style.OTransformOrigin = transformOrigin;
node.style.MozTransform = transform;
node.style.webkitTransform = transform;
node.style.msTransform = transform;
node.style.OTransform = transform;
},
/**
* @private
*/
_updateHandler: function()
{
this._draw();
},
/**
* @private
*/
_draw: function()
{
this._paint();
},
/**
* Completes a shape or drawing
*
* @method _paint
* @private
*/
_paint: function()
{
if(!this._methods)
{
return;
}
var node = this.get("node"),
w = this.get("width") || this._width,
h = this.get("height") || this._height,
context = this._context,
methods = [],
cachedMethods = this._methods.concat(),
i = 0,
j,
method,
args,
len = 0;
this._context.clearRect(0, 0, w, h);
if(this._methods)
{
len = cachedMethods.length;
if(!len || len < 1)
{
return;
}
for(; i < len; ++i)
{
methods[i] = cachedMethods[i].concat();
args = methods[i];
for(j = 1; j < args.length; ++j)
{
if(j % 2 === 0)
{
args[j] = args[j] - this._top;
}
else
{
args[j] = args[j] - this._left;
}
}
}
node.setAttribute("width", w);
node.setAttribute("height", h);
context.beginPath();
for(i = 0; i < len; ++i)
{
args = methods[i].concat();
if(args && args.length > 0)
{
method = args.shift();
if(method)
{
if(method && method == "lineTo" && this._dashstyle)
{
args.unshift(this._xcoords[i] - this._left, this._ycoords[i] - this._top);
this._drawDashedLine.apply(this, args);
}
else
{
context[method].apply(context, args);
}
}
}
}
if (this._fillType)
{
if(this._fillType == "linear")
{
context.fillStyle = this._getLinearGradient();
}
else if(this._fillType == "radial")
{
context.fillStyle = this._getRadialGradient();
}
else
{
context.fillStyle = this._fillColor;
}
context.closePath();
context.fill();
}
if (this._stroke) {
if(this._strokeWeight)
{
context.lineWidth = this._strokeWeight;
}
context.lineCap = this._linecap;
context.lineJoin = this._linejoin;
if(this._miterlimit)
{
context.miterLimit = this._miterlimit;
}
context.strokeStyle = this._strokeStyle;
context.stroke();
}
this._drawingComplete = true;
this._clearAndUpdateCoords();
this._updateNodePosition();
this._methods = cachedMethods;
}
},
/**
* Draws a dashed line between two points.
*
* @method _drawDashedLine
* @param {Number} xStart The x position of the start of the line
* @param {Number} yStart The y position of the start of the line
* @param {Number} xEnd The x position of the end of the line
* @param {Number} yEnd The y position of the end of the line
* @private
*/
_drawDashedLine: function(xStart, yStart, xEnd, yEnd)
{
var context = this._context,
dashsize = this._dashstyle[0],
gapsize = this._dashstyle[1],
segmentLength = dashsize + gapsize,
xDelta = xEnd - xStart,
yDelta = yEnd - yStart,
delta = Math.sqrt(Math.pow(xDelta, 2) + Math.pow(yDelta, 2)),
segmentCount = Math.floor(Math.abs(delta / segmentLength)),
radians = Math.atan2(yDelta, xDelta),
xCurrent = xStart,
yCurrent = yStart,
i;
xDelta = Math.cos(radians) * segmentLength;
yDelta = Math.sin(radians) * segmentLength;
for(i = 0; i < segmentCount; ++i)
{
context.moveTo(xCurrent, yCurrent);
context.lineTo(xCurrent + Math.cos(radians) * dashsize, yCurrent + Math.sin(radians) * dashsize);
xCurrent += xDelta;
yCurrent += yDelta;
}
context.moveTo(xCurrent, yCurrent);
delta = Math.sqrt((xEnd - xCurrent) * (xEnd - xCurrent) + (yEnd - yCurrent) * (yEnd - yCurrent));
if(delta > dashsize)
{
context.lineTo(xCurrent + Math.cos(radians) * dashsize, yCurrent + Math.sin(radians) * dashsize);
}
else if(delta > 0)
{
context.lineTo(xCurrent + Math.cos(radians) * delta, yCurrent + Math.sin(radians) * delta);
}
context.moveTo(xEnd, yEnd);
},
/**
* Clears the graphics object.
*
* @method clear
*/
clear: function() {
var w = this.get("width"),
h = this.get("height");
this._initProps();
this._context.clearRect(0, 0, w, h);
return this;
}
});
CanvasShape.ATTRS = {
/**
* An array of x, y values which indicates the transformOrigin in which to rotate the shape. Valid values range between 0 and 1 representing a
* fraction of the shape's corresponding bounding box dimension. The default value is [0.5, 0.5].
*
* @attribute transformOrigin
* @type Array
*/
transformOrigin: {
valueFn: function()
{
return [0.5, 0.5];
}
},
/**
* The rotation (in degrees) of the shape.
*
* @attribute rotation
* @type Number
*/
rotation: {
setter: function(val)
{
this.rotate(val);
},
getter: function()
{
return this._rotation;
}
},
/**
* Dom node of the shape
*
* @attribute node
* @type HTMLElement
* @readOnly
*/
node: {
readOnly: true,
getter: function()
{
return this.node;
}
},
/**
* Unique id for class instance.
*
* @attribute id
* @type String
*/
id: {
valueFn: function()
{
return Y.guid();
}
},
/**
*
* @attribute width
*/
width: {},
/**
*
* @attribute height
*/
height: {},
/**
* The x-coordinate for the shape.
*/
x: {
value: 0
},
/**
* The x-coordinate for the shape.
*/
y: {
value: 0
},
/**
* Indicates whether the shape is visible.
*
* @attribute visible
* @type Boolean
*/
visible: {
value: true,
setter: function(val){
var visibility = val ? "visible" : "hidden";
this.get("node").style.visibility = visibility;
return val;
}
},
/**
* Contains information about the fill of the shape.
* <dl>
* <dt>color</dt><dd>The color of the fill.</dd>
* <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the fill. The default value is 1.</dd>
* </dl>
*
* @attribute fill
* @type Object
*/
fill: {
valueFn: "_getDefaultFill",
setter: function(val)
{
var fill,
tmpl = this.get("fill") || this._getDefaultFill();
fill = (val) ? Y.merge(tmpl, val) : null;
if(fill && fill.color)
{
if(fill.color === undefined || fill.color == "none")
{
fill.color = null;
}
}
this._setFillProps(fill);
return fill;
}
},
/**
* Contains information about the stroke of the shape.
* <dl>
* <dt>color</dt><dd>The color of the stroke.</dd>
* <dt>weight</dt><dd>Number that indicates the width of the stroke.</dd>
* <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the stroke. The default value is 1.</dd>
* <dt>dashstyle</dt>Indicates whether to draw a dashed stroke. When set to "none", a solid stroke is drawn. When set to an array, the first index indicates the
* length of the dash. The second index indicates the length of gap.
* </dl>
*
* @attribute stroke
* @type Object
*/
stroke: {
valueFn: "_getDefaultStroke",
setter: function(val)
{
var tmpl = this.get("stroke") || this._getDefaultStroke();
val = (val) ? Y.merge(tmpl, val) : null;
this._setStrokeProps(val);
return val;
}
},
/**
* Indicates whether or not the instance will size itself based on its contents.
*
* @attribute autoSize
* @type Boolean
*/
autoSize: {
value: false
},
/**
* Determines whether the instance will receive mouse events.
*
* @attribute pointerEvents
* @type string
*/
pointerEvents: {
value: "visiblePainted"
},
/**
* Reference to the container Graphic.
*
* @attribute graphic
* @type Graphic
*/
graphic: {
readOnly: true,
getter: function()
{
return this._graphic;
}
}
};
//Straightup augment, no wrapper functions
Y.mix(CanvasShape, Y.AttributeLite, false, null, 1);
Y.mix(CanvasShape, Y.EventTarget, false, null, 1);
Y.mix(CanvasShape, PluginHost, false, null, 1);
CanvasShape.plug = PluginHost.plug;
CanvasShape.unplug = PluginHost.unplug;
Y.CanvasShape = CanvasShape;