@carbonenginejs/runtime 0.1.0-alpha.6 → 0.1.0-alpha.7

package/dist/sof/EveSOFDataMgr.js

@@ -4,15 +4,29 @@ import { CjsModel } from '#model';
 import { carbon, impl, type, CjsSchema } from '#schema';
 import { mat4 } from '#math/mat4';
 import { vec3 } from '#math/vec3';
+import { EveSOFDataFactionColorSet as _EveSOFDataFactionCol } from './faction/EveSOFDataFactionColorSet.js';
 
 let _initProto, _initClass;
+
+// CARBON'S DEFAULTS FOR ABSENT COLOUR TYPES. A .black record stores only the
+// fields that differ from the class default, so a missing colour type means
+// the constructor's value, never 0 (Primary): EveSOFDataAreaMaterial's glow
+// is Hull (EveSOFData.cpp:32), EveSOFDataRace's heat glows Booster and
+// Reactor (EveSOFData.cpp:356-357). Falling back to 0 gave every hull area
+// the faction's Primary colour as its glow - an ordinary colour where an HDR
+// glow belongs, about ten times too dark.
+const {
+  TYPE_HULL,
+  TYPE_BOOSTER,
+  TYPE_REACTOR
+} = _EveSOFDataFactionCol.ColorType;
 const LOGO_KEYS = Object.freeze(["Primary", "Secondary", "Tertiary", "Marking_01", "Marking_02"]);
 
-/**
- * Owns the CPU-side SOF lookup tables consumed by EveSOFDNA and EveSOF.
- *
- * Carbon declares its many projection records as nested C++ structs. They are
- * plain JavaScript records here; they are not persisted fields on the manager.
+/**
+ * Owns the CPU-side SOF lookup tables consumed by EveSOFDNA and EveSOF.
+ *
+ * Carbon declares its many projection records as nested C++ structs. They are
+ * plain JavaScript records here; they are not persisted fields on the manager.
  */
 let _EveSOFDataMgr;
 new class extends _identity {
@@ -93,9 +107,9 @@ new class extends _identity {
       return this.#hullData.has(String(name));
     }
 
-    /**
-     * Returns the normalized hull projection for an exact key, or null when
-     * absent.
+    /**
+     * Returns the normalized hull projection for an exact key, or null when
+     * absent.
      */
     GetHullData(name) {
       return this.#hullData.get(String(name)) ?? null;
@@ -106,9 +120,9 @@ new class extends _identity {
       return this.#factionData.has(String(name));
     }
 
-    /**
-     * Returns the normalized faction projection for an exact key, or null when
-     * absent.
+    /**
+     * Returns the normalized faction projection for an exact key, or null when
+     * absent.
      */
     GetFactionData(name) {
       return this.#factionData.get(String(name)) ?? null;
@@ -119,9 +133,9 @@ new class extends _identity {
       return this.#raceData.has(String(name));
     }
 
-    /**
-     * Returns the normalized race projection for an exact key, or null when
-     * absent.
+    /**
+     * Returns the normalized race projection for an exact key, or null when
+     * absent.
      */
     GetRaceData(name) {
       return this.#raceData.get(String(name)) ?? null;
@@ -132,9 +146,9 @@ new class extends _identity {
       return this.#materialData.has(String(name));
     }
 
-    /**
-     * Returns the normalized material projection for an exact key, or null when
-     * absent.
+    /**
+     * Returns the normalized material projection for an exact key, or null when
+     * absent.
      */
     GetMaterialData(name) {
       return this.#materialData.get(String(name)) ?? null;
@@ -145,9 +159,9 @@ new class extends _identity {
       return this.#patternData.has(String(name));
     }
 
-    /**
-     * Returns the normalized pattern projection for an exact key, or null when
-     * absent.
+    /**
+     * Returns the normalized pattern projection for an exact key, or null when
+     * absent.
      */
     GetPatternData(name) {
       return this.#patternData.get(String(name)) ?? null;
@@ -171,9 +185,9 @@ new class extends _identity {
       return this.#layoutData.get(String(nameOrNames)) ?? null;
     }
 
-    /**
-     * Exposes the current normalized generic projection used by DNA and SOF
-     * assembly.
+    /**
+     * Exposes the current normalized generic projection used by DNA and SOF
+     * assembly.
      */
     GetGenericData() {
       return this.#genericData;
@@ -259,59 +273,59 @@ new class extends _identity {
       return application ? projectJsonValue(application) : null;
     }
 
-    /**
-     * Normalizes a supplied hull graph and stores its projection under the
-     * requested key.
+    /**
+     * Normalizes a supplied hull graph and stores its projection under the
+     * requested key.
      */
     UpdateHull(name, value) {
       return updateNamed(this.#hullData, name, value, projectHull);
     }
 
-    /**
-     * Normalizes a supplied faction graph and stores its projection under the
-     * requested key.
+    /**
+     * Normalizes a supplied faction graph and stores its projection under the
+     * requested key.
      */
     UpdateFaction(name, value) {
       return updateNamed(this.#factionData, name, value, projectFaction);
     }
 
-    /**
-     * Normalizes a supplied race graph and stores its projection under the
-     * requested key.
+    /**
+     * Normalizes a supplied race graph and stores its projection under the
+     * requested key.
      */
     UpdateRace(name, value) {
       return updateNamed(this.#raceData, name, value, projectRace);
     }
 
-    /**
-     * Normalizes a supplied material graph and stores its projection under the
-     * requested key.
+    /**
+     * Normalizes a supplied material graph and stores its projection under the
+     * requested key.
      */
     UpdateMaterial(name, value) {
       return updateNamed(this.#materialData, name, value, projectMaterial);
     }
 
-    /**
-     * Rejects a missing value, otherwise normalizes and replaces the keyed pattern
-     * projection.
+    /**
+     * Rejects a missing value, otherwise normalizes and replaces the keyed pattern
+     * projection.
      */
     UpdatePattern(name, value) {
       if (!value) return false;
       return updateNamed(this.#patternData, name, value, projectPattern);
     }
 
-    /**
-     * Rejects a missing value, otherwise normalizes and replaces the keyed layout
-     * projection.
+    /**
+     * Rejects a missing value, otherwise normalizes and replaces the keyed layout
+     * projection.
      */
     UpdateLayout(name, value) {
       if (!value) return false;
       return updateNamed(this.#layoutData, name, value, projectLayout);
     }
 
-    /**
-     * Rejects a missing value, otherwise replaces the manager's normalized generic
-     * projection.
+    /**
+     * Rejects a missing value, otherwise replaces the manager's normalized generic
+     * projection.
      */
     UpdateGeneric(value) {
       if (!value) return false;
@@ -320,9 +334,9 @@ new class extends _identity {
       return true;
     }
 
-    /**
-     * Empties every named projection table and restores an empty normalized
-     * generic record.
+    /**
+     * Empties every named projection table and restores an empty normalized
+     * generic record.
      */
     #clear() {
       this.#hullData.clear();
@@ -1025,8 +1039,8 @@ function projectFaction(value) {
 }
 function projectRace(value) {
   const areaMaterials = createAreaMaterialData();
-  areaMaterials.glowColor.set("0:GeneralHeatGlowColor", Number(value.hullPrimaryHeatColorType ?? 0));
-  areaMaterials.glowColor.set("3:GeneralHeatGlowColor", Number(value.hullReactorHeatColorType ?? 0));
+  areaMaterials.glowColor.set("0:GeneralHeatGlowColor", Number(value.hullPrimaryHeatColorType ?? TYPE_BOOSTER));
+  areaMaterials.glowColor.set("3:GeneralHeatGlowColor", Number(value.hullReactorHeatColorType ?? TYPE_REACTOR));
   return {
     ...value,
     areaMaterials,
@@ -1533,13 +1547,13 @@ function selectAreaMaterial(areaTypes, key) {
   return selectNamedSlot(areaTypes, key, "materials");
 }
 
-/**
- * Carbon's generated records declare one property per slot (EveSOFDataArea's
- * AreaType properties, EveSOFDataFactionColorSet's ColorType properties), but
- * the decoded data.black record carries those slots as a lowercase-keyed child
- * map instead. Both shapes reach these projections, and reading only the
- * declared property names silently produced empty area materials and
- * all-black faction colors.
+/**
+ * Carbon's generated records declare one property per slot (EveSOFDataArea's
+ * AreaType properties, EveSOFDataFactionColorSet's ColorType properties), but
+ * the decoded data.black record carries those slots as a lowercase-keyed child
+ * map instead. Both shapes reach these projections, and reading only the
+ * declared property names silently produced empty area materials and
+ * all-black faction colors.
  */
 function selectNamedSlot(container, key, mapName) {
   if (!container) return null;
@@ -1572,14 +1586,14 @@ function mergeAreaMaterial(result, value, areaType) {
   [areaMaterialName(value.material1, "material1"), areaMaterialName(value.material2, "material2"), areaMaterialName(value.material3, "material3"), areaMaterialName(value.material4, "material4")].forEach((name, materialIndex) => {
     if (name) result.materialNames.set(`${areaType}:${materialIndex}`, name);
   });
-  result.glowColor.set(`${areaType}:GeneralGlowColor`, Number(value.colorType ?? 0));
+  result.glowColor.set(`${areaType}:GeneralGlowColor`, Number(value.colorType ?? TYPE_HULL));
 }
 
-/**
- * Carbon's m_material[N] is a plain string, but the decoded data.black record
- * wraps each slot in its own single-key object ({ material1: "name" }).
- * Stringifying that wrapper produced "[object Object]" material names, so no
- * material record was ever found.
+/**
+ * Carbon's m_material[N] is a plain string, but the decoded data.black record
+ * wraps each slot in its own single-key object ({ material1: "name" }).
+ * Stringifying that wrapper produced "[object Object]" material names, so no
+ * material record was ever found.
  */
 function areaMaterialName(value, key) {
   if (!value) return "";
@@ -1593,13 +1607,13 @@ function copyVector(value) {
   return value ? Array.from(value) : [0, 0, 0, 0];
 }
 
-/**
- * Flattens one authored parameter record to a shader vec4 the way Carbon's
- * virtual EveSOFDataParameter::GetValue does (EveSOFData.cpp:85-102): typed
- * records answer through GetValue when they are live class instances, and
- * plain data flattens by value shape - booleans and numbers broadcast to all
- * four components, two-component values zero-pad z and w, three-component
- * values zero-pad w (0, not 1), four-component values copy through.
+/**
+ * Flattens one authored parameter record to a shader vec4 the way Carbon's
+ * virtual EveSOFDataParameter::GetValue does (EveSOFData.cpp:85-102): typed
+ * records answer through GetValue when they are live class instances, and
+ * plain data flattens by value shape - booleans and numbers broadcast to all
+ * four components, two-component values zero-pad z and w, three-component
+ * values zero-pad w (0, not 1), four-component values copy through.
  */
 function flattenParameterValue(parameter) {
   if (typeof parameter?.GetValue === "function") return Array.from(parameter.GetValue());