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

package/dist/lib-cjs/manager/camera-manager.d.ts

@@ -1,110 +1,110 @@
-import { AnimationGroup, ArcRotateCamera, BoundingSphere, ExcludedGeometryList, Vector3, Viewer } from '../index';
-export declare type CameraPosition = {
-    alpha: number;
-    beta: number;
-    radius: number;
-    target: Vector3;
-};
-export declare type AutofocusSettings = {
-    /** Can be used to customize the margins shown around the 3d model. Defaults to 1. */
-    radiusFactor?: number;
-    adjustWheelPrecision?: boolean;
-    adjustPanningSensibility?: boolean;
-    adjustPinchPrecision?: boolean;
-    /** Desired horizontal camera angle, this won't be overwritten by the autofocus function */
-    alpha?: number;
-    /** Desired vertical camera angle, this won't be overwritten by the autofocus function */
-    beta?: number;
-    /** Optional list of geometry to be excluded from consideration */
-    exclude?: ExcludedGeometryList;
-    durationMs?: number;
-};
-export declare type ScreenshotSettings = {
-    /** Width of the final screenshot image, defaults to canvas width */
-    width?: number;
-    /** Height of the final screenshot image, defaults to canvas height */
-    height?: number;
-    /** Camera alpha angle used for the screenshot, defaults to alpha angle of currently active camera */
-    alpha?: number;
-    /** Camera beta angle used for the screenshot, defaults to beta angle of currently active camera */
-    beta?: number;
-    /**
-     * Camera radius used for the screenshot, default value depends on `autofocusScene` flag:
-     * - `true`: radius is calculated automatically so that the whole current scene content is visible
-     * - `false`: radius of currently active camera is used
-     */
-    radius?: number;
-    /**
-     * Camera target used for the screenshot, default value depends on `autofocusScene` flag:
-     * - `true`:  center of the current scene content is set as camera target
-     * - `false`: target of currently active camera is used
-     */
-    target?: Vector3;
-    /** Used to scale the calculated radius if `radius` property is not set and `autofocusScene` mode is active */
-    radiusFactor?: number;
-    /** Can be used to automatically calculate camera `radius` and `target`, if these 2 settings are not defined
-     * explicitely */
-    autofocusScene?: boolean;
-    /** Optional list of geometry to be excluded from consideration */
-    exclude?: ExcludedGeometryList;
-    /**
-     * "MIME type" of the returned screenshot image, defaults to `image/png`
-     *
-     * **Info regarding JPEG:** \
-     * Use mimeType `image/jpeg` (**not** `image/jpg`) when creating jpeg's. \
-     * Also ensure that the viewer scenes `clearColor` has an alpha value of `1` as jpeg's don't
-     * support transparency. Otherwise background will always be black for jpeg's.
-     */
-    mimeType?: string;
-    /** If file name is given, the screenshot image will be downloaded and the base64 string will NOT be returned! */
-    fileName?: string;
-    /** Expert settings to tweak the screenshot image, see [Babylon.js](https://doc.babylonjs.com/typedoc/functions/BABYLON.CreateScreenshotUsingRenderTarget) docs for further information */
-    samples?: number;
-    /** Expert settings to tweak the screenshot image, see [Babylon.js](https://doc.babylonjs.com/typedoc/functions/BABYLON.CreateScreenshotUsingRenderTarget) docs for further information */
-    antialiasing?: boolean;
-    /** Expert settings to tweak the screenshot image, see [Babylon.js](https://doc.babylonjs.com/typedoc/functions/BABYLON.CreateScreenshotUsingRenderTarget) docs for further information */
-    renderSprites?: boolean;
-    /** Expert settings to tweak the screenshot image, see [Babylon.js](https://doc.babylonjs.com/typedoc/functions/BABYLON.CreateScreenshotUsingRenderTarget) docs for further information */
-    enableStencilBuffer?: boolean;
-    /** Expert settings to tweak the screenshot image, see [Babylon.js](https://doc.babylonjs.com/typedoc/functions/BABYLON.CreateScreenshotUsingRenderTarget) docs for further information */
-    useLayerMask?: boolean;
-    /** Expert settings to tweak the screenshot image, see [Babylon.js](https://doc.babylonjs.com/typedoc/functions/BABYLON.CreateScreenshotUsingRenderTarget) docs for further information */
-    quality?: number;
-};
-/**
- * Manager for camera related tasks
- */
-export declare class CameraManager {
-    protected viewer: Viewer;
-    static readonly CAMERA_ANIMATION_NAME = "__cameraAnimation__";
-    /** @internal */
-    static readonly DEFAULT_CAMERA_POSITION: CameraPosition;
-    protected static readonly _AUTOFOCUS_CONSTANTS: {
-        minZ: number;
-        wheelPrecision: number;
-        panningSensibility: number;
-        pinchPrecision: number;
-    };
-    protected static readonly _DEFAULT_AUTOFOCUS_RADIUS_FACTOR = 1;
-    protected static readonly _DEFAULT_CAM_SPEED_MS = 250;
-    protected static readonly _SCREENSHOT_CAMERA_NAME = "__screenshotCamera__";
-    /** @internal */
-    constructor(viewer: Viewer);
-    /**
-     * Focuses the camera to see every visible mesh in scene and tries to optimize wheel precision and panning
-     */
-    autofocusActiveCamera(settings?: AutofocusSettings): Promise<void>;
-    /**
-     * Moves the active camera smoothly to certain position
-     *
-     * @param durationMs defaults to 250ms if unset, use 0 for instant movement
-     */
-    moveActiveCameraTo(position: CameraPosition, durationMs?: number): Promise<void>;
-    /**
-     * Takes a sceenshot the the current scene.\
-     * The result is a string containing a base64 encoded image.
-     */
-    createScreenshot(settings?: ScreenshotSettings): Promise<string>;
-    protected static _addCameraAnimationToGroup(targetProperty: string, from: number | Vector3, to: number | Vector3, framesPerSec: number, dataType: number, animationGroup: AnimationGroup, activeCamera: ArcRotateCamera): void;
-    protected _getAutofocusZoomingDistance(boundingSphere: BoundingSphere, camera: ArcRotateCamera): number;
-}
+import { AnimationGroup, ArcRotateCamera, BoundingSphere, ExcludedGeometryList, Vector3, Viewer } from '../index';
+export declare type CameraPosition = {
+    alpha: number;
+    beta: number;
+    radius: number;
+    target: Vector3;
+};
+export declare type AutofocusSettings = {
+    /** Can be used to customize the margins shown around the 3d model. Defaults to 1. */
+    radiusFactor?: number;
+    adjustWheelPrecision?: boolean;
+    adjustPanningSensibility?: boolean;
+    adjustPinchPrecision?: boolean;
+    /** Desired horizontal camera angle, this won't be overwritten by the autofocus function */
+    alpha?: number;
+    /** Desired vertical camera angle, this won't be overwritten by the autofocus function */
+    beta?: number;
+    /** Optional list of geometry to be excluded from consideration */
+    exclude?: ExcludedGeometryList;
+    durationMs?: number;
+};
+export declare type ScreenshotSettings = {
+    /** Width of the final screenshot image, defaults to canvas width */
+    width?: number;
+    /** Height of the final screenshot image, defaults to canvas height */
+    height?: number;
+    /** Camera alpha angle used for the screenshot, defaults to alpha angle of currently active camera */
+    alpha?: number;
+    /** Camera beta angle used for the screenshot, defaults to beta angle of currently active camera */
+    beta?: number;
+    /**
+     * Camera radius used for the screenshot, default value depends on `autofocusScene` flag:
+     * - `true`: radius is calculated automatically so that the whole current scene content is visible
+     * - `false`: radius of currently active camera is used
+     */
+    radius?: number;
+    /**
+     * Camera target used for the screenshot, default value depends on `autofocusScene` flag:
+     * - `true`:  center of the current scene content is set as camera target
+     * - `false`: target of currently active camera is used
+     */
+    target?: Vector3;
+    /** Used to scale the calculated radius if `radius` property is not set and `autofocusScene` mode is active */
+    radiusFactor?: number;
+    /** Can be used to automatically calculate camera `radius` and `target`, if these 2 settings are not defined
+     * explicitely */
+    autofocusScene?: boolean;
+    /** Optional list of geometry to be excluded from consideration */
+    exclude?: ExcludedGeometryList;
+    /**
+     * "MIME type" of the returned screenshot image, defaults to `image/png`
+     *
+     * **Info regarding JPEG:** \
+     * Use mimeType `image/jpeg` (**not** `image/jpg`) when creating jpeg's. \
+     * Also ensure that the viewer scenes `clearColor` has an alpha value of `1` as jpeg's don't
+     * support transparency. Otherwise background will always be black for jpeg's.
+     */
+    mimeType?: string;
+    /** If file name is given, the screenshot image will be downloaded and the base64 string will NOT be returned! */
+    fileName?: string;
+    /** Expert settings to tweak the screenshot image, see [Babylon.js](https://doc.babylonjs.com/typedoc/functions/BABYLON.CreateScreenshotUsingRenderTarget) docs for further information */
+    samples?: number;
+    /** Expert settings to tweak the screenshot image, see [Babylon.js](https://doc.babylonjs.com/typedoc/functions/BABYLON.CreateScreenshotUsingRenderTarget) docs for further information */
+    antialiasing?: boolean;
+    /** Expert settings to tweak the screenshot image, see [Babylon.js](https://doc.babylonjs.com/typedoc/functions/BABYLON.CreateScreenshotUsingRenderTarget) docs for further information */
+    renderSprites?: boolean;
+    /** Expert settings to tweak the screenshot image, see [Babylon.js](https://doc.babylonjs.com/typedoc/functions/BABYLON.CreateScreenshotUsingRenderTarget) docs for further information */
+    enableStencilBuffer?: boolean;
+    /** Expert settings to tweak the screenshot image, see [Babylon.js](https://doc.babylonjs.com/typedoc/functions/BABYLON.CreateScreenshotUsingRenderTarget) docs for further information */
+    useLayerMask?: boolean;
+    /** Expert settings to tweak the screenshot image, see [Babylon.js](https://doc.babylonjs.com/typedoc/functions/BABYLON.CreateScreenshotUsingRenderTarget) docs for further information */
+    quality?: number;
+};
+/**
+ * Manager for camera related tasks
+ */
+export declare class CameraManager {
+    protected viewer: Viewer;
+    static readonly CAMERA_ANIMATION_NAME = "__cameraAnimation__";
+    /** @internal */
+    static readonly DEFAULT_CAMERA_POSITION: CameraPosition;
+    protected static readonly _AUTOFOCUS_CONSTANTS: {
+        minZ: number;
+        wheelPrecision: number;
+        panningSensibility: number;
+        pinchPrecision: number;
+    };
+    protected static readonly _DEFAULT_AUTOFOCUS_RADIUS_FACTOR = 1;
+    protected static readonly _DEFAULT_CAM_SPEED_MS = 250;
+    protected static readonly _SCREENSHOT_CAMERA_NAME = "__screenshotCamera__";
+    /** @internal */
+    constructor(viewer: Viewer);
+    /**
+     * Focuses the camera to see every visible mesh in scene and tries to optimize wheel precision and panning
+     */
+    autofocusActiveCamera(settings?: AutofocusSettings): Promise<void>;
+    /**
+     * Moves the active camera smoothly to certain position
+     *
+     * @param durationMs defaults to 250ms if unset, use 0 for instant movement
+     */
+    moveActiveCameraTo(position: CameraPosition, durationMs?: number): Promise<void>;
+    /**
+     * Takes a sceenshot the the current scene.\
+     * The result is a string containing a base64 encoded image.
+     */
+    createScreenshot(settings?: ScreenshotSettings): Promise<string>;
+    protected static _addCameraAnimationToGroup(targetProperty: string, from: number | Vector3, to: number | Vector3, framesPerSec: number, dataType: number, animationGroup: AnimationGroup, activeCamera: ArcRotateCamera): void;
+    protected _getAutofocusZoomingDistance(boundingSphere: BoundingSphere, camera: ArcRotateCamera): number;
+}