fabric
Version:
Object model for HTML5 canvas, and SVG-to-canvas parser. Backed by jsdom and node-canvas.
1 lines • 15.1 kB
Source Map (JSON)
{"version":3,"file":"LayoutManager.min.mjs","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"],"names":["LAYOUT_MANAGER","LayoutManager","constructor","strategy","arguments","length","undefined","FitContentLayout","_defineProperty","this","_subscriptions","Map","performLayout","context","strictContext","bubbles","prevStrategy","_prevLayoutStrategy","stopPropagation","onBeforeLayout","layoutResult","getLayoutResult","commitLayout","onAfterLayout","attachHandlers","object","target","MODIFIED","MOVING","RESIZING","ROTATING","SCALING","SKEWING","CHANGED","MODIFY_POLY","MODIFY_PATH","map","key","on","e","type","LAYOUT_TYPE_OBJECT_MODIFIED","trigger","LAYOUT_TYPE_OBJECT_MODIFYING","subscribe","unsubscribe","disposers","set","_context","get","forEach","d","delete","unsubscribeTargets","targets","subscribeTargets","canvas","LAYOUT_TYPE_INITIALIZATION","LAYOUT_TYPE_ADDED","LAYOUT_TYPE_REMOVED","fire","LAYOUT_TYPE_IMPERATIVE","deep","_","tricklingContext","forEachObject","layoutManager","result","calcLayoutResult","getObjects","prevCenter","Point","getRelativeCenterPoint","center","nextCenter","correction","relativeCorrection","offset","subtract","add","transform","iMatrix","invertTransform","calcOwnMatrix","size","_context$x","_context$y","width","x","height","y","layoutObjects","left","resolveOrigin","originX","top","originY","setPositionByOrigin","CENTER","setCoords","group","layoutObject","shouldLayoutClipPath","clipPath","_ref","bubblingContext","parent","path","push","dispose","clear","toObject","toJSON","classRegistry","setClass"],"mappings":"8wBAqCA,MAAMA,EAAiB,gBAOhB,MAAMC,EAMXC,WAAAA,GAA+D,IAAnDC,EAAwBC,UAAAC,OAAA,QAAAC,IAAAF,UAAA,GAAAA,UAAA,GAAG,IAAIG,EAAkBC,EAAAC,KAAA,gBAAA,GAC3DA,KAAKN,SAAWA,EAChBM,KAAKC,eAAiB,IAAIC,GAC5B,CAEOC,aAAAA,CAAcC,GACnB,MAAMC,EAAqC,CACzCC,SAAS,EACTZ,SAAUM,KAAKN,YACZU,EACHG,aAAcP,KAAKQ,oBACnBC,eAAAA,GACET,KAAKM,SAAU,CACjB,GAGFN,KAAKU,eAAeL,GAEpB,MAAMM,EAAeX,KAAKY,gBAAgBP,GACtCM,GACFX,KAAKa,aAAaR,EAAeM,GAGnCX,KAAKc,cAAcT,EAAeM,GAClCX,KAAKQ,oBAAsBH,EAAcX,QAC3C,CAUUqB,cAAAA,CACRC,EACAZ,GAEA,MAAMa,OAAEA,GAAWb,EACnB,MACE,CACEc,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,GAEFC,IAAKC,GACLZ,EAAOa,GAAGD,EAAME,GACd9B,KAAKG,cACHyB,IAAQV,EACJ,CACEa,KAAMC,EACNC,QAASL,EACTE,IACAb,UAEF,CACEc,KAAMG,EACND,QAASL,EACTE,IACAb,YAKd,CAQUkB,SAAAA,CACRnB,EACAZ,GAEAJ,KAAKoC,YAAYpB,EAAQZ,GACzB,MAAMiC,EAAYrC,KAAKe,eAAeC,EAAQZ,GAC9CJ,KAAKC,eAAeqC,IAAItB,EAAQqB,EAClC,CAKUD,WAAAA,CACRpB,EACAuB,IAECvC,KAAKC,eAAeuC,IAAIxB,IAAW,IAAIyB,QAASC,GAAMA,KACvD1C,KAAKC,eAAe0C,OAAO3B,EAC7B,CAEA4B,kBAAAA,CACExC,GAEAA,EAAQyC,QAAQJ,QAASzB,GAAWhB,KAAKoC,YAAYpB,EAAQZ,GAC/D,CAEA0C,gBAAAA,CACE1C,GAEAA,EAAQyC,QAAQJ,QAASzB,GAAWhB,KAAKmC,UAAUnB,EAAQZ,GAC7D,CAEUM,cAAAA,CAAeN,GACvB,MAAMa,OAAEA,EAAMc,KAAEA,GAAS3B,GACnB2C,OAAEA,GAAW9B,EAkBnB,GAfIc,IAASiB,GAA8BjB,IAASkB,EAClDjD,KAAK8C,iBAAiB1C,GACb2B,IAASmB,GAClBlD,KAAK4C,mBAAmBxC,GAG1Ba,EAAOkC,KAAK,gBAAiB,CAC3B/C,YAEF2C,GACEA,EAAOI,KAAK,uBAAwB,CAClClC,SACAb,YAGA2B,IAASqB,GAA0BhD,EAAQiD,KAAM,CACnD,MAAQ3D,SAAU4D,KAAMC,GAAqBnD,EAE7Ca,EAAOuC,cACJxC,GACEA,EAAiByC,eACjBzC,EAAiByC,cAActD,cAAc,IACzCoD,EACHjD,SAAS,EACTW,OAAQD,IAGhB,CACF,CAEUJ,eAAAA,CACRR,GAEA,MAAMa,OAAEA,EAAMvB,SAAEA,EAAQqC,KAAEA,GAAS3B,EAE7BsD,EAAShE,EAASiE,iBAAiBvD,EAASa,EAAO2C,cAEzD,IAAKF,EACH,OAGF,MAAMG,EACJ9B,IAASiB,EACL,IAAIc,EACJ7C,EAAO8C,0BAGXC,OAAQC,EAAUC,WAClBA,EAAa,IAAIJ,EAAOK,mBACxBA,EAAqB,IAAIL,GACvBJ,EACEU,EAASP,EACZQ,SAASJ,GACTK,IAAIJ,GACJK,UAECxC,IAASiB,EACLwB,EACAC,EAAgBxD,EAAOyD,kBAC3B,GAEDJ,IAAIH,GAEP,MAAO,CACLT,SACAG,aACAI,aACAG,SAEJ,CAEUvD,YAAAA,CACRT,EACAO,GAEA,MAAMM,OAAEA,GAAWb,GAEjBsD,QAAQiB,KAAEA,GAAMV,WAChBA,GACEtD,EAO6C,IAAAiE,EAAAC,GALjD5D,EAAOqB,IAAI,CAAEwC,MAAOH,EAAKI,EAAGC,OAAQL,EAAKM,IAEzCjF,KAAKkF,cAAc9E,EAASO,GAGxBP,EAAQ2B,OAASiB,GAEnB/B,EAAOqB,IAAI,CACT6C,KACW,QADPP,EACFxE,EAAQ2E,SAAC,IAAAH,EAAAA,EAAIX,EAAWc,EAAIJ,EAAKI,EAAIK,EAAcnE,EAAOoE,SAC5DC,IAAc,QAAXT,EAAEzE,EAAQ6E,SAAC,IAAAJ,EAAAA,EAAIZ,EAAWgB,EAAIN,EAAKM,EAAIG,EAAcnE,EAAOsE,YAGjEtE,EAAOuE,oBAAoBvB,EAAYwB,EAAQA,GAE/CxE,EAAOyE,YACPzE,EAAOqB,IAAI,SAAS,GAExB,CAEU4C,aAAAA,CACR9E,EACAO,GAEA,MAAMM,OAAEA,GAAWb,EAEnBa,EAAOuC,cAAexC,IACpBA,EAAO2E,QAAU1E,GACfjB,KAAK4F,aAAaxF,EAASO,EAAcK,KAG7CZ,EAAQV,SAASmG,qBAAqBzF,IACpCJ,KAAK4F,aAAaxF,EAASO,EAAcM,EAAO6E,SACpD,CAMUF,YAAAA,CACRxF,EAA4B2F,EAE5B/E,GACA,IAFAoD,OAAEA,GAAgC2B,EAMlC/E,EAAOsB,IAAI,CACT6C,KAAMnE,EAAOmE,KAAOf,EAAOW,EAC3BO,IAAKtE,EAAOsE,IAAMlB,EAAOa,GAE7B,CAEUnE,aAAAA,CACRV,EACAO,GAEA,MAAMM,OACJA,EAAMvB,SACNA,EAAQY,QACRA,EACAC,aAAc+C,KACX0C,GACD5F,GACE2C,OAAEA,GAAW9B,EAGnBA,EAAOkC,KAAK,eAAgB,CAC1B/C,UACAsD,OAAQ/C,IAEVoC,GACEA,EAAOI,KAAK,sBAAuB,CACjC/C,UACAsD,OAAQ/C,EACRM,WAIJ,MAAMgF,EAAShF,EAAOgF,OAClB3F,SAAW2F,GAAAA,EAAQxC,iBAEpBuC,EAAgBE,OAASF,EAAgBE,KAAO,KAAKC,KAAKlF,GAE3DgF,EAAOxC,cAActD,cAAc,IAC9B6F,EACH/E,OAAQgF,KAGZhF,EAAOqB,IAAI,SAAS,EACtB,CAEA8D,OAAAA,GACE,MAAMnG,eAAEA,GAAmBD,KAC3BC,EAAewC,QAASJ,GAAcA,EAAUI,QAASC,GAAMA,MAC/DzC,EAAeoG,OACjB,CAEAC,QAAAA,GACE,MAAO,CACLvE,KAAMxC,EACNG,SAAWM,KAAKN,SAASD,YAAsCsC,KAEnE,CAEAwE,MAAAA,GACE,OAAOvG,KAAKsG,UACd,EAGFE,EAAcC,SAASjH,EAAeD"}