@combeenation/3d-viewer 13.0.1 → 14.0.1-rc1

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

@@ -1,117 +1,115 @@
-import * as Index from './index';
-import { BoundingInfo, CameraManager, DebugManager, DefaultSceneSettings, Engine, EngineOptions, EventManager, GltfExportManager, MaterialManager, ModelManager, ParameterManager, ParameterSubject, Scene, SceneManager, ScreenshotManager, TextureManager, TransformNode } from './index';
-/**
- * Use this to define geometry to be excluded from autofocus, GLB export, etc.
- */
-export declare type ExcludedGeometry = TransformNode | ParameterSubject;
-export declare type ExcludedGeometryList = ExcludedGeometry[];
-export declare type LimitTextureSizeConfig = {
-    size: 512 | 1024;
-    devices: 'iPhone' | 'all';
-};
-export declare type ViewerSettings = {
-    antialiasing: boolean;
-    engineOptions: EngineOptions;
-    /**
-     * Important for visual quality on iOS devices, this setting will set the hardware scaling proportional to the devices
-     * pixel ratio
-     */
-    adaptToDeviceRatio: boolean;
-    /**
-     * Possibility to limit the size of textures when getting loaded by the engine.\
-     * Activating this feature potentially saves a lot of memory and can be used to avoid crashes when loading expensive
-     * models on weaker devices.\
-     * In praxis this has been an issue with iPhones a lot, therefore it's possible to activate this feature for iPhones
-     * only as well.
-     */
-    limitTextureSize: LimitTextureSizeConfig | false;
-    /**
-     * See this forum entry for description of parallel shader compilition effect:
-     * https://forum.babylonjs.com/t/scene-flickering-when-turning-off-light/48733.\
-     * Parallel shading compilition generally improves the speed of material compilition and helps when switching
-     * materials while objects are moving (eg: animations).\
-     * Deactivating parallel shading compilition is benefitial when switching lights and materials in static scenarios.\
-     * It's activated by default due to compatibility reasons but can be overwritten with this flag.
-     */
-    useParallelShaderCompile: boolean;
-};
-/**
- * This is the entry point into the application.\
- * Create an instance to set up the viewer on your canvas.
- *  ```js
- * const canvas = document.getElementById('babylon-canvas');
- * const viewer = Viewer(canvas, viewerSettings, defaultSceneSettings);
- * ```
- * Use "manager" sub classes for interacting with the Babylon.js engine.
- * (e.g. `modelManager` for loading models into the scene)
- */
-export declare class Viewer {
-    readonly canvas: HTMLCanvasElement;
-    static readonly version: string;
-    protected _scene: Scene;
-    protected _cameraManager: CameraManager;
-    protected _debugManager: DebugManager;
-    protected _eventManager: EventManager;
-    protected _gltfExportManager: GltfExportManager;
-    protected _materialManager: MaterialManager;
-    protected _modelManager: ModelManager;
-    protected _parameterManager: ParameterManager;
-    protected _sceneManager: SceneManager;
-    protected _screenshotManager: ScreenshotManager;
-    protected _textureManager: TextureManager;
-    protected _viewerSettings: ViewerSettings;
-    protected _isRenderLoopPaused: boolean;
-    get scene(): Scene;
-    get engine(): Engine;
-    get cameraManager(): CameraManager;
-    get debugManager(): DebugManager;
-    get eventManager(): EventManager;
-    get gltfExportManager(): GltfExportManager;
-    get materialManager(): MaterialManager;
-    get modelManager(): ModelManager;
-    get parameterManager(): ParameterManager;
-    /** @internal */
-    get sceneManager(): SceneManager;
-    get screenshotManager(): ScreenshotManager;
-    /** @internal */
-    get textureManager(): TextureManager;
-    get viewerSettings(): ViewerSettings;
-    /**
-     * 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;
-    /**
-     * @param viewerSettings Can be overwritten to tweak settings for the Babylon.js engine or viewer internal
-     *                       functionalities like "texture downscaling mode"
-     * @param defaultSceneSettings Can be overwritten to tweak settings for the automatically create Babylon.js scene.\
-     *                             This scene contains a camera and an environment per default.
-     */
-    constructor(canvas: HTMLCanvasElement, viewerSettings?: DeepPartial<ViewerSettings>, defaultSceneSettings?: DeepPartial<DefaultSceneSettings>);
-    /**
-     * Pause rendering can be usefull when doing internal scene processings that should not be visible to the user,
-     * e.g. cloning meshes for gltf export
-     */
-    pauseRendering(): void;
-    /**
-     * Resume render loop when paused by {@link pauseRendering} function
-     */
-    resumeRendering(): void;
-    /**
-     * Destroys this viewer instance and disposes Babylon.js engine and all scene content
-     */
-    destroy(): void;
-    /**
-     * Calculates size of the current scene.\
-     * Only takes meshes into considerations that:
-     * - are visible
-     * - are not excluded by "excludeGeometry" parameter
-     * - do not have an infinite distance (like sky boxes)
-     */
-    calculateBoundingInfo(excludeGeometry?: ExcludedGeometryList): BoundingInfo;
-    /**
-     * Set up viewer (engine and scene) and initialize all managers
-     */
-    protected _init(defaultSceneSettings?: DeepPartial<DefaultSceneSettings>): void;
-}
+import * as Index from './index';
+import { BoundingInfo, CameraManager, DebugManager, DefaultSceneSettings, Engine, EngineOptions, EventManager, GltfExportManager, MaterialManager, ModelManager, ParameterManager, ParameterSubject, Scene, SceneManager, TextureManager, TransformNode } from './index';
+/**
+ * Use this to define geometry to be excluded from autofocus, GLB export, etc.
+ */
+export declare type ExcludedGeometry = TransformNode | ParameterSubject;
+export declare type ExcludedGeometryList = ExcludedGeometry[];
+export declare type LimitTextureSizeConfig = {
+    size: 512 | 1024;
+    devices: 'iPhone' | 'all';
+};
+export declare type ViewerSettings = {
+    antialiasing: boolean;
+    engineOptions: EngineOptions;
+    /**
+     * Important for visual quality on iOS devices, this setting will set the hardware scaling proportional to the devices
+     * pixel ratio
+     */
+    adaptToDeviceRatio: boolean;
+    /**
+     * Possibility to limit the size of textures when getting loaded by the engine.\
+     * Activating this feature potentially saves a lot of memory and can be used to avoid crashes when loading expensive
+     * models on weaker devices.\
+     * In praxis this has been an issue with iPhones a lot, therefore it's possible to activate this feature for iPhones
+     * only as well.
+     */
+    limitTextureSize: LimitTextureSizeConfig | false;
+    /**
+     * See this forum entry for description of parallel shader compilition effect:
+     * https://forum.babylonjs.com/t/scene-flickering-when-turning-off-light/48733.\
+     * Parallel shading compilition generally improves the speed of material compilition and helps when switching
+     * materials while objects are moving (eg: animations).\
+     * Deactivating parallel shading compilition is benefitial when switching lights and materials in static scenarios.\
+     * It's activated by default due to compatibility reasons but can be overwritten with this flag.
+     */
+    useParallelShaderCompile: boolean;
+};
+/**
+ * This is the entry point into the application.\
+ * Create an instance to set up the viewer on your canvas.
+ *  ```js
+ * const canvas = document.getElementById('babylon-canvas');
+ * const viewer = Viewer(canvas, viewerSettings, defaultSceneSettings);
+ * ```
+ * Use "manager" sub classes for interacting with the Babylon.js engine.
+ * (e.g. `modelManager` for loading models into the scene)
+ */
+export declare class Viewer {
+    readonly canvas: HTMLCanvasElement;
+    static readonly version: string;
+    protected _scene: Scene;
+    protected _cameraManager: CameraManager;
+    protected _debugManager: DebugManager;
+    protected _eventManager: EventManager;
+    protected _gltfExportManager: GltfExportManager;
+    protected _materialManager: MaterialManager;
+    protected _modelManager: ModelManager;
+    protected _parameterManager: ParameterManager;
+    protected _sceneManager: SceneManager;
+    protected _textureManager: TextureManager;
+    protected _viewerSettings: ViewerSettings;
+    protected _isRenderLoopPaused: boolean;
+    get scene(): Scene;
+    get engine(): Engine;
+    get cameraManager(): CameraManager;
+    get debugManager(): DebugManager;
+    get eventManager(): EventManager;
+    get gltfExportManager(): GltfExportManager;
+    get materialManager(): MaterialManager;
+    get modelManager(): ModelManager;
+    get parameterManager(): ParameterManager;
+    /** @internal */
+    get sceneManager(): SceneManager;
+    /** @internal */
+    get textureManager(): TextureManager;
+    get viewerSettings(): ViewerSettings;
+    /**
+     * 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;
+    /**
+     * @param viewerSettings Can be overwritten to tweak settings for the Babylon.js engine or viewer internal
+     *                       functionalities like "texture downscaling mode"
+     * @param defaultSceneSettings Can be overwritten to tweak settings for the automatically create Babylon.js scene.\
+     *                             This scene contains a camera and an environment per default.
+     */
+    constructor(canvas: HTMLCanvasElement, viewerSettings?: DeepPartial<ViewerSettings>, defaultSceneSettings?: DeepPartial<DefaultSceneSettings>);
+    /**
+     * Pause rendering can be usefull when doing internal scene processings that should not be visible to the user,
+     * e.g. cloning meshes for gltf export
+     */
+    pauseRendering(): void;
+    /**
+     * Resume render loop when paused by {@link pauseRendering} function
+     */
+    resumeRendering(): void;
+    /**
+     * Destroys this viewer instance and disposes Babylon.js engine and all scene content
+     */
+    destroy(): void;
+    /**
+     * Calculates size of the current scene.\
+     * Only takes meshes into considerations that:
+     * - are visible
+     * - are not excluded by "excludeGeometry" parameter
+     * - do not have an infinite distance (like sky boxes)
+     */
+    calculateBoundingInfo(excludeGeometry?: ExcludedGeometryList): BoundingInfo;
+    /**
+     * Set up viewer (engine and scene) and initialize all managers
+     */
+    protected _init(defaultSceneSettings?: DeepPartial<DefaultSceneSettings>): void;
+}