@objectifthunes/react-three-book 0.2.0 → 0.2.2

package/dist/index.d.ts

@@ -445,6 +445,13 @@ export declare class Cylinder {
  */
 export declare function drawImageWithFit(ctx: CanvasRenderingContext2D, image: HTMLImageElement, x: number, y: number, width: number, height: number, fit: ImageFitMode): void;
 
+/**
+ * Returns the 0-indexed page indices where a spread can start.
+ * In a staple-bound book, facing page pairs are (1,2), (3,4), (5,6), …
+ * — i.e. odd indices where i+1 < pageCount.
+ */
+export declare function getSpreadPairs(pageCount: number): number[];
+
 /** Minimal Book interface consumed by the binding. */
 declare interface IBook {
     readonly totalThickness: number;
@@ -1009,6 +1016,52 @@ export declare class RendererFactory {
     getBounds(): THREE.Box3;
 }
 
+export declare class SpreadContent {
+    readonly canvas: HTMLCanvasElement;
+    readonly texts: TextBlock[];
+    readonly left: IPageContent;
+    readonly right: IPageContent;
+    /** Width of a single page in pixels. */
+    readonly pageWidth: number;
+    /** Height of a single page in pixels. */
+    readonly pageHeight: number;
+    private readonly ctx;
+    private readonly _texture;
+    private _source;
+    get texture(): THREE.Texture;
+    /** The base layer drawn beneath text blocks (full spread width). */
+    get source(): HTMLCanvasElement | HTMLImageElement | null;
+    set source(v: HTMLCanvasElement | HTMLImageElement | null);
+    constructor(options?: SpreadContentOptions);
+    addText(options?: TextBlockOptions): TextBlock;
+    removeText(text: TextBlock): void;
+    /** Update a text block by index. Only provided fields are changed. */
+    updateText(index: number, options: Partial<TextBlockOptions>): void;
+    /**
+     * Re-composite the canvas: source layer + text blocks.
+     * Call every frame (or when content changes).
+     *
+     * @param root  Optional THREE.Object3D to traverse for texture sync
+     *              (needed because three-book clones material textures).
+     */
+    update(root?: THREE.Object3D): void;
+    /**
+     * Traverse `root` and set `needsUpdate = true` on every material map whose
+     * source image is this spread's canvas.
+     */
+    syncMaterials(root: THREE.Object3D): void;
+    dispose(): void;
+}
+
+export declare interface SpreadContentOptions {
+    /** Width of a single page in pixels. The spread canvas will be 2x this. */
+    pageWidth?: number;
+    /** Height of a single page in pixels. */
+    pageHeight?: number;
+    /** Source canvas or image to draw as the base layer (full spread width). */
+    source?: HTMLCanvasElement | HTMLImageElement | null;
+}
+
 export declare class SpritePageContent2 implements IPageContent {
     private m_Texture;
     private m_TextureST;