@galacean/engine-spine 0.0.0-experimental-engine-spine-20241116 → 0.0.0-experimental-engine-spine-caifu.0

package/package.json

@@ -1,69 +1,69 @@
 {
-  "version": "0.0.0-experimental-engine-spine-20241116",
+  "version": "0.0.0-experimental-engine-spine-caifu.0",
   "description": "galacean spine runtime",
   "name": "@galacean/engine-spine",
   "main": "dist/main.js",
   "browser": "dist/browser.js",
   "module": "dist/module.js",
   "dependencies": {
-    "@esotericsoftware/spine-core": "~4.2.1"
+    "@esotericsoftware/spine-core": "~4.2.66"
   },
   "peerDependencies": {
-    "@galacean/engine": ">=1.3.20"
+    "@galacean/engine": ">=1.3.0-alpha.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.22.5",
-    "@babel/plugin-proposal-class-properties": "^7.12.1",
-    "@babel/plugin-proposal-decorators": "^7.12.1",
-    "@babel/plugin-proposal-optional-chaining": "^7.12.1",
-    "@babel/plugin-transform-class-properties": "^7.24.7",
-    "@babel/plugin-transform-object-assign": "^7.12.1",
-    "@babel/preset-env": "^7.24.8",
-    "@babel/preset-typescript": "^7.24.7",
-    "@galacean/engine": "^1.3.0-alpha.3",
+    "@babel/core": "^7.26.0",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-proposal-decorators": "^7.25.9",
+    "@babel/plugin-proposal-optional-chaining": "^7.21.0",
+    "@babel/plugin-transform-class-properties": "^7.25.9",
+    "@babel/plugin-transform-object-assign": "^7.25.9",
+    "@babel/preset-env": "^7.26.0",
+    "@babel/preset-typescript": "^7.26.0",
+    "@galacean/engine": "^1.3.11",
     "@galacean/engine-toolkit": "beta",
-    "@rollup/plugin-babel": "^5.2.1",
+    "@rollup/plugin-babel": "^5.3.1",
     "@rollup/plugin-commonjs": "^16.0.0",
-    "@rollup/plugin-inject": "^4.0.2",
+    "@rollup/plugin-inject": "^4.0.4",
     "@rollup/plugin-node-resolve": "^10.0.0",
-    "@rollup/plugin-replace": "^2.3.4",
-    "@rollup/plugin-terser": "^0.4.3",
-    "@swc/core": "^1.3.32",
-    "@swc/helpers": "^0.5",
-    "@types/chai": "^4.3.16",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.14.10",
-    "@vitejs/plugin-basic-ssl": "^1.1.0",
+    "@rollup/plugin-replace": "^2.4.2",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@swc/core": "^1.9.3",
+    "@swc/helpers": "^0.5.15",
+    "@types/chai": "^4.3.20",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.17.9",
+    "@vitejs/plugin-basic-ssl": "^1.2.0",
     "babel-core": "^6.26.3",
     "babel-jest": "^29.7.0",
-    "chai": "^4.3.6",
-    "chai-spies": "^1.0.0",
+    "chai": "^4.5.0",
+    "chai-spies": "^1.1.0",
     "cross-env": "^5.2.1",
-    "cypress": "^13.13.0",
+    "cypress": "^13.16.0",
     "cypress-recurse": "^1.35.3",
     "dat.gui": "^0.7.9",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-webgl-canvas-mock": "^2.5.3",
-    "nock": "^13.5.4",
-    "odiff-bin": "^3.0.1",
+    "nock": "^13.5.6",
+    "odiff-bin": "^3.2.0",
     "react": "^16.14.0",
     "react-dom": "^16.14.0",
     "regenerator-runtime": "^0.14.1",
-    "rollup": "^2.32.0",
-    "rollup-plugin-glslify": "^1.2.0",
+    "rollup": "^2.79.2",
+    "rollup-plugin-glslify": "^1.3.1",
     "rollup-plugin-modify": "^3.0.0",
-    "rollup-plugin-serve": "^1.1.0",
-    "rollup-plugin-swc3": "^0.8.0",
+    "rollup-plugin-serve": "^1.1.1",
+    "rollup-plugin-swc3": "^0.8.2",
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-version-injector": "^1.3.3",
-    "sass": "^1.77.8",
-    "sinon": "^18.0.0",
-    "ts-jest": "^29.2.2",
+    "sass": "^1.81.1",
+    "sinon": "^18.0.1",
+    "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.5.3",
-    "vite": "^5.3.4"
+    "typescript": "^5.7.2",
+    "vite": "^5.4.11"
   },
   "ci": {
     "type": "aci",

package/types/SpineAnimationRenderer.d.ts

@@ -1,6 +1,6 @@
-import { Skeleton, AnimationState } from "@esotericsoftware/spine-core";
+import { Skeleton, SkeletonData, AnimationState, AnimationStateData } from "@esotericsoftware/spine-core";
 import { Buffer, Renderer, Entity, Material, Engine, BoundingBox, Primitive, SubPrimitive } from "@galacean/engine";
-import { SpineResource } from "./loader/SpineResource";
+import { SkeletonDataResource } from "./loader/SkeletonDataResource";
 /**
  * Spine animation renderer, capable of rendering spine animations and providing functions for animation and skeleton manipulation.
  */
@@ -13,20 +13,17 @@ export declare class SpineAnimationRenderer extends Renderer {
     /** @internal */
     static _materialCache: Map<string, Material>;
     /** @internal */
+    static _animationDataCache: Map<SkeletonData, AnimationStateData>;
+    /** @internal */
     static _getDefaultMaterial(engine: Engine): Material;
-    /**
-     * The spacing between z layers.
-     */
-    zSpacing: number;
-    /**
-     * Whether to premultiplied alpha for texture.
-     */
-    premultipliedAlpha: boolean;
+    /** Render setting for spine rendering. */
+    setting: SpineRenderSetting;
     /**
      * Default state for spine animation.
-     * Contains the default animation name to be played, whether this animation should loop, the default skin name.
+     * Contains the default animation name to be played, whether this animation should loop,
+     * the default skin name, and the default scale of the skeleton.
      */
-    readonly defaultConfig: SpineAnimationDefaultConfig;
+    defaultState: DefaultState;
     /** @internal */
     _primitive: Primitive;
     /** @internal */
@@ -44,18 +41,22 @@ export declare class SpineAnimationRenderer extends Renderer {
     /** @internal */
     _vertexCount: number;
     /** @internal */
-    _resource: SpineResource;
+    _resource: SkeletonDataResource;
     private _skeleton;
     private _state;
-    private _needsInitialize;
     /**
-     * The Spine.AnimationState object of this SpineAnimationRenderer.
-     * Manage, blend, and transition between multiple simultaneous animations effectively.
+     * Spine resource of current spine animation.This property allows you to switch between different animations at runtime.
+     */
+    get resource(): SkeletonDataResource;
+    set resource(value: SkeletonDataResource);
+    /**
+     * Provides access to `AnimationState` which controls animation playback on a skeleton.
+     * You can use its API to manage, blend, and transition between multiple simultaneous animations effectively.
      */
     get state(): AnimationState;
     /**
-     * The Spine.Skeleton object of this SpineAnimationRenderer.
-     * Manipulate bone positions, rotations, scaling
+     * Provides access to `Skeleton`, which defines the structure of a Spine model.
+     * Through its API, users can manipulate bone positions, rotations, scaling
      * and change spine attachment to customize character appearances dynamically during runtime.
      */
     get skeleton(): Skeleton;
@@ -63,6 +64,10 @@ export declare class SpineAnimationRenderer extends Renderer {
      * @internal
      */
     constructor(entity: Entity);
+    /**
+     * Separate slot by slot name. This will add a new sub primitive, and new materials.
+     */
+    addSeparateSlot(slotName: string): void;
     /**
      * @internal
      */
@@ -83,14 +88,6 @@ export declare class SpineAnimationRenderer extends Renderer {
      * @internal
      */
     _calculateGeneratorBounds(worldBounds: BoundingBox): void;
-    /**
-     * @internal
-     */
-    _setSkeleton(skeleton: Skeleton): void;
-    /**
-     * @internal
-     */
-    _setState(state: AnimationState): void;
     /**
      * @internal
      */
@@ -102,7 +99,7 @@ export declare class SpineAnimationRenderer extends Renderer {
     /**
      * @internal
      */
-    _createAndBindBuffer(vertexCount: number): void;
+    _createBuffer(vertexCount: number): void;
     /**
      * @internal
      */
@@ -123,23 +120,10 @@ export declare class SpineAnimationRenderer extends Renderer {
      * @internal
      */
     _onWorldVolumeChanged(): void;
-    private _initialize;
     private _onAnimationStart;
     private _onAnimationComplete;
     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);
+    private _initializeDefaultState;
 }
 /**
  * @internal
@@ -159,12 +143,41 @@ export declare enum RendererUpdateFlags {
     /** Include world position and world bounds. */
     WorldVolume = 1
 }
+/**
+ * Render setting for spine rendering.
+ */
+export declare class SpineRenderSetting {
+    /**
+     * The spacing between z layers @defaultValue `0.01`
+     */
+    zSpacing: number;
+    /**
+     * Whether to use clipping @defaultValue `true`
+     */
+    useClipping: boolean;
+    /**
+     * Creates an instance of SpineRenderSetting.
+     */
+    constructor(
+    /**
+     * The spacing between z layers @defaultValue `0.01`
+     */
+    zSpacing?: number, 
+    /**
+     * Whether to use clipping @defaultValue `true`
+     */
+    useClipping?: boolean);
+}
 /**
  * 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 {
+export declare class DefaultState {
+    /**
+     * The default scale of the animation @defaultValue `1`
+     */
+    scale: number;
     /**
      * Whether the default animation should loop @defaultValue `true. The default animation should loop`
      */
@@ -178,9 +191,13 @@ export declare class SpineAnimationDefaultConfig {
      */
     skinName: string;
     /**
-     * Creates an instance of default config
+     * Creates an instance of DefaultState
      */
     constructor(
+    /**
+     * The default scale of the animation @defaultValue `1`
+     */
+    scale?: number, 
     /**
      * Whether the default animation should loop @defaultValue `true. The default animation should loop`
      */

package/types/SpineGenerator.d.ts

@@ -1,5 +1,5 @@
 import { Texture2D, SubPrimitive, BoundingBox } from "@galacean/engine";
-import { Skeleton, Color, BlendMode } from "@esotericsoftware/spine-core";
+import { Skeleton, Color, BlendMode, SkeletonData } from "@esotericsoftware/spine-core";
 import { SpineAnimationRenderer } from "./SpineAnimationRenderer";
 import { AdaptiveTexture } from "./loader/LoaderUtils";
 import { ReturnablePool } from "./util/ReturnablePool";
@@ -26,10 +26,13 @@ export declare class SpineGenerator {
     private _subRenderItems;
     private _separateSlots;
     private _separateSlotTextureMap;
+    getMaxVertexCount(skeletonData: SkeletonData): number;
     buildPrimitive(skeleton: Skeleton, renderer: SpineAnimationRenderer): void;
     addSeparateSlot(slotName: string): void;
     addSeparateSlotTexture(slotName: string, texture: Texture2D): void;
     private _createMaterialForTexture;
     private _expandByPoint;
+    private _collectUniqueAttachments;
+    private _calculateTotalVertexCount;
 }
 export {};

package/types/index.d.ts

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

package/types/loader/SkeletonDataResource.d.ts

@@ -1,4 +1,4 @@
-import { SkeletonData } from "../spine-core";
+import { SkeletonData } from "@esotericsoftware/spine-core";
 import { Engine, ReferResource, Texture2D } from "@galacean/engine";
 export declare class SkeletonDataResource extends ReferResource {
     readonly textures: Texture2D[];

package/types/loader/SpineLoader.d.ts

@@ -1,5 +1,5 @@
 import { AssetPromise, Loader, LoadItem, ResourceManager } from "@galacean/engine";
-import { SpineResource } from "./SpineResource";
+import { SkeletonDataResource } from "./SkeletonDataResource";
 export type SpineAssetBundle = {
     skeletonPath: string;
     skeletonExtension: string;
@@ -14,14 +14,14 @@ type SpineLoaderParams = {
 type SpineLoadItem = LoadItem & {
     params?: SpineLoaderParams;
 };
-export declare class SpineLoader extends Loader<SpineResource> {
+export declare class SpineLoader extends Loader<SkeletonDataResource> {
     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>;
+    load(item: SpineLoadItem, resourceManager: ResourceManager): AssetPromise<SkeletonDataResource>;
     private _handleEditorAsset;
     private _handleOriginAsset;
     private _determineSkeletonDataType;

package/types/util/AttachmentTools.d.ts

@@ -0,0 +1,22 @@
+import { Attachment, MeshAttachment, RegionAttachment, TextureAtlasRegion } from "@esotericsoftware/spine-core";
+/**
+ * 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.
+ */
+export declare function 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.
+ */
+export declare function cloneAttachmentWithRegion(attachment: RegionAttachment | MeshAttachment, atlasRegion: TextureAtlasRegion, useOriginalRegionSize?: boolean, scale?: number, cloneMeshAsLinked?: boolean): Attachment;

package/types/util/BlendMode.d.ts

@@ -1,4 +1,4 @@
 import { BlendMode } from "@esotericsoftware/spine-core";
 import { Material } from "@galacean/engine";
-export declare function setBlendMode(material: Material, blendMode: BlendMode, premultipliedAlpha: boolean): void;
+export declare function setBlendMode(material: Material, blendMode: BlendMode): void;
 export declare function getBlendMode(material: Material): BlendMode;

package/types/util/BufferReader.d.ts

@@ -1,10 +1,8 @@
 export declare class BufferReader {
+    data: Uint8Array;
     private _dataView;
     private _position;
-    private _data;
-    constructor(data?: Uint8Array, byteOffset?: number, byteLength?: number);
-    init(data: Uint8Array, byteOffset?: number, byteLength?: number): void;
-    reset(): void;
+    constructor(data: Uint8Array, byteOffset?: number, byteLength?: number);
     nextUint16(): number;
     nextStr(): string;
     nextImageData(): Uint8Array;