@lightningjs/renderer 0.0.1

package/dist/src/core/Matrix2DContext.js

@@ -0,0 +1,45 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ *  Represents a 2D transformation context, providing a 2x2 matrix for transformations.
+ */
+export class Matrix2DContext {
+    // world alpha
+    alpha = 1;
+    // world position
+    px = 0;
+    py = 0;
+    ta = 1;
+    tb = 0;
+    tc = 0;
+    td = 1;
+    isIdentity() {
+        return (this.alpha === 1 &&
+            this.px === 0 &&
+            this.py === 0 &&
+            this.isIdentityMatrix());
+    }
+    isIdentityMatrix() {
+        return this.ta === 1 && this.tb === 0 && this.tc === 0 && this.td === 1;
+    }
+    isSquare() {
+        return this.tb === 0 && this.tc === 0;
+    }
+}
+//# sourceMappingURL=Matrix2DContext.js.map

package/dist/src/core/Matrix2DContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Matrix2DContext.js","sourceRoot":"","sources":["../../../src/core/Matrix2DContext.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH;;GAEG;AACH,MAAM,OAAO,eAAe;IAC1B,cAAc;IACd,KAAK,GAAG,CAAC,CAAC;IAEV,iBAAiB;IACjB,EAAE,GAAG,CAAC,CAAC;IACP,EAAE,GAAG,CAAC,CAAC;IAEP,EAAE,GAAG,CAAC,CAAC;IACP,EAAE,GAAG,CAAC,CAAC;IACP,EAAE,GAAG,CAAC,CAAC;IACP,EAAE,GAAG,CAAC,CAAC;IAEP,UAAU;QACR,OAAO,CACL,IAAI,CAAC,KAAK,KAAK,CAAC;YAChB,IAAI,CAAC,EAAE,KAAK,CAAC;YACb,IAAI,CAAC,EAAE,KAAK,CAAC;YACb,IAAI,CAAC,gBAAgB,EAAE,CACxB,CAAC;IACJ,CAAC;IAED,gBAAgB;QACd,OAAO,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IAC1E,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;CACF"}

package/dist/src/core/Stage.d.ts

@@ -0,0 +1,53 @@
+import { WebGlCoreRenderer } from './renderers/webgl/WebGlCoreRenderer.js';
+import { AnimationManager } from './animations/AnimationManager.js';
+import { CoreNode } from './CoreNode.js';
+import { CoreTextureManager } from './CoreTextureManager.js';
+import { TrFontManager } from './text-rendering/TrFontManager.js';
+import { CoreShaderManager } from './CoreShaderManager.js';
+import type { TextRenderer, TextRendererMap, TrProps } from './text-rendering/renderers/TextRenderer.js';
+export interface StageOptions {
+    rootId: number;
+    appWidth: number;
+    appHeight: number;
+    deviceLogicalPixelRatio: number;
+    devicePhysicalPixelRatio: number;
+    canvas: HTMLCanvasElement | OffscreenCanvas;
+    clearColor: number;
+    debug?: {
+        monitorTextureCache?: boolean;
+    };
+}
+export declare class Stage {
+    readonly options: StageOptions;
+    readonly animationManager: AnimationManager;
+    readonly txManager: CoreTextureManager;
+    readonly fontManager: TrFontManager;
+    readonly textRenderers: Partial<TextRendererMap>;
+    readonly shManager: CoreShaderManager;
+    readonly renderer: WebGlCoreRenderer;
+    private scene;
+    deltaTime: number;
+    lastFrameTime: number;
+    currentFrameTime: number;
+    /**
+     * Stage constructor
+     */
+    constructor(options: StageOptions);
+    /**
+     * Start a new frame draw
+     */
+    drawFrame(): void;
+    addQuads(node: CoreNode): void;
+    /**
+     * Given a font name, and possible renderer override, return the best compatible text renderer.
+     *
+     * @remarks
+     * Will always return at least a canvas renderer if no other suitable renderer can be resolved.
+     *
+     * @param fontFamily
+     * @param textRendererOverride
+     * @returns
+     */
+    resolveTextRenderer(trProps: TrProps, textRendererOverride?: keyof TextRendererMap | null): TextRenderer;
+    get root(): CoreNode;
+}

package/dist/src/core/Stage.js

@@ -0,0 +1,214 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Scene } from './scene/Scene.js';
+import { startLoop, getTimeStamp } from './platform.js';
+import { WebGlCoreRenderer } from './renderers/webgl/WebGlCoreRenderer.js';
+import { assertTruthy } from '../utils.js';
+import { AnimationManager } from './animations/AnimationManager.js';
+import { CoreNode } from './CoreNode.js';
+import { CoreTextureManager } from './CoreTextureManager.js';
+import { TrFontManager } from './text-rendering/TrFontManager.js';
+import { CoreShaderManager } from './CoreShaderManager.js';
+import { WebTrFontFace } from './text-rendering/font-face-types/WebTrFontFace.js';
+import { SdfTextRenderer } from './text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js';
+import { SdfTrFontFace } from './text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js';
+import { CanvasTextRenderer } from './text-rendering/renderers/CanvasTextRenderer.js';
+const bufferMemory = 2e6;
+const autoStart = true;
+export class Stage {
+    options;
+    /// Module Instances
+    animationManager;
+    txManager;
+    fontManager;
+    textRenderers;
+    shManager;
+    renderer;
+    scene;
+    /// State
+    deltaTime = 0;
+    lastFrameTime = 0;
+    currentFrameTime = 0;
+    /**
+     * Stage constructor
+     */
+    constructor(options) {
+        this.options = options;
+        const { canvas, clearColor, rootId, debug, appWidth, appHeight } = options;
+        this.txManager = new CoreTextureManager();
+        this.shManager = new CoreShaderManager();
+        this.animationManager = new AnimationManager();
+        if (debug?.monitorTextureCache) {
+            setInterval(() => {
+                assertTruthy(this.txManager);
+                const debugInfo = this.txManager.getDebugInfo();
+                console.log('Texture ID Cache Size: ', debugInfo.idCacheSize);
+                console.log('Texture Key Cache Size: ', debugInfo.keyCacheSize);
+            }, 1000);
+        }
+        this.renderer = new WebGlCoreRenderer({
+            stage: this,
+            canvas,
+            pixelRatio: options.devicePhysicalPixelRatio * options.deviceLogicalPixelRatio,
+            clearColor: clearColor ?? 0xff000000,
+            bufferMemory,
+            txManager: this.txManager,
+            shManager: this.shManager,
+        });
+        // Must do this after renderer is created
+        this.txManager.renderer = this.renderer;
+        this.textRenderers = {
+            canvas: new CanvasTextRenderer(this),
+            sdf: new SdfTextRenderer(this),
+        };
+        this.fontManager = new TrFontManager(this.textRenderers);
+        // create root node
+        const rootNode = new CoreNode(this, {
+            id: rootId,
+            x: 0,
+            y: 0,
+            width: appWidth,
+            height: appHeight,
+            alpha: 1,
+            color: 0x00000000,
+            colorTop: 0x00000000,
+            colorBottom: 0x00000000,
+            colorLeft: 0x00000000,
+            colorRight: 0x00000000,
+            colorTl: 0x00000000,
+            colorTr: 0x00000000,
+            colorBl: 0x00000000,
+            colorBr: 0x00000000,
+            zIndex: 0,
+            zIndexLocked: 0,
+            scale: 1,
+            mountX: 0,
+            mountY: 0,
+            mount: 0,
+            pivot: 0.5,
+            pivotX: 0.5,
+            pivotY: 0.5,
+            rotation: 0,
+            parent: null,
+            texture: null,
+            textureOptions: null,
+            shader: null,
+            shaderProps: null,
+        });
+        this.scene = new Scene(rootNode);
+        // execute platform start loop
+        if (autoStart) {
+            startLoop(this);
+        }
+    }
+    /**
+     * Start a new frame draw
+     */
+    drawFrame() {
+        const { renderer, scene, animationManager } = this;
+        if (!scene?.root) {
+            return;
+        }
+        this.lastFrameTime = this.currentFrameTime;
+        this.currentFrameTime = getTimeStamp();
+        this.deltaTime = !this.lastFrameTime
+            ? 100 / 6
+            : this.currentFrameTime - this.lastFrameTime;
+        // step animation
+        animationManager.update(this.deltaTime);
+        // reset and clear viewport
+        renderer?.reset();
+        // test if we need to update the scene
+        if (scene?.root?.hasUpdates) {
+            scene?.root?.update(this.deltaTime);
+        }
+        this.addQuads(scene.root);
+        renderer?.sortRenderables();
+        renderer?.render();
+    }
+    addQuads(node) {
+        assertTruthy(this.renderer);
+        node.renderQuads(this.renderer);
+        node.children.forEach((child) => {
+            if (child.alpha === 0) {
+                return;
+            }
+            this.addQuads(child);
+        });
+    }
+    /**
+     * Given a font name, and possible renderer override, return the best compatible text renderer.
+     *
+     * @remarks
+     * Will always return at least a canvas renderer if no other suitable renderer can be resolved.
+     *
+     * @param fontFamily
+     * @param textRendererOverride
+     * @returns
+     */
+    resolveTextRenderer(trProps, textRendererOverride = null) {
+        let rendererId = textRendererOverride;
+        let overrideFallback = false;
+        // Check if the override is valid (if one is provided)
+        if (rendererId) {
+            const possibleRenderer = this.textRenderers[rendererId];
+            if (!possibleRenderer) {
+                console.warn(`Text renderer override '${rendererId}' not found.`);
+                rendererId = null;
+                overrideFallback = true;
+            }
+            else if (!possibleRenderer.canRenderFont(trProps)) {
+                console.warn(`Cannot use override text renderer '${rendererId}' for font`, trProps);
+                rendererId = null;
+                overrideFallback = true;
+            }
+        }
+        if (!rendererId) {
+            // Iterate through the text renderers and find the first one that can render the font
+            for (const [trId, tr] of Object.entries(this.textRenderers)) {
+                if (trId === 'canvas') {
+                    // Canvas is always a fallback
+                    continue;
+                }
+                if (tr.canRenderFont(trProps)) {
+                    rendererId = trId;
+                    break;
+                }
+            }
+            if (!rendererId) {
+                // If no renderer can be found, use the canvas renderer
+                rendererId = 'canvas';
+            }
+        }
+        if (overrideFallback) {
+            console.warn(`Falling back to text renderer ${String(rendererId)}`);
+        }
+        // By now we are guaranteed to have a valid rendererId (at least Canvas);
+        const resolvedTextRenderer = this.textRenderers[rendererId];
+        assertTruthy(resolvedTextRenderer, 'resolvedTextRenderer undefined');
+        // Need to explicitly cast to TextRenderer because TS doesn't like
+        // the covariant state argument in the setter method map
+        return resolvedTextRenderer;
+    }
+    //#region Properties
+    get root() {
+        return this.scene?.root || null;
+    }
+}
+//# sourceMappingURL=Stage.js.map

package/dist/src/core/Stage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Stage.js","sourceRoot":"","sources":["../../../src/core/Stage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAExD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAC3E,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAM3D,OAAO,EAAE,aAAa,EAAE,MAAM,mDAAmD,CAAC;AAClF,OAAO,EAAE,eAAe,EAAE,MAAM,+DAA+D,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,iEAAiE,CAAC;AAChG,OAAO,EAAE,kBAAkB,EAAE,MAAM,kDAAkD,CAAC;AAetF,MAAM,YAAY,GAAG,GAAG,CAAC;AACzB,MAAM,SAAS,GAAG,IAAI,CAAC;AAEvB,MAAM,OAAO,KAAK;IAkBK;IAjBrB,oBAAoB;IACJ,gBAAgB,CAAmB;IACnC,SAAS,CAAqB;IAC9B,WAAW,CAAgB;IAC3B,aAAa,CAA2B;IACxC,SAAS,CAAoB;IAC7B,QAAQ,CAAoB;IACpC,KAAK,CAAQ;IAErB,SAAS;IACT,SAAS,GAAG,CAAC,CAAC;IACd,aAAa,GAAG,CAAC,CAAC;IAClB,gBAAgB,GAAG,CAAC,CAAC;IAErB;;OAEG;IACH,YAAqB,OAAqB;QAArB,YAAO,GAAP,OAAO,CAAc;QACxC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QAC3E,IAAI,CAAC,SAAS,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,IAAI,iBAAiB,EAAE,CAAC;QACzC,IAAI,CAAC,gBAAgB,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAE/C,IAAI,KAAK,EAAE,mBAAmB,EAAE;YAC9B,WAAW,CAAC,GAAG,EAAE;gBACf,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC7B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;gBAChD,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;gBAC9D,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;YAClE,CAAC,EAAE,IAAI,CAAC,CAAC;SACV;QAED,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAiB,CAAC;YACpC,KAAK,EAAE,IAAI;YACX,MAAM;YACN,UAAU,EACR,OAAO,CAAC,wBAAwB,GAAG,OAAO,CAAC,uBAAuB;YACpE,UAAU,EAAE,UAAU,IAAI,UAAU;YACpC,YAAY;YACZ,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC,CAAC;QAEH,yCAAyC;QACzC,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAExC,IAAI,CAAC,aAAa,GAAG;YACnB,MAAM,EAAE,IAAI,kBAAkB,CAAC,IAAI,CAAC;YACpC,GAAG,EAAE,IAAI,eAAe,CAAC,IAAI,CAAC;SAC/B,CAAC;QACF,IAAI,CAAC,WAAW,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAEzD,mBAAmB;QACnB,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE;YAClC,EAAE,EAAE,MAAM;YACV,CAAC,EAAE,CAAC;YACJ,CAAC,EAAE,CAAC;YACJ,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,SAAS;YACjB,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,UAAU;YACjB,QAAQ,EAAE,UAAU;YACpB,WAAW,EAAE,UAAU;YACvB,SAAS,EAAE,UAAU;YACrB,UAAU,EAAE,UAAU;YACtB,OAAO,EAAE,UAAU;YACnB,OAAO,EAAE,UAAU;YACnB,OAAO,EAAE,UAAU;YACnB,OAAO,EAAE,UAAU;YACnB,MAAM,EAAE,CAAC;YACT,YAAY,EAAE,CAAC;YACf,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,CAAC;YACT,MAAM,EAAE,CAAC;YACT,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,GAAG;YACV,MAAM,EAAE,GAAG;YACX,MAAM,EAAE,GAAG;YACX,QAAQ,EAAE,CAAC;YACX,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,IAAI;YACb,cAAc,EAAE,IAAI;YACpB,MAAM,EAAE,IAAI;YACZ,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEjC,8BAA8B;QAC9B,IAAI,SAAS,EAAE;YACb,SAAS,CAAC,IAAI,CAAC,CAAC;SACjB;IACH,CAAC;IACD;;OAEG;IACH,SAAS;QACP,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;QACnD,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YAChB,OAAO;SACR;QACD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAC3C,IAAI,CAAC,gBAAgB,GAAG,YAAY,EAAE,CAAC;QAEvC,IAAI,CAAC,SAAS,GAAG,CAAC,IAAI,CAAC,aAAa;YAClC,CAAC,CAAC,GAAG,GAAG,CAAC;YACT,CAAC,CAAC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC;QAE/C,iBAAiB;QACjB,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAExC,2BAA2B;QAC3B,QAAQ,EAAE,KAAK,EAAE,CAAC;QAElB,sCAAsC;QACtC,IAAI,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE;YAC3B,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACrC;QAED,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE1B,QAAQ,EAAE,eAAe,EAAE,CAAC;QAC5B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACrB,CAAC;IAED,QAAQ,CAAC,IAAc;QACrB,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE5B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,IAAI,KAAK,CAAC,KAAK,KAAK,CAAC,EAAE;gBACrB,OAAO;aACR;YACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,mBAAmB,CACjB,OAAgB,EAChB,uBAAqD,IAAI;QAEzD,IAAI,UAAU,GAAG,oBAAoB,CAAC;QAEtC,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAC7B,sDAAsD;QACtD,IAAI,UAAU,EAAE;YACd,MAAM,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YACxD,IAAI,CAAC,gBAAgB,EAAE;gBACrB,OAAO,CAAC,IAAI,CAAC,2BAA2B,UAAU,cAAc,CAAC,CAAC;gBAClE,UAAU,GAAG,IAAI,CAAC;gBAClB,gBAAgB,GAAG,IAAI,CAAC;aACzB;iBAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;gBACnD,OAAO,CAAC,IAAI,CACV,sCAAsC,UAAU,YAAY,EAC5D,OAAO,CACR,CAAC;gBACF,UAAU,GAAG,IAAI,CAAC;gBAClB,gBAAgB,GAAG,IAAI,CAAC;aACzB;SACF;QAED,IAAI,CAAC,UAAU,EAAE;YACf,qFAAqF;YACrF,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;gBAC3D,IAAI,IAAI,KAAK,QAAQ,EAAE;oBACrB,8BAA8B;oBAC9B,SAAS;iBACV;gBACD,IAAI,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;oBAC7B,UAAU,GAAG,IAA6B,CAAC;oBAC3C,MAAM;iBACP;aACF;YACD,IAAI,CAAC,UAAU,EAAE;gBACf,uDAAuD;gBACvD,UAAU,GAAG,QAAQ,CAAC;aACvB;SACF;QAED,IAAI,gBAAgB,EAAE;YACpB,OAAO,CAAC,IAAI,CAAC,iCAAiC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;SACrE;QAED,yEAAyE;QACzE,MAAM,oBAAoB,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC5D,YAAY,CAAC,oBAAoB,EAAE,gCAAgC,CAAC,CAAC;QAErE,kEAAkE;QAClE,wDAAwD;QACxD,OAAO,oBAA+C,CAAC;IACzD,CAAC;IAED,oBAAoB;IAEpB,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,EAAE,IAAI,IAAI,IAAI,CAAC;IAClC,CAAC;CAGF"}

package/dist/src/core/animations/AnimationManager.d.ts

@@ -0,0 +1,7 @@
+import { CoreAnimation } from './CoreAnimation.js';
+export declare class AnimationManager {
+    activeAnimations: Set<CoreAnimation>;
+    registerAnimation(animation: CoreAnimation): void;
+    unregisterAnimation(animation: CoreAnimation): void;
+    update(dt: number): void;
+}

package/dist/src/core/animations/AnimationManager.js

@@ -0,0 +1,34 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { CoreAnimation } from './CoreAnimation.js';
+export class AnimationManager {
+    activeAnimations = new Set();
+    registerAnimation(animation) {
+        this.activeAnimations.add(animation);
+    }
+    unregisterAnimation(animation) {
+        this.activeAnimations.delete(animation);
+    }
+    update(dt) {
+        this.activeAnimations.forEach((animation) => {
+            animation.update(dt);
+        });
+    }
+}
+//# sourceMappingURL=AnimationManager.js.map

package/dist/src/core/animations/AnimationManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnimationManager.js","sourceRoot":"","sources":["../../../../src/core/animations/AnimationManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,MAAM,OAAO,gBAAgB;IAC3B,gBAAgB,GAAuB,IAAI,GAAG,EAAE,CAAC;IAEjD,iBAAiB,CAAC,SAAwB;QACxC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;IAED,mBAAmB,CAAC,SAAwB;QAC1C,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,EAAU;QACf,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC1C,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/src/core/animations/CoreAnimation.d.ts

@@ -0,0 +1,27 @@
+import type { CoreNode } from '../CoreNode.js';
+import type { INodeAnimatableProps } from '../../main-api/INode.js';
+import { EventEmitter } from '../../common/EventEmitter.js';
+export interface IAnimationSettings {
+    duration: number;
+    delay: number;
+    easing: string;
+    loop: boolean;
+    repeat: number;
+    repeatDelay: number;
+    stopMethod: 'reverse' | 'reset' | false;
+}
+export declare class CoreAnimation extends EventEmitter {
+    private node;
+    private props;
+    settings: Partial<IAnimationSettings>;
+    propStartValues: Partial<INodeAnimatableProps>;
+    restoreValues: Partial<INodeAnimatableProps>;
+    private progress;
+    private timingFunction;
+    constructor(node: CoreNode, props: Partial<INodeAnimatableProps>, settings: Partial<IAnimationSettings>);
+    reset(): void;
+    restore(): void;
+    reverse(): void;
+    applyEasing(p: number, s: number, e: number): number;
+    update(dt: number): void;
+}

package/dist/src/core/animations/CoreAnimation.js

@@ -0,0 +1,103 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { getTimingFunction } from '../utils.js';
+import { mergeColorProgress } from '../../utils.js';
+import { EventEmitter } from '../../common/EventEmitter.js';
+export class CoreAnimation extends EventEmitter {
+    node;
+    props;
+    settings;
+    propStartValues = {};
+    restoreValues = {};
+    progress = 0;
+    timingFunction;
+    constructor(node, props, settings) {
+        super();
+        this.node = node;
+        this.props = props;
+        this.settings = settings;
+        this.propStartValues = {};
+        Object.keys(props).forEach((propName) => {
+            this.propStartValues[propName] = node[propName];
+        });
+        this.timingFunction = (t) => t;
+        if (settings.easing && typeof settings.easing === 'string') {
+            this.timingFunction = getTimingFunction(settings.easing);
+        }
+    }
+    reset() {
+        this.progress = 0;
+        this.update(0);
+    }
+    restore() {
+        this.reset();
+        Object.keys(this.props).forEach((propName) => {
+            this.node[propName] = this.propStartValues[propName];
+        });
+    }
+    reverse() {
+        this.progress = 0;
+        Object.keys(this.props).forEach((propName) => {
+            // set the start value to the current value
+            const startValue = this.node[propName];
+            const endValue = this.propStartValues[propName];
+            // swap the start and end values
+            this.props[propName] = endValue;
+            this.propStartValues[propName] = startValue;
+        });
+        // restore stop method
+        this.settings.stopMethod = false;
+    }
+    applyEasing(p, s, e) {
+        return (this.timingFunction(p) || p) * (e - s) + s;
+    }
+    update(dt) {
+        // finish if no duration is provided
+        const { duration, loop, easing } = this.settings;
+        if (!duration) {
+            this.emit('finished', {});
+            return;
+        }
+        this.progress += dt / duration;
+        if (this.progress > 1) {
+            this.progress = loop ? 0 : 1;
+            this.emit('finished', {});
+        }
+        Object.keys(this.props).forEach((propName) => {
+            const propValue = this.props[propName];
+            const startValue = this.propStartValues[propName];
+            const endValue = propValue;
+            if (propName.indexOf('color') !== -1) {
+                const progressValue = easing
+                    ? this.timingFunction(this.progress) || this.progress
+                    : this.progress;
+                const colorValue = mergeColorProgress(startValue, endValue, progressValue);
+                this.node[propName] = easing
+                    ? colorValue
+                    : mergeColorProgress(startValue, endValue, this.progress);
+            }
+            else {
+                this.node[propName] = easing
+                    ? this.applyEasing(this.progress, startValue, endValue)
+                    : startValue + (endValue - startValue) * this.progress;
+            }
+        });
+    }
+}
+//# sourceMappingURL=CoreAnimation.js.map

package/dist/src/core/animations/CoreAnimation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CoreAnimation.js","sourceRoot":"","sources":["../../../../src/core/animations/CoreAnimation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAIH,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAY5D,MAAM,OAAO,aAAc,SAAQ,YAAY;IAOnC;IACA;IACD;IARF,eAAe,GAAkC,EAAE,CAAC;IACpD,aAAa,GAAkC,EAAE,CAAC;IACjD,QAAQ,GAAG,CAAC,CAAC;IACb,cAAc,CAAoC;IAE1D,YACU,IAAc,EACd,KAAoC,EACrC,QAAqC;QAE5C,KAAK,EAAE,CAAC;QAJA,SAAI,GAAJ,IAAI,CAAU;QACd,UAAK,GAAL,KAAK,CAA+B;QACrC,aAAQ,GAAR,QAAQ,CAA6B;QAG5C,IAAI,CAAC,eAAe,GAAG,EAAE,CAAC;QACzB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAuC,CAAC,OAAO,CAC/D,CAAC,QAAQ,EAAE,EAAE;YACX,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClD,CAAC,CACF,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC;QAEvC,IAAI,QAAQ,CAAC,MAAM,IAAI,OAAO,QAAQ,CAAC,MAAM,KAAK,QAAQ,EAAE;YAC1D,IAAI,CAAC,cAAc,GAAG,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAC1D;IACH,CAAC;IAED,KAAK;QACH,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAClB,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IAED,OAAO;QACL,IAAI,CAAC,KAAK,EAAE,CAAC;QACZ,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAuC,CAAC,OAAO,CACpE,CAAC,QAAQ,EAAE,EAAE;YACX,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAW,CAAC;QACjE,CAAC,CACF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QACjB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAuC,CAAC,OAAO,CACpE,CAAC,QAAQ,EAAE,EAAE;YACX,2CAA2C;YAC3C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAW,CAAC;YAE1D,gCAAgC;YAChC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;YAChC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC;QAC9C,CAAC,CACF,CAAC;QAEF,sBAAsB;QACtB,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,KAAK,CAAC;IACnC,CAAC;IAED,WAAW,CAAC,CAAS,EAAE,CAAS,EAAE,CAAS;QACzC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,CAAC,EAAU;QACf,oCAAoC;QACpC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QACjD,IAAI,CAAC,QAAQ,EAAE;YACb,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YAC1B,OAAO;SACR;QAED,IAAI,CAAC,QAAQ,IAAI,EAAE,GAAG,QAAQ,CAAC;QAE/B,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE;YACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;SAC3B;QAEA,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAuC,CAAC,OAAO,CACpE,CAAC,QAAQ,EAAE,EAAE;YACX,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAW,CAAC;YACjD,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAW,CAAC;YAC5D,MAAM,QAAQ,GAAG,SAAS,CAAC;YAE3B,IAAI,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE;gBACpC,MAAM,aAAa,GAAG,MAAM;oBAC1B,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ;oBACrD,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAClB,MAAM,UAAU,GAAG,kBAAkB,CACnC,UAAU,EACV,QAAQ,EACR,aAAa,CACd,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,MAAM;oBAC1B,CAAC,CAAC,UAAU;oBACZ,CAAC,CAAC,kBAAkB,CAAC,UAAU,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;aAC7D;iBAAM;gBACL,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,MAAM;oBAC1B,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,QAAQ,CAAC;oBACvD,CAAC,CAAC,UAAU,GAAG,CAAC,QAAQ,GAAG,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;aAC1D;QACH,CAAC,CACF,CAAC;IACJ,CAAC;CACF"}

package/dist/src/core/animations/CoreAnimationController.d.ts

@@ -0,0 +1,21 @@
+import type { AnimationControllerState, IAnimationController } from '../../common/IAnimationController.js';
+import type { AnimationManager } from './AnimationManager.js';
+import type { CoreAnimation } from './CoreAnimation.js';
+export declare class CoreAnimationController implements IAnimationController {
+    private manager;
+    private animation;
+    stoppedPromise: Promise<void> | null;
+    /**
+     * If this is null, then the animation is in a finished / stopped state.
+     */
+    stoppedResolve: (() => void) | null;
+    constructor(manager: AnimationManager, animation: CoreAnimation);
+    state: AnimationControllerState;
+    start(): IAnimationController;
+    stop(): IAnimationController;
+    pause(): IAnimationController;
+    restore(): IAnimationController;
+    waitUntilStopped(): Promise<void>;
+    private makeStoppedPromise;
+    private finished;
+}

package/dist/src/core/animations/CoreAnimationController.js

@@ -0,0 +1,96 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { assertTruthy } from '../../utils.js';
+export class CoreAnimationController {
+    manager;
+    animation;
+    stoppedPromise = null;
+    /**
+     * If this is null, then the animation is in a finished / stopped state.
+     */
+    stoppedResolve = null;
+    constructor(manager, animation) {
+        this.manager = manager;
+        this.animation = animation;
+        this.state = 'stopped';
+    }
+    state;
+    start() {
+        this.makeStoppedPromise();
+        this.animation.once('finished', this.finished.bind(this));
+        // prevent registering the same animation twice
+        if (!this.manager.activeAnimations.has(this.animation)) {
+            this.manager.registerAnimation(this.animation);
+        }
+        this.state = 'running';
+        return this;
+    }
+    stop() {
+        this.manager.unregisterAnimation(this.animation);
+        if (this.stoppedResolve !== null) {
+            this.stoppedResolve();
+            this.stoppedResolve = null;
+        }
+        this.animation.reset();
+        this.state = 'stopped';
+        return this;
+    }
+    pause() {
+        this.manager.unregisterAnimation(this.animation);
+        this.state = 'paused';
+        return this;
+    }
+    restore() {
+        this.stoppedResolve = null;
+        this.animation.restore();
+        return this;
+    }
+    waitUntilStopped() {
+        this.makeStoppedPromise();
+        const promise = this.stoppedPromise;
+        assertTruthy(promise);
+        return promise;
+    }
+    makeStoppedPromise() {
+        if (this.stoppedResolve === null) {
+            this.stoppedPromise = new Promise((resolve) => {
+                this.stoppedResolve = resolve;
+            });
+        }
+    }
+    finished() {
+        assertTruthy(this.stoppedResolve);
+        // If the animation is looping, then we need to restart it.
+        const { loop, stopMethod } = this.animation.settings;
+        if (stopMethod === 'reverse') {
+            this.animation.reverse();
+            this.start();
+            return;
+        }
+        // resolve promise
+        this.stoppedResolve();
+        this.stoppedResolve = null;
+        if (loop) {
+            return;
+        }
+        // unregister animation
+        this.manager.unregisterAnimation(this.animation);
+    }
+}
+//# sourceMappingURL=CoreAnimationController.js.map

package/dist/src/core/animations/CoreAnimationController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CoreAnimationController.js","sourceRoot":"","sources":["../../../../src/core/animations/CoreAnimationController.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAQH,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,MAAM,OAAO,uBAAuB;IAQxB;IACA;IARV,cAAc,GAAyB,IAAI,CAAC;IAC5C;;OAEG;IACH,cAAc,GAAwB,IAAI,CAAC;IAE3C,YACU,OAAyB,EACzB,SAAwB;QADxB,YAAO,GAAP,OAAO,CAAkB;QACzB,cAAS,GAAT,SAAS,CAAe;QAEhC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IACzB,CAAC;IAED,KAAK,CAA2B;IAEhC,KAAK;QACH,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAE1D,+CAA+C;QAC/C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YACtD,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAChD;QAED,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI;QACF,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,cAAc,KAAK,IAAI,EAAE;YAChC,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;SAC5B;QACD,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB;QACd,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC;QACpC,YAAY,CAAC,OAAO,CAAC,CAAC;QACtB,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,kBAAkB;QACxB,IAAI,IAAI,CAAC,cAAc,KAAK,IAAI,EAAE;YAChC,IAAI,CAAC,cAAc,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC5C,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC;YAChC,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAEO,QAAQ;QACd,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAClC,2DAA2D;QAC3D,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QAErD,IAAI,UAAU,KAAK,SAAS,EAAE;YAC5B,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;YACzB,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO;SACR;QAED,kBAAkB;QAClB,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAE3B,IAAI,IAAI,EAAE;YACR,OAAO;SACR;QAED,uBAAuB;QACvB,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC;CACF"}