@woosh/meep-engine 3.52.0 → 3.53.0

package/src/engine/graphics3/prefab/Prefab.js

@@ -1,162 +1,169 @@
-/**
- * @typedef {import("../../../shade/renderer/geometry/MeshletGeometry.js").MeshletGeometry} MeshletGeometry
- * @typedef {import("../../../shade/renderer/material/ShadeMaterial.js").ShadeMaterial} ShadeMaterial
- * @typedef {import("../../../shade/renderer/animation/Skin.js").Skin} Skin
- * @typedef {import("../../../shade/renderer/animation/ShadeAnimationClip.js").ShadeAnimationClip} ShadeAnimationClip
- * @typedef {import("../../ecs/transform/Transform64.js").Transform64} Transform64
- */
-
-/**
- * One draw of a prefab: a node that carries geometry, and the skin that deforms it if any.
- */
-export class PrefabPrimitive {
-    /**
-     * Index of the node this primitive draws at.
-     *
-     * @type {number}
-     */
-    node = 0;
-
-    /**
-     * @type {MeshletGeometry}
-     */
-    geometry = null;
-
-    /**
-     * @type {ShadeMaterial}
-     */
-    material = null;
-
-    /**
-     * Index into {@link Prefab.skins} of the skin this primitive deforms against, or -1 for a
-     * rigid primitive.
-     *
-     * @type {number}
-     */
-    skin = -1;
-}
-
-/**
- * A model compiled once, to be spawned as entities any number of times.
- *
- * **Everything in here is addressed by node index**, and a node index is what an instance turns
- * into an entity. Parents precede children, so one forward pass composes every world transform
- * and one forward pass spawns every entity with its parent already there. Node 0 is the root:
- * the entity that places the model, which the prefab does not spawn and whose transform is the
- * placement. It carries no name and no geometry of its own.
- *
- * Skins name their joints and their meshes by node index; clips target node indices. Geometry,
- * materials, inverse-bind matrices and animation curves are shared by every instance — none of
- * them is per-placement state — which is what makes a prefab cheap to instantiate and what a
- * per-instance copy of a node tree could never be.
- *
- * Built by `prefab_compile`, from what a loader produced. Read-only afterwards.
- */
-export class Prefab {
-    /**
-     * @type {number}
-     */
-    node_count = 0;
-
-    /**
-     * Parent node of each node; -1 for the root, and every parent's index is below its child's.
-     *
-     * @type {Int32Array}
-     */
-    parent = new Int32Array(0);
-
-    /**
-     * The name the asset gave each node, or an empty string.
-     *
-     * @type {string[]}
-     */
-    name = [];
-
-    /**
-     * Each node's rest pose, relative to its parent. A skinned mesh node's is the frame its skin
-     * deforms in, not what the file said — see `prefab_normalize_skin_frames`.
-     *
-     * @type {Transform64[]}
-     */
-    local = [];
-
-    /**
-     * Each node's rest pose relative to the root, as a column-major 4×4, composed from
-     * {@link local}. The root's is the identity.
-     *
-     * @type {Float64Array[]}
-     */
-    world = [];
-
-    /**
-     * Whether a node is one the GPU may take over: a joint of a skin, the target of a clip, or
-     * anything under either — the GPU composes a driven joint's whole subtree. These are the nodes
-     * an instance declares `GPUStateAuthority` on, so that a later grant is a bit write rather
-     * than a component add.
-     *
-     * @type {Uint8Array}
-     */
-    animated = new Uint8Array(0);
-
-    /**
-     * @type {PrefabPrimitive[]}
-     */
-    primitives = [];
-
-    /**
-     * Skins with `joints` and `meshes` as node indices.
-     *
-     * @type {Skin[]}
-     */
-    skins = [];
-
-    /**
-     * Clips whose channels target node indices.
-     *
-     * @type {ShadeAnimationClip[]}
-     */
-    clips = [];
-
-    /**
-     * @type {Map<string, number>}
-     */
-    #index_by_name = new Map();
-
-    /**
-     * Which node the asset calls `name`. A name authored twice answers with the first node in
-     * pre-order, which is the same answer a search would have given.
-     *
-     * @param {string} name
-     * @returns {number} the node index, or -1
-     */
-    index_of(name) {
-        const index = this.#index_by_name.get(name);
-
-        return index === undefined ? -1 : index;
-    }
-
-    /**
-     * Build {@link index_of}'s table from {@link name}. For `prefab_compile`.
-     */
-    index_names() {
-        const by_name = this.#index_by_name;
-
-        by_name.clear();
-
-        const names = this.name;
-
-        for (let i = 0; i < names.length; i++) {
-            const name = names[i];
-
-            if (name !== "" && !by_name.has(name)) {
-                by_name.set(name, i);
-            }
-        }
-    }
-}
-
-/**
- * @readonly
- * @type {boolean}
- */
-Prefab.prototype.isPrefab = true;
+/**
+ * @typedef {import("../../../shade/renderer/geometry/MeshletGeometry.js").MeshletGeometry} MeshletGeometry
+ * @typedef {import("../../../shade/renderer/material/ShadeMaterial.js").ShadeMaterial} ShadeMaterial
+ * @typedef {import("../../../shade/renderer/animation/Skin.js").Skin} Skin
+ * @typedef {import("../../../shade/renderer/animation/ShadeAnimationClip.js").ShadeAnimationClip} ShadeAnimationClip
+ * @typedef {import("../../ecs/transform/Transform64.js").Transform64} Transform64
+ */
+
+/**
+ * One draw of a prefab: a node that carries geometry, and the skin that deforms it if any.
+ */
+export class PrefabPrimitive {
+    /**
+     * Index of the node this primitive draws at.
+     *
+     * @type {number}
+     */
+    node = 0;
+
+    /**
+     * @type {MeshletGeometry}
+     */
+    geometry = null;
+
+    /**
+     * @type {ShadeMaterial}
+     */
+    material = null;
+
+    /**
+     * Index into {@link Prefab.skins} of the skin this primitive deforms against, or -1 for a
+     * rigid primitive.
+     *
+     * @type {number}
+     */
+    skin = -1;
+}
+
+/**
+ * A model compiled once, to be spawned as entities any number of times.
+ *
+ * **Everything in here is addressed by node index**, and a node index is what an instance turns
+ * into an entity. Parents precede children, so one forward pass composes every world transform
+ * and one forward pass spawns every entity with its parent already there. Node 0 is the root:
+ * the entity that places the model, which the prefab does not spawn and whose transform is the
+ * placement. It carries no name and no geometry of its own.
+ *
+ * Skins name their joints and their meshes by node index; clips target node indices. Geometry,
+ * materials, inverse-bind matrices and animation curves are shared by every instance — none of
+ * them is per-placement state — which is what makes a prefab cheap to instantiate and what a
+ * per-instance copy of a node tree could never be.
+ *
+ * Built by `prefab_compile`, from what a loader produced. Read-only afterwards.
+ */
+export class Prefab {
+    /**
+     * @type {number}
+     */
+    node_count = 0;
+
+    /**
+     * Parent node of each node; -1 for the root, and every parent's index is below its child's.
+     *
+     * @type {Int32Array}
+     */
+    parent = new Int32Array(0);
+
+    /**
+     * The name the asset gave each node, or an empty string.
+     *
+     * @type {string[]}
+     */
+    name = [];
+
+    /**
+     * Each node's rest pose, relative to its parent. A skinned mesh node's is the frame its skin
+     * deforms in, not what the file said — see `prefab_normalize_skin_frames`.
+     *
+     * @type {Transform64[]}
+     */
+    local = [];
+
+    /**
+     * Each node's rest pose relative to the root, as a column-major 4×4, composed from
+     * {@link local}. The root's is the identity.
+     *
+     * @type {Float64Array[]}
+     */
+    world = [];
+
+    /**
+     * Whether a node is one the GPU may take over: a joint of a skin, the target of a clip, or
+     * anything under either — the GPU composes a driven joint's whole subtree. These are the nodes
+     * an instance declares `GPUStateAuthority` on, so that a later grant is a bit write rather
+     * than a component add.
+     *
+     * @type {Uint8Array}
+     */
+    animated = new Uint8Array(0);
+
+    /**
+     * @type {PrefabPrimitive[]}
+     */
+    primitives = [];
+
+    /**
+     * Skins with `joints` and `meshes` as node indices.
+     *
+     * @type {Skin[]}
+     */
+    skins = [];
+
+    /**
+     * Clips whose channels target node indices.
+     *
+     * @type {ShadeAnimationClip[]}
+     */
+    clips = [];
+
+    /**
+     * Aeroelastic foliage wind rigs whose `root` and joint `target`s address prefab node indices.
+     *
+     * @type {import("../../../shade/renderer/animation/foliage/FoliageWindRig.js").FoliageWindRig[]}
+     */
+    foliage_rigs = [];
+
+    /**
+     * @type {Map<string, number>}
+     */
+    #index_by_name = new Map();
+
+    /**
+     * Which node the asset calls `name`. A name authored twice answers with the first node in
+     * pre-order, which is the same answer a search would have given.
+     *
+     * @param {string} name
+     * @returns {number} the node index, or -1
+     */
+    index_of(name) {
+        const index = this.#index_by_name.get(name);
+
+        return index === undefined ? -1 : index;
+    }
+
+    /**
+     * Build {@link index_of}'s table from {@link name}. For `prefab_compile`.
+     */
+    index_names() {
+        const by_name = this.#index_by_name;
+
+        by_name.clear();
+
+        const names = this.name;
+
+        for (let i = 0; i < names.length; i++) {
+            const name = names[i];
+
+            if (name !== "" && !by_name.has(name)) {
+                by_name.set(name, i);
+            }
+        }
+    }
+}
+
+/**
+ * @readonly
+ * @type {boolean}
+ */
+Prefab.prototype.isPrefab = true;

package/src/engine/graphics3/prefab/prefab_compile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prefab_compile.d.ts","sourceRoot":"","sources":["../../../../../src/engine/graphics3/prefab/prefab_compile.js"],"names":[],"mappings":"AA6CA;;;;;;;;;;;;;;;;;GAiBG;AACH,uCAHW,WAAW,GACT,MAAM,CA0KlB;0BA5NY,OAAO,+CAA+C,EAAE,WAAW;wBACnE,OAAO,6CAA6C,EAAE,SAAS;uBANpC,aAAa"}
+{"version":3,"file":"prefab_compile.d.ts","sourceRoot":"","sources":["../../../../../src/engine/graphics3/prefab/prefab_compile.js"],"names":[],"mappings":"AA+CA;;;;;;;;;;;;;;;;;GAiBG;AACH,uCAHW,WAAW,GACT,MAAM,CA2MlB;0BA7PY,OAAO,+CAA+C,EAAE,WAAW;wBACnE,OAAO,6CAA6C,EAAE,SAAS;uBANpC,aAAa"}