/*! * jSketch 0.8 | Luis A. Leiva | MIT license * A simple JavaScript library for drawing facilities on HTML5 canvas. */ /** * A simple JavaScript library for drawing facilities on HTML5 canvas. * This class is mostly a wrapper for the HTML5 canvas API with some syntactic sugar, * such as function chainability and old-school AS3-like notation. * @name jSketch * @class * @version 0.8 * @date 9 Jul 2014 * @author Luis A. Leiva * @license MIT license * @example * var canvas1 = document.getElementById('foo'); * var canvas2 = document.getElementById('bar'); * // Instantiate once, reuse everywhere. * var brush = new jSketch(canvas1).lineStyle('red').moveTo(50,50).lineTo(10,10).stroke(); * // Actually, .moveTo(50,50).lineTo(10,10) can be just .line(50,50, 10,10) * // Switching between contexts removes the need of having to reinstantiate the jSketch class. * brush.context(canvas2).beginFill('#5F7').fillCircle(30,30,8).endFill(); */ (function(window){ /** * @constructor * @param {Object} elem - MUST be a DOM element * @param {Object} options - Configuration */ var jSketch = function(elem, options){ return new Sketch(elem, options); }; // Base class, private. var Sketch = function(elem, options){ // Although discouraged, we can instantiate the class without arguments. if (!elem) return; // We can pass default setup values. if (typeof options === 'undefined') options = {}; // Set drawing context first. this.context(elem); // Scene defaults. this.stageWidth = elem.getAttribute("width"); this.stageHeight = elem.getAttribute("height"); // Drawing defaults. this.graphics.fillStyle = typeof options.fillStyle !== 'undefined' ? options.fillStyle : '#F00'; this.graphics.strokeStyle = typeof options.strokeStyle !== 'undefined' ? options.strokeStyle : '#F0F'; this.graphics.lineWidth = typeof options.lineWidth !== 'undefined' ? options.lineWidth : 2; this.graphics.lineCap = typeof options.lineCap !== 'undefined' ? options.lineCap : 'round'; this.graphics.lineJoin = typeof options.lineJoin !== 'undefined' ? options.lineJoin : 'round'; this.graphics.mitterLimit = typeof options.mitterLimit !== 'undefined' ? options.mitterLimit : 10; // Make room for storing some data such as brush type, colors, etc. this.data = {}; // Make constructor chainable. return this; }; /** * jSketch methods (publicly extensible). * @ignore * @memberof jSketch * @see jSketch */ jSketch.fn = Sketch.prototype = { /** * Allows to change the drawing context at runtime. * @param {Object} elem - DOM element. * @return jSketch * @memberof jSketch */ context: function(elem) { if (elem == null) throw("No canvas element specified."); // Save shortcuts: canvas (DOM elem) & graphics (2D canvas context). this.canvas = elem; this.graphics = elem.getContext("2d"); // Always allow chainability. return this; }, /** * Sets the dimensions of canvas. * @param {Number} width - New canvas width. * @param {Number} height - New canvas width. * @return jSketch * @memberof jSketch */ size: function(width,height) { this.stageWidth = width; this.stageHeight = height; this.canvas.width = width; this.canvas.height = height; return this; }, /** * Sets the background color of canvas. * @param {Number|String} color - An HTML color. * @return jSketch * @memberof jSketch */ background: function(color) { var oldFill = this.graphics.fillStyle; this.beginFill(color); this.graphics.fillRect(0,0,this.stageWidth,this.stageHeight); this.beginFill(oldFill); // Restore old fill return this; }, /** * Shortcut for setting the size + background color. * @param {Number} width - New canvas width. * @param {Number} height - New canvas width. * @param {Number|String} bgcolor - An HTML color. * @return jSketch * @memberof jSketch */ stage: function(width,height,bgcolor) { this.size(width,height).background(bgcolor); return this; }, /** * Sets the fill color. * @param {Number|String} color - An HTML color. * @return jSketch * @memberof jSketch */ beginFill: function(color) { this.saveGraphics('fillStyle'); this.graphics.fillStyle = color; return this; }, /** * Recovers the fill color that was set before beginFill(). * @return jSketch * @memberof jSketch */ endFill: function() { this.graphics.fillStyle = this.data.fillStyle; return this; }, /** * Sets the line style. * @param {Number|String} color - An HTML color. * @param {Number} thickness - Line thickness. * @param {String} capStyle - Style of line cap. * @param {String} joinStyle - Style of line join. * @param {String} mitter - Style of mitter. * @return jSketch * @memberof jSketch */ lineStyle: function(color,thickness,capStyle,joinStyle,mitter) { this.graphics.strokeStyle = color || this.graphics.strokeStyle; this.graphics.lineWidth = thickness || this.graphics.lineWidth; this.graphics.lineCap = capStyle || this.graphics.lineCap; this.graphics.lineJoin = joinStyle || this.graphics.lineJoin; this.graphics.mitterLimit = mitter || this.graphics.mitterLimit; return this; }, /** * Move brush to a coordinate in canvas. * @param {Number} x - Horizontal coordinate. * @param {Number} y - Vertical coordinate. * @return jSketch * @memberof jSketch */ moveTo: function(x,y) { this.graphics.moveTo(x,y); return this; }, /** * Draws line to given coordinate. * @param {Number} x - Horizontal coordinate. * @param {Number} y - Vertical coordinate. * @return jSketch * @memberof jSketch */ lineTo: function(x,y) { this.graphics.lineTo(x,y); return this; }, /** * Draws line from point 1 to point 2. * @param {Number} x1 - Horizontal coordinate of point 1. * @param {Number} y1 - Vertical coordinate of point 1. * @param {Number} x2 - Horizontal coordinate of point 2. * @param {Number} y2 - Vertical coordinate of point 2. * @return jSketch * @memberof jSketch */ line: function(x1,y1,x2,y2) { this.graphics.moveTo(x1,y1); this.lineTo(x2,y2); return this; }, /** * Draws curve to given coordinate. * @param {Number} x - Horizontal coordinate. * @param {Number} y - Vertical coordinate. * @param {Number} cpx - Horizontal coordinate of control point. * @param {Number} cpy - Vertical coordinate of control point. * @return jSketch * @memberof jSketch */ curveTo: function(x,y,cpx,cpy) { this.graphics.quadraticCurveTo(cpx,cpy,x,y); return this; }, /** * Draws curve from coordinate 1 to coordinate 2. * @param {Number} x1 - Horizontal coordinate of point 1. * @param {Number} y1 - Vertical coordinate of point 1. * @param {Number} x2 - Horizontal coordinate of point 2. * @param {Number} y2 - Vertical coordinate of point 2. * @param {Number} cpx - Horizontal coordinate of control point. * @param {Number} cpy - Vertical coordinate of control point. * @return jSketch * @memberof jSketch */ curve: function(x1,y1,x2,y2,cpx,cpy) { this.graphics.moveTo(x1,y1); this.curveTo(x2,y2,cpx,cpy); return this; }, /** * Strokes a given path. * @return jSketch * @memberof jSketch */ stroke: function() { this.graphics.stroke(); return this; }, /** * Draws a stroke-only rectangle. * @param {Number} x - Horizontal coordinate. * @param {Number} y - Vertical coordinate. * @param {Number} width - Rectangle width. * @param {Number} height - Rectangle height. * @return jSketch * @memberof jSketch */ strokeRect: function(x,y,width,height) { this.graphics.beginPath(); //this.moveTo(x,y).lineTo(x+width,y).lineTo(x+width,y+height).lineTo(y,y+height).lineTo(x,y); this.graphics.strokeRect(x,y,width,height); this.graphics.closePath(); return this; }, /** * Draws a filled rectangle. * @param {Number} x - Horizontal coordinate. * @param {Number} y - Vertical coordinate. * @param {Number} width - Rectangle width. * @param {Number} height - Rectangle height. * @return jSketch * @memberof jSketch */ fillRect: function(x,y,width,height) { this.graphics.beginPath(); this.graphics.fillRect(x,y,width,height); this.graphics.closePath(); return this; }, /** * Draws a stroke-only circle. * @param {Number} x - Horizontal coordinate. * @param {Number} y - Vertical coordinate. * @param {Number} radius - Circle radius. * @return jSketch * @memberof jSketch */ strokeCircle: function(x,y,radius) { this.graphics.beginPath(); this.graphics.arc(x,y, radius, 0, Math.PI * 2, false); this.graphics.stroke(); this.graphics.closePath(); return this; }, /** * Draws a filled circle. * @param {Number} x - Horizontal coordinate. * @param {Number} y - Vertical coordinate. * @param {Number} radius - Circle radius. * @return jSketch * @memberof jSketch */ fillCircle: function(x,y,radius) { this.graphics.beginPath(); this.graphics.arc(x,y, radius, 0, Math.PI * 2, false); this.graphics.fill(); this.graphics.closePath(); return this; }, // experimental radialCircle: function(x,y,radius,color,glowSize){ var g = this.graphics.createRadialGradient(x,y,radius,x,y,glowSize); g.addColorStop(0,color); g.addColorStop(1.0,"rgba(0,0,0,0)"); this.graphics.fillStyle = g; this.fillCircle(x,y,radius); return this; }, /** * A path is started. * @return jSketch * @memberof jSketch */ beginPath: function() { this.graphics.beginPath(); return this; }, /** * A path is finished. * @return jSketch * @memberof jSketch */ closePath: function() { this.graphics.closePath(); return this; }, /** * Sets brush to eraser mode. * @param {Number} brushSize - Brush size. * @return jSketch * @memberof jSketch */ eraser: function(brushSize) { if (typeof brushSize === 'undefined') brushSize = 15; if (typeof this.data.strokeStyle === 'undefined') this.saveGraphics('strokeStyle lineWidth'); this.graphics.globalCompositeOperation = "destination-out"; this.graphics.strokeStyle = "rgba(0,0,0,1)"; this.graphics.lineWidth = brushSize; return this; }, /** * Sets brush to pencil mode. * @param {Number} brushSize - Brush size. * @return jSketch * @memberof jSketch */ pencil: function(brushSize) { this.graphics.globalCompositeOperation = "source-over"; this.restoreGraphics('strokeStyle lineWidth'); if (typeof brushSize !== 'undefined') this.graphics.lineWidth = brushSize; return this; }, /** * Clears stage. * @return jSketch * @memberof jSketch */ clear: function() { // The following resets _all_ styles, so better use clearRect. //this.canvas.width = this.canvas.width; this.graphics.clearRect(0,0, this.stageWidth,this.stageHeight); this.data = {}; return this; }, /** * Saves a snapshot of all styles and transformations. * @return jSketch * @memberof jSketch */ save: function() { this.graphics.save(); return this; }, /** * Restores previous drawing state. * @return jSketch * @memberof jSketch */ restore: function() { this.graphics.restore(); return this; }, /** * Saves given drawing settings. * @param propList {Array|String} propList - Array or space-separated String. * @return jSketch * @memberof jSketch */ saveGraphics: function(propList) { if (typeof propList === 'string') propList = propList.split(" "); for (var p = 0; p < propList.length; p++) { var prop = propList[p]; this.data[prop] = this.graphics[prop]; } return this; }, /** * Restores given drawing settings. * @param propList {Array|String} propList - Array or space-separated String. * @return jSketch * @memberof jSketch */ restoreGraphics: function(propList) { if (typeof propList === 'string') propList = propList.split(" "); for (var p = 0; p < propList.length; p++) { var prop = propList[p]; this.graphics[prop] = this.data[prop]; } return this; }, /** * Draws an image. * @param {Number} src - Image source path. * @param {Number} x - Horizontal coordinate. * @param {Number} y - Vertical coordinate. * @return jSketch * @memberof jSketch */ drawImage: function(src, x,y) { var self = this, img = new Image(); img.src = src; img.onload = function() { self.graphics.drawImage(img, x,y); } return this; } }; // Expose. window.jSketch = jSketch; })(this);