physics-animator 0.11.0 → 0.13.0

package/dist/cjs/animators/SpringAnimator.js

@@ -45,17 +45,17 @@ exports.SpringAnimator = {
 var Spring;
 (function (Spring) {
     /**
-     * Starting with 0 velocity, this parameter describes how long it would take to reach half-way to the target
+     * Exponential decay without any bounce
      *
-     * `damping = 3.356694 / approxHalfLife_s`
-     *
-     * `strength = damping * damping / 4`
+     * Control with either duration_s or halfLife_s
      */
     function Exponential(options) {
         // found numerically
         const halfLifeConstant = 3.356694; // from solve (1+u)*exp(-u)=0.5 for u, and constant = 2u
         const pointOnePercentConstant = 18.46682; // from solve (1+u)*exp(-u)=0.001 for u, and constant = 2u
-        const damping = pointOnePercentConstant / options.duration_s;
+        const damping = ('halfLife_s' in options)
+            ? halfLifeConstant / options.halfLife_s
+            : pointOnePercentConstant / options.duration_s;
         let strength = damping * damping / 4;
         return { damping, strength };
     }

package/dist/esm/animators/SpringAnimator.js

@@ -42,17 +42,17 @@ export const SpringAnimator = {
 export var Spring;
 (function (Spring) {
     /**
-     * Starting with 0 velocity, this parameter describes how long it would take to reach half-way to the target
+     * Exponential decay without any bounce
      *
-     * `damping = 3.356694 / approxHalfLife_s`
-     *
-     * `strength = damping * damping / 4`
+     * Control with either duration_s or halfLife_s
      */
     function Exponential(options) {
         // found numerically
         const halfLifeConstant = 3.356694; // from solve (1+u)*exp(-u)=0.5 for u, and constant = 2u
         const pointOnePercentConstant = 18.46682; // from solve (1+u)*exp(-u)=0.001 for u, and constant = 2u
-        const damping = pointOnePercentConstant / options.duration_s;
+        const damping = ('halfLife_s' in options)
+            ? halfLifeConstant / options.halfLife_s
+            : pointOnePercentConstant / options.duration_s;
         let strength = damping * damping / 4;
         return { damping, strength };
     }

package/dist/types/Animator.d.ts

@@ -44,14 +44,14 @@ export declare class Animator {
     protected beforeChange: EventSignal<void, void>;
     protected afterChange: EventSignal<void, void>;
     constructor(onBeforeStep?: (dt_s: number) => void, onAfterStep?: (dt_s: number) => void);
-    setTo<Obj>(object: Obj, target: Partial<Obj>): void;
-    animateTo<Obj, Parameters, State, FieldType>(object: Obj, target: Partial<Obj>, animator?: IFieldAnimator<Parameters, State, FieldType>, params?: Parameters | null): void;
-    springTo<Obj>(object: Obj, target: Partial<Obj>, params: SpringParameters | null): void;
-    customTweenTo<Obj>(object: Obj, target: Partial<Obj>, duration_s: number, easingFn: EasingStepFn): void;
-    linearTo<Obj>(object: Obj, target: Partial<Obj>, duration_s: number): void;
-    easeInOutTo<Obj>(object: Obj, target: Partial<Obj>, duration_s: number): void;
-    easeInTo<Obj>(object: Obj, target: Partial<Obj>, duration_s: number): void;
-    easeOutTo<Obj>(object: Obj, target: Partial<Obj>, duration_s: number): void;
+    setTo<Obj extends Record<string, any>>(object: Obj, target: Partial<Obj>): void;
+    animateTo<Obj extends Record<string, any>, Parameters, State, FieldType>(object: Obj, target: Partial<Obj>, animator?: IFieldAnimator<Parameters, State, FieldType>, params?: Parameters | null): void;
+    springTo<Obj extends Record<string, any>>(object: Obj, target: Partial<Obj>, params: SpringParameters | null): void;
+    customTweenTo<Obj extends Record<string, any>>(object: Obj, target: Partial<Obj>, duration_s: number, easingFn: EasingStepFn): void;
+    linearTo<Obj extends Record<string, any>>(object: Obj, target: Partial<Obj>, duration_s: number): void;
+    easeInOutTo<Obj extends Record<string, any>>(object: Obj, target: Partial<Obj>, duration_s: number): void;
+    easeInTo<Obj extends Record<string, any>>(object: Obj, target: Partial<Obj>, duration_s: number): void;
+    easeOutTo<Obj extends Record<string, any>>(object: Obj, target: Partial<Obj>, duration_s: number): void;
     onCompleteField<Obj, Name extends keyof Obj>(object: Obj, field: Name, callback: (object: Obj, field: Name) => void, once?: 'once'): {
         priority: number;
         listener: (event: {

package/dist/types/animators/SpringAnimator.d.ts

@@ -8,6 +8,8 @@ export declare const SpringAnimator: IFieldAnimator<SpringParameters, SpringStat
 type ExponentialParameters = {
     /** Defined as the point in time we'll reach within 0.01% of target from 0 velocity start */
     duration_s: number;
+} | {
+    halfLife_s: number;
 };
 type UnderdampedParameters = {
     /** Defined as the point in time we'll reach within 0.01% of target from 0 velocity start */
@@ -31,11 +33,9 @@ export declare namespace Spring {
         damping: number;
     };
     /**
-     * Starting with 0 velocity, this parameter describes how long it would take to reach half-way to the target
+     * Exponential decay without any bounce
      *
-     * `damping = 3.356694 / approxHalfLife_s`
-     *
-     * `strength = damping * damping / 4`
+     * Control with either duration_s or halfLife_s
      */
     function Exponential(options: ExponentialParameters): PhysicsParameters;
     function Underdamped(options: UnderdampedParameters): PhysicsParameters;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "physics-animator",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "author": "haxiomic (George Corney)",
   "license": "MIT",
   "description": "A TypeScript animation system grounded in physics with three.js and react support.",