@combeenation/3d-viewer 8.1.0-alpha1 → 9.0.1

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

@@ -1,43 +1,43 @@
-/**
- * Combeenation configurators are explicitly catching and handling some specific errors thrown by the viewer.
- * We use this custom error class which adds a unique ID to each error so that we can safely distinguish the different
- * errors without having to look at the thrown text.
- */
-declare type ViewerErrorData = {
-    /** One of `GlobalViewerErrorIds` */
-    id: string;
-    message: string;
-};
-/**
- * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- * !!! Note: Combeenation viewer ctrl needs to be adjusted, whenever changing existing keys here. !!!
- * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- *
- * IDs here shall only include "word characters" (`/w` in RegEx) as `GetViewerErrorIdFromMsg` wouldn't work correctly
- * otherwise.
- */
-export declare const ViewerErrorIds: {
-    InvalidParameterValue: string;
-    UnknownParameterOption: string;
-    AssetLoadingFailed: string;
-};
-export declare class ViewerError extends Error {
-    viewerErrorId: string;
-    constructor(data: ViewerErrorData);
-    /**
-     * Splits the given error message into a known viewer error id and the message itself.
-     *
-     * E.g.:
-     * Message `[InvalidParameterValue] Some error msg` returns `{ id: 'InvalidParameterValue', msg: 'Some error msg' }`
-     *
-     * @param message An error message in the form `[KnownErrorId] Some error msg`
-     * @returns id = The extracted error id (one of `GlobalViewerErrorIds`) or `undefined` if no valid ID has been found
-     *          msg = The error message without the prefixed ID. Returns the whole given `message` if it isn't prefixed
-     *                with a known ID in the correct format.
-     */
-    static SplitViewerErrorMsg(message: string): {
-        id: string | undefined;
-        msg: string;
-    };
-}
-export {};
+/**
+ * Combeenation configurators are explicitly catching and handling some specific errors thrown by the viewer.
+ * We use this custom error class which adds a unique ID to each error so that we can safely distinguish the different
+ * errors without having to look at the thrown text.
+ */
+declare type ViewerErrorData = {
+    /** One of `GlobalViewerErrorIds` */
+    id: string;
+    message: string;
+};
+/**
+ * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ * !!! Note: Combeenation viewer ctrl needs to be adjusted, whenever changing existing keys here. !!!
+ * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ *
+ * IDs here shall only include "word characters" (`/w` in RegEx) as `GetViewerErrorIdFromMsg` wouldn't work correctly
+ * otherwise.
+ */
+export declare const ViewerErrorIds: {
+    InvalidParameterValue: string;
+    UnknownParameterOption: string;
+    AssetLoadingFailed: string;
+};
+export declare class ViewerError extends Error {
+    viewerErrorId: string;
+    constructor(data: ViewerErrorData);
+    /**
+     * Splits the given error message into a known viewer error id and the message itself.
+     *
+     * E.g.:
+     * Message `[InvalidParameterValue] Some error msg` returns `{ id: 'InvalidParameterValue', msg: 'Some error msg' }`
+     *
+     * @param message An error message in the form `[KnownErrorId] Some error msg`
+     * @returns id = The extracted error id (one of `GlobalViewerErrorIds`) or `undefined` if no valid ID has been found
+     *          msg = The error message without the prefixed ID. Returns the whole given `message` if it isn't prefixed
+     *                with a known ID in the correct format.
+     */
+    static SplitViewerErrorMsg(message: string): {
+        id: string | undefined;
+        msg: string;
+    };
+}
+export {};

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

@@ -1,56 +1,56 @@
-"use strict";
-/**
- * Combeenation configurators are explicitly catching and handling some specific errors thrown by the viewer.
- * We use this custom error class which adds a unique ID to each error so that we can safely distinguish the different
- * errors without having to look at the thrown text.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ViewerError = exports.ViewerErrorIds = void 0;
-/**
- * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- * !!! Note: Combeenation viewer ctrl needs to be adjusted, whenever changing existing keys here. !!!
- * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- *
- * IDs here shall only include "word characters" (`/w` in RegEx) as `GetViewerErrorIdFromMsg` wouldn't work correctly
- * otherwise.
- */
-exports.ViewerErrorIds = {
-    InvalidParameterValue: 'InvalidParameterValue',
-    UnknownParameterOption: 'UnknownParameterOption',
-    AssetLoadingFailed: 'AssetLoadingFailed',
-};
-class ViewerError extends Error {
-    constructor(data) {
-        // Unfortunately we can't access the custom `viewerErrorId` property when catching global errors in Combeenation so
-        // we also have to add the ID to the message itself.
-        super(`[${data.id}] ${data.message}`);
-        this.viewerErrorId = data.id;
-    }
-    /**
-     * Splits the given error message into a known viewer error id and the message itself.
-     *
-     * E.g.:
-     * Message `[InvalidParameterValue] Some error msg` returns `{ id: 'InvalidParameterValue', msg: 'Some error msg' }`
-     *
-     * @param message An error message in the form `[KnownErrorId] Some error msg`
-     * @returns id = The extracted error id (one of `GlobalViewerErrorIds`) or `undefined` if no valid ID has been found
-     *          msg = The error message without the prefixed ID. Returns the whole given `message` if it isn't prefixed
-     *                with a known ID in the correct format.
-     */
-    static SplitViewerErrorMsg(message) {
-        var _a, _b;
-        const knownIds = Object.values(exports.ViewerErrorIds).join('|');
-        // RegEx:
-        //   `^`                  = Start of string
-        //   `\\[`                = Literal `[`
-        //   `(?<id>abc|xyz|...)` = Named capture group `id` which looks for one of the existing error ids
-        //   `] `                 = Literal `] `
-        //   `(?<msg>.*)`         = Named capture group `msg` which looks for everything after the matched group id
-        const result = new RegExp('^\\[(?<id>' + knownIds + ')] (?<msg>.*)').exec(message);
-        const id = (_a = result === null || result === void 0 ? void 0 : result.groups) === null || _a === void 0 ? void 0 : _a.id;
-        const msg = ((_b = result === null || result === void 0 ? void 0 : result.groups) === null || _b === void 0 ? void 0 : _b.msg) || message;
-        return { id, msg };
-    }
-}
-exports.ViewerError = ViewerError;
+"use strict";
+/**
+ * Combeenation configurators are explicitly catching and handling some specific errors thrown by the viewer.
+ * We use this custom error class which adds a unique ID to each error so that we can safely distinguish the different
+ * errors without having to look at the thrown text.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewerError = exports.ViewerErrorIds = void 0;
+/**
+ * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ * !!! Note: Combeenation viewer ctrl needs to be adjusted, whenever changing existing keys here. !!!
+ * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ *
+ * IDs here shall only include "word characters" (`/w` in RegEx) as `GetViewerErrorIdFromMsg` wouldn't work correctly
+ * otherwise.
+ */
+exports.ViewerErrorIds = {
+    InvalidParameterValue: 'InvalidParameterValue',
+    UnknownParameterOption: 'UnknownParameterOption',
+    AssetLoadingFailed: 'AssetLoadingFailed',
+};
+class ViewerError extends Error {
+    constructor(data) {
+        // Unfortunately we can't access the custom `viewerErrorId` property when catching global errors in Combeenation so
+        // we also have to add the ID to the message itself.
+        super(`[${data.id}] ${data.message}`);
+        this.viewerErrorId = data.id;
+    }
+    /**
+     * Splits the given error message into a known viewer error id and the message itself.
+     *
+     * E.g.:
+     * Message `[InvalidParameterValue] Some error msg` returns `{ id: 'InvalidParameterValue', msg: 'Some error msg' }`
+     *
+     * @param message An error message in the form `[KnownErrorId] Some error msg`
+     * @returns id = The extracted error id (one of `GlobalViewerErrorIds`) or `undefined` if no valid ID has been found
+     *          msg = The error message without the prefixed ID. Returns the whole given `message` if it isn't prefixed
+     *                with a known ID in the correct format.
+     */
+    static SplitViewerErrorMsg(message) {
+        var _a, _b;
+        const knownIds = Object.values(exports.ViewerErrorIds).join('|');
+        // RegEx:
+        //   `^`                  = Start of string
+        //   `\\[`                = Literal `[`
+        //   `(?<id>abc|xyz|...)` = Named capture group `id` which looks for one of the existing error ids
+        //   `] `                 = Literal `] `
+        //   `(?<msg>.*)`         = Named capture group `msg` which looks for everything after the matched group id
+        const result = new RegExp('^\\[(?<id>' + knownIds + ')] (?<msg>.*)').exec(message);
+        const id = (_a = result === null || result === void 0 ? void 0 : result.groups) === null || _a === void 0 ? void 0 : _a.id;
+        const msg = ((_b = result === null || result === void 0 ? void 0 : result.groups) === null || _b === void 0 ? void 0 : _b.msg) || message;
+        return { id, msg };
+    }
+}
+exports.ViewerError = ViewerError;
 //# sourceMappingURL=viewerError.js.map

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

@@ -1,66 +1,66 @@
-import { DottedPath } from './dottedPath';
-import { Variant } from './variant';
-import { VariantParameterizable } from './variantParameterizable';
-import { ShadowGenerator } from '@babylonjs/core/Lights/Shadows/shadowGenerator';
-import '@babylonjs/core/Lights/Shadows/shadowGeneratorSceneComponent';
-import { Light } from '@babylonjs/core/Lights/light';
-import { ShadowLight } from '@babylonjs/core/Lights/shadowLight';
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_lights_punctual';
-/**
- * A {@link ViewerLight} of a {@link Variant}. Acts as a container for Babylon.js lights. Lives only in the context of a
- * {@link Variant}.
- */
-export declare class ViewerLight extends VariantParameterizable {
-    readonly variant: Variant;
-    readonly name: string;
-    protected _light: Light | undefined;
-    /**
-     * Constructor.
-     */
-    protected constructor(variant: Variant, name: string);
-    /**
-     * Creates a {@link ViewerLight} with given name.
-     */
-    static create(variant: Variant, name: string): Promise<ViewerLight>;
-    /**
-     * The wrapped Light.
-     */
-    get light(): Light;
-    /**
-     * The {@link DottedPath} in the built tree of {@link ViewerLight}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 LightDefinition} of the {@link ViewerLight}.
-     */
-    get definition(): LightDefinition;
-    /**
-     * The type of the {@link ViewerLight}'s light.
-     */
-    get type(): string;
-    /**
-     * @see {@link VariantParameterizable.commitParameters}
-     * @emit {@link Event.VIEWER_LIGHT_PARAMETER_COMMITTED}
-     */
-    commitParameters(parameters?: ParameterBag): Promise<VariantParameterizable>;
-    /**
-     * Adds the default {@link ParameterObserver}s which are called every time {@link commitParameters} is called.
-     */
-    protected addParameterObservers(): ViewerLight;
-    /**
-     * @param definition
-     * @protected
-     */
-    protected createBabylonLightFromDefinition(definition: LightDefinition): Promise<Light>;
-    /**
-     * @param babylonLight
-     * @param definition
-     * @protected
-     */
-    protected processShadowGenerator(babylonLight: ShadowLight, definition: ShadowGeneratorDefinition): Promise<ShadowGenerator>;
-}
+import { DottedPath } from './dottedPath';
+import { Variant } from './variant';
+import { VariantParameterizable } from './variantParameterizable';
+import { ShadowGenerator } from '@babylonjs/core/Lights/Shadows/shadowGenerator';
+import '@babylonjs/core/Lights/Shadows/shadowGeneratorSceneComponent';
+import { Light } from '@babylonjs/core/Lights/light';
+import { ShadowLight } from '@babylonjs/core/Lights/shadowLight';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_lights_punctual';
+/**
+ * A {@link ViewerLight} of a {@link Variant}. Acts as a container for Babylon.js lights. Lives only in the context of a
+ * {@link Variant}.
+ */
+export declare class ViewerLight extends VariantParameterizable {
+    readonly variant: Variant;
+    readonly name: string;
+    protected _light: Light | undefined;
+    /**
+     * Constructor.
+     */
+    protected constructor(variant: Variant, name: string);
+    /**
+     * Creates a {@link ViewerLight} with given name.
+     */
+    static create(variant: Variant, name: string): Promise<ViewerLight>;
+    /**
+     * The wrapped Light.
+     */
+    get light(): Light;
+    /**
+     * The {@link DottedPath} in the built tree of {@link ViewerLight}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 LightDefinition} of the {@link ViewerLight}.
+     */
+    get definition(): LightDefinition;
+    /**
+     * The type of the {@link ViewerLight}'s light.
+     */
+    get type(): string;
+    /**
+     * @see {@link VariantParameterizable.commitParameters}
+     * @emit {@link Event.VIEWER_LIGHT_PARAMETER_COMMITTED}
+     */
+    commitParameters(parameters?: ParameterBag): Promise<VariantParameterizable>;
+    /**
+     * Adds the default {@link ParameterObserver}s which are called every time {@link commitParameters} is called.
+     */
+    protected addParameterObservers(): ViewerLight;
+    /**
+     * @param definition
+     * @protected
+     */
+    protected createBabylonLightFromDefinition(definition: LightDefinition): Promise<Light>;
+    /**
+     * @param babylonLight
+     * @param definition
+     * @protected
+     */
+    protected processShadowGenerator(babylonLight: ShadowLight, definition: ShadowGeneratorDefinition): Promise<ShadowGenerator>;
+}