@galacean/engine-spine 0.0.0-experimental-6d3110b4d9-20240531

package/package.json

@@ -0,0 +1,67 @@
+{
+  "version": "0.0.0-experimental-6d3110b4d9-20240531",
+  "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"
+  },
+  "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-object-assign": "^7.12.1",
+    "@babel/preset-env": "^7.12.1",
+    "@babel/preset-typescript": "^7.12.1",
+    "@galacean/engine": "1.3.0-alpha.0",
+    "@galacean/engine-toolkit": "beta",
+    "@rollup/plugin-babel": "^5.2.1",
+    "@rollup/plugin-commonjs": "^16.0.0",
+    "@rollup/plugin-inject": "^4.0.2",
+    "@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",
+    "cross-env": "^5.2.0",
+    "dat.gui": "^0.7.9",
+    "react": "^16.14.0",
+    "react-dom": "^16.14.0",
+    "rollup": "^2.32.0",
+    "rollup-plugin-glslify": "^1.2.0",
+    "rollup-plugin-modify": "^3.0.0",
+    "rollup-plugin-serve": "^1.1.0",
+    "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"
+  },
+  "ci": {
+    "type": "aci",
+    "versions": "12"
+  },
+  "files": [
+    "types",
+    "dist"
+  ],
+  "scripts": {
+    "example": "vite",
+    "test": "jest",
+    "test-cov": "jest --coverage",
+    "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",
+    "ci": "npm run lint && npm run test-cov",
+    "lint": "eslint src --fix --ext .ts,.tsx",
+    "b:types": "tsc --emitDeclarationOnly"
+  },
+  "types": "types/index.d.ts",
+  "repository": "https://github.com/johanzhu/engine-spine.git"
+}

package/types/SpineAnimation.d.ts

@@ -0,0 +1,64 @@
+import { Skeleton, SkeletonData, AnimationState } from "@esotericsoftware/spine-core";
+import { SpineGenerator } from "./core/SpineGenerator";
+import { SpineRenderSetting } from "./types";
+import { Renderer, Entity, Material, Engine, BoundingBox, Primitive } from "@galacean/engine";
+import { SubPrimitive } from "./core/SpinePrimitive";
+interface InitialState {
+    animationName: string;
+    skinName: string;
+    loop: boolean;
+    scale: number;
+}
+export declare class SpineAnimation extends Renderer {
+    private static _defaultMaterial;
+    private static _uvMacro;
+    private static _enableVertexColorMacro;
+    private static _tempOffset;
+    private static _tempSize;
+    private static _tempArray;
+    static getDefaultMaterial(engine: Engine): Material;
+    setting: SpineRenderSetting;
+    initialState: InitialState;
+    _primitive: Primitive;
+    _subPrimitives: SubPrimitive[];
+    protected _skeleton: Skeleton;
+    protected _state: AnimationState;
+    protected _spineGenerator: SpineGenerator;
+    set skeletonData(value: SkeletonData);
+    get state(): AnimationState;
+    get skeleton(): Skeleton;
+    constructor(entity: Entity);
+    /**
+     * @internal
+     */
+    _onAwake(): void;
+    /**
+     * Separate slot by slot name. This will add a new sub primitive, and new materials.
+     */
+    addSeparateSlot(slotName: string): void;
+    /**
+     * @internal
+     */
+    update(delta: number): void;
+    /**
+     * @internal
+     */
+    _updateRendererShaderData(context: any): void;
+    /**
+     * @internal
+     */
+    protected _render(context: any): void;
+    /**
+     * @internal
+     */
+    protected _updateBounds(worldBounds: BoundingBox): void;
+    /**
+     * @internal
+     */
+    _cloneTo(target: SpineAnimation, srcRoot: Entity, targetRoot: Entity): void;
+    /**
+     * @internal
+     */
+    protected _onDestroy(): void;
+}
+export {};

package/types/SpineMaterial.d.ts

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

package/types/core/MeshGenerator.d.ts

@@ -0,0 +1,43 @@
+import { Engine, SubMesh, Texture2D } from "@galacean/engine";
+import { Skeleton, SkeletonData, Color, BlendMode } from "@esotericsoftware/spine-core";
+import { SpineRenderSetting } from "../types";
+import { AdaptiveTexture } from "../loader/LoaderUtils";
+import { SpineAnimation } from "../SpineAnimation";
+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 tempDark: Color;
+    static tempBlendMode: BlendMode | null;
+    static tempTexture: AdaptiveTexture | null;
+    private _setting;
+    private _engine;
+    private _clipper;
+    private _spineMesh;
+    private _renderer;
+    private _vertexCount;
+    private _vertices;
+    private _verticesWithZ;
+    private _indices;
+    private _needResize;
+    private _subMeshItems;
+    readonly separateSlots: string[];
+    readonly separateSlotTextureMap: Map<string, Texture2D>;
+    get mesh(): import("@galacean/engine").BufferMesh;
+    get subMeshItems(): SubMeshItem[];
+    constructor(engine: Engine, renderer: SpineAnimation);
+    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/SpineGenerator.d.ts

@@ -0,0 +1,43 @@
+import { Engine, Texture2D } from "@galacean/engine";
+import { Skeleton, SkeletonData, Color, BlendMode } from "@esotericsoftware/spine-core";
+import { SubPrimitive } from "./SpinePrimitive";
+import { SpineRenderSetting } from "../types";
+import { AdaptiveTexture } from "../loader/LoaderUtils";
+import { SpineAnimation } from "../SpineAnimation";
+type subRenderItems = {
+    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 tempColor: Color;
+    static tempDark: Color;
+    static tempBlendMode: BlendMode | null;
+    static tempTexture: AdaptiveTexture | null;
+    private _setting;
+    private _engine;
+    private _clipper;
+    private _spinePrimitive;
+    private _renderer;
+    private _vertexCount;
+    private _vertices;
+    private _verticesWithZ;
+    private _indices;
+    private _needResize;
+    private _subRenderItems;
+    readonly separateSlots: string[];
+    readonly separateSlotTextureMap: Map<string, Texture2D>;
+    get subRenderItems(): subRenderItems[];
+    constructor(engine: Engine, renderer: SpineAnimation);
+    initialize(skeletonData: SkeletonData, setting?: SpineRenderSetting): void;
+    buildPrimitive(skeleton: Skeleton): void;
+    addSeparateSlot(slotName: string): void;
+    addSeparateSlotTexture(slotName: string, texture: Texture2D): void;
+    private _prepareBufferData;
+    private setBlendMode;
+}
+export {};

package/types/core/SpineMesh.d.ts

@@ -0,0 +1,11 @@
+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;
+}

package/types/core/SpinePrimitive.d.ts

@@ -0,0 +1,23 @@
+import { Engine, Buffer, MeshTopology } from '@galacean/engine';
+export declare class SubPrimitive {
+    /** Start drawing offset. */
+    start: number;
+    /** Drawing count. */
+    count: number;
+    /** Drawing topology. */
+    topology?: MeshTopology;
+}
+export declare class SpinePrimitive {
+    private _primitive;
+    private _subPrimitive;
+    private _indexBuffer;
+    private _vertexBuffer;
+    get primitive(): Primitive;
+    get subPrimitive(): SubPrimitive[];
+    get indexBuffer(): Buffer;
+    get vertexBuffer(): Buffer;
+    initialize(engine: Engine, vertexCount: number): void;
+    addSubPrimitive(subPrimitive: SubPrimitive): void;
+    clearSubPrimitive(): void;
+    changeBuffer(engine: Engine, vertexCount: number): void;
+}

package/types/index.d.ts

@@ -0,0 +1,7 @@
+import "./loader/SpineLoader";
+import "./loader/EditorSkeletonDataLoader";
+import "./loader/EditorSpineAtlasLoader";
+export { SpineAnimation } from "./SpineAnimation";
+export * from "@esotericsoftware/spine-core";
+export { generateTextureAtlas } from "./loader/LoaderUtils";
+export declare const version = "__buildVersion";

package/types/loader/BufferReader.d.ts

@@ -0,0 +1,9 @@
+export declare class BufferReader {
+    data: Uint8Array;
+    private _dataView;
+    private _position;
+    constructor(data: Uint8Array, byteOffset?: number, byteLength?: number);
+    nextUint16(): number;
+    nextStr(): string;
+    nextImageData(): Uint8Array;
+}

package/types/loader/EditorSkeletonDataLoader.d.ts

@@ -0,0 +1,6 @@
+import { AssetPromise, Loader, LoadItem, ResourceManager } from "@galacean/engine";
+import { SkeletonData } from "@esotericsoftware/spine-core";
+declare class EditorSkeletonDataLoader extends Loader<SkeletonData> {
+    load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<SkeletonData>;
+}
+export { EditorSkeletonDataLoader };

package/types/loader/EditorSpineAtlasLoader.d.ts

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

package/types/loader/LoaderUtils.d.ts

@@ -0,0 +1,16 @@
+import { Engine, Texture2D } from "@galacean/engine";
+import { TextureAtlas, SkeletonData, Texture, TextureFilter, TextureWrap } from "@esotericsoftware/spine-core";
+import { SpineAssetBundle } from "./SpineLoader";
+export declare function loadAndCreateSpineSkeletonData(bundle: SpineAssetBundle, engine: Engine): Promise<SkeletonData>;
+export declare function generateTextureAtlas(atlasText: string, textureMap: Record<string, Texture2D>): TextureAtlas;
+export declare function getBaseUrl(url: string): string;
+export declare class AdaptiveTexture extends Texture {
+    texture: Texture2D;
+    constructor(image: HTMLImageElement | ImageBitmap, texture: Texture2D);
+    getImage(): any;
+    setFilters(minFilter: TextureFilter, magFilter: TextureFilter): void;
+    setWraps(uWrap: TextureWrap, vWrap: TextureWrap): void;
+    dispose(): void;
+    private _convertWrapMode;
+}
+export declare function getUrlExtension(url: string, fileExtension: string): string | null;

package/types/loader/SpineLoader.d.ts

@@ -0,0 +1,21 @@
+import { AssetPromise, Loader, LoadItem, ResourceManager } from "@galacean/engine";
+import { SkeletonData } from "@esotericsoftware/spine-core";
+export type SpineAssetBundle = {
+    skeletonPath: string;
+    skeletonExtension: string;
+    atlasPath: string;
+    imagePaths: string[];
+    imageExtensions: string[];
+};
+type SpineLoaderParams = {
+    fileExtensions?: string | string[];
+};
+type SpineLoadItem = LoadItem & {
+    params?: SpineLoaderParams;
+};
+declare class SpineLoader extends Loader<SkeletonData> {
+    static imageExtensions: string[];
+    static skeletonExtensions: string[];
+    load(item: SpineLoadItem, resourceManager: ResourceManager): AssetPromise<SkeletonData>;
+}
+export { SpineLoader };

package/types/types.d.ts

@@ -0,0 +1,4 @@
+export type SpineRenderSetting = {
+    useClipping: boolean;
+    zSpacing: number;
+};