@galacean/effects-core 1.1.2 → 1.1.4

package/dist/vfx-item.d.ts

@@ -0,0 +1,361 @@
+import * as spec from '@galacean/effects-specification';
+import { Vector3 } from '@galacean/effects-math/es/core/index';
+import type { Disposable } from './utils';
+import { Transform } from './transform';
+import type { HitTestBoxParams, HitTestCustomParams, HitTestSphereParams, HitTestTriangleParams, ParticleSystem, SpriteItem, CalculateItem, CameraController, InteractItem, BoundingBoxData, SpriteRenderData, ParticleVFXItem, FilterSpriteVFXItem, SpriteVFXItem, CameraVFXItem } from './plugins';
+import type { Composition } from './composition';
+import type { CompVFXItem } from './comp-vfx-item';
+export type VFXItemContent = ParticleSystem | SpriteItem | CalculateItem | CameraController | InteractItem | void;
+export type VFXItemConstructor = new (props: VFXItemProps, composition: Composition) => VFXItem<VFXItemContent>;
+export type VFXItemProps = spec.Item & {
+    items: any;
+    startTime: number;
+    relative?: boolean;
+    listIndex?: number;
+    refId?: string;
+};
+/**
+ * 所有元素的继承的抽象类
+ */
+export declare abstract class VFXItem<T extends VFXItemContent> implements Disposable {
+    /**
+     * 元素绑定的父元素，
+     * 1. 当元素没有绑定任何父元素时，parent为空，transform.parentTransform 为 composition.transform
+     * 2. 当元素绑定 nullItem 时，parent 为 nullItem, transform.parentTransform 为 nullItem.transform
+     * 3. 当元素绑定 TreeItem 的node时，parent为treeItem, transform.parentTransform 为 tree.nodes[i].transform(绑定的node节点上的transform)
+     * 4. 当元素绑定 TreeItem 本身时，行为表现和绑定 nullItem 相同
+     */
+    parent?: VFXItem<VFXItemContent>;
+    /**
+     * 元素的变换包含位置、旋转、缩放。
+     */
+    transform: Transform;
+    /**
+     * 合成属性
+     */
+    composition: Composition | null;
+    /**
+     * 元素动画的持续时间
+     */
+    duration: number;
+    /**
+     * 元素当前更新归一化时间，开始时为 0，结束时为 1
+     */
+    lifetime: number;
+    /**
+     * 父元素的 id
+     */
+    parentId?: string;
+    /**
+     * 元素动画的开始时间
+     */
+    delay?: number;
+    /**
+     * 元素动画结束时行为（如何处理元素）
+     */
+    endBehavior: spec.ItemEndBehavior | spec.ParentItemEndBehavior;
+    /**
+     * 元素是否可用
+     */
+    ended: boolean;
+    /**
+     * 元素在合成中的索引
+     */
+    readonly listIndex: number;
+    /**
+     * 元素名称
+     */
+    readonly name: string;
+    /**
+     * 元素 id 唯一
+     */
+    readonly id: string;
+    /**
+     * 元素动画是否开始
+     */
+    started: boolean;
+    /**
+     * 元素优先级
+     */
+    _v_priority: number;
+    /**
+     * 元素创建的数据图层/粒子/模型等
+     */
+    protected _content?: T;
+    /**
+     * 元素可见性，该值的改变会触发 `handleVisibleChanged` 回调
+     * @protected
+     */
+    protected visible: boolean;
+    /**
+     * 是否允许渲染，元素生命周期开始后为 true，结束时为 false
+     * @protected
+     */
+    protected _contentVisible: boolean;
+    /**
+     * 合成元素当前的时间，单位毫秒
+     * @protected
+     */
+    protected timeInms: number;
+    /**
+     * 合成元素当前的时间，单位秒，兼容旧 player 使用秒的时间更新数据
+     * @protected
+     */
+    protected time: number;
+    /**
+     * 元素动画持续时间，单位毫秒
+     */
+    protected readonly durInms: number;
+    /**
+    * 元素动画延迟/开始播放时间，单位毫秒
+    */
+    protected readonly delayInms: number;
+    /**
+     * 元素动画是否延迟播放
+     */
+    protected delaying: boolean;
+    /**
+     * 元素冻结属性，冻结后停止计算/更新数据
+     */
+    private _frozen;
+    /**
+     * 元素动画结束回调是否被调用
+     */
+    private callEnd;
+    /**
+     * 元素动画的速度
+     */
+    private speed;
+    static isComposition(item: VFXItem<VFXItemContent>): item is CompVFXItem;
+    static isSprite(item: VFXItem<VFXItemContent>): item is SpriteVFXItem;
+    static isParticle(item: VFXItem<VFXItemContent>): item is ParticleVFXItem;
+    static isFilterSprite(item: VFXItem<VFXItemContent>): item is FilterSpriteVFXItem;
+    static isNull(item: VFXItem<VFXItemContent>): item is VFXItem<void>;
+    static isTree(item: VFXItem<VFXItemContent>): item is VFXItem<void>;
+    static isCamera(item: VFXItem<VFXItemContent>): item is VFXItem<void>;
+    static isExtraCamera(item: VFXItem<VFXItemContent>): item is CameraVFXItem;
+    constructor(props: VFXItemProps, composition: Composition);
+    /**
+     * 元素内容可见性
+     */
+    get contentVisible(): boolean;
+    /**
+     * 返回元素创建的数据
+     */
+    get content(): T;
+    /**
+     * 设置元素数据
+     */
+    set content(t: T);
+    /**
+     * 播放完成后是否需要再使用，是的话生命周期结束后不会 dispose
+     */
+    get reusable(): boolean;
+    /**
+     * 获取元素类型
+     */
+    get type(): spec.ItemType | string;
+    /**
+     * 获取元素冻结属性
+     */
+    get frozen(): boolean;
+    /**
+     * 设置元素冻结属性
+     */
+    set frozen(v: boolean);
+    /**
+     * 获取元素生命周期是否开始
+     */
+    get lifetimeStarted(): boolean;
+    /**
+     * 设置元素的动画速度
+     * @param speed - 速度
+     */
+    setSpeed(speed: number): void;
+    /**
+     * 获取元素的动画速度
+     * @returns
+     */
+    getSpeed(): number;
+    /**
+     * 重置元素状态属性
+     */
+    start(): void;
+    /**
+     * 停止播放元素动画
+     */
+    stop(): void;
+    doStop(): void;
+    /**
+     * 创建元素内容，此函数可以在任何时间被调用
+     * 第一帧渲染前会被调用
+     * @returns
+     */
+    createContent(): T;
+    /**
+     * 创建元素的内容
+     * @override
+     * @param composition
+     * @returns
+     */
+    protected doCreateContent(composition: Composition | null): T;
+    /**
+     * 元素构造函数调用时将调用该函数
+     * @param options
+     * @override
+     */
+    onConstructed(options: spec.Item): void;
+    /**
+     * 内部使用的更新回调，请不要重写此方法，重写 `onItemUpdate` 方法
+     * @param deltaTime
+     */
+    onUpdate(deltaTime: number): void;
+    /**
+     * 元素结束时的回调
+     * @override
+     * @param composition
+     * @param content
+     */
+    protected onItemRemoved(composition: Composition, content?: T): void;
+    /**
+     * 元素更新函数，在 Composition 对象的 tick 函数中被调用
+     * @override
+     * @param dt
+     * @param lifetime
+     */
+    onItemUpdate(dt: number, lifetime: number): void;
+    /**
+     * 元素 doCreateContent 函数调用后会立即调用该函数用于初始化数据
+     * @override
+     * @param composition
+     * @param content
+     */
+    onLifetimeBegin(composition: Composition, content: T): void;
+    /**
+     * 元素动画结束播放时回调函数
+     * @override
+     */
+    onEnd(): void;
+    /**
+     * 通过指定 r、g、b、a 值设置元素的颜色
+     * @param {number} r
+     * @param {number} g
+     * @param {number} b
+     * @param {number} a
+     * @internal
+     */
+    setColor(r: number, g: number, b: number, a: number): void;
+    /**
+     * 设置元素的透明度
+     * @param opacity - 透明度值，范围 [0,1]
+     */
+    setOpacity(opacity: number): void;
+    /**
+     * 获取元素显隐属性
+     */
+    getVisible(): boolean;
+    /**
+     * 设置元素显隐属性 会触发 `handleVisibleChanged` 回调
+     */
+    setVisible(visible: boolean): void;
+    /**
+     * 元素显隐属性改变时调用的函数，当 visible 为 true 时，务必显示元素
+     * @param visible
+     * @override
+     */
+    protected handleVisibleChanged(visible: boolean): void;
+    /**
+     * 元素冻结属性改变时调用的函数
+     * @param frozen
+     * @override
+     */
+    protected handleFrozenChanged(frozen: boolean): void;
+    /**
+     * 获取元素变换包括位置、旋转、缩放
+     * @param transform 将元素变换拷贝到该对象，并将其作为返回值
+     * @returns 元素变换的拷贝
+     */
+    getWorldTransform(transform?: Transform): Transform;
+    /**
+     * 获取元素内部节点的变换，目前只有场景树元素在使用
+     * @param itemId 元素id信息，如果带^就返回内部节点变换，否则返回自己的变换
+     * @returns 元素变换或内部节点变换
+     */
+    getNodeTransform(itemId: string): Transform;
+    /**
+     * 设置元素在 3D 坐标轴上相对移动
+     */
+    translate(x: number, y: number, z: number): void;
+    /**
+     * 设置元素在 3D 坐标轴上相对旋转（角度）
+     */
+    rotate(x: number, y: number, z: number): void;
+    /**
+     * 设置元素在 3D 坐标轴上相对缩放
+     */
+    scale(x: number, y: number, z: number): void;
+    /**
+     * 设置元素的在画布上的像素位置
+     */
+    setPositionByPixel(x: number, y: number): void;
+    /**
+     * 设置元素在 3D 坐标轴的位置
+     */
+    setPosition(x: number, y: number, z: number): void;
+    /**
+     * 设置元素在 3D 坐标轴的角度
+     */
+    setRotation(x: number, y: number, z: number): void;
+    /**
+     * 设置元素在 3D 坐标轴的缩放
+     */
+    setScale(x: number, y: number, z: number): void;
+    /**
+     * 获取元素包围盒
+     * @override
+     */
+    getBoundingBox(): void | BoundingBoxData;
+    /**
+     * 获取元素用于计算光线投射的面片类型和参数
+     * @override
+     * @param force 元素没有开启交互也返回参数
+     */
+    getHitTestParams(force?: boolean): void | HitTestBoxParams | HitTestTriangleParams | HitTestSphereParams | HitTestCustomParams;
+    /**
+     * 获取元素的 transform、当前生命周期、可见性，当子元素需要时可继承
+     * @override
+     */
+    getRenderData(): SpriteRenderData;
+    /**
+     * 获取元素当前世界坐标
+     */
+    getCurrentPosition(): Vector3;
+    /**
+     * 是否到达元素的结束时间
+     * @param now
+     * @returns
+     */
+    protected isEnded(now: number): boolean;
+    /**
+     * 重置元素，元素创建的内容将会被销毁
+     */
+    reset(): void;
+    translateByPixel(x: number, y: number): void;
+    /**
+     * 销毁元素
+     */
+    dispose(): void;
+}
+export declare namespace Item {
+    function is<T extends spec.Item>(item: spec.Item, type: spec.ItemType): item is T;
+    function isFilter(item: spec.Item): item is spec.FilterItem;
+    function isComposition(item: spec.Item): item is spec.CompositionItem;
+    function isParticle(item: spec.Item): item is spec.ParticleItem;
+    function isNull(item: spec.Item): item is spec.NullItem;
+}
+/**
+ * 根据元素的类型创建对应的 `VFXItem` 实例
+ * @param props
+ * @param composition
+ */
+export declare function createVFXItem(props: VFXItemProps, composition: Composition): VFXItem<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-core",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "Galacean Effects runtime core for the web",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",
@@ -43,7 +43,7 @@
   },
   "dependencies": {
     "@galacean/effects-specification": "1.0.0",
-    "@galacean/effects-math": "1.0.0"
+    "@galacean/effects-math": "1.0.1"
   },
   "scripts": {
     "prebuild": "pnpm clean",