fabric
Version:
Object model for HTML5 canvas, and SVG-to-canvas parser. Backed by jsdom and node-canvas.
1 lines • 5.18 kB
Source Map (JSON)
{"version":3,"file":"BaseBrush.mjs","names":[],"sources":["../../../src/brushes/BaseBrush.ts"],"sourcesContent":["import { Color } from '../color/Color';\nimport type { Point } from '../Point';\nimport type { Shadow } from '../Shadow';\nimport type { Canvas } from '../canvas/Canvas';\nimport type { TBrushEventData } from './typedefs';\n\n/**\n * @see {@link http://fabric5.fabricjs.com/freedrawing|Freedrawing demo}\n */\nexport abstract class BaseBrush {\n /**\n * Color of a brush\n * @type String\n */\n color = 'rgb(0, 0, 0)';\n\n /**\n * Width of a brush, has to be a Number, no string literals\n * @type Number\n */\n width = 1;\n\n /**\n * Shadow object representing shadow of this shape.\n * <b>Backwards incompatibility note:</b> This property replaces \"shadowColor\" (String), \"shadowOffsetX\" (Number),\n * \"shadowOffsetY\" (Number) and \"shadowBlur\" (Number) since v1.2.12\n * @type Shadow\n */\n shadow: Shadow | null = null;\n\n /**\n * Line endings style of a brush (one of \"butt\", \"round\", \"square\")\n * @type String\n */\n strokeLineCap: CanvasLineCap = 'round';\n\n /**\n * Corner style of a brush (one of \"bevel\", \"round\", \"miter\")\n * @type String\n */\n strokeLineJoin: CanvasLineJoin = 'round';\n\n /**\n * Maximum miter length (used for strokeLineJoin = \"miter\") of a brush's\n * @type Number\n */\n strokeMiterLimit = 10;\n\n /**\n * Stroke Dash Array.\n * @type Array\n */\n strokeDashArray: number[] | null = null;\n\n /**\n * When `true`, the free drawing is limited to the whiteboard size. Default to false.\n * @type Boolean\n * @default false\n */\n\n limitedToCanvasSize = false;\n\n /**\n * @todo add type\n */\n declare canvas: Canvas;\n\n constructor(canvas: Canvas) {\n this.canvas = canvas;\n }\n\n abstract _render(): void;\n abstract onMouseDown(pointer: Point, ev: TBrushEventData): void;\n abstract onMouseMove(pointer: Point, ev: TBrushEventData): void;\n /**\n * @returns true if brush should continue blocking interaction\n */\n abstract onMouseUp(ev: TBrushEventData): boolean | void;\n\n /**\n * Sets brush styles\n * @private\n * @param {CanvasRenderingContext2D} ctx\n */\n _setBrushStyles(ctx: CanvasRenderingContext2D) {\n ctx.strokeStyle = this.color;\n ctx.lineWidth = this.width;\n ctx.lineCap = this.strokeLineCap;\n ctx.miterLimit = this.strokeMiterLimit;\n ctx.lineJoin = this.strokeLineJoin;\n ctx.setLineDash(this.strokeDashArray || []);\n }\n\n /**\n * Sets the transformation on given context\n * @param {CanvasRenderingContext2D} ctx context to render on\n * @private\n */\n protected _saveAndTransform(ctx: CanvasRenderingContext2D) {\n const v = this.canvas.viewportTransform;\n ctx.save();\n ctx.transform(v[0], v[1], v[2], v[3], v[4], v[5]);\n }\n\n protected needsFullRender() {\n const color = new Color(this.color);\n return color.getAlpha() < 1 || !!this.shadow;\n }\n\n /**\n * Sets brush shadow styles\n * @private\n */\n protected _setShadow() {\n if (!this.shadow || !this.canvas) {\n return;\n }\n\n const canvas = this.canvas,\n shadow = this.shadow,\n ctx = canvas.contextTop,\n zoom = canvas.getZoom() * canvas.getRetinaScaling();\n\n ctx.shadowColor = shadow.color;\n ctx.shadowBlur = shadow.blur * zoom;\n ctx.shadowOffsetX = shadow.offsetX * zoom;\n ctx.shadowOffsetY = shadow.offsetY * zoom;\n }\n\n /**\n * Removes brush shadow styles\n * @private\n */\n protected _resetShadow() {\n const ctx = this.canvas.contextTop;\n\n ctx.shadowColor = '';\n ctx.shadowBlur = ctx.shadowOffsetX = ctx.shadowOffsetY = 0;\n }\n\n /**\n * Check is pointer is outside canvas boundaries\n * @param {Object} pointer\n * @private\n */\n protected _isOutSideCanvas(pointer: Point) {\n return (\n pointer.x < 0 ||\n pointer.x > this.canvas.getWidth() ||\n pointer.y < 0 ||\n pointer.y > this.canvas.getHeight()\n );\n }\n}\n"],"mappings":";;;;;;AASA,IAAsB,YAAtB,MAAgC;CA0D9B,YAAY,QAAgB;;;;;;;GArD5B;GAAQ;GAAe;;;;;;;GAMvB;GAAQ;GAAE;;;;;;;;;GAQV;GAAwB;GAAK;;;;;;;GAM7B;GAA+B;GAAQ;;;;;;;GAMvC;GAAiC;GAAQ;;;;;;;GAMzC;GAAmB;GAAG;;;;;;;GAMtB;GAAmC;GAAK;;;;;;;;GAQxC;GAAsB;GAAM;AAQ1B,OAAK,SAAS;;;;;;;CAgBhB,gBAAgB,KAA+B;AAC7C,MAAI,cAAc,KAAK;AACvB,MAAI,YAAY,KAAK;AACrB,MAAI,UAAU,KAAK;AACnB,MAAI,aAAa,KAAK;AACtB,MAAI,WAAW,KAAK;AACpB,MAAI,YAAY,KAAK,mBAAmB,EAAE,CAAC;;;;;;;CAQ7C,kBAA4B,KAA+B;EACzD,MAAM,IAAI,KAAK,OAAO;AACtB,MAAI,MAAM;AACV,MAAI,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG;;CAGnD,kBAA4B;AAE1B,SADc,IAAI,MAAM,KAAK,MAAM,CACtB,UAAU,GAAG,KAAK,CAAC,CAAC,KAAK;;;;;;CAOxC,aAAuB;AACrB,MAAI,CAAC,KAAK,UAAU,CAAC,KAAK,OACxB;EAGF,MAAM,SAAS,KAAK,QAClB,SAAS,KAAK,QACd,MAAM,OAAO,YACb,OAAO,OAAO,SAAS,GAAG,OAAO,kBAAkB;AAErD,MAAI,cAAc,OAAO;AACzB,MAAI,aAAa,OAAO,OAAO;AAC/B,MAAI,gBAAgB,OAAO,UAAU;AACrC,MAAI,gBAAgB,OAAO,UAAU;;;;;;CAOvC,eAAyB;EACvB,MAAM,MAAM,KAAK,OAAO;AAExB,MAAI,cAAc;AAClB,MAAI,aAAa,IAAI,gBAAgB,IAAI,gBAAgB;;;;;;;CAQ3D,iBAA2B,SAAgB;AACzC,SACE,QAAQ,IAAI,KACZ,QAAQ,IAAI,KAAK,OAAO,UAAU,IAClC,QAAQ,IAAI,KACZ,QAAQ,IAAI,KAAK,OAAO,WAAW"}