@galacean/engine-spine 0.0.0-experimental-engine-spine-20240821 → 0.0.0-experimental-engine-spine-20241104

package/package.json

@@ -1,21 +1,25 @@
 {
-  "version": "0.0.0-experimental-engine-spine-20240821",
+  "version": "0.0.0-experimental-engine-spine-20241104",
   "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"
+  },
   "peerDependencies": {
-    "@galacean/engine": ">=1.3.0-alpha.0"
+    "@galacean/engine": ">=1.3.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.12.1",
-    "@babel/preset-typescript": "^7.12.1",
+    "@babel/preset-env": "^7.24.8",
+    "@babel/preset-typescript": "^7.24.7",
     "@galacean/engine": "^1.3.0-alpha.3",
     "@galacean/engine-toolkit": "beta",
     "@rollup/plugin-babel": "^5.2.1",
@@ -26,10 +30,26 @@
     "@rollup/plugin-terser": "^0.4.3",
     "@swc/core": "^1.3.32",
     "@swc/helpers": "^0.5",
-    "cross-env": "^5.2.0",
+    "@types/chai": "^4.3.16",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.14.10",
+    "@vitejs/plugin-basic-ssl": "^1.1.0",
+    "babel-core": "^6.26.3",
+    "babel-jest": "^29.7.0",
+    "chai": "^4.3.6",
+    "chai-spies": "^1.0.0",
+    "cross-env": "^5.2.1",
+    "cypress": "^13.13.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",
     "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-plugin-modify": "^3.0.0",
@@ -37,8 +57,13 @@
     "rollup-plugin-swc3": "^0.8.0",
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-version-injector": "^1.3.3",
-    "typescript": "^4.8.4",
-    "vite": "^4.3.9"
+    "sass": "^1.77.8",
+    "sinon": "^18.0.0",
+    "ts-jest": "^29.2.2",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.5.3",
+    "vite": "^5.3.4"
   },
   "ci": {
     "type": "aci",
@@ -48,10 +73,39 @@
     "types",
     "dist"
   ],
+  "jest": {
+    "runner": "jest-runner",
+    "testEnvironment": "jsdom",
+    "testEnvironmentOptions": {
+      "url": "https://mdn.alipayobjects.com/",
+      "userAgent": "Agent/007"
+    },
+    "preset": "ts-jest",
+    "collectCoverage": true,
+    "testRegex": "(/tests/.*\\.(test|spec))\\.ts?$",
+    "collectCoverageFrom": [
+      "src/**/*.ts"
+    ],
+    "transform": {
+      "^.+\\.js$": "babel-jest",
+      "^.+\\.ts$": "ts-jest"
+    },
+    "transformIgnorePatterns": [
+      "node_modules/(?!(.*@esotericsoftware/spine-core.*))"
+    ],
+    "setupFilesAfterEnv": [
+      "./jest.setup.ts",
+      "jest-webgl-canvas-mock"
+    ]
+  },
   "scripts": {
     "example": "vite",
     "test": "jest",
-    "test-cov": "jest --coverage",
+    "test:cov": "jest --coverage",
+    "test:debug": "cross-env DEBUG_MODE=1 jest",
+    "e2e:case": "vite serve ./e2e/.dev --config ./e2e/.dev/vite.config.js",
+    "e2e": "cypress run --browser chrome --headless",
+    "e2e:debug": "cypress open",
     "dev": "rollup -cw",
     "build": "npm run b:types && cross-env BUILD_TYPE=ALL rollup -c",
     "build:watch": "npm run b:types && cross-env BUILD_TYPE=ALL rollup -c --watch",
@@ -60,5 +114,9 @@
     "b:types": "tsc --emitDeclarationOnly"
   },
   "types": "types/index.d.ts",
-  "repository": "https://github.com/johanzhu/engine-spine.git"
+  "repository": "https://github.com/johanzhu/engine-spine.git",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
 }

package/types/SpineAnimationRenderer.d.ts

@@ -1,6 +1,6 @@
-import { Skeleton, SkeletonData, AnimationState, AnimationStateData } from "./spine-core";
+import { Skeleton, AnimationState } from "@esotericsoftware/spine-core";
 import { Buffer, Renderer, Entity, Material, Engine, BoundingBox, Primitive, SubPrimitive } from "@galacean/engine";
-import { SkeletonDataResource } from "./loader/SkeletonDataResource";
+import { SpineResource } from "./loader/SpineResource";
 /**
  * Spine animation renderer, capable of rendering spine animations and providing functions for animation and skeleton manipulation.
  */
@@ -13,17 +13,20 @@ export declare class SpineAnimationRenderer extends Renderer {
     /** @internal */
     static _materialCache: Map<string, Material>;
     /** @internal */
-    static _animationDataCache: Map<SkeletonData, AnimationStateData>;
-    /** @internal */
     static _getDefaultMaterial(engine: Engine): Material;
-    /** Render setting for spine rendering. */
-    setting: SpineRenderSetting;
+    /**
+     * The spacing between z layers.
+     */
+    zSpacing: number;
+    /**
+     * Whether to premultiplied alpha for texture.
+     */
+    premultipliedAlpha: 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.
+     * Contains the default animation name to be played, whether this animation should loop, the default skin name.
      */
-    defaultState: DefaultState;
+    readonly defaultConfig: SpineAnimationDefaultConfig;
     /** @internal */
     _primitive: Primitive;
     /** @internal */
@@ -41,22 +44,18 @@ export declare class SpineAnimationRenderer extends Renderer {
     /** @internal */
     _vertexCount: number;
     /** @internal */
-    _resource: SkeletonDataResource;
+    _resource: SpineResource;
     private _skeleton;
     private _state;
+    private _needsInitialize;
     /**
-     * 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.
+     * The Spine.AnimationState object of this SpineAnimationRenderer.
+     * Manage, blend, and transition between multiple simultaneous animations effectively.
      */
     get state(): AnimationState;
     /**
-     * Provides access to `Skeleton`, which defines the structure of a Spine model.
-     * Through its API, users can manipulate bone positions, rotations, scaling
+     * 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;
@@ -64,10 +63,6 @@ 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
      */
@@ -88,6 +83,14 @@ export declare class SpineAnimationRenderer extends Renderer {
      * @internal
      */
     _calculateGeneratorBounds(worldBounds: BoundingBox): void;
+    /**
+     * @internal
+     */
+    _setSkeleton(skeleton: Skeleton): void;
+    /**
+     * @internal
+     */
+    _setState(state: AnimationState): void;
     /**
      * @internal
      */
@@ -99,7 +102,7 @@ export declare class SpineAnimationRenderer extends Renderer {
     /**
      * @internal
      */
-    _createBuffer(vertexCount: number): void;
+    _createAndBindBuffer(vertexCount: number): void;
     /**
      * @internal
      */
@@ -120,10 +123,23 @@ export declare class SpineAnimationRenderer extends Renderer {
      * @internal
      */
     _onWorldVolumeChanged(): void;
+    private _initialize;
     private _onAnimationStart;
     private _onAnimationComplete;
     private _clearMaterialCache;
-    private _initializeDefaultState;
+    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
@@ -143,41 +159,12 @@ 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 DefaultState {
-    /**
-     * The default scale of the animation @defaultValue `1`
-     */
-    scale: number;
+export declare class SpineAnimationDefaultConfig {
     /**
      * Whether the default animation should loop @defaultValue `true. The default animation should loop`
      */
@@ -191,13 +178,9 @@ export declare class DefaultState {
      */
     skinName: string;
     /**
-     * Creates an instance of DefaultState
+     * Creates an instance of default config
      */
     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, SkeletonData } from "./spine-core";
+import { Skeleton, Color, BlendMode } from "@esotericsoftware/spine-core";
 import { SpineAnimationRenderer } from "./SpineAnimationRenderer";
 import { AdaptiveTexture } from "./loader/LoaderUtils";
 import { ReturnablePool } from "./util/ReturnablePool";
@@ -26,13 +26,10 @@ 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 { SkeletonDataResource } from "./loader/SkeletonDataResource";
+export { SpineResource } from "./loader/SpineResource";
 export { createTextureAtlas } from "./loader/LoaderUtils";
-export * from "../src/spine-core";
+export * from "@esotericsoftware/spine-core";
 export declare const version = "__buildVersion";

package/types/loader/EditorSpineAtlasLoader.d.ts

@@ -1,5 +1,5 @@
 import { AssetPromise, Loader, ResourceManager, LoadItem } from "@galacean/engine";
-import { TextureAtlas } from "../spine-core";
+import { TextureAtlas } from "@esotericsoftware/spine-core";
 declare class EditorSpineAtlasLoader extends Loader<TextureAtlas> {
     load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<TextureAtlas>;
 }

package/types/loader/LoaderUtils.d.ts

@@ -1,5 +1,5 @@
 import { AssetPromise, Engine, Texture2D } from "@galacean/engine";
-import { TextureAtlas, SkeletonData, Texture, TextureFilter, TextureWrap } from "../spine-core";
+import { TextureAtlas, SkeletonData, Texture, TextureFilter, TextureWrap } from "@esotericsoftware/spine-core";
 export declare function createSkeletonData(textureAtlas: TextureAtlas, skeletonTextData: string | ArrayBuffer, skeletonFileType: 'json' | 'skel'): SkeletonData;
 export declare function loadTexturesByPath(imagePaths: string[], imageExtensions: string[], engine: Engine): Promise<Texture2D[]>;
 export declare function loadTextureAtlas(atlasPath: string, engine: Engine): Promise<TextureAtlas>;

package/types/loader/SpineLoader.d.ts

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

package/types/loader/SpineResource.d.ts

@@ -0,0 +1,33 @@
+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/BlendMode.d.ts

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