@newkrok/nape-js 3.23.0 → 3.24.1

package/dist/index.d.cts

@@ -1169,6 +1169,70 @@ declare class PulleyJoint extends Constraint {
     visitBodies(lambda: (body: Body) => void): void;
 }
 
+/**
+ * A spring/damper constraint between two anchor points on two bodies.
+ *
+ * Applies a spring force that pulls or pushes the anchors toward a target
+ * `restLength`. The spring behavior is controlled by `frequency` (Hz) and
+ * `damping` (ratio), inherited from {@link Constraint}.
+ *
+ * Unlike {@link DistanceJoint}, a SpringJoint:
+ * - Is **always soft** — there is no rigid/stiff mode.
+ * - Has a single `restLength` instead of a `[jointMin, jointMax]` range.
+ * - Applies force in **both directions** (compression and extension).
+ * - Never goes slack — the spring always exerts a restorative force.
+ *
+ * Ideal for: vehicle suspension, soft-body connections, ragdoll hair/cloth,
+ * bouncy UI animations, bridge/rope segments, trampolines.
+ *
+ * @example
+ * ```ts
+ * const spring = new SpringJoint(
+ *   body1, body2,
+ *   Vec2.weak(0, 0),   // anchor on body1 (local)
+ *   Vec2.weak(0, 0),   // anchor on body2 (local)
+ *   100,               // rest length (pixels)
+ * );
+ * spring.frequency = 5;  // 5 Hz oscillation
+ * spring.damping = 0.5;  // underdamped (bouncy)
+ * spring.space = space;
+ * ```
+ */
+declare class SpringJoint extends Constraint {
+    /**
+     * @param body1 - First body, or `null` for a static world anchor.
+     * @param body2 - Second body, or `null` for a static world anchor.
+     * @param anchor1 - Anchor point in `body1`'s local space (disposed if weak).
+     * @param anchor2 - Anchor point in `body2`'s local space (disposed if weak).
+     * @param restLength - Equilibrium distance between anchors (must be `>= 0`).
+     */
+    constructor(body1: Body | null, body2: Body | null, anchor1: Vec2, anchor2: Vec2, restLength: number);
+    /** First body. `null` treats the anchor as a static world point. */
+    get body1(): Body;
+    set body1(value: Body | null);
+    /** Second body. `null` treats the anchor as a static world point. */
+    get body2(): Body;
+    set body2(value: Body | null);
+    /** Anchor point on `body1` in local coordinates. */
+    get anchor1(): Vec2;
+    set anchor1(value: Vec2);
+    /** Anchor point on `body2` in local coordinates. */
+    get anchor2(): Vec2;
+    set anchor2(value: Vec2);
+    /** Equilibrium distance between anchors (pixels, must be `>= 0`). */
+    get restLength(): number;
+    set restLength(value: number);
+    /**
+     * SpringJoint is always soft — setting `stiff` to `true` is not allowed.
+     * Use {@link DistanceJoint} if you need a rigid distance constraint.
+     */
+    get stiff(): boolean;
+    set stiff(_value: boolean);
+    impulse(): MatMN;
+    bodyImpulse(body: Body): Vec3;
+    visitBodies(lambda: (body: Body) => void): void;
+}
+
 /**
  * ZPP_Constraint — Internal base class for all constraints / joints.
  *
@@ -1798,4 +1862,4 @@ declare function fractureBody(body: Body, impactPoint: Vec2, options?: FractureO
 
 declare const VERSION: string;
 
-export { AABB, AngleJoint, Arbiter, Body, BodyCallback, BodyListener, BodyType, Callback, Capsule, CbEvent, CbType, CharacterController, type CharacterControllerOptions, Circle, CollisionArbiter, type ConcaveBodyOptions, Constraint, ConstraintCallback, ConstraintListener, Contact, DebugDrawFlags, DistanceJoint, type FractureOptions, type FractureResult, Geom, GeomPoly, InteractionCallback, InteractionFilter, InteractionListener, InteractionType, Interactor, LineJoint, Listener, MarchingSquares, MatMN, Material, MotorJoint, type MoveResult, OptionType, PivotJoint, PreCallback, PreFlag, PreListener, PulleyJoint, Shape, ShapeType, Space, type TriggerHandler, TriggerZone, type TriggerZoneOptions, UserConstraint, VERSION, ValidationResult, Vec2, Vec3, type VoronoiCell, type VoronoiPoint, type VoronoiResult, WeldJoint, Winding, computeVoronoi, createConcaveBody, fractureBody, generateFractureSites };
+export { AABB, AngleJoint, Arbiter, Body, BodyCallback, BodyListener, BodyType, Callback, Capsule, CbEvent, CbType, CharacterController, type CharacterControllerOptions, Circle, CollisionArbiter, type ConcaveBodyOptions, Constraint, ConstraintCallback, ConstraintListener, Contact, DebugDrawFlags, DistanceJoint, type FractureOptions, type FractureResult, Geom, GeomPoly, InteractionCallback, InteractionFilter, InteractionListener, InteractionType, Interactor, LineJoint, Listener, MarchingSquares, MatMN, Material, MotorJoint, type MoveResult, OptionType, PivotJoint, PreCallback, PreFlag, PreListener, PulleyJoint, Shape, ShapeType, Space, SpringJoint, type TriggerHandler, TriggerZone, type TriggerZoneOptions, UserConstraint, VERSION, ValidationResult, Vec2, Vec3, type VoronoiCell, type VoronoiPoint, type VoronoiResult, WeldJoint, Winding, computeVoronoi, createConcaveBody, fractureBody, generateFractureSites };

package/dist/index.d.ts

@@ -1169,6 +1169,70 @@ declare class PulleyJoint extends Constraint {
     visitBodies(lambda: (body: Body) => void): void;
 }
 
+/**
+ * A spring/damper constraint between two anchor points on two bodies.
+ *
+ * Applies a spring force that pulls or pushes the anchors toward a target
+ * `restLength`. The spring behavior is controlled by `frequency` (Hz) and
+ * `damping` (ratio), inherited from {@link Constraint}.
+ *
+ * Unlike {@link DistanceJoint}, a SpringJoint:
+ * - Is **always soft** — there is no rigid/stiff mode.
+ * - Has a single `restLength` instead of a `[jointMin, jointMax]` range.
+ * - Applies force in **both directions** (compression and extension).
+ * - Never goes slack — the spring always exerts a restorative force.
+ *
+ * Ideal for: vehicle suspension, soft-body connections, ragdoll hair/cloth,
+ * bouncy UI animations, bridge/rope segments, trampolines.
+ *
+ * @example
+ * ```ts
+ * const spring = new SpringJoint(
+ *   body1, body2,
+ *   Vec2.weak(0, 0),   // anchor on body1 (local)
+ *   Vec2.weak(0, 0),   // anchor on body2 (local)
+ *   100,               // rest length (pixels)
+ * );
+ * spring.frequency = 5;  // 5 Hz oscillation
+ * spring.damping = 0.5;  // underdamped (bouncy)
+ * spring.space = space;
+ * ```
+ */
+declare class SpringJoint extends Constraint {
+    /**
+     * @param body1 - First body, or `null` for a static world anchor.
+     * @param body2 - Second body, or `null` for a static world anchor.
+     * @param anchor1 - Anchor point in `body1`'s local space (disposed if weak).
+     * @param anchor2 - Anchor point in `body2`'s local space (disposed if weak).
+     * @param restLength - Equilibrium distance between anchors (must be `>= 0`).
+     */
+    constructor(body1: Body | null, body2: Body | null, anchor1: Vec2, anchor2: Vec2, restLength: number);
+    /** First body. `null` treats the anchor as a static world point. */
+    get body1(): Body;
+    set body1(value: Body | null);
+    /** Second body. `null` treats the anchor as a static world point. */
+    get body2(): Body;
+    set body2(value: Body | null);
+    /** Anchor point on `body1` in local coordinates. */
+    get anchor1(): Vec2;
+    set anchor1(value: Vec2);
+    /** Anchor point on `body2` in local coordinates. */
+    get anchor2(): Vec2;
+    set anchor2(value: Vec2);
+    /** Equilibrium distance between anchors (pixels, must be `>= 0`). */
+    get restLength(): number;
+    set restLength(value: number);
+    /**
+     * SpringJoint is always soft — setting `stiff` to `true` is not allowed.
+     * Use {@link DistanceJoint} if you need a rigid distance constraint.
+     */
+    get stiff(): boolean;
+    set stiff(_value: boolean);
+    impulse(): MatMN;
+    bodyImpulse(body: Body): Vec3;
+    visitBodies(lambda: (body: Body) => void): void;
+}
+
 /**
  * ZPP_Constraint — Internal base class for all constraints / joints.
  *
@@ -1798,4 +1862,4 @@ declare function fractureBody(body: Body, impactPoint: Vec2, options?: FractureO
 
 declare const VERSION: string;
 
-export { AABB, AngleJoint, Arbiter, Body, BodyCallback, BodyListener, BodyType, Callback, Capsule, CbEvent, CbType, CharacterController, type CharacterControllerOptions, Circle, CollisionArbiter, type ConcaveBodyOptions, Constraint, ConstraintCallback, ConstraintListener, Contact, DebugDrawFlags, DistanceJoint, type FractureOptions, type FractureResult, Geom, GeomPoly, InteractionCallback, InteractionFilter, InteractionListener, InteractionType, Interactor, LineJoint, Listener, MarchingSquares, MatMN, Material, MotorJoint, type MoveResult, OptionType, PivotJoint, PreCallback, PreFlag, PreListener, PulleyJoint, Shape, ShapeType, Space, type TriggerHandler, TriggerZone, type TriggerZoneOptions, UserConstraint, VERSION, ValidationResult, Vec2, Vec3, type VoronoiCell, type VoronoiPoint, type VoronoiResult, WeldJoint, Winding, computeVoronoi, createConcaveBody, fractureBody, generateFractureSites };
+export { AABB, AngleJoint, Arbiter, Body, BodyCallback, BodyListener, BodyType, Callback, Capsule, CbEvent, CbType, CharacterController, type CharacterControllerOptions, Circle, CollisionArbiter, type ConcaveBodyOptions, Constraint, ConstraintCallback, ConstraintListener, Contact, DebugDrawFlags, DistanceJoint, type FractureOptions, type FractureResult, Geom, GeomPoly, InteractionCallback, InteractionFilter, InteractionListener, InteractionType, Interactor, LineJoint, Listener, MarchingSquares, MatMN, Material, MotorJoint, type MoveResult, OptionType, PivotJoint, PreCallback, PreFlag, PreListener, PulleyJoint, Shape, ShapeType, Space, SpringJoint, type TriggerHandler, TriggerZone, type TriggerZoneOptions, UserConstraint, VERSION, ValidationResult, Vec2, Vec3, type VoronoiCell, type VoronoiPoint, type VoronoiResult, WeldJoint, Winding, computeVoronoi, createConcaveBody, fractureBody, generateFractureSites };