@terraware/web-components 5.0.2 → 5.0.4

package/components/VirtualWalkthrough/xr-annotation-candidate-buffer.js

@@ -0,0 +1,88 @@
+import { Vec3 } from 'playcanvas';
+
+/** Local half-extent of the unit-plane hotspot quad. */
+const HOTSPOT_HALF_EXTENT = 0.5;
+
+/** Pulls the stock annotation script off a hotspot entity, or undefined if it carries none. */
+
+const scratchScale = new Vec3();
+
+/**
+ * Whether `node` still hangs beneath `sceneRoot`. An entity that has been removed from the scene
+ * keeps its own `children` array - a destroyed one keeps it as an empty array - so only a walk back
+ * up the parent chain tells a live root apart from a detached one.
+ */
+const isInScene = (node, sceneRoot) => {
+  for (let current = node; current; current = current.parent) {
+    if (current === sceneRoot) {
+      return true;
+    }
+  }
+  return false;
+};
+
+/**
+ * Collects world-space hit candidates for the openable annotation hotspots into a buffer it owns and
+ * reuses, so a caller running every frame allocates nothing. The returned array and the candidate
+ * objects inside it are overwritten by the next `collect`, which is why each caller holds its own
+ * buffer rather than sharing one.
+ *
+ * Positions and radii are re-read on every call, so hotspots that move or resize stay targetable.
+ * That read is cheap; it is the allocation around it that a per-frame caller cannot afford.
+ */
+class AnnotationCandidateBuffer {
+  _candidates = [];
+  _root = null;
+  constructor(_getScript) {
+    this._getScript = _getScript;
+  }
+
+  /**
+   * Hit candidates for every openable hotspot except `excludeName`, with hit spheres derived from
+   * each hotspot's rendered world size and padded by `radiusPad` for easier aiming.
+   */
+  collect(app, radiusPad, excludeName) {
+    // The root is looked up by a walk of the whole scene graph, so it is held onto between frames.
+    // It is re-resolved whenever it leaves the scene: annotations mount after the scene does, and
+    // the root is torn down and built afresh every time the annotation list empties and refills.
+    if (!isInScene(this._root, app.root)) {
+      this._root = app.root.findByName('annotations-root');
+    }
+    const children = this._root?.children;
+    if (!children) {
+      this._candidates.length = 0;
+      return this._candidates;
+    }
+    let count = 0;
+    for (const entity of children) {
+      if (excludeName !== undefined && entity.name === excludeName) {
+        continue;
+      }
+      const script = this._getScript(entity);
+      if (!script || script.enabled === false || typeof script.onVrOpenCallback !== 'function') {
+        continue;
+      }
+      entity.getWorldTransform().getScale(scratchScale);
+      const radius = HOTSPOT_HALF_EXTENT * scratchScale.x * radiusPad;
+      const existing = this._candidates[count];
+      if (existing) {
+        existing.entity = entity;
+        existing.script = script;
+        existing.position = entity.getPosition();
+        existing.radius = radius;
+      } else {
+        this._candidates.push({
+          entity,
+          script,
+          position: entity.getPosition(),
+          radius
+        });
+      }
+      count++;
+    }
+    this._candidates.length = count;
+    return this._candidates;
+  }
+}
+
+export { AnnotationCandidateBuffer, HOTSPOT_HALF_EXTENT };

package/components/VirtualWalkthrough/xr-annotation-candidates.d.ts

@@ -1,18 +1,14 @@
-import { Vec3 } from 'playcanvas';
-/** Local half-extent of the unit-plane hotspot quad. */
-export declare const HOTSPOT_HALF_EXTENT = 0.5;
+import { AnnotationCandidate, AnnotationCandidateBuffer, HOTSPOT_HALF_EXTENT } from './xr-annotation-candidate-buffer';
+export { HOTSPOT_HALF_EXTENT };
+export type { AnnotationCandidate };
 /** Multiplier on the hotspot's world radius to make controller targeting forgiving. */
 export declare const HIT_RADIUS_PAD = 2.5;
-export interface AnnotationCandidate {
-    entity: any;
-    script: any;
-    position: Vec3;
-    radius: number;
-}
+/** A buffer wired to the stock annotation script. Callers that collect every frame hold one of
+ * these; its results are overwritten on the next collect, so one buffer cannot be shared. */
+export declare const createAnnotationCandidateBuffer: () => AnnotationCandidateBuffer;
 /**
- * World-space hit candidates for every openable annotation hotspot: its entity, its stock
- * annotation script (which carries `onVrOpenCallback`), its world position, and a hit-sphere
- * radius derived from the hotspot's rendered world size, padded by `radiusPad` for easier aiming.
+ * One-shot collection for callers that run on an input event rather than every frame, and so have no
+ * reason to hold a buffer of their own.
  */
 export declare const collectAnnotationHitCandidates: (app: any, radiusPad: number) => AnnotationCandidate[];
 //# sourceMappingURL=xr-annotation-candidates.d.ts.map

package/components/VirtualWalkthrough/xr-annotation-candidates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"xr-annotation-candidates.d.ts","sourceRoot":"","sources":["../../../src/components/VirtualWalkthrough/xr-annotation-candidates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAGlC,wDAAwD;AACxD,eAAO,MAAM,mBAAmB,MAAM,CAAC;AAEvC,uFAAuF;AACvF,eAAO,MAAM,cAAc,MAAM,CAAC;AAElC,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,GAAG,CAAC;IACZ,QAAQ,EAAE,IAAI,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAID;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,GAAI,KAAK,GAAG,EAAE,WAAW,MAAM,KAAG,mBAAmB,EAmB/F,CAAC"}
+{"version":3,"file":"xr-annotation-candidates.d.ts","sourceRoot":"","sources":["../../../src/components/VirtualWalkthrough/xr-annotation-candidates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAEvH,OAAO,EAAE,mBAAmB,EAAE,CAAC;AAC/B,YAAY,EAAE,mBAAmB,EAAE,CAAC;AAEpC,uFAAuF;AACvF,eAAO,MAAM,cAAc,MAAM,CAAC;AAIlC;6FAC6F;AAC7F,eAAO,MAAM,+BAA+B,QAAO,yBACA,CAAC;AAEpD;;;GAGG;AACH,eAAO,MAAM,8BAA8B,GAAI,KAAK,GAAG,EAAE,WAAW,MAAM,KAAG,mBAAmB,EACrC,CAAC"}

package/components/VirtualWalkthrough/xr-annotation-candidates.js

@@ -1,40 +1,19 @@
-import { Vec3 } from 'playcanvas';
 import { Annotation } from 'playcanvas/scripts/esm/annotations.mjs';
-
-/** Local half-extent of the unit-plane hotspot quad. */
-const HOTSPOT_HALF_EXTENT = 0.5;
+import { AnnotationCandidateBuffer } from './xr-annotation-candidate-buffer.js';
+export { HOTSPOT_HALF_EXTENT } from './xr-annotation-candidate-buffer.js';
 
 /** Multiplier on the hotspot's world radius to make controller targeting forgiving. */
 const HIT_RADIUS_PAD = 2.5;
-const scratchScale = new Vec3();
+const annotationScriptOf = entity => entity.script?.get(Annotation.scriptName);
+
+/** A buffer wired to the stock annotation script. Callers that collect every frame hold one of
+ * these; its results are overwritten on the next collect, so one buffer cannot be shared. */
+const createAnnotationCandidateBuffer = () => new AnnotationCandidateBuffer(annotationScriptOf);
 
 /**
- * World-space hit candidates for every openable annotation hotspot: its entity, its stock
- * annotation script (which carries `onVrOpenCallback`), its world position, and a hit-sphere
- * radius derived from the hotspot's rendered world size, padded by `radiusPad` for easier aiming.
+ * One-shot collection for callers that run on an input event rather than every frame, and so have no
+ * reason to hold a buffer of their own.
  */
-const collectAnnotationHitCandidates = (app, radiusPad) => {
-  const root = app.root.findByName('annotations-root');
-  if (!root) {
-    return [];
-  }
-  return root.children.map(entity => ({
-    entity,
-    script: entity.script?.get(Annotation.scriptName)
-  })).filter(({
-    script
-  }) => script && script.enabled !== false && typeof script.onVrOpenCallback === 'function').map(({
-    entity,
-    script
-  }) => {
-    entity.getWorldTransform().getScale(scratchScale);
-    return {
-      entity,
-      script,
-      position: entity.getPosition(),
-      radius: HOTSPOT_HALF_EXTENT * scratchScale.x * radiusPad
-    };
-  });
-};
+const collectAnnotationHitCandidates = (app, radiusPad) => createAnnotationCandidateBuffer().collect(app, radiusPad);
 
-export { HIT_RADIUS_PAD, HOTSPOT_HALF_EXTENT, collectAnnotationHitCandidates };
+export { HIT_RADIUS_PAD, collectAnnotationHitCandidates, createAnnotationCandidateBuffer };

package/components/VirtualWalkthrough/xr-annotation-targeting.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"xr-annotation-targeting.d.ts","sourceRoot":"","sources":["../../../src/components/VirtualWalkthrough/xr-annotation-targeting.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAElC,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,IAAI,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAsBD;;GAEG;AACH,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,IAAI,EACZ,WAAW,IAAI,EACf,YAAY,sBAAsB,EAAE,KACnC,MAAM,GAAG,IAcX,CAAC"}
+{"version":3,"file":"xr-annotation-targeting.d.ts","sourceRoot":"","sources":["../../../src/components/VirtualWalkthrough/xr-annotation-targeting.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAElC,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,IAAI,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AA0BD;;GAEG;AACH,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,IAAI,EACZ,WAAW,IAAI,EACf,YAAY,sBAAsB,EAAE,KACnC,MAAM,GAAG,IAeX,CAAC"}

package/components/VirtualWalkthrough/xr-annotation-targeting.js

@@ -1,11 +1,15 @@
 import { Vec3 } from 'playcanvas';
 
+// Reused across calls: this runs per candidate per frame, where fresh vectors would be steady GC churn.
+const scratchDir = new Vec3();
+const scratchToCenter = new Vec3();
+
 /**
  * Distance along a (normalized) ray to where it first enters the sphere, or null if it never does.
  * A ray starting inside the sphere returns 0.
  */
 const raySphereEntryDistance = (origin, dir, center, radius) => {
-  const m = new Vec3().sub2(origin, center);
+  const m = scratchToCenter.sub2(origin, center);
   const b = m.dot(dir);
   const c = m.dot(m) - radius * radius;
   if (c > 0 && b > 0) {
@@ -23,16 +27,17 @@ const raySphereEntryDistance = (origin, dir, center, radius) => {
  * Index of the closest candidate sphere the ray enters, or null if it hits none.
  */
 const nearestAnnotationHit = (origin, direction, candidates) => {
-  const dir = direction.clone().normalize();
+  const dir = scratchDir.copy(direction).normalize();
   let bestIndex = null;
   let bestDistance = Infinity;
-  candidates.forEach((candidate, index) => {
+  for (let index = 0; index < candidates.length; index++) {
+    const candidate = candidates[index];
     const distance = raySphereEntryDistance(origin, dir, candidate.position, candidate.radius);
     if (distance !== null && distance < bestDistance) {
       bestDistance = distance;
       bestIndex = index;
     }
-  });
+  }
   return bestIndex;
 };
 

package/components/VirtualWalkthrough/xr-gaze-dwell.d.ts

@@ -5,6 +5,7 @@ export declare class XrGazeDwell extends Script {
      * dwell opens OTHER annotations while one is open (and never re-dwells the open one). */
     activeIndex: number;
     private _dwell;
+    private _candidates;
     private _pieEntity?;
     private _pieMaterial?;
     private _pieMesh?;

package/components/VirtualWalkthrough/xr-gaze-dwell.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"xr-gaze-dwell.d.ts","sourceRoot":"","sources":["../../../src/components/VirtualWalkthrough/xr-gaze-dwell.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,MAAM,EAKP,MAAM,YAAY,CAAC;AAmBpB,qBAAa,WAAY,SAAQ,MAAM;IACrC,MAAM,CAAC,UAAU,SAAiB;IAElC;6FACyF;IACzF,WAAW,SAAM;IAEjB,OAAO,CAAC,MAAM,CAAmC;IAEjD,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,YAAY,CAAC,CAAiB;IACtC,OAAO,CAAC,QAAQ,CAAC,CAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,CAAU;IAE3B,OAAO,CAAC,QAAQ,CAAc;IAC9B,OAAO,CAAC,QAAQ,CAAc;IAC9B,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,QAAQ,CAAc;IAC9B,OAAO,CAAC,aAAa,CAAc;IAEnC,OAAO,CAAC,WAAW,CAAyE;IAE5F;;;;;OAKG;IACH,OAAO,CAAC,UAAU,CAGhB;IAEF,OAAO,CAAC,QAAQ,CAId;IAEF,OAAO,CAAC,cAAc;IAMtB,UAAU;IA4BV,MAAM,CAAC,EAAE,EAAE,MAAM;IAmCjB,OAAO,CAAC,UAAU;IAgBlB,uDAAuD;IACvD,OAAO,CAAC,SAAS;IAcjB,OAAO;CAiBR"}
+{"version":3,"file":"xr-gaze-dwell.d.ts","sourceRoot":"","sources":["../../../src/components/VirtualWalkthrough/xr-gaze-dwell.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,MAAM,EAKP,MAAM,YAAY,CAAC;AAmBpB,qBAAa,WAAY,SAAQ,MAAM;IACrC,MAAM,CAAC,UAAU,SAAiB;IAElC;6FACyF;IACzF,WAAW,SAAM;IAEjB,OAAO,CAAC,MAAM,CAAmC;IACjD,OAAO,CAAC,WAAW,CAAqC;IAExD,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,YAAY,CAAC,CAAiB;IACtC,OAAO,CAAC,QAAQ,CAAC,CAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,CAAU;IAE3B,OAAO,CAAC,QAAQ,CAAc;IAC9B,OAAO,CAAC,QAAQ,CAAc;IAC9B,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,QAAQ,CAAc;IAC9B,OAAO,CAAC,aAAa,CAAc;IAEnC,OAAO,CAAC,WAAW,CAAyE;IAE5F;;;;;OAKG;IACH,OAAO,CAAC,UAAU,CAGhB;IAEF,OAAO,CAAC,QAAQ,CAId;IAEF,OAAO,CAAC,cAAc;IAMtB,UAAU;IA4BV,MAAM,CAAC,EAAE,EAAE,MAAM;IAgCjB,OAAO,CAAC,UAAU;IAgBlB,uDAAuD;IACvD,OAAO,CAAC,SAAS;IAcjB,OAAO;CAiBR"}

package/components/VirtualWalkthrough/xr-gaze-dwell.js

@@ -1,9 +1,10 @@
 import { Vec3, Script, Quat, XRTYPE_VR, MeshInstance, Entity, LAYERID_IMMEDIATE } from 'playcanvas';
-import { collectAnnotationHitCandidates, HOTSPOT_HALF_EXTENT } from './xr-annotation-candidates.js';
+import { createAnnotationCandidateBuffer } from './xr-annotation-candidates.js';
 import { nearestAnnotationHit } from './xr-annotation-targeting.js';
 import { INITIAL_DWELL_STATE, advanceDwell } from './xr-gaze-dwell-state.js';
 import { pieShaderProgress } from './xr-progress-pie.js';
 import { emptyMaskTexture, createProgressPieMaterial, progressPieQuadMesh } from './xr-progress-pie-material.js';
+import { HOTSPOT_HALF_EXTENT } from './xr-annotation-candidate-buffer.js';
 
 /** Multiplier on the hotspot's world radius for gaze targeting. */
 const GAZE_HIT_RADIUS_PAD = 5;
@@ -21,6 +22,7 @@ class XrGazeDwell extends Script {
    * dwell opens OTHER annotations while one is open (and never re-dwells the open one). */
   activeIndex = -1;
   _dwell = INITIAL_DWELL_STATE;
+  _candidates = createAnnotationCandidateBuffer();
   _headPos = new Vec3();
   _headRot = new Quat();
   _viewOffset = new Vec3();
@@ -85,8 +87,7 @@ class XrGazeDwell extends Script {
       this._pieMaterial.setParameter('uProgress', 0);
       return;
     }
-    const activeName = `annotation-${this.activeIndex}`;
-    const candidates = collectAnnotationHitCandidates(this.app, GAZE_HIT_RADIUS_PAD).filter(candidate => candidate.entity.name !== activeName);
+    const candidates = this._candidates.collect(this.app, GAZE_HIT_RADIUS_PAD, `annotation-${this.activeIndex}`);
     this._headRot.transformVector(LOCAL_FORWARD, this._forward);
     const target = nearestAnnotationHit(this._headPos, this._forward, candidates);
     const result = advanceDwell(this._dwell, target, dt, DWELL_SECONDS);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@terraware/web-components",
-  "version": "5.0.2",
+  "version": "5.0.4",
   "author": "Terraformation Inc.",
   "license": "Apache-2.0",
   "repository": {