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

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

@@ -1,176 +1,224 @@
-import { AssetContainer } from '@babylonjs/core/assetContainer';
-import '@babylonjs/core/Loading/Plugins/babylonFileLoader';
-import { Material } from '@babylonjs/core/Materials/material';
-import { Mesh } from '@babylonjs/core/Meshes/mesh';
-import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_draco_mesh_compression';
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_texture_transform';
-import '@babylonjs/loaders/glTF/2.0/glTFLoader';
-import { DottedPath } from './dottedPath';
-import { Element } from './element';
-import { ElementParameterizable } from './elementParameterizable';
-import { Viewer } from './viewer';
-/**
- * A concrete "Variant". Most of these are handled by either the {@link Viewer} or {@link VariantInstance}.
- */
-export declare class Variant extends ElementParameterizable {
-    readonly name: string;
-    protected readonly _structureJson: StructureJson;
-    readonly viewer: Viewer;
-    readonly parent?: Variant | undefined;
-    assetContainer: AssetContainer;
-    readonly elements: Element[];
-    structureJson: StructureJson;
-    protected _dottedNodes: Map<DottedPath, TransformNode> | undefined;
-    protected readonly _children: Map<string, Variant>;
-    protected readonly _parameterObservers: Map<string, ParameterObserver[]>;
-    /**
-     * @internal
-     */
-    private parametersInitialized;
-    /**
-     * Constructor.
-     */
-    protected constructor(name: string, _structureJson: StructureJson, viewer: Viewer, parent?: Variant | undefined);
-    /**
-     * Creates a {@link Variant} based on given parameters.
-     *
-     * @throws Error if "gltf" property is provided without a filename
-     */
-    static create(name: string, structureJson: StructureJson, viewer: Viewer, parent?: Variant): Promise<Variant>;
-    /**
-     * The ancestor {@link Variant}s ordered from top to bottom in the built tree.
-     */
-    get ancestors(): Variant[];
-    /**
-     * The root {@link Variant}.
-     */
-    get root(): Variant;
-    /**
-     * The {@link DottedPath} in the built tree of {@link Variant}s.
-     * E.g. "_.top-1.sub-2.sub-sub-3"
-     */
-    get dottedPath(): DottedPath;
-    /**
-     * The id representing a {@link DottedPath}.
-     */
-    get id(): string;
-    /**
-     * The defined glTF Asset.
-     */
-    get glTF(): Asset | undefined;
-    /**
-     * The defined glTF URI.
-     */
-    get glTFUri(): string | undefined;
-    /**
-     * The inherited defined glTF URI.
-     */
-    get inheritedGlTFUri(): string | undefined;
-    /**
-     * The TransformNodes of the {@link Variant}.
-     */
-    get nodes(): TransformNode[];
-    /**
-     * All TransformNodes of the {@link Variant} mapped flat with a {@link DottedPath}.
-     */
-    get dottedNodes(): Map<DottedPath, TransformNode>;
-    /**
-     * The Materials of the {@link Variant}.
-     */
-    get materials(): Material[];
-    /**
-     * All {@link Element}s from this {@link Variant}'s parents.
-     */
-    get inheritedElements(): Element[];
-    /**
-     * All TransformNodes inherited from this {@link Variant}'s parents.
-     */
-    get inheritedNodes(): TransformNode[];
-    /**
-     * All TransformNodes inherited from this {@link Variant}'s parents mapped flat with a {@link DottedPath}.
-     */
-    get inheritedDottedNodes(): Map<DottedPath, TransformNode>;
-    /**
-     * The {@link ParameterDeclarations} inherited from this {@link Variant}'s parents.
-     */
-    get inheritedParameterDeclaration(): ParameterDeclarations;
-    /**
-     * The {@link ParameterBag} inherited from this {@link Variant}'s parents.
-     */
-    get inheritedParameters(): ParameterBag;
-    /**
-     * All Materials from this {@link Variant}'s parents.
-     */
-    get inheritedMaterials(): Material[];
-    /**
-     * Gets the direct children of the current {@link Variant}.
-     */
-    getChildren(): Promise<Variant[]>;
-    /**
-     *  Gets a descendant {@link Variant} of the current {@link Variant} relative to its {@link DottedPath}.
-     *  If you have the dotted path `_.product_x.variant_blue.with_yellow_highlight` in a tree and you operate on the
-     *  `product_x`, you can call `this.getDescendant('variant_blue.with_yellow_highlight')` to get the lowermost
-     *  {@link Variant}.
-     */
-    getDescendant(dottedPath: DottedPathArgument): Promise<Variant>;
-    /**
-     * Gets the desired {@link Element} of the current {@link Variant} relative to its {@link DottedPath}.
-     * Uses the mechanism of {@link getDescendant} to resolve the appropriate variant in tree.
-     */
-    getElement(dottedPath: DottedPathArgument): Promise<Element>;
-    /**
-     * A proxy for directly getting a Node from an {@link Element} by its {@link DottedPath}s.
-     */
-    getNode(elementDottedPath: DottedPathArgument, nodeDottedPath: DottedPathArgument): Promise<TransformNode>;
-    /**
-     * A proxy for directly getting a Mesh from an {@link Element} by its {@link DottedPath}s.
-     */
-    getMesh(elementDottedPath: DottedPathArgument, meshDottedPath: DottedPathArgument): Promise<Mesh | null>;
-    /**
-     * Gets the Material defined in one of the variants glTFs by its id.
-     */
-    getMaterial(id: string): Material;
-    /**
-     * Creates a living clone of this {@link Variant}. Will clone all parent {@link Variant}s in tree.
-     *
-     * @emit {@link Event.VARIANT_CREATED}
-     * @ignore
-     */
-    createLiving(parameters?: ParameterBag): Promise<Variant>;
-    /**
-     * Destroys this {@link Variant}, all parents and destroy the {@link Element}s.
-     */
-    destroy(): Variant;
-    /**
-     * Places the given {@link ParameterBag} in the {@link Variant}'s parameters, replaces all patterns in the
-     * {@link StructureJson}, broadcasts all {@link ParameterObserver}s and delegates them to its {@link Element}s.
-     *
-     * @emit {@link Event.VARIANT_PARAMETER_COMMITTED}
-     */
-    commitParameters(parameters?: ParameterBag): Promise<Variant>;
-    /**
-     * Adds an observer function for camera matrix changes for given `dottedPath` representing the {@link Element}
-     * and the `traceable`. The `observer` gets 2 parameters: the `AbstractMesh` and a `ClientRect` object.
-     */
-    addTraceableObserver(dottedPath: DottedPathArgument, observer: CallableFunction, payload?: any): Promise<Element>;
-    /**
-     * Loads {@link glTFUri} with assets, adds them to the {@link Variant}'s `assetContainer` and deactivates the meshes.
-     * (for further processing).
-     * @emits {@link Event.ASSET_LOADING_START}
-     * @emits {@link Event.ASSET_LOADING_END}
-     */
-    protected loadAssets(): Promise<Variant>;
-    /**
-     * Adds the default {@link ParameterObserver}s which are called every time {@link commitParameters} is called.
-     */
-    protected addParameterObservers(): Variant;
-    /**
-     * Creates {@link Element}s and clones nodes into them.
-     */
-    protected createElements(): Variant;
-    /**
-     * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
-     */
-    protected bootstrapParameters(parameters?: ParameterBag): Promise<Variant>;
-}
+import { AssetContainer } from '@babylonjs/core/assetContainer';
+import { Light } from '@babylonjs/core/Lights/light';
+import '@babylonjs/core/Loading/Plugins/babylonFileLoader';
+import { Material } from '@babylonjs/core/Materials/material';
+import { Mesh } from '@babylonjs/core/Meshes/mesh';
+import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_draco_mesh_compression';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_texture_transform';
+import '@babylonjs/loaders/glTF/2.0/glTFLoader';
+import { DottedPath } from './dottedPath';
+import { Element } from './element';
+import { Parameterizable } from './parameterizable';
+import { ParameterObservable } from './parameterObservable';
+import { VariantParameterizable } from './variantParameterizable';
+import { Viewer } from './viewer';
+import { ViewerLight } from './viewerLight';
+/**
+ * A concrete "Variant". Most of these are handled by either the {@link Viewer} or {@link VariantInstance}.
+ */
+export declare class Variant extends Parameterizable {
+    readonly name: string;
+    protected readonly _structureJson: StructureJson;
+    readonly viewer: Viewer;
+    readonly parent?: Variant | undefined;
+    assetContainer: AssetContainer;
+    readonly elements: Element[];
+    readonly viewerLights: ViewerLight[];
+    structureJson: StructureJson;
+    protected _dottedNodes: Map<DottedPath, TransformNode> | undefined;
+    protected readonly _children: Map<string, Variant>;
+    protected readonly _parameterObservers: Map<string, ParameterObserver[]>;
+    /**
+     * @internal
+     */
+    private parametersInitialized;
+    /**
+     * Constructor.
+     */
+    protected constructor(name: string, _structureJson: StructureJson, viewer: Viewer, parent?: Variant | undefined);
+    /**
+     * Creates a {@link Variant} based on given parameters.
+     *
+     * @throws Error if "gltf" property is provided without a filename
+     */
+    static create(name: string, structureJson: StructureJson, viewer: Viewer, parent?: Variant): Promise<Variant>;
+    /**
+     * The ancestor {@link Variant}s ordered from top to bottom in the built tree.
+     */
+    get ancestors(): Variant[];
+    /**
+     * The root {@link Variant}.
+     */
+    get root(): Variant;
+    /**
+     * The {@link DottedPath} in the built tree of {@link Variant}s.
+     * E.g. "_.top-1.sub-2.sub-sub-3"
+     */
+    get dottedPath(): DottedPath;
+    /**
+     * The id representing a {@link DottedPath}.
+     */
+    get id(): string;
+    /**
+     * The defined glTF Asset.
+     */
+    get glTF(): Asset | undefined;
+    /**
+     * The defined glTF URI.
+     */
+    get glTFUri(): string | undefined;
+    /**
+     * The inherited defined glTF URI.
+     */
+    get inheritedGlTFUri(): string | undefined;
+    /**
+     * The TransformNodes of the {@link Variant}.
+     */
+    get nodes(): TransformNode[];
+    /**
+     * The {@link ViewerLight}s of the {@link Variant}.
+     */
+    get lights(): Light[];
+    /**
+     * All TransformNodes of the {@link Variant} mapped flat with a {@link DottedPath}.
+     */
+    get dottedNodes(): Map<DottedPath, TransformNode>;
+    /**
+     * The Materials of the {@link Variant}.
+     */
+    get materials(): Material[];
+    /**
+     * All {@link Element}s from this {@link Variant}'s parents.
+     */
+    get inheritedElements(): Element[];
+    /**
+     * All {@link ViewerLight}s inherited from this {@link Variant}'s parents.
+     */
+    get inheritedViewerLights(): ViewerLight[];
+    /**
+     * All TransformNodes inherited from this {@link Variant}'s parents.
+     */
+    get inheritedNodes(): TransformNode[];
+    /**
+     * All TransformNodes inherited from this {@link Variant}'s parents mapped flat with a {@link DottedPath}.
+     */
+    get inheritedDottedNodes(): Map<DottedPath, TransformNode>;
+    /**
+     * All Lights inherited from this {@link Variant}'s parents.
+     */
+    get inheritedLights(): Light[];
+    /**
+     * The {@link ParameterDeclarations} inherited from this {@link Variant}'s parents.
+     */
+    get inheritedParameterDeclaration(): ParameterDeclarations;
+    /**
+     * The {@link ParameterBag} inherited from this {@link Variant}'s parents.
+     */
+    get inheritedParameters(): ParameterBag;
+    /**
+     * All Materials from this {@link Variant}'s parents.
+     */
+    get inheritedMaterials(): Material[];
+    /**
+     * Gets the direct children of the current {@link Variant}.
+     */
+    getChildren(): Promise<Variant[]>;
+    /**
+     *  Gets a descendant {@link Variant} of the current {@link Variant} relative to its {@link DottedPath}.
+     *  If you have the dotted path `_.product_x.variant_blue.with_yellow_highlight` in a tree and you operate on the
+     *  `product_x`, you can call `this.getDescendant('variant_blue.with_yellow_highlight')` to get the lowermost
+     *  {@link Variant}.
+     */
+    getDescendant(dottedPath: DottedPathArgument): Promise<Variant>;
+    /**
+     * Gets the desired {@link Element} of the current {@link Variant} relative to its {@link DottedPath}.
+     * Uses the mechanism of {@link getDescendant} to resolve the appropriate variant in tree.
+     */
+    getElement(dottedPath: DottedPathArgument): Promise<Element>;
+    /**
+     * Gets the desired {@link ViewerLight} of the current {@link Variant} relative to its {@link DottedPath}.
+     * Uses the mechanism of {@link getDescendant} to resolve the appropriate variant in tree.
+     */
+    getViewerLight(dottedPath: DottedPathArgument): Promise<ViewerLight>;
+    /**
+     * A proxy for directly getting a Node from an {@link Element} by its {@link DottedPath}s.
+     */
+    getNode(elementDottedPath: DottedPathArgument, nodeDottedPath: DottedPathArgument): Promise<TransformNode>;
+    /**
+     * A proxy for directly getting a Mesh from an {@link Element} by its {@link DottedPath}s.
+     */
+    getMesh(elementDottedPath: DottedPathArgument, meshDottedPath: DottedPathArgument): Promise<Mesh | null>;
+    /**
+     * Gets the Material defined in one of the variants glTFs by its id.
+     */
+    getMaterial(id: string): Material;
+    /**
+     * Creates a living clone of this {@link Variant}. Will clone all parent {@link Variant}s in tree.
+     *
+     * @emit {@link Event.VARIANT_CREATED}
+     * @ignore
+     */
+    createLiving(parameters?: ParameterBag): Promise<Variant>;
+    /**
+     * Destroys this {@link Variant}, all parents and destroy the {@link Element}s.
+     */
+    destroy(): Variant;
+    /**
+     * Places the given {@link ParameterBag} in the {@link Variant}'s parameters, replaces all patterns in the
+     * {@link StructureJson}, broadcasts all {@link ParameterObserver}s and delegates them to its {@link Element}s.
+     *
+     * @emit {@link Event.VARIANT_PARAMETER_COMMITTED}
+     */
+    commitParameters(parameters?: ParameterBag): Promise<Variant>;
+    /**
+     * Adds an observer function for camera matrix changes for given `dottedPath` representing the {@link Element}
+     * and the `traceable`. The `observer` gets 2 parameters: the `AbstractMesh` and a `ClientRect` object.
+     */
+    addTraceableObserver(dottedPath: DottedPathArgument, observer: CallableFunction, payload?: any): Promise<Element>;
+    /**
+     * Loads {@link glTFUri} with assets, adds them to the {@link Variant}'s `assetContainer` and deactivates the meshes.
+     * (for further processing).
+     * @emits {@link Event.ASSET_LOADING_START}
+     * @emits {@link Event.ASSET_LOADING_END}
+     */
+    protected loadAssets(): Promise<Variant>;
+    /**
+     * Commits given parameters to all {@link Element}s.
+     */
+    protected commitParametersToElements(parameters: ParameterBag): Promise<void>;
+    /**
+     * Commits given parameters to all {@link ViewerLight}s.
+     */
+    protected commitParametersToViewerLights(parameters: ParameterBag): Promise<void>;
+    /**
+     * Commits given parameters to a {@link VariantParameterizable} and updates the according definition with given
+     * key in the {@link StructureJson}. The `definitionKey` "elements" for example will update the definition in
+     * `this.structureJson.elements`.
+     */
+    protected commitParametersToVariantParameterizable(parameters: ParameterBag, parameterizable: VariantParameterizable, definitionKey: string): Promise<ParameterObservable>;
+    /**
+     * Commits given {@link Parameter} to the {@link Variant}'s {@link Element}s.
+     */
+    protected commitParameterToElements(parameter: string, value: ParameterValue): Promise<void>;
+    /**
+     * Commits given {@link Parameter} to the {@link Variant}'s {@link Element}s.
+     */
+    protected commitParameterToViewerLights(parameter: string, value: ParameterValue): Promise<void>;
+    /**
+     * Adds the default {@link ParameterObserver}s which are called every time {@link commitParameters} is called.
+     */
+    protected addParameterObservers(): Variant;
+    /**
+     * Creates {@link Element}s and clones nodes into them.
+     */
+    protected createElements(): Promise<Variant>;
+    /**
+     * Creates {@link ViewerLight}s.
+     */
+    protected createViewerLights(): Promise<Variant>;
+    /**
+     * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
+     */
+    protected bootstrapParameters(parameters?: ParameterBag): Promise<Variant>;
+}