@idetik/core 0.40.0 → 0.40.2

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

@@ -1,29 +1,70 @@
 import { Camera, CameraType } from "./camera";
 import { Box2 } from "../../math/box2";
 import { SliceOrientation } from "../../math/axes";
-type OrthographicCameraFrame = {
+/**
+ * A world-space rectangle for the camera to frame.
+ */
+export type OrthographicCameraFrame = {
+    /** Left edge of the view frame in world units. */
     left: number;
+    /** Right edge of the view frame in world units. */
     right: number;
+    /** Top edge of the view frame in world units. */
     top: number;
+    /** Bottom edge of the view frame in world units. */
     bottom: number;
 };
-type OrthographicCameraProps = OrthographicCameraFrame & {
+/**
+ * Initialization properties for constructing an orthographic camera.
+ */
+export type OrthographicCameraProps = {
+    /** Left edge of the view frame in world units. */
+    left: number;
+    /** Right edge of the view frame in world units. */
+    right: number;
+    /** Top edge of the view frame in world units. */
+    top: number;
+    /** Bottom edge of the view frame in world units. */
+    bottom: number;
+    /** Near clipping plane distance. Defaults to `-1e6`. */
     near?: number;
+    /** Far clipping plane distance. Defaults to `1e6`. */
     far?: number;
+    /** Slice orientation. Defaults to `"XY"`. */
     orientation?: SliceOrientation;
 };
 /**
  * A camera using an orthographic (parallel) projection.
  *
- * Orthographic projection has no perspective foreshortening, so object size is
- * independent of distance from the camera. This is the camera to use for 2D
- * image viewing, where it pairs naturally with {@link PanZoomControls}. The
- * initial frame is given in world coordinates; zoom and pan are applied as
- * scale and translation on top of that frame.
+ * Orthographic projection has no perspective foreshortening: objects render at
+ * the same size regardless of their distance from the camera, which makes this
+ * the camera to use for 2D image viewing. It pairs naturally with
+ * {@link PanZoomControls}.
+ *
+ * The constructor frames a world-space rectangle, typically the physical
+ * extent of the image being viewed. Zoom and pan are then applied as scale and
+ * translation on top of that frame, and {@link setFrame} resets them. When the
+ * viewport's aspect ratio differs from the frame's, the frame is padded rather
+ * than stretched, so image pixels always stay square.
  *
- * @see {@link PerspectiveCamera} for 3D scenes with perspective projection.
+ * ```ts
+ * const camera = new OrthographicCamera({
+ *  left: 0,
+ *  right: 1024,
+ *  top: 0,
+ *  bottom: 1024
+ * });
  *
- * @group Cameras & Controls
+ * const idetik = new Idetik({
+ *   canvas: document.querySelector('canvas')!,
+ *   viewports: [{
+ *     camera,
+ *     layers: [imageLayer],
+ *     cameraControls: new PanZoomControls(camera),
+ *   }],
+ * });
+ * ```
+ * @group Cameras
  */
 export declare class OrthographicCamera extends Camera {
     private width_;
@@ -36,25 +77,61 @@ export declare class OrthographicCamera extends Camera {
     /**
      * Creates an orthographic camera framing the given world-space rectangle.
      *
-     * @param props - The view frame edges in world units, near/far clipping
-     *   plane distances (default `-1e6` and `1e6`), and the slice orientation
-     *   the camera faces (default `"XY"`).
+     * @param props - Initialization properties.
      */
     constructor(props: OrthographicCameraProps);
+    /**
+     * The world-space size of the rendered view as `[width, height]`.
+     *
+     * This is the camera frame padded to match the viewport's aspect ratio, so
+     * it reflects what is actually visible rather than the frame that was set.
+     */
     get viewportSize(): [number, number];
+    /**
+     * 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.
+     */
     setAspectRatio(aspectRatio: number): void;
+    /**
+     * Reframes the camera to the given world-space rectangle, resetting any
+     * accumulated zoom and pan.
+     *
+     * The frame may be padded horizontally or vertically at render time to
+     * match the viewport's aspect ratio (see {@link viewportSize}).
+     *
+     * @param frame - The view frame edges in world units.
+     */
     setFrame({ left, right, top, bottom }: OrthographicCameraFrame): void;
+    /** Identifies the camera type as `OrthographicCamera`. */
     get type(): CameraType;
+    /** The slice orientation the camera faces. */
     get orientation(): SliceOrientation;
     /**
      * Changes the slice orientation the camera faces. The current frame and
      * zoom carry over numerically to the new plane axes. Call {@link setFrame}
      * to reframe the view for the new plane.
+     *
+     * @param orientation - The slice plane for the camera to face.
      */
     setOrientation(orientation: SliceOrientation): 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.
+     */
     zoom(factor: number): void;
+    /**
+     * Computes the world-space rectangle currently visible in the viewport,
+     * accounting for zoom, pan, and aspect-ratio padding.
+     *
+     * @returns The visible rectangle on the camera's slice plane.
+     */
     getWorldViewRect(): Box2;
+    /** @hidden */
     protected updateProjectionMatrix(): void;
 }
-export {};
 //# sourceMappingURL=orthographic_camera.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"orthographic_camera.d.ts","sourceRoot":"","sources":["../../../../../src/objects/cameras/orthographic_camera.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE9C,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAGL,gBAAgB,EAGjB,MAAM,iBAAiB,CAAC;AAQzB,KAAK,uBAAuB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,uBAAuB,GAAG,uBAAuB,GAAG;IACvD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,gBAAgB,CAAC;CAChC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,qBAAa,kBAAmB,SAAQ,MAAM;IAE5C,OAAO,CAAC,MAAM,CAAyB;IACvC,OAAO,CAAC,OAAO,CAA0B;IACzC,OAAO,CAAC,oBAAoB,CAAgC;IAC5D,OAAO,CAAC,aAAa,CAAqD;IAC1E,OAAO,CAAC,KAAK,CAAY;IACzB,OAAO,CAAC,SAAS,CAAO;IACxB,OAAO,CAAC,YAAY,CAAmB;IAEvC;;;;;;OAMG;gBACS,KAAK,EAAE,uBAAuB;IAW1C,IAAW,YAAY,qBAEtB;IAEM,cAAc,CAAC,WAAW,EAAE,MAAM;IAKlC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,uBAAuB;IAYrE,IAAW,IAAI,IAAI,UAAU,CAE5B;IAED,IAAW,WAAW,IAAI,gBAAgB,CAEzC;IAED;;;;OAIG;IACI,cAAc,CAAC,WAAW,EAAE,gBAAgB;IAoB5C,IAAI,CAAC,MAAM,EAAE,MAAM;IAQnB,gBAAgB,IAAI,IAAI;IAgB/B,SAAS,CAAC,sBAAsB;CA8BjC"}
+{"version":3,"file":"orthographic_camera.d.ts","sourceRoot":"","sources":["../../../../../src/objects/cameras/orthographic_camera.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE9C,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAGL,gBAAgB,EAGjB,MAAM,iBAAiB,CAAC;AAQzB;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,GAAG,EAAE,MAAM,CAAC;IACZ,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,GAAG,EAAE,MAAM,CAAC;IACZ,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC;IACf,wDAAwD;IACxD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sDAAsD;IACtD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,WAAW,CAAC,EAAE,gBAAgB,CAAC;CAChC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAAa,kBAAmB,SAAQ,MAAM;IAE5C,OAAO,CAAC,MAAM,CAAyB;IACvC,OAAO,CAAC,OAAO,CAA0B;IACzC,OAAO,CAAC,oBAAoB,CAAgC;IAC5D,OAAO,CAAC,aAAa,CAAqD;IAC1E,OAAO,CAAC,KAAK,CAAY;IACzB,OAAO,CAAC,SAAS,CAAO;IACxB,OAAO,CAAC,YAAY,CAAmB;IAEvC;;;;OAIG;gBACS,KAAK,EAAE,uBAAuB;IAW1C;;;;;OAKG;IACH,IAAW,YAAY,qBAEtB;IAED;;;;;OAKG;IACI,cAAc,CAAC,WAAW,EAAE,MAAM;IAKzC;;;;;;;;OAQG;IACI,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,uBAAuB;IAYrE,0DAA0D;IAC1D,IAAW,IAAI,IAAI,UAAU,CAE5B;IAED,8CAA8C;IAC9C,IAAW,WAAW,IAAI,gBAAgB,CAEzC;IAED;;;;;;OAMG;IACI,cAAc,CAAC,WAAW,EAAE,gBAAgB;IAoBnD;;;;;;OAMG;IACI,IAAI,CAAC,MAAM,EAAE,MAAM;IAQ1B;;;;;OAKG;IACI,gBAAgB,IAAI,IAAI;IAgB/B,cAAc;IACd,SAAS,CAAC,sBAAsB;CA8BjC"}

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

@@ -1,22 +1,84 @@
 import { Camera, CameraType } from "./camera";
 import { vec3 } from "gl-matrix";
-type PerspectiveCameraProps = {
+/**
+ * Initialization properties for constructing a perspective camera.
+ */
+export type PerspectiveCameraProps = {
+    /** Vertical field of view in degrees. Defaults to `60`. */
     fov?: number;
+    /** Aspect ratio (width / height). Defaults to `1.77`. */
     aspectRatio?: number;
+    /** Near clipping plane distance. Defaults to `0.1`. */
     near?: number;
+    /** Far clipping plane distance. Defaults to `10000`. */
     far?: number;
+    /** World-space camera position. Defaults to the origin. */
     position?: vec3;
 };
-/** @group Cameras & Controls */
+/**
+ * A camera using a perspective projection.
+ *
+ * Perspective projection applies foreshortening: objects appear smaller the
+ * farther they are from the camera, which makes this the camera to use for
+ * 3D scenes such as volume rendering. It pairs naturally with
+ * {@link OrbitControls}.
+ *
+ * The projection is defined by a vertical field of view, an aspect ratio,
+ * and near/far clipping planes. Zooming narrows or widens the field of view
+ * rather than moving the camera.
+ *
+ * ```ts
+ * const camera = new PerspectiveCamera({ fov: 45 });
+ *
+ * const controls = new OrbitControls(camera, {
+ *   radius: 1200,
+ *   target: [0, 0, 0],
+ * });
+ *
+ * const idetik = new Idetik({
+ *   canvas: document.querySelector('canvas')!,
+ *   viewports: [{ camera, layers: [volumeLayer], cameraControls: controls }],
+ * });
+ * ```
+ *
+ * @see {@link OrthographicCamera} for 2D image viewing with parallel
+ *   projection.
+ *
+ * @group Cameras
+ */
 export declare class PerspectiveCamera extends Camera {
     private fov_;
     private aspectRatio_;
+    /**
+     * Creates a perspective camera from the given projection settings.
+     *
+     * @param props - Initialization properties.
+     */
     constructor(props?: PerspectiveCameraProps);
+    /**
+     * 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.
+     */
     setAspectRatio(aspectRatio: number): void;
+    /** Identifies the camera type as `PerspectiveCamera`. */
     get type(): CameraType;
+    /** The vertical field of view in degrees. */
     get fov(): number;
+    /**
+     * 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.
+     *
+     * Zooming narrows or widens the field of view rather than moving the
+     * camera, and the result is clamped to valid angles.
+     *
+     * @param factor - The magnification factor to apply.
+     */
     zoom(factor: number): void;
+    /** @hidden */
     protected updateProjectionMatrix(): void;
 }
-export {};
 //# sourceMappingURL=perspective_camera.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"perspective_camera.d.ts","sourceRoot":"","sources":["../../../../../src/objects/cameras/perspective_camera.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAkB,IAAI,EAAE,MAAM,WAAW,CAAC;AAOjD,KAAK,sBAAsB,GAAG;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,IAAI,CAAC;CACjB,CAAC;AAEF,gCAAgC;AAChC,qBAAa,iBAAkB,SAAQ,MAAM;IAC3C,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,YAAY,CAAS;gBAEjB,KAAK,GAAE,sBAA2B;IAyBvC,cAAc,CAAC,WAAW,EAAE,MAAM;IAKzC,IAAW,IAAI,IAAI,UAAU,CAE5B;IAED,IAAW,GAAG,WAEb;IAEM,IAAI,CAAC,MAAM,EAAE,MAAM;IAS1B,SAAS,CAAC,sBAAsB;CASjC"}
+{"version":3,"file":"perspective_camera.d.ts","sourceRoot":"","sources":["../../../../../src/objects/cameras/perspective_camera.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAkB,IAAI,EAAE,MAAM,WAAW,CAAC;AAOjD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,yDAAyD;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wDAAwD;IACxD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,IAAI,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,iBAAkB,SAAQ,MAAM;IAC3C,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,YAAY,CAAS;IAE7B;;;;OAIG;gBACS,KAAK,GAAE,sBAA2B;IAyB9C;;;;;;OAMG;IACI,cAAc,CAAC,WAAW,EAAE,MAAM;IAKzC,yDAAyD;IACzD,IAAW,IAAI,IAAI,UAAU,CAE5B;IAED,6CAA6C;IAC7C,IAAW,GAAG,WAEb;IAED;;;;;;;;;OASG;IACI,IAAI,CAAC,MAAM,EAAE,MAAM;IAS1B,cAAc;IACd,SAAS,CAAC,sBAAsB;CASjC"}

package/dist/types/src/objects/renderable/image_renderable.d.ts

@@ -2,10 +2,17 @@ import { RenderableObject } from "../../core/renderable_object";
 import { Texture } from "../../objects/textures/texture";
 import { ChannelProps } from "../../core/channel";
 import { mat4, vec3 } from "gl-matrix";
-type ImageRenderableProps = {
+/**
+ * Initialization properties for constructing an image renderable.
+ */
+export type ImageRenderableProps = {
+    /** Width of the image in texels. */
     width: number;
+    /** Height of the image in texels. */
     height: number;
+    /** The scalar image texture to draw. */
     texture: Texture;
+    /** Channel appearance settings. Defaults to `[]`. */
     channelProps?: ChannelProps[];
 };
 type UniformValues = {
@@ -16,14 +23,52 @@ type UniformValues = {
     u_valueScale: number;
     u_worldToTexCoord: mat4;
 };
-/** @group Renderable Objects */
+/**
+ * A textured plane that draws one 2D slice of scalar image data.
+ *
+ * Image renderable maps a scalar texture through a single channel's
+ * color, contrast limits, and opacity. {@link ImageLayer} constructs and
+ * pools one instance per visible chunk, so most applications never create
+ * these directly.
+ *
+ * @group Renderables
+ */
 export declare class ImageRenderable extends RenderableObject {
-    private channels_;
+    /**
+     * A matrix mapping world space to the texture's normalized coordinate
+     * space. Layers derive it from the chunk's offset, scale, and shape.
+     */
     worldToTexCoord: mat4;
+    private channels_;
+    /**
+     * Creates an image renderable drawing the given texture. The texture's
+     * data type selects the matching scalar image shader.
+     *
+     * @param props - Initialization properties.
+     */
     constructor({ width, height, texture, channelProps, }: ImageRenderableProps);
+    /** Identifies the renderable type as `ImageRenderable`. */
     get type(): string;
+    /**
+     * Replaces the channel appearance settings and revalidates them
+     * against the current texture. Only the first entry affects rendering.
+     *
+     * @param channels - The new channel settings.
+     */
     setChannelProps(channels: ChannelProps[]): void;
+    /**
+     * Updates one property of the channel at the given index and
+     * revalidates the channel against the current texture.
+     *
+     * @param channelIndex - The channel to update.
+     * @param property - The property name to set.
+     * @param value - The new value.
+     */
     setChannelProperty<K extends keyof ChannelProps>(channelIndex: number, property: K, value: Required<ChannelProps>[K]): void;
+    /**
+     * Returns the sampler, contrast, color, opacity, and world-to-texture
+     * uniforms for the scalar image shaders.
+     */
     getUniforms(): UniformValues;
 }
 export {};

package/dist/types/src/objects/renderable/image_renderable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"image_renderable.d.ts","sourceRoot":"","sources":["../../../../../src/objects/renderable/image_renderable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAEhE,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAEL,YAAY,EAGb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGvC,KAAK,oBAAoB,GAAG;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC;CAC/B,CAAC;AAEF,KAAK,aAAa,GAAG;IACnB,OAAO,EAAE,IAAI,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,IAAI,CAAC;CACzB,CAAC;AAEF,gCAAgC;AAChC,qBAAa,eAAgB,SAAQ,gBAAgB;IACnD,OAAO,CAAC,SAAS,CAAsB;IAEhC,eAAe,EAAE,IAAI,CAAiB;gBAEjC,EACV,KAAK,EACL,MAAM,EACN,OAAO,EACP,YAAiB,GAClB,EAAE,oBAAoB;IASvB,IAAW,IAAI,WAEd;IAEM,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE;IAIxC,kBAAkB,CAAC,CAAC,SAAS,MAAM,YAAY,EACpD,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,CAAC,EACX,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAUlB,WAAW,IAAI,aAAa;CAkB7C"}
+{"version":3,"file":"image_renderable.d.ts","sourceRoot":"","sources":["../../../../../src/objects/renderable/image_renderable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAEhE,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAEL,YAAY,EAGb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGvC;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,OAAO,EAAE,OAAO,CAAC;IACjB,qDAAqD;IACrD,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC;CAC/B,CAAC;AAEF,KAAK,aAAa,GAAG;IACnB,OAAO,EAAE,IAAI,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,IAAI,CAAC;CACzB,CAAC;AAEF;;;;;;;;;GASG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB;IACnD;;;OAGG;IACI,eAAe,EAAE,IAAI,CAAiB;IAE7C,OAAO,CAAC,SAAS,CAAsB;IAEvC;;;;;OAKG;gBACS,EACV,KAAK,EACL,MAAM,EACN,OAAO,EACP,YAAiB,GAClB,EAAE,oBAAoB;IASvB,2DAA2D;IAC3D,IAAW,IAAI,WAEd;IAED;;;;;OAKG;IACI,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE;IAI/C;;;;;;;OAOG;IACI,kBAAkB,CAAC,CAAC,SAAS,MAAM,YAAY,EACpD,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,CAAC,EACX,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAUlC;;;OAGG;IACa,WAAW,IAAI,aAAa;CAkB7C"}

package/dist/types/src/objects/renderable/label_image_renderable.d.ts

@@ -2,30 +2,80 @@ import { RenderableObject } from "../../core/renderable_object";
 import { mat4 } from "gl-matrix";
 import { Texture } from "../../objects/textures/texture";
 import { Color, ColorLike } from "../../math/color";
+/**
+ * Color assignments for label values.
+ *
+ * Values present in `lookupTable` use its color. Any other value takes a
+ * color from `cycle` by index. Value `0` renders transparent unless the
+ * lookup table assigns it a color.
+ */
 export type LabelColorMapProps = {
+    /** Exact colors for specific label values. */
     lookupTable?: ReadonlyMap<number, ColorLike>;
+    /** Colors cycled by value. Defaults to 6 built-ins. */
     cycle?: ReadonlyArray<ColorLike>;
 };
+/**
+ * A validated color map with every entry resolved to a {@link Color}.
+ * Returned by {@link LabelLayer.colorMap}.
+ */
 export type LabelColorMap = {
+    /** Exact colors for specific label values. */
     readonly lookupTable: ReadonlyMap<number, Color>;
+    /** Colors cycled by value. */
     readonly cycle: ReadonlyArray<Color>;
 };
 export declare function validateColorMap(props?: LabelColorMapProps): LabelColorMap;
-type LabelImageRenderableProps = {
+/**
+ * Initialization properties for constructing a label image renderable.
+ */
+export type LabelImageRenderableProps = {
+    /** Width of the label image in texels. */
     width: number;
+    /** Height of the label image in texels. */
     height: number;
+    /** Scalar integer texture of label values. */
     imageData: Texture;
+    /** Colors to apply to label values. */
     colorMap: LabelColorMapProps;
+    /** Outlines the selected value. Defaults to `false`. */
     outlineSelected?: boolean;
+    /** The selected label value. Defaults to `null`. */
     selectedValue?: number | null;
 };
-/** @group Renderable Objects */
+/**
+ * A textured plane that draws one 2D slice of integer label data.
+ *
+ * Each label value is colored through a {@link LabelColorMap}. Values in
+ * the lookup table use its color, other values take a color from the
+ * cycle, and value `0` renders transparent unless the lookup table covers
+ * it. The image texture must hold scalar integer data. {@link LabelLayer}
+ * constructs and pools one instance per visible chunk, so most
+ * applications configure labels through the layer instead.
+ *
+ * @group Renderables
+ */
 export declare class LabelImageRenderable extends RenderableObject {
+    /**
+     * A matrix mapping world space to the texture's normalized coordinate
+     * space. Layers derive it from the chunk's offset, scale, and shape.
+     */
+    worldToTexCoord: mat4;
     private outlineSelected_;
     private selectedValue_;
-    worldToTexCoord: mat4;
+    /**
+     * Creates a label renderable drawing the given label texture. The
+     * texture's data type selects the matching label shader.
+     *
+     * @param props - Initialization properties.
+     */
     constructor(props: LabelImageRenderableProps);
+    /** Identifies the renderable type as `LabelImageRenderable`. */
     get type(): string;
+    /**
+     * Returns the sampler, color map, and selection uniforms for the label
+     * image shaders.
+     */
     getUniforms(): {
         u_imageSampler: number;
         u_colorCycleSampler: number;
@@ -34,10 +84,22 @@ export declare class LabelImageRenderable extends RenderableObject {
         u_selectedValue: number;
         u_worldToTexCoord: mat4;
     };
+    /**
+     * Replaces the label color map. The previous color map textures are
+     * marked stale for GPU disposal.
+     *
+     * @param colorMap - The new color map.
+     */
     setColorMap(colorMap: LabelColorMapProps): void;
+    /**
+     * Sets the label value drawn as selected or `null` to clear the
+     * selection. The selected region is outlined when the renderable was
+     * constructed with `outlineSelected`.
+     *
+     * @param value - The label value to select.
+     */
     setSelectedValue(value: number | null): void;
     private makeColorCycleTexture;
     private makeColorLookupTableTexture;
 }
-export {};
 //# sourceMappingURL=label_image_renderable.d.ts.map

package/dist/types/src/objects/renderable/label_image_renderable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"label_image_renderable.d.ts","sourceRoot":"","sources":["../../../../../src/objects/renderable/label_image_renderable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAEhE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,OAAO,EAAmB,MAAM,gCAAgC,CAAC;AAC1E,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AA8BpD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC7C,KAAK,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACjD,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;CACtC,CAAC;AAEF,wBAAgB,gBAAgB,CAC9B,KAAK,GAAE,kBAAuB,GAC7B,aAAa,CAKf;AAED,KAAK,yBAAyB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B,CAAC;AA8BF,gCAAgC;AAChC,qBAAa,oBAAqB,SAAQ,gBAAgB;IACxD,OAAO,CAAC,gBAAgB,CAAU;IAClC,OAAO,CAAC,cAAc,CAAgB;IAE/B,eAAe,EAAE,IAAI,CAAiB;gBAEjC,KAAK,EAAE,yBAAyB;IAa5C,IAAW,IAAI,WAEd;IAEM,WAAW;;;;;;;;IAWX,WAAW,CAAC,QAAQ,EAAE,kBAAkB;IAQxC,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI5C,OAAO,CAAC,qBAAqB;IAS7B,OAAO,CAAC,2BAA2B;CAgBpC"}
+{"version":3,"file":"label_image_renderable.d.ts","sourceRoot":"","sources":["../../../../../src/objects/renderable/label_image_renderable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAEhE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,OAAO,EAAmB,MAAM,gCAAgC,CAAC;AAC1E,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AA8BpD;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,8CAA8C;IAC9C,WAAW,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC7C,uDAAuD;IACvD,KAAK,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;CAClC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,8CAA8C;IAC9C,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACjD,8BAA8B;IAC9B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;CACtC,CAAC;AAEF,wBAAgB,gBAAgB,CAC9B,KAAK,GAAE,kBAAuB,GAC7B,aAAa,CAKf;AAED;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,SAAS,EAAE,OAAO,CAAC;IACnB,uCAAuC;IACvC,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,wDAAwD;IACxD,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,oDAAoD;IACpD,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B,CAAC;AA8BF;;;;;;;;;;;GAWG;AACH,qBAAa,oBAAqB,SAAQ,gBAAgB;IACxD;;;OAGG;IACI,eAAe,EAAE,IAAI,CAAiB;IAE7C,OAAO,CAAC,gBAAgB,CAAU;IAClC,OAAO,CAAC,cAAc,CAAgB;IAEtC;;;;;OAKG;gBACS,KAAK,EAAE,yBAAyB;IAa5C,gEAAgE;IAChE,IAAW,IAAI,WAEd;IAED;;;OAGG;IACI,WAAW;;;;;;;;IAWlB;;;;;OAKG;IACI,WAAW,CAAC,QAAQ,EAAE,kBAAkB;IAQ/C;;;;;;OAMG;IACI,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI5C,OAAO,CAAC,qBAAqB;IAS7B,OAAO,CAAC,2BAA2B;CAgBpC"}

package/dist/types/src/objects/renderable/points_renderable.d.ts

@@ -2,15 +2,60 @@ import { vec3 } from "gl-matrix";
 import { ColorLike } from "../../math/color";
 import { RenderableObject } from "../../core/renderable_object";
 type Marker = "circle" | "square" | "triangle";
-type PointProps = {
+/**
+ * Initialization properties for a point in {@link PointsRenderable}.
+ */
+export type PointProps = {
+    /** World-space position of the point. */
     position: vec3;
+    /** Fill color of the marker. */
     color: ColorLike;
+    /** Marker size in pixels. */
     size: number;
+    /** Marker shape. */
     marker: Marker;
 };
-/** @group Renderable Objects */
+/**
+ * A set of point markers drawn as screen-space sprites.
+ *
+ * Each point has a world-space position, a color, a size in pixels, and a
+ * marker shape. All instances share a single marker sprite atlas. The
+ * point set is fixed at construction, so build a new instance to change
+ * it. Construct these directly inside a custom {@link Layer}.
+ *
+ * ```ts
+ * class Particles extends Layer {
+ *   public readonly type = "Particles";
+ *
+ *   constructor(positions: vec3[]) {
+ *     super();
+ *     this.addObject(
+ *       new PointsRenderable(
+ *         positions.map((position) => ({
+ *           position,
+ *           color: Color.RED,
+ *           size: 20,
+ *           marker: "circle" as const,
+ *         }))
+ *       )
+ *     );
+ *     this.setState("ready");
+ *   }
+ *
+ *   public update() {}
+ * }
+ * ```
+ *
+ * @group Renderables
+ */
 export declare class PointsRenderable extends RenderableObject {
+    /**
+     * Creates a renderable drawing one marker per entry.
+     *
+     * @param points - The points to draw.
+     */
     constructor(points: PointProps[]);
+    /** Identifies the renderable type as `PointsRenderable`. */
     get type(): string;
 }
 export {};

package/dist/types/src/objects/renderable/points_renderable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"points_renderable.d.ts","sourceRoot":"","sources":["../../../../../src/objects/renderable/points_renderable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAS,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAIhE,KAAK,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;AAS/C,KAAK,UAAU,GAAG;IAChB,QAAQ,EAAE,IAAI,CAAC;IACf,KAAK,EAAE,SAAS,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,gCAAgC;AAChC,qBAAa,gBAAiB,SAAQ,gBAAgB;gBACxC,MAAM,EAAE,UAAU,EAAE;IA8ChC,IAAW,IAAI,WAEd;CACF"}
+{"version":3,"file":"points_renderable.d.ts","sourceRoot":"","sources":["../../../../../src/objects/renderable/points_renderable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAS,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAIhE,KAAK,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;AAS/C;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,yCAAyC;IACzC,QAAQ,EAAE,IAAI,CAAC;IACf,gCAAgC;IAChC,KAAK,EAAE,SAAS,CAAC;IACjB,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAAa,gBAAiB,SAAQ,gBAAgB;IACpD;;;;OAIG;gBACS,MAAM,EAAE,UAAU,EAAE;IA8ChC,4DAA4D;IAC5D,IAAW,IAAI,WAEd;CACF"}

package/dist/types/src/objects/renderable/projected_line_renderable.d.ts

@@ -1,25 +1,49 @@
 import { RenderableObject } from "../../core/renderable_object";
 import { ProjectedLineGeometry } from "../../objects/geometry/projected_line_geometry";
 import { Color, ColorLike } from "../../math/color";
-type ProjectedLineRenderableProps = {
+/**
+ * Initialization properties for constructing a projected line renderable.
+ */
+export type ProjectedLineRenderableProps = {
+    /** The line path geometry to draw. */
     geometry: ProjectedLineGeometry;
+    /** The line color. */
     color: ColorLike;
+    /** Line width in pixels. */
     width: number;
 };
-/** @group Renderable Objects */
+/**
+ * A polyline drawn with a constant screen-space width.
+ *
+ * The line is extruded in the vertex shader so its width stays fixed in
+ * pixels at any zoom level. Custom layers can construct it directly for
+ * paths and outlines.
+ *
+ * @group Renderables
+ */
 export declare class ProjectedLineRenderable extends RenderableObject {
     private color_;
     private width_;
+    /**
+     * Creates a projected line renderable for the given path geometry.
+     *
+     * @param props - Initialization properties.
+     */
     constructor({ geometry, color, width }: ProjectedLineRenderableProps);
+    /** Identifies the renderable type as `ProjectedLineRenderable`. */
     get type(): string;
+    /** The line color. Assignable from any {@link ColorLike} value. */
     get color(): Color;
+    /** @param value - The new line color. */
     set color(value: ColorLike);
+    /** The line width in pixels. */
     get width(): number;
+    /** @param value - The new width in pixels. */
     set width(value: number);
+    /** Returns the color and width uniforms for the line shader. */
     getUniforms(): {
         u_lineColor: [number, number, number];
         u_lineWidth: number;
     };
 }
-export {};
 //# sourceMappingURL=projected_line_renderable.d.ts.map

package/dist/types/src/objects/renderable/projected_line_renderable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"projected_line_renderable.d.ts","sourceRoot":"","sources":["../../../../../src/objects/renderable/projected_line_renderable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAAE,MAAM,gDAAgD,CAAC;AACvF,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAEpD,KAAK,4BAA4B,GAAG;IAClC,QAAQ,EAAE,qBAAqB,CAAC;IAChC,KAAK,EAAE,SAAS,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,gCAAgC;AAChC,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC3D,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,MAAM,CAAS;gBAEX,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,4BAA4B;IASpE,IAAW,IAAI,WAEd;IAED,IAAW,KAAK,IAAI,KAAK,CAExB;IAED,IAAW,KAAK,CAAC,KAAK,EAAE,SAAS,EAEhC;IAED,IAAW,KAAK,IAIQ,MAAM,CAF7B;IAED,IAAW,KAAK,CAAC,KAAK,EAAE,MAAM,EAE7B;IAEe,WAAW;;;;CAM5B"}
+{"version":3,"file":"projected_line_renderable.d.ts","sourceRoot":"","sources":["../../../../../src/objects/renderable/projected_line_renderable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAAE,MAAM,gDAAgD,CAAC;AACvF,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,sCAAsC;IACtC,QAAQ,EAAE,qBAAqB,CAAC;IAChC,sBAAsB;IACtB,KAAK,EAAE,SAAS,CAAC;IACjB,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;GAQG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC3D,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,MAAM,CAAS;IAEvB;;;;OAIG;gBACS,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,4BAA4B;IASpE,mEAAmE;IACnE,IAAW,IAAI,WAEd;IAED,mEAAmE;IACnE,IAAW,KAAK,IAAI,KAAK,CAExB;IAED,yCAAyC;IACzC,IAAW,KAAK,CAAC,KAAK,EAAE,SAAS,EAEhC;IAED,gCAAgC;IAChC,IAAW,KAAK,IAKQ,MAAM,CAH7B;IAED,8CAA8C;IAC9C,IAAW,KAAK,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED,gEAAgE;IAChD,WAAW;;;;CAM5B"}