@esotericsoftware/spine-core 4.2.25 → 4.2.27

package/dist/Animation.d.ts

@@ -26,13 +26,15 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THE
  * SPINE RUNTIMES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *****************************************************************************/
-import { VertexAttachment, Attachment } from "./attachments/Attachment";
-import { Skeleton } from "./Skeleton";
-import { Slot } from "./Slot";
-import { StringSet, NumberArrayLike } from "./Utils";
-import { Event } from "./Event";
-import { HasTextureRegion } from "./attachments/HasTextureRegion";
-import { SequenceMode } from "./attachments/Sequence";
+import { VertexAttachment, Attachment } from "./attachments/Attachment.js";
+import { Skeleton } from "./Skeleton.js";
+import { Slot } from "./Slot.js";
+import { StringSet, NumberArrayLike } from "./Utils.js";
+import { Event } from "./Event.js";
+import { HasTextureRegion } from "./attachments/HasTextureRegion.js";
+import { SequenceMode } from "./attachments/Sequence.js";
+import { PhysicsConstraint } from "./PhysicsConstraint.js";
+import { PhysicsConstraintData } from "./PhysicsConstraintData.js";
 /** A simple container for a list of timelines and a name. */
 export declare class Animation {
     /** The animation's name, which is unique across all animations in the skeleton. */
@@ -148,6 +150,10 @@ export declare abstract class CurveTimeline1 extends CurveTimeline {
     setFrame(frame: number, time: number, value: number): void;
     /** Returns the interpolated value for the specified time. */
     getCurveValue(time: number): number;
+    getRelativeValue(time: number, alpha: number, blend: MixBlend, current: number, setup: number): number;
+    getAbsoluteValue(time: number, alpha: number, blend: MixBlend, current: number, setup: number): number;
+    getAbsoluteValue2(time: number, alpha: number, blend: MixBlend, current: number, setup: number, value: number): number;
+    getScaleValue(time: number, alpha: number, blend: MixBlend, direction: MixDirection, current: number, setup: number): number;
 }
 /** The base class for a {@link CurveTimeline} which sets two properties. */
 export declare abstract class CurveTimeline2 extends CurveTimeline {
@@ -320,8 +326,8 @@ export declare class DrawOrderTimeline extends Timeline {
 /** Changes an IK constraint's {@link IkConstraint#mix}, {@link IkConstraint#softness},
  * {@link IkConstraint#bendDirection}, {@link IkConstraint#stretch}, and {@link IkConstraint#compress}. */
 export declare class IkConstraintTimeline extends CurveTimeline {
-    /** The index of the IK constraint slot in {@link Skeleton#ikConstraints} that will be changed. */
-    ikConstraintIndex: number;
+    /** The index of the IK constraint in {@link Skeleton#getIkConstraints()} that will be changed when this timeline is */
+    constraintIndex: number;
     constructor(frameCount: number, bezierCount: number, ikConstraintIndex: number);
     getFrameEntries(): number;
     /** Sets the time in seconds, mix, softness, bend direction, compress, and stretch for the specified key frame. */
@@ -332,7 +338,7 @@ export declare class IkConstraintTimeline extends CurveTimeline {
  * {@link TransformConstraint#scaleMix}, and {@link TransformConstraint#shearMix}. */
 export declare class TransformConstraintTimeline extends CurveTimeline {
     /** The index of the transform constraint slot in {@link Skeleton#transformConstraints} that will be changed. */
-    transformConstraintIndex: number;
+    constraintIndex: number;
     constructor(frameCount: number, bezierCount: number, transformConstraintIndex: number);
     getFrameEntries(): number;
     /** The time in seconds, rotate mix, translate mix, scale mix, and shear mix for the specified key frame. */
@@ -341,28 +347,115 @@ export declare class TransformConstraintTimeline extends CurveTimeline {
 }
 /** Changes a path constraint's {@link PathConstraint#position}. */
 export declare class PathConstraintPositionTimeline extends CurveTimeline1 {
-    /** The index of the path constraint slot in {@link Skeleton#pathConstraints} that will be changed. */
-    pathConstraintIndex: number;
+    /** The index of the path constraint in {@link Skeleton#getPathConstraints()} that will be changed when this timeline is
+     * applied. */
+    constraintIndex: number;
     constructor(frameCount: number, bezierCount: number, pathConstraintIndex: number);
     apply(skeleton: Skeleton, lastTime: number, time: number, firedEvents: Array<Event>, alpha: number, blend: MixBlend, direction: MixDirection): void;
 }
 /** Changes a path constraint's {@link PathConstraint#spacing}. */
 export declare class PathConstraintSpacingTimeline extends CurveTimeline1 {
-    /** The index of the path constraint slot in {@link Skeleton#getPathConstraints()} that will be changed. */
-    pathConstraintIndex: number;
+    /** The index of the path constraint in {@link Skeleton#getPathConstraints()} that will be changed when this timeline is
+     * applied. */
+    constraintIndex: number;
     constructor(frameCount: number, bezierCount: number, pathConstraintIndex: number);
     apply(skeleton: Skeleton, lastTime: number, time: number, firedEvents: Array<Event>, alpha: number, blend: MixBlend, direction: MixDirection): void;
 }
 /** Changes a transform constraint's {@link PathConstraint#getMixRotate()}, {@link PathConstraint#getMixX()}, and
  * {@link PathConstraint#getMixY()}. */
 export declare class PathConstraintMixTimeline extends CurveTimeline {
-    /** The index of the path constraint slot in {@link Skeleton#getPathConstraints()} that will be changed. */
-    pathConstraintIndex: number;
+    /** The index of the path constraint in {@link Skeleton#getPathConstraints()} that will be changed when this timeline is
+     * applied. */
+    constraintIndex: number;
     constructor(frameCount: number, bezierCount: number, pathConstraintIndex: number);
     getFrameEntries(): number;
     setFrame(frame: number, time: number, mixRotate: number, mixX: number, mixY: number): void;
     apply(skeleton: Skeleton, lastTime: number, time: number, firedEvents: Array<Event>, alpha: number, blend: MixBlend, direction: MixDirection): void;
 }
+/** The base class for most {@link PhysicsConstraint} timelines. */
+export declare abstract class PhysicsConstraintTimeline extends CurveTimeline1 {
+    /** The index of the physics constraint in {@link Skeleton#getPhysicsConstraints()} that will be changed when this timeline
+     * is applied, or -1 if all physics constraints in the skeleton will be changed. */
+    constraintIndex: number;
+    /** @param physicsConstraintIndex -1 for all physics constraints in the skeleton. */
+    constructor(frameCount: number, bezierCount: number, physicsConstraintIndex: number, property: number);
+    apply(skeleton: Skeleton, lastTime: number, time: number, firedEvents: Array<Event>, alpha: number, blend: MixBlend, direction: MixDirection): void;
+    abstract setup(constraint: PhysicsConstraint): number;
+    abstract get(constraint: PhysicsConstraint): number;
+    abstract set(constraint: PhysicsConstraint, value: number): void;
+    abstract global(constraint: PhysicsConstraintData): boolean;
+}
+/** Changes a physics constraint's {@link PhysicsConstraint#getInertia()}. */
+export declare class PhysicsConstraintInertiaTimeline extends PhysicsConstraintTimeline {
+    constructor(frameCount: number, bezierCount: number, physicsConstraintIndex: number, property: number);
+    setup(constraint: PhysicsConstraint): number;
+    get(constraint: PhysicsConstraint): number;
+    set(constraint: PhysicsConstraint, value: number): void;
+    global(constraint: PhysicsConstraintData): boolean;
+}
+/** Changes a physics constraint's {@link PhysicsConstraint#getStrength()}. */
+export declare class PhysicsConstraintStrengthTimeline extends PhysicsConstraintTimeline {
+    constructor(frameCount: number, bezierCount: number, physicsConstraintIndex: number, property: number);
+    setup(constraint: PhysicsConstraint): number;
+    get(constraint: PhysicsConstraint): number;
+    set(constraint: PhysicsConstraint, value: number): void;
+    global(constraint: PhysicsConstraintData): boolean;
+}
+/** Changes a physics constraint's {@link PhysicsConstraint#getDamping()}. */
+export declare class PhysicsConstraintDampingTimeline extends PhysicsConstraintTimeline {
+    constructor(frameCount: number, bezierCount: number, physicsConstraintIndex: number, property: number);
+    setup(constraint: PhysicsConstraint): number;
+    get(constraint: PhysicsConstraint): number;
+    set(constraint: PhysicsConstraint, value: number): void;
+    global(constraint: PhysicsConstraintData): boolean;
+}
+/** Changes a physics constraint's {@link PhysicsConstraint#getMassInverse()}. The timeline values are not inverted. */
+export declare class PhysicsConstraintMassTimeline extends PhysicsConstraintTimeline {
+    constructor(frameCount: number, bezierCount: number, physicsConstraintIndex: number, property: number);
+    setup(constraint: PhysicsConstraint): number;
+    get(constraint: PhysicsConstraint): number;
+    set(constraint: PhysicsConstraint, value: number): void;
+    global(constraint: PhysicsConstraintData): boolean;
+}
+/** Changes a physics constraint's {@link PhysicsConstraint#getWind()}. */
+export declare class PhysicsConstraintWindTimeline extends PhysicsConstraintTimeline {
+    constructor(frameCount: number, bezierCount: number, physicsConstraintIndex: number, property: number);
+    setup(constraint: PhysicsConstraint): number;
+    get(constraint: PhysicsConstraint): number;
+    set(constraint: PhysicsConstraint, value: number): void;
+    global(constraint: PhysicsConstraintData): boolean;
+}
+/** Changes a physics constraint's {@link PhysicsConstraint#getGravity()}. */
+export declare class PhysicsConstraintGravityTimeline extends PhysicsConstraintTimeline {
+    constructor(frameCount: number, bezierCount: number, physicsConstraintIndex: number, property: number);
+    setup(constraint: PhysicsConstraint): number;
+    get(constraint: PhysicsConstraint): number;
+    set(constraint: PhysicsConstraint, value: number): void;
+    global(constraint: PhysicsConstraintData): boolean;
+}
+/** Changes a physics constraint's {@link PhysicsConstraint#getMix()}. */
+export declare class PhysicsConstraintMixTimeline extends PhysicsConstraintTimeline {
+    constructor(frameCount: number, bezierCount: number, physicsConstraintIndex: number, property: number);
+    setup(constraint: PhysicsConstraint): number;
+    get(constraint: PhysicsConstraint): number;
+    set(constraint: PhysicsConstraint, value: number): void;
+    global(constraint: PhysicsConstraintData): boolean;
+}
+/** Resets a physics constraint when specific animation times are reached. */
+export declare class PhysicsConstraintResetTimeline extends Timeline {
+    private static propertyIds;
+    /** The index of the physics constraint in {@link Skeleton#getPhysicsConstraints()} that will be reset when this timeline is
+    * applied, or -1 if all physics constraints in the skeleton will be reset. */
+    constraintIndex: number;
+    /** @param physicsConstraintIndex -1 for all physics constraints in the skeleton. */
+    constructor(frameCount: number, physicsConstraintIndex: number);
+    getFrameCount(): number;
+    /** Sets the time for the specified frame.
+     * @param frame Between 0 and <code>frameCount</code>, inclusive. */
+    setFrame(frame: number, time: number): void;
+    /** Resets the physics constraint when frames > <code>lastTime</code> and <= <code>time</code>. */
+    apply(skeleton: Skeleton, lastTime: number, time: number, firedEvents: Array<Event>, alpha: number, blend: MixBlend, direction: MixDirection): void;
+}
 /** Changes a slot's {@link Slot#getSequenceIndex()} for an attachment's {@link Sequence}. */
 export declare class SequenceTimeline extends Timeline implements SlotTimeline {
     static ENTRIES: number;