@galacean/effects-core 2.0.0-alpha.31 → 2.0.0-alpha.33

package/dist/composition.d.ts

@@ -1,6 +1,7 @@
 import * as spec from '@galacean/effects-specification';
 import type { Ray } from '@galacean/effects-math/es/core/ray';
 import type { Vector3 } from '@galacean/effects-math/es/core/vector3';
+import type { Matrix4 } from '@galacean/effects-math/es/core/matrix4';
 import { Camera } from './camera';
 import { CompositionComponent } from './comp-vfx-item';
 import { CompositionSourceManager } from './composition-source-manager';
@@ -13,7 +14,8 @@ import type { Texture } from './texture';
 import type { Disposable, LostHandler } from './utils';
 import type { VFXItemProps } from './vfx-item';
 import { VFXItem } from './vfx-item';
-import { type Matrix4 } from '@galacean/effects-math/es/core';
+import type { CompositionEvent } from './events';
+import { EventEmitter } from './events';
 import type { PostProcessVolume } from './components/post-process-volume';
 export interface CompositionStatistic {
     loadTime: number;
@@ -45,10 +47,7 @@ export interface CompositionProps {
     reusable?: boolean;
     baseRenderOrder?: number;
     renderer: Renderer;
-    onPlayerPause?: (item: VFXItem) => void;
-    onItemClicked?: (item: VFXItem) => void;
-    onMessageItem?: (item: MessageItem) => void;
-    onEnd?: (composition: Composition) => void;
+    handleItemMessage: (message: MessageItem) => void;
     event?: EventSystem;
     width: number;
     height: number;
@@ -59,7 +58,7 @@ export interface CompositionProps {
  * 合成中包含了相关的 Item 元素，支持对 Item 元素的创建、更新和销毁。
  * 也负责 Item 相关的动画播放控制，和持有渲染帧数据。
  */
-export declare class Composition implements Disposable, LostHandler {
+export declare class Composition extends EventEmitter<CompositionEvent<Composition>> implements Disposable, LostHandler {
     renderer: Renderer;
     /**
      * 当前帧的渲染数据对象
@@ -93,27 +92,6 @@ export declare class Composition implements Disposable, LostHandler {
      */
     interactive: boolean;
     compositionSourceManager: CompositionSourceManager;
-    /**
-     * 合成结束行为是 spec.END_BEHAVIOR_PAUSE 或 spec.END_BEHAVIOR_PAUSE_AND_DESTROY 时执行的回调
-     * @internal
-     */
-    onPlayerPause?: (item: VFXItem) => void;
-    /**
-     * 单个合成结束时的回调
-     */
-    onEnd?: (composition: Composition) => void;
-    /**
-     * 合成中消息元素创建/销毁时触发的回调
-     */
-    onMessageItem?: (item: MessageItem) => void;
-    /**
-     * 合成中元素点击时触发的回调
-     * 注意：此接口随时可能下线，请务使用！
-     * @since 1.6.0
-     * @ignore
-     * @deprecated
-     */
-    onItemClicked?: (data: CompItemClickedData) => void;
     /**
      * 合成id
      */
@@ -196,6 +174,10 @@ export declare class Composition implements Disposable, LostHandler {
     private paused;
     private lastVideoUpdateTime;
     private readonly texInfo;
+    /**
+     * 合成中消息元素创建/销毁时触发的回调
+     */
+    private handleItemMessage;
     /**
      * Composition 构造函数
      * @param props - composition 的创建参数
@@ -305,23 +287,14 @@ export declare class Composition implements Disposable, LostHandler {
     protected reset(): void;
     prepareRender(): void;
     protected gatherRendererComponent(vfxItem: VFXItem, renderFrame: RenderFrame): void;
-    /**
-     * 是否合成需要重新播放
-     * @returns 重新播放合成标志位
-     */
-    private shouldRestart;
-    /**
-     * 是否合成需要销毁
-     * @returns 销毁合成标志位
-     */
-    private shouldDispose;
     /**
      * 合成更新，针对所有 item 的更新
      * @param deltaTime - 更新的时间步长
      * @param skipRender - 是否需要渲染
      */
-    update(deltaTime: number, skipRender?: boolean): void;
+    update(deltaTime: number): void;
     private toLocalTime;
+    private shouldDispose;
     private getUpdateTime;
     private callStart;
     private callUpdate;
@@ -340,12 +313,16 @@ export declare class Composition implements Disposable, LostHandler {
      * 更新相机
      * @override
      */
-    updateCamera(): void;
+    private updateCamera;
     /**
      * 插件更新，来自 CompVFXItem 的更新调用
      * @param deltaTime - 更新的时间步长
      */
-    updatePluginLoaders(deltaTime: number): void;
+    private updatePluginLoaders;
+    /**
+     * 更新主合成组件
+     */
+    private updateRootComposition;
     /**
      * 通过名称获取元素
      * @param name - 元素名称

package/dist/effects-object.d.ts

@@ -1,10 +1,12 @@
 import type * as spec from '@galacean/effects-specification';
 import type { Engine } from './engine';
+import type { ItemEvent } from './events';
+import { EventEmitter } from './events';
 /**
  * @since 2.0.0
  * @internal
  */
-export declare abstract class EffectsObject {
+export declare abstract class EffectsObject extends EventEmitter<ItemEvent> {
     engine: Engine;
     static is(obj: unknown): obj is EffectsObject;
     protected guid: string;

package/dist/events/event-emitter.d.ts

@@ -0,0 +1,46 @@
+export type EventEmitterListener<P extends any[]> = (...callbackArgs: P) => void;
+/**
+ * 事件监听器选项
+ */
+export type EventEmitterOptions = {
+    /**
+     * 是否只监听一次
+     */
+    once?: boolean;
+};
+export declare class EventEmitter<T extends Record<string, any[]>> {
+    private listeners;
+    /**
+     * 移除事件监听器
+     * @param eventName - 事件名称
+     * @param listener - 事件监听器
+     * @returns
+     */
+    off: <E extends keyof T & string>(eventName: E, listener: EventEmitterListener<T[E]>) => void;
+    /**
+     * 监听事件
+     * @param eventName - 事件名称
+     * @param listener - 事件监听器
+     * @param options - 事件监听器选项
+     * @returns
+     */
+    on: <E extends keyof T & string>(eventName: E, listener: EventEmitterListener<T[E]>, options?: EventEmitterOptions) => () => void;
+    /**
+     * 一次性监听事件
+     * @param eventName - 事件名称
+     * @param listener - 事件监听器
+     */
+    once: <E extends keyof T & string>(eventName: E, listener: EventEmitterListener<T[E]>) => void;
+    /**
+     * 触发事件
+     * @param eventName - 事件名称
+     * @param args - 事件参数
+     */
+    emit: <E extends keyof T & string>(eventName: E, ...args: T[E]) => void;
+    /**
+     * 获取事件名称对应的所有监听器
+     * @param eventName - 事件名称
+     * @returns - 返回事件名称对应的所有监听器
+     */
+    getListeners: <E extends keyof T & string>(eventName: E) => EventEmitterListener<T[E]>[];
+}

package/dist/events/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './event-emitter';

package/dist/events/types.d.ts

@@ -0,0 +1,37 @@
+import type { MessageItem } from '../composition';
+import type { Region } from '../plugins';
+/**
+ * Item 可以绑定的事件
+ */
+export type ItemEvent = {
+    /**
+     * 元素点击事件
+     */
+    ['click']: [region: Region];
+    /**
+     * 元素消息事件（元素创建/销毁时触发）
+     */
+    ['message']: [message: Omit<MessageItem, 'compositionId'>];
+};
+/**
+ * Compositio 可以绑定的事件
+ */
+export type CompositionEvent<C> = {
+    /**
+     * 合成点击事件
+     */
+    ['click']: [
+        clickInfo: Region & {
+            compositionName: string;
+            compositionId: string;
+        }
+    ];
+    /**
+     * 合成结束事件
+     * 合成行为为循环时每次循环结束都会触发
+     * 合成行为为销毁/冻结时只会触发一次
+     */
+    ['end']: [endInfo: {
+        composition: C;
+    }];
+};

package/dist/index.d.ts

@@ -14,7 +14,7 @@ export * from './decorators';
 export * from './downloader';
 export * from './effects-object';
 export * from './engine';
-export { ensureFixedNumber, getStandardComposition, getStandardImage, getStandardItem, getStandardJSON, normalizeColor } from './fallback';
+export { ensureFixedNumber, getStandardComposition, getStandardImage, getStandardItem, getStandardJSON, normalizeColor, } from './fallback';
 export * from './gl';
 export * from './material';
 export * from './math';
@@ -35,4 +35,5 @@ export * from './vfx-item';
 export * from './binary-asset';
 export * from './effects-object';
 export * from './effects-package';
+export * from './events';
 export declare const version: string;