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

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.2.0-beta.1",
+  "version": "4.2.0-beta.3",
   "description": "galacean spine runtime",
   "name": "@galacean/engine-spine",
   "main": "dist/main.js",
@@ -9,7 +9,7 @@
     "@esotericsoftware/spine-core": "~4.2.1"
   },
   "peerDependencies": {
-    "@galacean/engine": ">=1.3.0-alpha.0"
+    "@galacean/engine": ">=1.3.20"
   },
   "devDependencies": {
     "@babel/core": "^7.22.5",
@@ -107,11 +107,12 @@
     "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": "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"
+    "b:types": "tsc --emitDeclarationOnly",
+    "b:all": "npm run b:types && npm run build"
   },
   "types": "types/index.d.ts",
   "repository": "https://github.com/johanzhu/engine-spine.git"

package/types/example/outline.d.ts

@@ -0,0 +1,11 @@
+import { Entity, MeshRenderer, Camera } from '@galacean/engine';
+export default class BoundingBoxLine extends MeshRenderer {
+    private attachedEntity;
+    private renderers;
+    private boundingBox;
+    constructor(entity: Entity);
+    updateBoundingBox(): void;
+    attachToEntity(entity: Entity): void;
+    private updateVertices;
+    _render(camera: Camera): void;
+}

package/types/loader/AdaptiveTexture.d.ts

@@ -0,0 +1,13 @@
+import { Texture, TextureFilter, TextureWrap } from "@esotericsoftware/spine-core";
+import { Texture2D } from "@galacean/engine";
+/**
+ * @internal
+ */
+export declare class AdaptiveTexture extends Texture {
+    constructor(image: Texture2D);
+    getImage(): Texture2D;
+    setFilters(minFilter: TextureFilter, magFilter: TextureFilter): void;
+    setWraps(uWrap: TextureWrap, vWrap: TextureWrap): void;
+    dispose(): void;
+    private _convertWrapMode;
+}

package/types/loader/SpineAtlasLoader.d.ts

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

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 spine resource. */
+    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/loader/SpineTexture.d.ts

@@ -0,0 +1,13 @@
+import { Texture, TextureFilter, TextureWrap } from "@esotericsoftware/spine-core";
+import { Texture2D } from "@galacean/engine";
+/**
+ * @internal
+ */
+export declare class SpineTexture extends Texture {
+    constructor(image: Texture2D);
+    getImage(): Texture2D;
+    setFilters(minFilter: TextureFilter, magFilter: TextureFilter): void;
+    setWraps(uWrap: TextureWrap, vWrap: TextureWrap): void;
+    dispose(): void;
+    private _convertWrapMode;
+}

package/types/loader/index.d.ts

@@ -0,0 +1,4 @@
+import "./SpineLoader";
+import "./SpineAtlasLoader";
+export { SpineResource } from "./SpineResource";
+export { LoaderUtils } from "./LoaderUtils";

package/types/renderer/SpineAnimationRenderer.d.ts

@@ -0,0 +1,177 @@
+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;
+    /**
+     * 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 */
+    _localBounds: BoundingBox;
+    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;
+    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 change */
+    Animation = 2
+}
+/**
+ * @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/renderer/SpineGenerator.d.ts

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

package/types/renderer/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/renderer/index.d.ts

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