@illgrenoble/webx-client 0.10.0 → 1.1.0

package/dist/display/WebXCursor.d.ts

@@ -1,6 +1,12 @@
 import * as THREE from 'three';
 import { Texture } from 'three';
 import { WebXCursorFactory } from './WebXCursorFactory';
+/**
+ * Represents the cursor in the WebX display.
+ *
+ * This class manages the cursor's position, appearance, and updates based on
+ * the cursor ID and coordinates provided by the WebX Engine.
+ */
 export declare class WebXCursor {
     private _cursorFactory;
     private static _PLANE_GEOMETRY;
@@ -14,15 +20,74 @@ export declare class WebXCursor {
     private _yHot;
     private _width;
     private _height;
+    /**
+     * Gets the THREE.js mesh representing the cursor.
+     *
+     * @returns The cursor mesh.
+     */
     get mesh(): THREE.Mesh;
+    /**
+     * Gets the cursor ID.
+     *
+     * @returns The cursor ID.
+     */
     get cursorId(): number;
+    /**
+     * Gets the texture of the cursor.
+     *
+     * @returns The cursor texture.
+     */
     get texture(): Texture;
+    /**
+     * Sets the x-coordinate of the cursor.
+     *
+     * @param value The x-coordinate.
+     */
     set x(value: number);
+    /**
+     * Sets the y-coordinate of the cursor.
+     *
+     * @param value The y-coordinate.
+     */
     set y(value: number);
+    /**
+     * Creates a new instance of WebXCursor.
+     *
+     * @param cursorFactory The factory used to create cursor textures.
+     */
     constructor(_cursorFactory: WebXCursorFactory);
+    /**
+     * Sets the position of the cursor.
+     *
+     * @param x The x-coordinate of the cursor.
+     * @param y The y-coordinate of the cursor.
+     */
     setPosition(x: number, y: number): void;
+    /**
+     * Updates the cursor's position and appearance based on the given cursor ID and coordinates.
+     *
+     * @param x The x-coordinate of the cursor.
+     * @param y The y-coordinate of the cursor.
+     * @param cursorId The ID of the cursor to display.
+     */
     updateCursorId(x: number, y: number, cursorId: number): void;
+    /**
+     * Updates the cursor's position, appearance, and texture.
+     *
+     * @param x The x-coordinate of the cursor.
+     * @param y The y-coordinate of the cursor.
+     * @param xHot The x-coordinate of the cursor's hotspot.
+     * @param yHot The y-coordinate of the cursor's hotspot.
+     * @param cursorId The ID of the cursor to display.
+     * @param texture The texture of the cursor.
+     */
     update(x: number, y: number, xHot: number, yHot: number, cursorId: number, texture: Texture): void;
+    /**
+     * Updates the scale of the cursor mesh based on its width and height.
+     */
     private _updateScale;
+    /**
+     * Updates the position of the cursor mesh based on its coordinates and hotspot.
+     */
     private _updatePosition;
 }

package/dist/display/WebXCursor.js

@@ -3,24 +3,60 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXCursor = void 0;
 const THREE = require("three");
 const three_1 = require("three");
+/**
+ * Represents the cursor in the WebX display.
+ *
+ * This class manages the cursor's position, appearance, and updates based on
+ * the cursor ID and coordinates provided by the WebX Engine.
+ */
 class WebXCursor {
+    /**
+     * Gets the THREE.js mesh representing the cursor.
+     *
+     * @returns The cursor mesh.
+     */
     get mesh() {
         return this._mesh;
     }
+    /**
+     * Gets the cursor ID.
+     *
+     * @returns The cursor ID.
+     */
     get cursorId() {
         return this._cursorId;
     }
+    /**
+     * Gets the texture of the cursor.
+     *
+     * @returns The cursor texture.
+     */
     get texture() {
         return this._texture;
     }
+    /**
+     * Sets the x-coordinate of the cursor.
+     *
+     * @param value The x-coordinate.
+     */
     set x(value) {
         this._x = value;
         this._updatePosition();
     }
+    /**
+     * Sets the y-coordinate of the cursor.
+     *
+     * @param value The y-coordinate.
+     */
     set y(value) {
         this._y = value;
         this._updatePosition();
     }
+    /**
+     * Creates a new instance of WebXCursor.
+     *
+     * @param cursorFactory The factory used to create cursor textures.
+     */
     constructor(_cursorFactory) {
         this._cursorFactory = _cursorFactory;
         this._xHot = 0;
@@ -47,11 +83,24 @@ class WebXCursor {
                 this.update(cursorData.x, cursorData.y, cursor.xHot, cursor.yHot, cursor.cursorId, cursor.texture);
         });
     }
+    /**
+     * Sets the position of the cursor.
+     *
+     * @param x The x-coordinate of the cursor.
+     * @param y The y-coordinate of the cursor.
+     */
     setPosition(x, y) {
         this._x = x;
         this._y = y;
         this._updatePosition();
     }
+    /**
+     * Updates the cursor's position and appearance based on the given cursor ID and coordinates.
+     *
+     * @param x The x-coordinate of the cursor.
+     * @param y The y-coordinate of the cursor.
+     * @param cursorId The ID of the cursor to display.
+     */
     updateCursorId(x, y, cursorId) {
         this._x = x;
         this._y = y;
@@ -63,6 +112,16 @@ class WebXCursor {
         });
         this._updatePosition();
     }
+    /**
+     * Updates the cursor's position, appearance, and texture.
+     *
+     * @param x The x-coordinate of the cursor.
+     * @param y The y-coordinate of the cursor.
+     * @param xHot The x-coordinate of the cursor's hotspot.
+     * @param yHot The y-coordinate of the cursor's hotspot.
+     * @param cursorId The ID of the cursor to display.
+     * @param texture The texture of the cursor.
+     */
     update(x, y, xHot, yHot, cursorId, texture) {
         this._x = x;
         this._y = y;
@@ -82,9 +141,15 @@ class WebXCursor {
         this._updateScale();
         this._updatePosition();
     }
+    /**
+     * Updates the scale of the cursor mesh based on its width and height.
+     */
     _updateScale() {
         this._mesh.scale.set(this._width, this._height, 1);
     }
+    /**
+     * Updates the position of the cursor mesh based on its coordinates and hotspot.
+     */
     _updatePosition() {
         this._mesh.position.set(this._x - this._xHot + 0.5 * this._width, this._y - this._yHot + 0.5 * this._height, 999);
     }

package/dist/display/WebXCursor.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXCursor.js","sourceRoot":"","sources":["../../src/display/WebXCursor.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,iCAA8C;AAG9C,MAAa,UAAU;IAerB,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAW,CAAC,CAAC,KAAa;QACxB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;QAChB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED,IAAW,CAAC,CAAC,KAAa;QACxB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;QAChB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED,YAAoB,cAAiC;QAAjC,mBAAc,GAAd,cAAc,CAAmB;QA3B7C,UAAK,GAAW,CAAC,CAAC;QAClB,UAAK,GAAW,CAAC,CAAC;QAClB,WAAM,GAAW,CAAC,CAAC;QACnB,YAAO,GAAW,CAAC,CAAC;QAyB1B,IAAI,CAAC,SAAS,GAAG,IAAI,KAAK,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC;QACrC,IAAI,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;QAClC,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,KAAK,CAAC;QAE/B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAExE,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,eAAe,EAAE,CAAC;QAEvB,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YAChD,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;YACjC,IAAI,IAAI,CAAC,SAAS,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,KAAK,MAAM,CAAC,QAAQ;gBAC9D,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,WAAW,CAAC,CAAS,EAAE,CAAS;QACrC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QAEZ,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAEM,cAAc,CAAC,CAAS,EAAE,CAAS,EAAE,QAAgB;QAC1D,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACxD,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;YAEjC,IAAI,IAAI,CAAC,SAAS,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,KAAK,MAAM,CAAC,QAAQ;gBAC9D,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QACvK,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAEM,MAAM,CAAC,CAAS,EAAE,CAAS,EAAE,IAAY,EAAE,IAAY,EAAE,QAAgB,EAAE,OAAgB;QAChG,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE1B,IAAI,OAAO,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YAC7C,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;YAClC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;YAEpC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;YAExB,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,oBAAY,CAAC;YACvC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAE7G,IAAI,CAAC,SAAS,CAAC,GAAG,GAAG,OAAO,CAAC;YAC7B,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC;YAC9B,IAAI,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;QACpC,CAAC;QAED,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAEO,YAAY;QAClB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACrD,CAAC;IAEO,eAAe;QACrB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACpH,CAAC;;AAjHH,gCAkHC;AAjHgB,0BAAe,GAAwB,IAAI,KAAK,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,AAA/D,CAAgE"}
+{"version":3,"file":"WebXCursor.js","sourceRoot":"","sources":["../../src/display/WebXCursor.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,iCAA8C;AAG9C;;;;;GAKG;AACH,MAAa,UAAU;IAerB;;;;OAIG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAW,CAAC,CAAC,KAAa;QACxB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;QAChB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAW,CAAC,CAAC,KAAa;QACxB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;QAChB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,YAAoB,cAAiC;QAAjC,mBAAc,GAAd,cAAc,CAAmB;QAzD7C,UAAK,GAAW,CAAC,CAAC;QAClB,UAAK,GAAW,CAAC,CAAC;QAClB,WAAM,GAAW,CAAC,CAAC;QACnB,YAAO,GAAW,CAAC,CAAC;QAuD1B,IAAI,CAAC,SAAS,GAAG,IAAI,KAAK,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC;QACrC,IAAI,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;QAClC,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,KAAK,CAAC;QAE/B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAExE,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,eAAe,EAAE,CAAC;QAEvB,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YAChD,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;YACjC,IAAI,IAAI,CAAC,SAAS,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,KAAK,MAAM,CAAC,QAAQ;gBAC9D,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,CAAS,EAAE,CAAS;QACrC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QAEZ,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAC,CAAS,EAAE,CAAS,EAAE,QAAgB;QAC1D,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACxD,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;YAEjC,IAAI,IAAI,CAAC,SAAS,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,KAAK,MAAM,CAAC,QAAQ;gBAC9D,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QACvK,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,CAAS,EAAE,CAAS,EAAE,IAAY,EAAE,IAAY,EAAE,QAAgB,EAAE,OAAgB;QAChG,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE1B,IAAI,OAAO,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YAC7C,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;YAClC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;YAEpC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;YAExB,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,oBAAY,CAAC;YACvC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAE7G,IAAI,CAAC,SAAS,CAAC,GAAG,GAAG,OAAO,CAAC;YAC7B,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC;YAC9B,IAAI,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;QACpC,CAAC;QAED,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACK,YAAY;QAClB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACK,eAAe;QACrB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACpH,CAAC;;AA5KH,gCA6KC;AA5KgB,0BAAe,GAAwB,IAAI,KAAK,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,AAA/D,CAAgE"}

package/dist/display/WebXCursorFactory.d.ts

@@ -1,15 +1,33 @@
 import { WebXTunnel } from '../tunnel';
 import { Texture } from 'three';
+/**
+ * Interface representing cursor data.
+ */
 export interface WebXCursorData {
     xHot: number;
     yHot: number;
     cursorId: number;
     texture: Texture;
 }
+/**
+ * Factory class for creating and managing cursor textures.
+ *
+ * This class retrieves cursor textures based on cursor IDs and caches them
+ * for reuse.
+ */
 export declare class WebXCursorFactory {
     private _tunnel;
     private _cursorMap;
     constructor(_tunnel: WebXTunnel);
+    /**
+     * Retrieves the cursor texture for the given cursor ID.
+     *
+     * If the cursor texture is not already cached, it will be fetched and cached
+     * for future use.
+     *
+     * @param cursorId The ID of the cursor to retrieve.
+     * @returns A promise that resolves to the cursor texture and its dimensions.
+     */
     getCursor(cursorId?: number): Promise<{
         x?: number;
         y?: number;

package/dist/display/WebXCursorFactory.js

@@ -1,33 +1,56 @@
 "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.WebXCursorFactory = void 0;
 const instruction_1 = require("../instruction");
+/**
+ * Factory class for creating and managing cursor textures.
+ *
+ * This class retrieves cursor textures based on cursor IDs and caches them
+ * for reuse.
+ */
 class WebXCursorFactory {
     constructor(_tunnel) {
         this._tunnel = _tunnel;
         this._cursorMap = new Map();
     }
+    /**
+     * Retrieves the cursor texture for the given cursor ID.
+     *
+     * If the cursor texture is not already cached, it will be fetched and cached
+     * for future use.
+     *
+     * @param cursorId The ID of the cursor to retrieve.
+     * @returns A promise that resolves to the cursor texture and its dimensions.
+     */
     getCursor(cursorId) {
-        return new Promise((resolve) => {
+        return __awaiter(this, void 0, void 0, function* () {
             const cursorData = this._cursorMap.get(cursorId);
             if (cursorData != null) {
-                resolve({ cursor: cursorData });
+                return { cursor: cursorData };
             }
             else {
-                this._tunnel.sendRequest(new instruction_1.WebXCursorImageInstruction(cursorId)).then((response) => {
-                    const newCursorData = {
-                        xHot: response.xHot,
-                        yHot: response.yHot,
-                        cursorId: response.cursorId,
-                        texture: response.texture
-                    };
-                    this._cursorMap.set(response.cursorId, newCursorData);
-                    resolve({
-                        x: response.x,
-                        y: response.y,
-                        cursor: newCursorData
-                    });
-                });
+                const response = yield this._tunnel.sendRequest(new instruction_1.WebXCursorImageInstruction(cursorId));
+                const newCursorData = {
+                    xHot: response.xHot,
+                    yHot: response.yHot,
+                    cursorId: response.cursorId,
+                    texture: response.texture
+                };
+                this._cursorMap.set(response.cursorId, newCursorData);
+                return {
+                    x: response.x,
+                    y: response.y,
+                    cursor: newCursorData
+                };
             }
         });
     }

package/dist/display/WebXCursorFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXCursorFactory.js","sourceRoot":"","sources":["../../src/display/WebXCursorFactory.ts"],"names":[],"mappings":";;;AAEA,gDAA4D;AAU5D,MAAa,iBAAiB;IAG5B,YAAoB,OAAmB;QAAnB,YAAO,GAAP,OAAO,CAAY;QAF/B,eAAU,GAAgC,IAAI,GAAG,EAAE,CAAC;IAElB,CAAC;IAEpC,SAAS,CAAC,QAAiB;QAChC,OAAO,IAAI,OAAO,CAAqD,CAAC,OAAO,EAAE,EAAE;YACjF,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACjD,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;gBACvB,OAAO,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;YAClC,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,wCAA0B,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,QAAgC,EAAE,EAAE;oBAC3G,MAAM,aAAa,GAAG;wBACpB,IAAI,EAAE,QAAQ,CAAC,IAAI;wBACnB,IAAI,EAAE,QAAQ,CAAC,IAAI;wBACnB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;wBAC3B,OAAO,EAAE,QAAQ,CAAC,OAAO;qBAC1B,CAAA;oBAED,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;oBAEtD,OAAO,CAAC;wBACN,CAAC,EAAE,QAAQ,CAAC,CAAC;wBACb,CAAC,EAAE,QAAQ,CAAC,CAAC;wBACb,MAAM,EAAE,aAAa;qBACtB,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA9BD,8CA8BC"}
+{"version":3,"file":"WebXCursorFactory.js","sourceRoot":"","sources":["../../src/display/WebXCursorFactory.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,gDAAgF;AAahF;;;;;GAKG;AACH,MAAa,iBAAiB;IAG5B,YAAoB,OAAmB;QAAnB,YAAO,GAAP,OAAO,CAAY;QAF/B,eAAU,GAAgC,IAAI,GAAG,EAAE,CAAC;IAElB,CAAC;IAE3C;;;;;;;;OAQG;IACU,SAAS,CAAC,QAAiB;;YACtC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACjD,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;gBACvB,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YAEhC,CAAC;iBAAM,CAAC;gBACN,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,wCAA0B,CAAC,QAAQ,CAAC,CAA2B,CAAC;gBAEpH,MAAM,aAAa,GAAG;oBACpB,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;oBAC3B,OAAO,EAAE,QAAQ,CAAC,OAAO;iBAC1B,CAAA;gBAED,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;gBAEtD,OAAO;oBACL,CAAC,EAAE,QAAQ,CAAC,CAAC;oBACb,CAAC,EAAE,QAAQ,CAAC,CAAC;oBACb,MAAM,EAAE,aAAa;iBACtB,CAAC;YACJ,CAAC;QACH,CAAC;KAAA;CACF;AAtCD,8CAsCC"}

package/dist/display/WebXDisplay.d.ts

@@ -1,10 +1,17 @@
 import * as THREE from 'three';
-import { Texture } from 'three';
+import { OrthographicCamera, Texture } from 'three';
 import { WebXWindow } from './WebXWindow';
 import { WebXWindowProperties } from './WebXWindowProperties';
 import { WebXSubImage } from './WebXSubImage';
 import { WebXTextureFactory } from './WebXTextureFactory';
 import { WebXCursorFactory } from './WebXCursorFactory';
+/**
+ * Manages the rendering of the WebX remote desktop using WebGL.
+ *
+ * This class handles the creation and management of the WebGL scene, including
+ * windows, cursor, and scaling. It provides methods to update the display
+ * and interact with the rendered elements.
+ */
 export declare class WebXDisplay {
     private readonly _scene;
     private readonly _camera;
@@ -20,50 +27,184 @@ export declare class WebXDisplay {
     private _displayElement;
     private _boundsElement;
     private _disposed;
+    /**
+     * Gets the WebGL renderer used for rendering the display.
+     *
+     * @returns The WebGLRenderer instance.
+     */
     get renderer(): THREE.WebGLRenderer;
+    /**
+     * Gets the width of the screen.
+     *
+     * @returns The screen width in pixels.
+     */
     get screenWidth(): number;
+    /**
+     * Gets the height of the screen.
+     *
+     * @returns The screen height in pixels.
+     */
     get screenHeight(): number;
+    /**
+     * Gets the HTML container element for the display.
+     *
+     * @returns The container HTMLElement.
+     */
     get containerElement(): HTMLElement;
+    /**
+     * Gets the current scale factor of the display.
+     *
+     * @returns The scale factor as a number.
+     */
     get scale(): number;
+    /**
+     * Gets the Three.js scene used for rendering.
+     *
+     * @returns The Scene instance.
+     */
     get scene(): THREE.Scene;
+    /**
+     * Gets the Three.js camera used for rendering.
+     *
+     * @returns the Camera instance
+     */
+    get camera(): OrthographicCamera;
+    /**
+     * Creates a new instance of WebXDisplay.
+     *
+     * @param containerElement The HTML element to render the display.
+     * @param screenWidth The width of the screen.
+     * @param screenHeight The height of the screen.
+     * @param textureFactory The texture factory used for creating textures.
+     * @param cursorFactory The cursor factory used for managing cursors.
+     */
     constructor(containerElement: HTMLElement, screenWidth: number, screenHeight: number, textureFactory: WebXTextureFactory, cursorFactory: WebXCursorFactory);
+    /**
+     * Displays the screen by adding it to the scene.
+     */
     showScreen(): void;
+    /**
+     * Hides the screen by removing it from the scene.
+     */
     hideScreen(): void;
+    /**
+     * Disposes of all resources used by the display.
+     *
+     * This includes removing windows, clearing elements, and releasing WebGL resources.
+     */
     dispose(): void;
+    /**
+     * Animates the display by continuously rendering the scene.
+     *
+     * This method uses `requestAnimationFrame` to update the display at regular intervals.
+     */
     animate(): void;
+    /**
+     * Renders the display by updating the WebGL context.
+     */
+    render(): void;
+    /**
+     * Adds a new window to the display.
+     *
+     * @param window The WebXWindow instance to add.
+     */
     addWindow(window: WebXWindow): void;
+    /**
+     * Removes a window from the display.
+     *
+     * @param window The WebXWindow instance to remove.
+     */
     removeWindow(window: WebXWindow): void;
+    /**
+     * Updates the display with the given windows.
+     *
+     * @param windows The list of windows to update.
+     * @returns A promise that resolves when all windows are updated.
+     */
     updateWindows(windows: Array<WebXWindowProperties>): Promise<void>;
+    /**
+     * Checks if all specified windows are visible.
+     *
+     * @param windowIds The list of window IDs to check.
+     * @returns True if all windows are visible, false otherwise.
+     */
     checkVisibility(windowIds: number[]): boolean;
+    /**
+     * Updates the texture of a window with new image data.
+     *
+     * @param windowId The ID of the window to update.
+     * @param depth The depth of the image.
+     * @param colorMap The color texture.
+     * @param alphaMap The alpha texture.
+     */
     updateImage(windowId: number, depth: number, colorMap: Texture, alphaMap: Texture): void;
+    /**
+     * Updates sub-images of a window with new image data.
+     *
+     * @param windowId The ID of the window to update.
+     * @param subImages The list of sub-images to update.
+     */
     updateSubImages(windowId: number, subImages: WebXSubImage[]): void;
+    /**
+     * Updates the mouse position and cursor on the display.
+     *
+     * @param x The x-coordinate of the mouse.
+     * @param y The y-coordinate of the mouse.
+     * @param cursorId The ID of the cursor to display.
+     */
     updateMouse(x: number, y: number, cursorId: number): void;
+    /**
+     * Updates the mouse position without changing the cursor.
+     *
+     * @param x The x-coordinate of the mouse.
+     * @param y The y-coordinate of the mouse.
+     */
     updateMousePosition(x: number, y: number): void;
+    /**
+     * Retrieves a window by its ID.
+     *
+     * @param id The ID of the window to retrieve.
+     * @returns The WebXWindow instance, or undefined if not found.
+     */
     getWindow(id: number): WebXWindow;
     /**
-     * Set the scale
-     * @param scale the scale (between 0 and 1)
+     * Sets the scale of the display.
+     *
+     * @param scale The scale factor (between 0 and 1).
      */
     setScale(scale: number): void;
     /**
-     * Scale automatically
+     * Automatically scales the display to fit its container.
      */
     autoScale(): void;
     /**
-     * Update the screen scale
-     * @param scale between 0 and 1 or empty. If empty then the display will autoscale
-     *              to fit the dimensions of its container
+     * Resizes the display to fit its container.
+     *
+     * @param scale Optional scale factor. If not provided, the display will auto-scale.
      */
     resize(scale?: number): void;
+    /**
+     * Clears all child elements from the container element.
+     */
     private _clearElements;
+    /**
+     * Creates the main display element and sets its dimensions.
+     *
+     * @returns The created HTML element.
+     */
     private _createDisplayElement;
+    /**
+     * Creates the bounding element for the display.
+     *
+     * @returns The created HTML element.
+     */
     private _createDisplayBoundingElement;
     /**
-     * Render the display to the screen
+     * Renders the display by appending the display and bounding elements to the container.
      */
     private _render;
     /**
-     * Bind the event listeners
+     * Binds event listeners for resizing and other interactions.
      */
     private _bindListeners;
 }