@esotericsoftware/spine-pixi-v8 4.2.71 → 4.2.72

package/dist/Spine.d.ts

@@ -47,6 +47,66 @@ export interface SpineFromOptions {
      * If `undefined`, use the dark tint renderer if at least one slot has tint black
      */
     darkTint?: boolean;
+    /** The bounds provider to use. If undefined the bounds will be dynamic, calculated when requested and based on the current frame. */
+    boundsProvider?: SpineBoundsProvider;
+}
+/** A bounds provider calculates the bounding box for a skeleton, which is then assigned as the size of the SpineGameObject. */
+export interface SpineBoundsProvider {
+    /** Returns the bounding box for the skeleton, in skeleton space. */
+    calculateBounds(gameObject: Spine): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+}
+/** A bounds provider that provides a fixed size given by the user. */
+export declare class AABBRectangleBoundsProvider implements SpineBoundsProvider {
+    private x;
+    private y;
+    private width;
+    private height;
+    constructor(x: number, y: number, width: number, height: number);
+    calculateBounds(): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+}
+/** A bounds provider that calculates the bounding box from the setup pose. */
+export declare class SetupPoseBoundsProvider implements SpineBoundsProvider {
+    private clipping;
+    /**
+     * @param clipping If true, clipping attachments are used to compute the bounds. False, by default.
+     */
+    constructor(clipping?: boolean);
+    calculateBounds(gameObject: Spine): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+}
+/** A bounds provider that calculates the bounding box by taking the maximumg bounding box for a combination of skins and specific animation. */
+export declare class SkinsAndAnimationBoundsProvider implements SpineBoundsProvider {
+    private animation;
+    private skins;
+    private timeStep;
+    private clipping;
+    /**
+     * @param animation The animation to use for calculating the bounds. If null, the setup pose is used.
+     * @param skins The skins to use for calculating the bounds. If empty, the default skin is used.
+     * @param timeStep The time step to use for calculating the bounds. A smaller time step means more precision, but slower calculation.
+     * @param clipping If true, clipping attachments are used to compute the bounds. False, by default.
+     */
+    constructor(animation: string | null, skins?: string[], timeStep?: number, clipping?: boolean);
+    calculateBounds(gameObject: Spine): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
 }
 export interface SpineOptions extends ContainerOptions {
     /** the {@link SkeletonData} used to instantiate the skeleton */
@@ -55,6 +115,8 @@ export interface SpineOptions extends ContainerOptions {
     autoUpdate?: boolean;
     /**  See {@link SpineFromOptions.darkTint}. */
     darkTint?: boolean;
+    /**  See {@link SpineFromOptions.boundsProvider}. */
+    boundsProvider?: SpineBoundsProvider;
 }
 /**
  * AnimationStateListener {@link https://en.esotericsoftware.com/spine-api-reference#AnimationStateListener events} exposed for Pixi.
@@ -125,6 +187,10 @@ export declare class Spine extends ViewContainer {
     get autoUpdate(): boolean;
     /** When `true`, the Spine AnimationState and the Skeleton will be automatically updated using the {@link Ticker.shared} instance. */
     set autoUpdate(value: boolean);
+    private _boundsProvider?;
+    /** The bounds provider to use. If undefined the bounds will be dynamic, calculated when requested and based on the current frame. */
+    get boundsProvider(): SpineBoundsProvider | undefined;
+    set boundsProvider(value: SpineBoundsProvider | undefined);
     private hasNeverUpdated;
     constructor(options: SpineOptions | SkeletonData);
     /** If {@link Spine.autoUpdate} is `false`, this method allows to update the AnimationState and the Skeleton with the given delta. */
@@ -243,5 +309,5 @@ export declare class Spine extends ViewContainer {
      * @param options - Options to configure the Spine game object. See {@link SpineFromOptions}
      * @returns {Spine} The Spine game object instantiated
      */
-    static from({ skeleton, atlas, scale, darkTint, autoUpdate }: SpineFromOptions): Spine;
+    static from({ skeleton, atlas, scale, darkTint, autoUpdate, boundsProvider }: SpineFromOptions): Spine;
 }