@liveroom-tech/react-immersive 1.3.5 → 2.0.0

package/dist/index.d.ts

@@ -26,10 +26,12 @@ type SceneLightingConfig = {
     };
     lights: SceneLight[];
 };
+declare const SCENE_MODEL_RENDERERS: readonly ["pbr", "matcap", "uv-checker"];
+type SceneModelRenderer = (typeof SCENE_MODEL_RENDERERS)[number];
 type SceneModelConfig = {
     rotation: [number, number, number];
     showAdvancedRotation: boolean;
-    renderer: "pbr" | "matcap";
+    renderer: SceneModelRenderer;
     shading: "lit" | "unlit" | "normals";
 };
 type SceneCameraConfig = {
@@ -610,6 +612,7 @@ type ModelViewerProps = {
     ktx2TranscoderPath?: string | false;
     meshopt?: boolean;
     showMeasureTools?: boolean;
+    showUvCheckerButton?: boolean;
     showExplodeControls?: boolean;
     cinematic?: boolean | CinematicConfig;
     measurementUnit?: string;
@@ -620,7 +623,7 @@ type ModelViewerProps = {
     showAnnotationNavigation?: boolean;
     showAnnotationOnHover?: boolean;
 };
-declare function ModelViewer({ modelUrl, licenseKey, objectBindings, selectedObject, panelHoveredObject, onObjectBindingsChange, onObjectSelect, onObjectHover, onModelLoaded, onLoadError, onAction, onHiddenObjectsChange, onCameraChange, onViewerReady, onTextureUpload, onAnimationsReady, onAnnotationsChange, activeAnnotation: controlledActiveAnnotation, onActiveAnnotationChange, lights, camera, backgroundColor, shadows, showObjectBindingDataPanel, customObjectBindingDataPanel, customSceneObjectsPanel, showSceneObjectsPanel, showDownloadButton, downloadFilename, showResetButton, showLoadingOverlay, showMouseController, mouseControllerPosition, mouseControllerOpacity, moveSensitivity, zoomSensitivity, sceneConfig, disableZoom, zoomOnSelected, highlightOnHover, onAutoFit, refitOnResize, renderMode, maxDpr, performanceProfile, dracoDecoderPath, ktx2TranscoderPath, meshopt, showMeasureTools, showExplodeControls, cinematic, measurementUnit, enableXR, usdzUrl, arScaleMode, mobileHandoffUrl, showAnnotationNavigation, showAnnotationOnHover, }: ModelViewerProps): react_jsx_runtime.JSX.Element;
+declare function ModelViewer({ modelUrl, licenseKey, objectBindings, selectedObject, panelHoveredObject, onObjectBindingsChange, onObjectSelect, onObjectHover, onModelLoaded, onLoadError, onAction, onHiddenObjectsChange, onCameraChange, onViewerReady, onTextureUpload, onAnimationsReady, onAnnotationsChange, activeAnnotation: controlledActiveAnnotation, onActiveAnnotationChange, lights, camera, backgroundColor, shadows, showObjectBindingDataPanel, customObjectBindingDataPanel, customSceneObjectsPanel, showSceneObjectsPanel, showDownloadButton, downloadFilename, showResetButton, showLoadingOverlay, showMouseController, mouseControllerPosition, mouseControllerOpacity, moveSensitivity, zoomSensitivity, sceneConfig, disableZoom, zoomOnSelected, highlightOnHover, onAutoFit, refitOnResize, renderMode, maxDpr, performanceProfile, dracoDecoderPath, ktx2TranscoderPath, meshopt, showMeasureTools, showUvCheckerButton, showExplodeControls, cinematic, measurementUnit, enableXR, usdzUrl, arScaleMode, mobileHandoffUrl, showAnnotationNavigation, showAnnotationOnHover, }: ModelViewerProps): react_jsx_runtime.JSX.Element;
 
 declare function BindingBuilder({ licenseKey }: {
     licenseKey: string;
@@ -661,17 +664,55 @@ declare function useObjectBinding(objectBindings: Record<string, ObjectBinding>,
 
 declare function useObjectBindingIds(objectBindings: Record<string, ObjectBinding>): string[];
 
+type DeepPartial<T> = T extends (infer _U)[] ? T : T extends object ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : T;
+type ObjectBindingPatch = DeepPartial<ObjectBinding>;
+type BindingEdit = {
+    ids: string | string[];
+    patch: ObjectBindingPatch;
+};
+/**
+ * Applies field-level patches to object bindings and returns the updated
+ * record. Pure — nothing is mutated, and the original reference comes back
+ * untouched when no id matched, so React can skip the re-render.
+ *
+ * Ids resolve the same way everywhere else in the library: binding key first,
+ * then `binding.id`, then `binding.modelObjectId`.
+ */
+declare function patchBindings(bindings: Record<string, ObjectBinding>, objectId: string | string[], patch: ObjectBindingPatch): Record<string, ObjectBinding>;
+declare function patchBindings(bindings: Record<string, ObjectBinding>, edits: BindingEdit[]): Record<string, ObjectBinding>;
+/** Shorthand for the common `{ style: { material: … } }` nesting. */
+declare function material(value: ObjectBindingMaterial): ObjectBindingPatch;
+
 type HiddenObjectsState = Record<string, boolean>;
-type ObjectVisibilityProps = {
+type ObjectBindingsController = {
+    objectBindings: Record<string, ObjectBinding>;
+    setObjectBindings: React.Dispatch<React.SetStateAction<Record<string, ObjectBinding>>>;
+    patch: {
+        (objectId: string | string[], patch: ObjectBindingPatch): void;
+        (edits: BindingEdit[]): void;
+    };
+    setMaterial: (objectId: string | string[], material: ObjectBindingMaterial) => void;
+    setBaseColor: (objectId: string | string[], color: string) => void;
+    resetMaterial: (objectId: string | string[]) => void;
+    getMaterial: (objectId: string) => ObjectBindingMaterial | null;
     hiddenObjects: HiddenObjectsState;
     hiddenObjectIds: string[];
-    hideObject: (objectId: string) => void;
-    showObject: (objectId: string) => void;
-    toggleObjectVisibility: (objectId: string) => void;
+    hideObject: (objectId: string | string[]) => void;
+    showObject: (objectId: string | string[]) => void;
+    toggleObjectVisibility: (objectId: string | string[]) => void;
     isObjectHidden: (objectId: string) => boolean;
     clearHiddenObjects: () => void;
 };
-declare function useObjectVisibility(objectBindings: Record<string, ObjectBinding>, onObjectBindingsChange: (next: Record<string, ObjectBinding>) => void): ObjectVisibilityProps;
+/**
+ * Owns object-binding state and exposes field-level, material, and visibility
+ * operations over the same functional state updater.
+ *
+ * Consecutive calls in the same tick compose instead of overwriting each other,
+ * including calls across material and visibility concerns.
+ */
+declare function useObjectBindings(initialBindings: Record<string, ObjectBinding> | (() => Record<string, ObjectBinding>)): ObjectBindingsController;
 
 type ViewerHoverProps = {
     hoveredObjectBinding: ObjectBinding | null;
@@ -725,4 +766,4 @@ type ShareableViewerStateProps = {
 };
 declare function useShareableViewerState({ cameraState, setCameraState, objectBindings, onObjectBindingsChange, selectedObjectBinding, setSelectedObjectBinding, paramKey, debounceMs, autoSync, }: UseShareableViewerStateOptions): ShareableViewerStateProps;
 
-export { type AnimationClipInfo, type AnimationControls, type AnimationLoopMode, type AnimationPlaybackState, BindingBuilder, type CaptureImageOptions, type CinematicConfig, type CinematicWaypoint, type CustomObjectBindingDataPanelProps, type CustomSceneObjectsPanelProps, type HiddenObjectsState, type HomeCameraState, MATERIAL_BLENDING_MODES, MATERIAL_SIDES, ModelViewer, type ModelViewerProps, type ObjectActionEvent, type ObjectBinding, type ObjectBindingAction, type ObjectBindingMaterial, type ObjectBindingMaterialBlendingMode, type ObjectBindingMaterialSide, type ObjectBindingTextureSlot, type ObjectVisibilityProps, type SceneAnimationClipConfig, type SceneAnimationConfig, type SceneCinematicConfig, type SceneCinematicWaypoint, type SceneConfig, SimpleModelViewer, type SimpleModelViewerProps, type ViewerActionsOptions, type ViewerActionsProps, type ViewerAnimationsProps, type ViewerCameraProps, type ViewerCameraState, type ViewerModelBounds, type ViewerModelProps, type ViewerReadyState, type ViewerSelectionProps, type XRScaleMode, useObjectBinding, useObjectBindingIds, useObjectVisibility, useShareableViewerState, useViewerActions, useViewerAnimations, useViewerCamera, useViewerHover, useViewerModel, useViewerSelection };
+export { type AnimationClipInfo, type AnimationControls, type AnimationLoopMode, type AnimationPlaybackState, BindingBuilder, type BindingEdit, type CaptureImageOptions, type CinematicConfig, type CinematicWaypoint, type CustomObjectBindingDataPanelProps, type CustomSceneObjectsPanelProps, type HiddenObjectsState, type HomeCameraState, MATERIAL_BLENDING_MODES, MATERIAL_SIDES, ModelViewer, type ModelViewerProps, type ObjectActionEvent, type ObjectBinding, type ObjectBindingAction, type ObjectBindingMaterial, type ObjectBindingMaterialBlendingMode, type ObjectBindingMaterialSide, type ObjectBindingPatch, type ObjectBindingTextureSlot, type ObjectBindingsController, type SceneAnimationClipConfig, type SceneAnimationConfig, type SceneCinematicConfig, type SceneCinematicWaypoint, type SceneConfig, type SceneModelRenderer, SimpleModelViewer, type SimpleModelViewerProps, type ViewerActionsOptions, type ViewerActionsProps, type ViewerAnimationsProps, type ViewerCameraProps, type ViewerCameraState, type ViewerModelBounds, type ViewerModelProps, type ViewerReadyState, type ViewerSelectionProps, type XRScaleMode, material, patchBindings, useObjectBinding, useObjectBindingIds, useObjectBindings, useShareableViewerState, useViewerActions, useViewerAnimations, useViewerCamera, useViewerHover, useViewerModel, useViewerSelection };