@illgrenoble/webx-client 1.9.2 → 1.9.4

package/dist/src/display/WebXTextureFactory.d.ts

@@ -1,54 +0,0 @@
-import { WebXTunnel } from '../tunnel';
-import { Texture } from 'three';
-/**
- * Factory class for creating and managing textures for WebX windows.
- *
- * This class retrieves textures from the WebX Engine and caches them for reuse.
- */
-export declare class WebXTextureFactory {
-    private _tunnel;
-    constructor(_tunnel: WebXTunnel);
-    /**
-     * Retrieves the textures (colorMap and alphaMap) for a specific window ID from the WebX Engine.
-     *
-     * @param windowId The ID of the window to retrieve the texture for.
-     * @returns A promise that resolves to the textures and associated data.
-     */
-    getWindowTexture(windowId: number): Promise<{
-        depth: number;
-        colorMap: Texture;
-        alphaMap: Texture;
-    }>;
-    /**
-     * Retrieves the stencil textures for a specific window ID from the WebX Engine.
-     *
-     * @param windowId The ID of the window to retrieve the texture for.
-     * @returns A promise that resolves to the stencil texture
-     */
-    getWindowStencilTexture(windowId: number): Promise<{
-        stencilMap: Texture;
-    }>;
-    /**
-     * Creates a texture from a base64-encoded image data.
-     *
-     * @param imageData The base64-encoded image data.
-     * @returns A promise that resolves to the created texture.
-     */
-    createTextureFromBase64Array(imageData: string): Promise<Texture>;
-    /**
-     * Creates a texture from raw image data.
-     *
-     * @param imageData The raw image data as a Uint8Array.
-     * @param mimetype The MIME type of the image data (e.g., "image/png").
-     * @param colorSpace The color space of the image data (e.g., "srgb").
-     * @returns A promise that resolves to the created texture.
-     */
-    createTextureFromArray(imageData: Uint8Array, mimetype: string, colorSpace: string): Promise<Texture>;
-    /**
-     * Creates a texture from a Blob object.
-     *
-     * @param blob The Blob object containing the image data.
-     * @returns A promise that resolves to the created texture.
-     */
-    createTextureFromBlob(blob: Blob): Promise<Texture>;
-}

package/dist/src/display/WebXTextureFactory.js

@@ -1,160 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebXTextureFactory = void 0;
-const instruction_1 = require("../instruction");
-const three_1 = require("three");
-/**
- * Factory class for creating and managing textures for WebX windows.
- *
- * This class retrieves textures from the WebX Engine and caches them for reuse.
- */
-class WebXTextureFactory {
-    constructor(_tunnel) {
-        this._tunnel = _tunnel;
-    }
-    /**
-     * Retrieves the textures (colorMap and alphaMap) for a specific window ID from the WebX Engine.
-     *
-     * @param windowId The ID of the window to retrieve the texture for.
-     * @returns A promise that resolves to the textures and associated data.
-     */
-    getWindowTexture(windowId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const response = yield this._tunnel.sendRequest(new instruction_1.WebXImageInstruction(windowId));
-                return {
-                    depth: response.depth,
-                    colorMap: response.colorMap,
-                    alphaMap: response.alphaMap,
-                };
-            }
-            catch (err) {
-                console.warn('Failed to get texture: ' + err);
-            }
-        });
-    }
-    /**
-     * Retrieves the stencil textures for a specific window ID from the WebX Engine.
-     *
-     * @param windowId The ID of the window to retrieve the texture for.
-     * @returns A promise that resolves to the stencil texture
-     */
-    getWindowStencilTexture(windowId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const response = yield this._tunnel.sendRequest(new instruction_1.WebXShapeInstruction(windowId));
-                return {
-                    stencilMap: response.stencilMap,
-                };
-            }
-            catch (err) {
-                console.warn('Failed to get stencil texture: ' + err);
-                return null;
-            }
-        });
-    }
-    /**
-     * Creates a texture from a base64-encoded image data.
-     *
-     * @param imageData The base64-encoded image data.
-     * @returns A promise that resolves to the created texture.
-     */
-    createTextureFromBase64Array(imageData) {
-        return new Promise((resolve, reject) => {
-            if (imageData != null && imageData !== '') {
-                const image = new Image();
-                const texture = new three_1.Texture(image);
-                image.onload = () => {
-                    texture.needsUpdate = true;
-                    texture.flipY = false;
-                    texture.minFilter = three_1.LinearFilter;
-                    resolve(texture);
-                };
-                image.onerror = (error) => {
-                    console.warn(`Failed to create texture from base64: ${error}`);
-                    reject(error);
-                };
-                image.src = imageData;
-            }
-            else {
-                resolve(null);
-            }
-        });
-    }
-    /**
-     * Creates a texture from raw image data.
-     *
-     * @param imageData The raw image data as a Uint8Array.
-     * @param mimetype The MIME type of the image data (e.g., "image/png").
-     * @param colorSpace The color space of the image data (e.g., "srgb").
-     * @returns A promise that resolves to the created texture.
-     */
-    createTextureFromArray(imageData, mimetype, colorSpace) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (imageData != null && imageData.byteLength > 0) {
-                const blob = new Blob([imageData], { type: mimetype });
-                const texture = yield this.createTextureFromBlob(blob);
-                texture.needsUpdate = true;
-                texture.flipY = false;
-                texture.minFilter = three_1.LinearFilter;
-                texture.colorSpace = colorSpace;
-                return texture;
-            }
-            else {
-                return null;
-            }
-        });
-    }
-    /**
-     * Creates a texture from a Blob object.
-     *
-     * @param blob The Blob object containing the image data.
-     * @returns A promise that resolves to the created texture.
-     */
-    createTextureFromBlob(blob) {
-        // not supported by all of the browsers at the moment
-        // https://caniuse.com/createimagebitmap
-        if (typeof createImageBitmap === 'function') {
-            return new Promise((resolve, reject) => {
-                createImageBitmap(blob)
-                    .then(bitmap => {
-                    const texture = new three_1.Texture();
-                    texture.image = bitmap;
-                    resolve(texture);
-                })
-                    .catch(error => {
-                    console.warn(`Failed to create texture using createImageBitmap from binary data: ${error}`);
-                    reject(error);
-                });
-            });
-        }
-        else {
-            return new Promise((resolve, reject) => {
-                // fall back to the standard way of creating an image
-                const url = URL.createObjectURL(blob);
-                const image = new Image();
-                image.onload = () => {
-                    URL.revokeObjectURL(url);
-                    const texture = new three_1.Texture(image);
-                    resolve(texture);
-                };
-                image.onerror = (error) => {
-                    console.warn(`Failed to create texture from binary data: ${error}`);
-                    reject(error);
-                };
-                image.src = url;
-            });
-        }
-    }
-}
-exports.WebXTextureFactory = WebXTextureFactory;
-//# sourceMappingURL=WebXTextureFactory.js.map

package/dist/src/display/WebXTextureFactory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"WebXTextureFactory.js","sourceRoot":"","sources":["../../../src/display/WebXTextureFactory.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,gDAA0E;AAC1E,iCAA4C;AAG5C;;;;GAIG;AACH,MAAa,kBAAkB;IAE7B,YAAoB,OAAmB;QAAnB,YAAO,GAAP,OAAO,CAAY;IAAG,CAAC;IAE3C;;;;;OAKG;IACU,gBAAgB,CAAC,QAAgB;;YAC5C,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,kCAAoB,CAAC,QAAQ,CAAC,CAAqB,CAAC;gBACxG,OAAO;oBACL,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;oBAC3B,QAAQ,EAAE,QAAQ,CAAC,QAAQ;iBAC5B,CAAC;YAEJ,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,IAAI,CAAC,yBAAyB,GAAG,GAAG,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACU,uBAAuB,CAAC,QAAgB;;YACnD,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,kCAAoB,CAAC,QAAQ,CAAC,CAAqB,CAAC;gBACxG,OAAO;oBACL,UAAU,EAAE,QAAQ,CAAC,UAAU;iBAChC,CAAC;YAEJ,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,IAAI,CAAC,iCAAiC,GAAG,GAAG,CAAC,CAAC;gBACtD,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACI,4BAA4B,CAAC,SAAiB;QACnD,OAAO,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC9C,IAAI,SAAS,IAAI,IAAI,IAAI,SAAS,KAAK,EAAE,EAAE,CAAC;gBAC1C,MAAM,KAAK,GAAqB,IAAI,KAAK,EAAE,CAAC;gBAC5C,MAAM,OAAO,GAAY,IAAI,eAAO,CAAC,KAAK,CAAC,CAAC;gBAC5C,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE;oBAClB,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;oBAC3B,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;oBACtB,OAAO,CAAC,SAAS,GAAG,oBAAY,CAAC;oBAEjC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACnB,CAAC,CAAC;gBAEF,KAAK,CAAC,OAAO,GAAG,CAAC,KAAK,EAAE,EAAE;oBACxB,OAAO,CAAC,IAAI,CAAC,yCAAyC,KAAK,EAAE,CAAC,CAAC;oBAC/D,MAAM,CAAC,KAAK,CAAC,CAAC;gBAChB,CAAC,CAAA;gBAED,KAAK,CAAC,GAAG,GAAG,SAAS,CAAC;YAExB,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACU,sBAAsB,CAAC,SAAqB,EAAE,QAAgB,EAAE,UAAkB;;YAC7F,IAAI,SAAS,IAAI,IAAI,IAAI,SAAS,CAAC,UAAU,GAAG,CAAC,EAAE,CAAC;gBAClD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;gBACvD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;gBAGvD,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;gBAC3B,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;gBACtB,OAAO,CAAC,SAAS,GAAG,oBAAY,CAAC;gBACjC,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;gBAEhC,OAAO,OAAO,CAAC;YAEjB,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACI,qBAAqB,CAAC,IAAU;QACrC,qDAAqD;QACrD,wCAAwC;QACxC,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;YAC5C,OAAO,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC9C,iBAAiB,CAAC,IAAI,CAAC;qBACpB,IAAI,CAAC,MAAM,CAAC,EAAE;oBACb,MAAM,OAAO,GAAY,IAAI,eAAO,EAAE,CAAC;oBACvC,OAAO,CAAC,KAAK,GAAG,MAAM,CAAC;oBAEvB,OAAO,CAAC,OAAO,CAAC,CAAC;gBACnB,CAAC,CAAC;qBACD,KAAK,CAAC,KAAK,CAAC,EAAE;oBACb,OAAO,CAAC,IAAI,CAAC,sEAAsE,KAAK,EAAE,CAAC,CAAC;oBAC5F,MAAM,CAAC,KAAK,CAAC,CAAC;gBAChB,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QAEL,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC9C,qDAAqD;gBACrD,MAAM,GAAG,GAAG,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;gBACtC,MAAM,KAAK,GAAqB,IAAI,KAAK,EAAE,CAAC;gBAC5C,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE;oBAClB,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;oBACzB,MAAM,OAAO,GAAY,IAAI,eAAO,CAAC,KAAK,CAAC,CAAC;oBAE5C,OAAO,CAAC,OAAO,CAAC,CAAC;gBACnB,CAAC,CAAC;gBAEF,KAAK,CAAC,OAAO,GAAG,CAAC,KAAK,EAAE,EAAE;oBACxB,OAAO,CAAC,IAAI,CAAC,8CAA8C,KAAK,EAAE,CAAC,CAAC;oBACpE,MAAM,CAAC,KAAK,CAAC,CAAC;gBAChB,CAAC,CAAA;gBAED,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;CACF;AAlJD,gDAkJC"}

package/dist/src/display/WebXWindow.d.ts

@@ -1,241 +0,0 @@
-import * as THREE from 'three';
-import { WebXTextureFactory } from './WebXTextureFactory';
-import { Texture } from 'three';
-/**
- * Represents a window in the WebX display.
- *
- * This class manages the rendering of a single window, including its position,
- * size, and texture updates.
- */
-export declare class WebXWindow {
-    static WINDOW_REFRESH_TIME_MS: number;
-    private static _PLANE_GEOMETRY;
-    private static _COLOR_INDEX;
-    private readonly _textureFactory;
-    private readonly _colorIndex;
-    private readonly _id;
-    private readonly _material;
-    private readonly _mesh;
-    private _depth;
-    private _x;
-    private _y;
-    private _z;
-    private _width;
-    private _height;
-    private _shaped;
-    private _windowRefreshTimeout;
-    /**
-     * Gets the THREE.js mesh representing the window.
-     *
-     * @returns The window mesh.
-     */
-    get mesh(): THREE.Mesh;
-    /**
-     * Gets the color index of the window.
-     *
-     * @returns The color index as a number.
-     */
-    get colorIndex(): number;
-    /**
-     * Gets the unique ID of the window.
-     *
-     * @returns The window ID as a number.
-     */
-    get id(): number;
-    /**
-     * Gets the visibility status of the window.
-     *
-     * @returns True if the window is visible, false otherwise.
-     */
-    get visible(): boolean;
-    /**
-     * Sets the visibility status of the window.
-     *
-     * @param visible True to make the window visible, false to hide it.
-     */
-    private set visible(value);
-    /**
-     * Gets the color map texture of the window.
-     *
-     * @returns The color map as a Texture.
-     */
-    get colorMap(): Texture;
-    /**
-     * Sets the color map texture of the window.
-     *
-     * @param colorMap The new color map as a Texture.
-     */
-    private set colorMap(value);
-    /**
-     * Gets the alpha map texture of the window.
-     *
-     * @returns The alpha map as a Texture.
-     */
-    get alphaMap(): Texture;
-    /**
-     * Sets the alpha map texture of the window.
-     *
-     * @param alphaMap The new alpha map as a Texture.
-     */
-    private set alphaMap(value);
-    /**
-     * Gets the stencil map texture of the window.
-     *
-     * @returns The stencil map as a Texture.
-     */
-    get stencilMap(): Texture;
-    /**
-     * Sets the stencil map texture of the window.
-     *
-     * @param stencilMap The new stencil map as a Texture.
-     */
-    private set stencilMap(value);
-    /**
-     * Checks if the color map is valid.
-     *
-     * @returns True if the color map is valid, false otherwise.
-     */
-    get colorMapValid(): boolean;
-    /**
-     * Gets the depth of the window.
-     *
-     * @returns The depth as a number.
-     */
-    get depth(): number;
-    /**
-     * Gets the x-coordinate of the window.
-     *
-     * @returns The x-coordinate as a number.
-     */
-    get x(): number;
-    /**
-     * Sets the x-coordinate of the window.
-     *
-     * @param value The new x-coordinate as a number.
-     */
-    set x(value: number);
-    /**
-     * Gets the y-coordinate of the window.
-     *
-     * @returns The y-coordinate as a number.
-     */
-    get y(): number;
-    /**
-     * Sets the y-coordinate of the window.
-     *
-     * @param value The new y-coordinate as a number.
-     */
-    set y(value: number);
-    /**
-     * Gets the z-index of the window.
-     *
-     * @returns The z-index as a number.
-     */
-    get z(): number;
-    /**
-     * Sets the z-index of the window.
-     *
-     * @param value The new z-index as a number.
-     */
-    set z(value: number);
-    /**
-     * Gets the width of the window.
-     *
-     * @returns The width as a number.
-     */
-    get width(): number;
-    /**
-     * Sets the width of the window.
-     *
-     * @param value The new width as a number.
-     */
-    set width(value: number);
-    /**
-     * Gets the height of the window.
-     *
-     * @returns The height as a number.
-     */
-    get height(): number;
-    /**
-     * Sets the height of the window.
-     *
-     * @param value The new height as a number.
-     */
-    set height(value: number);
-    /**
-     * Creates a new instance of WebXWindow.
-     *
-     * @param configuration The properties of the window, such as position and size.
-     * @param textureFactory The factory used to create textures for the window.
-     */
-    constructor(configuration: {
-        id: number;
-        x: number;
-        y: number;
-        z: number;
-        width: number;
-        height: number;
-        shaped: boolean;
-    }, textureFactory: WebXTextureFactory);
-    /**
-     * Loads the window image from the texture factory.
-     */
-    loadWindowImage(): Promise<void>;
-    /**
-     * Loads the window shape (stencil map) from the texture factory.
-     */
-    loadWindowShape(): Promise<void>;
-    /**
-     * Loads the window image and shape (if needed) from the texture factory.
-     */
-    loadWindowImageAndShape(): Promise<void>;
-    /**
-     * Updates the position and size of the window.
-     *
-     * @param x The x-coordinate of the window.
-     * @param y The y-coordinate of the window.
-     * @param z The z-index of the window.
-     * @param width The width of the window.
-     * @param height The height of the window.
-     */
-    setRectangle(x: number, y: number, z: number, width: number, height: number): void;
-    /**
-     * Updates the textures of the window with new image data.
-     *
-     * @param depth The depth of the image.
-     * @param colorMap The color texture.
-     * @param alphaMap The alpha texture.
-     * @param isFullWindow Whether to force an update of the textures.
-     */
-    updateTexture(depth: number, colorMap: Texture, alphaMap: Texture, isFullWindow: boolean): void;
-    /**
-     * Updates the stencil map texture of the window with new image data.
-     *
-     * @param stencilMap The stencil map texture.
-     */
-    updateStencilTexture(stencilMap: Texture): void;
-    /**
-     * Updates the scale of the window mesh based on its width and height.
-     */
-    private _updateScale;
-    /**
-     * Updates the position of the window mesh based on its x, y, and z coordinates.
-     */
-    private _updatePosition;
-    /**
-     * Disposes of the resources used by the window.
-     */
-    dispose(): void;
-    /**
-     * Disposes of the color map texture, releasing its resources.
-     */
-    private _disposeColorMap;
-    /**
-     * Disposes of the alpha map texture, releasing its resources.
-     */
-    private _disposeAlphaMap;
-    /**
-     * Disposes of the stencil map texture, releasing its resources.
-     */
-    private _disposeStencilMap;
-}