@objectifthunes/three-book 0.1.5 → 0.2.1

package/dist/TextBlock.d.ts

@@ -0,0 +1,66 @@
+/**
+ * A styled text block rendered onto a 2D canvas.
+ *
+ * Positions and dimensions are in canvas pixels.  Word-wrapping is handled
+ * manually via `ctx.measureText()` when `width` > 0.
+ */
+export interface TextBlockOptions {
+    /** Left edge of the text box in canvas pixels. */
+    x?: number;
+    /** Top edge of the text box in canvas pixels. */
+    y?: number;
+    /** Maximum width before wrapping.  0 = no wrapping (default 0). */
+    width?: number;
+    /** Text content. */
+    text?: string;
+    /** Font family (default 'Georgia'). */
+    fontFamily?: string;
+    /** Font size in canvas pixels (default 24). */
+    fontSize?: number;
+    /** Font weight (default 'normal'). */
+    fontWeight?: 'normal' | 'bold';
+    /** Font style (default 'normal'). */
+    fontStyle?: 'normal' | 'italic';
+    /** CSS fill colour (default '#222'). */
+    color?: string;
+    /** Line height multiplier (default 1.4). */
+    lineHeight?: number;
+    /** Text alignment within the box (default 'left'). */
+    textAlign?: 'left' | 'center' | 'right';
+    /** Opacity 0–1 (default 1). */
+    opacity?: number;
+    /** Optional text shadow colour for readability. */
+    shadowColor?: string;
+    /** Shadow blur radius in pixels (default 0). */
+    shadowBlur?: number;
+}
+export declare class TextBlock {
+    x: number;
+    y: number;
+    width: number;
+    text: string;
+    fontFamily: string;
+    fontSize: number;
+    fontWeight: 'normal' | 'bold';
+    fontStyle: 'normal' | 'italic';
+    color: string;
+    lineHeight: number;
+    textAlign: 'left' | 'center' | 'right';
+    opacity: number;
+    shadowColor: string;
+    shadowBlur: number;
+    constructor(options?: TextBlockOptions);
+    private _font;
+    /**
+     * Word-wrap `text` into lines that fit within `width` pixels.
+     * Respects explicit newlines.
+     */
+    wrapLines(ctx: CanvasRenderingContext2D): string[];
+    /** Total rendered height in canvas pixels. */
+    measureHeight(ctx: CanvasRenderingContext2D): number;
+    /** Returns true if the point (px, py) is within the text bounding box. */
+    hitTest(ctx: CanvasRenderingContext2D, px: number, py: number): boolean;
+    private _maxLineWidth;
+    draw(ctx: CanvasRenderingContext2D): void;
+}
+//# sourceMappingURL=TextBlock.d.ts.map

package/dist/TextBlock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextBlock.d.ts","sourceRoot":"","sources":["../src/TextBlock.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,WAAW,gBAAgB;IAC/B,kDAAkD;IAClD,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,iDAAiD;IACjD,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uCAAuC;IACvC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,UAAU,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC/B,qCAAqC;IACrC,SAAS,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAChC,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sDAAsD;IACtD,SAAS,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IACxC,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,qBAAa,SAAS;IACpB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC9B,SAAS,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;gBAEP,OAAO,CAAC,EAAE,gBAAgB;IAiBtC,OAAO,CAAC,KAAK;IAIb;;;OAGG;IACH,SAAS,CAAC,GAAG,EAAE,wBAAwB,GAAG,MAAM,EAAE;IAyBlD,8CAA8C;IAC9C,aAAa,CAAC,GAAG,EAAE,wBAAwB,GAAG,MAAM;IAKpD,0EAA0E;IAC1E,OAAO,CAAC,GAAG,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO;IAQvE,OAAO,CAAC,aAAa;IAUrB,IAAI,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;CAgC1C"}

package/dist/TextOverlayContent.d.ts

@@ -0,0 +1,72 @@
+/**
+ * TextOverlayContent — an IPageContent that composites text blocks on top of
+ * a source canvas (e.g. a SpriteScene canvas from three-book-theatre).
+ *
+ * Usage:
+ *   const overlay = new TextOverlayContent(512, 512);
+ *   overlay.source = spriteScene.canvas;          // set the underlying layer
+ *   overlay.addText({ text: 'Hello', x: 20, y: 400, width: 472, fontSize: 28 });
+ *   bookContent.pages.push(overlay);
+ *
+ *   // Per-frame: call update() to re-composite
+ *   overlay.update();
+ *
+ * The update flow:
+ *   1. Clear own canvas
+ *   2. Draw `source` canvas/image onto own canvas (full size)
+ *   3. Draw all text blocks on top
+ *   4. Set texture.needsUpdate = true
+ *
+ * For three-book material sync, pass the book root to syncMaterials() —
+ * same pattern as SpriteScene.
+ */
+import * as THREE from 'three';
+import { TextBlock } from './TextBlock';
+import type { TextBlockOptions } from './TextBlock';
+import type { IPageContent } from './PageContent';
+import type { BookContent } from './BookContent';
+export interface TextOverlayContentOptions {
+    /** Canvas width in pixels (default 512). */
+    width?: number;
+    /** Canvas height in pixels (default 512). */
+    height?: number;
+    /** Source canvas or image to draw as the base layer. */
+    source?: HTMLCanvasElement | HTMLImageElement | null;
+}
+export declare class TextOverlayContent implements IPageContent {
+    readonly canvas: HTMLCanvasElement;
+    readonly texts: TextBlock[];
+    private readonly ctx;
+    private readonly _texture;
+    private readonly _textureST;
+    private _source;
+    get texture(): THREE.Texture;
+    get textureST(): THREE.Vector4;
+    /** The base layer drawn beneath text blocks. */
+    get source(): HTMLCanvasElement | HTMLImageElement | null;
+    set source(v: HTMLCanvasElement | HTMLImageElement | null);
+    constructor(options?: TextOverlayContentOptions);
+    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
+     *              (same pattern as SpriteScene — 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 overlay's canvas.
+     */
+    syncMaterials(root: THREE.Object3D): void;
+    isPointOverUI(_textureCoord: THREE.Vector2): boolean;
+    init(_bookContent: BookContent): void;
+    setActive(_active: boolean): void;
+    dispose(): void;
+}
+//# sourceMappingURL=TextOverlayContent.d.ts.map

package/dist/TextOverlayContent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextOverlayContent.d.ts","sourceRoot":"","sources":["../src/TextOverlayContent.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,MAAM,WAAW,yBAAyB;IACxC,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wDAAwD;IACxD,MAAM,CAAC,EAAE,iBAAiB,GAAG,gBAAgB,GAAG,IAAI,CAAC;CACtD;AAOD,qBAAa,kBAAmB,YAAW,YAAY;IACrD,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE,CAAM;IAEjC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAA2B;IAC/C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAsB;IAC/C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAiC;IAC5D,OAAO,CAAC,OAAO,CAA8C;IAE7D,IAAI,OAAO,IAAI,KAAK,CAAC,OAAO,CAA0B;IACtD,IAAI,SAAS,IAAI,KAAK,CAAC,OAAO,CAA4B;IAE1D,gDAAgD;IAChD,IAAI,MAAM,IAAI,iBAAiB,GAAG,gBAAgB,GAAG,IAAI,CAAyB;IAClF,IAAI,MAAM,CAAC,CAAC,EAAE,iBAAiB,GAAG,gBAAgB,GAAG,IAAI,EAAuB;gBAEpE,OAAO,CAAC,EAAE,yBAAyB;IAmB/C,OAAO,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,SAAS;IAM9C,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI;IAKjC,sEAAsE;IACtE,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,IAAI;IAqBnE;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,IAAI;IAiBnC;;;OAGG;IACH,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,GAAG,IAAI;IAezC,aAAa,CAAC,aAAa,EAAE,KAAK,CAAC,OAAO,GAAG,OAAO;IAIpD,IAAI,CAAC,YAAY,EAAE,WAAW,GAAG,IAAI;IAErC,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAEjC,OAAO,IAAI,IAAI;CAGhB"}

package/dist/index.d.ts

@@ -20,4 +20,10 @@ export type { Keyframe } from './AutoTurn';
 export { BookRenderer, RendererFactory, MeshFactory, PaperMeshDataPool } from './Renderer';
 export type { IPageContent } from './PageContent';
 export { PageContent, SpritePageContent2 } from './PageContent';
+export { TextBlock } from './TextBlock';
+export type { TextBlockOptions } from './TextBlock';
+export { TextOverlayContent } from './TextOverlayContent';
+export type { TextOverlayContentOptions } from './TextOverlayContent';
+export { drawImageWithFit, createPageTexture, loadImage, PX_PER_UNIT } from './textureUtils';
+export type { ImageFitMode, LoadedImage } from './textureUtils';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AACnD,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAE1E,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,gBAAgB,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEzE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAElF,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,4BAA4B,EAC5B,cAAc,GACf,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE3F,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AACnD,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAE1E,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,gBAAgB,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEzE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAElF,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,4BAA4B,EAC5B,cAAc,GACf,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE3F,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEhE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,YAAY,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,YAAY,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAGtE,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7F,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC"}