@micrio/client 7.0.9 → 7.0.11

package/micrio.min.d.ts

@@ -711,7 +711,7 @@ declare module '@micrio/client' {
 		        archive?: string;
 		        archiveLayerOffset?: number;
 		        revisions?: Record<string, Record<string, any>>;
-		        settings?: Partial<ImageInfo.Settings>;
+		        settings?: Record<string, any>;
 		        id?: string;
 		        name?: string;
 		        grid?: {
@@ -1852,6 +1852,10 @@ declare module '@micrio/client' {
     export const VIEWPORT_MARGIN_PCT = 0.05;
     /** Default camera polar angle in radians (0 = side view, π/2 = directly overhead) */
     export const DEFAULT_CAMERA_PHI: number;
+    /** When true, page margins without a texture are discarded instead of drawn as
+     * transparent: they no longer block the pages behind them and you can see
+     * through to the underlying spread. */
+    export const SEE_THROUGH_MARGINS = false;
     /** RGB tint for the front face of each page */
     export const FRONT_COLOR: [number, number, number];
     /** RGB tint for the back face of each page */
@@ -2029,11 +2033,20 @@ declare module '@micrio/client' {
     export class PaperRenderer {
         #private;
         _tiltShiftEnabled: boolean;
+        /** When true, page margins without a texture are discarded (see-through) instead of drawn as transparent, so pages behind remain visible. */
+        _seeThroughMargins: boolean;
         constructor(gl: WebGL2RenderingContext);
         _initialize(meshes: PaperMesh[]): void;
         _setPageTextures(pageIndex: number, frontBitmap: TexImageSource, backBitmap: TexImageSource): void;
         _setPageHiResTexture(pageIdx: number, side: 0 | 1, slot: 0 | 1, bitmap: ImageBitmap): void;
         _setPageBlend(pageIdx: number, frontBlendA: number, frontBlendB: number, backBlendA: number, backBlendB: number): void;
+        /**
+         * Sets the per-page texture regions (see the fragment shader): each page's
+         * front/back texture only occupies a sub-rectangle `[uMin, vMin, fU, fV]` of
+         * the page UV space. Pass regions of `(0, 0, 1, 1)` to stretch textures over
+         * the whole page. Each array has `4 · pageCount` floats.
+         */
+        _setAspectRegions(frontRegions: Float32Array, backRegions: Float32Array): void;
         _evictPageHiRes(pageIdx: number, side: 0 | 1, slot: 0 | 1): void;
         _getCanvas(): HTMLCanvasElement;
         _setLightingPreset(name: string, params: Record<string, number>): void;
@@ -2143,8 +2156,8 @@ declare module '@micrio/client' {
         _gravity: number;
         _gravityEnabled: boolean;
     }
-    export function isWasmReady(): boolean;
-    export function initWasmSolver(meshes: PaperMesh[], pageCount: number): Promise<void>;
+    export function isSolverReady(): boolean;
+    export function initSolver(meshes: PaperMesh[], pageCount: number): Promise<void>;
     export function dispatchSolve(subDt: number, activeIndices: number[], substeps: number, solverSettings: SolverSettings, meshes: PaperMesh[], progress: Float32Array, totalStackHeight: number, pageCount: number, pageThickness: number): void;
 
     export class IIIFTextureManager {
@@ -2184,6 +2197,18 @@ declare module '@micrio/client' {
         /** World-space direction of increasing image v (not normalized). */
         _tangentV: Vec3;
     }
+    /**
+     * The sub-rectangle of a page's UV space in which a texture is displayed with
+     * its native aspect ratio. `uMin`/`vMin` are the lower-left corner and
+     * `fU`/`fV` the fraction of the page's u/v range the texture occupies. A region
+     * of `(0, 0, 1, 1)` stretches the texture over the whole page.
+     */
+    export interface TexRegion {
+        uMin: number;
+        vMin: number;
+        fU: number;
+        fV: number;
+    }
     /**
      * Returns the world-space position, surface normal and UV tangents of a
      * relative texture coordinate (u, v) on a page mesh, using the mesh's *current*
@@ -2194,14 +2219,18 @@ declare module '@micrio/client' {
      *   1 = back face (sampled with the U axis mirrored on a single-grid PaperMesh,
      *       or on the separate back-face grid of a CoverMesh).
      *
+     * `region` restricts the image to a sub-rectangle of the page (see
+     * {@link TexRegion}); the tangents are scaled accordingly. When omitted the
+     * image is stretched over the whole page.
+     *
      * Returns null when (u, v) falls outside [0, 1].
      */
-    export function uvToWorldPosition(mesh: PaperMesh, u: number, v: number, side: 0 | 1): UvWorldResult | null;
+    export function uvToWorldPosition(mesh: PaperMesh, u: number, v: number, side: 0 | 1, region?: TexRegion | null): UvWorldResult | null;
     /**
      * Like `uvToWorldPosition` but returns only the interpolated world-space
      * position, skipping the surface normal and tangent computation.
      */
-    export function sampleMeshPosition(mesh: PaperMesh, u: number, v: number, side: 0 | 1): Vec3 | null;
+    export function sampleMeshPosition(mesh: PaperMesh, u: number, v: number, side: 0 | 1, region?: TexRegion | null): Vec3 | null;
     /**
      * Projects a world-space point through the given view-projection matrix to CSS
      * pixel coordinates relative to the canvas top-left. Returns null when the point
@@ -2237,6 +2266,10 @@ declare module '@micrio/client' {
         _tiltShift?: boolean;
         _lightingPreset?: string;
         _useIndividualAspects?: boolean;
+        /** When true, page margins without a texture are discarded instead of drawn as
+         * transparent: they no longer block the pages behind them and you can see
+         * through to the underlying spread. */
+        _seeThroughMargins?: boolean;
         _startPageIdx?: number;
         /** Base URL for the IIIF image server (hi-res streaming). */
         _iiifBaseUrl?: string;