59 lines
3.2 KiB
TypeScript
59 lines
3.2 KiB
TypeScript
/******************************************************************************
|
|
* Spine Runtimes License Agreement
|
|
* Last updated April 5, 2025. Replaces all prior versions.
|
|
*
|
|
* Copyright (c) 2013-2025, 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 type { Pose } from "./Pose.js";
|
|
import type { PosedData } from "./PosedData.js";
|
|
/** The base class for an object with a number of poses:
|
|
* - {@link data}: The setup pose.
|
|
* - {@link pose}: The unconstrained pose. Set by animations and application code.
|
|
* - {@link appliedPose}: The pose to use for rendering. Possibly modified by constraints.
|
|
*/
|
|
export declare abstract class Posed<D extends PosedData<P>, P extends Pose<P>> {
|
|
/** The constraint's setup pose data. */
|
|
readonly data: D;
|
|
readonly pose: P;
|
|
readonly constrainedPose: P;
|
|
appliedPose: P;
|
|
constructor(data: D, pose: P, constrainedPose: P);
|
|
/** Sets the unconstrained pose to the setup pose. */
|
|
setupPose(): void;
|
|
/** The setup pose data. May be shared with multiple instances. */
|
|
getData(): D;
|
|
/** The unconstrained pose for this object, set by animations and application code. */
|
|
getPose(): P;
|
|
/** The pose to use for rendering. If no constraints modify this pose, this is the same as {@link pose}. Otherwise it is a
|
|
* copy of {@link pose} modified by constraints. */
|
|
getAppliedPose(): P;
|
|
/** Sets the applied pose to the unconstrained pose, for when no constraints will modify the pose. */
|
|
unconstrained(): void;
|
|
/** Sets the applied pose to the constrained pose, in anticipation of the applied pose being modified by constraints. */
|
|
constrained(): void;
|
|
/** Sets the constrained pose to the unconstrained pose, as a starting point for constraints to be applied. */
|
|
resetConstrained(): void;
|
|
}
|