fabric/dist/src/LayoutManager/LayoutManager.mjs.map

Object model for HTML5 canvas, and SVG-to-canvas parser. Backed by jsdom and node-canvas.

{"version":3,"file":"LayoutManager.mjs","names":[],"sources":["../../../src/LayoutManager/LayoutManager.ts"],"sourcesContent":["import { Point } from '../Point';\nimport {\n  CENTER,\n  CHANGED,\n  MODIFIED,\n  MODIFY_PATH,\n  MODIFY_POLY,\n  MOVING,\n  RESIZING,\n  ROTATING,\n  SCALING,\n  SKEWING,\n  iMatrix,\n} from '../constants';\nimport type { Group } from '../shapes/Group';\nimport type { FabricObject } from '../shapes/Object/FabricObject';\nimport { invertTransform } from '../util/misc/matrix';\nimport { resolveOrigin } from '../util/misc/resolveOrigin';\nimport { FitContentLayout } from './LayoutStrategies/FitContentLayout';\nimport type { LayoutStrategy } from './LayoutStrategies/LayoutStrategy';\nimport {\n  LAYOUT_TYPE_INITIALIZATION,\n  LAYOUT_TYPE_ADDED,\n  LAYOUT_TYPE_REMOVED,\n  LAYOUT_TYPE_IMPERATIVE,\n  LAYOUT_TYPE_OBJECT_MODIFIED,\n  LAYOUT_TYPE_OBJECT_MODIFYING,\n} from './constants';\nimport type {\n  LayoutContext,\n  LayoutResult,\n  RegistrationContext,\n  StrictLayoutContext,\n} from './types';\nimport { classRegistry } from '../ClassRegistry';\nimport type { TModificationEvents } from '../EventTypeDefs';\n\nconst LAYOUT_MANAGER = 'layoutManager';\n\nexport type SerializedLayoutManager = {\n  type: string;\n  strategy: string;\n};\n\nexport class LayoutManager {\n  declare private _prevLayoutStrategy?: LayoutStrategy;\n  declare protected _subscriptions: Map<FabricObject, VoidFunction[]>;\n\n  strategy: LayoutStrategy;\n\n  constructor(strategy: LayoutStrategy = new FitContentLayout()) {\n    this.strategy = strategy;\n    this._subscriptions = new Map();\n  }\n\n  public performLayout(context: LayoutContext) {\n    const strictContext: StrictLayoutContext = {\n      bubbles: true,\n      strategy: this.strategy,\n      ...context,\n      prevStrategy: this._prevLayoutStrategy,\n      stopPropagation() {\n        this.bubbles = false;\n      },\n    };\n\n    this.onBeforeLayout(strictContext);\n\n    const layoutResult = this.getLayoutResult(strictContext);\n    if (layoutResult) {\n      this.commitLayout(strictContext, layoutResult);\n    }\n\n    this.onAfterLayout(strictContext, layoutResult);\n    this._prevLayoutStrategy = strictContext.strategy;\n  }\n\n  /**\n   * Attach handlers for events that we know will invalidate the layout when\n   * performed on child objects ( general transforms ).\n   * Returns the disposers for later unsubscribing and cleanup\n   * @param {FabricObject} object\n   * @param {RegistrationContext & Partial<StrictLayoutContext>} context\n   * @returns {VoidFunction[]} disposers remove the handlers\n   */\n  protected attachHandlers(\n    object: FabricObject,\n    context: RegistrationContext & Partial<StrictLayoutContext>,\n  ): VoidFunction[] {\n    const { target } = context;\n    return (\n      [\n        MODIFIED,\n        MOVING,\n        RESIZING,\n        ROTATING,\n        SCALING,\n        SKEWING,\n        CHANGED,\n        MODIFY_POLY,\n        MODIFY_PATH,\n      ] as (TModificationEvents & 'modified')[]\n    ).map((key) =>\n      object.on(key, (e) =>\n        this.performLayout(\n          key === MODIFIED\n            ? {\n                type: LAYOUT_TYPE_OBJECT_MODIFIED,\n                trigger: key,\n                e,\n                target,\n              }\n            : {\n                type: LAYOUT_TYPE_OBJECT_MODIFYING,\n                trigger: key,\n                e,\n                target,\n              },\n        ),\n      ),\n    );\n  }\n\n  /**\n   * Subscribe an object to transform events that will trigger a layout change on the parent\n   * This is important only for interactive groups.\n   * @param object\n   * @param context\n   */\n  protected subscribe(\n    object: FabricObject,\n    context: RegistrationContext & Partial<StrictLayoutContext>,\n  ) {\n    this.unsubscribe(object, context);\n    const disposers = this.attachHandlers(object, context);\n    this._subscriptions.set(object, disposers);\n  }\n\n  /**\n   * unsubscribe object layout triggers\n   */\n  protected unsubscribe(\n    object: FabricObject,\n    _context?: RegistrationContext & Partial<StrictLayoutContext>,\n  ) {\n    (this._subscriptions.get(object) || []).forEach((d) => d());\n    this._subscriptions.delete(object);\n  }\n\n  unsubscribeTargets(\n    context: RegistrationContext & Partial<StrictLayoutContext>,\n  ) {\n    context.targets.forEach((object) => this.unsubscribe(object, context));\n  }\n\n  subscribeTargets(\n    context: RegistrationContext & Partial<StrictLayoutContext>,\n  ) {\n    context.targets.forEach((object) => this.subscribe(object, context));\n  }\n\n  protected onBeforeLayout(context: StrictLayoutContext) {\n    const { target, type } = context;\n    const { canvas } = target;\n    // handle layout triggers subscription\n    // @TODO: gate the registration when the group is interactive\n    if (type === LAYOUT_TYPE_INITIALIZATION || type === LAYOUT_TYPE_ADDED) {\n      this.subscribeTargets(context);\n    } else if (type === LAYOUT_TYPE_REMOVED) {\n      this.unsubscribeTargets(context);\n    }\n    // fire layout event (event will fire only for layouts after initialization layout)\n    target.fire('layout:before', {\n      context,\n    });\n    canvas &&\n      canvas.fire('object:layout:before', {\n        target,\n        context,\n      });\n\n    if (type === LAYOUT_TYPE_IMPERATIVE && context.deep) {\n      const { strategy: _, ...tricklingContext } = context;\n      // traverse the tree\n      target.forEachObject(\n        (object) =>\n          (object as Group).layoutManager &&\n          (object as Group).layoutManager.performLayout({\n            ...tricklingContext,\n            bubbles: false,\n            target: object as Group,\n          }),\n      );\n    }\n  }\n\n  protected getLayoutResult(\n    context: StrictLayoutContext,\n  ): Required<LayoutResult> | undefined {\n    const { target, strategy, type } = context;\n\n    const result = strategy.calcLayoutResult(context, target.getObjects());\n\n    if (!result) {\n      return;\n    }\n\n    const prevCenter =\n      type === LAYOUT_TYPE_INITIALIZATION\n        ? new Point()\n        : target.getRelativeCenterPoint();\n\n    const {\n      center: nextCenter,\n      correction = new Point(),\n      relativeCorrection = new Point(),\n    } = result;\n    const offset = prevCenter\n      .subtract(nextCenter)\n      .add(correction)\n      .transform(\n        // in `initialization` we do not account for target's transformation matrix\n        type === LAYOUT_TYPE_INITIALIZATION\n          ? iMatrix\n          : invertTransform(target.calcOwnMatrix()),\n        true,\n      )\n      .add(relativeCorrection);\n\n    return {\n      result,\n      prevCenter,\n      nextCenter,\n      offset,\n    };\n  }\n\n  protected commitLayout(\n    context: StrictLayoutContext,\n    layoutResult: Required<LayoutResult>,\n  ) {\n    const { target } = context;\n    const {\n      result: { size },\n      nextCenter,\n    } = layoutResult;\n    // set dimensions\n    target.set({ width: size.x, height: size.y });\n    // layout descendants\n    this.layoutObjects(context, layoutResult);\n    //  set position\n    // in `initialization` we do not account for target's transformation matrix\n    if (context.type === LAYOUT_TYPE_INITIALIZATION) {\n      // TODO: what about strokeWidth?\n      target.set({\n        left:\n          context.x ?? nextCenter.x + size.x * resolveOrigin(target.originX),\n        top: context.y ?? nextCenter.y + size.y * resolveOrigin(target.originY),\n      });\n    } else {\n      target.setPositionByOrigin(nextCenter, CENTER, CENTER);\n      // invalidate\n      target.setCoords();\n      target.set('dirty', true);\n    }\n  }\n\n  protected layoutObjects(\n    context: StrictLayoutContext,\n    layoutResult: Required<LayoutResult>,\n  ) {\n    const { target } = context;\n    //  adjust objects to account for new center\n    target.forEachObject((object) => {\n      object.group === target &&\n        this.layoutObject(context, layoutResult, object);\n    });\n    // adjust clip path to account for new center\n    context.strategy.shouldLayoutClipPath(context) &&\n      this.layoutObject(context, layoutResult, target.clipPath as FabricObject);\n  }\n\n  /**\n   * @param {FabricObject} object\n   * @param {Point} offset\n   */\n  protected layoutObject(\n    context: StrictLayoutContext,\n    { offset }: Required<LayoutResult>,\n    object: FabricObject,\n  ) {\n    // TODO: this is here for cache invalidation.\n    // verify if this is necessary since we have explicit\n    // cache invalidation at the end of commitLayout\n    object.set({\n      left: object.left + offset.x,\n      top: object.top + offset.y,\n    });\n  }\n\n  protected onAfterLayout(\n    context: StrictLayoutContext,\n    layoutResult?: LayoutResult,\n  ) {\n    const {\n      target,\n      strategy,\n      bubbles,\n      prevStrategy: _,\n      ...bubblingContext\n    } = context;\n    const { canvas } = target;\n\n    //  fire layout event (event will fire only for layouts after initialization layout)\n    target.fire('layout:after', {\n      context,\n      result: layoutResult,\n    });\n    canvas &&\n      canvas.fire('object:layout:after', {\n        context,\n        result: layoutResult,\n        target,\n      });\n\n    //  bubble\n    const parent = target.parent;\n    if (bubbles && parent?.layoutManager) {\n      //  add target to context#path\n      (bubblingContext.path || (bubblingContext.path = [])).push(target);\n      //  all parents should invalidate their layout\n      parent.layoutManager.performLayout({\n        ...bubblingContext,\n        target: parent,\n      });\n    }\n    target.set('dirty', true);\n  }\n\n  dispose() {\n    const { _subscriptions } = this;\n    _subscriptions.forEach((disposers) => disposers.forEach((d) => d()));\n    _subscriptions.clear();\n  }\n\n  toObject() {\n    return {\n      type: LAYOUT_MANAGER,\n      strategy: (this.strategy.constructor as typeof LayoutStrategy).type,\n    };\n  }\n\n  toJSON() {\n    return this.toObject();\n  }\n}\n\nclassRegistry.setClass(LayoutManager, LAYOUT_MANAGER);\n"],"mappings":";;;;;;;;;AAqCA,MAAM,iBAAiB;AAOvB,IAAa,gBAAb,MAA2B;CAMzB,YAAY,WAA2B,IAAI,kBAAkB,EAAE;wBAF/D,YAAA,KAAA,EAAyB;AAGvB,OAAK,WAAW;AAChB,OAAK,iCAAiB,IAAI,KAAK;;CAGjC,cAAqB,SAAwB;EAC3C,MAAM,gBAAqC;GACzC,SAAS;GACT,UAAU,KAAK;GACf,GAAG;GACH,cAAc,KAAK;GACnB,kBAAkB;AAChB,SAAK,UAAU;;GAElB;AAED,OAAK,eAAe,cAAc;EAElC,MAAM,eAAe,KAAK,gBAAgB,cAAc;AACxD,MAAI,aACF,MAAK,aAAa,eAAe,aAAa;AAGhD,OAAK,cAAc,eAAe,aAAa;AAC/C,OAAK,sBAAsB,cAAc;;;;;;;;;;CAW3C,eACE,QACA,SACgB;EAChB,MAAM,EAAE,WAAW;AACnB,SACE;GACE;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACD,CACD,KAAK,QACL,OAAO,GAAG,MAAM,MACd,KAAK,cACH,QAAA,aACI;GACE,MAAM;GACN,SAAS;GACT;GACA;GACD,GACD;GACE,MAAM;GACN,SAAS;GACT;GACA;GACD,CACN,CACF,CACF;;;;;;;;CASH,UACE,QACA,SACA;AACA,OAAK,YAAY,QAAQ,QAAQ;EACjC,MAAM,YAAY,KAAK,eAAe,QAAQ,QAAQ;AACtD,OAAK,eAAe,IAAI,QAAQ,UAAU;;;;;CAM5C,YACE,QACA,UACA;AACA,GAAC,KAAK,eAAe,IAAI,OAAO,IAAI,EAAE,EAAE,SAAS,MAAM,GAAG,CAAC;AAC3D,OAAK,eAAe,OAAO,OAAO;;CAGpC,mBACE,SACA;AACA,UAAQ,QAAQ,SAAS,WAAW,KAAK,YAAY,QAAQ,QAAQ,CAAC;;CAGxE,iBACE,SACA;AACA,UAAQ,QAAQ,SAAS,WAAW,KAAK,UAAU,QAAQ,QAAQ,CAAC;;CAGtE,eAAyB,SAA8B;EACrD,MAAM,EAAE,QAAQ,SAAS;EACzB,MAAM,EAAE,WAAW;AAGnB,MAAI,SAAA,oBAAuC,SAAA,QACzC,MAAK,iBAAiB,QAAQ;WACrB,SAAA,UACT,MAAK,mBAAmB,QAAQ;AAGlC,SAAO,KAAK,iBAAiB,EAC3B,SACD,CAAC;AACF,YACE,OAAO,KAAK,wBAAwB;GAClC;GACA;GACD,CAAC;AAEJ,MAAI,SAAA,gBAAmC,QAAQ,MAAM;GACnD,MAAM,EAAE,UAAU,GAAG,GAAG,qBAAqB;AAE7C,UAAO,eACJ,WACE,OAAiB,iBACjB,OAAiB,cAAc,cAAc;IAC5C,GAAG;IACH,SAAS;IACT,QAAQ;IACT,CAAC,CACL;;;CAIL,gBACE,SACoC;EACpC,MAAM,EAAE,QAAQ,UAAU,SAAS;EAEnC,MAAM,SAAS,SAAS,iBAAiB,SAAS,OAAO,YAAY,CAAC;AAEtE,MAAI,CAAC,OACH;EAGF,MAAM,aACJ,SAAA,mBACI,IAAI,OAAO,GACX,OAAO,wBAAwB;EAErC,MAAM,EACJ,QAAQ,YACR,aAAa,IAAI,OAAO,EACxB,qBAAqB,IAAI,OAAO,KAC9B;AAaJ,SAAO;GACL;GACA;GACA;GACA,QAhBa,WACZ,SAAS,WAAW,CACpB,IAAI,WAAW,CACf,UAEC,SAAA,mBACI,UACA,gBAAgB,OAAO,eAAe,CAAC,EAC3C,KACD,CACA,IAAI,mBAAmB;GAOzB;;CAGH,aACE,SACA,cACA;EACA,MAAM,EAAE,WAAW;EACnB,MAAM,EACJ,QAAQ,EAAE,QACV,eACE;AAEJ,SAAO,IAAI;GAAE,OAAO,KAAK;GAAG,QAAQ,KAAK;GAAG,CAAC;AAE7C,OAAK,cAAc,SAAS,aAAa;AAGzC,MAAI,QAAQ,SAAA,kBAAqC;;AAE/C,UAAO,IAAI;IACT,OAAA,aACE,QAAQ,OAAA,QAAA,eAAA,KAAA,IAAA,aAAK,WAAW,IAAI,KAAK,IAAI,cAAc,OAAO,QAAQ;IACpE,MAAA,aAAK,QAAQ,OAAA,QAAA,eAAA,KAAA,IAAA,aAAK,WAAW,IAAI,KAAK,IAAI,cAAc,OAAO,QAAQ;IACxE,CAAC;SACG;AACL,UAAO,oBAAoB,YAAY,QAAQ,OAAO;AAEtD,UAAO,WAAW;AAClB,UAAO,IAAI,SAAS,KAAK;;;CAI7B,cACE,SACA,cACA;EACA,MAAM,EAAE,WAAW;AAEnB,SAAO,eAAe,WAAW;AAC/B,UAAO,UAAU,UACf,KAAK,aAAa,SAAS,cAAc,OAAO;IAClD;AAEF,UAAQ,SAAS,qBAAqB,QAAQ,IAC5C,KAAK,aAAa,SAAS,cAAc,OAAO,SAAyB;;;;;;CAO7E,aACE,SACA,EAAE,UACF,QACA;AAIA,SAAO,IAAI;GACT,MAAM,OAAO,OAAO,OAAO;GAC3B,KAAK,OAAO,MAAM,OAAO;GAC1B,CAAC;;CAGJ,cACE,SACA,cACA;EACA,MAAM,EACJ,QACA,UACA,SACA,cAAc,GACd,GAAG,oBACD;EACJ,MAAM,EAAE,WAAW;AAGnB,SAAO,KAAK,gBAAgB;GAC1B;GACA,QAAQ;GACT,CAAC;AACF,YACE,OAAO,KAAK,uBAAuB;GACjC;GACA,QAAQ;GACR;GACD,CAAC;EAGJ,MAAM,SAAS,OAAO;AACtB,MAAI,YAAA,WAAA,QAAA,WAAA,KAAA,IAAA,KAAA,IAAW,OAAQ,gBAAe;AAEpC,IAAC,gBAAgB,SAAS,gBAAgB,OAAO,EAAE,GAAG,KAAK,OAAO;AAElE,UAAO,cAAc,cAAc;IACjC,GAAG;IACH,QAAQ;IACT,CAAC;;AAEJ,SAAO,IAAI,SAAS,KAAK;;CAG3B,UAAU;EACR,MAAM,EAAE,mBAAmB;AAC3B,iBAAe,SAAS,cAAc,UAAU,SAAS,MAAM,GAAG,CAAC,CAAC;AACpE,iBAAe,OAAO;;CAGxB,WAAW;AACT,SAAO;GACL,MAAM;GACN,UAAW,KAAK,SAAS,YAAsC;GAChE;;CAGH,SAAS;AACP,SAAO,KAAK,UAAU;;;AAI1B,cAAc,SAAS,eAAe,eAAe"}