@weasel-js/kernel3d 1.9.3 → 1.10.0

package/README.md

@@ -31,7 +31,7 @@ numbers: a 3D host passes the dispatcher an identity `clientToWorld`, so
 `ctx.world` is the screen point, and each dep rebuilds the ray itself. Tools,
 the select tool included, transfer untouched.
 
-One thing does not, and the kernel says so rather than guessing:
+One thing does not:
 
 - **`ViewApi` has no orientation**, so an orbit camera cannot travel through
   the kit's `view`. The kernel declares a `camera3d` dep of its own.
@@ -46,7 +46,7 @@ away it is.
 
 **The answer is "as far as it already was."** Both resolve the rectangle on the
 plane through the pose they were handed, facing the camera, so neither changes
-depth. Two consequences worth knowing before you build on them:
+depth. Two consequences:
 
 - A resize scales uniformly. The rectangle names two extents and a pose has
   three, so the factor is the geometric mean of the two it names.

package/dist/index.d.ts

@@ -140,14 +140,9 @@ declare function projectAabbToScreen(box: Aabb, viewProjection: Mat4, rect: Scre
 /**
  * The kit's deps, implemented against a 3D world.
  *
- * Every one of these takes its camera from a thunk rather than an argument.
- * That is the kernel's central claim in code: the dispatcher keeps handing
- * actions two numbers, and what makes them mean something in 3D is the camera
- * each dep already closes over. `InvocationCtx` needs no widening, and none of
- * these needs a ray passed in.
- *
- * Where a kit contract cannot be honored, the implementation throws rather than
- * guessing. A guess would report a fit the kernel does not have.
+ * Every one of these takes its camera from a thunk rather than an argument:
+ * the dispatcher keeps handing actions two numbers, and what makes them mean
+ * something in 3D is the camera each dep already closes over.
  */
 
 /** The camera and the pane it draws into; `width`/`height` are the pane's
@@ -171,11 +166,9 @@ type Scene3d<TData, TLayer extends string> = Scene<TData, TLayer, Pose3>;
 /** A node of a `Scene3d`. */
 type Node3d<TData, TLayer extends string> = SceneNode<TData, TLayer, Pose3>;
 /**
- * The world box a node occupies. The kernel cannot answer this, and the reason
- * is sharper than "it does not know the mesh": a sphere's box is the same under
- * every rotation, and no transform of a local box reproduces that — rotate a
- * cube and it widens. Asking for the world box directly is what lets a
- * primitive answer for its own symmetry.
+ * The world box a node occupies, rather than a local box to transform: a
+ * sphere's box is the same under every rotation, and no transform of a local
+ * box reproduces that — rotate a cube and it widens.
  *
  * Omitted, a node is a unit cube carried by its pose.
  */
@@ -220,9 +213,9 @@ interface Footprint {
  * implies is the consumer's answer — the kernel does not know what it is
  * inserting.
  *
- * The kit's `InsertDep.commit` hands over a screen-space AABB and nothing else,
- * which turns out to be enough: the depth the 2D contract cannot express comes
- * from the plane, not from the caller.
+ * The kit's `InsertDep.commit` hands over a screen-space AABB and nothing else:
+ * the depth the 2D contract cannot express comes from the plane, not from the
+ * caller.
  */
 declare function createInsert(opts: {
     viewport: ViewportSource;
@@ -233,33 +226,29 @@ declare function createInsert(opts: {
 }): InsertDep;
 /**
  * `PoseDescriptor` over a 3D pose, with `Bounds` read as the screen box the
- * node covers. Chrome and marquee math work unchanged; the two methods that
- * run the other way cannot.
+ * node covers.
  *
- * `forNode` is what lets a sphere bound itself as a sphere: every node is a
- * `Pose3`, so the shape lives on `node.data` and nothing but the node can say
- * which one this is. Unspecialized — the kit calling with only a pose in hand —
+ * `forNode` is what lets a sphere bound itself as a sphere: the shape lives
+ * on `node.data`. Unspecialized — the kit calling with only a pose in hand —
  * it answers with the default local box, which is the looser of the two.
  *
- * The two methods that run the other way — `remapBounds` and `fromBounds` —
- * take a screen rectangle, which names a pose only once something supplies a
- * depth. Both resolve it against the plane through the pose they were handed,
- * facing the camera, so nothing they produce changes depth. See
- * {@link viewPlaneAt}.
+ * `remapBounds` and `fromBounds` take a screen rectangle, which names a pose
+ * only once something supplies a depth. Both resolve it against the plane
+ * through the pose they were handed, facing the camera, so nothing they
+ * produce changes depth.
  */
 declare function createPoseDescriptor<TData, TLayer extends string>(world: World3d<TData, TLayer>): PoseDescriptor<Pose3, Node3d<TData, TLayer>>;
 
 /**
  * What a host paints for a gesture that proposes chrome rather than a pose.
  *
- * A marquee sweep and a box-drag both publish an `OngoingOverlay`, which used
- * to reach paint only through core's own 2D layer. `resolveOverlays` hands back
- * world geometry with no renderer in it, so the same call `<SceneCanvas>` makes
- * serves a consumer-owned 3D renderer.
+ * A marquee sweep and a box-drag both publish an `OngoingOverlay`.
+ * `resolveOverlays` hands back world geometry with no renderer in it, so the
+ * same call `<SceneCanvas>` makes serves a consumer-owned 3D renderer.
  *
  * A 3D host's `clientToWorld` is identity, so an overlay's world bounds are the
  * client rect the deps already work in, and the pane origin comes off exactly
- * once. Only the rectangular variants resolve here: a lasso, a pencil and a run
+ * once. Only the rectangular variants resolve here: a lasso, a pencil, and a run
  * of points are paths, and a path is geometry this cannot flatten to a box.
  */
 
@@ -287,7 +276,7 @@ declare const orbitAction: Action;
 declare const dollyAction: Action;
 /** A tool that binds drag to `camera.orbit`. Register `orbitAction` alongside
  *  it; the tool only declares the binding. */
-declare function useOrbitTool(): Tool<null>;
+declare function useOrbitTool(): Tool;
 
 /**
  * The kernel's one new dep.