@liveroom-tech/react-immersive 4.3.0 → 5.0.0

package/dist/publicProps-Bv3_PCP0.d.ts

@@ -1,349 +0,0 @@
-import { ComponentProps, ReactNode, MutableRefObject } from 'react';
-import { CameraControls } from '@react-three/drei';
-import { Object3D, WebGLRenderer, Scene, Camera, Box3, Material } from 'three';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { XRStore } from '@react-three/xr';
-import { v as SceneConfig, f as ObjectBinding, V as ViewerCameraState, e as ObjectActionEvent, s as SceneAnnotationMarker } from './objectBinding-CBRYMYk6.js';
-import { Canvas } from '@react-three/fiber';
-
-type CanvasCamera = ComponentProps<typeof Canvas>["camera"];
-
-type RendererCapture = {
-    gl: WebGLRenderer;
-    scene: Scene;
-    camera: Camera;
-    invalidate: () => void;
-};
-type Props = {
-    children: ReactNode;
-    camera?: CanvasCamera;
-    backgroundColor?: string;
-    shadows?: boolean;
-    sceneConfig?: SceneConfig;
-    selectedObjectRef?: Object3D | null;
-    hoveredObjectRef?: Object3D | null;
-    highlightOnHover?: boolean;
-    renderMode?: "always" | "demand";
-    maxDpr?: number;
-    xrStore?: XRStore | null;
-    rendererCaptureRef?: MutableRefObject<RendererCapture | null>;
-    preserveDrawingBuffer?: boolean;
-    reduceGpuLoad?: boolean;
-};
-declare function Viewer({ children, camera, backgroundColor, shadows, sceneConfig, selectedObjectRef, hoveredObjectRef, highlightOnHover, renderMode, maxDpr, xrStore, rendererCaptureRef, preserveDrawingBuffer, reduceGpuLoad, }: Props): react_jsx_runtime.JSX.Element;
-
-type PerformanceProfile = "auto" | "high" | "low";
-
-type CameraLimits = {
-    minDistance?: number;
-    maxDistance?: number;
-    minPolarAngle?: number;
-    maxPolarAngle?: number;
-    minAzimuthAngle?: number;
-    maxAzimuthAngle?: number;
-    panBoundary?: [min: [number, number, number], max: [number, number, number]];
-    boundaryEnclosesCamera?: boolean;
-    boundaryFriction?: number;
-};
-type CameraControllerType = "orbit" | "pointerLock";
-
-type GltfDecoderConfig = {
-    dracoDecoderPath?: string | false;
-    ktx2TranscoderPath?: string | false;
-    meshopt?: boolean;
-};
-
-/** One entry of the object catalog the processor writes beside `tileset.json`. */
-type TileObjectCatalogEntry = {
-    name: string;
-    triangles: number;
-    minimum: [number, number, number];
-    maximum: [number, number, number];
-};
-type StreamingTilesModelProps = {
-    url: string;
-    rotation?: [number, number, number];
-    errorTarget?: number;
-    cacheSize?: number;
-    /**
-     * Ceiling on the geometry and texture the renderer keeps resident, in MB.
-     * Reaching it does not degrade quality — it stops content being requested
-     * entirely — so it is a limit to stay under, not one to aim at.
-     */
-    memoryBudgetMB?: number;
-    /** Same decoder configuration the monolithic loader uses. */
-    decoderConfig?: GltfDecoderConfig;
-    /** Bindings keyed the same way as the monolithic viewer's. */
-    objectBindings?: Record<string, ObjectBinding>;
-    /** Live colour overrides from the editor's picker. */
-    itemMaterials?: Record<string, {
-        hex?: string;
-    }>;
-    /** Supplies the shading and renderer modes, as it does for the model path. */
-    sceneConfig?: SceneConfig;
-    selectedItem?: string | null;
-    /** Matches the monolithic viewer: a binding, not a node name. */
-    panelHoveredItem?: ObjectBinding | null;
-    highlightOnHover?: boolean;
-    onItemClick?: (binding: ObjectBinding) => void;
-    onItemHover?: (binding: ObjectBinding | null) => void;
-    /** Every bindable object in the model, available before any tile loads. */
-    onObjectCatalog?: (objects: TileObjectCatalogEntry[]) => void;
-    /**
-     * The whole model's world-space extent, reported as soon as tileset.json is
-     * parsed and long before any content is fetched. The viewer needs it to frame
-     * the camera; see the reporting effect below for why waiting is not an option.
-     */
-    onTilesetBounds?: (box: Box3) => void;
-    onModelLoaded?: (scene: Object3D) => void;
-    onLoadError?: (error: unknown) => void;
-    /**
-     * One representative resident mesh per binding, for the transform gizmo and
-     * for framing the camera. A streamed object has no single node — it exists
-     * once per resolved level of detail, and those come and go — so this is
-     * rebuilt as tiles arrive and are evicted rather than being written once.
-     */
-    nodeRefsOut?: React.MutableRefObject<Record<string, Object3D>>;
-    onNodeRefsChange?: () => void;
-    materialRefsOut?: React.MutableRefObject<Record<string, Material | Material[]>>;
-    /** 0-1. Eased here, so the value can be driven straight from a slider. */
-    explodeFactor?: number;
-    suspendBindingTransforms?: boolean;
-};
-
-type ModelFormat = "glb" | "gltf" | "obj" | "fbx" | "usdz";
-
-type XRScaleMode = "normalized" | "real-world";
-
-type CinematicWaypoint = {
-    position: [number, number, number];
-    target: [number, number, number];
-    azimuthAngle?: number;
-    polarAngle?: number;
-    segmentDuration?: number;
-};
-type CinematicConfig = {
-    waypoints?: CinematicWaypoint[];
-    duration?: number;
-    loop?: boolean;
-    autoPlay?: boolean;
-};
-
-type MouseControllerPosition = 'bottom-left' | 'bottom-right' | 'top-left' | 'top-right' | 'center' | 'center-bottom' | 'center-top';
-
-type CaptureImageOptions = {
-    width?: number;
-    height?: number;
-    transparent?: boolean;
-};
-
-type ViewerCameraPreset = {
-    position: [number, number, number];
-    target: [number, number, number];
-    fov?: number | null;
-    zoom?: number;
-    azimuthAngle?: number;
-    polarAngle?: number;
-};
-type UseViewerCameraOptions = {
-    /** Camera position applied once when each model becomes ready. */
-    initialPosition?: [number, number, number];
-    /** Orbit target applied once when each model becomes ready. */
-    initialTarget?: [number, number, number];
-    /** Whether the initial position/target should animate. Defaults to false. */
-    initialTransition?: boolean;
-    /** Named views that can be opened with goToPreset. */
-    presets?: Record<string, ViewerCameraPreset>;
-};
-type HomeCameraState = {
-    position: [number, number, number];
-    target: [number, number, number];
-};
-type ViewerReadyState = {
-    controls: CameraControls;
-    scene: Object3D | null;
-    objectBindings: Record<string, ObjectBinding>;
-    nodeRefs: Record<string, Object3D>;
-    homeCameraState: HomeCameraState | null;
-    captureImage: (options?: CaptureImageOptions) => Promise<string>;
-    invalidate: () => void;
-};
-type ViewerCameraProps = {
-    cameraState: ViewerCameraState | null;
-    cameraPresets: Record<string, ViewerCameraPreset>;
-    resetView: () => Promise<boolean>;
-    focusObject: (objectId: string) => Promise<boolean>;
-    fitScene: () => Promise<boolean>;
-    setCameraTarget: (target: [number, number, number], enableTransition?: boolean) => Promise<boolean>;
-    setCameraState: (state: ViewerCameraState, enableTransition?: boolean) => Promise<boolean>;
-    lookAt: (position: [number, number, number], target: [number, number, number], enableTransition?: boolean) => Promise<boolean>;
-    orbitTo: (azimuthAngle: number, polarAngle: number, enableTransition?: boolean) => Promise<boolean>;
-    dollyTo: (distance: number, enableTransition?: boolean) => Promise<boolean>;
-    savePreset: (name: string) => ViewerCameraState | null;
-    goToPreset: (name: string, enableTransition?: boolean) => Promise<boolean>;
-    handleCameraChange: (camera: Camera, controls: CameraControls) => void;
-    handleViewerReady: (viewer: ViewerReadyState) => void;
-};
-declare function useViewerCamera(options?: UseViewerCameraOptions): ViewerCameraProps;
-
-type AnimationClipInfo = {
-    sourceName: string;
-    duration: number;
-};
-type AnimationPlaybackState = {
-    currentClip: string | null;
-    isPlaying: boolean;
-    speed: number;
-    time: number;
-    duration: number;
-};
-type AnimationControls = {
-    clips: string[];
-    clipDetails?: AnimationClipInfo[];
-    play: (clipName: string) => void;
-    pause: () => void;
-    stop: () => void;
-    setSpeed: (speed: number) => void;
-    seek?: (time: number) => void;
-    getState?: () => AnimationPlaybackState;
-    subscribe?: (listener: (state: AnimationPlaybackState) => void) => () => void;
-};
-type ViewerAnimationsProps = {
-    clips: string[];
-    clipDetails: AnimationClipInfo[];
-    currentClip: string | null;
-    isPlaying: boolean;
-    speed: number;
-    time: number;
-    duration: number;
-    play: (clipName: string) => void;
-    pause: () => void;
-    stop: () => void;
-    setSpeed: (speed: number) => void;
-    seek: (time: number) => void;
-    handleAnimationsReady: (controls: AnimationControls) => void;
-};
-declare function useViewerAnimations(): ViewerAnimationsProps;
-
-type ObjectTransformSpace = "local" | "world";
-
-type ViewerCamera = React.ComponentProps<typeof Viewer>["camera"];
-type AnnotationMarker = SceneAnnotationMarker & {
-    markerId?: string;
-};
-type CustomObjectBindingDataPanelProps = {
-    isOpen: boolean;
-    selectedObject: ObjectBinding | null;
-    currentAction: ObjectActionEvent | null;
-    onClose: () => void;
-    onAction: (event: ObjectActionEvent) => void;
-};
-type CustomSceneObjectsPanelProps = {
-    objectBindings: Record<string, ObjectBinding>;
-    onAction?: (event: ObjectActionEvent) => void;
-    onFocus?: (binding: ObjectBinding) => void;
-    onHover?: (binding: ObjectBinding | null) => void;
-};
-type ModelViewerProps = {
-    modelUrl: string;
-    /** Optional 3D Tiles manifest used instead of loading `modelUrl` monolithically. */
-    tilesetUrl?: string | null;
-    /** Screen-space error target for streamed 3D Tiles. Lower is sharper. */
-    tilesErrorTarget?: number;
-    /** Maximum number of parsed tiles retained by the client cache. */
-    tilesCacheSize?: number;
-    /**
-     * Every bindable object in a streamed model, read from the catalog the
-     * processor writes beside `tileset.json`. Reported once, before the tiles
-     * that contain those objects have necessarily loaded.
-     */
-    onObjectCatalog?: (objects: TileObjectCatalogEntry[]) => void;
-    /** Explicit format for extensionless or signed model URLs. */
-    modelFormat?: ModelFormat;
-    licenseKey: string;
-    objectBindings: Record<string, ObjectBinding>;
-    selectedObject?: ObjectBinding | null;
-    panelHoveredObject?: ObjectBinding | null;
-    onObjectBindingsChange?: (next: Record<string, ObjectBinding>) => void;
-    onObjectSelect?: (binding: ObjectBinding | null) => void;
-    onObjectHover?: (binding: ObjectBinding | null) => void;
-    onModelLoaded?: (scene: Object3D) => void;
-    onLoadError?: (error: unknown) => void;
-    onProgress?: (event: ProgressEvent) => void;
-    onCameraControllerChange?: (controller: CameraControllerType) => void;
-    cameraControllerType?: CameraControllerType;
-    onAction?: (event: ObjectActionEvent) => void;
-    onHiddenObjectsChange?: (next: Record<string, boolean>) => void;
-    onCameraChange?: (camera: Camera, controls: CameraControls) => void;
-    onViewerReady?: (viewer: ViewerReadyState) => void;
-    onTextureUpload?: (file: File, objectId: string) => Promise<string>;
-    onAnimationsReady?: (controls: AnimationControls) => void;
-    onAnnotationsChange?: (annotations: AnnotationMarker[]) => void;
-    activeAnnotation?: AnnotationMarker | null;
-    onActiveAnnotationChange?: (annotation: AnnotationMarker | null) => void;
-    lights?: ReactNode;
-    camera?: ViewerCamera;
-    cameraLimits?: CameraLimits;
-    backgroundColor?: string;
-    shadows?: boolean;
-    showObjectBindingDataPanel?: boolean;
-    customObjectBindingDataPanel?: (props: CustomObjectBindingDataPanelProps) => ReactNode;
-    customSceneObjectsPanel?: (props: CustomSceneObjectsPanelProps) => ReactNode;
-    showSceneObjectsPanel?: boolean;
-    showDownloadButton?: boolean;
-    downloadFilename?: string;
-    showResetButton?: boolean;
-    showLoadingOverlay?: boolean;
-    showMouseController?: boolean;
-    mouseControllerPosition?: MouseControllerPosition;
-    mouseControllerOpacity?: number;
-    moveSensitivity?: number;
-    zoomSensitivity?: number;
-    sceneConfig?: SceneConfig;
-    disableZoom?: boolean;
-    zoomOnSelected?: boolean;
-    highlightOnHover?: boolean;
-    onAutoFit?: () => Promise<boolean>;
-    enableCameraControls?: boolean;
-    moveModeEnabled?: boolean;
-    /** Aligns PivotControls to the scene or to the selected object. */
-    objectTransformSpace?: ObjectTransformSpace;
-    /** Enables canvas-focused camera shortcuts. Disabled by default. */
-    enableKeyboardNavigation?: boolean;
-    refitOnResize?: boolean;
-    renderMode?: "always" | "demand";
-    maxDpr?: number;
-    preserveDrawingBuffer?: boolean;
-    performanceProfile?: PerformanceProfile;
-    dracoDecoderPath?: string | false;
-    ktx2TranscoderPath?: string | false;
-    meshopt?: boolean;
-    showMeasureTools?: boolean;
-    showUvCheckerButton?: boolean;
-    showExplodeControls?: boolean;
-    cinematic?: boolean | CinematicConfig;
-    measurementUnit?: string;
-    enableXR?: boolean;
-    usdzUrl?: string;
-    arScaleMode?: XRScaleMode;
-    mobileHandoffUrl?: string;
-    showAnnotationNavigation?: boolean;
-    showAnnotationOnHover?: boolean;
-    onSceneConfigChange?: (config: SceneConfig) => void;
-    showViewGizmo?: boolean;
-    autoRotate?: boolean;
-    autoRotateSpeed?: number;
-};
-
-/** Props of `BindingBuilder`. */
-type BindingBuilderProps = {
-    licenseKey: string;
-    /** Directory containing the DRACO decoder files, or false. */
-    dracoDecoderPath?: string | false;
-    /** Directory containing the Basis/KTX2 transcoder files, or false. */
-    ktx2TranscoderPath?: string | false;
-    /** Enable the bundled Meshopt decoder. Defaults to true. */
-    meshopt?: boolean;
-};
-
-export { type AnimationClipInfo as A, type BindingBuilderProps as B, type CaptureImageOptions as C, type HomeCameraState as H, type ModelFormat as M, type ObjectTransformSpace as O, type StreamingTilesModelProps as S, type TileObjectCatalogEntry as T, type UseViewerCameraOptions as U, type ViewerAnimationsProps as V, type XRScaleMode as X, type AnimationControls as a, type AnimationPlaybackState as b, type CinematicConfig as c, type CinematicWaypoint as d, type CustomObjectBindingDataPanelProps as e, type CustomSceneObjectsPanelProps as f, type ModelViewerProps as g, type ViewerCameraPreset as h, type ViewerCameraProps as i, type ViewerReadyState as j, useViewerCamera as k, useViewerAnimations as u };