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

package/types/spine-core/vertexeffects/JitterEffect.d.ts

@@ -0,0 +1,11 @@
+import { VertexEffect } from "../VertexEffect";
+import { Skeleton } from "../Skeleton";
+import { Color, Vector2 } from "../Utils";
+export declare class JitterEffect implements VertexEffect {
+    jitterX: number;
+    jitterY: number;
+    constructor(jitterX: number, jitterY: number);
+    begin(skeleton: Skeleton): void;
+    transform(position: Vector2, uv: Vector2, light: Color, dark: Color): void;
+    end(): void;
+}

package/types/spine-core/vertexeffects/SwirlEffect.d.ts

@@ -0,0 +1,16 @@
+import { VertexEffect } from "../VertexEffect";
+import { PowOut, Color, Vector2 } from "../Utils";
+import { Skeleton } from "../Skeleton";
+export declare class SwirlEffect implements VertexEffect {
+    static interpolation: PowOut;
+    centerX: number;
+    centerY: number;
+    radius: number;
+    angle: number;
+    private worldX;
+    private worldY;
+    constructor(radius: number);
+    begin(skeleton: Skeleton): void;
+    transform(position: Vector2, uv: Vector2, light: Color, dark: Color): void;
+    end(): void;
+}

package/types/util/BlendMode.d.ts

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

package/types/SpineAnimation.d.ts

@@ -1,147 +0,0 @@
-import { Skeleton, SkeletonData, AnimationState, AnimationStateData } from "@esotericsoftware/spine-core";
-import { Buffer, Renderer, Entity, Material, Engine, BoundingBox, Primitive, SubPrimitive } from "@galacean/engine";
-import { SkeletonDataResource } from "./loader/SkeletonDataResource";
-interface DefaultState {
-    animationName: string;
-    skinName: string;
-    loop: boolean;
-    scale: number;
-}
-export type SpineRenderSetting = {
-    useClipping: boolean;
-    zSpacing: number;
-};
-export declare class SpineAnimation extends Renderer {
-    private static _defaultMaterial;
-    private static _spineGenerator;
-    private static positionVertexElement;
-    private static colorVertexElement;
-    private static uvVertexElement;
-    static materialCache: Map<string, Material>;
-    static animationDataCache: Map<SkeletonData, AnimationStateData>;
-    static getDefaultMaterial(engine: Engine): Material;
-    /** Render setting for spine rendering. */
-    setting: SpineRenderSetting;
-    /** Initial spine animation and skin state. */
-    defaultState: DefaultState;
-    /** @internal */
-    _primitive: Primitive;
-    /** @internal */
-    _subPrimitives: SubPrimitive[];
-    /** @internal */
-    _indexBuffer: Buffer;
-    /** @internal */
-    _vertexBuffer: Buffer;
-    /** @internal */
-    _vertices: Float32Array;
-    /** @internal */
-    _indices: Uint16Array;
-    /** @internal */
-    _needResizeBuffer: boolean;
-    /** @internal */
-    _vertexCount: number;
-    /** @internal */
-    _resource: SkeletonDataResource;
-    private _skeleton;
-    private _state;
-    /**
-     * Setting `skeletonData` initializes a new Spine animation with the provided data.
-     * This property allows you to switch between different animations at runtime.
-     */
-    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;
-    /**
-     * 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;
-    /**
-     * @internal
-     */
-    get engine(): Engine;
-    constructor(entity: Entity);
-    /**
-     * @internal
-     */
-    _onEnable(): 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
-     */
-    _render(context: any): void;
-    /**
-     * @internal
-     */
-    _updateBounds(worldBounds: BoundingBox): void;
-    /**
-     * @internal
-     */
-    _calculateGeneratorBounds(worldBounds: BoundingBox): void;
-    /**
-     * @internal
-     */
-    _cloneTo(target: SpineAnimation): void;
-    /**
-     * @internal
-     */
-    _onDestroy(): void;
-    /**
-     * @internal
-     */
-    _createBuffer(vertexCount: number): void;
-    /**
-     * @internal
-     */
-    _addSubPrimitive(subPrimitive: SubPrimitive): void;
-    /**
-     * @internal
-     */
-    _clearSubPrimitives(): void;
-    /**
-     * @internal
-     */
-    _isContainDirtyFlag(type: number): boolean;
-    /**
-     * @internal
-     */
-    _setDirtyFlagFalse(type: number): void;
-    /**
-     * @internal
-     */
-    _onWorldVolumeChanged(): void;
-    private onAnimationStart;
-    private onAnimationComplete;
-    private _clearMaterialCache;
-    private _initializeDefaultState;
-}
-/**
- * @internal
- */
-export declare enum SpineAnimationUpdateFlags {
-    /** On World Transform Changed */
-    TransformVolume = 1,
-    /** On Animation start play */
-    AnimationVolume = 2,
-    /** On skeleton data asset changed */
-    InitialVolume = 4
-}
-/**
- * @internal
- */
-export declare enum RendererUpdateFlags {
-    /** Include world position and world bounds. */
-    WorldVolume = 1
-}
-export {};

package/types/core/MeshGenerator.d.ts

@@ -1,43 +0,0 @@
-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

@@ -1,42 +0,0 @@
-import { Engine, Texture2D, SubPrimitive } 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 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

@@ -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;
-}

package/types/core/SpinePrimitive.d.ts

@@ -1,15 +0,0 @@
-import { Engine, Buffer, SubPrimitive } from '@galacean/engine';
-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/cypress.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: Cypress.ConfigOptions<any>;
-export default _default;

package/types/e2e/case/.mockForE2E.d.ts

@@ -1,3 +0,0 @@
-import { Camera, Engine } from "@galacean/engine-core";
-export declare const updateForE2E: (engine: any, deltaTime?: number, loopTime?: number) => void;
-export declare function initScreenshot(engine: Engine, camera: Camera, width?: number, height?: number, flipY?: boolean, isPNG?: boolean, jpgQuality?: number): void;

package/types/e2e/case/raptor.d.ts

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

package/types/e2e/case/spine-boy.d.ts

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

package/types/e2e/config.d.ts

@@ -1,19 +0,0 @@
-export declare const E2E_CONFIG: {
-    Spine: {
-        'spine-boy': {
-            category: string;
-            caseFileName: string;
-            threshold: number;
-        };
-        raptor: {
-            category: string;
-            caseFileName: string;
-            threshold: number;
-        };
-        'mix-and-match': {
-            category: string;
-            caseFileName: string;
-            threshold: number;
-        };
-    };
-};

package/types/e2e/support/commands.d.ts

@@ -1,8 +0,0 @@
-declare global {
-    namespace Cypress {
-        interface Chainable {
-            screenshotWithThreshold(category: string, name: string, threshold?: number): Chainable<Element>;
-        }
-    }
-}
-export {};

package/types/e2e/support/e2e.d.ts

@@ -1 +0,0 @@
-import "./commands";

package/types/e2e/tests/index.cy.d.ts

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

package/types/example/main.d.ts

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

package/types/example/outline.d.ts

@@ -1,11 +0,0 @@
-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/jest.setup.d.ts

@@ -1,5 +0,0 @@
-declare class MockImage {
-    onload: () => void;
-    onerror: () => void;
-    set src(_url: string);
-}

package/types/loader/BufferReader.d.ts

@@ -1,9 +0,0 @@
-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

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

package/types/src/SpineGenerator.d.ts

@@ -1,37 +0,0 @@
-import { Texture2D, SubPrimitive, BoundingBox } from "@galacean/engine";
-import { Skeleton, Color, BlendMode, SkeletonData } from "@esotericsoftware/spine-core";
-import { SpineAnimationRenderer } from "./SpineAnimationRenderer";
-import { AdaptiveTexture } from "./loader/LoaderUtils";
-import { ReturnablePool } from "./util/ReturnablePool";
-import { ClearablePool } from "./util/ClearablePool";
-declare class SubRenderItem {
-    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 tempDark: Color;
-    static tempColor: Color;
-    static tempVerts: any[];
-    static tempBlendMode: BlendMode | null;
-    static tempTexture: AdaptiveTexture | null;
-    static subPrimitivePool: ReturnablePool<SubPrimitive>;
-    static subRenderItemPool: ClearablePool<SubRenderItem>;
-    static bounds: BoundingBox;
-    private _clipper;
-    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 _getSkinVertexCount;
-}
-export {};

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

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

package/types/src/loader/EditorSpineAtlasLoader.d.ts

@@ -1,6 +0,0 @@
-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/src/loader/LoaderUtils.d.ts

@@ -1,18 +0,0 @@
-import { AssetPromise, Engine, Texture2D } from "@galacean/engine";
-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>;
-export declare function createTextureAtlas(atlasText: string, textures: Texture2D[]): TextureAtlas;
-export declare function loadTexture(url: string, engine: Engine, imageLoaderType?: string): AssetPromise<Texture2D>;
-export declare function createAdaptiveTexture(texture: Texture2D): AdaptiveTexture;
-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;
-}

package/types/src/loader/SkeletonDataResource.d.ts

@@ -1,12 +0,0 @@
-import { SkeletonData } from "@esotericsoftware/spine-core";
-import { Engine, ReferResource, Texture2D } from "@galacean/engine";
-export declare class SkeletonDataResource extends ReferResource {
-    readonly textures: Texture2D[];
-    private _skeletonData;
-    get skeletonData(): SkeletonData;
-    constructor(engine: Engine, skeletonData: SkeletonData);
-    protected _onDestroy(): void;
-    private _disassociationSuperResource;
-    private _associationTextureInSkeletonData;
-    private _clearAttachmentTextures;
-}

package/types/src/loader/SpineLoader.d.ts

@@ -1,29 +0,0 @@
-import { AssetPromise, Loader, LoadItem, ResourceManager } from "@galacean/engine";
-import { SkeletonDataResource } from "./SkeletonDataResource";
-export type SpineAssetBundle = {
-    skeletonPath: string;
-    skeletonExtension: string;
-    skeletonTextData?: string | ArrayBuffer;
-    atlasPath: string;
-    imagePaths: string[];
-    imageExtensions: string[];
-};
-type SpineLoaderParams = {
-    fileExtensions?: string | string[];
-};
-type SpineLoadItem = LoadItem & {
-    params?: SpineLoaderParams;
-};
-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<SkeletonDataResource>;
-    private _handleEditorAsset;
-    private _handleOriginAsset;
-    private _determineSkeletonDataType;
-}
-export {};

package/types/src/util/BlendMode.d.ts

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

package/types/src/util/BufferReader.d.ts

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

package/types/src/util/ClearablePool.d.ts

@@ -1,8 +0,0 @@
-export declare class ClearablePool<T> {
-    private _type;
-    private _elements;
-    private _usedElementCount;
-    constructor(type: new () => T);
-    get(): T;
-    clear(): void;
-}

package/types/src/util/ReturnablePool.d.ts

@@ -1,8 +0,0 @@
-export declare class ReturnablePool<T> {
-    private _type;
-    private _elements;
-    private _lastElementIndex;
-    constructor(type: new () => T, initializeCount?: number);
-    get(): T;
-    return(element: T): void;
-}

package/types/tests/SpineAnimation.test.d.ts

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

package/types/tests/SpineGenerator.test.d.ts

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

package/types/tests/SpineMaterial.test.d.ts

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

package/types/tests/loader/EditorSpineAtlasLoader.test.d.ts

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

package/types/tests/loader/SkeletonDataResource.test.d.ts

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

package/types/tests/loader/SpineLoader.test.d.ts

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

package/types/tests/testUtils.d.ts

@@ -1,3 +0,0 @@
-import { WebGLEngine } from "@galacean/engine";
-export declare function createEngine(): Promise<WebGLEngine>;
-export declare function mockSkeletonDataResource(): void;

package/types/tests/util/BlendMode.test.d.ts

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

package/types/tests/util/BufferReader.test.d.ts

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

package/types/tests/util/ClearablePool.test.d.ts

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

package/types/tests/util/ReturnablePool.test.d.ts

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

package/types/types.d.ts

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

package/types/util/Cache.d.ts

@@ -1,19 +0,0 @@
-import { SkeletonData, AnimationStateData } from "@esotericsoftware/spine-core";
-import { Material } from "@galacean/engine";
-declare class Cache<K, V> {
-    protected _cache: Map<K, V>;
-    get(key: K): V;
-    set(key: K, value: V): void;
-    clear(keys?: K[]): void;
-}
-export declare class AnimationStateDataCache extends Cache<SkeletonData, AnimationStateData> {
-    private static _instance;
-    static get instance(): AnimationStateDataCache;
-    getAnimationStateData(skeletonData: SkeletonData): AnimationStateData;
-}
-export declare class MaterialCache extends Cache<string, Material> {
-    private static _instance;
-    static get instance(): MaterialCache;
-    getMaterial(key: string): Material;
-}
-export {};