@visactor/vrender-core 1.1.0-alpha.0 → 1.1.0-alpha.2

package/es/graphic/state/attribute-update-classifier.js

@@ -0,0 +1,61 @@
+export var UpdateCategory;
+
+!function(UpdateCategory) {
+    UpdateCategory[UpdateCategory.NONE = 0] = "NONE", UpdateCategory[UpdateCategory.PAINT = 1] = "PAINT", 
+    UpdateCategory[UpdateCategory.SHAPE = 2] = "SHAPE", UpdateCategory[UpdateCategory.BOUNDS = 4] = "BOUNDS", 
+    UpdateCategory[UpdateCategory.TRANSFORM = 8] = "TRANSFORM", UpdateCategory[UpdateCategory.LAYOUT = 16] = "LAYOUT", 
+    UpdateCategory[UpdateCategory.PICK = 32] = "PICK";
+}(UpdateCategory || (UpdateCategory = {}));
+
+export const ATTRIBUTE_CATEGORY = {
+    fill: UpdateCategory.PAINT,
+    opacity: UpdateCategory.PAINT,
+    fillOpacity: UpdateCategory.PAINT,
+    strokeOpacity: UpdateCategory.PAINT,
+    lineDash: UpdateCategory.PAINT,
+    lineDashOffset: UpdateCategory.PAINT,
+    lineCap: UpdateCategory.PAINT,
+    lineJoin: UpdateCategory.PAINT,
+    miterLimit: UpdateCategory.PAINT,
+    shadowColor: UpdateCategory.PAINT,
+    x: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,
+    y: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,
+    scaleX: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,
+    scaleY: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,
+    angle: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,
+    anchor: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,
+    anchor3d: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,
+    postMatrix: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,
+    layout: UpdateCategory.LAYOUT,
+    zIndex: UpdateCategory.PAINT,
+    visible: UpdateCategory.PAINT | UpdateCategory.PICK,
+    lineWidth: UpdateCategory.SHAPE | UpdateCategory.BOUNDS | UpdateCategory.PICK,
+    width: UpdateCategory.SHAPE | UpdateCategory.BOUNDS,
+    height: UpdateCategory.SHAPE | UpdateCategory.BOUNDS
+};
+
+const ATTRIBUTE_DELTA_CLASSIFIER = {
+    stroke: (prev, next) => (null != prev && !1 !== prev) !== (null != next && !1 !== next) ? UpdateCategory.PAINT | UpdateCategory.BOUNDS | UpdateCategory.PICK : UpdateCategory.PAINT,
+    shadowBlur: (prev, next) => {
+        const prevBlur = Number(null != prev ? prev : 0), nextBlur = Number(null != next ? next : 0);
+        return prevBlur !== nextBlur && (prevBlur > 0 || nextBlur > 0) ? UpdateCategory.PAINT | UpdateCategory.BOUNDS : UpdateCategory.PAINT;
+    }
+};
+
+export function classifyAttributeDelta(key, prev, next) {
+    var _a;
+    const dynamicClassifier = ATTRIBUTE_DELTA_CLASSIFIER[key];
+    return dynamicClassifier ? dynamicClassifier(prev, next) : null !== (_a = ATTRIBUTE_CATEGORY[key]) && void 0 !== _a ? _a : UpdateCategory.PAINT;
+}
+
+export function classifyAffectedKeyConservatively(key) {
+    var _a;
+    return "stroke" === key ? UpdateCategory.PAINT | UpdateCategory.BOUNDS | UpdateCategory.PICK : "shadowBlur" === key ? UpdateCategory.PAINT | UpdateCategory.BOUNDS : null !== (_a = ATTRIBUTE_CATEGORY[key]) && void 0 !== _a ? _a : UpdateCategory.PAINT;
+}
+
+export function classifyAffectedKeys(keys) {
+    let category = UpdateCategory.NONE;
+    for (const key of keys) category |= classifyAffectedKeyConservatively(key);
+    return category;
+}
+//# sourceMappingURL=attribute-update-classifier.js.map

package/es/graphic/state/attribute-update-classifier.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/graphic/state/attribute-update-classifier.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,cAQX;AARD,WAAY,cAAc;IACxB,mDAAQ,CAAA;IACR,qDAAc,CAAA;IACd,qDAAc,CAAA;IACd,uDAAe,CAAA;IACf,6DAAkB,CAAA;IAClB,wDAAe,CAAA;IACf,oDAAa,CAAA;AACf,CAAC,EARW,cAAc,KAAd,cAAc,QAQzB;AAID,MAAM,CAAC,MAAM,kBAAkB,GAAmC;IAChE,IAAI,EAAE,cAAc,CAAC,KAAK;IAC1B,OAAO,EAAE,cAAc,CAAC,KAAK;IAC7B,WAAW,EAAE,cAAc,CAAC,KAAK;IACjC,aAAa,EAAE,cAAc,CAAC,KAAK;IACnC,QAAQ,EAAE,cAAc,CAAC,KAAK;IAC9B,cAAc,EAAE,cAAc,CAAC,KAAK;IACpC,OAAO,EAAE,cAAc,CAAC,KAAK;IAC7B,QAAQ,EAAE,cAAc,CAAC,KAAK;IAC9B,UAAU,EAAE,cAAc,CAAC,KAAK;IAChC,WAAW,EAAE,cAAc,CAAC,KAAK;IACjC,CAAC,EAAE,cAAc,CAAC,SAAS,GAAG,cAAc,CAAC,MAAM;IACnD,CAAC,EAAE,cAAc,CAAC,SAAS,GAAG,cAAc,CAAC,MAAM;IACnD,MAAM,EAAE,cAAc,CAAC,SAAS,GAAG,cAAc,CAAC,MAAM;IACxD,MAAM,EAAE,cAAc,CAAC,SAAS,GAAG,cAAc,CAAC,MAAM;IACxD,KAAK,EAAE,cAAc,CAAC,SAAS,GAAG,cAAc,CAAC,MAAM;IACvD,MAAM,EAAE,cAAc,CAAC,SAAS,GAAG,cAAc,CAAC,MAAM;IACxD,QAAQ,EAAE,cAAc,CAAC,SAAS,GAAG,cAAc,CAAC,MAAM;IAC1D,UAAU,EAAE,cAAc,CAAC,SAAS,GAAG,cAAc,CAAC,MAAM;IAC5D,MAAM,EAAE,cAAc,CAAC,MAAM;IAC7B,MAAM,EAAE,cAAc,CAAC,KAAK;IAC5B,OAAO,EAAE,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,IAAI;IACnD,SAAS,EAAE,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,MAAM,GAAG,cAAc,CAAC,IAAI;IAC7E,KAAK,EAAE,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,MAAM;IACnD,MAAM,EAAE,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,MAAM;CACrD,CAAC;AAEF,MAAM,0BAA0B,GAA6C;IAC3E,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;QACrB,MAAM,WAAW,GAAG,IAAI,IAAI,IAAI,IAAI,IAAI,KAAK,KAAK,CAAC;QACnD,MAAM,WAAW,GAAG,IAAI,IAAI,IAAI,IAAI,IAAI,KAAK,KAAK,CAAC;QACnD,IAAI,WAAW,KAAK,WAAW,EAAE;YAC/B,OAAO,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC;SAC3E;QACD,OAAO,cAAc,CAAC,KAAK,CAAC;IAC9B,CAAC;IACD,UAAU,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;QACzB,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,CAAC,CAAC,CAAC;QACnC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,CAAC,CAAC,CAAC;QACnC,IAAI,QAAQ,KAAK,QAAQ,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,QAAQ,GAAG,CAAC,CAAC,EAAE;YAC3D,OAAO,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC;SACrD;QACD,OAAO,cAAc,CAAC,KAAK,CAAC;IAC9B,CAAC;CACF,CAAC;AAEF,MAAM,UAAU,sBAAsB,CAAC,GAAW,EAAE,IAAa,EAAE,IAAa;;IAC9E,MAAM,iBAAiB,GAAG,0BAA0B,CAAC,GAAG,CAAC,CAAC;IAC1D,IAAI,iBAAiB,EAAE;QACrB,OAAO,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;KACtC;IAED,OAAO,MAAA,kBAAkB,CAAC,GAAG,CAAC,mCAAI,cAAc,CAAC,KAAK,CAAC;AACzD,CAAC;AAED,MAAM,UAAU,iCAAiC,CAAC,GAAW;;IAC3D,IAAI,GAAG,KAAK,QAAQ,EAAE;QACpB,OAAO,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC;KAC3E;IAED,IAAI,GAAG,KAAK,YAAY,EAAE;QACxB,OAAO,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC;KACrD;IAED,OAAO,MAAA,kBAAkB,CAAC,GAAG,CAAC,mCAAI,cAAc,CAAC,KAAK,CAAC;AACzD,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAsB;IACzD,IAAI,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC;IACnC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,QAAQ,IAAI,iCAAiC,CAAC,GAAG,CAAC,CAAC;KACpD;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC","file":"attribute-update-classifier.js","sourcesContent":["export enum UpdateCategory {\n  NONE = 0,\n  PAINT = 1 << 0,\n  SHAPE = 1 << 1,\n  BOUNDS = 1 << 2,\n  TRANSFORM = 1 << 3,\n  LAYOUT = 1 << 4,\n  PICK = 1 << 5\n}\n\ntype AttributeDeltaClassifier = (prev: unknown, next: unknown) => UpdateCategory;\n\nexport const ATTRIBUTE_CATEGORY: Record<string, UpdateCategory> = {\n  fill: UpdateCategory.PAINT,\n  opacity: UpdateCategory.PAINT,\n  fillOpacity: UpdateCategory.PAINT,\n  strokeOpacity: UpdateCategory.PAINT,\n  lineDash: UpdateCategory.PAINT,\n  lineDashOffset: UpdateCategory.PAINT,\n  lineCap: UpdateCategory.PAINT,\n  lineJoin: UpdateCategory.PAINT,\n  miterLimit: UpdateCategory.PAINT,\n  shadowColor: UpdateCategory.PAINT,\n  x: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,\n  y: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,\n  scaleX: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,\n  scaleY: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,\n  angle: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,\n  anchor: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,\n  anchor3d: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,\n  postMatrix: UpdateCategory.TRANSFORM | UpdateCategory.BOUNDS,\n  layout: UpdateCategory.LAYOUT,\n  zIndex: UpdateCategory.PAINT,\n  visible: UpdateCategory.PAINT | UpdateCategory.PICK,\n  lineWidth: UpdateCategory.SHAPE | UpdateCategory.BOUNDS | UpdateCategory.PICK,\n  width: UpdateCategory.SHAPE | UpdateCategory.BOUNDS,\n  height: UpdateCategory.SHAPE | UpdateCategory.BOUNDS\n};\n\nconst ATTRIBUTE_DELTA_CLASSIFIER: Record<string, AttributeDeltaClassifier> = {\n  stroke: (prev, next) => {\n    const prevEnabled = prev != null && prev !== false;\n    const nextEnabled = next != null && next !== false;\n    if (prevEnabled !== nextEnabled) {\n      return UpdateCategory.PAINT | UpdateCategory.BOUNDS | UpdateCategory.PICK;\n    }\n    return UpdateCategory.PAINT;\n  },\n  shadowBlur: (prev, next) => {\n    const prevBlur = Number(prev ?? 0);\n    const nextBlur = Number(next ?? 0);\n    if (prevBlur !== nextBlur && (prevBlur > 0 || nextBlur > 0)) {\n      return UpdateCategory.PAINT | UpdateCategory.BOUNDS;\n    }\n    return UpdateCategory.PAINT;\n  }\n};\n\nexport function classifyAttributeDelta(key: string, prev: unknown, next: unknown): UpdateCategory {\n  const dynamicClassifier = ATTRIBUTE_DELTA_CLASSIFIER[key];\n  if (dynamicClassifier) {\n    return dynamicClassifier(prev, next);\n  }\n\n  return ATTRIBUTE_CATEGORY[key] ?? UpdateCategory.PAINT;\n}\n\nexport function classifyAffectedKeyConservatively(key: string): UpdateCategory {\n  if (key === 'stroke') {\n    return UpdateCategory.PAINT | UpdateCategory.BOUNDS | UpdateCategory.PICK;\n  }\n\n  if (key === 'shadowBlur') {\n    return UpdateCategory.PAINT | UpdateCategory.BOUNDS;\n  }\n\n  return ATTRIBUTE_CATEGORY[key] ?? UpdateCategory.PAINT;\n}\n\nexport function classifyAffectedKeys(keys: Iterable<string>): UpdateCategory {\n  let category = UpdateCategory.NONE;\n  for (const key of keys) {\n    category |= classifyAffectedKeyConservatively(key);\n  }\n  return category;\n}\n"]}

package/es/graphic/state/shared-state-refresh.d.ts

@@ -0,0 +1,6 @@
+import type { IGraphic, IStage } from '../../interface';
+import type { SharedStateScope } from './shared-state-scope';
+export declare function scheduleStageSharedStateRefresh(stage: IStage | undefined): void;
+export declare function enqueueGraphicSharedStateRefresh(stage: IStage | undefined, graphic: IGraphic): void;
+export declare function markScopeActiveDescendantsDirty<T extends Record<string, any> = Record<string, any>>(scope: SharedStateScope<T>, stage?: IStage): void;
+export declare function flushStageSharedStateRefresh(stage: IStage): void;

package/es/graphic/state/shared-state-refresh.js

@@ -0,0 +1,46 @@
+import { getStageStatePerfMonitor } from "./state-perf-monitor";
+
+export function scheduleStageSharedStateRefresh(stage) {
+    var _a;
+    stage && "released" !== stage.releaseStatus && (null === (_a = getStageStatePerfMonitor(stage)) || void 0 === _a || _a.recordRefresh("renderScheduled"), 
+    stage.renderNextFrame());
+}
+
+export function enqueueGraphicSharedStateRefresh(stage, graphic) {
+    var _a;
+    if (!stage) return;
+    const pending = null !== (_a = stage._pendingSharedStateRefreshGraphics) && void 0 !== _a ? _a : stage._pendingSharedStateRefreshGraphics = new Set;
+    if (!pending.has(graphic)) {
+        pending.add(graphic);
+        const perfMonitor = getStageStatePerfMonitor(stage);
+        null == perfMonitor || perfMonitor.recordRefresh("queuedGraphics"), null == perfMonitor || perfMonitor.recordAllocation("refreshQueuePushes");
+    }
+}
+
+export function markScopeActiveDescendantsDirty(scope, stage) {
+    let marked = !1;
+    scope.subtreeActiveDescendants.forEach((graphic => {
+        var _a;
+        graphic.sharedStateDirty = !0;
+        enqueueGraphicSharedStateRefresh(null !== (_a = null != stage ? stage : graphic.stage) && void 0 !== _a ? _a : scope.ownerStage, graphic), 
+        marked = !0;
+    })), marked && scheduleStageSharedStateRefresh(null != stage ? stage : scope.ownerStage);
+}
+
+export function flushStageSharedStateRefresh(stage) {
+    const pending = stage._pendingSharedStateRefreshGraphics;
+    if (!pending || !pending.size) return;
+    const perfMonitor = getStageStatePerfMonitor(stage), start = perfMonitor ? performance.now() : 0, graphics = Array.from(pending.values());
+    pending.clear(), null == perfMonitor || perfMonitor.recordRefresh("flushedGraphics", graphics.length), 
+    graphics.forEach((graphic => {
+        if ("released" === graphic.releaseStatus) return;
+        if (graphic.stage !== stage) return;
+        const refresh = graphic.refreshSharedStateBeforeRender;
+        "function" == typeof refresh && (refresh.call(graphic), null == perfMonitor || perfMonitor.incrementCounter("sharedRefreshCommits"));
+    })), perfMonitor && (perfMonitor.recordCost("sharedRefresh", performance.now() - start), 
+    perfMonitor.recordEvent("shared-refresh-flush", {
+        stageId: stage._uid,
+        flushedGraphics: graphics.length
+    }));
+}
+//# sourceMappingURL=shared-state-refresh.js.map

package/es/graphic/state/shared-state-refresh.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/graphic/state/shared-state-refresh.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAEhE,MAAM,UAAU,+BAA+B,CAAC,KAAyB;;IACvE,IAAI,CAAC,KAAK,IAAK,KAAa,CAAC,aAAa,KAAK,UAAU,EAAE;QACzD,OAAO;KACR;IAED,MAAA,wBAAwB,CAAC,KAAK,CAAC,0CAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;IAClE,KAAK,CAAC,eAAe,EAAE,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,gCAAgC,CAAC,KAAyB,EAAE,OAAiB;;IAC3F,IAAI,CAAC,KAAK,EAAE;QACV,OAAO;KACR;IAED,MAAM,OAAO,GACX,MAAE,KAAa,CAAC,kCAAgE,mCAC/E,CAAE,KAAa,CAAC,kCAAkC,GAAG,IAAI,GAAG,EAAY,CAAmB,CAAC;IAE/F,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;QACzB,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACrB,MAAM,WAAW,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;QACpD,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;QAC7C,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;KACrD;AACH,CAAC;AAED,MAAM,UAAU,+BAA+B,CAC7C,KAA0B,EAC1B,KAAc;IAEd,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,KAAK,CAAC,wBAAwB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;;QAC9C,OAAe,CAAC,gBAAgB,GAAG,IAAI,CAAC;QACzC,MAAM,UAAU,GAAG,MAAA,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,OAAO,CAAC,KAAK,mCAAI,KAAK,CAAC,UAAU,CAAC;QAC9D,gCAAgC,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACtD,MAAM,GAAG,IAAI,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,IAAI,MAAM,EAAE;QACV,+BAA+B,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,KAAK,CAAC,UAAU,CAAC,CAAC;KAC5D;AACH,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,KAAa;IACxD,MAAM,OAAO,GAAI,KAAa,CAAC,kCAA+D,CAAC;IAC/F,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;QAC7B,OAAO;KACR;IAED,MAAM,WAAW,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC9C,OAAO,CAAC,KAAK,EAAE,CAAC;IAChB,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,aAAa,CAAC,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAE/D,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QACzB,IAAK,OAAe,CAAC,aAAa,KAAK,UAAU,EAAE;YACjD,OAAO;SACR;QACD,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK,EAAE;YAC3B,OAAO;SACR;QAED,MAAM,OAAO,GAAI,OAAe,CAAC,8BAA8B,CAAC;QAChE,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YACjC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACtB,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;SACvD;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,WAAW,EAAE;QACf,WAAW,CAAC,UAAU,CAAC,eAAe,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC;QACnE,WAAW,CAAC,WAAW,CAAC,sBAAsB,EAAE;YAC9C,OAAO,EAAG,KAAa,CAAC,IAAI;YAC5B,eAAe,EAAE,QAAQ,CAAC,MAAM;SACjC,CAAC,CAAC;KACJ;AACH,CAAC","file":"shared-state-refresh.js","sourcesContent":["import type { IGraphic, IStage } from '../../interface';\nimport type { SharedStateScope } from './shared-state-scope';\nimport { getStageStatePerfMonitor } from './state-perf-monitor';\n\nexport function scheduleStageSharedStateRefresh(stage: IStage | undefined): void {\n  if (!stage || (stage as any).releaseStatus === 'released') {\n    return;\n  }\n\n  getStageStatePerfMonitor(stage)?.recordRefresh('renderScheduled');\n  stage.renderNextFrame();\n}\n\nexport function enqueueGraphicSharedStateRefresh(stage: IStage | undefined, graphic: IGraphic): void {\n  if (!stage) {\n    return;\n  }\n\n  const pending =\n    ((stage as any)._pendingSharedStateRefreshGraphics as Set<IGraphic> | undefined) ??\n    (((stage as any)._pendingSharedStateRefreshGraphics = new Set<IGraphic>()) as Set<IGraphic>);\n\n  if (!pending.has(graphic)) {\n    pending.add(graphic);\n    const perfMonitor = getStageStatePerfMonitor(stage);\n    perfMonitor?.recordRefresh('queuedGraphics');\n    perfMonitor?.recordAllocation('refreshQueuePushes');\n  }\n}\n\nexport function markScopeActiveDescendantsDirty<T extends Record<string, any> = Record<string, any>>(\n  scope: SharedStateScope<T>,\n  stage?: IStage\n): void {\n  let marked = false;\n  scope.subtreeActiveDescendants.forEach(graphic => {\n    (graphic as any).sharedStateDirty = true;\n    const ownerStage = stage ?? graphic.stage ?? scope.ownerStage;\n    enqueueGraphicSharedStateRefresh(ownerStage, graphic);\n    marked = true;\n  });\n\n  if (marked) {\n    scheduleStageSharedStateRefresh(stage ?? scope.ownerStage);\n  }\n}\n\nexport function flushStageSharedStateRefresh(stage: IStage): void {\n  const pending = (stage as any)._pendingSharedStateRefreshGraphics as Set<IGraphic> | undefined;\n  if (!pending || !pending.size) {\n    return;\n  }\n\n  const perfMonitor = getStageStatePerfMonitor(stage);\n  const start = perfMonitor ? performance.now() : 0;\n  const graphics = Array.from(pending.values());\n  pending.clear();\n  perfMonitor?.recordRefresh('flushedGraphics', graphics.length);\n\n  graphics.forEach(graphic => {\n    if ((graphic as any).releaseStatus === 'released') {\n      return;\n    }\n    if (graphic.stage !== stage) {\n      return;\n    }\n\n    const refresh = (graphic as any).refreshSharedStateBeforeRender;\n    if (typeof refresh === 'function') {\n      refresh.call(graphic);\n      perfMonitor?.incrementCounter('sharedRefreshCommits');\n    }\n  });\n\n  if (perfMonitor) {\n    perfMonitor.recordCost('sharedRefresh', performance.now() - start);\n    perfMonitor.recordEvent('shared-refresh-flush', {\n      stageId: (stage as any)._uid,\n      flushedGraphics: graphics.length\n    });\n  }\n}\n"]}

package/es/graphic/state/shared-state-scope.d.ts

@@ -0,0 +1,25 @@
+import type { IGraphic, IStage } from '../../interface';
+import type { IGroup } from '../../interface/graphic/group';
+import type { CompiledStateDefinition, StateDefinitionsInput } from './state-definition';
+export interface SharedStateScope<T extends Record<string, any> = Record<string, any>> {
+    ownerKind: 'group' | 'root';
+    ownerGroup?: IGroup;
+    ownerStage?: IStage;
+    parentScope?: SharedStateScope<T>;
+    themeStateDefinitions?: StateDefinitionsInput<T>;
+    localStateDefinitions?: StateDefinitionsInput<T>;
+    effectiveSourceDefinitions: StateDefinitionsInput<T>;
+    effectiveCompiledDefinitions: Map<string, CompiledStateDefinition<T>>;
+    revision: number;
+    parentRevisionAtBuild?: number;
+    dirty: boolean;
+    subtreeActiveDescendants: Set<IGraphic>;
+}
+export declare function createRootSharedStateScope<T extends Record<string, any> = Record<string, any>>(stage: IStage, themeStateDefinitions?: StateDefinitionsInput<T>): SharedStateScope<T>;
+export declare function createGroupSharedStateScope<T extends Record<string, any> = Record<string, any>>(group: IGroup, parentScope?: SharedStateScope<T>, localStateDefinitions?: StateDefinitionsInput<T>): SharedStateScope<T>;
+export declare function setSharedStateScopeParent<T extends Record<string, any> = Record<string, any>>(scope: SharedStateScope<T>, parentScope?: SharedStateScope<T>): boolean;
+export declare function setSharedStateScopeLocalDefinitions<T extends Record<string, any> = Record<string, any>>(scope: SharedStateScope<T>, localStateDefinitions?: StateDefinitionsInput<T>): boolean;
+export declare function setRootSharedStateScopeThemeDefinitions<T extends Record<string, any> = Record<string, any>>(scope: SharedStateScope<T>, themeStateDefinitions?: StateDefinitionsInput<T>): boolean;
+export declare function rebuildSharedStateScope<T extends Record<string, any> = Record<string, any>>(scope: SharedStateScope<T>): SharedStateScope<T>;
+export declare function ensureSharedStateScopeFresh<T extends Record<string, any> = Record<string, any>>(scope?: SharedStateScope<T>): SharedStateScope<T> | undefined;
+export declare function collectSharedStateScopeChain<T extends Record<string, any> = Record<string, any>>(scope?: SharedStateScope<T>): SharedStateScope<T>[];

package/es/graphic/state/shared-state-scope.js

@@ -0,0 +1,90 @@
+import { StateDefinitionCompiler } from "./state-definition-compiler";
+
+import { getStageStatePerfMonitor } from "./state-perf-monitor";
+
+const compiler = new StateDefinitionCompiler;
+
+function copyDefinitions(definitions) {
+    return definitions ? Object.assign({}, definitions) : {};
+}
+
+function buildEffectiveSourceDefinitions(parentScope, localStateDefinitions, themeStateDefinitions) {
+    const merged = copyDefinitions(parentScope ? parentScope.effectiveSourceDefinitions : themeStateDefinitions);
+    return localStateDefinitions && Object.keys(localStateDefinitions).forEach((stateName => {
+        merged[stateName] = localStateDefinitions[stateName];
+    })), merged;
+}
+
+function initializeScope(scope, revision = 0) {
+    var _a;
+    const effectiveSourceDefinitions = buildEffectiveSourceDefinitions(scope.parentScope, scope.localStateDefinitions, scope.themeStateDefinitions);
+    return scope.effectiveSourceDefinitions = effectiveSourceDefinitions, scope.effectiveCompiledDefinitions = compiler.compile(effectiveSourceDefinitions), 
+    scope.parentRevisionAtBuild = null === (_a = scope.parentScope) || void 0 === _a ? void 0 : _a.revision, 
+    scope.revision = revision, scope.dirty = !1, scope;
+}
+
+export function createRootSharedStateScope(stage, themeStateDefinitions) {
+    return initializeScope({
+        ownerKind: "root",
+        ownerStage: stage,
+        themeStateDefinitions: themeStateDefinitions,
+        effectiveSourceDefinitions: {},
+        effectiveCompiledDefinitions: new Map,
+        revision: 0,
+        dirty: !1,
+        subtreeActiveDescendants: new Set
+    }, 0);
+}
+
+export function createGroupSharedStateScope(group, parentScope, localStateDefinitions) {
+    return initializeScope({
+        ownerKind: "group",
+        ownerGroup: group,
+        ownerStage: group.stage,
+        parentScope: parentScope,
+        localStateDefinitions: localStateDefinitions,
+        effectiveSourceDefinitions: {},
+        effectiveCompiledDefinitions: new Map,
+        revision: 0,
+        dirty: !1,
+        subtreeActiveDescendants: new Set
+    }, 0);
+}
+
+export function setSharedStateScopeParent(scope, parentScope) {
+    return scope.parentScope !== parentScope && (scope.parentScope = parentScope, scope.dirty = !0, 
+    !0);
+}
+
+export function setSharedStateScopeLocalDefinitions(scope, localStateDefinitions) {
+    return scope.localStateDefinitions !== localStateDefinitions && (scope.localStateDefinitions = localStateDefinitions, 
+    rebuildSharedStateScope(scope), !0);
+}
+
+export function setRootSharedStateScopeThemeDefinitions(scope, themeStateDefinitions) {
+    return scope.themeStateDefinitions !== themeStateDefinitions && (scope.themeStateDefinitions = themeStateDefinitions, 
+    rebuildSharedStateScope(scope), !0);
+}
+
+export function rebuildSharedStateScope(scope) {
+    var _a;
+    const effectiveSourceDefinitions = buildEffectiveSourceDefinitions(scope.parentScope, scope.localStateDefinitions, scope.themeStateDefinitions);
+    return scope.effectiveSourceDefinitions = effectiveSourceDefinitions, scope.effectiveCompiledDefinitions = compiler.compile(effectiveSourceDefinitions), 
+    scope.parentRevisionAtBuild = null === (_a = scope.parentScope) || void 0 === _a ? void 0 : _a.revision, 
+    scope.revision += 1, scope.dirty = !1, scope;
+}
+
+export function ensureSharedStateScopeFresh(scope) {
+    var _a;
+    if (scope) return null === (_a = getStageStatePerfMonitor(scope.ownerStage)) || void 0 === _a || _a.recordRefresh("ensureFreshCalls"), 
+    scope.parentScope && ensureSharedStateScopeFresh(scope.parentScope), (scope.dirty || scope.parentScope && scope.parentRevisionAtBuild !== scope.parentScope.revision) && rebuildSharedStateScope(scope), 
+    scope;
+}
+
+export function collectSharedStateScopeChain(scope) {
+    const chain = [];
+    let current = scope;
+    for (;current; ) chain.push(current), current = current.parentScope;
+    return chain;
+}
+//# sourceMappingURL=shared-state-scope.js.map

package/es/graphic/state/shared-state-scope.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/graphic/state/shared-state-scope.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAEtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAiBhE,MAAM,QAAQ,GAAG,IAAI,uBAAuB,EAAO,CAAC;AAEpD,SAAS,eAAe,CACtB,WAAsC;IAEtC,OAAO,WAAW,CAAC,CAAC,CAAE,kBAAK,WAAW,CAA+B,CAAC,CAAC,CAAE,EAA+B,CAAC;AAC3G,CAAC;AAED,SAAS,+BAA+B,CACtC,WAAiC,EACjC,qBAAgD,EAChD,qBAAgD;IAEhD,MAAM,MAAM,GAAG,WAAW;QACxB,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,0BAA0B,CAAC;QACzD,CAAC,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC;IAE3C,IAAI,qBAAqB,EAAE;QACzB,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YACrD,MAAM,CAAC,SAAS,CAAC,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;KACJ;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,eAAe,CACtB,KAA0B,EAC1B,WAAmB,CAAC;;IAEpB,MAAM,0BAA0B,GAAG,+BAA+B,CAChE,KAAK,CAAC,WAAW,EACjB,KAAK,CAAC,qBAAqB,EAC3B,KAAK,CAAC,qBAAqB,CAC5B,CAAC;IAEF,KAAK,CAAC,0BAA0B,GAAG,0BAA0B,CAAC;IAC9D,KAAK,CAAC,4BAA4B,GAAG,QAAQ,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAClF,KAAK,CAAC,qBAAqB,GAAG,MAAA,KAAK,CAAC,WAAW,0CAAE,QAAQ,CAAC;IAC1D,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC1B,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;IAEpB,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,KAAa,EACb,qBAAgD;IAEhD,OAAO,eAAe,CACpB;QACE,SAAS,EAAE,MAAM;QACjB,UAAU,EAAE,KAAK;QACjB,qBAAqB;QACrB,0BAA0B,EAAE,EAA8B;QAC1D,4BAA4B,EAAE,IAAI,GAAG,EAAE;QACvC,QAAQ,EAAE,CAAC;QACX,KAAK,EAAE,KAAK;QACZ,wBAAwB,EAAE,IAAI,GAAG,EAAE;KACpC,EACD,CAAC,CACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,KAAa,EACb,WAAiC,EACjC,qBAAgD;IAEhD,OAAO,eAAe,CACpB;QACE,SAAS,EAAE,OAAO;QAClB,UAAU,EAAE,KAAK;QACjB,UAAU,EAAE,KAAK,CAAC,KAAK;QACvB,WAAW;QACX,qBAAqB;QACrB,0BAA0B,EAAE,EAA8B;QAC1D,4BAA4B,EAAE,IAAI,GAAG,EAAE;QACvC,QAAQ,EAAE,CAAC;QACX,KAAK,EAAE,KAAK;QACZ,wBAAwB,EAAE,IAAI,GAAG,EAAE;KACpC,EACD,CAAC,CACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,KAA0B,EAC1B,WAAiC;IAEjC,IAAI,KAAK,CAAC,WAAW,KAAK,WAAW,EAAE;QACrC,OAAO,KAAK,CAAC;KACd;IAED,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;IAChC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC;IACnB,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,mCAAmC,CACjD,KAA0B,EAC1B,qBAAgD;IAEhD,IAAI,KAAK,CAAC,qBAAqB,KAAK,qBAAqB,EAAE;QACzD,OAAO,KAAK,CAAC;KACd;IAED,KAAK,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;IACpD,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAC/B,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,uCAAuC,CACrD,KAA0B,EAC1B,qBAAgD;IAEhD,IAAI,KAAK,CAAC,qBAAqB,KAAK,qBAAqB,EAAE;QACzD,OAAO,KAAK,CAAC;KACd;IAED,KAAK,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;IACpD,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAC/B,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,KAA0B;;IAE1B,MAAM,0BAA0B,GAAG,+BAA+B,CAChE,KAAK,CAAC,WAAW,EACjB,KAAK,CAAC,qBAAqB,EAC3B,KAAK,CAAC,qBAAqB,CAC5B,CAAC;IAEF,KAAK,CAAC,0BAA0B,GAAG,0BAA0B,CAAC;IAC9D,KAAK,CAAC,4BAA4B,GAAG,QAAQ,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAClF,KAAK,CAAC,qBAAqB,GAAG,MAAA,KAAK,CAAC,WAAW,0CAAE,QAAQ,CAAC;IAC1D,KAAK,CAAC,QAAQ,IAAI,CAAC,CAAC;IACpB,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;IAEpB,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,KAA2B;;IAE3B,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,SAAS,CAAC;KAClB;IAED,MAAA,wBAAwB,CAAC,KAAK,CAAC,UAAU,CAAC,0CAAE,aAAa,CAAC,kBAAkB,CAAC,CAAC;IAE9E,IAAI,KAAK,CAAC,WAAW,EAAE;QACrB,2BAA2B,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;KAChD;IAED,IAAI,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,qBAAqB,KAAK,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;QACpG,uBAAuB,CAAC,KAAK,CAAC,CAAC;KAChC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,4BAA4B,CAC1C,KAA2B;IAE3B,MAAM,KAAK,GAA0B,EAAE,CAAC;IACxC,IAAI,OAAO,GAAG,KAAK,CAAC;IAEpB,OAAO,OAAO,EAAE;QACd,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpB,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;KAC/B;IAED,OAAO,KAAK,CAAC;AACf,CAAC","file":"shared-state-scope.js","sourcesContent":["import type { IGraphic, IStage } from '../../interface';\nimport type { IGroup } from '../../interface/graphic/group';\nimport { StateDefinitionCompiler } from './state-definition-compiler';\nimport type { CompiledStateDefinition, StateDefinitionsInput } from './state-definition';\nimport { getStageStatePerfMonitor } from './state-perf-monitor';\n\nexport interface SharedStateScope<T extends Record<string, any> = Record<string, any>> {\n  ownerKind: 'group' | 'root';\n  ownerGroup?: IGroup;\n  ownerStage?: IStage;\n  parentScope?: SharedStateScope<T>;\n  themeStateDefinitions?: StateDefinitionsInput<T>;\n  localStateDefinitions?: StateDefinitionsInput<T>;\n  effectiveSourceDefinitions: StateDefinitionsInput<T>;\n  effectiveCompiledDefinitions: Map<string, CompiledStateDefinition<T>>;\n  revision: number;\n  parentRevisionAtBuild?: number;\n  dirty: boolean;\n  subtreeActiveDescendants: Set<IGraphic>;\n}\n\nconst compiler = new StateDefinitionCompiler<any>();\n\nfunction copyDefinitions<T extends Record<string, any>>(\n  definitions?: StateDefinitionsInput<T>\n): StateDefinitionsInput<T> {\n  return definitions ? ({ ...definitions } as StateDefinitionsInput<T>) : ({} as StateDefinitionsInput<T>);\n}\n\nfunction buildEffectiveSourceDefinitions<T extends Record<string, any>>(\n  parentScope?: SharedStateScope<T>,\n  localStateDefinitions?: StateDefinitionsInput<T>,\n  themeStateDefinitions?: StateDefinitionsInput<T>\n): StateDefinitionsInput<T> {\n  const merged = parentScope\n    ? copyDefinitions(parentScope.effectiveSourceDefinitions)\n    : copyDefinitions(themeStateDefinitions);\n\n  if (localStateDefinitions) {\n    Object.keys(localStateDefinitions).forEach(stateName => {\n      merged[stateName] = localStateDefinitions[stateName];\n    });\n  }\n\n  return merged;\n}\n\nfunction initializeScope<T extends Record<string, any>>(\n  scope: SharedStateScope<T>,\n  revision: number = 0\n): SharedStateScope<T> {\n  const effectiveSourceDefinitions = buildEffectiveSourceDefinitions(\n    scope.parentScope,\n    scope.localStateDefinitions,\n    scope.themeStateDefinitions\n  );\n\n  scope.effectiveSourceDefinitions = effectiveSourceDefinitions;\n  scope.effectiveCompiledDefinitions = compiler.compile(effectiveSourceDefinitions);\n  scope.parentRevisionAtBuild = scope.parentScope?.revision;\n  scope.revision = revision;\n  scope.dirty = false;\n\n  return scope;\n}\n\nexport function createRootSharedStateScope<T extends Record<string, any> = Record<string, any>>(\n  stage: IStage,\n  themeStateDefinitions?: StateDefinitionsInput<T>\n): SharedStateScope<T> {\n  return initializeScope(\n    {\n      ownerKind: 'root',\n      ownerStage: stage,\n      themeStateDefinitions,\n      effectiveSourceDefinitions: {} as StateDefinitionsInput<T>,\n      effectiveCompiledDefinitions: new Map(),\n      revision: 0,\n      dirty: false,\n      subtreeActiveDescendants: new Set()\n    },\n    0\n  );\n}\n\nexport function createGroupSharedStateScope<T extends Record<string, any> = Record<string, any>>(\n  group: IGroup,\n  parentScope?: SharedStateScope<T>,\n  localStateDefinitions?: StateDefinitionsInput<T>\n): SharedStateScope<T> {\n  return initializeScope(\n    {\n      ownerKind: 'group',\n      ownerGroup: group,\n      ownerStage: group.stage,\n      parentScope,\n      localStateDefinitions,\n      effectiveSourceDefinitions: {} as StateDefinitionsInput<T>,\n      effectiveCompiledDefinitions: new Map(),\n      revision: 0,\n      dirty: false,\n      subtreeActiveDescendants: new Set()\n    },\n    0\n  );\n}\n\nexport function setSharedStateScopeParent<T extends Record<string, any> = Record<string, any>>(\n  scope: SharedStateScope<T>,\n  parentScope?: SharedStateScope<T>\n): boolean {\n  if (scope.parentScope === parentScope) {\n    return false;\n  }\n\n  scope.parentScope = parentScope;\n  scope.dirty = true;\n  return true;\n}\n\nexport function setSharedStateScopeLocalDefinitions<T extends Record<string, any> = Record<string, any>>(\n  scope: SharedStateScope<T>,\n  localStateDefinitions?: StateDefinitionsInput<T>\n): boolean {\n  if (scope.localStateDefinitions === localStateDefinitions) {\n    return false;\n  }\n\n  scope.localStateDefinitions = localStateDefinitions;\n  rebuildSharedStateScope(scope);\n  return true;\n}\n\nexport function setRootSharedStateScopeThemeDefinitions<T extends Record<string, any> = Record<string, any>>(\n  scope: SharedStateScope<T>,\n  themeStateDefinitions?: StateDefinitionsInput<T>\n): boolean {\n  if (scope.themeStateDefinitions === themeStateDefinitions) {\n    return false;\n  }\n\n  scope.themeStateDefinitions = themeStateDefinitions;\n  rebuildSharedStateScope(scope);\n  return true;\n}\n\nexport function rebuildSharedStateScope<T extends Record<string, any> = Record<string, any>>(\n  scope: SharedStateScope<T>\n): SharedStateScope<T> {\n  const effectiveSourceDefinitions = buildEffectiveSourceDefinitions(\n    scope.parentScope,\n    scope.localStateDefinitions,\n    scope.themeStateDefinitions\n  );\n\n  scope.effectiveSourceDefinitions = effectiveSourceDefinitions;\n  scope.effectiveCompiledDefinitions = compiler.compile(effectiveSourceDefinitions);\n  scope.parentRevisionAtBuild = scope.parentScope?.revision;\n  scope.revision += 1;\n  scope.dirty = false;\n\n  return scope;\n}\n\nexport function ensureSharedStateScopeFresh<T extends Record<string, any> = Record<string, any>>(\n  scope?: SharedStateScope<T>\n): SharedStateScope<T> | undefined {\n  if (!scope) {\n    return undefined;\n  }\n\n  getStageStatePerfMonitor(scope.ownerStage)?.recordRefresh('ensureFreshCalls');\n\n  if (scope.parentScope) {\n    ensureSharedStateScopeFresh(scope.parentScope);\n  }\n\n  if (scope.dirty || (scope.parentScope && scope.parentRevisionAtBuild !== scope.parentScope.revision)) {\n    rebuildSharedStateScope(scope);\n  }\n\n  return scope;\n}\n\nexport function collectSharedStateScopeChain<T extends Record<string, any> = Record<string, any>>(\n  scope?: SharedStateScope<T>\n): SharedStateScope<T>[] {\n  const chain: SharedStateScope<T>[] = [];\n  let current = scope;\n\n  while (current) {\n    chain.push(current);\n    current = current.parentScope;\n  }\n\n  return chain;\n}\n"]}

package/es/graphic/state/state-batch-scheduler.d.ts

@@ -0,0 +1,42 @@
+import type { IGraphic, IGroup, ILayer, IStage } from '../../interface';
+import { type IDeferredStateConfig, type StatePerfMonitor } from './state-perf-monitor';
+type StateBatchJobKind = 'apply_states';
+type StateBatchIntentKey = string;
+export interface IStateBatchJob {
+    id: number;
+    kind: StateBatchJobKind;
+    intentKey: StateBatchIntentKey;
+    status: 'pending' | 'running' | 'completed' | 'cancelled';
+    targetStates: string[];
+    targetStatesKey: string;
+    pendingGraphics: Set<IGraphic>;
+    orderedGraphics: IGraphic[];
+    config: Required<IDeferredStateConfig>;
+    contextOwner: IStage | ILayer | IGroup;
+    contextOwnerId: number;
+    configFingerprint: string;
+    createdAt: number;
+    processedCount: number;
+}
+export declare class StateBatchScheduler {
+    private readonly stage;
+    private readonly perfMonitor?;
+    readonly jobsByIntentKey: Map<string, IStateBatchJob>;
+    readonly pendingIntentByGraphic: Map<IGraphic<Partial<import("../../interface").IGraphicAttribute>>, string>;
+    private nextJobId;
+    private readonly runningJobs;
+    constructor(stage: IStage, perfMonitor?: StatePerfMonitor);
+    schedule(graphics: IGraphic[], targetStates: string[]): void;
+    release(): void;
+    private resolveEligibility;
+    private resolveDeferredContext;
+    private classifyGraphicTargetStates;
+    private enqueueDeferredIntent;
+    private removeGraphicFromPending;
+    private removeGraphicFromIntentJob;
+    private ensureJobRunning;
+    private runJob;
+    private waitForNextFrame;
+    private commitSynchronously;
+}
+export {};

package/es/graphic/state/state-batch-scheduler.js

@@ -0,0 +1,278 @@
+var __awaiter = this && this.__awaiter || function(thisArg, _arguments, P, generator) {
+    return new (P || (P = Promise))((function(resolve, reject) {
+        function fulfilled(value) {
+            try {
+                step(generator.next(value));
+            } catch (e) {
+                reject(e);
+            }
+        }
+        function rejected(value) {
+            try {
+                step(generator.throw(value));
+            } catch (e) {
+                reject(e);
+            }
+        }
+        function step(result) {
+            var value;
+            result.done ? resolve(result.value) : (value = result.value, value instanceof P ? value : new P((function(resolve) {
+                resolve(value);
+            }))).then(fulfilled, rejected);
+        }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    }));
+};
+
+import { UpdateCategory, classifyAffectedKeys } from "./attribute-update-classifier";
+
+import { fingerprintDeferredStateConfig, normalizeDeferredStateConfig, normalizeDeferredStateOwnerConfig } from "./state-perf-monitor";
+
+function isRenderableGraphic(graphic) {
+    return !!graphic.stage && "released" !== graphic.releaseStatus;
+}
+
+function createTargetStatesKey(targetStates) {
+    return targetStates.length ? targetStates.join("|") : "__clear__";
+}
+
+function createIntentKey(contextOwnerId, configFingerprint, targetStatesKey) {
+    return `${contextOwnerId}:${configFingerprint}:${targetStatesKey}`;
+}
+
+function hasMeaningfulDeferredConfig(config) {
+    const normalized = normalizeDeferredStateOwnerConfig(config);
+    return !!normalized && (null != normalized.localEnabled || null != normalized.deferred);
+}
+
+function getGraphicCompiledDefinitions(graphic) {
+    const graphicAny = graphic;
+    if ("function" == typeof graphicAny.resolveEffectiveCompiledDefinitions) {
+        const result = graphicAny.resolveEffectiveCompiledDefinitions();
+        return {
+            compiledDefinitions: result.compiledDefinitions,
+            stateProxyEligibility: result.stateProxyEligibility
+        };
+    }
+    return {};
+}
+
+function getCurrentStateNames(graphic) {
+    var _a, _b;
+    return null !== (_b = null === (_a = graphic.currentStates) || void 0 === _a ? void 0 : _a.slice()) && void 0 !== _b ? _b : [];
+}
+
+export class StateBatchScheduler {
+    constructor(stage, perfMonitor) {
+        this.stage = stage, this.perfMonitor = perfMonitor, this.jobsByIntentKey = new Map, 
+        this.pendingIntentByGraphic = new Map, this.nextJobId = 1, this.runningJobs = new Map;
+    }
+    schedule(graphics, targetStates) {
+        const batchOperation = graphics.length > 1;
+        graphics.forEach((graphic => {
+            const eligibility = this.resolveEligibility(graphic, targetStates, batchOperation, !0);
+            if ("reason" in eligibility) return this.removeGraphicFromPending(graphic), void ("graphic_unavailable" !== eligibility.reason && this.commitSynchronously(graphic, targetStates));
+            this.enqueueDeferredIntent(graphic, targetStates, eligibility.context, eligibility.targetStatesKey);
+        }));
+    }
+    release() {
+        var _a;
+        this.jobsByIntentKey.forEach((job => {
+            job.status = "cancelled";
+        })), this.jobsByIntentKey.clear(), this.pendingIntentByGraphic.clear(), this.runningJobs.clear(), 
+        null === (_a = this.perfMonitor) || void 0 === _a || _a.updateBatchPending(0);
+    }
+    resolveEligibility(graphic, targetStates, batchOperation, recordObservability) {
+        var _a, _b, _c, _d, _e, _f;
+        if (!isRenderableGraphic(graphic)) return recordObservability && (null === (_a = this.perfMonitor) || void 0 === _a || _a.recordDeferredIneligible("graphic_unavailable")), 
+        {
+            eligible: !1,
+            reason: "graphic_unavailable"
+        };
+        if (!batchOperation) return recordObservability && (null === (_b = this.perfMonitor) || void 0 === _b || _b.recordDeferredIneligible("non_batch_operation")), 
+        {
+            eligible: !1,
+            reason: "non_batch_operation"
+        };
+        const context = this.resolveDeferredContext(graphic);
+        if (!context) return recordObservability && (null === (_c = this.perfMonitor) || void 0 === _c || _c.recordDeferredIneligible("graphic_unavailable")), 
+        {
+            eligible: !1,
+            reason: "graphic_unavailable"
+        };
+        if (!context.config.enabled) {
+            const normalizedOwnerConfig = normalizeDeferredStateOwnerConfig(context.contextOwner.deferredStateConfig), reason = !1 === (null == normalizedOwnerConfig ? void 0 : normalizedOwnerConfig.localEnabled) ? "context_disabled" : "config_disabled";
+            return recordObservability && (null === (_d = this.perfMonitor) || void 0 === _d || _d.recordDeferredIneligible(reason)), 
+            {
+                eligible: !1,
+                reason: reason
+            };
+        }
+        const classification = this.classifyGraphicTargetStates(graphic, targetStates);
+        return classification.reason ? (recordObservability && (null === (_e = this.perfMonitor) || void 0 === _e || _e.recordDeferredIneligible(classification.reason)), 
+        {
+            eligible: !1,
+            reason: classification.reason
+        }) : classification.category !== UpdateCategory.PAINT ? (recordObservability && (null === (_f = this.perfMonitor) || void 0 === _f || _f.recordDeferredIneligible("mixed_update_category")), 
+        {
+            eligible: !1,
+            reason: "mixed_update_category"
+        }) : {
+            eligible: !0,
+            context: context,
+            targetStatesKey: createTargetStatesKey(targetStates)
+        };
+    }
+    resolveDeferredContext(graphic) {
+        var _a;
+        const stage = graphic.stage;
+        if (!stage) return;
+        let owner = stage, config = normalizeDeferredStateConfig(void 0);
+        const ownerConfigs = [ stage ], parents = [];
+        let parent = graphic.parent;
+        for (;parent && parent !== stage; ) parents.push(parent), parent = parent.parent;
+        parents.reverse().forEach((current => ownerConfigs.push(current))), ownerConfigs.forEach((current => {
+            const deferredStateConfig = normalizeDeferredStateOwnerConfig(current.deferredStateConfig);
+            deferredStateConfig && (deferredStateConfig.deferred && (config = Object.assign(Object.assign({}, config), deferredStateConfig.deferred)), 
+            null != deferredStateConfig.localEnabled && (config.enabled = deferredStateConfig.localEnabled), 
+            hasMeaningfulDeferredConfig(current.deferredStateConfig) && (owner = current));
+        }));
+        const normalized = normalizeDeferredStateConfig(config);
+        return {
+            contextOwner: owner,
+            contextOwnerId: null !== (_a = owner._uid) && void 0 !== _a ? _a : 0,
+            config: normalized,
+            configFingerprint: fingerprintDeferredStateConfig(normalized)
+        };
+    }
+    classifyGraphicTargetStates(graphic, targetStates) {
+        const {compiledDefinitions: compiledDefinitions, stateProxyEligibility: stateProxyEligibility} = getGraphicCompiledDefinitions(graphic), candidateStates = Array.from(new Set([ ...getCurrentStateNames(graphic), ...targetStates ]));
+        let category = UpdateCategory.NONE;
+        return candidateStates.forEach((stateName => {
+            if (null == stateProxyEligibility ? void 0 : stateProxyEligibility(stateName)) return void (category = UpdateCategory.NONE);
+            const definition = null == compiledDefinitions ? void 0 : compiledDefinitions.get(stateName);
+            definition && (definition.hasResolver && 0 === definition.affectedKeys.size ? category = UpdateCategory.NONE : category |= classifyAffectedKeys(definition.affectedKeys));
+        })), candidateStates.some((stateName => null == stateProxyEligibility ? void 0 : stateProxyEligibility(stateName))) || candidateStates.some((stateName => {
+            const definition = null == compiledDefinitions ? void 0 : compiledDefinitions.get(stateName);
+            return !!(null == definition ? void 0 : definition.hasResolver) && 0 === definition.affectedKeys.size;
+        })) ? {
+            category: UpdateCategory.NONE,
+            reason: "resolver_unstable_keys"
+        } : {
+            category: category === UpdateCategory.NONE ? UpdateCategory.PAINT : category
+        };
+    }
+    enqueueDeferredIntent(graphic, targetStates, context, targetStatesKey) {
+        var _a, _b, _c, _d, _e, _f;
+        const nextIntentKey = createIntentKey(context.contextOwnerId, context.configFingerprint, targetStatesKey), prevIntentKey = this.pendingIntentByGraphic.get(graphic);
+        if (prevIntentKey === nextIntentKey) return void (null === (_a = this.perfMonitor) || void 0 === _a || _a.incrementCounter("deferredJobsCoalesced"));
+        prevIntentKey && this.removeGraphicFromIntentJob(graphic, prevIntentKey);
+        let job = this.jobsByIntentKey.get(nextIntentKey);
+        job ? null === (_d = this.perfMonitor) || void 0 === _d || _d.incrementCounter("deferredJobsCoalesced") : (job = {
+            id: this.nextJobId++,
+            kind: "apply_states",
+            intentKey: nextIntentKey,
+            status: "pending",
+            targetStates: [ ...targetStates ],
+            targetStatesKey: targetStatesKey,
+            pendingGraphics: new Set,
+            orderedGraphics: [],
+            config: context.config,
+            contextOwner: context.contextOwner,
+            contextOwnerId: context.contextOwnerId,
+            configFingerprint: context.configFingerprint,
+            createdAt: Date.now(),
+            processedCount: 0
+        }, this.jobsByIntentKey.set(nextIntentKey, job), null === (_b = this.perfMonitor) || void 0 === _b || _b.incrementCounter("deferredJobsCreated"), 
+        null === (_c = this.perfMonitor) || void 0 === _c || _c.updateBatchPending(this.jobsByIntentKey.size)), 
+        job.pendingGraphics.has(graphic) || (job.pendingGraphics.add(graphic), job.orderedGraphics.push(graphic), 
+        this.pendingIntentByGraphic.set(graphic, nextIntentKey), null === (_e = this.perfMonitor) || void 0 === _e || _e.recordAllocation("batchEntriesCreated"), 
+        null === (_f = this.perfMonitor) || void 0 === _f || _f.updateMaxGraphicsInJob(job.pendingGraphics.size)), 
+        this.ensureJobRunning(job);
+    }
+    removeGraphicFromPending(graphic) {
+        const prevIntentKey = this.pendingIntentByGraphic.get(graphic);
+        prevIntentKey && this.removeGraphicFromIntentJob(graphic, prevIntentKey);
+    }
+    removeGraphicFromIntentJob(graphic, intentKey) {
+        var _a, _b, _c;
+        const job = this.jobsByIntentKey.get(intentKey);
+        job ? (job.pendingGraphics.delete(graphic), this.pendingIntentByGraphic.get(graphic) === intentKey && this.pendingIntentByGraphic.delete(graphic), 
+        0 === job.pendingGraphics.size && "completed" !== job.status && (job.status = "cancelled", 
+        this.jobsByIntentKey.delete(intentKey), null === (_a = this.perfMonitor) || void 0 === _a || _a.incrementCounter("deferredJobsCancelled"), 
+        null === (_b = this.perfMonitor) || void 0 === _b || _b.recordEvent("deferred-job-cancel", {
+            intentKey: intentKey,
+            jobId: job.id
+        }), null === (_c = this.perfMonitor) || void 0 === _c || _c.updateBatchPending(this.jobsByIntentKey.size))) : this.pendingIntentByGraphic.delete(graphic);
+    }
+    ensureJobRunning(job) {
+        if (this.runningJobs.has(job.intentKey)) return;
+        const runner = this.runJob(job).then((() => {
+            this.runningJobs.delete(job.intentKey);
+        }), (() => {
+            this.runningJobs.delete(job.intentKey);
+        }));
+        this.runningJobs.set(job.intentKey, runner);
+    }
+    runJob(job) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        return __awaiter(this, void 0, void 0, (function*() {
+            if ("cancelled" === job.status) return;
+            if (yield this.waitForNextFrame(), "cancelled" === job.status) return;
+            job.status = "running", null === (_a = this.perfMonitor) || void 0 === _a || _a.recordEvent("deferred-job-start", {
+                intentKey: job.intentKey,
+                jobId: job.id
+            });
+            let index = 0, frameStart = performance.now(), processedInFrame = 0, committedInSlice = 0;
+            for (;index < job.orderedGraphics.length; ) {
+                if ("cancelled" === job.status) return;
+                processedInFrame > 0 && (processedInFrame >= job.config.maxGraphicsPerFrame || performance.now() - frameStart >= job.config.frameBudget) && (null === (_b = this.perfMonitor) || void 0 === _b || _b.incrementCounter("deferredBudgetYields"), 
+                null === (_c = this.perfMonitor) || void 0 === _c || _c.recordCost("batchSlice", performance.now() - frameStart), 
+                null === (_d = this.perfMonitor) || void 0 === _d || _d.recordEvent("deferred-job-yield", {
+                    intentKey: job.intentKey,
+                    jobId: job.id,
+                    processedInFrame: processedInFrame
+                }), committedInSlice > 0 && this.stage.renderNextFrame(), yield this.waitForNextFrame(), 
+                frameStart = performance.now(), processedInFrame = 0, committedInSlice = 0);
+                const graphic = job.orderedGraphics[index++];
+                if (!job.pendingGraphics.has(graphic)) continue;
+                if (!isRenderableGraphic(graphic)) {
+                    job.pendingGraphics.delete(graphic), this.pendingIntentByGraphic.get(graphic) === job.intentKey && this.pendingIntentByGraphic.delete(graphic);
+                    continue;
+                }
+                if (this.pendingIntentByGraphic.get(graphic) !== job.intentKey) {
+                    job.pendingGraphics.delete(graphic);
+                    continue;
+                }
+                const nextEligibility = this.resolveEligibility(graphic, job.targetStates, !0, !1);
+                if (!nextEligibility.eligible) {
+                    job.pendingGraphics.delete(graphic), this.pendingIntentByGraphic.delete(graphic), 
+                    this.commitSynchronously(graphic, job.targetStates);
+                    continue;
+                }
+                createIntentKey(nextEligibility.context.contextOwnerId, nextEligibility.context.configFingerprint, nextEligibility.targetStatesKey) === job.intentKey ? (this.commitSynchronously(graphic, job.targetStates), 
+                job.pendingGraphics.delete(graphic), this.pendingIntentByGraphic.delete(graphic), 
+                job.processedCount += 1, processedInFrame += 1, committedInSlice += 1, null === (_e = this.perfMonitor) || void 0 === _e || _e.incrementCounter("deferredGraphicsCommitted")) : (job.pendingGraphics.delete(graphic), 
+                this.pendingIntentByGraphic.delete(graphic), this.enqueueDeferredIntent(graphic, job.targetStates, nextEligibility.context, nextEligibility.targetStatesKey));
+            }
+            processedInFrame > 0 && (null === (_f = this.perfMonitor) || void 0 === _f || _f.recordCost("batchSlice", performance.now() - frameStart), 
+            this.stage.renderNextFrame()), 0 === job.pendingGraphics.size && this.jobsByIntentKey.get(job.intentKey) === job && (job.status = "completed", 
+            this.jobsByIntentKey.delete(job.intentKey), null === (_g = this.perfMonitor) || void 0 === _g || _g.incrementCounter("deferredJobsCompleted"), 
+            null === (_h = this.perfMonitor) || void 0 === _h || _h.recordEvent("deferred-job-complete", {
+                intentKey: job.intentKey,
+                jobId: job.id,
+                processedCount: job.processedCount
+            }), null === (_j = this.perfMonitor) || void 0 === _j || _j.updateBatchPending(this.jobsByIntentKey.size));
+        }));
+    }
+    waitForNextFrame() {
+        const stageGlobal = this.stage.global;
+        return (null == stageGlobal ? void 0 : stageGlobal.getSpecifiedPerformanceRAF) ? stageGlobal.getSpecifiedPerformanceRAF(this.stage.rafId).wait() : new Promise((resolve => {
+            null == stageGlobal || stageGlobal.getSpecifiedRequestAnimationFrame(this.stage.rafId)((() => resolve()));
+        }));
+    }
+    commitSynchronously(graphic, targetStates) {
+        isRenderableGraphic(graphic) && (targetStates.length ? graphic.useStates(targetStates, !1) : graphic.clearStates(!1));
+    }
+}
+//# sourceMappingURL=state-batch-scheduler.js.map