Files
cocos4/cocos/spine/index.ts
T
2025-02-26 18:56:42 +08:00

137 lines
4.5 KiB
TypeScript

/*
Copyright (c) 2020-2023 Xiamen Yaji Software Co., Ltd.
https://www.cocos.com/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
import { BUILD, LOAD_SPINE_MANUALLY } from 'internal:constants';
import { ccenum } from '../core';
import spine from './lib/spine-core';
import { waitForSpineWasmInstantiation } from './lib/instantiated';
/**
* @en
* The global main namespace of Spine, all classes, functions,
* properties and constants of Spine are defined in this namespace
* @zh
* Spine 的全局的命名空间,
* 与 Spine 相关的所有的类,函数,属性,常量都在这个命名空间中定义。
* @module sp
* @main sp
*/
/*
* Reference:
* http://esotericsoftware.com/spine-runtime-terminology
* http://esotericsoftware.com/files/runtime-diagram.png
* http://en.esotericsoftware.com/spine-using-runtimes
*/
export * from './skeleton';
export * from './skeleton-data';
export * from './vertex-effect-delegate';
export * from './assembler';
export * from './lib/spine-version';
export { spine };
/**
* @internal Since v3.7.2, this is an engine private type.
*/
/**
* @en
* The attachment type of spine. It contains three type: REGION(0), BOUNDING_BOX(1), MESH(2) and SKINNED_MESH.
* [REGION] An attachment that displays a textured quadrilateral.
* [BOUNDING_BOX] An attachment with vertices that make up a polygon. Can be used for hit detection,
* creating physics bodies, spawning particle effects, and more.
* [MESH] An attachment that displays a textured mesh.
* [SKINNED_MESH] No used any more.
* @zh
* Attachment 类型枚举。类型包括 REGION, BOUNDING_BOX, MESH, SKINNED_MESH。
* [REGION] 一个用于显示 texture 四边形的附件。
* [BOUNDING_BOX] 一个带有顶点的附件。顶点构成的多边形可用于碰撞检测,创建物理实体,生成粒子特效等等。
* [MESH] 一个可以显示 texture 网格的附件。
* [SKINNED_MESH] 已废弃。
*/
export enum ATTACHMENT_TYPE {
REGION = 0,
BOUNDING_BOX = 1,
MESH = 2,
SKINNED_MESH = 3
}
ccenum(ATTACHMENT_TYPE);
/**
* @en The event type of spine skeleton animation.
* @zh 骨骼动画事件类型。
* @enum AnimationEventType
*/
export enum AnimationEventType {
/**
* @en The play spine skeleton animation start type.
* @zh 开始播放骨骼动画。
* @property {Number} START
*/
START = 0,
/**
* @en Another entry has replaced this entry as the current entry. This entry may continue being applied for mixing.
* @zh 当前的 entry 被其他的 entry 替换。当使用 mixing 时,当前的 entry 会继续运行。
*/
INTERRUPT = 1,
/**
* @en The play spine skeleton animation finish type.
* @zh 播放骨骼动画结束。
* @property {Number} END
*/
END = 2,
/**
* @en The entry will be disposed.
* @zh entry 将被销毁。
*/
DISPOSE = 3,
/**
* @en The play spine skeleton animation complete type.
* @zh 播放骨骼动画完成。
* @property {Number} COMPLETE
*/
COMPLETE = 4,
/**
* @en The spine skeleton animation event type.
* @zh 骨骼动画事件。
* @property {Number} EVENT
*/
EVENT = 5
}
ccenum(AnimationEventType);
let loadSpinePromise: Promise<void> | undefined;
export function loadWasmModuleSpine (): Promise<void> {
if (BUILD && LOAD_SPINE_MANUALLY) {
if (loadSpinePromise) return loadSpinePromise;
loadSpinePromise = Promise.resolve()
.then(() => waitForSpineWasmInstantiation());
return loadSpinePromise;
} else {
return Promise.resolve();
}
}