@combeenation/3d-viewer 9.3.0 → 10.0.0-alpha3

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

@@ -1,213 +1,211 @@
-import { AnimationManager } from '../manager/animationManager';
-import { GltfExportManager } from '../manager/gltfExportManager';
-import { SceneManager } from '../manager/sceneManager';
-import { TagManager } from '../manager/tagManager';
-import { VariantInstanceManager } from '../manager/variantInstanceManager';
-import * as Index from './../../index';
-import { AnimationInterface } from './animationInterface';
-import { EventBroadcaster } from './eventBroadcaster';
-import { VariantInstance } from './variantInstance';
-import { Engine } from '@babylonjs/core/Engines/engine';
-import { Mesh } from '@babylonjs/core/Meshes/mesh';
-import { Scene } from '@babylonjs/core/scene';
-/**
- * The main exposed object. This is the entry point into the application
- *
- * ```js
- * const canvas = document.getElementById( 'babylon-canvas' );
- * const viewer = Viewer( canvas, '/path/to/index.json' );
- * ```
- * The class does nothing on its own and needs to {@link bootstrap}
- */
-export declare class Viewer extends EventBroadcaster {
-    readonly canvas: HTMLCanvasElement;
-    protected structureJson: string | StructureJson;
-    static readonly BOUNDING_BOX_NAME = "__bounding_box__";
-    protected _scene: Scene | null;
-    protected _animationManager: AnimationManager | null;
-    protected _sceneManager: SceneManager | null;
-    protected _tagManager: TagManager | null;
-    protected _gltfExportManager: GltfExportManager | null;
-    protected _variantInstances: VariantInstanceManager | null;
-    protected _cloneMaterialsOnMutation: boolean;
-    protected _isRenderLoopPaused: boolean;
-    protected _inspectorLoaded: boolean;
-    protected _nodeNamingStrategyHandler: NodeNamingStrategyHandler | null;
-    static version: string;
-    private static readonly _autofocusConstants;
-    /**
-     * Help function for automatically creating a valid Spec from a list of variant names and dedicated GLB/babylon URLs.
-     * This data is most likely coming from babylon assets from the Combeenation system but other sources are also valid.
-     */
-    static generateSpec(genData: SpecGenerationData[]): AutoSpecStructureJson;
-    /**
-     * Returns all modules which are exported by the viewers index file.
-     *
-     * Needed by the [Combeenation viewer control](https://docs.combeenation.com/docs/3d-viewer-control) in situations where the viewer is injected from external code.
-     *
-     * See [Combeenation docs](https://docs.combeenation.com/docs/3d-viewer-control-with-custom-js) for more details.
-     */
-    static getAllViewerModules(): typeof Index;
-    /**
-     * Constructor
-     */
-    constructor(canvas: HTMLCanvasElement, structureJson: string | StructureJson);
-    /**
-     * Gets the Babylon.js Scene that is attached to the instance.
-     *
-     * @throws Error if the `scene` has not been initialized.
-     */
-    get scene(): Scene;
-    /**
-     * Gets the {@link SceneManager} attached to the viewer.
-     *
-     * @throws Error if the {@link SceneManager} has not been initialized.
-     */
-    get sceneManager(): SceneManager;
-    /**
-     * Gets the {@link GltfExportManager} attached to the viewer.
-     *
-     * @throws Error if the {@link GltfExportManager} has not been initialized.
-     */
-    get gltfExportManager(): GltfExportManager;
-    /**
-     * Gets the Babylon.js Engine that is attached to the viewer.
-     */
-    get engine(): Engine;
-    /**
-     * Gets the {@link VariantInstanceManager} attached to the viewer.
-     *
-     * @throws Error if the {@link VariantInstanceManager} has not been initialized.
-     */
-    get variantInstances(): VariantInstanceManager;
-    /**
-     * Gets the {@link AnimationManager} attached to the viewer.
-     *
-     * @throws Error if the {@link AnimationManager} has not been initialized.
-     */
-    get animationManager(): AnimationManager;
-    get tagManager(): TagManager;
-    /**
-     * Gets the `cloneMaterialsOnMutation` flag, as defined in the spec
-     */
-    get cloneMaterialsOnMutation(): boolean;
-    /**
-     * Gets the strategy handler for naming cloned nodes.
-     */
-    get nodeNamingStrategyHandler(): NodeNamingStrategyHandler;
-    /**
-     * Sets the strategy handler for naming cloned nodes.\
-     * Check the docs of the tag managers [renaming](https://3dviewer.docs.combeenation.com/pages/documentation/Tag-Manager.html#uniqueness-of-node-and-tag-names)
-     * chapter for further details.
-     */
-    set nodeNamingStrategyHandler(value: NodeNamingStrategyHandler);
-    /**
-     * Starts the application. This will
-     * * load the given "index" JSON file
-     * * setup the scene with the "scene" JSON file
-     * * create an (optional) default setup with different variant settings
-     * * sets up resizing by attaching a debounced version of {@link resize}
-     *
-     * @throws Error if any of the files is not found/valid
-     *
-     * @emits {@link Event.BOOTSTRAP_START}
-     * @emits {@link Event.BOOTSTRAP_END}
-     */
-    bootstrap(tagManagerParameterValues?: TagManagerParameterValue[]): Promise<Viewer>;
-    /**
-     * Enables the Babylon.js [Inspector](https://doc.babylonjs.com/toolsAndResources/tools/inspector).\
-     * Due to the additional size of the inspector, the CDN version is used instead of shipping the required code with
-     * the viewer.\
-     * This means that the code will be downloaded only when needed and calling `enableDebugLayer` can take a little while
-     * depending on your internet connection etc.
-     */
-    enableDebugLayer(options?: IInspectorOptions): Promise<void>;
-    /**
-     * Destroys all registered {@link VariantInstance}s that are registered
-     */
-    destroyVariantInstances(): Viewer;
-    /**
-     * Trigger a resize event for the `Engine`
-     */
-    resize(): Viewer;
-    /**
-     * A convenience method for directly getting a Node from a {@link VariantInstance} and an {@link Element} by its
-     * {@link DottedPath}s.
-     */
-    getNode(variantInstanceName: string, elementDottedPath: DottedPathArgument, nodeDottedPath: DottedPathArgument): Promise<TransformNode>;
-    /**
-     * A convenience method for directly getting a Node from a {@link VariantInstance} and an {@link Element} by its
-     * {@link DottedPath}s.
-     */
-    getMesh(variantInstanceName: string, elementDottedPath: DottedPathArgument, meshDottedPath: DottedPathArgument): Promise<Mesh | null>;
-    /**
-     * Switches the camera
-     *
-     * @emits {@link Event.CAMERA_SWITCHED}
-     */
-    switchCamera(newCamera: string, reset?: boolean): Viewer;
-    /**
-     * Moves or animates the active camera to given `placement`.
-     */
-    moveActiveCameraTo(placement: string | PlacementDefinition, animation?: string | AnimationDefinition): Promise<AnimationInterface>;
-    /**
-     * Takes a sceenshot the the current scene. The result is a string containing a base64 encoded image
-     */
-    screenshot(settings?: ScreenshotSettings): Promise<string>;
-    /**
-     * Checks whether the browser is capable of handling XR.
-     */
-    isBrowserARCapable(): Promise<boolean>;
-    /**
-     * Calculates the bounding box from all visible meshes on the scene.
-     */
-    calculateBoundingBox(excludeGeometry?: ExcludedGeometryList): Promise<Mesh>;
-    /**
-     * Focuses the camera to see every visible mesh in scene and tries to optimize wheel precision and panning
-     */
-    autofocusActiveCamera(settings?: AutofocusSettings): Promise<void>;
-    /**
-     * Resets everything by calling {@link destroy} to clear all references and {@link bootstrap} to setup a clean
-     * environment
-     */
-    reset(tagManagerParameterValues?: TagManagerParameterValue[]): Promise<Viewer>;
-    /**
-     * Destroys
-     *
-     * * all {@link VariantInstance}s using {@link destroyVariantInstances}
-     * * calling `dispose` on the `Engine` and `Scene`
-     */
-    destroy(): Viewer;
-    /**
-     * Show coordinate system with given dimension (for debugging purpose).
-     */
-    showWorldCoordinates(dimension: number): void;
-    /**
-     * Pause render loop.
-     */
-    pauseRendering(): void;
-    /**
-     * Resume render loop when paused.
-     */
-    resumeRendering(): void;
-    /**
-     * Prints defined instances from SetupJson to the console.
-     */
-    protected printInstanceDefinitions(setupJson: SetupJson): void;
-    /**
-     * @emits {@link Event.SCENE_PROCESSING_START}
-     * @emits {@link Event.SCENE_PROCESSING_END}
-     */
-    protected initScene(): Promise<Scene>;
-    /**
-     * Register custom file loader for babylon files which adds "missing-material" metadata to meshes which reference
-     * materials that are not present in the `materials` section of the given babylon file.
-     *
-     * Required for babylon files & materials loaded from "Combeenation configurator assets".
-     */
-    protected initCbnBabylonLoaderPlugin(): void;
-    /**
-     * Batch creation of multiple {@link VariantInstance} objects with a {@link SetupJson} object passed
-     */
-    protected createVariantInstances(): Promise<VariantInstance[]>;
-}
+import { AnimationManager } from '../manager/animationManager';
+import { GltfExportManager } from '../manager/gltfExportManager';
+import { SceneManager } from '../manager/sceneManager';
+import { TagManager } from '../manager/tagManager';
+import { VariantInstanceManager } from '../manager/variantInstanceManager';
+import * as Index from './../../index';
+import { AnimationInterface } from './animationInterface';
+import { EventBroadcaster } from './eventBroadcaster';
+import { VariantInstance } from './variantInstance';
+import { Engine } from '@babylonjs/core/Engines/engine';
+import { Mesh } from '@babylonjs/core/Meshes/mesh';
+import { Scene } from '@babylonjs/core/scene';
+/**
+ * The main exposed object. This is the entry point into the application
+ *
+ * ```js
+ * const canvas = document.getElementById( 'babylon-canvas' );
+ * const viewer = Viewer( canvas, '/path/to/index.json' );
+ * ```
+ * The class does nothing on its own and needs to {@link bootstrap}
+ */
+export declare class Viewer extends EventBroadcaster {
+    readonly canvas: HTMLCanvasElement;
+    protected structureJson: string | StructureJson;
+    static readonly BOUNDING_BOX_NAME = "__bounding_box__";
+    protected _scene: Scene | null;
+    protected _animationManager: AnimationManager | null;
+    protected _sceneManager: SceneManager | null;
+    protected _tagManager: TagManager | null;
+    protected _gltfExportManager: GltfExportManager | null;
+    protected _variantInstances: VariantInstanceManager | null;
+    protected _cloneMaterialsOnMutation: boolean;
+    protected _isRenderLoopPaused: boolean;
+    protected _nodeNamingStrategyHandler: NodeNamingStrategyHandler | null;
+    static version: string;
+    private static readonly _autofocusConstants;
+    /**
+     * Help function for automatically creating a valid Spec from a list of variant names and dedicated GLB/babylon URLs.
+     * This data is most likely coming from babylon assets from the Combeenation system but other sources are also valid.
+     */
+    static generateSpec(genData: SpecGenerationData[]): AutoSpecStructureJson;
+    /**
+     * Returns all modules which are exported by the viewers index file.
+     *
+     * Needed by the [Combeenation viewer control](https://docs.combeenation.com/docs/3d-viewer-control) in situations where the viewer is injected from external code.
+     *
+     * See [Combeenation docs](https://docs.combeenation.com/docs/3d-viewer-control-with-custom-js) for more details.
+     */
+    static getAllViewerModules(): typeof Index;
+    /**
+     * Constructor
+     */
+    constructor(canvas: HTMLCanvasElement, structureJson: string | StructureJson);
+    /**
+     * Gets the Babylon.js Scene that is attached to the instance.
+     *
+     * @throws Error if the `scene` has not been initialized.
+     */
+    get scene(): Scene;
+    /**
+     * Gets the {@link SceneManager} attached to the viewer.
+     *
+     * @throws Error if the {@link SceneManager} has not been initialized.
+     */
+    get sceneManager(): SceneManager;
+    /**
+     * Gets the {@link GltfExportManager} attached to the viewer.
+     *
+     * @throws Error if the {@link GltfExportManager} has not been initialized.
+     */
+    get gltfExportManager(): GltfExportManager;
+    /**
+     * Gets the Babylon.js Engine that is attached to the viewer.
+     */
+    get engine(): Engine;
+    /**
+     * Gets the {@link VariantInstanceManager} attached to the viewer.
+     *
+     * @throws Error if the {@link VariantInstanceManager} has not been initialized.
+     */
+    get variantInstances(): VariantInstanceManager;
+    /**
+     * Gets the {@link AnimationManager} attached to the viewer.
+     *
+     * @throws Error if the {@link AnimationManager} has not been initialized.
+     */
+    get animationManager(): AnimationManager;
+    get tagManager(): TagManager;
+    /**
+     * Gets the `cloneMaterialsOnMutation` flag, as defined in the spec
+     */
+    get cloneMaterialsOnMutation(): boolean;
+    /**
+     * Gets the strategy handler for naming cloned nodes.
+     */
+    get nodeNamingStrategyHandler(): NodeNamingStrategyHandler;
+    /**
+     * Sets the strategy handler for naming cloned nodes.\
+     * Check the docs of the tag managers [renaming](https://3dviewer.docs.combeenation.com/pages/documentation/Tag-Manager.html#uniqueness-of-node-and-tag-names)
+     * chapter for further details.
+     */
+    set nodeNamingStrategyHandler(value: NodeNamingStrategyHandler);
+    /**
+     * Starts the application. This will
+     * * load the given "index" JSON file
+     * * setup the scene with the "scene" JSON file
+     * * create an (optional) default setup with different variant settings
+     * * sets up resizing by attaching a debounced version of {@link resize}
+     *
+     * @throws Error if any of the files is not found/valid
+     *
+     * @emits {@link Event.BOOTSTRAP_START}
+     * @emits {@link Event.BOOTSTRAP_END}
+     */
+    bootstrap(tagManagerParameterValues?: TagManagerParameterValue[]): Promise<Viewer>;
+    /**
+     * Enables the Babylon.js [Inspector](https://doc.babylonjs.com/toolsAndResources/tools/inspector).\
+     * Due to the additional size of the inspector, this function is only available in "development" builds!
+     *
+     * @returns Signalizes if inspector could be loaded
+     */
+    enableDebugLayer(options?: IInspectorOptions): Promise<boolean>;
+    /**
+     * Destroys all registered {@link VariantInstance}s that are registered
+     */
+    destroyVariantInstances(): Viewer;
+    /**
+     * Trigger a resize event for the `Engine`
+     */
+    resize(): Viewer;
+    /**
+     * A convenience method for directly getting a Node from a {@link VariantInstance} and an {@link Element} by its
+     * {@link DottedPath}s.
+     */
+    getNode(variantInstanceName: string, elementDottedPath: DottedPathArgument, nodeDottedPath: DottedPathArgument): Promise<TransformNode>;
+    /**
+     * A convenience method for directly getting a Node from a {@link VariantInstance} and an {@link Element} by its
+     * {@link DottedPath}s.
+     */
+    getMesh(variantInstanceName: string, elementDottedPath: DottedPathArgument, meshDottedPath: DottedPathArgument): Promise<Mesh | null>;
+    /**
+     * Switches the camera
+     *
+     * @emits {@link Event.CAMERA_SWITCHED}
+     */
+    switchCamera(newCamera: string, reset?: boolean): Viewer;
+    /**
+     * Moves or animates the active camera to given `placement`.
+     */
+    moveActiveCameraTo(placement: string | PlacementDefinition, animation?: string | AnimationDefinition): Promise<AnimationInterface>;
+    /**
+     * Takes a sceenshot the the current scene. The result is a string containing a base64 encoded image
+     */
+    screenshot(settings?: ScreenshotSettings): Promise<string>;
+    /**
+     * Checks whether the browser is capable of handling XR.
+     */
+    isBrowserARCapable(): Promise<boolean>;
+    /**
+     * Calculates the bounding box from all visible meshes on the scene.
+     */
+    calculateBoundingBox(excludeGeometry?: ExcludedGeometryList): Promise<Mesh>;
+    /**
+     * Focuses the camera to see every visible mesh in scene and tries to optimize wheel precision and panning
+     */
+    autofocusActiveCamera(settings?: AutofocusSettings): Promise<void>;
+    /**
+     * Resets everything by calling {@link destroy} to clear all references and {@link bootstrap} to setup a clean
+     * environment
+     */
+    reset(tagManagerParameterValues?: TagManagerParameterValue[]): Promise<Viewer>;
+    /**
+     * Destroys
+     *
+     * * all {@link VariantInstance}s using {@link destroyVariantInstances}
+     * * calling `dispose` on the `Engine` and `Scene`
+     */
+    destroy(): Viewer;
+    /**
+     * Show coordinate system with given dimension (for debugging purpose).
+     */
+    showWorldCoordinates(dimension: number): void;
+    /**
+     * Pause render loop.
+     */
+    pauseRendering(): void;
+    /**
+     * Resume render loop when paused.
+     */
+    resumeRendering(): void;
+    /**
+     * Prints defined instances from SetupJson to the console.
+     */
+    protected printInstanceDefinitions(setupJson: SetupJson): void;
+    /**
+     * @emits {@link Event.SCENE_PROCESSING_START}
+     * @emits {@link Event.SCENE_PROCESSING_END}
+     */
+    protected initScene(): Promise<Scene>;
+    /**
+     * Register custom file loader for babylon files which adds "missing-material" metadata to meshes which reference
+     * materials that are not present in the `materials` section of the given babylon file.
+     *
+     * Required for babylon files & materials loaded from "Combeenation configurator assets".
+     */
+    protected initCbnBabylonLoaderPlugin(): void;
+    /**
+     * Batch creation of multiple {@link VariantInstance} objects with a {@link SetupJson} object passed
+     */
+    protected createVariantInstances(): Promise<VariantInstance[]>;
+}