softbox 4.10.1 → 4.12.0

package/dist/index.d.cts

@@ -491,6 +491,20 @@ export declare interface SimpleViewerHandle {
     playAnimations: (clipName?: string) => void;
     /** Freezes playback on the current pose; playAnimations() resumes. */
     pauseAnimations: () => void;
+    /**
+     * Replace the environment map (reflections + background) at runtime with the
+     * equirectangular HDRI/LDR image at `url`. Cached by URL, so re-applying is cheap.
+     */
+    setEnvironmentMap: (url: string) => Promise<void>;
+    /** Restore the built-in studio environment and clean gradient background. */
+    resetEnvironment: () => void;
+    /**
+     * Paint an uploaded image (URL, File, or HTMLImageElement) as the scene backdrop
+     * without changing the environment lighting. Clear it with setBackgroundColor.
+     */
+    setBackgroundImage: (source: string | File | HTMLImageElement) => Promise<void>;
+    /** Set a solid background color (also clears a background image). */
+    setBackgroundColor: (color: string | number) => void;
     dispose: () => void;
 }
 
@@ -516,6 +530,14 @@ export declare interface SimpleViewerOptions {
      */
     floorAlignment?: boolean;
     backgroundColor?: string | number;
+    /**
+     * Optional darker edge colour for a RADIAL backdrop vignette. When set,
+     * `backgroundColor` is painted as the centre (behind the subject) and this as
+     * the corners/bottom, floating the model in a soft cove instead of a flat
+     * fill. Omit for a flat background. Runtime-tunable (applies on a live preset
+     * switch without a rebuild), same as `backgroundColor`.
+     */
+    backgroundColorEdge?: string | number;
     staticScene?: boolean;
     /** GLTF animation playback (autoplay, speed). */
     animations?: AnimationOptions;
@@ -688,10 +710,11 @@ declare interface Vec3Like {
 /**
  * Visual presets: cohesive deltas layered over the defaults (deep-merged) so a
  * model looks intentional on first paint. Each preset only sets **runtime** look
- * fields — background color, tone-mapping exposure and environment intensity —
- * so switching presets is applied live (no viewer rebuild, no model reload) and
- * everything else (camera auto-framing, lighting rig, controls, grid) is
- * inherited from the defaults. Explicit user options always win.
+ * fields — background color (plus an optional radial-vignette edge colour),
+ * tone-mapping exposure and environment intensity — so switching presets is
+ * applied live (no viewer rebuild, no model reload) and everything else (camera
+ * auto-framing, lighting rig, controls, grid) is inherited from the defaults.
+ * Explicit user options always win.
  */
 export declare const VIEWER_PRESETS: Record<ViewerPreset, Partial<SimpleViewerOptions>>;
 

package/dist/index.d.ts

@@ -491,6 +491,20 @@ export declare interface SimpleViewerHandle {
     playAnimations: (clipName?: string) => void;
     /** Freezes playback on the current pose; playAnimations() resumes. */
     pauseAnimations: () => void;
+    /**
+     * Replace the environment map (reflections + background) at runtime with the
+     * equirectangular HDRI/LDR image at `url`. Cached by URL, so re-applying is cheap.
+     */
+    setEnvironmentMap: (url: string) => Promise<void>;
+    /** Restore the built-in studio environment and clean gradient background. */
+    resetEnvironment: () => void;
+    /**
+     * Paint an uploaded image (URL, File, or HTMLImageElement) as the scene backdrop
+     * without changing the environment lighting. Clear it with setBackgroundColor.
+     */
+    setBackgroundImage: (source: string | File | HTMLImageElement) => Promise<void>;
+    /** Set a solid background color (also clears a background image). */
+    setBackgroundColor: (color: string | number) => void;
     dispose: () => void;
 }
 
@@ -516,6 +530,14 @@ export declare interface SimpleViewerOptions {
      */
     floorAlignment?: boolean;
     backgroundColor?: string | number;
+    /**
+     * Optional darker edge colour for a RADIAL backdrop vignette. When set,
+     * `backgroundColor` is painted as the centre (behind the subject) and this as
+     * the corners/bottom, floating the model in a soft cove instead of a flat
+     * fill. Omit for a flat background. Runtime-tunable (applies on a live preset
+     * switch without a rebuild), same as `backgroundColor`.
+     */
+    backgroundColorEdge?: string | number;
     staticScene?: boolean;
     /** GLTF animation playback (autoplay, speed). */
     animations?: AnimationOptions;
@@ -688,10 +710,11 @@ declare interface Vec3Like {
 /**
  * Visual presets: cohesive deltas layered over the defaults (deep-merged) so a
  * model looks intentional on first paint. Each preset only sets **runtime** look
- * fields — background color, tone-mapping exposure and environment intensity —
- * so switching presets is applied live (no viewer rebuild, no model reload) and
- * everything else (camera auto-framing, lighting rig, controls, grid) is
- * inherited from the defaults. Explicit user options always win.
+ * fields — background color (plus an optional radial-vignette edge colour),
+ * tone-mapping exposure and environment intensity — so switching presets is
+ * applied live (no viewer rebuild, no model reload) and everything else (camera
+ * auto-framing, lighting rig, controls, grid) is inherited from the defaults.
+ * Explicit user options always win.
  */
 export declare const VIEWER_PRESETS: Record<ViewerPreset, Partial<SimpleViewerOptions>>;
 

package/dist/simple-viewer.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-D2nrtXiT.cjs");exports.ControlType=e.ControlType;exports.ErrorCode=e.ErrorCode;exports.Hotspot=e.Hotspot;exports.SimpleViewer=e.SimpleViewerWrapper;exports.ThreeViewerError=e.ThreeViewerError;exports.TypedEventEmitter=e.TypedEventEmitter;exports.VIEWER_PRESETS=e.VIEWER_PRESETS;exports.defaultOptions=e.defaultOptions;exports.resolvePreset=e.resolvePreset;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-KNMh4NyY.cjs");exports.ControlType=e.ControlType;exports.ErrorCode=e.ErrorCode;exports.Hotspot=e.Hotspot;exports.SimpleViewer=e.SimpleViewerWrapper;exports.ThreeViewerError=e.ThreeViewerError;exports.TypedEventEmitter=e.TypedEventEmitter;exports.VIEWER_PRESETS=e.VIEWER_PRESETS;exports.defaultOptions=e.defaultOptions;exports.resolvePreset=e.resolvePreset;

package/dist/simple-viewer.es.js

@@ -1,4 +1,4 @@
-import { f as s, E as o, H as a, h as t, e as E, T as i, V as p, i as T, r as l } from "./index-51m_nNmI.js";
+import { f as s, E as o, H as a, h as t, e as E, T as i, V as p, i as T, r as l } from "./index-BGPXOXoA.js";
 export {
   s as ControlType,
   o as ErrorCode,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "softbox",
   "private": false,
-  "version": "4.10.1",
+  "version": "4.12.0",
   "homepage": "https://leming.github.io/softbox/",
   "type": "module",
   "description": "Batteries-included React 3D viewer — any GLB looks studio-shot in one line",