@combeenation/3d-viewer 3.0.0-rc2 → 4.0.0-alpha6

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

@@ -1,191 +1,191 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DottedPath = void 0;
-var DottedPath = /** @class */ (function () {
-    /**
-     * Constructor
-     */
-    function DottedPath() {
-        this.parts = [];
-    }
-    /**
-     * Magic factory function that creates a DottedPath based on the argument type.
-     */
-    DottedPath.create = function (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"
-     */
-    DottedPath.createFromPath = function (path) {
-        if (path.length === 0) {
-            return this.createEmpty();
-        }
-        if (path.indexOf("'") > -1 || path.indexOf('"') > -1) {
-            var bd = '[\'|"]';
-            var search = new RegExp(bd + "(.*)" + bd, 'g');
-            var matches = search.exec(path);
-            while (matches !== null) {
-                var _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.
-     */
-    DottedPath.createFromParts = function (parts) {
-        var dottedPath = new DottedPath();
-        parts.forEach(function (part) { return dottedPath.addPart(part); });
-        return dottedPath;
-    };
-    /**
-     * Creates an empty DottedPath.
-     */
-    DottedPath.createEmpty = function () {
-        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.
-     */
-    DottedPath.sanitizePart = function (part) {
-        return part.split(DottedPath.DELIMITER).join(DottedPath.SAFE_CHAR);
-    };
-    Object.defineProperty(DottedPath.prototype, "path", {
-        /**
-         * The path.
-         * (i) Does not return an empty dot for no path.
-         */
-        get: function () {
-            return this.parts.length > 0
-                ? this.parts.join(DottedPath.DELIMITER)
-                : '';
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(DottedPath.prototype, "firstPart", {
-        /**
-         * The first part.
-         */
-        get: function () {
-            if (this.parts.length > 0) {
-                return this.parts[0];
-            }
-            return null;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(DottedPath.prototype, "lastPart", {
-        /**
-         * The last part.
-         */
-        get: function () {
-            if (this.parts.length > 0) {
-                return this.parts[this.parts.length - 1];
-            }
-            return null;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(DottedPath.prototype, "leafTokens", {
-        /**
-         * 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: function () {
-            var parents = [];
-            return this.parts.map(function (part) {
-                parents.push(part);
-                return DottedPath.create(parents).path;
-            });
-        },
-        enumerable: false,
-        configurable: true
-    });
-    /**
-     * Removes the first part and returns it.
-     */
-    DottedPath.prototype.shiftPart = function () {
-        return this.parts.shift();
-    };
-    /**
-     * Adds part to the beginning of parts list.
-     */
-    DottedPath.prototype.unshiftPart = function (part, duplicateCheck) {
-        if (duplicateCheck === void 0) { 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.
-     */
-    DottedPath.prototype.addPart = function (part, duplicateCheck) {
-        if (duplicateCheck === void 0) { 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.
-     */
-    DottedPath.prototype.addParts = function (parts, duplicateCheck) {
-        var _this = this;
-        if (duplicateCheck === void 0) { duplicateCheck = false; }
-        parts.forEach(function (part) { return _this.addPart(part, duplicateCheck); });
-        return this;
-    };
-    /**
-     * Removes the last part and returns it.
-     */
-    DottedPath.prototype.popPart = function () {
-        return this.parts.pop();
-    };
-    DottedPath.prototype.toString = function () {
-        return this.path;
-    };
-    DottedPath.prototype.valueOf = function () {
-        return this.path;
-    };
-    /**
-     * Clones the DottedPath.
-     */
-    DottedPath.prototype.clone = function () {
-        return DottedPath.createFromParts(this.parts);
-    };
-    DottedPath.DELIMITER = '.';
-    DottedPath.SAFE_CHAR = '·';
-    return DottedPath;
-}());
-exports.DottedPath = DottedPath;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DottedPath = void 0;
+var DottedPath = /** @class */ (function () {
+    /**
+     * Constructor
+     */
+    function DottedPath() {
+        this.parts = [];
+    }
+    /**
+     * Magic factory function that creates a DottedPath based on the argument type.
+     */
+    DottedPath.create = function (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"
+     */
+    DottedPath.createFromPath = function (path) {
+        if (path.length === 0) {
+            return this.createEmpty();
+        }
+        if (path.indexOf("'") > -1 || path.indexOf('"') > -1) {
+            var bd = '[\'|"]';
+            var search = new RegExp(bd + "(.*)" + bd, 'g');
+            var matches = search.exec(path);
+            while (matches !== null) {
+                var _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.
+     */
+    DottedPath.createFromParts = function (parts) {
+        var dottedPath = new DottedPath();
+        parts.forEach(function (part) { return dottedPath.addPart(part); });
+        return dottedPath;
+    };
+    /**
+     * Creates an empty DottedPath.
+     */
+    DottedPath.createEmpty = function () {
+        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.
+     */
+    DottedPath.sanitizePart = function (part) {
+        return part.split(DottedPath.DELIMITER).join(DottedPath.SAFE_CHAR);
+    };
+    Object.defineProperty(DottedPath.prototype, "path", {
+        /**
+         * The path.
+         * (i) Does not return an empty dot for no path.
+         */
+        get: function () {
+            return this.parts.length > 0
+                ? this.parts.join(DottedPath.DELIMITER)
+                : '';
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(DottedPath.prototype, "firstPart", {
+        /**
+         * The first part.
+         */
+        get: function () {
+            if (this.parts.length > 0) {
+                return this.parts[0];
+            }
+            return null;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(DottedPath.prototype, "lastPart", {
+        /**
+         * The last part.
+         */
+        get: function () {
+            if (this.parts.length > 0) {
+                return this.parts[this.parts.length - 1];
+            }
+            return null;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(DottedPath.prototype, "leafTokens", {
+        /**
+         * 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: function () {
+            var parents = [];
+            return this.parts.map(function (part) {
+                parents.push(part);
+                return DottedPath.create(parents).path;
+            });
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Removes the first part and returns it.
+     */
+    DottedPath.prototype.shiftPart = function () {
+        return this.parts.shift();
+    };
+    /**
+     * Adds part to the beginning of parts list.
+     */
+    DottedPath.prototype.unshiftPart = function (part, duplicateCheck) {
+        if (duplicateCheck === void 0) { 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.
+     */
+    DottedPath.prototype.addPart = function (part, duplicateCheck) {
+        if (duplicateCheck === void 0) { 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.
+     */
+    DottedPath.prototype.addParts = function (parts, duplicateCheck) {
+        var _this = this;
+        if (duplicateCheck === void 0) { duplicateCheck = false; }
+        parts.forEach(function (part) { return _this.addPart(part, duplicateCheck); });
+        return this;
+    };
+    /**
+     * Removes the last part and returns it.
+     */
+    DottedPath.prototype.popPart = function () {
+        return this.parts.pop();
+    };
+    DottedPath.prototype.toString = function () {
+        return this.path;
+    };
+    DottedPath.prototype.valueOf = function () {
+        return this.path;
+    };
+    /**
+     * Clones the DottedPath.
+     */
+    DottedPath.prototype.clone = function () {
+        return DottedPath.createFromParts(this.parts);
+    };
+    DottedPath.DELIMITER = '.';
+    DottedPath.SAFE_CHAR = '·';
+    return DottedPath;
+}());
+exports.DottedPath = DottedPath;
 //# sourceMappingURL=dottedPath.js.map

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

@@ -1,125 +1,130 @@
-import { HighlightLayer } from '@babylonjs/core/Layers/highlightLayer';
-import { Mesh } from '@babylonjs/core/Meshes/mesh';
-import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
-import { DottedPath } from './dottedPath';
-import { ElementParameterizable } from './elementParameterizable';
-import { Variant } from './variant';
-/**
- * An {@link Element} of a {@link Variant}. Acts as a container for diverse definitions. Lives only in the context of a
- * {@link Variant}.
- *
- * When used in typings, refer to via its alias {@link VariantElement} to prevent name clashes with the web APIs
- * [Element](https://developer.mozilla.org/en-US/docs/Web/API/Element) class
- */
-export declare class Element extends ElementParameterizable {
-    readonly variant: Variant;
-    readonly name: string;
-    protected readonly _dottedNodes: Map<DottedPath, TransformNode>;
-    protected readonly _parameterObservers: Map<string, ParameterObserver[]>;
-    protected _highlightLayer?: HighlightLayer;
-    readonly nodes: TransformNode[];
-    /**
-     * Constructor.
-     */
-    constructor(variant: Variant, name: string);
-    /**
-     * The {@link DottedPath} in the built tree of {@link Element}s.
-     * E.g. "_.top-1.sub-2.sub-sub-3.el-1"
-     */
-    get dottedPath(): DottedPath;
-    /**
-     * The id representing a {@link DottedPath}.
-     */
-    get id(): string;
-    /**
-     * The {@link ElementDefinition} of the {@link Element}.
-     */
-    get definition(): ElementDefinition;
-    /**
-     * The {@link PathDefinitions} of the {@link Element}.
-     */
-    get pathDefinitions(): PathDefinitions;
-    /**
-     * The {@link TraceableDefinitions} of the {@link Element}.
-     */
-    get traceableDefinitions(): TraceableDefinitions;
-    /**
-     * The {@link PaintableDefinition} of the {@link Element}.
-     */
-    get paintableDefinitions(): PaintableDefinitions;
-    /**
-     * The inherited {@link ParameterBag}.
-     * Merges the {@link Variant}'s parameters and those from the {@link Element}.
-     */
-    get inheritedParameters(): ParameterBag;
-    /**
-     * @protected
-     */
-    set highlightLayer(layer: HighlightLayer | undefined);
-    get highlightLayer(): HighlightLayer | undefined;
-    /**
-     * Destroys this {@link Element} and dispose all nodes.
-     */
-    destroy(): Element;
-    /**
-     * Gets a node by its {@link DottedPath}.
-     */
-    getNode(dottedPath: DottedPathArgument): TransformNode;
-    /**
-     * Gets a mesh by its {@link DottedPath}.
-     */
-    getMesh(dottedPath: DottedPathArgument): Promise<Mesh | null>;
-    /**
-     * Gets a {@link PaintableDefinition} by its name.
-     */
-    getPaintableDefinition(name: string): PaintableDefinition;
-    /**
-     * Gets a {@link TraceableDefinition} by its name.
-     */
-    getTraceableDefinition(name: string): TraceableDefinition;
-    /**
-     * Gets the paintable Node by its name.
-     */
-    getPaintableNode(name: string): TransformNode;
-    /**
-     * Gets the traceable Node by its name.
-     */
-    getTraceableNode(name: string): TransformNode;
-    /**
-     * Places the given {@link ParameterBag} in the {@link Element}'s parameters, replaces all patterns in the
-     * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
-     *
-     * @emit {@link Event.ELEMENT_PARAMETER_COMMITTED}
-     */
-    commitParameters(parameters?: ParameterBag): Promise<Element>;
-    /**
-     * Adds an observer function for camera matrix changes.
-     * The `observer` gets 2 parameters: the `AbstractMesh` and a `ClientRect` object.
-     */
-    addTraceableObserver(traceable: string, observer: CallableFunction, payload?: any): Element;
-    /**
-     * Draws a `ImageBitmap` or `OffscreenCanvas` onto a `paintable` defined via {@link PaintableDefinition}.
-     */
-    drawPaintable(paintable: string, imageSource: CanvasImageSource): Element;
-    /**
-     * Draws a SVG string onto a `paintable` defined via {@link PaintableDefinition}.
-     */
-    drawPaintableFromSvg(paintable: string, svgSource: string): Promise<Element>;
-    /**
-     * Draws an Image from source (URL/URI) onto a `paintable` defined via {@link PaintableDefinition}.
-     */
-    drawPaintableFromImgSrc(paintable: string, imgSource: string): Promise<Element>;
-    /**
-     * Adds the default {@link ParameterObserver}s which are called every time {@link commitParameters} is called.
-     */
-    protected addParameterObservers(): Element;
-    /**
-     * Filter for nodes that are not defined or excluded in the `pathDefinitions`.
-     */
-    protected filterNode(node: TransformNode): boolean;
-    /**
-     * Asserts whether all {@link pathDefinitions} link to a valid `Node` path.
-     * @protected
-     */
-    protected assertPathDefinitions(): void;
-}
+import { HighlightLayer } from '@babylonjs/core/Layers/highlightLayer';
+import { Mesh } from '@babylonjs/core/Meshes/mesh';
+import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
+import { VariantParameterizable } from './../classes/variantParameterizable';
+import { DottedPath } from './dottedPath';
+import { Variant } from './variant';
+/**
+ * An {@link Element} of a {@link Variant}. Acts as a container for diverse definitions. Lives only in the context of a
+ * {@link Variant}.
+ *
+ * When used in typings, refer to via its alias {@link VariantElement} to prevent name clashes with the web APIs
+ * [Element](https://developer.mozilla.org/en-US/docs/Web/API/Element) class
+ */
+export declare class Element extends VariantParameterizable {
+    readonly variant: Variant;
+    readonly name: string;
+    readonly nodes: TransformNode[];
+    protected readonly _dottedNodes: Map<DottedPath, TransformNode>;
+    protected _highlightLayer?: HighlightLayer;
+    /**
+     * Constructor.
+     */
+    protected constructor(variant: Variant, name: string);
+    /**
+     * Creates an {@link Element} with given name.
+     */
+    static create(variant: Variant, name: string): Promise<Element>;
+    /**
+     * The {@link DottedPath} in the built tree of {@link Element}s.
+     * E.g. "_.top-1.sub-2.sub-sub-3.el-1"
+     */
+    get dottedPath(): DottedPath;
+    /**
+     * The id representing a {@link DottedPath}.
+     */
+    get id(): string;
+    /**
+     * The {@link ElementDefinition} of the {@link Element}.
+     */
+    get definition(): ElementDefinition;
+    /**
+     * The {@link PathDefinitions} of the {@link Element}.
+     */
+    get pathDefinitions(): PathDefinitions;
+    /**
+     * The {@link TraceableDefinitions} of the {@link Element}.
+     */
+    get traceableDefinitions(): TraceableDefinitions;
+    /**
+     * The {@link PaintableDefinition} of the {@link Element}.
+     */
+    get paintableDefinitions(): PaintableDefinitions;
+    /**
+     * The inherited {@link ParameterBag}.
+     * Merges the {@link Variant}'s parameters and those from the {@link Element}.
+     */
+    get inheritedParameters(): ParameterBag;
+    /**
+     * @protected
+     */
+    set highlightLayer(layer: HighlightLayer | undefined);
+    get highlightLayer(): HighlightLayer | undefined;
+    /**
+     * Destroys this {@link Element} and dispose all nodes.
+     */
+    destroy(): Element;
+    /**
+     * Gets a node by its {@link DottedPath}.
+     */
+    getNode(dottedPath: DottedPathArgument): TransformNode;
+    /**
+     * Gets a mesh by its {@link DottedPath}.
+     */
+    getMesh(dottedPath: DottedPathArgument): Promise<Mesh | null>;
+    /**
+     * Gets a {@link PaintableDefinition} by its name.
+     */
+    getPaintableDefinition(name: string): PaintableDefinition;
+    /**
+     * Gets a {@link TraceableDefinition} by its name.
+     */
+    getTraceableDefinition(name: string): TraceableDefinition;
+    /**
+     * Gets the paintable Node by its name.
+     */
+    getPaintableNode(name: string): TransformNode;
+    /**
+     * Gets the traceable Node by its name.
+     */
+    getTraceableNode(name: string): TransformNode;
+    /**
+     * @see {@link VariantParameterizable.commitParameters}
+     * @emit {@link Event.ELEMENT_PARAMETER_COMMITTED}
+     */
+    commitParameters(parameters?: ParameterBag): Promise<VariantParameterizable>;
+    /**
+     * Adds an observer function for camera matrix changes.
+     * The `observer` gets 2 parameters: the `AbstractMesh` and a `ClientRect` object.
+     */
+    addTraceableObserver(traceable: string, observer: CallableFunction, payload?: any): Element;
+    /**
+     * Draws a `ImageBitmap` or `OffscreenCanvas` onto a `paintable` defined via {@link PaintableDefinition}.
+     */
+    drawPaintable(paintable: string, imageSource: CanvasImageSource): Element;
+    /**
+     * Draws a SVG string onto a `paintable` defined via {@link PaintableDefinition}.
+     */
+    drawPaintableFromSvg(paintable: string, svgSource: string): Promise<Element>;
+    /**
+     * Draws an Image from source (URL/URI) onto a `paintable` defined via {@link PaintableDefinition}.
+     */
+    drawPaintableFromImgSrc(paintable: string, imgSource: string): Promise<Element>;
+    /**
+     * Adds the default {@link ParameterObserver}s which are called every time {@link commitParameters} is called.
+     */
+    protected addParameterObservers(): Element;
+    /**
+     * Filter for nodes that are not defined or excluded in the `pathDefinitions`.
+     */
+    protected filterNode(node: TransformNode): boolean;
+    /**
+     * Asserts whether all {@link pathDefinitions} link to a valid `Node` path.
+     * @protected
+     */
+    protected assertPathDefinitions(): void;
+    /**
+     * Handles callback for given light parameter.
+     */
+    private castShadowValueHandler;
+}