@galacean/engine-spine 1.2.0 → 2.0.0-alpha.52

package/types/renderer/SpineAnimationRenderer.d.ts

@@ -0,0 +1,142 @@
+import { SpineSkeleton } from "../SpineSkeleton";
+import { SpineSlot } from "../SpineSlot";
+import { SpineAnimationState } from "../SpineAnimationState";
+import type { SpinePhysicsSupport } from "../SpinePhysics";
+import { Material, Renderer, Signal } 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 _defaultMaterials;
+    private static _textureProperty;
+    private static _sourceColorProperty;
+    private static _destinationColorProperty;
+    private static _sourceAlphaProperty;
+    private static _destinationAlphaProperty;
+    private static _positionVertexElement;
+    private static _lightColorVertexElement;
+    private static _uvVertexElement;
+    private static _darkColorVertexElement;
+    /** Called after time advances, before animations are applied. Use to prepare the base pose. */
+    readonly onBeforeApply: Signal<[SpineAnimationRenderer]>;
+    /** Called after animations are applied, before world transforms are solved. Use to edit local bone values. */
+    readonly onUpdateLocal: Signal<[SpineAnimationRenderer]>;
+    /**
+     * Called with evaluated world transforms, before the final constraint and physics solve.
+     * Use to edit local bone values based on world values. A listener enables an additional pose solve;
+     * physics simulation still advances only once per update.
+     */
+    readonly onUpdateWorld: Signal<[SpineAnimationRenderer]>;
+    /** Called after the final bone transforms are solved, before geometry is built. Use to read the final pose. */
+    readonly onUpdateComplete: Signal<[SpineAnimationRenderer]>;
+    /**
+     * Time multiplier for both animation playback and skeleton physics. Defaults to 1.
+     * Zero stops time advancement while still applying the pose and rendering.
+     * AnimationState and TrackEntry time scales multiply animation time independently.
+     */
+    timeScale: number;
+    /**
+     * The spacing between z layers in world units.
+     */
+    zSpacing: number;
+    private _tintBlack;
+    /**
+     * Whether to enable tint black feature for dark color tinting.
+     *
+     * @remarks Should be enabled when using "Tint Black" feature in Spine editor.
+     */
+    get tintBlack(): boolean;
+    set tintBlack(value: 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;
+    private _slotMaterials;
+    private _slotMaterialsDirty;
+    private _geometry;
+    private _batchShaderData;
+    private _skeleton;
+    private _state;
+    private _runtime;
+    private _physics;
+    private _publicSkeleton;
+    private _publicState;
+    /** Physics support for the bound skeleton, or null before an asset is assigned. */
+    get physics(): SpinePhysicsSupport | null;
+    /**
+     * The animation playback state of this renderer.
+     * Manage, blend, and transition between multiple simultaneous animations effectively.
+     */
+    get state(): SpineAnimationState;
+    /**
+     * The skeleton pose of this renderer.
+     * Manipulate bone positions, rotations, scaling
+     * and change spine attachment to customize character appearances dynamically during runtime.
+     */
+    get skeleton(): SpineSkeleton;
+    /** Set the default material used by slots without an override. */
+    setMaterial(material: Material | null): void;
+    /** Set a renderer material by index. Spine uses index 0 as its default material. */
+    setMaterial(index: number, material: Material | null): void;
+    /** Override a slot's material, or pass null to restore the renderer's default material. */
+    setMaterial(slot: SpineSlot, material: Material | null): void;
+    getMaterial(): Material | null;
+    getMaterial(index: number): Material | null;
+    /** Get a slot's effective material, including the renderer's default when no override is set. */
+    getMaterial(slot: SpineSlot): Material | null;
+    private _isCurrentState;
+    private _uploadGeometry;
+    private _getSlotIndex;
+    private _clearSlotMaterials;
+    private _buildGeometry;
+    private _clearBatchTextures;
+    private _setBatchBlend;
+    private _applyDefaultConfig;
+    /**
+     * Spine resource of this renderer, or null when unbound.
+     */
+    get resource(): SpineResource | null;
+    /**
+     * Bind a Spine resource, or assign null to clear its pose and playback.
+     *
+     * @param value - The resource to use, or null to unbind
+     */
+    set resource(value: SpineResource | null);
+}
+/**
+ * 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/renderer/SpineGeometry.d.ts

@@ -0,0 +1 @@
+export {};

package/types/renderer/SpineMaterial.d.ts

@@ -0,0 +1,10 @@
+import { Engine, Material, Shader } from "@galacean/engine";
+/**
+ * Material for Spine rendering. Defaults to the built-in `2D/Spine` shader.
+ * Texture and blend inputs are supplied per draw batch; tint is a renderer input.
+ * Inputs use straight alpha; the shader premultiplies its final linear output for the supplied blend factors.
+ */
+export declare class SpineMaterial extends Material {
+    constructor(engine: Engine, shader?: Shader);
+    clone(): SpineMaterial;
+}

package/types/renderer/index.d.ts

@@ -0,0 +1,2 @@
+export { SpineAnimationRenderer } from "./SpineAnimationRenderer";
+export { SpineMaterial } from "./SpineMaterial";

package/types/runtime/ISpineRuntime.d.ts

@@ -0,0 +1,4 @@
+import type { ISpineRuntime as ISpineRuntimeContract } from "@galacean/engine-design";
+import type { Texture2D } from "@galacean/engine";
+/** Backend contract specialized for engine textures. */
+export type ISpineRuntime = ISpineRuntimeContract<Texture2D>;

package/types/AntGSpineLoader.d.ts

@@ -1,22 +0,0 @@
-import { AssetPromise, Loader, LoadItem, ResourceManager, TextureWrapMode, Texture2D, Engine, Entity } from '@galacean/engine';
-import { AssetManager } from './spine-core/AssetManager';
-import { Texture } from './spine-core/Texture';
-type SpineOpt = {
-    scale: number;
-};
-type SpineLoadItem = LoadItem & SpineOpt;
-declare class SpineLoader extends Loader<Entity> {
-    load(item: SpineLoadItem, resourceManager: ResourceManager): AssetPromise<Entity>;
-    textureAssetPicker(assetManager: AssetManager, textureFile: string): any;
-    createAdaptiveTexture(img: any, engine: any): AdaptiveTexture;
-    checkUrl(url: string): boolean;
-    getExtFromUrl(url: string): string;
-}
-export declare class AdaptiveTexture extends Texture {
-    texture: Texture2D;
-    constructor(data: HTMLImageElement, engine: Engine);
-    setFilters(minFilter: any, magFilter: any): void;
-    setWraps(uWrap: TextureWrapMode, vWrap: TextureWrapMode): void;
-    dispose(): void;
-}
-export { SpineLoader };

package/types/SpineLoader.d.ts

@@ -1,32 +0,0 @@
-import { AssetPromise, Loader, LoadItem, ResourceManager, TextureWrapMode, Texture2D, Entity, AssetType } from "@galacean/engine";
-import { AssetManager } from "./spine-core/AssetManager";
-import { Texture } from "./spine-core/Texture";
-type SpineResouce = {
-    skeletonFile: string;
-    atlasFile: string;
-    textureFile?: string;
-    textureType?: AssetType;
-};
-type SpineOpt = {
-    scale: number;
-};
-type SpineLoadItem = LoadItem & SpineOpt;
-declare class SpineLoader extends Loader<Entity> {
-    load(item: SpineLoadItem, resourceManager: ResourceManager): AssetPromise<Entity>;
-    handleResource(resourceManager: ResourceManager, item: SpineLoadItem, resource: SpineResouce, resolve: any, reject: any): void;
-    textureAssetPicker(assetManager: AssetManager, textureFile: string): any;
-    createAdaptiveTexture(texture: Texture2D): AdaptiveTexture;
-    isBinFile(url: string): boolean;
-    checkUrl(url: string): boolean;
-    getResouceFromUrl(url: any): SpineResouce;
-    checkUrls(urls: string[]): boolean;
-    getResouceFromUrls(urls: string[], type?: AssetType): SpineResouce;
-    getExtFromUrl(url: string): string;
-}
-export declare class AdaptiveTexture extends Texture {
-    constructor(texture: Texture2D);
-    setFilters(minFilter: any, magFilter: any): void;
-    setWraps(uWrap: TextureWrapMode, vWrap: TextureWrapMode): void;
-    dispose(): void;
-}
-export { SpineLoader };

package/types/SpineMaterial.d.ts

@@ -1,6 +0,0 @@
-import { Engine, Material } from "@galacean/engine";
-export declare class SpineMaterial extends Material {
-    private static _spineVS;
-    private static _spineFS;
-    constructor(engine: Engine);
-}

package/types/SpineRenderer.d.ts

@@ -1,38 +0,0 @@
-import { Script, Entity } from "@galacean/engine";
-import { SpineAnimation } from "./SpineAnimation";
-export declare class SpineRenderer extends Script {
-    private _priority;
-    private _resource;
-    private _animationName;
-    private _loop;
-    private _paused;
-    private _autoPlay;
-    private _skinName;
-    private _scale;
-    private _spineAnimation;
-    /** @internal */
-    _animationNames: Array<string>;
-    /** @internal */
-    _skinNames: Array<string>;
-    get priority(): number;
-    set priority(value: number);
-    get resource(): Entity | null;
-    set resource(value: Entity | null);
-    get animationName(): string;
-    set animationName(name: string);
-    get loop(): boolean;
-    set loop(value: boolean);
-    get paused(): boolean;
-    set paused(value: boolean);
-    get autoPlay(): boolean;
-    set autoPlay(value: boolean);
-    get skinName(): string;
-    set skinName(name: string);
-    get scale(): number;
-    set scale(value: number);
-    get spineAnimation(): SpineAnimation;
-    onDestroy(): void;
-    play(name?: string, loop?: boolean): void;
-    _cloneTo(target: SpineRenderer): void;
-    private _removeResource;
-}

package/types/core/MeshGenerator.d.ts

@@ -1,43 +0,0 @@
-import { Engine, Entity, SubMesh, Texture2D } from "@galacean/engine";
-import { Skeleton } from "../spine-core/Skeleton";
-import { SkeletonData } from "../spine-core/SkeletonData";
-import { Color } from "../spine-core/Utils";
-import { SpineRenderSetting } from "../types";
-import { BlendMode } from "../spine-core/BlendMode";
-type SubMeshItem = {
-    subMesh: SubMesh;
-    blendMode: BlendMode;
-    texture: any;
-    slotName?: string;
-};
-export declare class MeshGenerator {
-    static QUAD_TRIANGLES: number[];
-    static VERTEX_SIZE: number;
-    static VERTEX_STRIDE: number;
-    static tempColor: Color;
-    static tempBlendMode: BlendMode | null;
-    private _setting;
-    private _engine;
-    private _entity;
-    private _clipper;
-    private _spineMesh;
-    private _vertexCount;
-    private _vertices;
-    private _verticesWithZ;
-    private _indices;
-    private _needResize;
-    private _meshRenderer;
-    private _subMeshItems;
-    readonly separateSlots: string[];
-    readonly separateSlotTextureMap: Map<string, Texture2D>;
-    get mesh(): import("@galacean/engine").BufferMesh;
-    get subMeshItems(): SubMeshItem[];
-    constructor(engine: Engine, entity: Entity);
-    initialize(skeletonData: SkeletonData, setting?: SpineRenderSetting): void;
-    buildMesh(skeleton: Skeleton): void;
-    addSeparateSlot(slotName: string): void;
-    addSeparateSlotTexture(slotName: string, texture: Texture2D): void;
-    private _prepareBufferData;
-    private setBlendMode;
-}
-export {};

package/types/core/SpineMesh.d.ts

@@ -1,11 +0,0 @@
-import { BufferMesh, Engine, Buffer } from '@galacean/engine';
-export declare class SpineMesh {
-    private _mesh;
-    private _indexBuffer;
-    private _vertexBuffer;
-    get mesh(): BufferMesh;
-    get indexBuffer(): Buffer;
-    get vertexBuffer(): Buffer;
-    initialize(engine: Engine, vertexCount: number): void;
-    changeBuffer(engine: Engine, vertexCount: number): void;
-}