@liveroom-tech/react-immersive 5.0.2 → 5.2.0

package/dist/index.d.ts

@@ -1,17 +1,46 @@
 import * as react from 'react';
-import { n as ModelViewerProps, V as ViewerAnimationsProps, u as ViewerCameraProps, v as ViewerReadyState, e as CaptureImageOptions, U as UseViewerCameraOptions } from './ModelViewer-DOexHkJC.js';
-export { A as AnimationClipInfo, a as AnimationControls, b as AnimationPlaybackState, c as AnnotationMarker, C as CameraControllerType, d as CameraLimits, f as CinematicConfig, g as CinematicWaypoint, h as CustomObjectBindingDataPanelProps, i as CustomSceneObjectsPanelProps, G as GroupedModelViewerProps, H as HomeCameraState, M as MODEL_VIEWER_PRESETS, j as ModelViewerControlsOptions, k as ModelViewerDecoderOptions, l as ModelViewerPerfOptions, m as ModelViewerPreset, o as ModelViewerTilesOptions, p as ModelViewerToolsOptions, q as ModelViewerUiOptions, r as ModelViewerXrOptions, s as MouseControllerPosition, O as ObjectTransformSpace, P as PerformanceProfile, T as TexturePositioningControls, t as ViewerCameraPreset, X as XRScaleMode, w as useViewerAnimations, x as useViewerCamera } from './ModelViewer-DOexHkJC.js';
-import { g as ObjectBinding, q as ObjectBindingTarget, m as ObjectBindingPatch, B as BindingEdit, j as ObjectBindingMaterial, s as ObjectBindingTextureSlot, r as ObjectBindingTextureChannel, t as ObjectBindingTransform, J as SceneConfig, N as SceneConfigPatch, T as SceneLight, U as SceneLightAttachment, h as ObjectBindingAction, f as ObjectActionEvent, a2 as ViewerObjectInfo, a1 as ViewerCameraState } from './objectCatalog-5W8n5xNQ.js';
-export { A as AnimationAction, a as AnimationActionEffect, b as AnimationLoopMode, C as CameraAction, c as CameraActionEffect, D as DEFAULT_SCENE_CONFIG, d as DeepPartial, E as EnvironmentPreset, G as GlitchModeName, K as KernelSizeName, M as MATERIAL_BLENDING_MODES, e as MATERIAL_SIDES, O as ObjectActionEffect, i as ObjectBindingCameraState, k as ObjectBindingMaterialBlendingMode, l as ObjectBindingMaterialSide, n as ObjectBindingSelector, o as ObjectBindingStatus, p as ObjectBindingStyle, u as ObjectBindingType, v as ObjectBindingsActionEffect, w as ObjectPointerEvent, R as RampTypeName, S as SceneAnimationClipConfig, x as SceneAnimationConfig, y as SceneAnnotationMarker, z as SceneBackgroundConfig, F as SceneCameraConfig, H as SceneCinematicConfig, I as SceneCinematicWaypoint, L as SceneConfigActionEffect, P as SceneEnvironmentConfig, Q as SceneGroundShadowConfig, V as SceneLightType, W as SceneLightingConfig, X as SceneModelConfig, Y as SceneModelRenderer, Z as ScenePostProcessingConfig, _ as SceneShadowConfig, $ as SceneWireframeConfig, a0 as ViewerCameraConfig, a3 as VisibilityActionEffect, a4 as material, a5 as patchBindings, a6 as patchSceneConfig, a7 as selectBindingKeys, a8 as selectBindings } from './objectCatalog-5W8n5xNQ.js';
+import { l as ModelViewerProps, r as ViewerCameraProps, t as ViewerReadyState, b as CaptureImageOptions, c as CaptureVideoOptions, U as UseViewerCameraOptions } from './modelViewerProps-CIZ2R_Fv.js';
+export { A as AnnotationMarker, C as CameraControllerType, a as CameraLimits, d as CinematicConfig, e as CinematicWaypoint, f as CustomObjectBindingDataPanelProps, g as CustomSceneObjectsPanelProps, D as DecalMoveTarget, G as GroupedModelViewerProps, H as HomeCameraState, M as MODEL_VIEWER_PRESETS, h as ModelViewerControlsOptions, i as ModelViewerDecoderOptions, j as ModelViewerPerfOptions, k as ModelViewerPreset, m as ModelViewerTilesOptions, n as ModelViewerToolsOptions, o as ModelViewerUiOptions, p as ModelViewerXrOptions, q as MouseControllerPosition, O as ObjectTransformSpace, P as PerformanceProfile, T as TexturePositioningControls, V as ViewerCameraPreset, s as ViewerEngagementEvent, X as XRScaleMode, u as useViewerCamera } from './modelViewerProps-CIZ2R_Fv.js';
+import { o as ObjectBinding, z as ObjectBindingTarget, v as ObjectBindingPatch, B as BindingEdit, s as ObjectBindingMaterial, H as ObjectBindingTextureSlot, F as ObjectBindingTextureChannel, J as ObjectBindingTransform, r as ObjectBindingDecal, a1 as SceneConfig, a3 as SceneConfigPatch, a6 as SceneLight, a7 as SceneLightAttachment, aq as ViewerIsolation, p as ObjectBindingAction, n as ObjectActionEvent, an as ViewerAnimationsProps, ar as ViewerObjectInfo, ap as ViewerCameraState } from './rendererBackend-QwMzISTn.js';
+export { A as AnimationAction, a as AnimationActionEffect, b as AnimationClipInfo, c as AnimationClipState, d as AnimationClipStatus, e as AnimationControls, f as AnimationLoopMode, g as AnimationPlayOptions, h as AnimationPlaybackState, C as CameraAction, i as CameraActionEffect, D as DEFAULT_SCENE_CONFIG, j as DEFAULT_SECTION_CONFIG, k as DeepPartial, E as EnvironmentPreset, G as GlitchModeName, I as IsolatedObjectBindings, l as IsolationActionEffect, K as KernelSizeName, M as MATERIAL_BLENDING_MODES, m as MATERIAL_SIDES, O as ObjectActionEffect, q as ObjectBindingCameraState, t as ObjectBindingMaterialBlendingMode, u as ObjectBindingMaterialSide, w as ObjectBindingSelector, x as ObjectBindingStatus, y as ObjectBindingStyle, L as ObjectBindingType, N as ObjectBindingsActionEffect, P as ObjectPointerEvent, Q as ObjectSurfacePoint, R as RampTypeName, S as RendererBackend, T as SceneAnimationClipConfig, U as SceneAnimationConfig, V as SceneAnnotationCameraView, W as SceneAnnotationImage, X as SceneAnnotationLink, Y as SceneAnnotationMarker, Z as SceneBackgroundConfig, _ as SceneCameraConfig, $ as SceneCinematicConfig, a0 as SceneCinematicWaypoint, a2 as SceneConfigActionEffect, a4 as SceneEnvironmentConfig, a5 as SceneGroundShadowConfig, a8 as SceneLightType, a9 as SceneLightingConfig, aa as SceneModelConfig, ab as SceneModelRenderer, ac as ScenePostProcessingConfig, ad as SceneSectionAxis, ae as SceneSectionConfig, af as SceneShadowConfig, ag as SceneStyleColorScale, ah as SceneStyleCondition, ai as SceneStylePulse, aj as SceneStyleRule, ak as SceneWireframeConfig, al as StyledObjectBindings, am as StyledObjectPulse, ao as ViewerCameraConfig, as as VisibilityActionEffect, at as applyIsolation, au as applyStyleRules, av as colorScaleValue, aw as isolatedBindingKeys, ax as material, ay as patchBindings, az as patchSceneConfig, aA as selectBindingKeys, aB as selectBindings, aC as useViewerAnimations } from './rendererBackend-QwMzISTn.js';
 import { SceneLightInput } from './utils.js';
 export { ACTION_CATALOG, ActionCatalogEntry, ActionHandling, ObjectBindingActionId, ObjectBindingKey, buildBindingsFromNodes, createDefaultBinding, defineObjectBindings, findCatalogAction, inferType, sceneLight } from './utils.js';
-import { V as ViewerModelBounds, a as ViewerModelInfo } from './modelInfo-CEmmvVCH.js';
-export { M as ModelFormat } from './modelInfo-CEmmvVCH.js';
+import { a as ViewerModelBounds, b as ViewerModelInfo } from './modelInfo-XfUQO7C_.js';
+export { M as ModelFormat, V as ViewerLoading, c as ViewerReveal } from './modelInfo-XfUQO7C_.js';
+import { M as MaterialVariantGroup } from './materialVariants-DnZe9eMC.js';
+export { D as DEFAULT_MODEL_VIEWER_LABELS, a as MaterialVariantOption, b as ModelViewerLabelKey, c as ModelViewerLabels, R as ReducedMotionSetting, d as chooseMaterialVariant } from './materialVariants-DnZe9eMC.js';
 import '@react-three/drei';
 import 'three';
 
 declare function PublicModelViewer(props: ModelViewerProps): react.JSX.Element;
 
+/** One side of a comparison: any ModelViewer props, over the shared ones. */
+type CompareViewerSide = Partial<ModelViewerProps> & {
+    /** Shown over this side. Defaults to "Before" and "After". */
+    label?: string;
+};
+type CompareViewerProps = Partial<ModelViewerProps> & {
+    licenseKey: string;
+    /** The left side: the shared props with these on top. */
+    before: CompareViewerSide;
+    /** The right side. */
+    after: CompareViewerSide;
+    /**
+     * `"slider"` lays the two views over each other with a divider to drag
+     * across; `"side-by-side"` shows them next to each other. Default
+     * `"slider"`.
+     */
+    layout?: "slider" | "side-by-side";
+    /** Where the slider's divider is, from 0 (left edge) to 1. Default 0.5. */
+    split?: number;
+    onSplitChange?: (split: number) => void;
+};
+/**
+ * Two ModelViewers showing two configurations of a model (or two models) with
+ * one camera: moving either view moves both.
+ */
+declare function CompareViewer(props: CompareViewerProps): react.JSX.Element;
+
 type HiddenObjectsState = Record<string, boolean>;
 type ObjectBindingsController = {
     objectBindings: Record<string, ObjectBinding>;
@@ -30,6 +59,15 @@ type ObjectBindingsController = {
     setTransform: (target: ObjectBindingTarget, transform: ObjectBindingTransform) => void;
     resetTransform: (target: ObjectBindingTarget) => void;
     updateMetadata: (target: ObjectBindingTarget, metadata: Record<string, unknown>) => void;
+    /**
+     * Prints an image or text on the target objects and returns the decal's id
+     * (the one passed, or a generated one).
+     */
+    addDecal: (target: ObjectBindingTarget, decal: Omit<ObjectBindingDecal, "id"> & {
+        id?: string;
+    }) => string;
+    updateDecal: (target: ObjectBindingTarget, decalId: string, patch: Partial<Omit<ObjectBindingDecal, "id">>) => void;
+    removeDecal: (target: ObjectBindingTarget, decalId: string) => void;
     selectObjectBindings: (target: ObjectBindingTarget) => ObjectBinding[];
     selectObjectBindingIds: (target: ObjectBindingTarget) => string[];
     hiddenObjects: HiddenObjectsState;
@@ -78,15 +116,40 @@ type SceneLightsController = {
  */
 declare function useSceneConfig(initialSceneConfig: SceneConfig | (() => SceneConfig)): SceneConfigController;
 
+type ViewerIsolationProps = {
+    /** The current isolation, or `null` when every object shows normally. */
+    isolation: ViewerIsolation | null;
+    /** Focuses on the target's objects, ghosting (or hiding) the rest. */
+    isolate: (target: ObjectBindingTarget, options?: Omit<ViewerIsolation, "target">) => void;
+    clearIsolation: () => void;
+    /** Pass to `ModelViewer`'s `onIsolationChange`. */
+    handleIsolationChange: (isolation: ViewerIsolation | null) => void;
+};
+/**
+ * State for `ModelViewer`'s `isolation` prop:
+ *
+ * ```tsx
+ * const isolation = useViewerIsolation();
+ * <ModelViewer
+ *   isolation={isolation.isolation}
+ *   onIsolationChange={isolation.handleIsolationChange}
+ * />;
+ * isolation.isolate({ group: "engine" });
+ * ```
+ */
+declare function useViewerIsolation(initialIsolation?: ViewerIsolation | null): ViewerIsolationProps;
+
 type ViewerActionBindingsController = Pick<ObjectBindingsController, "objectBindings" | "updateObjectBindings" | "showObject" | "hideObject" | "toggleObjectVisibility">;
 type ViewerActionSceneController = Pick<SceneConfigController, "updateSceneConfig">;
 type ViewerActionCameraController = Pick<ViewerCameraProps, "focusObject" | "fitScene" | "resetView" | "setCameraTarget" | "setCameraState">;
 type ViewerActionAnimationController = Pick<ViewerAnimationsProps, "play" | "pause" | "stop" | "setSpeed" | "seek">;
+type ViewerActionIsolationController = Pick<ViewerIsolationProps, "handleIsolationChange">;
 type ViewerActionsOptions = {
     bindings: ViewerActionBindingsController;
     scene?: ViewerActionSceneController;
     camera?: ViewerActionCameraController;
     animations?: ViewerActionAnimationController;
+    isolation?: ViewerActionIsolationController;
     onAction?: (event: ObjectActionEvent) => void | Promise<void>;
 };
 type ViewerActionsProps = {
@@ -98,7 +161,7 @@ type ViewerActionsProps = {
  * Resolves object actions and executes their declarative binding, scene,
  * visibility, camera, and animation effects in declaration order.
  */
-declare function useViewerActions({ bindings, scene, camera, animations, onAction, }: ViewerActionsOptions): ViewerActionsProps;
+declare function useViewerActions({ bindings, scene, camera, animations, isolation, onAction, }: ViewerActionsOptions): ViewerActionsProps;
 
 type ViewerReadyHandler = (viewer: ViewerReadyState) => void;
 type ViewerReadyConsumer = ViewerReadyHandler | {
@@ -111,6 +174,8 @@ type ViewerConnectionController = {
     getViewer: () => ViewerReadyState | null;
     /** Captures the connected viewer, or rejects when it is not ready yet. */
     captureImage: (options?: CaptureImageOptions) => Promise<string>;
+    /** Records the connected viewer, or rejects when not ready/unsupported. */
+    captureVideo: (options?: CaptureVideoOptions) => Promise<Blob>;
     /** Requests a frame from the connected viewer. */
     invalidate: () => boolean;
 };
@@ -255,6 +320,13 @@ type ViewerModelProps = {
     error: unknown;
     bounds: ViewerModelBounds | null;
     objectCount: number;
+    /**
+     * The model's glTF material variants, by name; empty when it has none. Show
+     * them by setting `sceneConfig.model.activeVariants`.
+     */
+    materialVariants: string[];
+    /** The same variants as option groups, with labels and swatches. */
+    materialVariantGroups: MaterialVariantGroup[];
     /**
      * Every bindable object in the model (see `ViewerObjectInfo`). Filled by
      * `handleObjectCatalog`, so pass that to `ModelViewer`'s `onObjectCatalog`.
@@ -292,7 +364,8 @@ type UseViewerOptions = {
     onLoadError?: (error: unknown) => void;
 };
 /** The ModelViewer props that connect it to `useViewer`; spread them onto it. */
-type UseViewerProps = Required<Pick<ModelViewerProps, "onObjectBindingsChange" | "selectedObject" | "onObjectSelect" | "onObjectHover" | "onCameraChange" | "onViewerReady" | "onModelLoaded" | "onLoadError" | "onObjectCatalog" | "onAnimationsReady" | "onAction">> & {
+type UseViewerProps = Required<Pick<ModelViewerProps, "onObjectBindingsChange" | "selectedObject" | "onObjectSelect" | "onObjectHover" | "onCameraChange" | "onViewerReady" | "onModelLoaded" | "onLoadError" | "onObjectCatalog" | "onAnimationsReady" | "onAction" | "onIsolationChange">> & {
+    isolation: ModelViewerProps["isolation"];
     objectBindings: Record<string, ObjectBinding>;
     sceneConfig?: SceneConfig;
     onSceneConfigChange: (config: SceneConfig) => void;
@@ -308,8 +381,10 @@ type UseViewerResult = {
     animations: ViewerAnimationsProps;
     actions: ViewerActionsProps;
     scene: SceneConfigController;
+    /** Focus on some objects, ghosting or hiding the rest. */
+    isolation: ViewerIsolationProps;
     effects: ViewerEffectsController;
-    /** The live viewer, image capture and redraw requests. */
+    /** The live viewer, image/video capture and redraw requests. */
     connection: ViewerConnectionController;
 };
 /**
@@ -350,4 +425,4 @@ type ShareableViewerStateProps = {
 };
 declare function useShareableViewerState({ cameraState, setCameraState, objectBindings, onObjectBindingsChange, selectedObjectBinding, setSelectedObjectBinding, paramKey, debounceMs, autoSync, }: UseShareableViewerStateOptions): ShareableViewerStateProps;
 
-export { BindingEdit, CaptureImageOptions, type HiddenObjectsState, PublicModelViewer as ModelViewer, ModelViewerProps, ObjectActionEvent, ObjectBinding, ObjectBindingAction, ObjectBindingMaterial, ObjectBindingPatch, ObjectBindingTarget, ObjectBindingTextureChannel, ObjectBindingTextureSlot, ObjectBindingTransform, type ObjectBindingsController, type RuntimeMaterialPatch, type RuntimeMaterialRanges, type RuntimePointLightOptions, type RuntimePointLightPatch, type RuntimeTransformPatch, type RuntimeTransformRanges, SceneConfig, type SceneConfigController, SceneConfigPatch, type SceneConfigUpdate, SceneLight, SceneLightAttachment, SceneLightInput, type SceneLightPatch, type SceneLightsController, type ShareableViewerStateProps, type UseShareableViewerStateOptions, UseViewerCameraOptions, type UseViewerEffectsOptions, type UseViewerOptions, type UseViewerProps, type UseViewerResult, type ViewerActionAnimationController, type ViewerActionBindingsController, type ViewerActionCameraController, type ViewerActionSceneController, type ViewerActionsOptions, type ViewerActionsProps, ViewerAnimationsProps, ViewerCameraProps, ViewerCameraState, type ViewerConnectionController, type ViewerEffectChannels, type ViewerEffectEasing, type ViewerEffectRange, type ViewerEffectTarget, type ViewerEffectsController, type ViewerFlickerOptions, type ViewerHoverProps, type ViewerLightEffectChannel, type ViewerMaterialEffectChannel, ViewerModelBounds, ViewerModelInfo, type ViewerModelProps, ViewerObjectInfo, type ViewerPulseOptions, type ViewerReadyConsumer, type ViewerReadyHandler, ViewerReadyState, type ViewerSelectionProps, type ViewerTimelineOptions, type ViewerTimelineStep, type ViewerTransformEffectChannel, type ViewerTransitionOptions, type ViewerVector3, useObjectBinding, useObjectBindingIds, useObjectBindings, useSceneConfig, useShareableViewerState, useViewer, useViewerActions, useViewerConnection, useViewerEffects, useViewerHover, useViewerModel, useViewerSelection };
+export { BindingEdit, CaptureImageOptions, CaptureVideoOptions, CompareViewer, type CompareViewerProps, type CompareViewerSide, type HiddenObjectsState, MaterialVariantGroup, PublicModelViewer as ModelViewer, ModelViewerProps, ObjectActionEvent, ObjectBinding, ObjectBindingAction, ObjectBindingDecal, ObjectBindingMaterial, ObjectBindingPatch, ObjectBindingTarget, ObjectBindingTextureChannel, ObjectBindingTextureSlot, ObjectBindingTransform, type ObjectBindingsController, type RuntimeMaterialPatch, type RuntimeMaterialRanges, type RuntimePointLightOptions, type RuntimePointLightPatch, type RuntimeTransformPatch, type RuntimeTransformRanges, SceneConfig, type SceneConfigController, SceneConfigPatch, type SceneConfigUpdate, SceneLight, SceneLightAttachment, SceneLightInput, type SceneLightPatch, type SceneLightsController, type ShareableViewerStateProps, type UseShareableViewerStateOptions, UseViewerCameraOptions, type UseViewerEffectsOptions, type UseViewerOptions, type UseViewerProps, type UseViewerResult, type ViewerActionAnimationController, type ViewerActionBindingsController, type ViewerActionCameraController, type ViewerActionIsolationController, type ViewerActionSceneController, type ViewerActionsOptions, type ViewerActionsProps, ViewerAnimationsProps, ViewerCameraProps, ViewerCameraState, type ViewerConnectionController, type ViewerEffectChannels, type ViewerEffectEasing, type ViewerEffectRange, type ViewerEffectTarget, type ViewerEffectsController, type ViewerFlickerOptions, type ViewerHoverProps, ViewerIsolation, type ViewerIsolationProps, type ViewerLightEffectChannel, type ViewerMaterialEffectChannel, ViewerModelBounds, ViewerModelInfo, type ViewerModelProps, ViewerObjectInfo, type ViewerPulseOptions, type ViewerReadyConsumer, type ViewerReadyHandler, ViewerReadyState, type ViewerSelectionProps, type ViewerTimelineOptions, type ViewerTimelineStep, type ViewerTransformEffectChannel, type ViewerTransitionOptions, type ViewerVector3, useObjectBinding, useObjectBindingIds, useObjectBindings, useSceneConfig, useShareableViewerState, useViewer, useViewerActions, useViewerConnection, useViewerEffects, useViewerHover, useViewerIsolation, useViewerModel, useViewerSelection };