shopar-plugin 1.1.2-alpha.0 → 1.2.0-alpha.0

package/README.md

@@ -223,7 +223,7 @@ Options used for the plugin setup:
   - Default value: `'pan-y'`
 - `zoomEnabled` (optional)
   - Type: `boolean`
-  - If provided and set to `false`, disables zoom in 3D by ignoring mouse scroll or pinch touch events.
+  - If provided and set to `false`, disables zoom in 3D. This includes both user interaction (mouse scroll, pinch touch) and programmatic zoom.
   - Default value: `true`
 - `minZoom` (optional)
   - Type: `number`
@@ -233,6 +233,30 @@ Options used for the plugin setup:
   - Type: `number`
   - If provided, it will be used as the maximum zoom level in 3D.
   - Default value: `5`
+- `onMaxZoomEnter` (optional)
+  - Type: `() => void`
+  - If provided, it will be called when the maximum zoom level (`maxZoom`) is reached in 3D.
+- `onMaxZoomLeave` (optional)
+  - Type: `() => void`
+  - If provided, it will be called when the zoom level moves away from the maximum (`maxZoom`) in 3D.
+- `onMinZoomEnter` (optional)
+  - Type: `() => void`
+  - If provided, it will be called when the minimum zoom level (`minZoom`) is reached in 3D.
+- `onMinZoomLeave` (optional)
+  - Type: `() => void`
+  - If provided, it will be called when the zoom level moves away from the minimum (`minZoom`) in 3D.
+- `onMinVerticalAngleEnter` (optional)
+  - Type: `() => void`
+  - If provided, it will be called when the minimum vertical angle is reached in 3D. This corresponds to the camera being positioned at the top of the orbit, looking down at the object.
+- `onMinVerticalAngleLeave` (optional)
+  - Type: `() => void`
+  - If provided, it will be called when the vertical angle moves away from the minimum in 3D. The camera is no longer at the top of the orbit.
+- `onMaxVerticalAngleEnter` (optional)
+  - Type: `() => void`
+  - If provided, it will be called when the maximum vertical angle is reached in 3D. This corresponds to the camera being positioned at the bottom of the orbit, looking up at the object.
+- `onMaxVerticalAngleLeave` (optional)
+  - Type: `() => void`
+  - If provided, it will be called when the vertical angle moves away from the maximum in 3D. The camera is no longer at the bottom of the orbit.
 - `alwaysTransparentBackground` (optional)
   - Type: `boolean`
   - If provided and set to `true`, transparent background will always be used in 3D.

package/dist/shopar-plugin.d.ts

@@ -122,6 +122,42 @@ type Plugin = {
      * @param value The provided value.
      */
     setInteractive: (interactive: boolean) => void;
+    /**
+     * Zooms the 3D view in.
+     * The magnification is multiplied by `2^power`, so a power of 1 doubles the magnification.
+     * Has no effect if the 3D view is not currently active.
+     * Set to `undefined` if 3D is not supported for given SKU.
+     *
+     * @param power The exponent applied to the zoom. Each unit doubles the magnification.
+     */
+    zoomIn3D?: (power: number) => void;
+    /**
+     * Zooms the 3D view out.
+     * The magnification is divided by `2^power`, so a power of 1 halves the magnification.
+     * Has no effect if the 3D view is not currently active.
+     * Set to `undefined` if 3D is not supported for given SKU.
+     *
+     * @param power The exponent applied to the zoom. Each unit halves the magnification.
+     */
+    zoomOut3D?: (power: number) => void;
+    /**
+     * Rotates the 3D model horizontally by the specified number of degrees.
+     * The initial animation is stopped on the first call.
+     * Has no effect if the 3D view is not currently active.
+     * Set to `undefined` if 3D is not supported for given SKU.
+     *
+     * @param degrees The rotation angle in degrees. Positive values rotate the model right, negative values rotate left.
+     */
+    rotateHorizontally3D?: (degrees: number) => void;
+    /**
+     * Rotates the 3D model vertically by the specified number of degrees.
+     * The initial animation is stopped on the first call.
+     * Has no effect if the 3D view is not currently active.
+     * Set to `undefined` if 3D is not supported for given SKU.
+     *
+     * @param degrees The rotation angle in degrees. Positive values rotate the model up, negative values rotate down.
+     */
+    rotateVertically3D?: (degrees: number) => void;
 };
 /**
  * Vision plugin controller
@@ -373,6 +409,42 @@ type SetupOptions = {
      * @see debounce3DEngagementMs
      */
     onDebounced3DEngagement?: (durationMs: number) => void;
+    /**
+     * If provided, it will be called when the maximum zoom level (`maxZoom`) is reached in 3D.
+     */
+    onMaxZoomEnter?: () => void;
+    /**
+     * If provided, it will be called when the zoom level moves away from the maximum (`maxZoom`) in 3D.
+     */
+    onMaxZoomLeave?: () => void;
+    /**
+     * If provided, it will be called when the minimum zoom level (`minZoom`) is reached in 3D.
+     */
+    onMinZoomEnter?: () => void;
+    /**
+     * If provided, it will be called when the zoom level moves away from the minimum (`minZoom`) in 3D.
+     */
+    onMinZoomLeave?: () => void;
+    /**
+     * If provided, it will be called when the minimum vertical angle is reached in 3D.
+     * This corresponds to the camera being positioned at the top of the orbit, looking down at the object.
+     */
+    onMinVerticalAngleEnter?: () => void;
+    /**
+     * If provided, it will be called when the vertical angle moves away from the minimum in 3D.
+     * The camera is no longer at the top of the orbit.
+     */
+    onMinVerticalAngleLeave?: () => void;
+    /**
+     * If provided, it will be called when the maximum vertical angle is reached in 3D.
+     * This corresponds to the camera being positioned at the bottom of the orbit, looking up at the object.
+     */
+    onMaxVerticalAngleEnter?: () => void;
+    /**
+     * If provided, it will be called when the vertical angle moves away from the maximum in 3D.
+     * The camera is no longer at the bottom of the orbit.
+     */
+    onMaxVerticalAngleLeave?: () => void;
     /**
      * If provided, it will be used as the video source for AR instead of the default camera used by plugin.
      *