physics-animator 0.10.0 → 0.12.0

package/dist/cjs/Animator.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Animator = void 0;
+exports.StepResult = exports.Animator = void 0;
 const event_signal_1 = require("@haxiomic/event-signal");
-const IFieldAnimator_js_1 = require("./IFieldAnimator.js");
 const SpringAnimator_js_1 = require("./animators/SpringAnimator.js");
 const TweenAnimator_js_1 = require("./animators/TweenAnimator.js");
 /**
@@ -155,7 +154,7 @@ class Animator {
                 this.dispatchChangeFieldEvent(object, field);
                 // handle animation completion
                 switch (result) {
-                    case IFieldAnimator_js_1.StepResult.Complete:
+                    case StepResult.Complete:
                         {
                             objectAnims.delete(field);
                             this.events.completeField.dispatch({ object, field });
@@ -374,6 +373,11 @@ class Animator {
     }
 }
 exports.Animator = Animator;
+var StepResult;
+(function (StepResult) {
+    StepResult[StepResult["Continue"] = 0] = "Continue";
+    StepResult[StepResult["Complete"] = 1] = "Complete";
+})(StepResult || (exports.StepResult = StepResult = {}));
 function forObjectFieldsRecursive(sourceObj, targetObj, callback) {
     for (let field in targetObj) {
         if (Object.prototype.hasOwnProperty.call(targetObj, field)) {

package/dist/cjs/animators/IFieldAnimator.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/animators/SpringAnimator.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Spring = exports.SpringAnimator = void 0;
-const IFieldAnimator_js_1 = require("../IFieldAnimator.js");
+const Animator_js_1 = require("../Animator.js");
 const defaultSpringParameters = {
     duration_s: 0.5,
 };
@@ -35,27 +35,27 @@ exports.SpringAnimator = {
         // complete the animation if it's close enough to the target and velocity is close to 0
         if (Math.abs(state.x - state.targetX) < 0.0001 && Math.abs(state.v) < 0.0001) {
             object[field] = state.targetX;
-            return IFieldAnimator_js_1.StepResult.Complete;
+            return Animator_js_1.StepResult.Complete;
         }
         else {
-            return IFieldAnimator_js_1.StepResult.Continue;
+            return Animator_js_1.StepResult.Continue;
         }
     }
 };
 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/cjs/animators/TweenAnimator.js

@@ -5,7 +5,7 @@ exports.linearStep = linearStep;
 exports.easeInOutStep = easeInOutStep;
 exports.easeInStep = easeInStep;
 exports.easeOutStep = easeOutStep;
-const IFieldAnimator_js_1 = require("../IFieldAnimator.js");
+const Animator_js_1 = require("../Animator.js");
 const defaultParams = {
     duration_s: 0.5, // default duration of the tween in seconds
     easingFn: linearStep, // default easing function is linear
@@ -37,10 +37,10 @@ exports.TweenAnimator = {
         let deltaTime_s = (performance.now() - state.t0_ms) / 1000;
         if (deltaTime_s >= state.duration_s) {
             object[field] = state.target;
-            return IFieldAnimator_js_1.StepResult.Complete;
+            return Animator_js_1.StepResult.Complete;
         }
         else {
-            return IFieldAnimator_js_1.StepResult.Continue;
+            return Animator_js_1.StepResult.Continue;
         }
     }
 };

package/dist/cjs/animators/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./SpringAnimator.js"), exports);
 __exportStar(require("./TweenAnimator.js"), exports);
+__exportStar(require("./IFieldAnimator.js"), exports);

package/dist/cjs/index.js

@@ -14,8 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./AnimationSequencer.js"), exports);
 __exportStar(require("./Animator.js"), exports);
-__exportStar(require("./IFieldAnimator.js"), exports);
-__exportStar(require("./animators/index.js"), exports);
-__exportStar(require("./react/index.js"), exports);

package/dist/cjs/utils/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AnimationSequencer.js"), exports);

package/dist/esm/Animator.js

@@ -1,5 +1,4 @@
 import { EventSignal } from "@haxiomic/event-signal";
-import { StepResult } from "./IFieldAnimator.js";
 import { SpringAnimator } from "./animators/SpringAnimator.js";
 import { easeInOutStep, easeInStep, easeOutStep, linearStep, TweenAnimator } from "./animators/TweenAnimator.js";
 /**
@@ -370,6 +369,11 @@ export class Animator {
         return animation;
     }
 }
+export var StepResult;
+(function (StepResult) {
+    StepResult[StepResult["Continue"] = 0] = "Continue";
+    StepResult[StepResult["Complete"] = 1] = "Complete";
+})(StepResult || (StepResult = {}));
 function forObjectFieldsRecursive(sourceObj, targetObj, callback) {
     for (let field in targetObj) {
         if (Object.prototype.hasOwnProperty.call(targetObj, field)) {

package/dist/esm/animators/IFieldAnimator.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/animators/SpringAnimator.js

@@ -1,4 +1,4 @@
-import { StepResult } from "../IFieldAnimator.js";
+import { StepResult } from "../Animator.js";
 const defaultSpringParameters = {
     duration_s: 0.5,
 };
@@ -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/esm/animators/TweenAnimator.js

@@ -1,4 +1,4 @@
-import { StepResult } from "../IFieldAnimator.js";
+import { StepResult } from "../Animator.js";
 const defaultParams = {
     duration_s: 0.5, // default duration of the tween in seconds
     easingFn: linearStep, // default easing function is linear

package/dist/esm/animators/index.js

@@ -1,2 +1,3 @@
 export * from './SpringAnimator.js';
 export * from './TweenAnimator.js';
+export * from './IFieldAnimator.js';

package/dist/esm/index.js

@@ -1,5 +1 @@
-export * from './AnimationSequencer.js';
 export * from './Animator.js';
-export * from './IFieldAnimator.js';
-export * from './animators/index.js';
-export * from './react/index.js';

package/dist/esm/utils/index.js

@@ -0,0 +1 @@
+export * from './AnimationSequencer.js';

package/dist/types/Animator.d.ts

@@ -1,5 +1,5 @@
 import { EventSignal } from "@haxiomic/event-signal";
-import { IFieldAnimator } from "./IFieldAnimator.js";
+import { IFieldAnimator } from "./animators/IFieldAnimator.js";
 import { SpringParameters } from "./animators/SpringAnimator.js";
 import { EasingStepFn } from "./animators/TweenAnimator.js";
 /**
@@ -141,6 +141,10 @@ export declare class Animator {
      */
     private syncAnimation;
 }
+export declare enum StepResult {
+    Continue = 0,// continue stepping
+    Complete = 1
+}
 type FieldAnimation<Params, State> = {
     animator: IFieldAnimator<Params, State, any>;
     state: State;

package/dist/types/{IFieldAnimator.d.ts → animators/IFieldAnimator.d.ts}

@@ -1,7 +1,4 @@
-export declare enum StepResult {
-    Continue = 0,// continue stepping
-    Complete = 1
-}
+import { StepResult } from "../Animator.js";
 export interface IFieldAnimator<Params, State, FieldType> {
     createState<Name extends keyof Obj, Obj extends Record<Name, FieldType>>(object: Obj, field: Name, target: Obj[Name], params: Params | null): State;
     updateState<Name extends keyof Obj, Obj extends Record<Name, FieldType>>(state: State, object: Obj, field: Name, target: Obj[Name], params: Params | null): void;

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

@@ -1,4 +1,4 @@
-import { IFieldAnimator } from "../IFieldAnimator.js";
+import { IFieldAnimator } from "./IFieldAnimator.js";
 export declare const SpringAnimator: IFieldAnimator<SpringParameters, SpringState, number>;
 /**
  * Spring
@@ -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/dist/types/animators/TweenAnimator.d.ts

@@ -1,4 +1,4 @@
-import { IFieldAnimator } from "../IFieldAnimator.js";
+import { IFieldAnimator } from "./IFieldAnimator.js";
 export type TweenParameters = {
     duration_s: number;
     easingFn: EasingStepFn;

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

@@ -1,2 +1,3 @@
 export * from './SpringAnimator.js';
 export * from './TweenAnimator.js';
+export * from './IFieldAnimator.js';

package/dist/types/index.d.ts

@@ -1,5 +1 @@
-export * from './AnimationSequencer.js';
 export * from './Animator.js';
-export * from './IFieldAnimator.js';
-export * from './animators/index.js';
-export * from './react/index.js';

package/dist/types/react/useSpringState.d.ts

@@ -1,5 +1,5 @@
 import { Animator } from "../Animator.js";
-import { SpringParameters } from "src/animators/SpringAnimator.js";
+import { SpringParameters } from "../animators/SpringAnimator.js";
 /**
  * A value that animates to a target value using a spring animation.
  * This **will** cause a re-render when the value changes.

package/dist/types/react/useSpringValue.d.ts

@@ -1,5 +1,5 @@
 import { Animator } from "../Animator.js";
-import { SpringParameters } from "src/animators/SpringAnimator.js";
+import { SpringParameters } from "../animators/SpringAnimator.js";
 /**
  * A value that animates to a target value using a spring animation.
  * This will **not** cause a re-render when the value changes.

package/dist/types/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './AnimationSequencer.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "physics-animator",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "author": "haxiomic (George Corney)",
   "license": "MIT",
   "description": "A TypeScript animation system grounded in physics with three.js and react support.",
@@ -17,9 +17,7 @@
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
-  "files": [
-    "dist"
-  ],
+  "files": ["dist"],
   "exports": {
     ".": {
       "types": "./dist/types/index.d.ts",
@@ -32,6 +30,15 @@
       "require": "./dist/cjs/*/index.js"
     }
   },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "prepack": "npm run clean && npm run build",
+    "build": "npm run clean && npm run build-esm && npm run build-cjs",
+    "build-esm": "tsc --project tsconfig.json && echo '{\"type\": \"module\"}' > dist/esm/package.json",
+    "build-cjs": "tsc --project tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
+    "clean": "rm -rf dist",
+    "dev": "tsc --watch"
+  },
   "devDependencies": {
     "@types/react": "^19.0.12",
     "typescript": "^5.0.0"
@@ -47,13 +54,5 @@
     "react": {
       "optional": true
     }
-  },
-  "scripts": {
-    "typecheck": "tsc --noEmit",
-    "build": "npm run clean && npm run build-esm && npm run build-cjs",
-    "build-esm": "tsc --project tsconfig.json && echo '{\"type\": \"module\"}' > dist/esm/package.json",
-    "build-cjs": "tsc --project tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
-    "clean": "rm -rf dist",
-    "dev": "tsc --watch"
   }
-}
+}

package/dist/cjs/IFieldAnimator.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StepResult = void 0;
-var StepResult;
-(function (StepResult) {
-    StepResult[StepResult["Continue"] = 0] = "Continue";
-    StepResult[StepResult["Complete"] = 1] = "Complete";
-})(StepResult || (exports.StepResult = StepResult = {}));

package/dist/esm/IFieldAnimator.js

@@ -1,5 +0,0 @@
-export var StepResult;
-(function (StepResult) {
-    StepResult[StepResult["Continue"] = 0] = "Continue";
-    StepResult[StepResult["Complete"] = 1] = "Complete";
-})(StepResult || (StepResult = {}));