@idetik/core 0.40.0 → 0.40.2

package/dist/types/src/math/box3.d.ts

@@ -1,18 +1,52 @@
 import { mat4, vec3 } from "gl-matrix";
+/**
+ * Axis-aligned bounding box defined by minimum and maximum corners.
+ *
+ * Box3 represents a 3D region bounded by two corners: `min` and `max`. It
+ * is used for spatial queries, culling tests, intersection checks, and
+ * computing bounding volumes. A default-constructed box is empty and
+ * intersection treats boxes as half-open intervals.
+ *
+ * @group Math
+ */
 export declare class Box3 {
+    /** Minimum corner of the box. */
     min: vec3;
+    /** Maximum corner of the box. */
     max: vec3;
     /**
-     * Initializes as an empty box if no values are provided using the
-     * "empty-by-sentinel" pattern: min = +Infinity, max = -Infinity.
-     * This allows expansion functions to work without special-casing
-     * the first element, and avoids biasing toward (0,0,0).
+     * Creates a box from optional corner points. The corners are cloned.
+     * When a corner is omitted the box starts empty.
+     *
+     * @param min - The minimum corner.
+     * @param max - The maximum corner.
      */
     constructor(min?: vec3, max?: vec3);
+    /** Returns a deep copy of the box. */
     clone(): Box3;
+    /** Returns `true` when the box encloses no volume. */
     isEmpty(): boolean;
+    /**
+     * Tests whether two boxes overlap. Boxes are treated as half-open
+     * intervals so touching faces do not count as overlap.
+     *
+     * @param a - The first box.
+     * @param b - The second box.
+     */
     static intersects(a: Box3, b: Box3): boolean;
+    /**
+     * Grows the box in place to contain the given point.
+     *
+     * @param p - The point to include.
+     */
     expandWithPoint(p: vec3): void;
+    /**
+     * Transforms the box in place by the given matrix. The result is the
+     * axis-aligned box of the eight transformed corners so the box can grow
+     * under rotation.
+     *
+     * @param matrix - The transform to apply.
+     */
     applyTransform(matrix: mat4): void;
 }
 //# sourceMappingURL=box3.d.ts.map

package/dist/types/src/math/box3.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"box3.d.ts","sourceRoot":"","sources":["../../../../src/math/box3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEvC,qBAAa,IAAI;IACR,GAAG,EAAE,IAAI,CAAC;IACV,GAAG,EAAE,IAAI,CAAC;IAEjB;;;;;OAKG;gBACS,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,EAAE,IAAI;IAS3B,KAAK;IAIL,OAAO,IAAI,OAAO;WASX,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,GAAG,OAAO;IAO5C,eAAe,CAAC,CAAC,EAAE,IAAI;IASvB,cAAc,CAAC,MAAM,EAAE,IAAI;CAuBnC"}
+{"version":3,"file":"box3.d.ts","sourceRoot":"","sources":["../../../../src/math/box3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEvC;;;;;;;;;GASG;AACH,qBAAa,IAAI;IACf,iCAAiC;IAC1B,GAAG,EAAE,IAAI,CAAC;IACjB,iCAAiC;IAC1B,GAAG,EAAE,IAAI,CAAC;IAEjB;;;;;;OAMG;gBACS,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,EAAE,IAAI;IASlC,sCAAsC;IAC/B,KAAK;IAIZ,sDAAsD;IAC/C,OAAO,IAAI,OAAO;IAQzB;;;;;;OAMG;WACW,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,GAAG,OAAO;IAOnD;;;;OAIG;IACI,eAAe,CAAC,CAAC,EAAE,IAAI;IAS9B;;;;;;OAMG;IACI,cAAc,CAAC,MAAM,EAAE,IAAI;CAuBnC"}

package/dist/types/src/math/color.d.ts

@@ -1,28 +1,75 @@
 import { vec3, vec4 } from "gl-matrix";
-/** @group Layer Configuration */
+/**
+ * A value convertible to {@link Color}.
+ */
 export type ColorLike = Color | vec3 | vec4 | string;
-/** @group Layer Configuration */
+/**
+ * Immutable RGBA color with components in `[0, 1]`.
+ *
+ * Color represents an RGBA value with four components. It is used for channel
+ * tints, label color maps, and wireframe overlays. Components are validated
+ * at construction and never change. Every API that takes a color accepts a
+ * {@link ColorLike} so hex strings and component arrays coerce automatically
+ * through {@link from}. Common colors are available as static presets.
+ *
+ * @group Math
+ */
 export declare class Color {
+    /** Opaque red `#ff0000`. */
     static readonly RED: Color;
+    /** Opaque green `#00ff00`. */
     static readonly GREEN: Color;
+    /** Opaque blue `#0000ff`. */
     static readonly BLUE: Color;
+    /** Opaque yellow `#ffff00`. */
     static readonly YELLOW: Color;
+    /** Opaque magenta `#ff00ff`. */
     static readonly MAGENTA: Color;
+    /** Opaque cyan `#00ffff`. */
     static readonly CYAN: Color;
+    /** Opaque black `#000000`. */
     static readonly BLACK: Color;
+    /** Opaque white `#ffffff`. */
     static readonly WHITE: Color;
+    /** Fully transparent black. */
     static readonly TRANSPARENT: Color;
     private readonly rgba_;
+    /**
+     * Creates a color from RGBA components in `[0, 1]`.
+     *
+     * @param r - The red component.
+     * @param g - The green component.
+     * @param b - The blue component.
+     * @param a - The alpha component. Defaults to `1`.
+     */
     constructor(r: number, g: number, b: number, a?: number);
+    /** The RGB components as a three-element array. */
     get rgb(): [number, number, number];
+    /** The RGBA components as a four-element array. */
     get rgba(): readonly [number, number, number, number];
+    /** The red component. */
     get r(): number;
+    /** The green component. */
     get g(): number;
+    /** The blue component. */
     get b(): number;
+    /** The alpha component. */
     get a(): number;
+    /** The color as a `#rrggbb` hex string. Alpha is dropped. */
     get rgbHex(): string;
+    /** The color packed into a 32-bit integer as RGBA bytes. */
     get packed(): number;
+    /**
+     * Converts a {@link ColorLike} value to a `Color`.
+     *
+     * @param colorLike - The value to convert.
+     */
     static from(colorLike: ColorLike): Color;
+    /**
+     * Parses a `#rrggbb` hex string into an opaque color.
+     *
+     * @param hex - The hex string with or without the leading `#`.
+     */
     static fromRgbHex(hex: string): Color;
     private toHexComponent;
 }

package/dist/types/src/math/color.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"color.d.ts","sourceRoot":"","sources":["../../../../src/math/color.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEvC,iCAAiC;AACjC,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC;AAErD,iCAAiC;AACjC,qBAAa,KAAK;IAChB,gBAAuB,GAAG,EAAE,KAAK,CAA4B;IAC7D,gBAAuB,KAAK,EAAE,KAAK,CAA4B;IAC/D,gBAAuB,IAAI,EAAE,KAAK,CAA4B;IAC9D,gBAAuB,MAAM,EAAE,KAAK,CAA4B;IAChE,gBAAuB,OAAO,EAAE,KAAK,CAA4B;IACjE,gBAAuB,IAAI,EAAE,KAAK,CAA4B;IAC9D,gBAAuB,KAAK,EAAE,KAAK,CAA4B;IAC/D,gBAAuB,KAAK,EAAE,KAAK,CAA4B;IAC/D,gBAAuB,WAAW,EAAE,KAAK,CAAiC;IAG1E,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA4C;gBAEtD,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM;IAUvD,IAAW,GAAG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAEzC;IAED,IAAW,IAAI,IAAI,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAE3D;IAED,IAAW,CAAC,IAAI,MAAM,CAErB;IAED,IAAW,CAAC,IAAI,MAAM,CAErB;IAED,IAAW,CAAC,IAAI,MAAM,CAErB;IAED,IAAW,CAAC,IAAI,MAAM,CAErB;IAED,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,IAAW,MAAM,IAAI,MAAM,CAO1B;WAEa,IAAI,CAAC,SAAS,EAAE,SAAS,GAAG,KAAK;WAgBjC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK;IAa5C,OAAO,CAAC,cAAc;CAMvB"}
+{"version":3,"file":"color.d.ts","sourceRoot":"","sources":["../../../../src/math/color.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC;AAErD;;;;;;;;;;GAUG;AACH,qBAAa,KAAK;IAChB,4BAA4B;IAC5B,gBAAuB,GAAG,EAAE,KAAK,CAA4B;IAC7D,8BAA8B;IAC9B,gBAAuB,KAAK,EAAE,KAAK,CAA4B;IAC/D,6BAA6B;IAC7B,gBAAuB,IAAI,EAAE,KAAK,CAA4B;IAC9D,+BAA+B;IAC/B,gBAAuB,MAAM,EAAE,KAAK,CAA4B;IAChE,gCAAgC;IAChC,gBAAuB,OAAO,EAAE,KAAK,CAA4B;IACjE,6BAA6B;IAC7B,gBAAuB,IAAI,EAAE,KAAK,CAA4B;IAC9D,8BAA8B;IAC9B,gBAAuB,KAAK,EAAE,KAAK,CAA4B;IAC/D,8BAA8B;IAC9B,gBAAuB,KAAK,EAAE,KAAK,CAA4B;IAC/D,+BAA+B;IAC/B,gBAAuB,WAAW,EAAE,KAAK,CAAiC;IAG1E,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA4C;IAElE;;;;;;;OAOG;gBACS,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM;IAUvD,mDAAmD;IACnD,IAAW,GAAG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAEzC;IAED,mDAAmD;IACnD,IAAW,IAAI,IAAI,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAE3D;IAED,yBAAyB;IACzB,IAAW,CAAC,IAAI,MAAM,CAErB;IAED,2BAA2B;IAC3B,IAAW,CAAC,IAAI,MAAM,CAErB;IAED,0BAA0B;IAC1B,IAAW,CAAC,IAAI,MAAM,CAErB;IAED,2BAA2B;IAC3B,IAAW,CAAC,IAAI,MAAM,CAErB;IAED,6DAA6D;IAC7D,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,4DAA4D;IAC5D,IAAW,MAAM,IAAI,MAAM,CAO1B;IAED;;;;OAIG;WACW,IAAI,CAAC,SAAS,EAAE,SAAS,GAAG,KAAK;IAgB/C;;;;OAIG;WACW,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK;IAa5C,OAAO,CAAC,cAAc;CAMvB"}

package/dist/types/src/math/frustum.d.ts

@@ -1,9 +1,37 @@
 import { Box3 } from "./box3";
 import { mat4 } from "gl-matrix";
+/**
+ * Camera view frustum defined by six world-space planes.
+ *
+ * Frustum represents the visible region of a camera as six bounding
+ * planes. It is used for culling tests and visibility checks against
+ * bounding boxes. The planes are extracted from a view-projection matrix
+ * and normalized so distances are in world units.
+ *
+ * @group Math
+ */
 export declare class Frustum {
     private readonly planes_;
+    /**
+     * Creates a frustum from a view-projection matrix.
+     *
+     * @param m - The combined view-projection matrix.
+     */
     constructor(m: mat4);
+    /**
+     * Re-extracts the six planes from a view-projection matrix.
+     *
+     * @param m - The combined view-projection matrix.
+     */
     setWithViewProjection(m: mat4): void;
+    /**
+     * Tests whether a box is at least partly inside the frustum. The test
+     * is conservative. A box outside the frustum but near a corner can be
+     * reported as intersecting, which only costs a draw of an offscreen
+     * object.
+     *
+     * @param box - The world-space box to test.
+     */
     intersectsWithBox3(box: Box3): boolean;
 }
 //# sourceMappingURL=frustum.d.ts.map

package/dist/types/src/math/frustum.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"frustum.d.ts","sourceRoot":"","sources":["../../../../src/math/frustum.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,IAAI,EAAQ,MAAM,WAAW,CAAC;AAEvC,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA6C;gBAEzD,CAAC,EAAE,IAAI;IAcZ,qBAAqB,CAAC,CAAC,EAAE,IAAI;IA0C7B,kBAAkB,CAAC,GAAG,EAAE,IAAI;CAWpC"}
+{"version":3,"file":"frustum.d.ts","sourceRoot":"","sources":["../../../../src/math/frustum.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,IAAI,EAAQ,MAAM,WAAW,CAAC;AAEvC;;;;;;;;;GASG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA6C;IAErE;;;;OAIG;gBACS,CAAC,EAAE,IAAI;IAcnB;;;;OAIG;IACI,qBAAqB,CAAC,CAAC,EAAE,IAAI;IA0CpC;;;;;;;OAOG;IACI,kBAAkB,CAAC,GAAG,EAAE,IAAI;CAWpC"}

package/dist/types/src/math/transforms.d.ts

@@ -1,21 +1,78 @@
 import { mat4, vec3, quat } from "gl-matrix";
+/**
+ * Transform defined by translation, rotation, and scale components.
+ *
+ * TRS transform represents a placement in world space composed as
+ * translation times rotation times scale. It is used to position cameras
+ * and renderable objects through their `transform` property. The matrix
+ * is computed lazily and cached.
+ *
+ * ```ts
+ * const transform = camera.transform;
+ * transform.setTranslation([0, 0, radius]);
+ * transform.targetTo([0, 0, 0]);
+ * ```
+ *
+ * @group Math
+ */
 export declare class TrsTransform {
     private dirty_;
     private matrix_;
     private rotation_;
     private translation_;
     private scale_;
+    /**
+     * Composes the given rotation onto the current rotation.
+     *
+     * @param q - The rotation to apply.
+     */
     addRotation(q: quat): void;
+    /**
+     * Replaces the rotation with the given quaternion.
+     *
+     * @param q - The new rotation.
+     */
     setRotation(q: quat): void;
+    /** A copy of the rotation quaternion. */
     get rotation(): import("gl-matrix").vec4;
+    /**
+     * Adds the given offset to the translation.
+     *
+     * @param vec - The offset to add.
+     */
     addTranslation(vec: vec3): void;
+    /**
+     * Replaces the translation with the given vector.
+     *
+     * @param vec - The new translation.
+     */
     setTranslation(vec: vec3): void;
+    /** A copy of the translation vector. */
     get translation(): vec3;
+    /**
+     * Multiplies the scale componentwise by the given vector.
+     *
+     * @param vec - The scale factors to apply.
+     */
     addScale(vec: vec3): void;
+    /**
+     * Replaces the scale with the given vector.
+     *
+     * @param vec - The new scale.
+     */
     setScale(vec: vec3): void;
+    /**
+     * Rotates the transform to face the given target point. Uses `+Y` as
+     * world up.
+     *
+     * @param target - The world-space point to face.
+     */
     targetTo(target: vec3): void;
+    /** A copy of the scale vector. */
     get scale(): vec3;
+    /** The composed transform matrix. Recomputed when stale. */
     get matrix(): mat4;
+    /** The inverse of the composed transform matrix. */
     get inverse(): mat4;
     private computeMatrix;
 }

package/dist/types/src/math/transforms.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transforms.d.ts","sourceRoot":"","sources":["../../../../src/math/transforms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAQ,IAAI,EAAE,IAAI,EAAY,MAAM,WAAW,CAAC;AAK7D,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,SAAS,CAAiB;IAClC,OAAO,CAAC,YAAY,CAAiB;IACrC,OAAO,CAAC,MAAM,CAA4B;IAEnC,WAAW,CAAC,CAAC,EAAE,IAAI;IAKnB,WAAW,CAAC,CAAC,EAAE,IAAI;IAK1B,IAAW,QAAQ,6BAElB;IAEM,cAAc,CAAC,GAAG,EAAE,IAAI;IAKxB,cAAc,CAAC,GAAG,EAAE,IAAI;IAK/B,IAAW,WAAW,SAErB;IAEM,QAAQ,CAAC,GAAG,EAAE,IAAI;IAKlB,QAAQ,CAAC,GAAG,EAAE,IAAI;IAKlB,QAAQ,CAAC,MAAM,EAAE,IAAI;IAgB5B,IAAW,KAAK,SAEf;IAED,IAAW,MAAM,SAMhB;IAED,IAAW,OAAO,SAEjB;IAED,OAAO,CAAC,aAAa;CAQtB"}
+{"version":3,"file":"transforms.d.ts","sourceRoot":"","sources":["../../../../src/math/transforms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAQ,IAAI,EAAE,IAAI,EAAY,MAAM,WAAW,CAAC;AAK7D;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,SAAS,CAAiB;IAClC,OAAO,CAAC,YAAY,CAAiB;IACrC,OAAO,CAAC,MAAM,CAA4B;IAE1C;;;;OAIG;IACI,WAAW,CAAC,CAAC,EAAE,IAAI;IAK1B;;;;OAIG;IACI,WAAW,CAAC,CAAC,EAAE,IAAI;IAK1B,yCAAyC;IACzC,IAAW,QAAQ,6BAElB;IAED;;;;OAIG;IACI,cAAc,CAAC,GAAG,EAAE,IAAI;IAK/B;;;;OAIG;IACI,cAAc,CAAC,GAAG,EAAE,IAAI;IAK/B,wCAAwC;IACxC,IAAW,WAAW,SAErB;IAED;;;;OAIG;IACI,QAAQ,CAAC,GAAG,EAAE,IAAI;IAKzB;;;;OAIG;IACI,QAAQ,CAAC,GAAG,EAAE,IAAI;IAKzB;;;;;OAKG;IACI,QAAQ,CAAC,MAAM,EAAE,IAAI;IAgB5B,kCAAkC;IAClC,IAAW,KAAK,SAEf;IAED,4DAA4D;IAC5D,IAAW,MAAM,SAMhB;IAED,oDAAoD;IACpD,IAAW,OAAO,SAEjB;IAED,OAAO,CAAC,aAAa;CAQtB"}

package/dist/types/src/objects/cameras/camera.d.ts

@@ -2,26 +2,81 @@ import { Node } from "../../core/node";
 import { Frustum } from "../../math/frustum";
 import { TrsTransform } from "../../math/transforms";
 import { mat4, vec3 } from "gl-matrix";
+/** Identifies a concrete camera implementation. */
 export type CameraType = "OrthographicCamera" | "PerspectiveCamera";
+/**
+ * Abstract base class for cameras.
+ *
+ * A camera pairs a world-space transform with a projection, producing the
+ * view and projection matrices used to render a viewport. The concrete
+ * cameras, {@link OrthographicCamera} and {@link PerspectiveCamera}, define
+ * the projection. This class provides the shared transform, derived
+ * matrices, and navigation helpers.
+ *
+ * @group Cameras
+ */
 export declare abstract class Camera extends Node {
     private readonly transform_;
+    /** @hidden */
     protected projectionMatrix_: mat4;
+    /** @hidden */
     protected near_: number;
+    /** @hidden */
     protected far_: number;
+    /** @hidden */
     protected abstract updateProjectionMatrix(): void;
+    /** Identifies the camera type. */
     abstract get type(): CameraType;
+    /** Recomputes the camera's projection matrix. */
     update(): void;
+    /** The camera's projection matrix. */
     get projectionMatrix(): mat4;
+    /** The camera's world-space transform. */
     get transform(): TrsTransform;
+    /** The view matrix: the inverse of the camera's world transform. */
     get viewMatrix(): mat4;
+    /** The camera's local right axis in world space. */
     get right(): vec3;
+    /** The camera's local up axis in world space. */
     get up(): vec3;
+    /**
+     * Computes the combined view-projection matrix.
+     *
+     * @returns The projection matrix multiplied by the view matrix.
+     */
     getViewProjection(): mat4;
+    /** The view frustum derived from the current view-projection. */
     get frustum(): Frustum;
+    /**
+     * Sets the aspect ratio (width / height) of the viewport the camera
+     * renders into. Called automatically by the owning viewport when it
+     * resizes.
+     *
+     * @param aspectRatio - The viewport's width divided by its height.
+     */
     abstract setAspectRatio(aspectRatio: number): void;
+    /**
+     * Zooms the view by the given factor relative to the current zoom level.
+     * Factors greater than `1` zoom in and factors between `0` and `1` zoom
+     * out.
+     *
+     * @param factor - The magnification factor to apply.
+     */
     abstract zoom(factor: number): void;
+    /**
+     * Moves the camera by the given world-space offset.
+     *
+     * @param vec - The translation to add to the camera's position.
+     */
     pan(vec: vec3): void;
+    /** The camera's world-space position. */
     get position(): vec3;
+    /**
+     * Transforms a position from clip space to world space.
+     *
+     * @param position - The clip-space position to transform.
+     * @returns The corresponding world-space position.
+     */
     clipToWorld(position: vec3): vec3;
 }
 //# sourceMappingURL=camera.d.ts.map

package/dist/types/src/objects/cameras/camera.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"camera.d.ts","sourceRoot":"","sources":["../../../../../src/objects/cameras/camera.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAQ,MAAM,WAAW,CAAC;AAE7C,MAAM,MAAM,UAAU,GAAG,oBAAoB,GAAG,mBAAmB,CAAC;AAEpE,8BAAsB,MAAO,SAAQ,IAAI;IACvC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAsB;IACjD,SAAS,CAAC,iBAAiB,OAAiB;IAC5C,SAAS,CAAC,KAAK,SAAK;IACpB,SAAS,CAAC,IAAI,SAAK;IAEnB,SAAS,CAAC,QAAQ,CAAC,sBAAsB,IAAI,IAAI;IAEjD,aAAoB,IAAI,IAAI,UAAU,CAAC;IAEhC,MAAM;IAIb,IAAI,gBAAgB,SAEnB;IAED,IAAW,SAAS,iBAEnB;IAED,IAAI,UAAU,SAEb;IAED,IAAI,KAAK,SAGR;IAED,IAAI,EAAE,SAGL;IAEM,iBAAiB,IAAI,IAAI;IAIhC,IAAI,OAAO,YAEV;aAEe,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;aACzC,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAEnC,GAAG,CAAC,GAAG,EAAE,IAAI;IAIpB,IAAW,QAAQ,SAElB;IAEM,WAAW,CAAC,QAAQ,EAAE,IAAI,GAAG,IAAI;CAoBzC"}
+{"version":3,"file":"camera.d.ts","sourceRoot":"","sources":["../../../../../src/objects/cameras/camera.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAQ,MAAM,WAAW,CAAC;AAE7C,mDAAmD;AACnD,MAAM,MAAM,UAAU,GAAG,oBAAoB,GAAG,mBAAmB,CAAC;AAEpE;;;;;;;;;;GAUG;AACH,8BAAsB,MAAO,SAAQ,IAAI;IACvC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAsB;IACjD,cAAc;IACd,SAAS,CAAC,iBAAiB,OAAiB;IAC5C,cAAc;IACd,SAAS,CAAC,KAAK,SAAK;IACpB,cAAc;IACd,SAAS,CAAC,IAAI,SAAK;IAEnB,cAAc;IACd,SAAS,CAAC,QAAQ,CAAC,sBAAsB,IAAI,IAAI;IAEjD,kCAAkC;IAClC,aAAoB,IAAI,IAAI,UAAU,CAAC;IAEvC,iDAAiD;IAC1C,MAAM;IAIb,sCAAsC;IACtC,IAAI,gBAAgB,SAEnB;IAED,0CAA0C;IAC1C,IAAW,SAAS,iBAEnB;IAED,oEAAoE;IACpE,IAAI,UAAU,SAEb;IAED,oDAAoD;IACpD,IAAI,KAAK,SAGR;IAED,iDAAiD;IACjD,IAAI,EAAE,SAGL;IAED;;;;OAIG;IACI,iBAAiB,IAAI,IAAI;IAIhC,iEAAiE;IACjE,IAAI,OAAO,YAEV;IAED;;;;;;OAMG;aACa,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAEzD;;;;;;OAMG;aACa,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAE1C;;;;OAIG;IACI,GAAG,CAAC,GAAG,EAAE,IAAI;IAIpB,yCAAyC;IACzC,IAAW,QAAQ,SAElB;IAED;;;;;OAKG;IACI,WAAW,CAAC,QAAQ,EAAE,IAAI,GAAG,IAAI;CAoBzC"}

package/dist/types/src/objects/cameras/controls.d.ts

@@ -1,18 +1,105 @@
 import { OrthographicCamera } from "./orthographic_camera";
 import { EventContext } from "../../core/event_dispatcher";
+/**
+ * The contract between a viewport and its camera controls.
+ *
+ * Implement this interface to drive a camera with custom input logic and
+ * assign it to a viewport through its `cameraControls` property. The
+ * viewport passes pointer and wheel events to `onEvent` unless a layer
+ * stops propagation.
+ *
+ * ```ts
+ * class ClickToZoomControls implements CameraControls {
+ *   constructor(private camera: OrthographicCamera) {}
+ *
+ *   get isMoving() {
+ *     return false;
+ *   }
+ *
+ *   onUpdate(dt: number) {}
+ *
+ *   onEvent(event: EventContext) {
+ *     if (event.type === "pointerdown") this.camera.zoom(2);
+ *   }
+ * }
+ *
+ * viewport.cameraControls = new ClickToZoomControls(camera);
+ * ```
+ *
+ * @group Controls
+ */
 export interface CameraControls {
+    /**
+     * Whether the camera is in motion from user interaction. Layers may
+     * read this to reduce rendering quality while the view changes.
+     */
     readonly isMoving: boolean;
+    /**
+     * Advances time-based motion such as damping. Called automatically by
+     * the render loop.
+     *
+     * @param dt - Time since the last frame in seconds.
+     */
     onUpdate(dt: number): void;
+    /**
+     * Handles a pointer or wheel event. Called automatically by the owning
+     * viewport unless a layer stops propagation.
+     *
+     * @param event - The event with clip and world coordinates attached.
+     */
     onEvent(event: EventContext): void;
 }
-/** @group Cameras & Controls */
+/**
+ * Camera controls for 2D pan and zoom with an orthographic camera.
+ *
+ * Dragging with the left mouse button pans the view and the scroll wheel
+ * zooms around the cursor, keeping the point under the pointer fixed.
+ * Movement applies immediately with no inertia or damping.
+ *
+ * ```ts
+ * const camera = new OrthographicCamera({
+ *   left: 0,
+ *   right: 1024,
+ *   top: 0,
+ *   bottom: 1024,
+ * });
+ *
+ * const idetik = new Idetik({
+ *   canvas,
+ *   viewports: [{
+ *     camera,
+ *     layers: [imageLayer],
+ *     cameraControls: new PanZoomControls(camera),
+ *   }],
+ * });
+ * ```
+ *
+ * @group Controls
+ */
 export declare class PanZoomControls implements CameraControls {
     private readonly camera_;
     private dragActive_;
     private dragStart_;
+    /**
+     * Creates pan and zoom controls for the given camera.
+     *
+     * @param camera - The orthographic camera to control.
+     */
     constructor(camera: OrthographicCamera);
+    /** Whether a pan drag is in progress. */
     get isMoving(): boolean;
+    /**
+     * Handles a pointer or wheel event. Called automatically by the owning
+     * viewport unless a layer stops propagation.
+     *
+     * @param event - The event with clip and world coordinates attached.
+     */
     onEvent(event: EventContext): void;
+    /**
+     * Does nothing. Pan and zoom apply immediately with no inertia.
+     *
+     * @param _delta - Time since the last frame in seconds. Unused.
+     */
     onUpdate(_delta: number): void;
     private onWheel;
     private onPointerDown;

package/dist/types/src/objects/cameras/controls.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"controls.d.ts","sourceRoot":"","sources":["../../../../../src/objects/cameras/controls.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAI3D,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,CAAC;CACpC;AAED,gCAAgC;AAChC,qBAAa,eAAgB,YAAW,cAAc;IACpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAC7C,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,UAAU,CAAuB;gBAE7B,MAAM,EAAE,kBAAkB;IAItC,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAEM,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAkBlC,QAAQ,CAAC,MAAM,EAAE,MAAM;IAE9B,OAAO,CAAC,OAAO;IAiBf,OAAO,CAAC,aAAa;IAUrB,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,YAAY;CAQrB"}
+{"version":3,"file":"controls.d.ts","sourceRoot":"","sources":["../../../../../src/objects/cameras/controls.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAI3D;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,CAAC;CACpC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,eAAgB,YAAW,cAAc;IACpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAC7C,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,UAAU,CAAuB;IAEzC;;;;OAIG;gBACS,MAAM,EAAE,kBAAkB;IAItC,yCAAyC;IACzC,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED;;;;;OAKG;IACI,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAkBzC;;;;OAIG;IACI,QAAQ,CAAC,MAAM,EAAE,MAAM;IAE9B,OAAO,CAAC,OAAO;IAiBf,OAAO,CAAC,aAAa;IAUrB,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,YAAY;CAQrB"}

package/dist/types/src/objects/cameras/orbit_controls.d.ts

@@ -2,14 +2,46 @@ import { CameraControls } from "./controls";
 import { EventContext } from "../../core/event_dispatcher";
 import { PerspectiveCamera } from "./perspective_camera";
 import { vec3 } from "gl-matrix";
+/**
+ * Initialization properties for constructing orbit controls.
+ */
 export type OrbitControlsProps = {
+    /** Distance from the target in world units. Defaults to `1`. */
     radius?: number;
+    /** Initial azimuth angle in radians. Defaults to `0`. */
     yaw?: number;
+    /** Initial elevation angle in radians. Defaults to `0`. */
     pitch?: number;
+    /** The point the camera orbits. Defaults to the origin. */
     target?: vec3;
+    /** Velocity decay rate between `0` and `1`. Defaults to `0.5`. */
     dampingFactor?: number;
 };
-/** @group Cameras & Controls */
+/**
+ * Camera controls for orbiting a perspective camera around a target.
+ *
+ * Dragging with the left mouse button orbits, dragging with `Shift` held
+ * or with the middle button pans the target, and the scroll wheel zooms by
+ * changing the orbit radius. Input adds velocity that damping decays over time.
+ *
+ * ```ts
+ * const camera = new PerspectiveCamera({ near: 1.0 });
+ *
+ * const idetik = new Idetik({
+ *   canvas,
+ *   viewports: [{
+ *     camera,
+ *     layers: [volumeLayer],
+ *     cameraControls: new OrbitControls(camera, {
+ *       radius: 100,
+ *       target: [40, 40, 10],
+ *     }),
+ *   }],
+ * });
+ * ```
+ *
+ * @group Controls
+ */
 export declare class OrbitControls implements CameraControls {
     private readonly camera_;
     private readonly orbitVelocity_;
@@ -18,13 +50,36 @@ export declare class OrbitControls implements CameraControls {
     private readonly currCenter_;
     private readonly dampingFactor_;
     private currMouseButton_;
+    /**
+     * Creates orbit controls and moves the camera to the initial pose.
+     *
+     * @param camera - The perspective camera to control.
+     * @param params - Initialization properties.
+     */
     constructor(camera: PerspectiveCamera, params?: OrbitControlsProps);
+    /** The current distance from the target in world units. */
     get radius(): number;
+    /** The current azimuth angle in radians. */
     get yaw(): number;
+    /** The current elevation angle in radians. */
     get pitch(): number;
+    /** A copy of the point the camera orbits. */
     get target(): vec3;
+    /** Whether any orbit, pan, or zoom velocity remains. */
     get isMoving(): boolean;
+    /**
+     * Handles a pointer or wheel event. Called automatically by the owning
+     * viewport unless a layer stops propagation.
+     *
+     * @param event - The event with clip and world coordinates attached.
+     */
     onEvent(event: EventContext): void;
+    /**
+     * Applies pending velocities to the camera and decays them toward zero.
+     * Called automatically by the render loop once per frame.
+     *
+     * @param dt - Time since the last frame in seconds.
+     */
     onUpdate(dt: number): void;
     private onPointerDown;
     private onPointerMove;

package/dist/types/src/objects/cameras/orbit_controls.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"orbit_controls.d.ts","sourceRoot":"","sources":["../../../../../src/objects/cameras/orbit_controls.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAGzD,OAAO,EAAY,IAAI,EAAE,MAAM,WAAW,CAAC;AAa3C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,gCAAgC;AAChC,qBAAa,aAAc,YAAW,cAAc;IAClD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;IAE5C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA0B;IACzD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAiB;IAE9C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAY;IACrC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAiB;IAE7C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IAExC,OAAO,CAAC,gBAAgB,CAAqB;gBAEjC,MAAM,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,kBAAkB;IAsBlE,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,IAAW,GAAG,IAAI,MAAM,CAEvB;IAED,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED,IAAW,MAAM,IAAI,IAAI,CAExB;IAED,IAAW,QAAQ,IAAI,OAAO,CAS7B;IAEM,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAkBlC,QAAQ,CAAC,EAAE,EAAE,MAAM;IAmC1B,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,OAAO;IAQf,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,KAAK;IAKb,OAAO,CAAC,GAAG;IAWX,OAAO,CAAC,IAAI;IAIZ,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,iBAAiB;CAU1B"}
+{"version":3,"file":"orbit_controls.d.ts","sourceRoot":"","sources":["../../../../../src/objects/cameras/orbit_controls.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAGzD,OAAO,EAAY,IAAI,EAAE,MAAM,WAAW,CAAC;AAa3C;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yDAAyD;IACzD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,kEAAkE;IAClE,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,aAAc,YAAW,cAAc;IAClD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;IAE5C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA0B;IACzD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAiB;IAE9C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAY;IACrC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAiB;IAE7C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IAExC,OAAO,CAAC,gBAAgB,CAAqB;IAE7C;;;;;OAKG;gBACS,MAAM,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,kBAAkB;IAsBlE,2DAA2D;IAC3D,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,4CAA4C;IAC5C,IAAW,GAAG,IAAI,MAAM,CAEvB;IAED,8CAA8C;IAC9C,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED,6CAA6C;IAC7C,IAAW,MAAM,IAAI,IAAI,CAExB;IAED,wDAAwD;IACxD,IAAW,QAAQ,IAAI,OAAO,CAS7B;IAED;;;;;OAKG;IACI,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAkBzC;;;;;OAKG;IACI,QAAQ,CAAC,EAAE,EAAE,MAAM;IAmC1B,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,OAAO;IAQf,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,KAAK;IAKb,OAAO,CAAC,GAAG;IAWX,OAAO,CAAC,IAAI;IAIZ,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,iBAAiB;CAU1B"}