fabric 5.3.0 → 6.0.0-beta3

package/dist/src/brushes/PencilBrush.d.ts

@@ -0,0 +1,92 @@
+import { ModifierKey, TEvent } from '../EventTypeDefs';
+import { Point } from '../Point';
+import { Path } from '../shapes/Path';
+import type { Canvas } from '../canvas/Canvas';
+import { BaseBrush } from './BaseBrush';
+import { TSimplePathData } from '../util/path/typedefs';
+export declare class PencilBrush extends BaseBrush {
+    /**
+     * Discard points that are less than `decimate` pixel distant from each other
+     * @type Number
+     * @default 0.4
+     */
+    decimate: number;
+    /**
+     * Draws a straight line between last recorded point to current pointer
+     * Used for `shift` functionality
+     *
+     * @type boolean
+     * @default false
+     */
+    drawStraightLine: boolean;
+    /**
+     * The event modifier key that makes the brush draw a straight line.
+     * If `null` or 'none' or any other string that is not a modifier key the feature is disabled.
+     * @type {ModifierKey | undefined | null}
+     */
+    straightLineKey: ModifierKey | undefined | null;
+    private _points;
+    private _hasStraightLine;
+    private oldEnd?;
+    constructor(canvas: Canvas);
+    needsFullRender(): boolean;
+    static drawSegment(ctx: CanvasRenderingContext2D, p1: Point, p2: Point): Point;
+    /**
+     * Invoked on mouse down
+     * @param {Point} pointer
+     */
+    onMouseDown(pointer: Point, { e }: TEvent): void;
+    /**
+     * Invoked on mouse move
+     * @param {Point} pointer
+     */
+    onMouseMove(pointer: Point, { e }: TEvent): void;
+    /**
+     * Invoked on mouse up
+     */
+    onMouseUp({ e }: TEvent): boolean;
+    /**
+     * @private
+     * @param {Point} pointer Actual mouse position related to the canvas.
+     */
+    _prepareForDrawing(pointer: Point): void;
+    /**
+     * @private
+     * @param {Point} point Point to be added to points array
+     */
+    _addPoint(point: Point): boolean;
+    /**
+     * Clear points array and set contextTop canvas style.
+     * @private
+     */
+    _reset(): void;
+    /**
+     * Draw a smooth path on the topCanvas using quadraticCurveTo
+     * @private
+     * @param {CanvasRenderingContext2D} [ctx]
+     */
+    _render(ctx?: CanvasRenderingContext2D): void;
+    /**
+     * Converts points to SVG path
+     * @param {Point[]} points Array of points
+     * @return {TSimplePathData} SVG path commands
+     */
+    convertPointsToSVGPath(points: Point[]): TSimplePathData;
+    /**
+     * Creates a Path object to add on canvas
+     * @param {TSimplePathData} pathData Path data
+     * @return {Path} Path to add on canvas
+     */
+    createPath(pathData: TSimplePathData): Path;
+    /**
+     * Decimate points array with the decimate value
+     */
+    decimatePoints(points: Point[], distance: number): Point[];
+    /**
+     * On mouseup after drawing the path on contextTop canvas
+     * we use the points captured to create an new Path object
+     * and add it to the canvas.
+     */
+    _finalizeAndAddPath(): void;
+}
+//# sourceMappingURL=PencilBrush.d.ts.map

package/dist/src/brushes/SprayBrush.d.ts

@@ -0,0 +1,79 @@
+import { Point } from '../Point';
+import type { Canvas } from '../canvas/Canvas';
+import { BaseBrush } from './BaseBrush';
+export type SprayBrushPoint = {
+    x: number;
+    y: number;
+    width: number;
+    opacity: number;
+};
+export declare class SprayBrush extends BaseBrush {
+    /**
+     * Width of a spray
+     * @type Number
+     * @default
+     */
+    width: number;
+    /**
+     * Density of a spray (number of dots per chunk)
+     * @type Number
+     * @default
+     */
+    density: number;
+    /**
+     * Width of spray dots
+     * @type Number
+     * @default
+     */
+    dotWidth: number;
+    /**
+     * Width variance of spray dots
+     * @type Number
+     * @default
+     */
+    dotWidthVariance: number;
+    /**
+     * Whether opacity of a dot should be random
+     * @type Boolean
+     * @default
+     */
+    randomOpacity: boolean;
+    /**
+     * Whether overlapping dots (rectangles) should be removed (for performance reasons)
+     * @type Boolean
+     * @default
+     */
+    optimizeOverlapping: boolean;
+    private sprayChunks;
+    private sprayChunk;
+    /**
+     * Constructor
+     * @param {Canvas} canvas
+     * @return {SprayBrush} Instance of a spray brush
+     */
+    constructor(canvas: Canvas);
+    /**
+     * Invoked on mouse down
+     * @param {Point} pointer
+     */
+    onMouseDown(pointer: Point): void;
+    /**
+     * Invoked on mouse move
+     * @param {Point} pointer
+     */
+    onMouseMove(pointer: Point): void;
+    /**
+     * Invoked on mouse up
+     */
+    onMouseUp(): void;
+    renderChunck(sprayChunck: SprayBrushPoint[]): void;
+    /**
+     * Render all spray chunks
+     */
+    _render(): void;
+    /**
+     * @param {Point} pointer
+     */
+    addSprayChunk(pointer: Point): void;
+}
+//# sourceMappingURL=SprayBrush.d.ts.map

package/dist/src/cache.d.ts

@@ -0,0 +1,47 @@
+import { TRectBounds } from './typedefs';
+export declare class Cache {
+    /**
+     * Cache of widths of chars in text rendering.
+     */
+    charWidthsCache: Record<
+    /** fontFamily */ string, Record<
+    /** fontStyleCacheKey */ string, Record</** char */ string, /** width */ number>>>;
+    /**
+     * @return {Object} reference to cache
+     */
+    getFontCache({ fontFamily, fontStyle, fontWeight, }: {
+        fontFamily: string;
+        fontStyle: string;
+        fontWeight: string | number;
+    }): Record<string, number>;
+    /**
+     * Clear char widths cache for the given font family or all the cache if no
+     * fontFamily is specified.
+     * Use it if you know you are loading fonts in a lazy way and you are not waiting
+     * for custom fonts to load properly when adding text objects to the canvas.
+     * If a text object is added when its own font is not loaded yet, you will get wrong
+     * measurement and so wrong bounding boxes.
+     * After the font cache is cleared, either change the textObject text content or call
+     * initDimensions() to trigger a recalculation
+     * @param {String} [fontFamily] font family to clear
+     */
+    clearFontCache(fontFamily?: string): void;
+    /**
+     * Given current aspect ratio, determines the max width and height that can
+     * respect the total allowed area for the cache.
+     * @param {number} ar aspect ratio
+     * @return {number[]} Limited dimensions X and Y
+     */
+    limitDimsByArea(ar: number): number[];
+    /**
+     * This object keeps the results of the boundsOfCurve calculation mapped by the joined arguments necessary to calculate it.
+     * It does speed up calculation, if you parse and add always the same paths, but in case of heavy usage of freedrawing
+     * you do not get any speed benefit and you get a big object in memory.
+     * The object was a private variable before, while now is appended to the lib so that you have access to it and you
+     * can eventually clear it.
+     * It was an internal variable, is accessible since version 2.3.4
+     */
+    boundsOfCurveCache: Record<string, TRectBounds>;
+}
+export declare const cache: Cache;
+//# sourceMappingURL=cache.d.ts.map