@woosh/meep-engine 3.11.2 → 3.12.0

package/src/engine/graphics3/pose/query_entity_node_world_pose.js

@@ -1,101 +1,101 @@
-import { assert } from "../../../core/assert.js";
-import { PosePlayback } from "../../../shade/renderer/animation/pose/PosePlayback.js";
-import { pose_evaluate_world } from "../../../shade/renderer/animation/pose/pose_evaluate_world.js";
-import { AnimationGraphSystem3 } from "../AnimationGraphSystem3.js";
-import { AnimationSystem3 } from "../AnimationSystem3.js";
-import { MeshSystem3 } from "../MeshSystem3.js";
-
-/**
- * The clip set handed to the evaluator, rebuilt per call from the systems' own entries. Nothing in
- * here outlives the call — the query is on a per-frame path and allocates nothing.
- *
- * @type {PosePlayback[]}
- */
-const PLAYBACKS = [];
-
-/**
- * Where a named part of an entity's model is, in world space.
- *
- * This is the question gameplay asks of an animated model and the only sanctioned way to ask it:
- * where does this projectile leave from, where does that effect anchor, where does the floating UI
- * hang. **The answer is computed, never read back** — GPU readback is a frame late and asynchronous,
- * so an outcome that depended on it would depend on frame pacing, and determinism and replay would
- * go with it (`EXECUTION.md` I-4).
- *
- * The pose is {@link pose_evaluate_world} over the clips the animation systems are driving: a pure
- * function of (clip set, time, weights), off the same clock the renderer is written from, which is
- * what keeps a socket on the mesh that is drawn.
- *
- * The result carries both its matrix and its components.
- *
- * @param {Transform64} result
- * @param {EntityManager} entity_manager
- * @param {number} entity
- * @param {string} node_name name the asset gave the node — a bone, a socket's bone, an effector
- * @returns {boolean} `false` when there is no such node to answer about: no mesh system is
- * registered, the model has not loaded yet, the entity has none, or the name is not in it. None of
- * the four is an error
- */
-export function query_entity_node_world_pose(result, entity_manager, entity, node_name) {
-    assert.defined(result, 'result');
-    assert.defined(entity_manager, 'entity_manager');
-    assert.isNonNegativeInteger(entity, 'entity');
-    assert.isString(node_name, 'node_name');
-
-    const meshes = entity_manager.getSystem(MeshSystem3);
-
-    if (meshes === null) {
-        // nothing draws models here, so nothing holds one to answer about
-        return false;
-    }
-
-    const instance = meshes.instance_of(entity);
-
-    if (instance === null) {
-        return false;
-    }
-
-    const node = instance.nodes.get(node_name);
-
-    if (node === undefined) {
-        return false;
-    }
-
-    const playbacks = PLAYBACKS;
-
-    playbacks.length = 0;
-
-    write_playbacks(playbacks, entity_manager, entity);
-
-    pose_evaluate_world(result, node, playbacks);
-
-    playbacks.length = 0;
-
-    return true;
-}
-
-/**
- * Collect what every animation driver is playing on the entity.
- *
- * Both are asked because either may be the one driving it — a combat unit runs a state machine, a
- * building runs a clip list — and an entity has one of them, so the two sets do not overlap in
- * practice. What they hand back is one entry per clip of the model, silent clips included, because
- * that is what the GPU's accumulator is summing.
- *
- * @param {PosePlayback[]} target
- * @param {EntityManager} entity_manager
- * @param {number} entity
- */
-function write_playbacks(target, entity_manager, entity) {
-    const graphs = entity_manager.getSystem(AnimationGraphSystem3);
-
-    if (graphs !== null) {
-        graphs.write_pose_playbacks(target, entity);
-    }
-
-    const clips = entity_manager.getSystem(AnimationSystem3);
-
-    if (clips !== null) {
-        clips.write_pose_playbacks(target, entity);
-    }
-}
+import { assert } from "../../../core/assert.js";
+import { PosePlayback } from "../../../shade/renderer/animation/pose/PosePlayback.js";
+import { pose_evaluate_world } from "../../../shade/renderer/animation/pose/pose_evaluate_world.js";
+import { AnimationGraphSystem } from "../AnimationGraphSystem.js";
+import { AnimationSystem } from "../AnimationSystem.js";
+import { MeshSystem } from "../MeshSystem.js";
+
+/**
+ * The clip set handed to the evaluator, rebuilt per call from the systems' own entries. Nothing in
+ * here outlives the call — the query is on a per-frame path and allocates nothing.
+ *
+ * @type {PosePlayback[]}
+ */
+const PLAYBACKS = [];
+
+/**
+ * Where a named part of an entity's model is, in world space.
+ *
+ * This is the question gameplay asks of an animated model and the only sanctioned way to ask it:
+ * where does this projectile leave from, where does that effect anchor, where does the floating UI
+ * hang. **The answer is computed, never read back** — GPU readback is a frame late and asynchronous,
+ * so an outcome that depended on it would depend on frame pacing, and determinism and replay would
+ * go with it: no GPU readback on a gameplay-affecting path.
+ *
+ * The pose is {@link pose_evaluate_world} over the clips the animation systems are driving: a pure
+ * function of (clip set, time, weights), off the same clock the renderer is written from, which is
+ * what keeps a socket on the mesh that is drawn.
+ *
+ * The result carries both its matrix and its components.
+ *
+ * @param {Transform64} result
+ * @param {EntityManager} entity_manager
+ * @param {number} entity
+ * @param {string} node_name name the asset gave the node — a bone, a socket's bone, an effector
+ * @returns {boolean} `false` when there is no such node to answer about: no mesh system is
+ * registered, the model has not loaded yet, the entity has none, or the name is not in it. None of
+ * the four is an error
+ */
+export function query_entity_node_world_pose(result, entity_manager, entity, node_name) {
+    assert.defined(result, 'result');
+    assert.defined(entity_manager, 'entity_manager');
+    assert.isNonNegativeInteger(entity, 'entity');
+    assert.isString(node_name, 'node_name');
+
+    const meshes = entity_manager.getSystem(MeshSystem);
+
+    if (meshes === null) {
+        // nothing draws models here, so nothing holds one to answer about
+        return false;
+    }
+
+    const instance = meshes.instance_of(entity);
+
+    if (instance === null) {
+        return false;
+    }
+
+    const node = instance.nodes.get(node_name);
+
+    if (node === undefined) {
+        return false;
+    }
+
+    const playbacks = PLAYBACKS;
+
+    playbacks.length = 0;
+
+    write_playbacks(playbacks, entity_manager, entity);
+
+    pose_evaluate_world(result, node, playbacks);
+
+    playbacks.length = 0;
+
+    return true;
+}
+
+/**
+ * Collect what every animation driver is playing on the entity.
+ *
+ * Both are asked because either may be the one driving it — a combat unit runs a state machine, a
+ * building runs a clip list — and an entity has one of them, so the two sets do not overlap in
+ * practice. What they hand back is one entry per clip of the model, silent clips included, because
+ * that is what the GPU's accumulator is summing.
+ *
+ * @param {PosePlayback[]} target
+ * @param {EntityManager} entity_manager
+ * @param {number} entity
+ */
+function write_playbacks(target, entity_manager, entity) {
+    const graphs = entity_manager.getSystem(AnimationGraphSystem);
+
+    if (graphs !== null) {
+        graphs.write_pose_playbacks(target, entity);
+    }
+
+    const clips = entity_manager.getSystem(AnimationSystem);
+
+    if (clips !== null) {
+        clips.write_pose_playbacks(target, entity);
+    }
+}

package/src/engine/graphics3/preview/make_model_thumbnail.d.ts

@@ -3,19 +3,19 @@
  *
  * The four steps are each somebody's: where the model is (`shade_bundle_bounds`), how to frame it
  * (`model_preview_framing`), what a scene of one model looks like (`make_model_preview_scene`), and
- * how a frame becomes pixels (`GraphicsEngine3.render_to_sampler`). This is only the order.
+ * how a frame becomes pixels (`GraphicsEngine.render_to_sampler`). This is only the order.
  *
  * **A model with nothing to draw has no picture, and that is data rather than a fault**: a glTF of
  * empties, or one whose every mesh is skinned — a preview scene registers no skin, so a skinned
  * mesh is not in it. The answer then is `null`, and a caller showing icons shows none for that
  * asset rather than a blank square that reads as a broken renderer.
  *
- * @param {GraphicsEngine3} graphics
+ * @param {GraphicsEngine} graphics
  * @param {SceneBundle} bundle
  * @param {number} width texels
  * @param {number} height texels
  * @param {number} [margin] fraction of the frame's height left clear around the model
  * @returns {Promise<Sampler2D|null>}
  */
-export function make_model_thumbnail(graphics: GraphicsEngine3, bundle: SceneBundle, width: number, height: number, margin?: number): Promise<Sampler2D | null>;
+export function make_model_thumbnail(graphics: GraphicsEngine, bundle: SceneBundle, width: number, height: number, margin?: number): Promise<Sampler2D | null>;
 //# sourceMappingURL=make_model_thumbnail.d.ts.map

package/src/engine/graphics3/preview/make_model_thumbnail.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"make_model_thumbnail.d.ts","sourceRoot":"","sources":["../../../../../src/engine/graphics3/preview/make_model_thumbnail.js"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;GAkBG;AACH,4FALW,MAAM,UACN,MAAM,WACN,MAAM,GACJ,QAAQ,YAAU,IAAI,CAAC,CAuBnC"}
+{"version":3,"file":"make_model_thumbnail.d.ts","sourceRoot":"","sources":["../../../../../src/engine/graphics3/preview/make_model_thumbnail.js"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;GAkBG;AACH,2FALW,MAAM,UACN,MAAM,WACN,MAAM,GACJ,QAAQ,YAAU,IAAI,CAAC,CAuBnC"}

package/src/engine/graphics3/preview/make_model_thumbnail.js

@@ -1,48 +1,48 @@
-import { assert } from "../../../core/assert.js";
-import { AABB3 } from "../../../core/geom/3d/aabb/AABB3.js";
-import { shade_bundle_bounds } from "../shade_bundle_bounds.js";
-import { make_model_preview_scene, MODEL_PREVIEW_FOV } from "./make_model_preview_scene.js";
-import { model_preview_framing } from "./model_preview_framing.js";
-import { ModelPreviewFraming } from "./ModelPreviewFraming.js";
-
-/**
- * A picture of a loaded model, framed on itself.
- *
- * The four steps are each somebody's: where the model is (`shade_bundle_bounds`), how to frame it
- * (`model_preview_framing`), what a scene of one model looks like (`make_model_preview_scene`), and
- * how a frame becomes pixels (`GraphicsEngine3.render_to_sampler`). This is only the order.
- *
- * **A model with nothing to draw has no picture, and that is data rather than a fault**: a glTF of
- * empties, or one whose every mesh is skinned — a preview scene registers no skin, so a skinned
- * mesh is not in it. The answer then is `null`, and a caller showing icons shows none for that
- * asset rather than a blank square that reads as a broken renderer.
- *
- * @param {GraphicsEngine3} graphics
- * @param {SceneBundle} bundle
- * @param {number} width texels
- * @param {number} height texels
- * @param {number} [margin] fraction of the frame's height left clear around the model
- * @returns {Promise<Sampler2D|null>}
- */
-export async function make_model_thumbnail(graphics, bundle, width, height, margin = 0) {
-    assert.defined(graphics, 'graphics');
-    assert.defined(bundle, 'bundle');
-
-    // held locally rather than in module scratch: a caller may have several thumbnails in flight,
-    // and what each of them is framing must not be what the last one was
-    const bounds = new AABB3();
-
-    if (!shade_bundle_bounds(bounds, bundle)) {
-        return null;
-    }
-
-    const framing = model_preview_framing(new ModelPreviewFraming(), bounds, MODEL_PREVIEW_FOV, margin);
-
-    const { scene, camera, drawn } = make_model_preview_scene(bundle, framing, width / height);
-
-    if (drawn === 0) {
-        return null;
-    }
-
-    return graphics.render_to_sampler(scene, camera, width, height);
-}
+import { assert } from "../../../core/assert.js";
+import { AABB3 } from "../../../core/geom/3d/aabb/AABB3.js";
+import { shade_bundle_bounds } from "../shade_bundle_bounds.js";
+import { make_model_preview_scene, MODEL_PREVIEW_FOV } from "./make_model_preview_scene.js";
+import { model_preview_framing } from "./model_preview_framing.js";
+import { ModelPreviewFraming } from "./ModelPreviewFraming.js";
+
+/**
+ * A picture of a loaded model, framed on itself.
+ *
+ * The four steps are each somebody's: where the model is (`shade_bundle_bounds`), how to frame it
+ * (`model_preview_framing`), what a scene of one model looks like (`make_model_preview_scene`), and
+ * how a frame becomes pixels (`GraphicsEngine.render_to_sampler`). This is only the order.
+ *
+ * **A model with nothing to draw has no picture, and that is data rather than a fault**: a glTF of
+ * empties, or one whose every mesh is skinned — a preview scene registers no skin, so a skinned
+ * mesh is not in it. The answer then is `null`, and a caller showing icons shows none for that
+ * asset rather than a blank square that reads as a broken renderer.
+ *
+ * @param {GraphicsEngine} graphics
+ * @param {SceneBundle} bundle
+ * @param {number} width texels
+ * @param {number} height texels
+ * @param {number} [margin] fraction of the frame's height left clear around the model
+ * @returns {Promise<Sampler2D|null>}
+ */
+export async function make_model_thumbnail(graphics, bundle, width, height, margin = 0) {
+    assert.defined(graphics, 'graphics');
+    assert.defined(bundle, 'bundle');
+
+    // held locally rather than in module scratch: a caller may have several thumbnails in flight,
+    // and what each of them is framing must not be what the last one was
+    const bounds = new AABB3();
+
+    if (!shade_bundle_bounds(bounds, bundle)) {
+        return null;
+    }
+
+    const framing = model_preview_framing(new ModelPreviewFraming(), bounds, MODEL_PREVIEW_FOV, margin);
+
+    const { scene, camera, drawn } = make_model_preview_scene(bundle, framing, width / height);
+
+    if (drawn === 0) {
+        return null;
+    }
+
+    return graphics.render_to_sampler(scene, camera, width, height);
+}

package/src/engine/graphics3/shade_camera_projection_ray.d.ts

@@ -6,7 +6,7 @@
  * where it used to be.
  *
  * `x` and `y` are **clip-space**, in −1…1 with +Y up, which is what
- * `GraphicsEngine3.normalizeViewportPoint` produces from pixels.
+ * `GraphicsEngine.normalizeViewportPoint` produces from pixels.
  *
  * The origin is the camera's own position, which is right for a perspective camera and is also what
  * the three-based engine did for both kinds. A true orthographic pick wants parallel rays from the

package/src/engine/graphics3/shade_camera_projection_ray.js

@@ -1,77 +1,77 @@
-import { m4_invert } from "../../core/geom/3d/mat4/m4_invert.js";
-import { v3_matrix4_multiply } from "../../core/geom/vec3/v3_matrix4_multiply.js";
-
-/**
- * @type {Float32Array}
- */
-const SCRATCH_INVERSE = new Float32Array(16);
-
-/**
- * @type {Float32Array}
- */
-const SCRATCH_CLIP = new Float32Array(3);
-
-/**
- * @type {Float32Array}
- */
-const SCRATCH_WORLD = new Float32Array(3);
-
-/**
- * Where along the ray the unprojected point is taken.
- *
- * Any depth strictly inside the frustum names a point on the same ray, so this only has to avoid the
- * two ends. It matters that it avoids them: the perspective camera projects with an **infinite
- * reverse-Z**, where clip depth 0 is the far plane at infinity and unprojecting it divides by zero.
- * Half-way is finite under that projection and under a conventional one alike, which is what keeps
- * this a single expression rather than a branch on {@link Camera#isReverseZ}.
- *
- * @type {number}
- */
-const SAMPLE_DEPTH = 0.5;
-
-/**
- * A ray from the eye through a point on the viewport, in world space.
- *
- * The camera's matrices are read as they stand, so they have to be current — `camera.update()` is
- * what composes the view-projection this inverts, and a camera moved since then produces a ray for
- * where it used to be.
- *
- * `x` and `y` are **clip-space**, in −1…1 with +Y up, which is what
- * `GraphicsEngine3.normalizeViewportPoint` produces from pixels.
- *
- * The origin is the camera's own position, which is right for a perspective camera and is also what
- * the three-based engine did for both kinds. A true orthographic pick wants parallel rays from the
- * near plane instead; nothing asks for one, and this would quietly answer the perspective question if
- * something did.
- *
- * @param {Camera} camera Shade's
- * @param {number} x clip space, −1…1
- * @param {number} y clip space, −1…1, +Y up
- * @param {Vector3} out_source written with the ray's origin
- * @param {Vector3} out_direction written with a unit direction
- */
-export function shade_camera_projection_ray(camera, x, y, out_source, out_direction) {
-    m4_invert(SCRATCH_INVERSE, camera.view_projection_matrix);
-
-    SCRATCH_CLIP[0] = x;
-    SCRATCH_CLIP[1] = y;
-    SCRATCH_CLIP[2] = SAMPLE_DEPTH;
-
-    v3_matrix4_multiply(SCRATCH_WORLD, 0, SCRATCH_CLIP, 0, SCRATCH_INVERSE);
-
-    const position = camera.transform.position;
-
-    const origin_x = position.x;
-    const origin_y = position.y;
-    const origin_z = position.z;
-
-    out_source.set(origin_x, origin_y, origin_z);
-
-    out_direction.set(
-        SCRATCH_WORLD[0] - origin_x,
-        SCRATCH_WORLD[1] - origin_y,
-        SCRATCH_WORLD[2] - origin_z
-    );
-
-    out_direction.normalize();
-}
+import { m4_invert } from "../../core/geom/3d/mat4/m4_invert.js";
+import { v3_matrix4_multiply } from "../../core/geom/vec3/v3_matrix4_multiply.js";
+
+/**
+ * @type {Float32Array}
+ */
+const SCRATCH_INVERSE = new Float32Array(16);
+
+/**
+ * @type {Float32Array}
+ */
+const SCRATCH_CLIP = new Float32Array(3);
+
+/**
+ * @type {Float32Array}
+ */
+const SCRATCH_WORLD = new Float32Array(3);
+
+/**
+ * Where along the ray the unprojected point is taken.
+ *
+ * Any depth strictly inside the frustum names a point on the same ray, so this only has to avoid the
+ * two ends. It matters that it avoids them: the perspective camera projects with an **infinite
+ * reverse-Z**, where clip depth 0 is the far plane at infinity and unprojecting it divides by zero.
+ * Half-way is finite under that projection and under a conventional one alike, which is what keeps
+ * this a single expression rather than a branch on {@link Camera#isReverseZ}.
+ *
+ * @type {number}
+ */
+const SAMPLE_DEPTH = 0.5;
+
+/**
+ * A ray from the eye through a point on the viewport, in world space.
+ *
+ * The camera's matrices are read as they stand, so they have to be current — `camera.update()` is
+ * what composes the view-projection this inverts, and a camera moved since then produces a ray for
+ * where it used to be.
+ *
+ * `x` and `y` are **clip-space**, in −1…1 with +Y up, which is what
+ * `GraphicsEngine.normalizeViewportPoint` produces from pixels.
+ *
+ * The origin is the camera's own position, which is right for a perspective camera and is also what
+ * the three-based engine did for both kinds. A true orthographic pick wants parallel rays from the
+ * near plane instead; nothing asks for one, and this would quietly answer the perspective question if
+ * something did.
+ *
+ * @param {Camera} camera Shade's
+ * @param {number} x clip space, −1…1
+ * @param {number} y clip space, −1…1, +Y up
+ * @param {Vector3} out_source written with the ray's origin
+ * @param {Vector3} out_direction written with a unit direction
+ */
+export function shade_camera_projection_ray(camera, x, y, out_source, out_direction) {
+    m4_invert(SCRATCH_INVERSE, camera.view_projection_matrix);
+
+    SCRATCH_CLIP[0] = x;
+    SCRATCH_CLIP[1] = y;
+    SCRATCH_CLIP[2] = SAMPLE_DEPTH;
+
+    v3_matrix4_multiply(SCRATCH_WORLD, 0, SCRATCH_CLIP, 0, SCRATCH_INVERSE);
+
+    const position = camera.transform.position;
+
+    const origin_x = position.x;
+    const origin_y = position.y;
+    const origin_z = position.z;
+
+    out_source.set(origin_x, origin_y, origin_z);
+
+    out_direction.set(
+        SCRATCH_WORLD[0] - origin_x,
+        SCRATCH_WORLD[1] - origin_y,
+        SCRATCH_WORLD[2] - origin_z
+    );
+
+    out_direction.normalize();
+}

package/src/engine/graphics3/shade_node_to_entity_composition.d.ts

@@ -12,7 +12,7 @@
  *
  * **Geometry and material are shared, not copied.** Two entities placing the same model name the
  * same `MeshletGeometry` and the same `ShadeMaterial`; what is per-entity is the row each one gets
- * in the scene, which is `ShadedGeometrySystem3`'s business. That is the whole reason a static model
+ * in the scene, which is `ShadedGeometrySystem`'s business. That is the whole reason a static model
  * needs no clone of the bundle at all.
  *
  * **A skinned mesh is not expanded, and that is a boundary rather than an omission.** Its vertices