@lightningjs/renderer 0.6.0 → 0.6.1

package/src/core/CoreNode.ts

@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 
-import { assertTruthy } from '../utils.js';
+import { assertTruthy, mergeColorAlphaPremultiplied } from '../utils.js';
 import type { ShaderMap } from './CoreShaderManager.js';
 import type {
   ExtractProps,
@@ -37,7 +37,11 @@ import type {
   NodeTextureLoadedPayload,
 } from '../common/CommonTypes.js';
 import { EventEmitter } from '../common/EventEmitter.js';
-import { intersectRect, type Rect } from './lib/utils.js';
+import {
+  getNormalizedAlphaComponent,
+  intersectRect,
+  type Rect,
+} from './lib/utils.js';
 import { Matrix3d } from './lib/Matrix3d.js';
 
 export interface CoreNodeProps {
@@ -82,17 +86,83 @@ type ICoreNode = Omit<
   'texture' | 'textureOptions' | 'shader' | 'shaderProps'
 >;
 
+enum UpdateType {
+  /**
+   * Child updates
+   */
+  Children = 1,
+
+  /**
+   * Scale/Rotate transform update
+   */
+  ScaleRotate = 2,
+
+  /**
+   * Translate transform update (x/y/width/height/pivot/mount)
+   */
+  Local = 4,
+
+  /**
+   * Global transform update
+   */
+  Global = 8,
+
+  /**
+   * Clipping rect update
+   */
+  Clipping = 16,
+
+  /**
+   * Calculated ZIndex update
+   */
+  CalculatedZIndex = 32,
+
+  /**
+   * Z-Index Sorted Children update
+   */
+  ZIndexSortedChildren = 64,
+
+  /**
+   * Premultiplied Colors
+   */
+  PremultipliedColors = 128,
+
+  /**
+   * World Alpha
+   *
+   * @remarks
+   * World Alpha = Parent World Alpha * Alpha
+   */
+  WorldAlpha = 256,
+
+  /**
+   * None
+   */
+  None = 0,
+
+  /**
+   * All
+   */
+  All = 511,
+}
+
 export class CoreNode extends EventEmitter implements ICoreNode {
   readonly children: CoreNode[] = [];
   protected props: Required<CoreNodeProps>;
 
-  public recalculationType = 0;
-  public hasUpdates = true;
+  public updateType = UpdateType.All;
   public globalTransform?: Matrix3d;
   public scaleRotateTransform?: Matrix3d;
   public localTransform?: Matrix3d;
   public clippingRect: Rect | null = null;
+  public isRenderable = false;
   private parentClippingRect: Rect | null = null;
+  public worldAlpha = 1;
+  public premultipliedColorTl = 0;
+  public premultipliedColorTr = 0;
+  public premultipliedColorBl = 0;
+  public premultipliedColorBr = 0;
+  public calcZIndex = 0;
 
   private isComplex = false;
 
@@ -122,6 +192,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
 
     this.props.texture = texture;
     this.props.textureOptions = options;
+    this.checkIsRenderable();
 
     // If texture is already loaded / failed, trigger loaded event manually
     // so that users get a consistent event experience.
@@ -145,9 +216,13 @@ export class CoreNode extends EventEmitter implements ICoreNode {
     }
     this.props.texture = null;
     this.props.textureOptions = null;
+    this.checkIsRenderable();
   }
 
   private onTextureLoaded: TextureLoadedEventHandler = (target, dimensions) => {
+    // Texture was loaded. In case the RAF loop has already stopped, we request
+    // a render to ensure the texture is rendered.
+    this.stage.requestRender();
     this.emit('loaded', {
       type: 'texture',
       dimensions,
@@ -171,66 +246,41 @@ export class CoreNode extends EventEmitter implements ICoreNode {
     const { shader, props: p } = shManager.loadShader(shaderType, props);
     this.props.shader = shader;
     this.props.shaderProps = p;
-  }
-
-  setHasUpdates(): void {
-    this.hasUpdates = true;
-  }
-
-  setChildrenHasUpdates(): void {
-    this.children.forEach((child) => {
-      child.setRecalculationType(2);
-    });
-  }
-
-  setParentHasUpdates(): void {
-    if (!this.props.parent) {
-      return;
-    }
-
-    this.props.parent.setRecalculationType(1);
+    this.checkIsRenderable();
   }
 
   /**
    * Change types types is used to determine the scope of the changes being applied
-   * 1 - alpha recalculation
-   * 2 - translate recalculation
-   * 4 - transform recalculation
-   * 8 - z-index recalculation
+   *
+   * @remarks
+   * See {@link UpdateType} for more information on each type
    *
    * @param type
    */
-  setRecalculationType(type: number): void {
-    this.recalculationType |= type;
-    this.setHasUpdates();
-
-    // always forcing parent updates so the root will have an hasUpdates flag
-    this.setParentHasUpdates();
-
-    if (type & 4) {
-      this.setChildrenHasUpdates();
+  setUpdateType(type: UpdateType): void {
+    this.updateType |= type;
+
+    // If we're updating this node at all, we need to inform the parent
+    // (and all ancestors) that their children need updating as well
+    const parent = this.props.parent;
+    if (parent && !(parent.updateType & UpdateType.Children)) {
+      parent.setUpdateType(UpdateType.Children);
     }
   }
 
   sortChildren() {
-    this.children.sort((a, b) => a.zIndex - b.zIndex);
+    this.children.sort((a, b) => a.calcZIndex - b.calcZIndex);
   }
 
   updateScaleRotateTransform() {
-    this.setRecalculationType(4);
-
     this.scaleRotateTransform = Matrix3d.rotate(
       this.props.rotation,
       this.scaleRotateTransform,
     ).scale(this.props.scaleX, this.props.scaleY);
-
-    // do transformations when matrix is implemented
-    this.updateLocalTransform();
   }
 
   updateLocalTransform() {
     assertTruthy(this.scaleRotateTransform);
-    this.setRecalculationType(2);
     const pivotTranslateX = this.props.pivotX * this.props.width;
     const pivotTranslateY = this.props.pivotY * this.props.height;
     const mountTranslateX = this.props.mountX * this.props.width;
@@ -243,6 +293,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
     )
       .multiply(this.scaleRotateTransform)
       .translate(-pivotTranslateX, -pivotTranslateY);
+    this.setUpdateType(UpdateType.Global);
   }
 
   /**
@@ -250,45 +301,145 @@ export class CoreNode extends EventEmitter implements ICoreNode {
    * @param delta
    */
   update(delta: number, parentClippingRect: Rect | null = null): void {
-    assertTruthy(this.localTransform);
-    const parentGlobalTransform = this.parent?.globalTransform;
-    if (parentGlobalTransform) {
-      this.globalTransform = Matrix3d.copy(
-        parentGlobalTransform,
-        this.globalTransform,
-      ).multiply(this.localTransform);
-    } else {
+    if (this.updateType & UpdateType.ScaleRotate) {
+      this.updateScaleRotateTransform();
+      this.setUpdateType(UpdateType.Local);
+    }
+
+    if (this.updateType & UpdateType.Local) {
+      this.updateLocalTransform();
+      this.setUpdateType(UpdateType.Global);
+    }
+
+    const parent = this.props.parent;
+    let childUpdateType = UpdateType.None;
+    if (this.updateType & UpdateType.Global) {
+      assertTruthy(this.localTransform);
       this.globalTransform = Matrix3d.copy(
-        this.localTransform,
+        parent?.globalTransform || this.localTransform,
         this.globalTransform,
       );
+
+      if (parent) {
+        this.globalTransform.multiply(this.localTransform);
+      }
+
+      this.setUpdateType(UpdateType.Clipping | UpdateType.Children);
+      childUpdateType |= UpdateType.Global;
+    }
+
+    if (this.updateType & UpdateType.Clipping) {
+      this.calculateClippingRect(parentClippingRect);
+      this.checkIsRenderable();
+      this.setUpdateType(UpdateType.Children);
+      childUpdateType |= UpdateType.Clipping;
     }
 
-    this.calculateClippingRect(parentClippingRect);
+    if (this.updateType & UpdateType.WorldAlpha) {
+      if (parent) {
+        this.worldAlpha = parent.worldAlpha * this.props.alpha;
+      } else {
+        this.worldAlpha = this.props.alpha;
+      }
+      this.setUpdateType(UpdateType.Children | UpdateType.PremultipliedColors);
+      childUpdateType |= UpdateType.WorldAlpha;
+    }
+
+    if (this.updateType & UpdateType.PremultipliedColors) {
+      this.premultipliedColorTl = mergeColorAlphaPremultiplied(
+        this.props.colorTl,
+        this.worldAlpha,
+        true,
+      );
+      this.premultipliedColorTr = mergeColorAlphaPremultiplied(
+        this.props.colorTr,
+        this.worldAlpha,
+        true,
+      );
+      this.premultipliedColorBl = mergeColorAlphaPremultiplied(
+        this.props.colorBl,
+        this.worldAlpha,
+        true,
+      );
+      this.premultipliedColorBr = mergeColorAlphaPremultiplied(
+        this.props.colorBr,
+        this.worldAlpha,
+        true,
+      );
+
+      this.checkIsRenderable();
+      this.setUpdateType(UpdateType.Children);
+      childUpdateType |= UpdateType.PremultipliedColors;
+    }
 
-    if (this.children.length) {
+    // No need to update zIndex if there is no parent
+    if (parent && this.updateType & UpdateType.CalculatedZIndex) {
+      this.calculateZIndex();
+      // Tell parent to re-sort children
+      parent.setUpdateType(UpdateType.ZIndexSortedChildren);
+    }
+
+    if (this.updateType & UpdateType.Children && this.children.length) {
       this.children.forEach((child) => {
+        // Trigger the depenedent update types on the child
+        child.setUpdateType(childUpdateType);
+        // If child has no updates, skip
+        if (child.updateType === 0) {
+          return;
+        }
         child.update(delta, this.clippingRect);
       });
     }
 
-    if (this.recalculationType & 8) {
+    // Sorting children MUST happen after children have been updated so
+    // that they have the oppotunity to update their calculated zIndex.
+    if (this.updateType & UpdateType.ZIndexSortedChildren) {
       // reorder z-index
       this.sortChildren();
     }
 
-    // reset update flag
-    this.hasUpdates = false;
+    // reset update type
+    this.updateType = 0;
+  }
+
+  // This function checks if the current node is renderable based on certain properties.
+  // It returns true if any of the specified properties are truthy or if any color property is not 0, otherwise it returns false.
+  checkIsRenderable(): boolean {
+    if (this.props.texture) {
+      return (this.isRenderable = true);
+    }
+
+    if (this.props.shader) {
+      return (this.isRenderable = true);
+    }
+
+    if (this.props.clipping) {
+      return (this.isRenderable = true);
+    }
+
+    const colors = [
+      'color',
+      'colorTop',
+      'colorBottom',
+      'colorLeft',
+      'colorRight',
+      'colorTl',
+      'colorTr',
+      'colorBl',
+      'colorBr',
+    ];
+    if (
+      colors.some((color) => this.props[color as keyof CoreNodeProps] !== 0)
+    ) {
+      return (this.isRenderable = true);
+    }
 
-    // reset recalculation type
-    this.recalculationType = 0;
+    return (this.isRenderable = false);
   }
 
   /**
    * This function calculates the clipping rectangle for a node.
    *
-   * If the node's globalTransform is not set, the function returns immediately.
-   * If the node's props do not require clipping and there is no parent clipping rectangle, the node's clipping rectangle is set to null.
    * If the parent clipping rectangle has not changed and the node's clipping rectangle is already set, the function returns immediately.
    *
    * The function then checks if the node is rotated. If the node requires clipping and is not rotated, a new clipping rectangle is created based on the node's global transform and dimensions.
@@ -297,14 +448,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
    * Finally, the node's parentClippingRect and clippingRect properties are updated.
    */
   calculateClippingRect(parentClippingRect: Rect | null = null) {
-    if (!this.globalTransform) {
-      return;
-    }
-
-    if (!this.props.clipping && !parentClippingRect) {
-      this.clippingRect = null;
-      return;
-    }
+    assertTruthy(this.globalTransform);
 
     if (this.parentClippingRect === parentClippingRect && this.clippingRect) {
       return;
@@ -332,19 +476,28 @@ export class CoreNode extends EventEmitter implements ICoreNode {
     this.clippingRect = clippingRect;
   }
 
+  calculateZIndex(): void {
+    const props = this.props;
+    const z = props.zIndex || 0;
+    const p = props.parent?.zIndex || 0;
+
+    let zIndex = z;
+    if (props.parent?.zIndexLocked) {
+      zIndex = z < p ? z : p;
+    }
+    this.calcZIndex = zIndex;
+  }
+
   renderQuads(renderer: CoreRenderer): void {
+    const { width, height, texture, textureOptions, shader, shaderProps } =
+      this.props;
     const {
-      width,
-      height,
-      colorTl,
-      colorTr,
-      colorBl,
-      colorBr,
-      texture,
-      textureOptions,
-      shader,
-      shaderProps,
-    } = this.props;
+      premultipliedColorTl,
+      premultipliedColorTr,
+      premultipliedColorBl,
+      premultipliedColorBr,
+    } = this;
+
     const { zIndex, worldAlpha, globalTransform: gt, clippingRect } = this;
 
     assertTruthy(gt);
@@ -353,10 +506,10 @@ export class CoreNode extends EventEmitter implements ICoreNode {
     renderer.addQuad({
       width,
       height,
-      colorTl,
-      colorTr,
-      colorBl,
-      colorBr,
+      colorTl: premultipliedColorTl,
+      colorTr: premultipliedColorTr,
+      colorBl: premultipliedColorBl,
+      colorBr: premultipliedColorBr,
       texture,
       textureOptions,
       zIndex,
@@ -388,7 +541,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
   set x(value: number) {
     if (this.props.x !== value) {
       this.props.x = value;
-      this.updateLocalTransform();
+      this.setUpdateType(UpdateType.Local);
     }
   }
 
@@ -410,7 +563,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
   set y(value: number) {
     if (this.props.y !== value) {
       this.props.y = value;
-      this.updateLocalTransform();
+      this.setUpdateType(UpdateType.Local);
     }
   }
 
@@ -421,7 +574,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
   set width(value: number) {
     if (this.props.width !== value) {
       this.props.width = value;
-      this.updateLocalTransform();
+      this.setUpdateType(UpdateType.Local);
     }
   }
 
@@ -432,7 +585,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
   set height(value: number) {
     if (this.props.height !== value) {
       this.props.height = value;
-      this.updateLocalTransform();
+      this.setUpdateType(UpdateType.Local);
     }
   }
 
@@ -456,7 +609,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
   set scaleX(value: number) {
     if (this.props.scaleX !== value) {
       this.props.scaleX = value;
-      this.updateScaleRotateTransform();
+      this.setUpdateType(UpdateType.ScaleRotate);
     }
   }
 
@@ -467,35 +620,21 @@ export class CoreNode extends EventEmitter implements ICoreNode {
   set scaleY(value: number) {
     if (this.props.scaleY !== value) {
       this.props.scaleY = value;
-      this.updateScaleRotateTransform();
+      this.setUpdateType(UpdateType.ScaleRotate);
     }
   }
 
-  get worldScaleX(): number {
-    return (
-      this.props.scaleX * (this.props.parent?.worldScaleX ?? 1) ||
-      this.props.scaleX
-    );
-  }
-
-  get worldScaleY(): number {
-    return (
-      this.props.scaleY * (this.props.parent?.worldScaleY ?? 1) ||
-      this.props.scaleY
-    );
-  }
-
   get mount(): number {
     return this.props.mount;
   }
 
   set mount(value: number) {
-    // if (this.props.mountX !== value || this.props.mountY !== value) {
-    this.props.mountX = value;
-    this.props.mountY = value;
-    this.props.mount = value;
-    this.updateLocalTransform();
-    // }
+    if (this.props.mountX !== value || this.props.mountY !== value) {
+      this.props.mountX = value;
+      this.props.mountY = value;
+      this.props.mount = value;
+      this.setUpdateType(UpdateType.Local);
+    }
   }
 
   get mountX(): number {
@@ -503,8 +642,10 @@ export class CoreNode extends EventEmitter implements ICoreNode {
   }
 
   set mountX(value: number) {
-    this.props.mountX = value;
-    this.updateLocalTransform();
+    if (this.props.mountX !== value) {
+      this.props.mountX = value;
+      this.setUpdateType(UpdateType.Local);
+    }
   }
 
   get mountY(): number {
@@ -512,8 +653,10 @@ export class CoreNode extends EventEmitter implements ICoreNode {
   }
 
   set mountY(value: number) {
-    this.props.mountY = value;
-    this.updateLocalTransform();
+    if (this.props.mountY !== value) {
+      this.props.mountY = value;
+      this.setUpdateType(UpdateType.Local);
+    }
   }
 
   get pivot(): number {
@@ -524,7 +667,8 @@ export class CoreNode extends EventEmitter implements ICoreNode {
     if (this.props.pivotX !== value || this.props.pivotY !== value) {
       this.props.pivotX = value;
       this.props.pivotY = value;
-      this.updateLocalTransform();
+      this.props.pivot = value;
+      this.setUpdateType(UpdateType.Local);
     }
   }
 
@@ -533,8 +677,10 @@ export class CoreNode extends EventEmitter implements ICoreNode {
   }
 
   set pivotX(value: number) {
-    this.props.pivotX = value;
-    this.updateLocalTransform();
+    if (this.props.pivotX !== value) {
+      this.props.pivotX = value;
+      this.setUpdateType(UpdateType.Local);
+    }
   }
 
   get pivotY(): number {
@@ -542,8 +688,10 @@ export class CoreNode extends EventEmitter implements ICoreNode {
   }
 
   set pivotY(value: number) {
-    this.props.pivotY = value;
-    this.updateLocalTransform();
+    if (this.props.pivotY !== value) {
+      this.props.pivotY = value;
+      this.setUpdateType(UpdateType.Local);
+    }
   }
 
   get rotation(): number {
@@ -553,7 +701,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
   set rotation(value: number) {
     if (this.props.rotation !== value) {
       this.props.rotation = value;
-      this.updateScaleRotateTransform();
+      this.setUpdateType(UpdateType.ScaleRotate);
     }
   }
 
@@ -563,14 +711,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
 
   set alpha(value: number) {
     this.props.alpha = value;
-    this.setRecalculationType(1);
-  }
-
-  get worldAlpha(): number {
-    const props = this.props;
-    const parent = props.parent;
-
-    return props.alpha * (parent?.worldAlpha || 1);
+    this.setUpdateType(UpdateType.PremultipliedColors | UpdateType.WorldAlpha);
   }
 
   get clipping(): boolean {
@@ -579,8 +720,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
 
   set clipping(value: boolean) {
     this.props.clipping = value;
-    this.clippingRect = null;
-    this.setRecalculationType(4);
+    this.setUpdateType(UpdateType.Clipping);
   }
 
   get color(): number {
@@ -601,7 +741,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
     }
     this.props.color = value;
 
-    this.setRecalculationType(2);
+    this.setUpdateType(UpdateType.PremultipliedColors);
   }
 
   get colorTop(): number {
@@ -614,7 +754,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
       this.colorTr = value;
     }
     this.props.colorTop = value;
-    this.setRecalculationType(2);
+    this.setUpdateType(UpdateType.PremultipliedColors);
   }
 
   get colorBottom(): number {
@@ -627,7 +767,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
       this.colorBr = value;
     }
     this.props.colorBottom = value;
-    this.setRecalculationType(2);
+    this.setUpdateType(UpdateType.PremultipliedColors);
   }
 
   get colorLeft(): number {
@@ -640,7 +780,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
       this.colorBl = value;
     }
     this.props.colorLeft = value;
-    this.setRecalculationType(2);
+    this.setUpdateType(UpdateType.PremultipliedColors);
   }
 
   get colorRight(): number {
@@ -653,7 +793,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
       this.colorBr = value;
     }
     this.props.colorRight = value;
-    this.setRecalculationType(2);
+    this.setUpdateType(UpdateType.PremultipliedColors);
   }
 
   get colorTl(): number {
@@ -662,7 +802,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
 
   set colorTl(value: number) {
     this.props.colorTl = value;
-    this.setRecalculationType(2);
+    this.setUpdateType(UpdateType.PremultipliedColors);
   }
 
   get colorTr(): number {
@@ -671,7 +811,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
 
   set colorTr(value: number) {
     this.props.colorTr = value;
-    this.setRecalculationType(2);
+    this.setUpdateType(UpdateType.PremultipliedColors);
   }
 
   get colorBl(): number {
@@ -680,7 +820,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
 
   set colorBl(value: number) {
     this.props.colorBl = value;
-    this.setRecalculationType(2);
+    this.setUpdateType(UpdateType.PremultipliedColors);
   }
 
   get colorBr(): number {
@@ -689,7 +829,7 @@ export class CoreNode extends EventEmitter implements ICoreNode {
 
   set colorBr(value: number) {
     this.props.colorBr = value;
-    this.setRecalculationType(2);
+    this.setUpdateType(UpdateType.PremultipliedColors);
   }
 
   // we're only interested in parent zIndex to test
@@ -700,22 +840,22 @@ export class CoreNode extends EventEmitter implements ICoreNode {
 
   set zIndexLocked(value: number) {
     this.props.zIndexLocked = value;
+    this.setUpdateType(UpdateType.CalculatedZIndex | UpdateType.Children);
+    this.children.forEach((child) => {
+      child.setUpdateType(UpdateType.CalculatedZIndex);
+    });
   }
 
   get zIndex(): number {
-    const props = this.props;
-    const z = props.zIndex || 0;
-    const p = props.parent?.zIndex || 0;
-
-    if (props.parent?.zIndexLocked) {
-      return z < p ? z : p;
-    }
-    return z;
+    return this.props.zIndex;
   }
 
   set zIndex(value: number) {
     this.props.zIndex = value;
-    this.props.parent?.setRecalculationType(8);
+    this.setUpdateType(UpdateType.CalculatedZIndex | UpdateType.Children);
+    this.children.forEach((child) => {
+      child.setUpdateType(UpdateType.CalculatedZIndex);
+    });
   }
 
   get parent(): CoreNode | null {
@@ -738,8 +878,12 @@ export class CoreNode extends EventEmitter implements ICoreNode {
     }
     if (newParent) {
       newParent.children.push(this);
-      // force parent to recalculate z-index for its children
-      newParent.setRecalculationType(8);
+      // Since this node has a new parent, to be safe, have it do a full update.
+      this.setUpdateType(UpdateType.All);
+      // Tell parent that it's children need to be updated and sorted.
+      newParent.setUpdateType(
+        UpdateType.Children | UpdateType.ZIndexSortedChildren,
+      );
     }
 
     this.updateScaleRotateTransform();