fabric 5.3.0 → 6.0.0-beta3

package/src/shapes/Line.ts

@@ -0,0 +1,346 @@
+import { SHARED_ATTRIBUTES } from '../parser/attributes';
+import { parseAttributes } from '../parser/parseAttributes';
+import { TClassProperties } from '../typedefs';
+import { classRegistry } from '../ClassRegistry';
+import { FabricObject, cacheProperties } from './Object/FabricObject';
+import { Point } from '../Point';
+import { isFiller } from '../util/types';
+import type {
+  FabricObjectProps,
+  SerializedObjectProps,
+  TProps,
+} from './Object/types';
+import type { ObjectEvents } from '../EventTypeDefs';
+
+// @TODO this code is terrible and Line should be a special case of polyline.
+
+const coordProps = ['x1', 'x2', 'y1', 'y2'] as const;
+
+interface UniqueLineProps {
+  x1: number;
+  x2: number;
+  y1: number;
+  y2: number;
+}
+
+export interface SerializedLineProps
+  extends SerializedObjectProps,
+    UniqueLineProps {}
+
+export class Line<
+    Props extends TProps<FabricObjectProps> = Partial<FabricObjectProps>,
+    SProps extends SerializedLineProps = SerializedLineProps,
+    EventSpec extends ObjectEvents = ObjectEvents
+  >
+  extends FabricObject<Props, SProps, EventSpec>
+  implements UniqueLineProps
+{
+  /**
+   * x value or first line edge
+   * @type number
+   * @default
+   */
+  declare x1: number;
+
+  /**
+   * y value or first line edge
+   * @type number
+   * @default
+   */
+  declare y1: number;
+
+  /**
+   * x value or second line edge
+   * @type number
+   * @default
+   */
+  declare x2: number;
+
+  /**
+   * y value or second line edge
+   * @type number
+   * @default
+   */
+  declare y2: number;
+
+  static cacheProperties = [...cacheProperties, ...coordProps];
+  /**
+   * Constructor
+   * @param {Array} [points] Array of points
+   * @param {Object} [options] Options object
+   * @return {Line} thisArg
+   */
+  constructor(points = [0, 0, 0, 0], options: Props = {} as Props) {
+    super(options);
+    this.x1 = points[0];
+    this.y1 = points[1];
+    this.x2 = points[2];
+    this.y2 = points[3];
+    this._setWidthHeight(options);
+  }
+
+  /**
+   * @private
+   * @param {Object} [options] Options
+   */
+  _setWidthHeight({ left, top }: Partial<Props> = {}) {
+    this.width = Math.abs(this.x2 - this.x1);
+    this.height = Math.abs(this.y2 - this.y1);
+    this.left = left ?? this._getLeftToOriginX();
+    this.top = top ?? this._getTopToOriginY();
+  }
+
+  /**
+   * @private
+   * @param {String} key
+   * @param {*} value
+   */
+  _set(key: string, value: any) {
+    super._set(key, value);
+    if (coordProps.includes(key as keyof UniqueLineProps)) {
+      this._setWidthHeight();
+    }
+    return this;
+  }
+
+  /**
+   * @private
+   * @param {CanvasRenderingContext2D} ctx Context to render on
+   */
+  _render(ctx: CanvasRenderingContext2D) {
+    ctx.beginPath();
+
+    const p = this.calcLinePoints();
+    ctx.moveTo(p.x1, p.y1);
+    ctx.lineTo(p.x2, p.y2);
+
+    ctx.lineWidth = this.strokeWidth;
+
+    // TODO: test this
+    // make sure setting "fill" changes color of a line
+    // (by copying fillStyle to strokeStyle, since line is stroked, not filled)
+    const origStrokeStyle = ctx.strokeStyle;
+    if (isFiller(this.stroke)) {
+      ctx.strokeStyle = this.stroke.toLive(ctx)!;
+    } else {
+      ctx.strokeStyle = this.stroke ?? ctx.fillStyle;
+    }
+    this.stroke && this._renderStroke(ctx);
+    ctx.strokeStyle = origStrokeStyle;
+  }
+
+  /**
+   * This function is an helper for svg import. it returns the center of the object in the svg
+   * untransformed coordinates
+   * @private
+   * @return {Point} center point from element coordinates
+   */
+  _findCenterFromElement(): Point {
+    return new Point((this.x1 + this.x2) / 2, (this.y1 + this.y2) / 2);
+  }
+
+  /**
+   * Returns object representation of an instance
+   * @method toObject
+   * @param {Array} [propertiesToInclude] Any properties that you might want to additionally include in the output
+   * @return {Object} object representation of an instance
+   */
+  toObject<
+    T extends Omit<Props & TClassProperties<this>, keyof SProps>,
+    K extends keyof T = never
+  >(propertiesToInclude: K[] = []): Pick<T, K> & SProps {
+    return {
+      ...super.toObject(propertiesToInclude),
+      ...this.calcLinePoints(),
+    };
+  }
+
+  /*
+   * Calculate object dimensions from its properties
+   * @private
+   */
+  _getNonTransformedDimensions(): Point {
+    const dim = super._getNonTransformedDimensions();
+    if (this.strokeLineCap === 'butt') {
+      if (this.width === 0) {
+        dim.y -= this.strokeWidth;
+      }
+      if (this.height === 0) {
+        dim.x -= this.strokeWidth;
+      }
+    }
+    return dim;
+  }
+
+  /**
+   * Recalculates line points given width and height
+   * @private
+   */
+  calcLinePoints(): UniqueLineProps {
+    const xMult = this.x1 <= this.x2 ? -1 : 1,
+      yMult = this.y1 <= this.y2 ? -1 : 1,
+      x1 = xMult * this.width * 0.5,
+      y1 = yMult * this.height * 0.5,
+      x2 = xMult * this.width * -0.5,
+      y2 = yMult * this.height * -0.5;
+
+    return {
+      x1: x1,
+      x2: x2,
+      y1: y1,
+      y2: y2,
+    };
+  }
+
+  private makeEdgeToOriginGetter(
+    propertyNames: any,
+    originValues: any
+  ): number {
+    const origin = propertyNames.origin,
+      axis1 = propertyNames.axis1,
+      axis2 = propertyNames.axis2,
+      dimension = propertyNames.dimension,
+      nearest = originValues.nearest,
+      center = originValues.center,
+      farthest = originValues.farthest;
+
+    switch (this.get(origin)) {
+      case nearest:
+        return Math.min(this.get(axis1), this.get(axis2));
+      case center:
+        return (
+          Math.min(this.get(axis1), this.get(axis2)) + 0.5 * this.get(dimension)
+        );
+      case farthest:
+        return Math.max(this.get(axis1), this.get(axis2));
+      // this should never occurr, since origin is always either one of the 3 above
+      default:
+        return 0;
+    }
+  }
+
+  /**
+   * @private
+   * @return {Number} leftToOriginX Distance from left edge of canvas to originX of Line.
+   */
+  _getLeftToOriginX(): number {
+    return this.makeEdgeToOriginGetter(
+      {
+        // property names
+        origin: 'originX',
+        axis1: 'x1',
+        axis2: 'x2',
+        dimension: 'width',
+      },
+      {
+        // possible values of origin
+        nearest: 'left',
+        center: 'center',
+        farthest: 'right',
+      }
+    );
+  }
+
+  /**
+   * @private
+   * @return {Number} leftToOriginX Distance from left edge of canvas to originX of Line.
+   */
+  _getTopToOriginY(): number {
+    return this.makeEdgeToOriginGetter(
+      {
+        // property names
+        origin: 'originY',
+        axis1: 'y1',
+        axis2: 'y2',
+        dimension: 'height',
+      },
+      {
+        // possible values of origin
+        nearest: 'top',
+        center: 'center',
+        farthest: 'bottom',
+      }
+    );
+  }
+
+  /**
+   * Returns svg representation of an instance
+   * @return {Array} an array of strings with the specific svg representation
+   * of the instance
+   */
+  _toSVG() {
+    const p = this.calcLinePoints();
+    return [
+      '<line ',
+      'COMMON_PARTS',
+      'x1="',
+      p.x1,
+      '" y1="',
+      p.y1,
+      '" x2="',
+      p.x2,
+      '" y2="',
+      p.y2,
+      '" />\n',
+    ];
+  }
+
+  /* _FROM_SVG_START_ */
+
+  /**
+   * List of attribute names to account for when parsing SVG element (used by {@link Line.fromElement})
+   * @static
+   * @memberOf Line
+   * @see http://www.w3.org/TR/SVG/shapes.html#LineElement
+   */
+  static ATTRIBUTE_NAMES = SHARED_ATTRIBUTES.concat(coordProps);
+
+  /**
+   * Returns Line instance from an SVG element
+   * @static
+   * @memberOf Line
+   * @param {SVGElement} element Element to parse
+   * @param {Object} [options] Options object
+   * @param {Function} [callback] callback function invoked after parsing
+   */
+  static fromElement(element: SVGElement, callback: (line: Line) => any) {
+    const parsedAttributes = parseAttributes(element, this.ATTRIBUTE_NAMES),
+      points = [
+        parsedAttributes.x1 || 0,
+        parsedAttributes.y1 || 0,
+        parsedAttributes.x2 || 0,
+        parsedAttributes.y2 || 0,
+      ];
+    callback(new this(points, parsedAttributes));
+  }
+
+  /* _FROM_SVG_END_ */
+
+  /**
+   * Returns Line instance from an object representation
+   * @static
+   * @memberOf Line
+   * @param {Object} object Object to create an instance from
+   * @returns {Promise<Line>}
+   */
+  static fromObject<T extends TProps<SerializedLineProps>>({
+    x1,
+    y1,
+    x2,
+    y2,
+    ...object
+  }: T) {
+    return this._fromObject<Line>(
+      {
+        ...object,
+        points: [x1, y1, x2, y2],
+      },
+      {
+        extraParam: 'points',
+      }
+    );
+  }
+}
+
+classRegistry.setClass(Line);
+classRegistry.setSVGClass(Line);

package/src/shapes/Object/AnimatableObject.ts

@@ -0,0 +1,106 @@
+import { TColorArg } from '../../color/Color';
+import { ObjectEvents } from '../../EventTypeDefs';
+import {
+  animate,
+  animateColor,
+  TAnimation,
+} from '../../util/animation/animate';
+import type {
+  AnimationOptions,
+  ArrayAnimationOptions,
+  ColorAnimationOptions,
+  ValueAnimationOptions,
+} from '../../util/animation/types';
+import { StackedObject } from './StackedObject';
+
+export abstract class AnimatableObject<
+  EventSpec extends ObjectEvents = ObjectEvents
+> extends StackedObject<EventSpec> {
+  /**
+   * List of properties to consider for animating colors.
+   * @type String[]
+   */
+  declare colorProperties: string[];
+
+  /**
+   * Animates object's properties
+   * @param {Record<string, number | number[] | TColorArg>} animatable map of keys and end values
+   * @param {Partial<AnimationOptions<T>>} options
+   * @tutorial {@link http://fabricjs.com/fabric-intro-part-2#animation}
+   * @return {Record<string, TAnimation<T>>} map of animation contexts
+   *
+   * As object — multiple properties
+   *
+   * object.animate({ left: ..., top: ... });
+   * object.animate({ left: ..., top: ... }, { duration: ... });
+   */
+  animate<T extends number | number[] | TColorArg>(
+    animatable: Record<string, T>,
+    options?: Partial<AnimationOptions<T>>
+  ): Record<string, TAnimation<T>> {
+    return Object.entries(animatable).reduce((acc, [key, endValue]) => {
+      acc[key] = this._animate(key, endValue, options);
+      return acc;
+    }, {} as Record<string, TAnimation<T>>);
+  }
+
+  /**
+   * @private
+   * @param {String} key Property to animate
+   * @param {String} to Value to animate to
+   * @param {Object} [options] Options object
+   */
+  _animate<T extends number | number[] | TColorArg>(
+    key: string,
+    endValue: T,
+    options: Partial<AnimationOptions<T>> = {}
+  ): TAnimation<T> {
+    const path = key.split('.');
+    const propIsColor = this.colorProperties.includes(path[path.length - 1]);
+    const { easing, duration, abort, startValue, onChange, onComplete } =
+      options;
+    const animationOptions = {
+      target: this,
+      // path.reduce... is the current value in case start value isn't provided
+      startValue:
+        startValue ?? path.reduce((deep: any, key) => deep[key], this),
+      endValue,
+      easing,
+      duration,
+      abort: abort?.bind(this),
+      onChange: (
+        value: number | number[] | string,
+        valueProgress: number,
+        durationProgress: number
+      ) => {
+        path.reduce((deep: Record<string, any>, key, index) => {
+          if (index === path.length - 1) {
+            deep[key] = value;
+          }
+          return deep[key];
+        }, this);
+        onChange &&
+          // @ts-expect-error generic callback arg0 is wrong
+          onChange(value, valueProgress, durationProgress);
+      },
+      onComplete: (
+        value: number | number[] | string,
+        valueProgress: number,
+        durationProgress: number
+      ) => {
+        this.setCoords();
+        onComplete &&
+          // @ts-expect-error generic callback arg0 is wrong
+          onComplete(value, valueProgress, durationProgress);
+      },
+    } as AnimationOptions<T>;
+
+    return (
+      propIsColor
+        ? animateColor(animationOptions as ColorAnimationOptions)
+        : animate(
+            animationOptions as ValueAnimationOptions | ArrayAnimationOptions
+          )
+    ) as TAnimation<T>;
+  }
+}

package/src/shapes/Object/FabricObject.ts

@@ -0,0 +1,29 @@
+import { ObjectEvents } from '../../EventTypeDefs';
+import { FabricObjectSVGExportMixin } from './FabricObjectSVGExportMixin';
+import { InteractiveFabricObject } from './InteractiveObject';
+import { applyMixins } from '../../util/applyMixins';
+import { FabricObjectProps } from './types/FabricObjectProps';
+import { TFabricObjectProps, SerializedObjectProps } from './types';
+import { classRegistry } from '../../ClassRegistry';
+
+// TODO somehow we have to make a tree-shakeable import
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface, @typescript-eslint/no-unused-vars
+export interface FabricObject<
+  Props extends TFabricObjectProps = Partial<FabricObjectProps>,
+  SProps extends SerializedObjectProps = SerializedObjectProps,
+  EventSpec extends ObjectEvents = ObjectEvents
+> extends FabricObjectSVGExportMixin {}
+
+export class FabricObject<
+  Props extends TFabricObjectProps = Partial<FabricObjectProps>,
+  SProps extends SerializedObjectProps = SerializedObjectProps,
+  EventSpec extends ObjectEvents = ObjectEvents
+> extends InteractiveFabricObject<Props, SProps, EventSpec> {}
+
+applyMixins(FabricObject, [FabricObjectSVGExportMixin]);
+
+classRegistry.setClass(FabricObject);
+classRegistry.setClass(FabricObject, 'object');
+
+export { cacheProperties } from './defaultValues';