@esotericsoftware/spine-core 4.1.25 → 4.1.28

package/dist/PathConstraintData.js

@@ -0,0 +1,91 @@
+/******************************************************************************
+ * Spine Runtimes License Agreement
+ * Last updated September 24, 2021. Replaces all prior versions.
+ *
+ * Copyright (c) 2013-2021, Esoteric Software LLC
+ *
+ * Integration of the Spine Runtimes into software or otherwise creating
+ * derivative works of the Spine Runtimes is permitted under the terms and
+ * conditions of Section 2 of the Spine Editor License Agreement:
+ * http://esotericsoftware.com/spine-editor-license
+ *
+ * Otherwise, it is permitted to integrate the Spine Runtimes into software
+ * or otherwise create derivative works of the Spine Runtimes (collectively,
+ * "Products"), provided that each user of the Products must obtain their own
+ * Spine Editor license and redistribution of the Products in any form must
+ * include this license and copyright notice.
+ *
+ * THE SPINE RUNTIMES ARE PROVIDED BY ESOTERIC SOFTWARE LLC "AS IS" AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL ESOTERIC SOFTWARE LLC BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES,
+ * BUSINESS INTERRUPTION, OR LOSS OF USE, DATA, OR PROFITS) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (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 { ConstraintData } from "./ConstraintData";
+/** Stores the setup pose for a {@link PathConstraint}.
+ *
+ * See [path constraints](http://esotericsoftware.com/spine-path-constraints) in the Spine User Guide. */
+export class PathConstraintData extends ConstraintData {
+    set target(slotData) { this._target = slotData; }
+    get target() {
+        if (!this._target)
+            throw new Error("SlotData not set.");
+        else
+            return this._target;
+    }
+    constructor(name) {
+        super(name, 0, false);
+        /** The bones that will be modified by this path constraint. */
+        this.bones = new Array();
+        /** The slot whose path attachment will be used to constrained the bones. */
+        this._target = null;
+        /** The mode for positioning the first bone on the path. */
+        this.positionMode = PositionMode.Fixed;
+        /** The mode for positioning the bones after the first bone on the path. */
+        this.spacingMode = SpacingMode.Fixed;
+        /** The mode for adjusting the rotation of the bones. */
+        this.rotateMode = RotateMode.Chain;
+        /** An offset added to the constrained bone rotation. */
+        this.offsetRotation = 0;
+        /** The position along the path. */
+        this.position = 0;
+        /** The spacing between bones. */
+        this.spacing = 0;
+        this.mixRotate = 0;
+        this.mixX = 0;
+        this.mixY = 0;
+    }
+}
+/** Controls how the first bone is positioned along the path.
+ *
+ * See [position](http://esotericsoftware.com/spine-path-constraints#Position) in the Spine User Guide. */
+export var PositionMode;
+(function (PositionMode) {
+    PositionMode[PositionMode["Fixed"] = 0] = "Fixed";
+    PositionMode[PositionMode["Percent"] = 1] = "Percent";
+})(PositionMode || (PositionMode = {}));
+/** Controls how bones after the first bone are positioned along the path.
+ *
+ * See [spacing](http://esotericsoftware.com/spine-path-constraints#Spacing) in the Spine User Guide. */
+export var SpacingMode;
+(function (SpacingMode) {
+    SpacingMode[SpacingMode["Length"] = 0] = "Length";
+    SpacingMode[SpacingMode["Fixed"] = 1] = "Fixed";
+    SpacingMode[SpacingMode["Percent"] = 2] = "Percent";
+    SpacingMode[SpacingMode["Proportional"] = 3] = "Proportional";
+})(SpacingMode || (SpacingMode = {}));
+/** Controls how bones are rotated, translated, and scaled to match the path.
+ *
+ * See [rotate mix](http://esotericsoftware.com/spine-path-constraints#Rotate-mix) in the Spine User Guide. */
+export var RotateMode;
+(function (RotateMode) {
+    RotateMode[RotateMode["Tangent"] = 0] = "Tangent";
+    RotateMode[RotateMode["Chain"] = 1] = "Chain";
+    RotateMode[RotateMode["ChainScale"] = 2] = "ChainScale";
+})(RotateMode || (RotateMode = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUGF0aENvbnN0cmFpbnREYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL1BhdGhDb25zdHJhaW50RGF0YS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OytFQTJCK0U7QUFHL0UsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBSWxEOzt5R0FFeUc7QUFDekcsTUFBTSxPQUFPLGtCQUFtQixTQUFRLGNBQWM7SUFPckQsSUFBVyxNQUFNLENBQUUsUUFBa0IsSUFBSSxJQUFJLENBQUMsT0FBTyxHQUFHLFFBQVEsQ0FBQyxDQUFDLENBQUM7SUFDbkUsSUFBVyxNQUFNO1FBQ2hCLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTztZQUFFLE1BQU0sSUFBSSxLQUFLLENBQUMsbUJBQW1CLENBQUMsQ0FBQTs7WUFDbEQsT0FBTyxJQUFJLENBQUMsT0FBTyxDQUFDO0lBQzFCLENBQUM7SUF3QkQsWUFBYSxJQUFZO1FBQ3hCLEtBQUssQ0FBQyxJQUFJLEVBQUUsQ0FBQyxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBbEN2QiwrREFBK0Q7UUFDL0QsVUFBSyxHQUFHLElBQUksS0FBSyxFQUFZLENBQUM7UUFFOUIsNEVBQTRFO1FBQ3BFLFlBQU8sR0FBb0IsSUFBSSxDQUFDO1FBT3hDLDJEQUEyRDtRQUMzRCxpQkFBWSxHQUFpQixZQUFZLENBQUMsS0FBSyxDQUFDO1FBRWhELDJFQUEyRTtRQUMzRSxnQkFBVyxHQUFnQixXQUFXLENBQUMsS0FBSyxDQUFDO1FBRTdDLHdEQUF3RDtRQUN4RCxlQUFVLEdBQWUsVUFBVSxDQUFDLEtBQUssQ0FBQztRQUUxQyx3REFBd0Q7UUFDeEQsbUJBQWMsR0FBVyxDQUFDLENBQUM7UUFFM0IsbUNBQW1DO1FBQ25DLGFBQVEsR0FBVyxDQUFDLENBQUM7UUFFckIsaUNBQWlDO1FBQ2pDLFlBQU8sR0FBVyxDQUFDLENBQUM7UUFFcEIsY0FBUyxHQUFHLENBQUMsQ0FBQztRQUNkLFNBQUksR0FBRyxDQUFDLENBQUM7UUFDVCxTQUFJLEdBQUcsQ0FBQyxDQUFDO0lBSVQsQ0FBQztDQUNEO0FBRUQ7OzBHQUUwRztBQUMxRyxNQUFNLENBQU4sSUFBWSxZQUErQjtBQUEzQyxXQUFZLFlBQVk7SUFBRyxpREFBSyxDQUFBO0lBQUUscURBQU8sQ0FBQTtBQUFDLENBQUMsRUFBL0IsWUFBWSxLQUFaLFlBQVksUUFBbUI7QUFFM0M7O3dHQUV3RztBQUN4RyxNQUFNLENBQU4sSUFBWSxXQUFvRDtBQUFoRSxXQUFZLFdBQVc7SUFBRyxpREFBTSxDQUFBO0lBQUUsK0NBQUssQ0FBQTtJQUFFLG1EQUFPLENBQUE7SUFBRSw2REFBWSxDQUFBO0FBQUMsQ0FBQyxFQUFwRCxXQUFXLEtBQVgsV0FBVyxRQUF5QztBQUVoRTs7OEdBRThHO0FBQzlHLE1BQU0sQ0FBTixJQUFZLFVBQXlDO0FBQXJELFdBQVksVUFBVTtJQUFHLGlEQUFPLENBQUE7SUFBRSw2Q0FBSyxDQUFBO0lBQUUsdURBQVUsQ0FBQTtBQUFDLENBQUMsRUFBekMsVUFBVSxLQUFWLFVBQVUsUUFBK0IifQ==

package/dist/Skeleton.d.ts

@@ -0,0 +1,163 @@
+/******************************************************************************
+ * Spine Runtimes License Agreement
+ * Last updated September 24, 2021. Replaces all prior versions.
+ *
+ * Copyright (c) 2013-2021, Esoteric Software LLC
+ *
+ * Integration of the Spine Runtimes into software or otherwise creating
+ * derivative works of the Spine Runtimes is permitted under the terms and
+ * conditions of Section 2 of the Spine Editor License Agreement:
+ * http://esotericsoftware.com/spine-editor-license
+ *
+ * Otherwise, it is permitted to integrate the Spine Runtimes into software
+ * or otherwise create derivative works of the Spine Runtimes (collectively,
+ * "Products"), provided that each user of the Products must obtain their own
+ * Spine Editor license and redistribution of the Products in any form must
+ * include this license and copyright notice.
+ *
+ * THE SPINE RUNTIMES ARE PROVIDED BY ESOTERIC SOFTWARE LLC "AS IS" AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL ESOTERIC SOFTWARE LLC BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES,
+ * BUSINESS INTERRUPTION, OR LOSS OF USE, DATA, OR PROFITS) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (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 { Attachment } from "./attachments/Attachment";
+import { Bone } from "./Bone";
+import { IkConstraint } from "./IkConstraint";
+import { PathConstraint } from "./PathConstraint";
+import { SkeletonData } from "./SkeletonData";
+import { Skin } from "./Skin";
+import { Slot } from "./Slot";
+import { TransformConstraint } from "./TransformConstraint";
+import { Updatable } from "./Updatable";
+import { Color, Vector2 } from "./Utils";
+/** Stores the current pose for a skeleton.
+ *
+ * See [Instance objects](http://esotericsoftware.com/spine-runtime-architecture#Instance-objects) in the Spine Runtimes Guide. */
+export declare class Skeleton {
+    static yDown: boolean;
+    /** The skeleton's setup pose data. */
+    data: SkeletonData;
+    /** The skeleton's bones, sorted parent first. The root bone is always the first bone. */
+    bones: Array<Bone>;
+    /** The skeleton's slots. */
+    slots: Array<Slot>;
+    /** The skeleton's slots in the order they should be drawn. The returned array may be modified to change the draw order. */
+    drawOrder: Array<Slot>;
+    /** The skeleton's IK constraints. */
+    ikConstraints: Array<IkConstraint>;
+    /** The skeleton's transform constraints. */
+    transformConstraints: Array<TransformConstraint>;
+    /** The skeleton's path constraints. */
+    pathConstraints: Array<PathConstraint>;
+    /** The list of bones and constraints, sorted in the order they should be updated, as computed by {@link #updateCache()}. */
+    _updateCache: Updatable[];
+    /** The skeleton's current skin. May be null. */
+    skin: Skin | null;
+    /** The color to tint all the skeleton's attachments. */
+    color: Color;
+    /** Scales the entire skeleton on the X axis. This affects all bones, even if the bone's transform mode disallows scale
+      * inheritance. */
+    scaleX: number;
+    /** Scales the entire skeleton on the Y axis. This affects all bones, even if the bone's transform mode disallows scale
+      * inheritance. */
+    private _scaleY;
+    get scaleY(): number;
+    set scaleY(scaleY: number);
+    /** Sets the skeleton X position, which is added to the root bone worldX position. */
+    x: number;
+    /** Sets the skeleton Y position, which is added to the root bone worldY position. */
+    y: number;
+    constructor(data: SkeletonData);
+    /** Caches information about bones and constraints. Must be called if the {@link #getSkin()} is modified or if bones,
+     * constraints, or weighted path attachments are added or removed. */
+    updateCache(): void;
+    sortIkConstraint(constraint: IkConstraint): void;
+    sortPathConstraint(constraint: PathConstraint): void;
+    sortTransformConstraint(constraint: TransformConstraint): void;
+    sortPathConstraintAttachment(skin: Skin, slotIndex: number, slotBone: Bone): void;
+    sortPathConstraintAttachmentWith(attachment: Attachment, slotBone: Bone): void;
+    sortBone(bone: Bone): void;
+    sortReset(bones: Array<Bone>): void;
+    /** Updates the world transform for each bone and applies all constraints.
+     *
+     * See [World transforms](http://esotericsoftware.com/spine-runtime-skeletons#World-transforms) in the Spine
+     * Runtimes Guide. */
+    updateWorldTransform(): void;
+    updateWorldTransformWith(parent: Bone): void;
+    /** Sets the bones, constraints, and slots to their setup pose values. */
+    setToSetupPose(): void;
+    /** Sets the bones and constraints to their setup pose values. */
+    setBonesToSetupPose(): void;
+    /** Sets the slots and draw order to their setup pose values. */
+    setSlotsToSetupPose(): void;
+    /** @returns May return null. */
+    getRootBone(): Bone | null;
+    /** @returns May be null. */
+    findBone(boneName: string): Bone | null;
+    /** Finds a slot by comparing each slot's name. It is more efficient to cache the results of this method than to call it
+     * repeatedly.
+     * @returns May be null. */
+    findSlot(slotName: string): Slot | null;
+    /** Sets a skin by name.
+     *
+     * See {@link #setSkin()}. */
+    setSkinByName(skinName: string): void;
+    /** Sets the skin used to look up attachments before looking in the {@link SkeletonData#defaultSkin default skin}. If the
+     * skin is changed, {@link #updateCache()} is called.
+     *
+     * Attachments from the new skin are attached if the corresponding attachment from the old skin was attached. If there was no
+     * old skin, each slot's setup mode attachment is attached from the new skin.
+     *
+     * After changing the skin, the visible attachments can be reset to those attached in the setup pose by calling
+     * {@link #setSlotsToSetupPose()}. Also, often {@link AnimationState#apply()} is called before the next time the
+     * skeleton is rendered to allow any attachment keys in the current animation(s) to hide or show attachments from the new skin.
+     * @param newSkin May be null. */
+    setSkin(newSkin: Skin): void;
+    /** Finds an attachment by looking in the {@link #skin} and {@link SkeletonData#defaultSkin} using the slot name and attachment
+     * name.
+     *
+     * See {@link #getAttachment()}.
+     * @returns May be null. */
+    getAttachmentByName(slotName: string, attachmentName: string): Attachment | null;
+    /** Finds an attachment by looking in the {@link #skin} and {@link SkeletonData#defaultSkin} using the slot index and
+     * attachment name. First the skin is checked and if the attachment was not found, the default skin is checked.
+     *
+     * See [Runtime skins](http://esotericsoftware.com/spine-runtime-skins) in the Spine Runtimes Guide.
+     * @returns May be null. */
+    getAttachment(slotIndex: number, attachmentName: string): Attachment | null;
+    /** A convenience method to set an attachment by finding the slot with {@link #findSlot()}, finding the attachment with
+     * {@link #getAttachment()}, then setting the slot's {@link Slot#attachment}.
+     * @param attachmentName May be null to clear the slot's attachment. */
+    setAttachment(slotName: string, attachmentName: string): void;
+    /** Finds an IK constraint by comparing each IK constraint's name. It is more efficient to cache the results of this method
+     * than to call it repeatedly.
+     * @return May be null. */
+    findIkConstraint(constraintName: string): IkConstraint | null;
+    /** Finds a transform constraint by comparing each transform constraint's name. It is more efficient to cache the results of
+     * this method than to call it repeatedly.
+     * @return May be null. */
+    findTransformConstraint(constraintName: string): TransformConstraint | null;
+    /** Finds a path constraint by comparing each path constraint's name. It is more efficient to cache the results of this method
+     * than to call it repeatedly.
+     * @return May be null. */
+    findPathConstraint(constraintName: string): PathConstraint | null;
+    /** Returns the axis aligned bounding box (AABB) of the region and mesh attachments for the current pose as `{ x: number, y: number, width: number, height: number }`.
+     * Note that this method will create temporary objects which can add to garbage collection pressure. Use `getBounds()` if garbage collection is a concern. */
+    getBoundsRect(): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    /** Returns the axis aligned bounding box (AABB) of the region and mesh attachments for the current pose.
+     * @param offset An output value, the distance from the skeleton origin to the bottom left corner of the AABB.
+     * @param size An output value, the width and height of the AABB.
+     * @param temp Working memory to temporarily store attachments' computed world vertices. */
+    getBounds(offset: Vector2, size: Vector2, temp?: Array<number>): void;
+}