@idetik/core 0.40.0 → 0.40.2

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

@@ -2,29 +2,89 @@ import { RenderableObject } from "../../core/renderable_object";
 import { ChannelProps } from "../../core/channel";
 import { vec3 } from "gl-matrix";
 import type { Chunk } from "../../data/chunk";
-type VolumeRenderableProps = {
+/**
+ * Initialization properties for constructing a volume renderable.
+ */
+export type VolumeRenderableProps = {
+    /** Channel appearance settings. Defaults to `[]`. */
     channelProps?: ChannelProps[];
 };
-/** @group Renderable Objects */
+/**
+ * A ray-marched box that draws multi-channel volumetric data.
+ *
+ * The renderable draws a unit box and ray marches through 3D chunk
+ * textures in the fragment shader. Up to 4 channels blend in a single
+ * pass and all loaded channels must share one texture data type. Front
+ * faces are culled and depth testing is off by default.
+ * {@link VolumeLayer} constructs and pools one instance per spatial chunk
+ * group, streams chunk textures in with {@link updateVolumeWithChunk},
+ * and sizes the box through the transform.
+ *
+ * @group Renderables
+ */
 export declare class VolumeRenderable extends RenderableObject {
+    /**
+     * World size of a voxel along each axis. Layers set it from the chunk
+     * scale so ray march steps account for anisotropic voxels. Defaults to
+     * `[1, 1, 1]`.
+     */
     voxelScale: vec3;
     private channels_;
     private loadedChannels_;
     private readonly channelToTextureIndex_;
+    /**
+     * Creates an empty volume renderable.
+     *
+     * @param props - Initialization properties.
+     */
     constructor({ channelProps }?: VolumeRenderableProps);
+    /** Identifies the renderable type as `VolumeRenderable`. */
     get type(): string;
+    /**
+     * Loads or refreshes the texture for the chunk's channel. The channel
+     * index comes from the chunk and the texture's data type selects the
+     * volume shader, so every channel must share one data type. Chunks
+     * without a texture are ignored.
+     *
+     * @param chunk - The chunk holding the channel texture.
+     */
     updateVolumeWithChunk(chunk: Chunk): void;
     private addChannelTexture;
     private updateChannelTexture;
+    /**
+     * Marks all channels as not loaded so they stop rendering until the
+     * next chunk update. The textures themselves are kept.
+     */
     clearLoadedChannels(): void;
+    /**
+     * Clears all textures and channel state so the renderable can be
+     * pooled and reused for another chunk.
+     */
     reset(): void;
+    /**
+     * Returns per-channel sampler, color, contrast, opacity, and
+     * visibility uniforms for up to 4 loaded channels plus the voxel
+     * scale.
+     */
     getUniforms(): Record<string, number[] | number>;
     /**
      * Get an available texture for a channel. If desiredChannelIndex is provided, it will try to return the texture for that channel index. If that texture is not available, or no desiredChannelIndex is passed, return the first available channel texture. This is used to determine which texture to use when updating channel properties, since channel properties can be updated even if the channel's texture hasn't been loaded yet. If no textures are available, it returns null, which signals that default contrast limits should be used when validating the channel properties.
      */
     private getAvailableChannelTexture;
+    /**
+     * Replaces the appearance settings for all channels.
+     *
+     * @param channels - The new channel settings.
+     */
     setChannelProps(channels: ChannelProps[]): void;
+    /**
+     * Updates one property of the channel at the given index and
+     * revalidates it against the channel's texture when available.
+     *
+     * @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;
 }
-export {};
 //# sourceMappingURL=volume_renderable.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"volume_renderable.d.ts","sourceRoot":"","sources":["../../../../../src/objects/renderable/volume_renderable.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAGhE,OAAO,EAEL,YAAY,EAGb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAE9C,KAAK,qBAAqB,GAAG;IAC3B,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC;CAC/B,CAAC;AAEF,gCAAgC;AAChC,qBAAa,gBAAiB,SAAQ,gBAAgB;IAC7C,UAAU,EAAE,IAAI,CAA4B;IAEnD,OAAO,CAAC,SAAS,CAAsB;IACvC,OAAO,CAAC,eAAe,CAA0B;IAEjD,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAkC;gBAE7D,EAAE,YAAiB,EAAE,GAAE,qBAA0B;IAS7D,IAAW,IAAI,WAEd;IAEM,qBAAqB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAehD,OAAO,CAAC,iBAAiB;IAgBzB,OAAO,CAAC,oBAAoB;IAIrB,mBAAmB;IAInB,KAAK;IAMI,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IA8DhE;;OAEG;IACH,OAAO,CAAC,0BAA0B;IAc3B,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE;IAOxC,kBAAkB,CAAC,CAAC,SAAS,MAAM,YAAY,EACpD,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,CAAC,EACX,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;CAYnC"}
+{"version":3,"file":"volume_renderable.d.ts","sourceRoot":"","sources":["../../../../../src/objects/renderable/volume_renderable.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAGhE,OAAO,EAEL,YAAY,EAGb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,qDAAqD;IACrD,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC;CAC/B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,qBAAa,gBAAiB,SAAQ,gBAAgB;IACpD;;;;OAIG;IACI,UAAU,EAAE,IAAI,CAA4B;IAEnD,OAAO,CAAC,SAAS,CAAsB;IACvC,OAAO,CAAC,eAAe,CAA0B;IAEjD,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAkC;IAEzE;;;;OAIG;gBACS,EAAE,YAAiB,EAAE,GAAE,qBAA0B;IAS7D,4DAA4D;IAC5D,IAAW,IAAI,WAEd;IAED;;;;;;;OAOG;IACI,qBAAqB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAehD,OAAO,CAAC,iBAAiB;IAgBzB,OAAO,CAAC,oBAAoB;IAI5B;;;OAGG;IACI,mBAAmB;IAI1B;;;OAGG;IACI,KAAK;IAMZ;;;;OAIG;IACa,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IA8DhE;;OAEG;IACH,OAAO,CAAC,0BAA0B;IAclC;;;;OAIG;IACI,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE;IAO/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;CAYnC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@idetik/core",
-  "version": "0.40.0",
+  "version": "0.40.2",
   "type": "module",
   "private": false,
   "repository": {