@zephyr3d/scene 0.9.0 → 0.9.2

package/dist/animation/skeleton_modifier.js

@@ -15,9 +15,7 @@
    */ get weight() {
         return this._getWeight();
     }
-    /**
-   * Set the blend weight [0-1]
-   */ set weight(value) {
+    set weight(value) {
         this._setWeight(value);
     }
     /**
@@ -25,9 +23,7 @@
    */ get enabled() {
         return this._enabled;
     }
-    /**
-   * Set whether this processor is enabled
-   */ set enabled(value) {
+    set enabled(value) {
         this._enabled = value;
     }
 }

package/dist/animation/skeleton_modifier.js.map

@@ -1 +1 @@
-{"version":3,"file":"skeleton_modifier.js","sources":["../../src/animation/skeleton_modifier.ts"],"sourcesContent":["import type { Skeleton } from './skeleton';\r\n\r\n/**\r\n * Abstract base class for skeleton post-processors.\r\n *\r\n * Post-processors are applied after the base animation/bind pose layer,\r\n * allowing procedural modifications like IK, spring physics, or manual overrides.\r\n *\r\n * @public\r\n */\r\nexport abstract class SkeletonModifier {\r\n  /** Whether this processor is enabled */\r\n  protected _enabled: boolean;\r\n\r\n  constructor() {\r\n    this._enabled = true;\r\n  }\r\n\r\n  /**\r\n   * Get the blend weight [0-1]\r\n   */\r\n  get weight(): number {\r\n    return this._getWeight();\r\n  }\r\n\r\n  /**\r\n   * Set the blend weight [0-1]\r\n   */\r\n  set weight(value: number) {\r\n    this._setWeight(value);\r\n  }\r\n\r\n  /**\r\n   * Get whether this processor is enabled\r\n   */\r\n  get enabled(): boolean {\r\n    return this._enabled;\r\n  }\r\n\r\n  /**\r\n   * Set whether this processor is enabled\r\n   */\r\n  set enabled(value: boolean) {\r\n    this._enabled = value;\r\n  }\r\n\r\n  /**\r\n   * Apply post-processing to skeleton joints.\r\n   *\r\n   * This method is called after the base animation/bind pose has been applied.\r\n   * Implementations should modify joint transforms and blend with the current state\r\n   * using the processor's weight.\r\n   *\r\n   * @param skeleton - The skeleton to process\r\n   * @param deltaTime - Time elapsed since last frame (in seconds)\r\n   */\r\n  abstract apply(skeleton: Skeleton, deltaTime: number): void;\r\n\r\n  /**\r\n   * Reset the processor to its initial state.\r\n   *\r\n   * Called when the skeleton or animation state changes significantly.\r\n   */\r\n  abstract reset(): void;\r\n\r\n  /**\r\n   * Get the blend weight for this processor.\r\n   */\r\n  protected abstract _getWeight(): number;\r\n\r\n  /**\r\n   * Set the blend weight for this processor.\r\n   * @param _value - New blend weight (0-1)\r\n   */\r\n  protected abstract _setWeight(_value: number): void;\r\n}\r\n"],"names":["SkeletonModifier","_enabled","weight","_getWeight","value","_setWeight","enabled"],"mappings":"AAEA;;;;;;;AAOC,IACM,MAAeA,gBAAAA,CAAAA;6CAEpB,QAA4B;IAE5B,WAAc,EAAA;QACZ,IAAI,CAACC,QAAQ,GAAG,IAAA;AAClB;AAEA;;AAEC,MACD,IAAIC,MAAiB,GAAA;QACnB,OAAO,IAAI,CAACC,UAAU,EAAA;AACxB;AAEA;;MAGA,IAAID,MAAOE,CAAAA,KAAa,EAAE;QACxB,IAAI,CAACC,UAAU,CAACD,KAAAA,CAAAA;AAClB;AAEA;;AAEC,MACD,IAAIE,OAAmB,GAAA;QACrB,OAAO,IAAI,CAACL,QAAQ;AACtB;AAEA;;MAGA,IAAIK,OAAQF,CAAAA,KAAc,EAAE;QAC1B,IAAI,CAACH,QAAQ,GAAGG,KAAAA;AAClB;AA+BF;;;;"}
+{"version":3,"file":"skeleton_modifier.js","sources":["../../src/animation/skeleton_modifier.ts"],"sourcesContent":["import type { Skeleton } from './skeleton';\r\n\r\n/**\r\n * Abstract base class for skeleton post-processors.\r\n *\r\n * Post-processors are applied after the base animation/bind pose layer,\r\n * allowing procedural modifications like IK, spring physics, or manual overrides.\r\n *\r\n * @public\r\n */\r\nexport abstract class SkeletonModifier {\r\n  /** Whether this processor is enabled */\r\n  protected _enabled: boolean;\r\n\r\n  constructor() {\r\n    this._enabled = true;\r\n  }\r\n\r\n  /**\r\n   * Get the blend weight [0-1]\r\n   */\r\n  get weight(): number {\r\n    return this._getWeight();\r\n  }\r\n\r\n  set weight(value: number) {\r\n    this._setWeight(value);\r\n  }\r\n\r\n  /**\r\n   * Get whether this processor is enabled\r\n   */\r\n  get enabled(): boolean {\r\n    return this._enabled;\r\n  }\r\n\r\n  set enabled(value: boolean) {\r\n    this._enabled = value;\r\n  }\r\n\r\n  /**\r\n   * Apply post-processing to skeleton joints.\r\n   *\r\n   * This method is called after the base animation/bind pose has been applied.\r\n   * Implementations should modify joint transforms and blend with the current state\r\n   * using the processor's weight.\r\n   *\r\n   * @param skeleton - The skeleton to process\r\n   * @param deltaTime - Time elapsed since last frame (in seconds)\r\n   */\r\n  abstract apply(skeleton: Skeleton, deltaTime: number): void;\r\n\r\n  /**\r\n   * Reset the processor to its initial state.\r\n   *\r\n   * Called when the skeleton or animation state changes significantly.\r\n   */\r\n  abstract reset(): void;\r\n\r\n  /**\r\n   * Get the blend weight for this processor.\r\n   */\r\n  protected abstract _getWeight(): number;\r\n\r\n  /**\r\n   * Set the blend weight for this processor.\r\n   * @param _value - New blend weight (0-1)\r\n   */\r\n  protected abstract _setWeight(_value: number): void;\r\n}\r\n"],"names":["SkeletonModifier","_enabled","weight","_getWeight","value","_setWeight","enabled"],"mappings":"AAEA;;;;;;;AAOC,IACM,MAAeA,gBAAAA,CAAAA;6CAEpB,QAA4B;IAE5B,WAAc,EAAA;QACZ,IAAI,CAACC,QAAQ,GAAG,IAAA;AAClB;AAEA;;AAEC,MACD,IAAIC,MAAiB,GAAA;QACnB,OAAO,IAAI,CAACC,UAAU,EAAA;AACxB;IAEA,IAAID,MAAAA,CAAOE,KAAa,EAAE;QACxB,IAAI,CAACC,UAAU,CAACD,KAAAA,CAAAA;AAClB;AAEA;;AAEC,MACD,IAAIE,OAAmB,GAAA;QACrB,OAAO,IAAI,CAACL,QAAQ;AACtB;IAEA,IAAIK,OAAAA,CAAQF,KAAc,EAAE;QAC1B,IAAI,CAACH,QAAQ,GAAGG,KAAAA;AAClB;AA+BF;;;;"}

package/dist/animation/spring/spring_system.js

@@ -7,11 +7,11 @@ const MAX_ACCUMULATED_SIMULATION_TIME = 1 / 20;
 const MAX_SIMULATION_STEPS_PER_UPDATE = Math.max(1, Math.ceil(MAX_ACCUMULATED_SIMULATION_TIME / FIXED_SIMULATION_TIME_STEP));
 const DEFAULT_PARTICLE_TARGET_SMOOTHING_TIME = 1 / 30;
 const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
-/**
- * Physics engine for spring-based particle simulation
- * Uses Verlet integration and iterative constraint solving
- *
- * @public
+/**
+ * Physics engine for spring-based particle simulation
+ * Uses Verlet integration and iterative constraint solving
+ *
+ * @public
  */ class SpringSystem {
     _chain;
     _iterations;
@@ -57,9 +57,9 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
         this._smoothedCapsuleEndpoints = new WeakMap();
         this._smoothedPlaneData = new WeakMap();
     }
-    /**
-   * Updates the physics simulation
-   * @param deltaTime - Time step in seconds
+    /**
+   * Updates the physics simulation
+   * @param deltaTime - Time step in seconds
    */ update(deltaTime) {
         const frameDt = Math.min(Math.max(Number(deltaTime) || 0, 0), MAX_ACCUMULATED_SIMULATION_TIME);
         if (frameDt <= 0) {
@@ -136,8 +136,8 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
             this.solveCollisions(inputDeltaTime);
         }
     }
-    /**
-   * Updates fixed particles to match their scene node positions
+    /**
+   * Updates fixed particles to match their scene node positions
    */ updateFixedParticles(deltaTime) {
         const blend = this.getTemporalBlendFactor(deltaTime, DEFAULT_PARTICLE_TARGET_SMOOTHING_TIME);
         for (const particle of this._chain.particles){
@@ -165,9 +165,9 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
             }
         }
     }
-    /**
-   * Solves pose preservation (long-range attachment to animated pose).
-   * This keeps strands close to authored shape while preserving dynamic movement.
+    /**
+   * Solves pose preservation (long-range attachment to animated pose).
+   * This keeps strands close to authored shape while preserving dynamic movement.
    */ solvePosePreservation(totalIterations) {
         if (this._poseFollowRoot <= 0 && this._poseFollowTip <= 0) {
             return;
@@ -200,9 +200,9 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
     lerp(a, b, t) {
         return a + (b - a) * t;
     }
-    /**
-   * Calculates global rotation parameters from fixed particle movements
-   * Uses position history to estimate rotation center
+    /**
+   * Calculates global rotation parameters from fixed particle movements
+   * Uses position history to estimate rotation center
    */ calculateGlobalRotation(dt) {
         // Collect fixed particles with movement
         const fixedParticles = [];
@@ -260,9 +260,9 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
             omega: sumOmega
         };
     }
-    /**
-   * Estimates rotation center from a single particle's position history
-   * Uses circular motion fitting
+    /**
+   * Estimates rotation center from a single particle's position history
+   * Uses circular motion fitting
    */ estimateRotationCenterFromHistory(particle, currentVelocity) {
         const history = particle.positionHistory;
         if (!history || history.length < 3) {
@@ -298,9 +298,9 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
         const center = this.calculateCircleCenter(p1, p2, p3);
         return center;
     }
-    /**
-   * Calculates the center of a circle passing through 3 points
-   * Uses perpendicular bisector method
+    /**
+   * Calculates the center of a circle passing through 3 points
+   * Uses perpendicular bisector method
    */ calculateCircleCenter(p1, p2, p3) {
         // Midpoints
         const mid12 = Vector3.scale(Vector3.add(p1, p2, new Vector3()), 0.5, new Vector3());
@@ -337,8 +337,8 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
         // Fallback: use centroid
         return Vector3.scale(Vector3.add(Vector3.add(p1, p2, new Vector3()), p3, new Vector3()), 1.0 / 3.0, new Vector3());
     }
-    /**
-   * Calculates inertial acceleration for a particle in a rotating reference frame
+    /**
+   * Calculates inertial acceleration for a particle in a rotating reference frame
    */ calculateInertialAcceleration(particle, rotationCenter, angularVelocity, particleVelocity, centrifugalScale, coriolisScale) {
         // Vector from rotation center to particle
         const r = Vector3.sub(particle.position, rotationCenter, new Vector3());
@@ -355,18 +355,10 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
         const totalAccel = Vector3.add(centrifugalAccel, coriolisAccel, new Vector3());
         return totalAccel;
     }
-    /**
-   * Solves a single spring constraint using XPBD (Extended Position-Based Dynamics).
-   *
-   * Reference: Müller et al., "Detailed Rigid Body Simulation with Extended Position Based Dynamics", 2020.
-   *
-   * The XPBD correction for a distance constraint C(x) = |x_b - x_a| - L is:
-   *   α̃ = compliance / dt²          (scaled compliance)
-   *   Δλ = (-C - α̃·λ) / (w_a + w_b + α̃)
-   *   λ  += Δλ
-   *   Δx_a = -w_a · Δλ · n̂
-   *   Δx_b = +w_b · Δλ · n̂
-   * where w = 1/mass (0 for fixed particles), n̂ = unit vector from a to b.
+    /**
+   * Solves a single spring constraint using XPBD (Extended Position-Based Dynamics).
+   *
+   * Reference: Müller et al., "Detailed Rigid Body Simulation with Extended Position Based Dynamics", 2020.
    */ solveConstraintXPBD(constraint, dt) {
         const pA = this._chain.particles[constraint.particleA];
         const pB = this._chain.particles[constraint.particleB];
@@ -383,7 +375,7 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
         }
         // Constraint value C = currentLength - restLength
         const C = currentLength - constraint.restLength;
-        // Scaled compliance: α̃ = compliance / dt²
+        // Scaled compliance: alphaTilde = compliance / dt^2
         const alphaTilde = constraint.compliance / (dt * dt);
         // XPBD Lagrange multiplier update
         const deltaLambda = (-C - alphaTilde * constraint.lambda) / (wSum + alphaTilde);
@@ -391,16 +383,16 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
         // Correction direction (unit vector from A to B)
         const n = Vector3.scale(delta, 1.0 / currentLength, new Vector3());
         if (!pA.fixed) {
-            // Δx_a = -w_a · Δλ · n̂
+            // deltaX_a = -w_a * deltaLambda * n
             Vector3.add(pA.position, Vector3.scale(n, -wA * deltaLambda, new Vector3()), pA.position);
         }
         if (!pB.fixed) {
-            // Δx_b = +w_b · Δλ · n̂
+            // deltaX_b = +w_b * deltaLambda * n
             Vector3.add(pB.position, Vector3.scale(n, wB * deltaLambda, new Vector3()), pB.position);
         }
     }
-    /**
-   * Solves a single spring constraint (Verlet / PBD)
+    /**
+   * Solves a single spring constraint (Verlet / PBD)
    */ solveConstraint(constraint) {
         const pA = this._chain.particles[constraint.particleA];
         const pB = this._chain.particles[constraint.particleB];
@@ -421,8 +413,8 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
             Vector3.sub(pB.position, correction, pB.position);
         }
     }
-    /**
-   * Solves collisions for all particles
+    /**
+   * Solves collisions for all particles
    */ solveCollisions(deltaTime) {
         // Update dynamic colliders from their nodes
         const blend = this.getTemporalBlendFactor(deltaTime, DEFAULT_COLLIDER_SMOOTHING_TIME);
@@ -495,9 +487,9 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
             }
         }
     }
-    /**
-   * Applies simulation results to scene nodes
-   * @param weight - Blend weight [0-1] (default: 1.0)
+    /**
+   * Applies simulation results to scene nodes
+   * @param weight - Blend weight [0-1] (default: 1.0)
    */ applyToNodes(weight = 1.0) {
         for(let i = 0; i < this._chain.particles.length - 1; i++){
             const particle = this._chain.particles[i];
@@ -545,8 +537,8 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
             }
         }
     }
-    /**
-   * Resets the simulation to initial state
+    /**
+   * Resets the simulation to initial state
    */ reset() {
         this._chain.reset();
         for (const particle of this._chain.particles){
@@ -562,70 +554,65 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
         this._smoothedCapsuleEndpoints = new WeakMap();
         this._smoothedPlaneData = new WeakMap();
     }
-    /**
-   * Gets the spring chain
+    /**
+   * Gets the spring chain
    */ get chain() {
         return this._chain;
     }
-    /**
-   * Gets the current gravity
+    /**
+   * Gets the current gravity
    */ get gravity() {
         return this._gravity;
     }
     set gravity(gravity) {
         this._gravity.set(gravity);
     }
-    /**
-   * Gets the current wind
+    /**
+   * Gets the current wind
    */ get wind() {
         return this._wind;
     }
     set wind(wind) {
         this._wind.set(wind);
     }
-    /**
-   * Gets the number of iterations
+    /**
+   * Gets the number of iterations
    */ get iterations() {
         return this._iterations;
     }
     set iterations(count) {
         this._iterations = Math.max(1, count);
     }
-    /**
-   * Gets whether inertial forces are enabled
+    /**
+   * Gets whether inertial forces are enabled
    */ get enableInertialForces() {
         return this._enableInertialForces;
     }
     set enableInertialForces(enabled) {
         this._enableInertialForces = enabled;
     }
-    /**
-   * Gets the centrifugal force scale
+    /**
+   * Gets the centrifugal force scale
    */ get centrifugalScale() {
         return this._centrifugalScale;
     }
     set centrifugalScale(scale) {
         this._centrifugalScale = Math.max(0, scale);
     }
-    /**
-   * Gets the Coriolis force scale
+    /**
+   * Gets the Coriolis force scale
    */ get coriolisScale() {
         return this._coriolisScale;
     }
-    /**
-   * Sets the Coriolis force scale
-   */ set coriolisScale(scale) {
+    set coriolisScale(scale) {
         this._coriolisScale = Math.max(0, scale);
     }
-    /**
-   * Gets the constraint solver type
+    /**
+   * Gets the constraint solver type
    */ get solver() {
         return this._solver;
     }
-    /**
-   * Sets the constraint solver type.
-   * Switching to 'xpbd' resets all Lagrange multipliers.
-   */ set solver(type) {
+    set solver(type) {
         if (this._solver !== type) {
             this._solver = type;
             if (type === 'xpbd') {
@@ -635,92 +622,78 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
             }
         }
     }
-    /**
-   * Gets pose preservation strength [0-1]
+    /**
+   * Gets pose preservation strength [0-1]
    */ get poseFollow() {
         return this._poseFollow;
     }
-    /**
-   * Sets pose preservation strength [0-1]
-   */ set poseFollow(value) {
+    set poseFollow(value) {
         const v = Math.max(0, Math.min(1, value));
         this._poseFollow = v;
         this._poseFollowRoot = v;
         this._poseFollowTip = v;
     }
-    /**
-   * Gets max allowed deviation from animated pose
+    /**
+   * Gets max allowed deviation from animated pose
    */ get maxPoseOffset() {
         return this._maxPoseOffset;
     }
-    /**
-   * Sets max allowed deviation from animated pose. 0 disables clamping.
-   */ set maxPoseOffset(value) {
+    set maxPoseOffset(value) {
         const v = Math.max(0, value);
         this._maxPoseOffset = v;
         this._maxPoseOffsetRoot = v;
         this._maxPoseOffsetTip = v;
     }
-    /**
-   * Gets root pose follow strength [0-1]
+    /**
+   * Gets root pose follow strength [0-1]
    */ get poseFollowRoot() {
         return this._poseFollowRoot;
     }
-    /**
-   * Sets root pose follow strength [0-1]
-   */ set poseFollowRoot(value) {
+    set poseFollowRoot(value) {
         this._poseFollowRoot = Math.max(0, Math.min(1, value));
     }
-    /**
-   * Gets tip pose follow strength [0-1]
+    /**
+   * Gets tip pose follow strength [0-1]
    */ get poseFollowTip() {
         return this._poseFollowTip;
     }
-    /**
-   * Sets tip pose follow strength [0-1]
-   */ set poseFollowTip(value) {
+    set poseFollowTip(value) {
         this._poseFollowTip = Math.max(0, Math.min(1, value));
     }
-    /**
-   * Gets exponent for root->tip interpolation
+    /**
+   * Gets exponent for root-to-tip interpolation
    */ get poseFollowExponent() {
         return this._poseFollowExponent;
     }
-    /**
-   * Sets exponent for root->tip interpolation
-   */ set poseFollowExponent(value) {
+    set poseFollowExponent(value) {
         this._poseFollowExponent = Math.max(0.1, value);
     }
-    /**
-   * Gets root max allowed deviation from animated pose
+    /**
+   * Gets root max allowed deviation from animated pose
    */ get maxPoseOffsetRoot() {
         return this._maxPoseOffsetRoot;
     }
-    /**
-   * Sets root max allowed deviation from animated pose
-   */ set maxPoseOffsetRoot(value) {
+    set maxPoseOffsetRoot(value) {
         this._maxPoseOffsetRoot = Math.max(0, value);
     }
-    /**
-   * Gets tip max allowed deviation from animated pose
+    /**
+   * Gets tip max allowed deviation from animated pose
    */ get maxPoseOffsetTip() {
         return this._maxPoseOffsetTip;
     }
-    /**
-   * Sets tip max allowed deviation from animated pose
-   */ set maxPoseOffsetTip(value) {
+    set maxPoseOffsetTip(value) {
         this._maxPoseOffsetTip = Math.max(0, value);
     }
-    /**
-   * Adds a collider to the system
+    /**
+   * Adds a collider to the system
    */ addCollider(collider) {
         this._colliders.push(collider);
         this._smoothedSphereCenters = new WeakMap();
         this._smoothedCapsuleEndpoints = new WeakMap();
         this._smoothedPlaneData = new WeakMap();
     }
-    /**
-   * Removes a collider from the system
+    /**
+   * Removes a collider from the system
    */ removeCollider(collider) {
         const index = this._colliders.indexOf(collider);
         if (index >= 0) {
@@ -732,16 +705,16 @@ const DEFAULT_COLLIDER_SMOOTHING_TIME = 1 / 30;
         }
         return false;
     }
-    /**
-   * Clears all colliders
+    /**
+   * Clears all colliders
    */ clearColliders() {
         this._colliders = [];
         this._smoothedSphereCenters = new WeakMap();
         this._smoothedCapsuleEndpoints = new WeakMap();
         this._smoothedPlaneData = new WeakMap();
     }
-    /**
-   * Gets all colliders
+    /**
+   * Gets all colliders
    */ get colliders() {
         return this._colliders;
     }