@wandelbots/wandelbots-js-react-components 2.26.0-pr.feature-update-to-react-19.361.c3fd41e → 2.26.0-pr.feature-update-to-react-19.361.fbd0985

package/dist/components/utils/interpolation.d.ts

@@ -62,29 +62,42 @@ export declare class ValueInterpolator {
     private velocities;
     constructor(initialValues?: number[], options?: InterpolationOptions);
     /**
-     * Update interpolation using spring physics (call this in useFrame for frame-rate independence)
-     * @param delta - Frame delta time for smooth animation
+     * Update interpolation using spring physics
+     *
+     * Call this method every frame for smooth animation. In React Three Fiber,
+     * call from within useFrame callback with the provided delta time.
+     *
+     * @param delta - Time elapsed since last update in seconds (e.g., 1/60 ≈ 0.0167 for 60fps)
+     * @returns true when interpolation is complete (all values reached their targets)
      */
     update(delta?: number): boolean;
     /**
-     * Set new target values to interpolate towards
-     * Handles irregular target updates smoothly by considering update frequency
+     * Set new target values for the interpolation to move towards
+     *
+     * Includes smart blending for very rapid target updates (faster than 120fps)
+     * to prevent jarring movements when targets change frequently.
      */
     setTarget(newValues: number[]): void;
     /**
-     * Get the current interpolated values
+     * Get a copy of all current interpolated values
      */
     getCurrentValues(): number[];
     /**
-     * Get a specific interpolated value by index
+     * Get a single interpolated value by its array index
      */
     getValue(index: number): number;
     /**
-     * Check if interpolation is currently active
+     * Check if automatic interpolation is currently running
+     *
+     * This only tracks auto-interpolation started with startAutoInterpolation().
+     * Manual update() calls are not tracked by this method.
      */
     isInterpolating(): boolean;
     /**
-     * Stop the current interpolation
+     * Stop automatic interpolation if it's running
+     *
+     * This cancels the internal animation frame loop but does not affect
+     * manual update() calls.
      */
     stop(): void;
     /**
@@ -96,11 +109,18 @@ export declare class ValueInterpolator {
      */
     updateOptions(newOptions: Partial<InterpolationOptions>): void;
     /**
-     * Start automatic interpolation (use when not calling update() manually)
+     * Start automatic interpolation with an animation loop
+     *
+     * This begins a requestAnimationFrame loop that calls update() automatically.
+     * For React Three Fiber components, prefer using manual update() calls
+     * within useFrame hooks instead.
      */
     startAutoInterpolation(): void;
     /**
-     * Destroy the interpolator and clean up resources
+     * Clean up all resources and stop any running animations
+     *
+     * This cancels any active animation frames and resets internal state.
+     * Call this when the component unmounts or is no longer needed.
      */
     destroy(): void;
     private startInterpolation;

package/dist/components/utils/interpolation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interpolation.d.ts","sourceRoot":"","sources":["../../../src/components/utils/interpolation.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AAEH,MAAM,WAAW,oBAAoB;IACnC,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,IAAI,CAAA;IACrC,wDAAwD;IACxD,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,IAAI,CAAA;CACxC;AAED,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,aAAa,CAAe;IACpC,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,oBAAoB,CAAe;IAC3C,OAAO,CAAC,gBAAgB,CAAY;IACpC,OAAO,CAAC,WAAW,CAAsB;IACzC,OAAO,CAAC,OAAO,CAAgC;IAG/C,OAAO,CAAC,UAAU,CAAe;gBAG/B,aAAa,GAAE,MAAM,EAAO,EAC5B,OAAO,GAAE,oBAAyB;IAkBpC;;;OAGG;IACH,MAAM,CAAC,KAAK,GAAE,MAAe,GAAG,OAAO;IAuDvC;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI;IA6CpC;;OAEG;IACH,gBAAgB,IAAI,MAAM,EAAE;IAI5B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAI/B;;OAEG;IACH,eAAe,IAAI,OAAO;IAI1B;;OAEG;IACH,IAAI,IAAI,IAAI;IAOZ;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI;IAUpC;;OAEG;IACH,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,IAAI;IAI9D;;OAEG;IACH,sBAAsB,IAAI,IAAI;IAI9B;;OAEG;IACH,OAAO,IAAI,IAAI;IAIf,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,OAAO,CASd;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,gBAAgB,CAC9B,aAAa,GAAE,MAAM,EAAO,EAC5B,OAAO,GAAE,oBAAyB,GACjC,CAAC,iBAAiB,CAAC,CAqBrB"}
+{"version":3,"file":"interpolation.d.ts","sourceRoot":"","sources":["../../../src/components/utils/interpolation.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AAEH,MAAM,WAAW,oBAAoB;IACnC,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,IAAI,CAAA;IACrC,wDAAwD;IACxD,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,IAAI,CAAA;CACxC;AAED,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,aAAa,CAAe;IACpC,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,oBAAoB,CAAe;IAC3C,OAAO,CAAC,gBAAgB,CAAY;IACpC,OAAO,CAAC,WAAW,CAAsB;IACzC,OAAO,CAAC,OAAO,CAAgC;IAG/C,OAAO,CAAC,UAAU,CAAe;gBAG/B,aAAa,GAAE,MAAM,EAAO,EAC5B,OAAO,GAAE,oBAAyB;IAkBpC;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,GAAE,MAAe,GAAG,OAAO;IAwDvC;;;;;OAKG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI;IA6CpC;;OAEG;IACH,gBAAgB,IAAI,MAAM,EAAE;IAI5B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAI/B;;;;;OAKG;IACH,eAAe,IAAI,OAAO;IAI1B;;;;;OAKG;IACH,IAAI,IAAI,IAAI;IAOZ;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI;IAUpC;;OAEG;IACH,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,IAAI;IAI9D;;;;;;OAMG;IACH,sBAAsB,IAAI,IAAI;IAI9B;;;;;OAKG;IACH,OAAO,IAAI,IAAI;IAIf,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,OAAO,CASd;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,gBAAgB,CAC9B,aAAa,GAAE,MAAM,EAAO,EAC5B,OAAO,GAAE,oBAAyB,GACjC,CAAC,iBAAiB,CAAC,CAqBrB"}