@carbonenginejs/runtime 0.1.0-alpha.0 → 0.1.0-alpha.1

package/dist/trinity/eve/child/EveChildContainer.js

@@ -14,7 +14,7 @@ import { EveComponentType } from '../EveComponentTypes.js';
 import { Origin } from '../../generated/eve/child/enums.js';
 import { Tr2RenderReason, TR2SHADERMODEL } from '../../generated/trinityCore/enums.js';
 import { Tr2Lod } from '#consts/trinity';
-import '../../core/rawData/Tr2PerObjectData.js';
+import '../../core/rawData/perObjectData/Tr2PerObjectData.js';
 import { createChildPerObjectRecords, inheritParentPerObjectData, stampChildTransforms } from '../perObjectData/childPerObjectRecords.js';
 import { withITr2Renderable } from '../../core/ITr2Renderable.js';
 
@@ -25,10 +25,10 @@ let _initProto, _initClass, _init_displayFilter, _init_extra_displayFilter, _ini
 // module scratch here - see GetBoundingSphere).
 const ZERO_VEC3 = vec3.create();
 
-/**
- * Space-object child that groups other children under one transform, owning
- * their curve sets, controllers, observers, lights, attachments and transform
- * modifiers, and gating them on a display-quality filter.
+/**
+ * Space-object child that groups other children under one transform, owning
+ * their curve sets, controllers, observers, lights, attachments and transform
+ * modifiers, and gating them on a display-quality filter.
  */
 let _EveChildContainer;
 new class extends _identity {
@@ -98,9 +98,9 @@ new class extends _identity {
       return this.IsUpdating();
     }
 
-    /**
-     * Links every authored controller that is not already linked to this
-     * container, so controller variables and events reach them.
+    /**
+     * Links every authored controller that is not already linked to this
+     * container, so controller variables and events reach them.
      */
     Initialize() {
       this.RegisterChildren(this.objects);
@@ -112,9 +112,9 @@ new class extends _identity {
       return true;
     }
 
-    /** Carbon EveChildContainer::OnModified (cpp:76-88): display/displayFilter
-     * changes re-register with the scene component registry (engine-owned,
-     * omitted); a mute change fans out to children and observers. The value
+    /** Carbon EveChildContainer::OnModified (cpp:76-88): display/displayFilter
+     * changes re-register with the scene component registry (engine-owned,
+     * omitted); a mute change fans out to children and observers. The value
      * argument follows the repo's OnModified duck (field name or field value). */
     OnModified(value = null) {
       if (value === "mute" || value === this.mute) {
@@ -123,18 +123,18 @@ new class extends _identity {
       return true;
     }
 
-    /**
-     * Applies the authored scale/rotation/translation through the shared child
-     * transform setup and returns the rebuilt local transform; lowestLodVisible is
-     * accepted for signature parity only.
+    /**
+     * Applies the authored scale/rotation/translation through the shared child
+     * transform setup and returns the rebuilt local transform; lowestLodVisible is
+     * accepted for signature parity only.
      */
     Setup(scale = null, rotation = null, translation = null, lowestLodVisible = null) {
       return super.Setup(scale, rotation, translation, lowestLodVisible);
     }
 
-    /**
-     * Returns the authored container name, which GetEffectChildByName matches
-     * against on the parent side.
+    /**
+     * Returns the authored container name, which GetEffectChildByName matches
+     * against on the parent side.
      */
     GetName() {
       return this.name;
@@ -145,9 +145,9 @@ new class extends _identity {
       this.name = String(name ?? "");
     }
 
-    /**
-     * Records whether this container's placement was authored in space or by SOF
-     * (the Origin enum).
+    /**
+     * Records whether this container's placement was authored in space or by SOF
+     * (the Origin enum).
      */
     SetOrigin(origin) {
       this.origin = Number(origin) | 0;
@@ -163,18 +163,18 @@ new class extends _identity {
       return this.alwaysOn;
     }
 
-    /**
-     * Sets the display-quality filter that IsRendering tests the current shader
-     * model against, which in turn gates every update and render path on this
-     * container.
+    /**
+     * Sets the display-quality filter that IsRendering tests the current shader
+     * model against, which in turn gates every update and render path on this
+     * container.
      */
     SetDisplayQualityModifier(filter) {
       this.displayFilter = Number(filter) | 0;
     }
 
-    /**
-     * Sets the mute flag and, only when it changes, pushes it down to the
-     * contained children and local observers.
+    /**
+     * Sets the mute flag and, only when it changes, pushes it down to the
+     * contained children and local observers.
      */
     SetMute(mute) {
       const next = !!mute;
@@ -184,9 +184,9 @@ new class extends _identity {
       }
     }
 
-    /**
-     * Pushes this container's current mute flag onto every contained child and
-     * local observer - it mutates their state, not the container's.
+    /**
+     * Pushes this container's current mute flag onto every contained child and
+     * local observer - it mutates their state, not the container's.
      */
     MuteChildren() {
       for (const child of this.objects) {
@@ -197,25 +197,25 @@ new class extends _identity {
       }
     }
 
-    /**
-     * Appends a transform modifier; modifiers fold over the container's world
-     * transform in insertion order on each async update.
+    /**
+     * Appends a transform modifier; modifiers fold over the container's world
+     * transform in insertion order on each async update.
      */
     AddTransformModifier(modifier) {
       this.transformModifiers.push(modifier);
     }
 
-    /**
-     * Appends a local audio observer, which is re-placed from the container's
-     * world transform on every sync update.
+    /**
+     * Appends a local audio observer, which is re-placed from the container's
+     * world transform on every sync update.
      */
     AddObserver(observer) {
       this.observers.push(observer);
     }
 
-    /**
-     * Appends a controller, links it to this container, and replays every
-     * controller variable set so far onto it so it starts in sync.
+    /**
+     * Appends a controller, links it to this container, and replays every
+     * controller variable set so far onto it so it starts in sync.
      */
     AddController(controller) {
       this.controllers.push(controller);
@@ -225,10 +225,10 @@ new class extends _identity {
       }
     }
 
-    /**
-     * Records a named float variable, pushes it to every controller on this
-     * container, and recurses into the contained children; the recorded value is
-     * also replayed onto controllers and children added later.
+    /**
+     * Records a named float variable, pushes it to every controller on this
+     * container, and recurses into the contained children; the recorded value is
+     * also replayed onto controllers and children added later.
      */
     SetControllerVariable(name, value) {
       const key = String(name ?? "");
@@ -242,9 +242,9 @@ new class extends _identity {
       }
     }
 
-    /**
-     * Fires a named controller event on every controller here and recurses into
-     * the contained children.
+    /**
+     * Fires a named controller event on every controller here and recurses into
+     * the contained children.
      */
     HandleControllerEvent(name) {
       const eventName = String(name ?? "");
@@ -266,9 +266,9 @@ new class extends _identity {
       }
     }
 
-    /**
-     * Forwards a procedural container variable to the contained children; a plain
-     * container holds none of its own.
+    /**
+     * Forwards a procedural container variable to the contained children; a plain
+     * container holds none of its own.
      */
     SetProceduralContainerVariable(name, value) {
       for (const child of this.objects) {
@@ -276,9 +276,9 @@ new class extends _identity {
       }
     }
 
-    /**
-     * Returns the first direct child whose GetName()/name matches, or null; the
-     * search does not recurse into nested containers.
+    /**
+     * Returns the first direct child whose GetName()/name matches, or null; the
+     * search does not recurse into nested containers.
      */
     GetEffectChildByName(name) {
       const target = String(name ?? "");
@@ -290,9 +290,9 @@ new class extends _identity {
       return null;
     }
 
-    /**
-     * Appends a child and replays every controller variable set so far onto it,
-     * then returns that same child.
+    /**
+     * Appends a child and replays every controller variable set so far onto it,
+     * then returns that same child.
      */
     AddToEffectChildrenList(child) {
       this.objects.push(child);
@@ -314,9 +314,9 @@ new class extends _identity {
       return false;
     }
 
-    /**
-     * Forwards a shader option to every contained child and attachment; the
-     * container compiles nothing itself.
+    /**
+     * Forwards a shader option to every contained child and attachment; the
+     * container compiles nothing itself.
      */
     SetShaderOption(name, value) {
       for (const child of this.objects) {
@@ -328,54 +328,54 @@ new class extends _identity {
       }
     }
 
-    /**
-     * Stores the Granny animation owner supplied by SOF placement; the bone-list
-     * override that would consume it awaits the JS animation seam.
+    /**
+     * Stores the Granny animation owner supplied by SOF placement; the bone-list
+     * override that would consume it awaits the JS animation seam.
      */
     SetAnimationOwner(animationOwner) {
       this.animationOwner = animationOwner ?? null;
     }
 
-    /**
-     * Flags this container as a SOF placement root - authored placement state,
-     * persisted for interchange parity, with no consumer inside the container
-     * itself.
+    /**
+     * Flags this container as a SOF placement root - authored placement state,
+     * persisted for interchange parity, with no consumer inside the container
+     * itself.
      */
     SetIsPlacementRoot(isPlacementRoot) {
       this.isPlacementRoot = !!isPlacementRoot;
     }
 
-    /**
-     * Appends an attachment; attachments are the only thing a container renders
-     * itself (HasRenderables) and the only thing GetBatches submits.
+    /**
+     * Appends an attachment; attachments are the only thing a container renders
+     * itself (HasRenderables) and the only thing GetBatches submits.
      */
     AddAttachment(attachment) {
       this.attachments.push(attachment);
     }
 
-    /**
-     * Drops every attachment, which also stops the container from contributing any
-     * renderable of its own.
+    /**
+     * Drops every attachment, which also stops the container from contributing any
+     * renderable of its own.
      */
     ClearAttachments() {
       this.attachments.length = 0;
     }
 
-    /**
-     * Reports whether the container owns nothing at all - no children, lights,
-     * attachments, controllers, curve sets, transform modifiers or observers.
+    /**
+     * Reports whether the container owns nothing at all - no children, lights,
+     * attachments, controllers, curve sets, transform modifiers or observers.
      */
     Empty() {
       return this.objects.length === 0 && this.lights.length === 0 && this.attachments.length === 0 && this.controllers.length === 0 && this.curveSets.length === 0 && this.transformModifiers.length === 0 && this.observers.length === 0;
     }
 
-    /**
-     * Sync-side frame update (Carbon EveChildContainer::UpdateSyncronous,
-     * cpp:496-518): gate on IsUpdating, remember the owner max speed, then
-     * recurse into the children with childParent params rebased onto this
-     * container's world transform, and refresh the local observers.
-     * @param {Object} updateContext - frame context (EveUpdateContext)
-     * @param {EveChildUpdateParams} params
+    /**
+     * Sync-side frame update (Carbon EveChildContainer::UpdateSyncronous,
+     * cpp:496-518): gate on IsUpdating, remember the owner max speed, then
+     * recurse into the children with childParent params rebased onto this
+     * container's world transform, and refresh the local observers.
+     * @param {Object} updateContext - frame context (EveUpdateContext)
+     * @param {EveChildUpdateParams} params
      */
     UpdateSyncronous(updateContext, params) {
       if (!this.IsUpdating()) {
@@ -394,18 +394,18 @@ new class extends _identity {
       }
     }
 
-    /**
-     * Per-frame async update (Carbon EveChildContainer::UpdateAsyncronous +
-     * DoUpdateAsyncronous, cpp:520-641): rebuild the world transform from the
-     * parent, tick the controllers, fold the transform modifiers, then recurse
-     * into the children with childParent params, update the curve sets and fx
-     * attributes, and refresh light/attachment bone state. Carbon's wrapper
-     * advances the GPU bone ring buffer and may dispatch the body onto the
-     * placement task group (cpp:522-538) - both engine-owned, so the JS port
-     * runs the DoUpdateAsyncronous body inline behind the same IsUpdating gate.
-     * @param {Object} updateContext - frame context (EveUpdateContext), threaded to modifiers
-     * @param {EveChildUpdateParams} params - localToWorldTransform + boneCount/bones
-     * @returns {Float32Array} worldTransform
+    /**
+     * Per-frame async update (Carbon EveChildContainer::UpdateAsyncronous +
+     * DoUpdateAsyncronous, cpp:520-641): rebuild the world transform from the
+     * parent, tick the controllers, fold the transform modifiers, then recurse
+     * into the children with childParent params, update the curve sets and fx
+     * attributes, and refresh light/attachment bone state. Carbon's wrapper
+     * advances the GPU bone ring buffer and may dispatch the body onto the
+     * placement task group (cpp:522-538) - both engine-owned, so the JS port
+     * runs the DoUpdateAsyncronous body inline behind the same IsUpdating gate.
+     * @param {Object} updateContext - frame context (EveUpdateContext), threaded to modifiers
+     * @param {EveChildUpdateParams} params - localToWorldTransform + boneCount/bones
+     * @returns {Float32Array} worldTransform
      */
     UpdateAsyncronous(updateContext, params) {
       if (!this.IsUpdating()) {
@@ -490,15 +490,15 @@ new class extends _identity {
       return this.worldTransform;
     }
 
-    /**
-     * Frame visibility fan-out (Carbon EveChildContainer::UpdateVisibility,
-     * cpp:379-410): gate on display/IsUpdating, recurse into the children with
-     * the unchanged parent transform/LOD, then refresh attachment visibility
-     * against this container's world transform.
-     * @param {Object} updateContext - frame context (frustum ducks)
-     * @param {Float32Array} parentTransform
-     * @param {Number} parentLod - parent Tr2Lod level
-     * @returns {Boolean} whether the fan-out ran
+    /**
+     * Frame visibility fan-out (Carbon EveChildContainer::UpdateVisibility,
+     * cpp:379-410): gate on display/IsUpdating, recurse into the children with
+     * the unchanged parent transform/LOD, then refresh attachment visibility
+     * against this container's world transform.
+     * @param {Object} updateContext - frame context (frustum ducks)
+     * @param {Float32Array} parentTransform
+     * @param {Number} parentLod - parent Tr2Lod level
+     * @returns {Boolean} whether the fan-out ran
      */
     UpdateVisibility(updateContext, parentTransform = null, parentLod = Tr2Lod.TR2_LOD_HIGH) {
       if (!this.display) {
@@ -525,7 +525,7 @@ new class extends _identity {
       return true;
     }
 
-    /** Carbon EveChildContainer::GetRenderables (cpp:412-432): the container
+    /** Carbon EveChildContainer::GetRenderables (cpp:412-432): the container
      * itself renders only when it owns attachments; children always recurse. */
     GetRenderables(out = []) {
       if (!this.display || !this.#hasUpdated) {
@@ -543,10 +543,10 @@ new class extends _identity {
       return out;
     }
 
-    /** Carbon EveChildContainer::GetBoundingSphere (cpp:434-452): the union of
-     * the children's spheres (BoundingSphereSetOrUpdate -> sph3.union). The
-     * child sphere is a per-call local rather than module scratch because
-     * containers nest - a shared scratch would be clobbered between recursion
+    /** Carbon EveChildContainer::GetBoundingSphere (cpp:434-452): the union of
+     * the children's spheres (BoundingSphereSetOrUpdate -> sph3.union). The
+     * child sphere is a per-call local rather than module scratch because
+     * containers nest - a shared scratch would be clobbered between recursion
      * levels; this is a bounds query, not the per-frame update hot path. */
     GetBoundingSphere(out = vec4.create(), _query = 0) {
       if (!this.IsUpdating()) {
@@ -567,7 +567,7 @@ new class extends _identity {
       return success;
     }
 
-    /** Carbon EveChildContainer::GetLocalToWorldTransform (cpp:644-647); the
+    /** Carbon EveChildContainer::GetLocalToWorldTransform (cpp:644-647); the
      * optional out follows the EveChildInstancedMeshes copy-out shape. */
     GetLocalToWorldTransform(out = null) {
       if (out) {
@@ -583,9 +583,9 @@ new class extends _identity {
       }
     }
 
-    /** Carbon EveChildContainer::GetLights (cpp:657-675): each light is added
-     * with the container world transform and the average basis-length scaling
-     * ((|X| + |Y| + |Z|) / 3 of the world basis rows - single-matrix reads, no
+    /** Carbon EveChildContainer::GetLights (cpp:657-675): each light is added
+     * with the container world transform and the average basis-length scaling
+     * ((|X| + |Y| + |Z|) / 3 of the world basis rows - single-matrix reads, no
      * composition). The light manager is duck-typed. */
     GetLights(lightManager) {
       if (!this.display || !this.#hasUpdated) {
@@ -601,9 +601,9 @@ new class extends _identity {
       }
     }
 
-    /** Carbon EveChildContainer::GetBatches (cpp:1134-1143): attachments only,
-     * gated on display, the NORMAL render reason, and a non-zero activation
-     * strength. Returns whether any batch was committed (JS addition; Carbon
+    /** Carbon EveChildContainer::GetBatches (cpp:1134-1143): attachments only,
+     * gated on display, the NORMAL render reason, and a non-zero activation
+     * strength. Returns whether any batch was committed (JS addition; Carbon
      * returns void). */
     GetBatches(batches, batchType, perObjectData, reason = Tr2RenderReason.TR2RENDERREASON_NORMAL) {
       if (!this.display || reason !== Tr2RenderReason.TR2RENDERREASON_NORMAL || this.#activationStrength === 0) {
@@ -627,11 +627,11 @@ new class extends _identity {
       return 0;
     }
 
-    /**
-     * Carbon EveChildContainer::GetPerObjectData (cpp:1180-1203): uploads the
-     * animation owner's bone palette, then hands back a handle over this
-     * container's two PERSISTENT buffers. The ring offsets are GPU addresses with
-     * no CPU derivation and keep their defaults; the bone COUNT is CPU-known.
+    /**
+     * Carbon EveChildContainer::GetPerObjectData (cpp:1180-1203): uploads the
+     * animation owner's bone palette, then hands back a handle over this
+     * container's two PERSISTENT buffers. The ring offsets are GPU addresses with
+     * no CPU derivation and keep their defaults; the bone COUNT is CPU-known.
      */
     GetPerObjectData(_accumulator = null) {
       const updater = this.animationOwner?.animationUpdater ?? this.animationUpdater;
@@ -644,13 +644,13 @@ new class extends _identity {
       };
     }
 
-    /** Carbon EveChildContainer::HasRenderables (cpp:1129-1132): the container
+    /** Carbon EveChildContainer::HasRenderables (cpp:1129-1132): the container
      * renders only for its attachments. */
     HasRenderables() {
       return this.attachments.length > 0;
     }
 
-    /** Carbon EveChildContainer::IsRendering (cpp:334-362): whether the current
+    /** Carbon EveChildContainer::IsRendering (cpp:334-362): whether the current
      * shader model passes this container's display filter. */
     IsRendering() {
       const settings = _EveChildContainer.shaderModel;
@@ -682,8 +682,8 @@ new class extends _identity {
       return (this.display || !this.updateOnDisplay) && (this.IsRendering() || this.displayFilter === _EveChildContainer.DisplayQualityModifier.ONLY_REFLECTIONS);
     }
 
-    /** Carbon EveChildContainer::RegisterComponents (cpp:258-284): LightOwner
-     * when lights are authored, then forwards the contained objects and the
+    /** Carbon EveChildContainer::RegisterComponents (cpp:258-284): LightOwner
+     * when lights are authored, then forwards the contained objects and the
      * attachments. Gate m_display && IsUpdating(). */
     RegisterComponents() {
       const registry = this.GetComponentRegistry();
@@ -700,9 +700,9 @@ new class extends _identity {
       }
     }
 
-    /** Carbon EveChildContainer::UnRegisterComponents (cpp:290-311): forwards
-     * the contained objects and attachments only (own components were already
-     * removed by EveEntity::UnRegister, EveEntity.cpp:90); no display/IsUpdating
+    /** Carbon EveChildContainer::UnRegisterComponents (cpp:290-311): forwards
+     * the contained objects and attachments only (own components were already
+     * removed by EveEntity::UnRegister, EveEntity.cpp:90); no display/IsUpdating
      * re-check. */
     UnRegisterComponents() {
       const registry = this.GetComponentRegistry();
@@ -716,7 +716,7 @@ new class extends _identity {
       }
     }
 
-    /** Carbon EveChildContainer::PlayCurveSet (cpp:682-712): named own sets play
+    /** Carbon EveChildContainer::PlayCurveSet (cpp:682-712): named own sets play
      * (or play a named range); children recurse via the curve-set-owner duck. */
     PlayCurveSet(name, rangeName = "") {
       if (!this.IsUpdating()) {
@@ -755,7 +755,7 @@ new class extends _identity {
       }
     }
 
-    /** Carbon EveChildContainer::UpdateCurveSet (cpp:770-786): samples matching
+    /** Carbon EveChildContainer::UpdateCurveSet (cpp:770-786): samples matching
      * own and child sets at an explicit time (both clocks, as Carbon does). */
     UpdateCurveSet(name, time, renderContext = null) {
       const target = String(name ?? "");
@@ -769,7 +769,7 @@ new class extends _identity {
       }
     }
 
-    /** Carbon EveChildContainer::PlayAllCurveSets (cpp:714-728): children
+    /** Carbon EveChildContainer::PlayAllCurveSets (cpp:714-728): children
      * first, then every own set. */
     PlayAllCurveSets() {
       for (const child of this.objects) {
@@ -790,7 +790,7 @@ new class extends _identity {
       }
     }
 
-    /** Carbon EveChildContainer::GetCurveSetDuration (cpp:788-813): maximum
+    /** Carbon EveChildContainer::GetCurveSetDuration (cpp:788-813): maximum
      * GetMaxCurveDuration over matching own and child sets. */
     GetCurveSetDuration(name) {
       if (!this.IsUpdating()) {
@@ -809,7 +809,7 @@ new class extends _identity {
       return duration;
     }
 
-    /** Carbon EveChildContainer::GetRangeDuration (cpp:815-840): maximum named
+    /** Carbon EveChildContainer::GetRangeDuration (cpp:815-840): maximum named
      * range duration over matching own and child sets. */
     GetRangeDuration(name, rangeName) {
       if (!this.IsUpdating()) {
@@ -828,8 +828,8 @@ new class extends _identity {
       return duration;
     }
 
-    /** Carbon EveChildContainer::GetControllerValueByName (cpp:1083-1098):
-     * Carbon returns bool with a float& out; the JS port returns the value or
+    /** Carbon EveChildContainer::GetControllerValueByName (cpp:1083-1098):
+     * Carbon returns bool with a float& out; the JS port returns the value or
      * null when no controller exposes the named float variable. */
     GetControllerValueByName(name) {
       const key = String(name ?? "");
@@ -881,8 +881,8 @@ new class extends _identity {
       for (const child of this.objects) child.CollectOwnedGeometry(type, childToObject, out, areaPool);
     }
 
-    /** Carbon EveChildContainer::SetInheritProperties (cpp:1017-1040): lazily
-     * creates the property holder, then fans the color set out to children and
+    /** Carbon EveChildContainer::SetInheritProperties (cpp:1017-1040): lazily
+     * creates the property holder, then fans the color set out to children and
      * lights. */
     SetInheritProperties(colorSet) {
       if (!this.inheritProperties) {
@@ -897,7 +897,7 @@ new class extends _identity {
       }
     }
 
-    /** Carbon EveChildContainer::FindSoundEmitter (cpp:1042-1066): named local
+    /** Carbon EveChildContainer::FindSoundEmitter (cpp:1042-1066): named local
      * observers first, then duck-typed recursion into the children. */
     FindSoundEmitter(name) {
       const target = String(name ?? "");
@@ -920,10 +920,10 @@ new class extends _identity {
     // EveSpaceObject2's child fan-out - container recursion makes a module
     // scratch record unsafe.
 
-    /**
-     * Copies the caller's update params into a fresh child-facing record (Carbon
-     * passes EveChildUpdateParams by value, cpp:505/592); allocated per call
-     * because container recursion makes a shared module scratch record unsafe.
+    /**
+     * Copies the caller's update params into a fresh child-facing record (Carbon
+     * passes EveChildUpdateParams by value, cpp:505/592); allocated per call
+     * because container recursion makes a shared module scratch record unsafe.
      */
 
     // Carbon reads Tr2Renderer::GetShaderModel() (a renderer global); the