softbox 4.22.0 → 4.24.0

package/dist/index.d.ts

@@ -31,6 +31,33 @@ export declare interface AnimationOptions {
     speed?: number;
 }
 
+/**
+ * AR handoff configuration: a small button over the canvas that opens the
+ * model in the platform's native AR viewer — AR Quick Look on iOS, Scene
+ * Viewer on Android. UI-only: the button never touches the WebGL viewer, and
+ * toggling it never rebuilds anything. The button only renders on devices
+ * that can actually hand off (never on desktop).
+ */
+export declare interface AROptions {
+    /**
+     * USDZ counterpart of the model, for iOS AR Quick Look — Quick Look cannot
+     * read GLB, so without this the button stays hidden on iOS. Android Scene
+     * Viewer instead reuses the loaded model's own URL and needs nothing here
+     * (but requires the model to be loaded from a network URL — a dropped
+     * `blob:` file has no address a native app could fetch).
+     */
+    iosSrc?: string;
+    /** Title shown on Android Scene Viewer's info card. */
+    title?: string;
+    /**
+     * Corner the button floats in (default `bottom-left`). When the built-in
+     * preset picker is enabled, a bottom-placed button lifts above the chip
+     * row on its own — pick a top corner if it must clear other chrome (e.g.
+     * a `bottom-left` gizmo).
+     */
+    placement?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+}
+
 export declare interface AxesHelperOptions {
     size?: number;
 }
@@ -581,6 +608,14 @@ export declare interface SimpleViewerHandle {
     captureVideo: (options?: CaptureVideoOptions) => Promise<Blob>;
     /** Clip names of the loaded model, in file order (empty when none). */
     getAnimationNames: () => string[];
+    /** KHR_materials_variants names of the loaded model (empty when none). */
+    getVariantNames: () => string[];
+    /**
+     * Switch the loaded model to a material variant; `null` restores the
+     * authored materials. Applies live (no reload). Throws `INVALID_PARAMETER`
+     * on a variant name the model does not carry.
+     */
+    setVariant: (variant: string | null) => void;
     /**
      * Plays one clip by name, or ALL clips when no name is given (looped).
      * Throws `INVALID_PARAMETER` on a clip name the model does not carry.
@@ -624,6 +659,16 @@ export declare interface SimpleViewerOptions {
      * Any other option you pass overrides the scene's values.
      */
     scene?: ViewerScene;
+    /**
+     * KHR_materials_variants variant to show (e.g. a product colorway baked
+     * into the GLB). Applies LIVE — switching never rebuilds the viewer or
+     * reloads the model. `null` shows the authored default materials; leaving
+     * the option out is "uncontrolled" (an imperative `handle.setVariant()`
+     * pick survives other option changes); an unknown name warns and keeps
+     * the defaults. Enumerate the model's variants via
+     * `handle.getVariantNames()`.
+     */
+    variant?: string | null;
     /**
      * Length unit the model geometry is authored in (default `'meters'`).
      * Non-meter models are rescaled on load — without touching the model's own
@@ -712,6 +757,14 @@ export declare interface SimpleViewerOptions {
      * live preset picker). All opt-in; UI-only — never rebuilds the viewer.
      */
     ui?: UIOptions;
+    /**
+     * AR handoff button: opens the model in the platform's native AR viewer —
+     * AR Quick Look on iOS (needs `iosSrc`, a USDZ counterpart), Scene Viewer
+     * on Android (reuses the model's own URL). `true` enables with defaults.
+     * The button renders only on devices that can actually hand off, so it is
+     * safe to set unconditionally. UI-only — never rebuilds the viewer.
+     */
+    ar?: boolean | AROptions;
     /**
      * Click-picking / hotspot-occlusion raycast tuning (e.g. `selection: { bvh:
      * false }` to skip the load-time BVH build on memory-constrained targets).