@lightningjs/renderer 2.12.0 → 2.13.0

package/src/common/CommonTypes.ts

@@ -1,146 +1,146 @@
-/*
- * If not stated otherwise in this file or this component's LICENSE file the
- * following copyright and licenses apply:
- *
- * Copyright 2023 Comcast Cable Communications Management, LLC.
- *
- * 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 type { CoreNodeRenderState } from '../core/CoreNode.js';
-
-/**
- * Types shared between Main Space and Core Space
- *
- * @remarks
- *
- * @module
- */
-
-/**
- * Represents a width and height.
- */
-export interface Dimensions {
-  width: number;
-  height: number;
-}
-
-/**
- * Payload for when text is loaded
- */
-export type NodeTextLoadedPayload = {
-  type: 'text';
-  dimensions: Dimensions;
-};
-
-/**
- * Payload for when texture is loaded
- */
-export type NodeTextureLoadedPayload = {
-  type: 'texture';
-  dimensions: Dimensions;
-};
-
-/**
- * Combined type for all loaded payloads
- */
-export type NodeLoadedPayload =
-  | NodeTextLoadedPayload
-  | NodeTextureLoadedPayload;
-
-/**
- * Payload for when text failed to load
- */
-export type NodeTextFailedPayload = {
-  type: 'text';
-  error: Error;
-};
-
-/**
- * Payload for when texture failed to load
- */
-export type NodeTextureFailedPayload = {
-  type: 'texture';
-  error: Error;
-};
-
-/**
- * Payload for when texture failed to load
- */
-export type NodeTextureFreedPayload = {
-  type: 'texture';
-};
-
-/**
- * Combined type for all failed payloads
- */
-export type NodeFailedPayload =
-  | NodeTextFailedPayload
-  | NodeTextureFailedPayload;
-
-/**
- * Event handler for when the texture/text of a node has loaded
- */
-export type NodeLoadedEventHandler = (
-  target: any,
-  payload: NodeLoadedPayload,
-) => void;
-
-/**
- * Event handler for when the texture/text of a node has failed to load
- */
-export type NodeFailedEventHandler = (
-  target: any,
-  payload: NodeFailedPayload,
-) => void;
-
-export type NodeRenderStatePayload = {
-  type: 'renderState';
-  payload: CoreNodeRenderState;
-};
-
-export type NodeRenderStateEventHandler = (
-  target: any,
-  payload: NodeRenderStatePayload,
-) => void;
-
-/**
- * Event payload for when an FpsUpdate event is emitted by either the Stage or
- * MainRenderer
- */
-export interface FpsUpdatePayload {
-  fps: number;
-  contextSpyData: Record<string, number> | null;
-}
-
-/**
- * Event payload for when a frame tick event is emitted by the Stage
- */
-export interface FrameTickPayload {
-  time: number;
-  delta: number;
-}
-
-/**
- * Event payload for when a an animtion tick event is emitted
- */
-export interface AnimationTickPayload {
-  progress: number;
-}
-
-/**
- * Event payload for when an QuadsUpdate event is emitted by the Stage
- */
-export interface QuadsUpdatePayload {
-  quads: number;
-}
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * 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 type { CoreNodeRenderState } from '../core/CoreNode.js';
+
+/**
+ * Types shared between Main Space and Core Space
+ *
+ * @remarks
+ *
+ * @module
+ */
+
+/**
+ * Represents a width and height.
+ */
+export interface Dimensions {
+  width: number;
+  height: number;
+}
+
+/**
+ * Payload for when text is loaded
+ */
+export type NodeTextLoadedPayload = {
+  type: 'text';
+  dimensions: Dimensions;
+};
+
+/**
+ * Payload for when texture is loaded
+ */
+export type NodeTextureLoadedPayload = {
+  type: 'texture';
+  dimensions: Dimensions;
+};
+
+/**
+ * Combined type for all loaded payloads
+ */
+export type NodeLoadedPayload =
+  | NodeTextLoadedPayload
+  | NodeTextureLoadedPayload;
+
+/**
+ * Payload for when text failed to load
+ */
+export type NodeTextFailedPayload = {
+  type: 'text';
+  error: Error;
+};
+
+/**
+ * Payload for when texture failed to load
+ */
+export type NodeTextureFailedPayload = {
+  type: 'texture';
+  error: Error;
+};
+
+/**
+ * Payload for when texture failed to load
+ */
+export type NodeTextureFreedPayload = {
+  type: 'texture';
+};
+
+/**
+ * Combined type for all failed payloads
+ */
+export type NodeFailedPayload =
+  | NodeTextFailedPayload
+  | NodeTextureFailedPayload;
+
+/**
+ * Event handler for when the texture/text of a node has loaded
+ */
+export type NodeLoadedEventHandler = (
+  target: any,
+  payload: NodeLoadedPayload,
+) => void;
+
+/**
+ * Event handler for when the texture/text of a node has failed to load
+ */
+export type NodeFailedEventHandler = (
+  target: any,
+  payload: NodeFailedPayload,
+) => void;
+
+export type NodeRenderStatePayload = {
+  type: 'renderState';
+  payload: CoreNodeRenderState;
+};
+
+export type NodeRenderStateEventHandler = (
+  target: any,
+  payload: NodeRenderStatePayload,
+) => void;
+
+/**
+ * Event payload for when an FpsUpdate event is emitted by either the Stage or
+ * MainRenderer
+ */
+export interface FpsUpdatePayload {
+  fps: number;
+  contextSpyData: Record<string, number> | null;
+}
+
+/**
+ * Event payload for when a frame tick event is emitted by the Stage
+ */
+export interface FrameTickPayload {
+  time: number;
+  delta: number;
+}
+
+/**
+ * Event payload for when a an animtion tick event is emitted
+ */
+export interface AnimationTickPayload {
+  progress: number;
+}
+
+/**
+ * Event payload for when an QuadsUpdate event is emitted by the Stage
+ */
+export interface QuadsUpdatePayload {
+  quads: number;
+}

package/src/common/EventEmitter.ts

@@ -1,77 +1,77 @@
-/*
- * If not stated otherwise in this file or this component's LICENSE file the
- * following copyright and licenses apply:
- *
- * Copyright 2023 Comcast Cable Communications Management, LLC.
- *
- * 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.
- */
-
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import type { IEventEmitter } from './IEventEmitter.js';
-
-/**
- * EventEmitter base class
- */
-export class EventEmitter implements IEventEmitter {
-  private eventListeners: { [eventName: string]: any } = {};
-
-  on(event: string, listener: (target: any, data: any) => void): void {
-    let listeners = this.eventListeners[event];
-    if (!listeners) {
-      listeners = [];
-    }
-    listeners.push(listener);
-    this.eventListeners[event] = listeners;
-  }
-
-  off(event: string, listener?: (target: any, data: any) => void): void {
-    const listeners = this.eventListeners[event];
-    if (!listeners) {
-      return;
-    }
-    if (!listener) {
-      delete this.eventListeners[event];
-      return;
-    }
-    const index = listeners.indexOf(listener);
-    if (index >= 0) {
-      listeners.splice(index, 1);
-    }
-  }
-
-  once(event: string, listener: (target: any, data: any) => void): void {
-    const onceListener = (target: any, data: any) => {
-      this.off(event, onceListener);
-      listener(target, data);
-    };
-    this.on(event, onceListener);
-  }
-
-  emit(event: string, data?: any): void {
-    const listeners = this.eventListeners[event];
-    if (!listeners) {
-      return;
-    }
-    [...listeners].forEach((listener) => {
-      listener(this, data);
-    });
-  }
-
-  removeAllListeners() {
-    this.eventListeners = {};
-  }
-}
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * 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.
+ */
+
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { IEventEmitter } from './IEventEmitter.js';
+
+/**
+ * EventEmitter base class
+ */
+export class EventEmitter implements IEventEmitter {
+  private eventListeners: { [eventName: string]: any } = {};
+
+  on(event: string, listener: (target: any, data: any) => void): void {
+    let listeners = this.eventListeners[event];
+    if (!listeners) {
+      listeners = [];
+    }
+    listeners.push(listener);
+    this.eventListeners[event] = listeners;
+  }
+
+  off(event: string, listener?: (target: any, data: any) => void): void {
+    const listeners = this.eventListeners[event];
+    if (!listeners) {
+      return;
+    }
+    if (!listener) {
+      delete this.eventListeners[event];
+      return;
+    }
+    const index = listeners.indexOf(listener);
+    if (index >= 0) {
+      listeners.splice(index, 1);
+    }
+  }
+
+  once(event: string, listener: (target: any, data: any) => void): void {
+    const onceListener = (target: any, data: any) => {
+      this.off(event, onceListener);
+      listener(target, data);
+    };
+    this.on(event, onceListener);
+  }
+
+  emit(event: string, data?: any): void {
+    const listeners = this.eventListeners[event];
+    if (!listeners) {
+      return;
+    }
+    [...listeners].forEach((listener) => {
+      listener(this, data);
+    });
+  }
+
+  removeAllListeners() {
+    this.eventListeners = {};
+  }
+}

package/src/common/IAnimationController.ts

@@ -1,92 +1,92 @@
-/*
- * If not stated otherwise in this file or this component's LICENSE file the
- * following copyright and licenses apply:
- *
- * Copyright 2023 Comcast Cable Communications Management, LLC.
- *
- * 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 type { IEventEmitter } from './IEventEmitter.js';
-
-export type AnimationControllerState =
-  | 'scheduled'
-  | 'running'
-  | 'paused'
-  | 'stopped';
-
-/**
- * Animation Controller interface
- *
- * @remarks
- * This interface is used to control animations. It provides methods to start,
- * stop, pause, and restore animations. It also provides a way to wait for the
- * animation to stop.
- *
- * This interface extends the `IEventEmitter` interface, which means you can
- * listen to these events emitted by the animation controller:
- * - `animating` - Emitted when the animation finishes it's delay phase and
- *   starts animating.
- * - `stopped` - Emitted when the animation stops either by calling the `stop()`
- *    method or when the animation finishes naturally.
- */
-export interface IAnimationController extends IEventEmitter {
-  /**
-   * Start the animation
-   *
-   * @remarks
-   * If the animation is paused this method will resume the animation.
-   */
-  start(): IAnimationController;
-  /**
-   * Stop the animation
-   *
-   * @remarks
-   * Resets the animation to the start state
-   */
-  stop(): IAnimationController;
-  /**
-   * Pause the animation
-   */
-  pause(): IAnimationController;
-  /**
-   * Restore the animation to the original values
-   */
-  restore(): IAnimationController;
-
-  /**
-   * Promise that resolves when the last active animation is stopped (including
-   * when the animation finishes naturally).
-   *
-   * @remarks
-   * The Promise returned by this method is reset every time the animation
-   * enters a new start/stop cycle. This means you must call `start()` before
-   * calling this method if you want to wait for the animation to stop.
-   *
-   * This method always returns a resolved promise if the animation is currently
-   * in a stopped state.
-   *
-   * @returns
-   */
-  waitUntilStopped(): Promise<void>;
-
-  /**
-   * Current state of the animation
-   *
-   * @remarks
-   * - `stopped` - The animation is currently stopped (at the beggining or end
-   *   of the animation)
-   * - `running` - The animation is currently running
-   * - `paused` - The animation is currently paused
-   */
-  readonly state: AnimationControllerState;
-}
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * 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 type { IEventEmitter } from './IEventEmitter.js';
+
+export type AnimationControllerState =
+  | 'scheduled'
+  | 'running'
+  | 'paused'
+  | 'stopped';
+
+/**
+ * Animation Controller interface
+ *
+ * @remarks
+ * This interface is used to control animations. It provides methods to start,
+ * stop, pause, and restore animations. It also provides a way to wait for the
+ * animation to stop.
+ *
+ * This interface extends the `IEventEmitter` interface, which means you can
+ * listen to these events emitted by the animation controller:
+ * - `animating` - Emitted when the animation finishes it's delay phase and
+ *   starts animating.
+ * - `stopped` - Emitted when the animation stops either by calling the `stop()`
+ *    method or when the animation finishes naturally.
+ */
+export interface IAnimationController extends IEventEmitter {
+  /**
+   * Start the animation
+   *
+   * @remarks
+   * If the animation is paused this method will resume the animation.
+   */
+  start(): IAnimationController;
+  /**
+   * Stop the animation
+   *
+   * @remarks
+   * Resets the animation to the start state
+   */
+  stop(): IAnimationController;
+  /**
+   * Pause the animation
+   */
+  pause(): IAnimationController;
+  /**
+   * Restore the animation to the original values
+   */
+  restore(): IAnimationController;
+
+  /**
+   * Promise that resolves when the last active animation is stopped (including
+   * when the animation finishes naturally).
+   *
+   * @remarks
+   * The Promise returned by this method is reset every time the animation
+   * enters a new start/stop cycle. This means you must call `start()` before
+   * calling this method if you want to wait for the animation to stop.
+   *
+   * This method always returns a resolved promise if the animation is currently
+   * in a stopped state.
+   *
+   * @returns
+   */
+  waitUntilStopped(): Promise<void>;
+
+  /**
+   * Current state of the animation
+   *
+   * @remarks
+   * - `stopped` - The animation is currently stopped (at the beggining or end
+   *   of the animation)
+   * - `running` - The animation is currently running
+   * - `paused` - The animation is currently paused
+   */
+  readonly state: AnimationControllerState;
+}