@babylonjs/viewer 7.41.0-alpha → 7.41.1

package/lib/index.d.ts

@@ -1,591 +0,0 @@
-import { LoadAssetContainerOptions, Nullable, AssetContainer, IDisposable, PickingInfo, HotSpotQuery, AbstractEngine, AbstractEngineOptions, EngineOptions, WebGPUEngineOptions } from '@babylonjs/core/index.js';
-import { ArcRotateCamera } from '@babylonjs/core/Cameras/arcRotateCamera.js';
-import { Observable } from '@babylonjs/core/Misc/observable.js';
-import { Scene } from '@babylonjs/core/scene.js';
-import * as lit from 'lit';
-import { LitElement, PropertyValues, TemplateResult } from 'lit';
-import { Color4 } from '@babylonjs/core/Maths/math.color.js';
-import * as lit_html from 'lit-html';
-
-declare const toneMappingOptions: readonly ["none", "standard", "aces", "neutral"];
-type ToneMapping = (typeof toneMappingOptions)[number];
-type LoadModelOptions = LoadAssetContainerOptions & {
-    /**
-     * The default animation index.
-     */
-    defaultAnimation?: number;
-};
-type CameraAutoOrbit = {
-    /**
-     * Whether the camera should automatically orbit around the model when idle.
-     */
-    enabled: boolean;
-    /**
-     * The speed at which the camera orbits around the model when idle.
-     */
-    speed: number;
-    /**
-     * The delay in milliseconds before the camera starts orbiting around the model when idle.
-     */
-    delay: number;
-};
-type PostProcessing = {
-    /**
-     * The tone mapping to use for rendering the scene.
-     */
-    toneMapping: ToneMapping;
-    /**
-     * The contrast applied to the scene.
-     */
-    contrast: number;
-    /**
-     * The exposure applied to the scene.
-     */
-    exposure: number;
-};
-type ViewerDetails = {
-    /**
-     * Gets the Viewer instance.
-     */
-    viewer: Viewer;
-    /**
-     * Provides access to the Scene managed by the Viewer.
-     */
-    scene: Scene;
-    /**
-     * Provides access to the Camera managed by the Viewer.
-     */
-    camera: ArcRotateCamera;
-    /**
-     * Provides access to the currently loaded model.
-     */
-    model: Nullable<AssetContainer>;
-    /**
-     * Suspends the render loop.
-     * @returns A token that should be disposed when the request for suspending rendering is no longer needed.
-     */
-    suspendRendering(): IDisposable;
-    /**
-     * Picks the object at the given screen coordinates.
-     * @remarks This function ensures skeletal and morph target animations are up to date before picking, and typically should not be called at high frequency (e.g. every frame, on pointer move, etc.).
-     * @param screenX The x coordinate in screen space.
-     * @param screenY The y coordinate in screen space.
-     * @returns A PickingInfo if an object was picked, otherwise null.
-     */
-    pick(screenX: number, screenY: number): Promise<Nullable<PickingInfo>>;
-};
-type ViewerOptions = Partial<Readonly<{
-    /**
-     * Called once when the viewer is initialized and provides viewer details that can be used for advanced customization.
-     */
-    onInitialized: (details: Readonly<ViewerDetails>) => void;
-}>>;
-type EnvironmentOptions = Partial<Readonly<{
-    /**
-     * Whether to use the environment for lighting (e.g. IBL).
-     */
-    lighting: boolean;
-    /**
-     * Whether to use the environment for the skybox.
-     */
-    skybox: boolean;
-}>>;
-type ViewerHotSpotQuery = ({
-    /**
-     * The type of the hot spot.
-     */
-    type: "surface";
-    /**
-     * The index of the mesh within the loaded model.
-     */
-    meshIndex: number;
-} & HotSpotQuery) | {
-    /**
-     * The type of the hot spot.
-     */
-    type: "world";
-    /**
-     * The fixed world space position of the hot spot.
-     */
-    position: [x: number, y: number, z: number];
-    /**
-     * The fixed world space normal of the hot spot.
-     */
-    normal: [x: number, y: number, z: number];
-};
-/**
- * Provides the result of a hot spot query.
- */
-declare class ViewerHotSpotResult {
-    /**
-     * 2D canvas position in pixels
-     */
-    readonly screenPosition: [x: number, y: number];
-    /**
-     * 3D world coordinates
-     */
-    readonly worldPosition: [x: number, y: number, z: number];
-    /**
-     * visibility range is [-1..1]. A value of 0 means camera eye is on the plane.
-     */
-    visibility: number;
-}
-/**
- * @experimental
- * Provides an experience for viewing a single 3D model.
- * @remarks
- * The Viewer is not tied to a specific UI framework and can be used with Babylon.js in a browser or with Babylon Native.
- */
-declare class Viewer implements IDisposable {
-    private readonly _engine;
-    /**
-     * Fired when the environment has changed.
-     */
-    readonly onEnvironmentChanged: Observable<void>;
-    /**
-     * Fired when an error occurs while loading the environment.
-     */
-    readonly onEnvironmentError: Observable<unknown>;
-    /**
-     * Fired when the skybox blur changes.
-     */
-    readonly onSkyboxBlurChanged: Observable<void>;
-    /**
-     * Fired when the post processing state changes.
-     */
-    readonly onPostProcessingChanged: Observable<void>;
-    /**
-     * Fired when a model is loaded into the viewer (or unloaded from the viewer).
-     */
-    readonly onModelChanged: Observable<void>;
-    /**
-     * Fired when an error occurs while loading a model.
-     */
-    readonly onModelError: Observable<unknown>;
-    /**
-     * Fired when progress changes on loading activity.
-     */
-    readonly onLoadingProgressChanged: Observable<void>;
-    /**
-     * Fired when the camera auto orbit state changes.
-     */
-    readonly onCameraAutoOrbitChanged: Observable<void>;
-    /**
-     * Fired when the selected animation changes.
-     */
-    readonly onSelectedAnimationChanged: Observable<void>;
-    /**
-     * Fired when the animation speed changes.
-     */
-    readonly onAnimationSpeedChanged: Observable<void>;
-    /**
-     * Fired when the selected animation is playing or paused.
-     */
-    readonly onIsAnimationPlayingChanged: Observable<void>;
-    /**
-     * Fired when the current point on the selected animation timeline changes.
-     */
-    readonly onAnimationProgressChanged: Observable<void>;
-    /**
-     * Fired when the selected material variant changes.
-     */
-    readonly onSelectedMaterialVariantChanged: Observable<void>;
-    private readonly _tempVectors;
-    private readonly _details;
-    private readonly _meshDataCache;
-    private readonly _snapshotHelper;
-    private readonly _autoRotationBehavior;
-    private readonly _imageProcessingConfigurationObserver;
-    private _renderLoopController;
-    private _materialVariantsController;
-    private _skybox;
-    private _skyboxBlur;
-    private _light;
-    private _toneMappingEnabled;
-    private _toneMappingType;
-    private _contrast;
-    private _exposure;
-    private _suspendRenderCount;
-    private _isDisposed;
-    private readonly _loadModelLock;
-    private _loadModelAbortController;
-    private readonly _loadEnvironmentLock;
-    private _loadEnvironmentAbortController;
-    private readonly _loadSkyboxLock;
-    private _loadSkyboxAbortController;
-    private _isLoadingModel;
-    private _modelLoadingProgress;
-    private _selectedAnimation;
-    private _activeAnimationObservers;
-    private _animationSpeed;
-    constructor(_engine: AbstractEngine, options?: ViewerOptions);
-    /**
-     * The camera auto orbit configuration.
-     */
-    get cameraAutoOrbit(): Readonly<CameraAutoOrbit>;
-    set cameraAutoOrbit(value: Partial<Readonly<CameraAutoOrbit>>);
-    /**
-     * A value between 0 and 1 that specifies how much to blur the skybox.
-     */
-    get skyboxBlur(): number;
-    set skyboxBlur(value: number);
-    /**
-     * The post processing configuration.
-     */
-    get postProcessing(): PostProcessing;
-    set postProcessing(value: Partial<Readonly<PostProcessing>>);
-    /**
-     * Gets information about loading activity.
-     * @remarks
-     * false indicates no loading activity.
-     * true indicates loading activity with no progress information.
-     * A number between 0 and 1 indicates loading activity with progress information.
-     */
-    get loadingProgress(): boolean | number;
-    /**
-     * The list of animation names for the currently loaded model.
-     */
-    get animations(): readonly string[];
-    /**
-     * The currently selected animation index.
-     */
-    get selectedAnimation(): number;
-    set selectedAnimation(value: number);
-    /**
-     * True if an animation is currently playing.
-     */
-    get isAnimationPlaying(): boolean;
-    /**
-     * The speed scale at which animations are played.
-     */
-    get animationSpeed(): number;
-    set animationSpeed(value: number);
-    /**
-     * The current point on the selected animation timeline, normalized between 0 and 1.
-     */
-    get animationProgress(): number;
-    set animationProgress(value: number);
-    private get _activeAnimation();
-    /**
-     * The list of material variant names for the currently loaded model.
-     */
-    get materialVariants(): readonly string[];
-    /**
-     * The currently selected material variant.
-     */
-    get selectedMaterialVariant(): Nullable<string>;
-    set selectedMaterialVariant(value: string);
-    /**
-     * Loads a 3D model from the specified URL.
-     * @remarks
-     * If a model is already loaded, it will be unloaded before loading the new model.
-     * @param source A url or File or ArrayBufferView that points to the model to load.
-     * @param options The options to use when loading the model.
-     * @param abortSignal An optional signal that can be used to abort the loading process.
-     */
-    loadModel(source: string | File | ArrayBufferView, options?: LoadModelOptions, abortSignal?: AbortSignal): Promise<void>;
-    /**
-     * Unloads the current 3D model if one is loaded.
-     * @param abortSignal An optional signal that can be used to abort the reset.
-     */
-    resetModel(abortSignal?: AbortSignal): Promise<void>;
-    private _updateModel;
-    /**
-     * Loads an environment texture from the specified url and sets up a corresponding skybox.
-     * @remarks
-     * If an environment is already loaded, it will be unloaded before loading the new environment.
-     * @param url The url of the environment texture to load.
-     * @param options The options to use when loading the environment.
-     * @param abortSignal An optional signal that can be used to abort the loading process.
-     */
-    loadEnvironment(url: string, options?: EnvironmentOptions, abortSignal?: AbortSignal): Promise<void>;
-    /**
-     * Unloads the current environment if one is loaded.
-     * @param options The options to use when resetting the environment.
-     * @param abortSignal An optional signal that can be used to abort the reset.
-     */
-    resetEnvironment(options?: EnvironmentOptions, abortSignal?: AbortSignal): Promise<void>;
-    private _updateEnvironment;
-    /**
-     * Toggles the play/pause animation state if there is a selected animation.
-     */
-    toggleAnimation(): void;
-    /**
-     * Plays the selected animation if there is one.
-     */
-    playAnimation(): void;
-    /**
-     * Pauses the selected animation if there is one.
-     */
-    pauseAnimation(): Promise<void>;
-    /**
-     * Resets the camera to its initial pose.
-     */
-    resetCamera(): void;
-    /**
-     * Disposes of the resources held by the Viewer.
-     */
-    dispose(): void;
-    /**
-     * retrun world and canvas coordinates of an hot spot
-     * @param query mesh index and surface information to query the hot spot positions
-     * @param result Query a Hot Spot and does the conversion for Babylon Hot spot to a more generic HotSpotPositions, without Vector types
-     * @returns true if hotspot found
-     */
-    getHotSpotToRef(query: Readonly<ViewerHotSpotQuery>, result: ViewerHotSpotResult): boolean;
-    private _suspendRendering;
-    private _beginRendering;
-    private _updateCamera;
-    private _updateLight;
-    private _applyAnimationSpeed;
-    private _pick;
-    /**
-     * Check for disposed or aborted state (basically everything that can interrupt an async operation).
-     * @param abortSignals A set of optional AbortSignals to also check.
-     */
-    private _throwIfDisposedOrAborted;
-}
-
-/**
- * Options for creating a Viewer instance that is bound to an HTML canvas.
- */
-type CanvasViewerOptions = ViewerOptions & (({
-    engine?: undefined;
-} & AbstractEngineOptions) | ({
-    engine: "WebGL";
-} & EngineOptions) | ({
-    engine: "WebGPU";
-} & WebGPUEngineOptions));
-/**
- * @experimental
- * Creates a Viewer instance that is bound to an HTML canvas.
- * @remarks
- * This function can be shared across multiple UI integrations (e.g. Web Components, React, etc.).
- * @param canvas The canvas element to bind the Viewer to.
- * @param options The options to use when creating the Viewer and binding it to the specified canvas.
- * @returns A Viewer instance that is bound to the specified canvas.
- */
-declare function createViewerForCanvas(canvas: HTMLCanvasElement, options?: CanvasViewerOptions): Promise<Viewer>;
-
-type HotSpot = ViewerHotSpotQuery & {
-    cameraOrbit?: [alpha: number, beta: number, radius: number];
-};
-interface HTML3DElementEventMap extends HTMLElementEventMap {
-    viewerready: Event;
-    viewerrender: Event;
-    environmentchange: Event;
-    environmenterror: ErrorEvent;
-    modelchange: Event;
-    modelerror: ErrorEvent;
-    loadingprogresschange: Event;
-    selectedanimationchange: Event;
-    animationspeedchange: Event;
-    animationplayingchange: Event;
-    animationprogresschange: Event;
-    selectedmaterialvariantchange: Event;
-}
-/**
- * Displays a 3D model using the Babylon.js Viewer.
- */
-declare class HTML3DElement extends LitElement {
-    private readonly _viewerLock;
-    private _viewerDetails?;
-    private readonly _propertyBindings;
-    /** @internal */
-    static styles: lit.CSSResult;
-    /**
-     * Gets the underlying viewer details (when the underlying viewer is in a loaded state).
-     * This is useful for advanced scenarios where direct access to the viewer or Babylon scene is needed.
-     */
-    get viewerDetails(): Readonly<ViewerDetails> | undefined;
-    /**
-     * Get hotspot world and screen values from a named hotspot
-     * @param name slot of the hot spot
-     * @param result resulting world and screen positions
-     * @returns world position, world normal and screen space coordinates
-     */
-    queryHotSpot(name: string, result: ViewerHotSpotResult): boolean;
-    private _queryHotSpot;
-    /**
-     * Updates the camera to focus on a named hotspot.
-     * @param name The name of the hotspot to focus on.
-     * @returns true if the hotspot was found and the camera was updated, false otherwise.
-     */
-    focusHotSpot(name: string): boolean;
-    /**
-     * The engine to use for rendering.
-     */
-    engine: NonNullable<CanvasViewerOptions["engine"]>;
-    /**
-     * The model URL.
-     */
-    source: Nullable<string>;
-    /**
-     * Forces the model to be loaded with the specified extension.
-     * @remarks
-     * If this property is not set, the extension will be inferred from the model URL when possible.
-     */
-    extension: Nullable<string>;
-    /**
-     * The texture URLs used for lighting and skybox. Setting this property will set both environmentLighting and environmentSkybox.
-     */
-    get environment(): {
-        lighting: Nullable<string>;
-        skybox: Nullable<string>;
-    };
-    set environment(url: string);
-    /**
-     * The texture URL for lighting.
-     */
-    environmentLighting: Nullable<string>;
-    /**
-     * The texture URL for the skybox.
-     */
-    environmentSkybox: Nullable<string>;
-    private _loadingProgress;
-    /**
-     * Gets information about loading activity.
-     * @remarks
-     * false indicates no loading activity.
-     * true indicates loading activity with no progress information.
-     * A number between 0 and 1 indicates loading activity with progress information.
-     */
-    get loadingProgress(): boolean | number;
-    /**
-     * A value between 0 and 1 that specifies how much to blur the skybox.
-     */
-    skyboxBlur: Nullable<number>;
-    /**
-     * The tone mapping to use for rendering the scene.
-     */
-    toneMapping: Nullable<ToneMapping>;
-    /**
-     * The contrast applied to the scene.
-     */
-    contrast: Nullable<number>;
-    /**
-     * The exposure applied to the scene.
-     */
-    exposure: Nullable<number>;
-    /**
-     * The clear color (e.g. background color) for the viewer.
-     */
-    clearColor: Nullable<Color4>;
-    /**
-     * Enables or disables camera auto-orbit.
-     */
-    cameraAutoOrbit: boolean;
-    /**
-     * The speed at which the camera auto-orbits around the target.
-     */
-    cameraAutoOrbitSpeed: Nullable<number>;
-    /**
-     * The delay in milliseconds before the camera starts auto-orbiting.
-     */
-    cameraAutoOrbitDelay: Nullable<number>;
-    /**
-     * Camera orbit can only be set as an attribute, and is set on the camera each time a new model is loaded.
-     * For access to the real time camera properties, use viewerDetails.camera.
-     */
-    private _cameraOrbitCoercer;
-    /**
-     * Camera target can only be set as an attribute, and is set on the camera each time a new model is loaded.
-     * For access to the real time camera properties, use viewerDetails.camera.
-     */
-    private _cameraTargetCoercer;
-    /**
-     * A string value that encodes one or more hotspots.
-     */
-    hotSpots: Readonly<Record<string, HotSpot>>;
-    private get _hasHotSpots();
-    /**
-     * True if the default animation should play automatically when a model is loaded.
-     */
-    animationAutoPlay: boolean;
-    /**
-     * The list of animation names for the currently loaded model.
-     */
-    get animations(): readonly string[];
-    private get _hasAnimations();
-    /**
-     * The currently selected animation index.
-     */
-    selectedAnimation: Nullable<number>;
-    /**
-     * True if an animation is currently playing.
-     */
-    get isAnimationPlaying(): boolean;
-    /**
-     * The speed scale at which animations are played.
-     */
-    animationSpeed: number;
-    /**
-     * The current point on the selected animation timeline, normalized between 0 and 1.
-     */
-    animationProgress: number;
-    private _animations;
-    private _isAnimationPlaying;
-    /**
-     * The list of material variants for the currently loaded model.
-     */
-    get materialVariants(): readonly string[];
-    /**
-     * The currently selected material variant.
-     */
-    selectedMaterialVariant: Nullable<string>;
-    private _canvasContainer;
-    private _materialSelect;
-    /**
-     * Toggles the play/pause animation state if there is a selected animation.
-     */
-    toggleAnimation(): void;
-    /**
-     * Resets the camera to its initial pose.
-     */
-    resetCamera(): void;
-    /** @internal */
-    connectedCallback(): void;
-    /** @internal */
-    disconnectedCallback(): void;
-    /** @internal */
-    protected update(changedProperties: PropertyValues<this>): void;
-    /** @internal */
-    protected render(): TemplateResult<1>;
-    addEventListener<K extends keyof HTML3DElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTML3DElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
-    private _dispatchCustomEvent;
-    private _onSelectedAnimationChanged;
-    private _onAnimationSpeedChanged;
-    private _onAnimationTimelineChanged;
-    private _onAnimationTimelinePointerDown;
-    private _onMaterialVariantChanged;
-    private _onHotSpotsChanged;
-    private _createPropertyBinding;
-    private _setupViewer;
-    private _tearDownViewer;
-    private _updateModel;
-    private _updateEnv;
-}
-
-/**
- * Displays child elements at the screen space location of a hotspot in a babylon-viewer.
- * @remarks
- * The babylon-viewer-annotation element must be a child of a babylon-viewer element.
- */
-declare class HTML3DAnnotationElement extends LitElement {
-    /** @internal */
-    static styles: lit.CSSResult;
-    private readonly _internals;
-    private _viewerAttachment;
-    /**
-     * The name of the hotspot to track.
-     */
-    hotSpot: string;
-    /** @internal */
-    connectedCallback(): void;
-    /** @internal */
-    disconnectedCallback(): void;
-    /** @internal */
-    protected render(): lit_html.TemplateResult<1>;
-}
-
-export { type CameraAutoOrbit, type CanvasViewerOptions, type EnvironmentOptions, HTML3DAnnotationElement, HTML3DElement, type LoadModelOptions, type PostProcessing, type ToneMapping, Viewer, type ViewerDetails, type ViewerHotSpotQuery, ViewerHotSpotResult, type ViewerOptions, createViewerForCanvas };