@galacean/engine-spine 4.2.0-beta.3 → 4.2.0

package/types/spine-core/vertexeffects/JitterEffect.d.ts

@@ -1,11 +0,0 @@
-import { VertexEffect } from "../VertexEffect";
-import { Skeleton } from "../Skeleton";
-import { Color, Vector2 } from "../Utils";
-export declare class JitterEffect implements VertexEffect {
-    jitterX: number;
-    jitterY: number;
-    constructor(jitterX: number, jitterY: number);
-    begin(skeleton: Skeleton): void;
-    transform(position: Vector2, uv: Vector2, light: Color, dark: Color): void;
-    end(): void;
-}

package/types/spine-core/vertexeffects/SwirlEffect.d.ts

@@ -1,16 +0,0 @@
-import { VertexEffect } from "../VertexEffect";
-import { PowOut, Color, Vector2 } from "../Utils";
-import { Skeleton } from "../Skeleton";
-export declare class SwirlEffect implements VertexEffect {
-    static interpolation: PowOut;
-    centerX: number;
-    centerY: number;
-    radius: number;
-    angle: number;
-    private worldX;
-    private worldY;
-    constructor(radius: number);
-    begin(skeleton: Skeleton): void;
-    transform(position: Vector2, uv: Vector2, light: Color, dark: Color): void;
-    end(): void;
-}

package/types/src/SpineAnimationRenderer.d.ts

@@ -1,197 +0,0 @@
-import { AnimationState, Skeleton } from "@esotericsoftware/spine-core";
-import { BoundingBox, Buffer, Engine, Entity, Material, Primitive, Renderer, SubPrimitive } from "@galacean/engine";
-import { SpineResource } from "./loader/SpineResource";
-/**
- * Spine animation renderer, capable of rendering spine animations and providing functions for animation and skeleton manipulation.
- */
-export declare class SpineAnimationRenderer extends Renderer {
-    private static _defaultMaterial;
-    private static _spineGenerator;
-    private static _positionVertexElement;
-    private static _colorVertexElement;
-    private static _uvVertexElement;
-    /** @internal */
-    static _materialCache: Map<string, Material>;
-    /** @internal */
-    static _getDefaultMaterial(engine: Engine): Material;
-    /**
-     * The spacing between z layers.
-     */
-    zSpacing: number;
-    /**
-     * Whether to use premultiplied alpha mode for rendering.
-     * When enabled, vertex color values are multiplied by the alpha channel.
-     * @remarks
-   If this option is enabled, the Spine editor must export textures with "Premultiply Alpha" checked.
-     */
-    premultipliedAlpha: boolean;
-    /**
-     * Updates the bounding box every frame when enabled.
-     * Otherwise, it is calculated only during animation initialization.
-     */
-    updateBoundsPerFrame: boolean;
-    /**
-     * Default state for spine animation.
-     * Contains the default animation name to be played, whether this animation should loop, the default skin name.
-     */
-    readonly defaultConfig: SpineAnimationDefaultConfig;
-    /** @internal */
-    _primitive: Primitive;
-    /** @internal */
-    _subPrimitives: SubPrimitive[];
-    /** @internal */
-    _indexBuffer: Buffer;
-    /** @internal */
-    _vertexBuffer: Buffer;
-    /** @internal */
-    _vertices: Float32Array<ArrayBuffer>;
-    /** @internal */
-    _indices: Uint16Array<ArrayBuffer>;
-    /** @internal */
-    _needResizeBuffer: boolean;
-    /** @internal */
-    _vertexCount: number;
-    /** @internal */
-    _resource: SpineResource;
-    /** @internal */
-    _spineBounds: BoundingBox;
-    /** @internal */
-    _needsInitialize: boolean;
-    private _skeleton;
-    private _state;
-    /**
-     * The Spine.AnimationState object of this SpineAnimationRenderer.
-     * Manage, blend, and transition between multiple simultaneous animations effectively.
-     */
-    get state(): AnimationState;
-    /**
-     * The Spine.Skeleton object of this SpineAnimationRenderer.
-     * Manipulate bone positions, rotations, scaling
-     * and change spine attachment to customize character appearances dynamically during runtime.
-     */
-    get skeleton(): Skeleton;
-    /**
-     * @internal
-     */
-    constructor(entity: Entity);
-    /**
-     * @internal
-     */
-    _onEnable(): void;
-    /**
-     * @internal
-     */
-    update(delta: number): void;
-    /**
-     * @internal
-     */
-    _render(context: any): void;
-    /**
-     * @internal
-     */
-    _updateBounds(worldBounds: BoundingBox): void;
-    /**
-     * @internal
-     */
-    _setSkeleton(skeleton: Skeleton): void;
-    /**
-     * @internal
-     */
-    _setState(state: AnimationState): void;
-    /**
-     * @internal
-     */
-    _cloneTo(target: SpineAnimationRenderer): void;
-    /**
-     * @internal
-     */
-    _onDestroy(): void;
-    /**
-     * @internal
-     */
-    _createAndBindBuffer(vertexCount: number): void;
-    /**
-     * @internal
-     */
-    _addSubPrimitive(subPrimitive: SubPrimitive): void;
-    /**
-     * @internal
-     */
-    _clearSubPrimitives(): void;
-    /**
-     * @internal
-     */
-    _isContainDirtyFlag(type: number): boolean;
-    /**
-     * @internal
-     */
-    _setDirtyFlagFalse(type: number): void;
-    private _initialize;
-    private _onAnimationStart;
-    private _onAnimationEnd;
-    private _clearMaterialCache;
-    private _applyDefaultConfig;
-    /**
-     * * @deprecated This property is deprecated and will be removed in future releases.
-     * Spine resource of current spine animation.
-    */
-    get resource(): SpineResource;
-    /**
-     * * @deprecated This property is deprecated and will be removed in future releases.
-     * Sets the Spine resource for the current animation. This property allows switching to a different `SpineResource`.
-     *
-     * @param value - The new `SpineResource` to be used for the current animation
-    */
-    set resource(value: SpineResource);
-}
-/**
- * @internal
- */
-export declare enum SpineAnimationUpdateFlags {
-    /** On Animation start play */
-    AnimationVolume = 2,
-    /** On skeleton data asset changed */
-    InitialVolume = 4
-}
-/**
- * @internal
- */
-export declare enum RendererUpdateFlags {
-    /** Include world position and world bounds. */
-    WorldVolume = 1
-}
-/**
- * Default state for spine animation.
- * Contains the default animation name to be played, whether this animation should loop,
- * the default skin name, and the default scale of the skeleton.
- */
-export declare class SpineAnimationDefaultConfig {
-    /**
-     * Whether the default animation should loop @defaultValue `true. The default animation should loop`
-     */
-    loop: boolean;
-    /**
-     * The name of the default animation @defaultValue `null. Do not play any animation by default`
-     */
-    animationName: string | null;
-    /**
-     * The name of the default skin @defaultValue `default`
-     */
-    skinName: string;
-    /**
-     * Creates an instance of default config
-     */
-    constructor(
-    /**
-     * Whether the default animation should loop @defaultValue `true. The default animation should loop`
-     */
-    loop?: boolean, 
-    /**
-     * The name of the default animation @defaultValue `null. Do not play any animation by default`
-     */
-    animationName?: string | null, 
-    /**
-     * The name of the default skin @defaultValue `default`
-     */
-    skinName?: string);
-}

package/types/src/SpineGenerator.d.ts

@@ -1,34 +0,0 @@
-import { BlendMode, Color, Skeleton } from "@esotericsoftware/spine-core";
-import { SubPrimitive, Texture2D } from "@galacean/engine";
-import { SpineAnimationRenderer } from "./SpineAnimationRenderer";
-import { AdaptiveTexture } from "./loader/LoaderUtils";
-import { ClearablePool } from "./util/ClearablePool";
-import { ReturnablePool } from "./util/ReturnablePool";
-declare class SubRenderItem {
-    subPrimitive: SubPrimitive;
-    blendMode: BlendMode;
-    texture: any;
-    slotName?: string;
-}
-export declare class SpineGenerator {
-    static QUAD_TRIANGLES: number[];
-    static VERTEX_SIZE: number;
-    static VERTEX_STRIDE: number;
-    static tempDark: Color;
-    static tempColor: Color;
-    static tempVerts: any[];
-    static tempBlendMode: BlendMode | null;
-    static tempTexture: AdaptiveTexture | null;
-    static subPrimitivePool: ReturnablePool<SubPrimitive>;
-    static subRenderItemPool: ClearablePool<SubRenderItem>;
-    private _clipper;
-    private _subRenderItems;
-    private _separateSlots;
-    private _separateSlotTextureMap;
-    buildPrimitive(skeleton: Skeleton, renderer: SpineAnimationRenderer, shouldUpdateBounds: boolean): void;
-    addSeparateSlot(slotName: string): void;
-    addSeparateSlotTexture(slotName: string, texture: Texture2D): void;
-    private _createMaterialForTexture;
-    private _expandByPoint;
-}
-export {};

package/types/src/index.d.ts

@@ -1,9 +0,0 @@
-import "./loader/SpineLoader";
-import "./loader/EditorSpineAtlasLoader";
-import BoundingBoxLine from "../example/outline";
-export { SpineAnimationRenderer } from "./SpineAnimationRenderer";
-export { SpineResource } from "./loader/SpineResource";
-export { createTextureAtlas } from "./loader/LoaderUtils";
-export { BoundingBoxLine };
-export * from "@esotericsoftware/spine-core";
-export declare const version = "__buildVersion";

package/types/src/loader/SpineLoader.d.ts

@@ -1,29 +0,0 @@
-import { AssetPromise, Loader, LoadItem, ResourceManager } from "@galacean/engine";
-import { SpineResource } from "./SpineResource";
-export type SpineAssetBundle = {
-    skeletonPath: string;
-    skeletonExtension: string;
-    skeletonTextData?: string | ArrayBuffer;
-    atlasPath: string;
-    imagePaths: string[];
-    imageExtensions: string[];
-};
-type SpineLoaderParams = {
-    fileExtensions?: string | string[];
-};
-type SpineLoadItem = LoadItem & {
-    params?: SpineLoaderParams;
-};
-export declare class SpineLoader extends Loader<SpineResource> {
-    static imageExtensions: string[];
-    static skeletonExtensions: string[];
-    static parseAndAssignSpineAsset(url: string, fileExtension: string | null, bundle: SpineAssetBundle): void;
-    static deriveAndAssignSpineAsset(url: string, fileExtension: string | null, bundle: SpineAssetBundle): void;
-    static verifyFileExtensions(fileExtensions: string | string[], expectArray: boolean): string | string[] | null;
-    static getUrlExtension(url: string, fileExtension: string): string | null;
-    load(item: SpineLoadItem, resourceManager: ResourceManager): AssetPromise<SpineResource>;
-    private _handleEditorAsset;
-    private _handleOriginAsset;
-    private _determineSkeletonDataType;
-}
-export {};

package/types/src/loader/SpineResource.d.ts

@@ -1,33 +0,0 @@
-import { AnimationStateData, SkeletonData } from "@esotericsoftware/spine-core";
-import { Engine, Entity, ReferResource } from "@galacean/engine";
-/**
- * Represents a resource that manages Spine animation data, textures, and entity templates for the Galacean engine.
- *
-*/
-export declare class SpineResource extends ReferResource {
-    /** The url of skeletonData. */
-    readonly url: string;
-    private _texturesInSpineAtlas;
-    private _skeletonData;
-    private _stateData;
-    private _template;
-    constructor(engine: Engine, skeletonData: SkeletonData, url?: string);
-    /**
-     * The skeleton data associated with this Spine resource.
-     */
-    get skeletonData(): SkeletonData;
-    /**
-     * The animation state data associated with this Spine resource.
-     */
-    get stateData(): AnimationStateData;
-    /**
-     * Creates and returns a new instance of the spine entity template.
-     * @returns A instance of the spine entity template
-     */
-    instantiate(): Entity;
-    protected _onDestroy(): void;
-    private _createTemplate;
-    private _associationTextureInSkeletonData;
-    private _disassociationSuperResource;
-    private _extractFileName;
-}

package/types/util/AttachmentTools.d.ts

@@ -1,24 +0,0 @@
-import { Attachment, MeshAttachment, RegionAttachment, TextureAtlasRegion } from "@esotericsoftware/spine-core";
-export declare class AttachmentTools {
-    /**
-     * Creates a new `RegionAttachment` from a specified texture atlas region.
-     *
-     * @param region - The texture atlas region used to create the attachment.
-     * @param attachmentName - The name of the new attachment.
-     * @param scale - A scaling factor applied to the attachment's dimensions (default is 1).
-     * @param rotation - The rotation angle of the attachment in degrees (default is 0).
-     * @returns The created `RegionAttachment` with the passed in region.
-     */
-    static createAttachmentFromRegion(region: TextureAtlasRegion, attachmentName: string, scale?: number, rotation?: number): RegionAttachment;
-    /**
-     * Clones an attachment (`RegionAttachment` or `MeshAttachment`) and applies a new texture atlas region.
-     *
-     * @param attachment - The attachment to clone (either `RegionAttachment` or `MeshAttachment`).
-     * @param atlasRegion - The new texture atlas region to associate with the cloned attachment.
-     * @param useOriginalRegionSize - Whether to retain the original region's size for the cloned attachment (default is `false`).
-     * @param scale - A scaling factor applied to the dimensions of the cloned attachment (default is 1).
-     * @param cloneMeshAsLinked - If `true`, clones a `MeshAttachment` as a linked mesh (default is `true`).
-     * @returns The cloned attachment with the specified properties and the new texture region.
-     */
-    static cloneAttachmentWithRegion(attachment: RegionAttachment | MeshAttachment, atlasRegion: TextureAtlasRegion, useOriginalRegionSize?: boolean, scale?: number, cloneMeshAsLinked?: boolean): Attachment;
-}

package/types/util/index.d.ts

@@ -1 +0,0 @@
-export { AttachmentTools } from "./AttachmentTools";