@combeenation/3d-viewer 9.2.1-alpha1 → 10.0.0-alpha3

package/README.md

@@ -1,111 +1,9 @@
-# 3D viewer
-
-## Usage
-
-- Create a label called `JS_3dViewerLbl` which we'll use to render the 3d viewer into:
-
-  - Set its value to `<canvas></canvas>`
-  - Add CSS class `ViewerLbl`
-  - Add the following CSS styles to your configurator:
-
-    ```css
-    .ViewerLbl .cfgrctrl-innerlabel {
-      height: 100%;
-    }
-
-    .ViewerLbl canvas {
-      width: 100%;
-      height: 100%;
-    }
-    ```
-
-- Install viewer dependencies: `npm i @combeenation/3d-viewer`
-- Create specification (example, bare minimum):
-  ```js
-  /**
-   * @return {StructureJson}
-   */
-  export function createSpec() {
-    return {
-      scene: {
-        engine: {
-          antialiasing: true,
-          options: {
-            preserveDrawingBuffer: true,
-            stencil: true,
-            // `xrCompatible` is required to fix WebXR issue in Safari 15 as mentioned in the Babylon.js forum:
-            // https://forum.babylonjs.com/t/safari-15-0-breaks-every-babylonjs-application/23973
-            xrCompatible: false,
-          },
-        },
-        scene: {
-          globals: {},
-          cameras: {},
-        },
-      },
-      setup: {
-        instances: [
-          {
-            name: 'DirtBikeInstance',
-            variant: 'DirtBike',
-            lazy: false,
-            parameters: {
-              visible: true,
-              scaling: '( 1, 1, 1 )',
-              position: '( 0, 0, 0 )',
-              rotation: '( 0, 0, 0 )',
-            },
-          },
-        ],
-      },
-      variants: {
-        DirtBike: {
-          glTF: 'https://combeepublic.blob.core.windows.net/resources/the-3d-file.glb',
-          elements: {
-            Main: ['__root__'],
-          },
-        },
-      },
-    };
-  }
-  ```
-- Bootstrap viewer (example code):
-
-  ```js
-  import { Viewer } from '@combeenation/3d-viewer';
-  import { CtrlUtils } from '@combeenation/custom-js-utils';
-  import { createSpec } from 'path/to/spec-file';
-
-  /**
-   * Bootstraps the viewer using the JSON spec, registers all needed events etc.
-   */
-  export async function bootstrapViewer() {
-    Cbn.utils.Log.add(`Bootstrapping viewer v${Viewer.version}`, Cbn.utils.Log.Type.Misc)();
-
-    const $canvas = $(CtrlUtils.getLabel('JS_3dViewerLbl').el.dom).find('canvas');
-    const canvas = /** @type {HTMLCanvasElement} */ ($canvas.get(0));
-    const viewer = new Viewer(canvas, createSpec());
-    await viewer.bootstrap([]);
-
-    // The resize listener doesn't seem to work on the canvas itself, therefore we're installing it on its parent
-    Cbn.utils.ResizeEvents.addResizeListener(canvas.parentElement, () => viewer.resize());
-
-    return viewer;
-  }
-  ```
-
-- Call `bootstrapViewer` e.g. somewhere in `onCfgrReady` in your main file:
-
-  ```js
-  CfgrUtils.onCfgrReady(async () => {
-    // ...
-
-    const viewer = await bootstrapViewer();
-
-    // ...
-
-    // Make some functions accessible in the global window object (e.g. for debugging in the console etc.)
-    // Can be extended as needed.
-    window.CfgrJS = { /* ... */ viewer /* ... */ };
-  });
-  ```
+# 3D viewer
+
+## Basic setup
+
+See [Combeenation docs](https://docs.combeenation.com/) (especially [this](https://docs.combeenation.com/v1/docs/3d-viewer-control) & [this](https://docs.combeenation.com/docs/3d-viewer-control-with-custom-js)) on how to setup a Combeenation configurator with the 3d viewer.
+
+## API
+
+The docs here contain detailed info about the viewer API which can be used from [Custom JS](https://docs.combeenation.com/v1/docs/custom-js) as explained [here](https://docs.combeenation.com/docs/3d-viewer-control-with-custom-js).

package/dist/lib-cjs/api/classes/animationInterface.d.ts

@@ -1,8 +1,8 @@
-/**
- * An Interface defining the basic functionality of an animation.
- */
-export interface AnimationInterface {
-    play(): Promise<AnimationInterface>;
-    pause(): AnimationInterface;
-    kill(): AnimationInterface;
-}
+/**
+ * An Interface defining the basic functionality of an animation.
+ */
+export interface AnimationInterface {
+    play(): Promise<AnimationInterface>;
+    pause(): AnimationInterface;
+    kill(): AnimationInterface;
+}

package/dist/lib-cjs/api/classes/animationInterface.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=animationInterface.js.map

package/dist/lib-cjs/api/classes/dottedPath.d.ts

@@ -1,79 +1,79 @@
-export declare class DottedPath {
-    static DELIMITER: string;
-    static SAFE_CHAR: string;
-    parts: string[];
-    /**
-     * Magic factory function that creates a DottedPath based on the argument type.
-     */
-    static create(dottedPath?: DottedPathArgument): DottedPath;
-    /**
-     * Creates a DottedPath from a string.
-     * Allows patterns with unsafe characters wrapped in apostrophes or quotes.
-     * E.g. "part1.part2.'part.3'.part_4"
-     */
-    static createFromPath(path: string): DottedPath;
-    /**
-     * Creates a DottedPath from a string list.
-     */
-    static createFromParts(parts: string[]): DottedPath;
-    /**
-     * Creates an empty DottedPath.
-     */
-    static createEmpty(): DottedPath;
-    /**
-     * Sanitizes given part: replaces all characters like {@link DottedPath.DELIMITER}
-     * with a "safe" character like {@link DottedPath.SAFE_CHAR}.
-     * (i) Does not trim whitespace.
-     */
-    static sanitizePart(part: string): string;
-    /**
-     * Constructor
-     */
-    private constructor();
-    /**
-     * The path.
-     * (i) Does not return an empty dot for no path.
-     */
-    get path(): string;
-    /**
-     * The first part.
-     */
-    get firstPart(): string | null;
-    /**
-     * The last part.
-     */
-    get lastPart(): string | null;
-    /**
-     * Gets the tokens to each leaf of the DottedPath tree.
-     * E.g. "part1.part2.part_3" will return an array like
-     *      ["part1", "part1.part2", "part1.part2.part_3"]
-     */
-    get leafTokens(): string[];
-    /**
-     * Removes the first part and returns it.
-     */
-    shiftPart(): string | undefined;
-    /**
-     * Adds part to the beginning of parts list.
-     */
-    unshiftPart(part: string, duplicateCheck?: boolean): DottedPath;
-    /**
-     * Adds part to the end of parts list.
-     * (i) Does not add a part if the last char already is the delimiter or if an empty string was passed.
-     */
-    addPart(part: string, duplicateCheck?: boolean): DottedPath;
-    /**
-     * Adds multiple parts to the end of parts list.
-     */
-    addParts(parts: string[], duplicateCheck?: boolean): DottedPath;
-    /**
-     * Removes the last part and returns it.
-     */
-    popPart(): string | undefined;
-    toString(): string;
-    valueOf(): string;
-    /**
-     * Clones the DottedPath.
-     */
-    clone(): DottedPath;
-}
+export declare class DottedPath {
+    static DELIMITER: string;
+    static SAFE_CHAR: string;
+    parts: string[];
+    /**
+     * Magic factory function that creates a DottedPath based on the argument type.
+     */
+    static create(dottedPath?: DottedPathArgument): DottedPath;
+    /**
+     * Creates a DottedPath from a string.
+     * Allows patterns with unsafe characters wrapped in apostrophes or quotes.
+     * E.g. "part1.part2.'part.3'.part_4"
+     */
+    static createFromPath(path: string): DottedPath;
+    /**
+     * Creates a DottedPath from a string list.
+     */
+    static createFromParts(parts: string[]): DottedPath;
+    /**
+     * Creates an empty DottedPath.
+     */
+    static createEmpty(): DottedPath;
+    /**
+     * Sanitizes given part: replaces all characters like {@link DottedPath.DELIMITER}
+     * with a "safe" character like {@link DottedPath.SAFE_CHAR}.
+     * (i) Does not trim whitespace.
+     */
+    static sanitizePart(part: string): string;
+    /**
+     * Constructor
+     */
+    private constructor();
+    /**
+     * The path.
+     * (i) Does not return an empty dot for no path.
+     */
+    get path(): string;
+    /**
+     * The first part.
+     */
+    get firstPart(): string | null;
+    /**
+     * The last part.
+     */
+    get lastPart(): string | null;
+    /**
+     * Gets the tokens to each leaf of the DottedPath tree.
+     * E.g. "part1.part2.part_3" will return an array like
+     *      ["part1", "part1.part2", "part1.part2.part_3"]
+     */
+    get leafTokens(): string[];
+    /**
+     * Removes the first part and returns it.
+     */
+    shiftPart(): string | undefined;
+    /**
+     * Adds part to the beginning of parts list.
+     */
+    unshiftPart(part: string, duplicateCheck?: boolean): DottedPath;
+    /**
+     * Adds part to the end of parts list.
+     * (i) Does not add a part if the last char already is the delimiter or if an empty string was passed.
+     */
+    addPart(part: string, duplicateCheck?: boolean): DottedPath;
+    /**
+     * Adds multiple parts to the end of parts list.
+     */
+    addParts(parts: string[], duplicateCheck?: boolean): DottedPath;
+    /**
+     * Removes the last part and returns it.
+     */
+    popPart(): string | undefined;
+    toString(): string;
+    valueOf(): string;
+    /**
+     * Clones the DottedPath.
+     */
+    clone(): DottedPath;
+}

package/dist/lib-cjs/api/classes/dottedPath.js

@@ -1,167 +1,167 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DottedPath = void 0;
-class DottedPath {
-    /**
-     * Constructor
-     */
-    constructor() {
-        this.parts = [];
-    }
-    /**
-     * Magic factory function that creates a DottedPath based on the argument type.
-     */
-    static create(dottedPath) {
-        if ((dottedPath === null || dottedPath === void 0 ? void 0 : dottedPath.constructor) === DottedPath) {
-            return dottedPath.clone();
-        }
-        if ((dottedPath === null || dottedPath === void 0 ? void 0 : dottedPath.constructor) === String) {
-            return DottedPath.createFromPath(dottedPath);
-        }
-        if ((dottedPath === null || dottedPath === void 0 ? void 0 : dottedPath.constructor) === Array) {
-            return DottedPath.createFromParts(dottedPath);
-        }
-        return DottedPath.createEmpty();
-    }
-    /**
-     * Creates a DottedPath from a string.
-     * Allows patterns with unsafe characters wrapped in apostrophes or quotes.
-     * E.g. "part1.part2.'part.3'.part_4"
-     */
-    static createFromPath(path) {
-        if (path.length === 0) {
-            return this.createEmpty();
-        }
-        if (path.indexOf("'") > -1 || path.indexOf('"') > -1) {
-            const bd = '[\'|"]';
-            const search = new RegExp(`${bd}(.*)${bd}`, 'g');
-            let matches = search.exec(path);
-            while (matches !== null) {
-                const _search = new RegExp(`${bd}${matches[1]}${bd}`, 'g');
-                path = path.replace(_search, this.sanitizePart(matches[1]));
-                matches = search.exec(path);
-            }
-        }
-        return this.createFromParts(path.split(DottedPath.DELIMITER));
-    }
-    /**
-     * Creates a DottedPath from a string list.
-     */
-    static createFromParts(parts) {
-        const dottedPath = new DottedPath();
-        parts.forEach(part => dottedPath.addPart(part));
-        return dottedPath;
-    }
-    /**
-     * Creates an empty DottedPath.
-     */
-    static createEmpty() {
-        return new DottedPath();
-    }
-    /**
-     * Sanitizes given part: replaces all characters like {@link DottedPath.DELIMITER}
-     * with a "safe" character like {@link DottedPath.SAFE_CHAR}.
-     * (i) Does not trim whitespace.
-     */
-    static sanitizePart(part) {
-        return part.split(DottedPath.DELIMITER).join(DottedPath.SAFE_CHAR);
-    }
-    /**
-     * The path.
-     * (i) Does not return an empty dot for no path.
-     */
-    get path() {
-        return this.parts.length > 0 ? this.parts.join(DottedPath.DELIMITER) : '';
-    }
-    /**
-     * The first part.
-     */
-    get firstPart() {
-        if (this.parts.length > 0) {
-            return this.parts[0];
-        }
-        return null;
-    }
-    /**
-     * The last part.
-     */
-    get lastPart() {
-        if (this.parts.length > 0) {
-            return this.parts[this.parts.length - 1];
-        }
-        return null;
-    }
-    /**
-     * Gets the tokens to each leaf of the DottedPath tree.
-     * E.g. "part1.part2.part_3" will return an array like
-     *      ["part1", "part1.part2", "part1.part2.part_3"]
-     */
-    get leafTokens() {
-        const parents = [];
-        return this.parts.map(part => {
-            parents.push(part);
-            return DottedPath.create(parents).path;
-        });
-    }
-    /**
-     * Removes the first part and returns it.
-     */
-    shiftPart() {
-        return this.parts.shift();
-    }
-    /**
-     * Adds part to the beginning of parts list.
-     */
-    unshiftPart(part, duplicateCheck = false) {
-        part = DottedPath.sanitizePart(part);
-        if (duplicateCheck && this.firstPart === part) {
-            return this;
-        }
-        this.parts.unshift(part);
-        return this;
-    }
-    /**
-     * Adds part to the end of parts list.
-     * (i) Does not add a part if the last char already is the delimiter or if an empty string was passed.
-     */
-    addPart(part, duplicateCheck = false) {
-        if (part.length < 1 || this.lastPart === DottedPath.DELIMITER) {
-            return this;
-        }
-        part = DottedPath.sanitizePart(part);
-        if (duplicateCheck && this.lastPart === part) {
-            return this;
-        }
-        this.parts.push(part);
-        return this;
-    }
-    /**
-     * Adds multiple parts to the end of parts list.
-     */
-    addParts(parts, duplicateCheck = false) {
-        parts.forEach(part => this.addPart(part, duplicateCheck));
-        return this;
-    }
-    /**
-     * Removes the last part and returns it.
-     */
-    popPart() {
-        return this.parts.pop();
-    }
-    toString() {
-        return this.path;
-    }
-    valueOf() {
-        return this.path;
-    }
-    /**
-     * Clones the DottedPath.
-     */
-    clone() {
-        return DottedPath.createFromParts(this.parts);
-    }
-}
-exports.DottedPath = DottedPath;
-DottedPath.DELIMITER = '.';
-DottedPath.SAFE_CHAR = '·';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DottedPath = void 0;
+class DottedPath {
+    /**
+     * Constructor
+     */
+    constructor() {
+        this.parts = [];
+    }
+    /**
+     * Magic factory function that creates a DottedPath based on the argument type.
+     */
+    static create(dottedPath) {
+        if ((dottedPath === null || dottedPath === void 0 ? void 0 : dottedPath.constructor) === DottedPath) {
+            return dottedPath.clone();
+        }
+        if ((dottedPath === null || dottedPath === void 0 ? void 0 : dottedPath.constructor) === String) {
+            return DottedPath.createFromPath(dottedPath);
+        }
+        if ((dottedPath === null || dottedPath === void 0 ? void 0 : dottedPath.constructor) === Array) {
+            return DottedPath.createFromParts(dottedPath);
+        }
+        return DottedPath.createEmpty();
+    }
+    /**
+     * Creates a DottedPath from a string.
+     * Allows patterns with unsafe characters wrapped in apostrophes or quotes.
+     * E.g. "part1.part2.'part.3'.part_4"
+     */
+    static createFromPath(path) {
+        if (path.length === 0) {
+            return this.createEmpty();
+        }
+        if (path.indexOf("'") > -1 || path.indexOf('"') > -1) {
+            const bd = '[\'|"]';
+            const search = new RegExp(`${bd}(.*)${bd}`, 'g');
+            let matches = search.exec(path);
+            while (matches !== null) {
+                const _search = new RegExp(`${bd}${matches[1]}${bd}`, 'g');
+                path = path.replace(_search, this.sanitizePart(matches[1]));
+                matches = search.exec(path);
+            }
+        }
+        return this.createFromParts(path.split(DottedPath.DELIMITER));
+    }
+    /**
+     * Creates a DottedPath from a string list.
+     */
+    static createFromParts(parts) {
+        const dottedPath = new DottedPath();
+        parts.forEach(part => dottedPath.addPart(part));
+        return dottedPath;
+    }
+    /**
+     * Creates an empty DottedPath.
+     */
+    static createEmpty() {
+        return new DottedPath();
+    }
+    /**
+     * Sanitizes given part: replaces all characters like {@link DottedPath.DELIMITER}
+     * with a "safe" character like {@link DottedPath.SAFE_CHAR}.
+     * (i) Does not trim whitespace.
+     */
+    static sanitizePart(part) {
+        return part.split(DottedPath.DELIMITER).join(DottedPath.SAFE_CHAR);
+    }
+    /**
+     * The path.
+     * (i) Does not return an empty dot for no path.
+     */
+    get path() {
+        return this.parts.length > 0 ? this.parts.join(DottedPath.DELIMITER) : '';
+    }
+    /**
+     * The first part.
+     */
+    get firstPart() {
+        if (this.parts.length > 0) {
+            return this.parts[0];
+        }
+        return null;
+    }
+    /**
+     * The last part.
+     */
+    get lastPart() {
+        if (this.parts.length > 0) {
+            return this.parts[this.parts.length - 1];
+        }
+        return null;
+    }
+    /**
+     * Gets the tokens to each leaf of the DottedPath tree.
+     * E.g. "part1.part2.part_3" will return an array like
+     *      ["part1", "part1.part2", "part1.part2.part_3"]
+     */
+    get leafTokens() {
+        const parents = [];
+        return this.parts.map(part => {
+            parents.push(part);
+            return DottedPath.create(parents).path;
+        });
+    }
+    /**
+     * Removes the first part and returns it.
+     */
+    shiftPart() {
+        return this.parts.shift();
+    }
+    /**
+     * Adds part to the beginning of parts list.
+     */
+    unshiftPart(part, duplicateCheck = false) {
+        part = DottedPath.sanitizePart(part);
+        if (duplicateCheck && this.firstPart === part) {
+            return this;
+        }
+        this.parts.unshift(part);
+        return this;
+    }
+    /**
+     * Adds part to the end of parts list.
+     * (i) Does not add a part if the last char already is the delimiter or if an empty string was passed.
+     */
+    addPart(part, duplicateCheck = false) {
+        if (part.length < 1 || this.lastPart === DottedPath.DELIMITER) {
+            return this;
+        }
+        part = DottedPath.sanitizePart(part);
+        if (duplicateCheck && this.lastPart === part) {
+            return this;
+        }
+        this.parts.push(part);
+        return this;
+    }
+    /**
+     * Adds multiple parts to the end of parts list.
+     */
+    addParts(parts, duplicateCheck = false) {
+        parts.forEach(part => this.addPart(part, duplicateCheck));
+        return this;
+    }
+    /**
+     * Removes the last part and returns it.
+     */
+    popPart() {
+        return this.parts.pop();
+    }
+    toString() {
+        return this.path;
+    }
+    valueOf() {
+        return this.path;
+    }
+    /**
+     * Clones the DottedPath.
+     */
+    clone() {
+        return DottedPath.createFromParts(this.parts);
+    }
+}
+exports.DottedPath = DottedPath;
+DottedPath.DELIMITER = '.';
+DottedPath.SAFE_CHAR = '·';
 //# sourceMappingURL=dottedPath.js.map