@galacean/effects-core 2.1.0-alpha.1 → 2.1.0-alpha.11

package/dist/composition-source-manager.d.ts

@@ -5,13 +5,12 @@ import type { PluginSystem } from './plugin-system';
 import type { Scene, SceneRenderLevel } from './scene';
 import type { Texture } from './texture';
 import type { Disposable } from './utils';
-import type { VFXItemProps } from './vfx-item';
 export interface ContentOptions {
     id: string;
     duration: number;
     name: string;
     endBehavior: spec.EndBehavior;
-    items: VFXItemProps[];
+    items: spec.DataPath[];
     camera: spec.CameraOptions;
     startTime: number;
     timelineAsset: spec.DataPath;
@@ -22,17 +21,17 @@ export interface ContentOptions {
  */
 export declare class CompositionSourceManager implements Disposable {
     composition?: spec.CompositionData;
-    refCompositions: Map<string, spec.CompositionData>;
-    sourceContent?: ContentOptions;
-    refCompositionProps: Map<string, VFXItemProps>;
+    sourceContent?: spec.CompositionData;
+    refCompositionProps: Map<string, spec.CompositionData>;
     renderLevel?: SceneRenderLevel;
     pluginSystem?: PluginSystem;
     totalTime: number;
-    imgUsage: Record<string, number[]>;
+    imgUsage: Record<string, number>;
     textures: Texture[];
     jsonScene?: spec.JSONScene;
     mask: number;
     engine: Engine;
+    private refCompositions;
     constructor(scene: Scene, engine: Engine);
     private getContent;
     private assembleItems;

package/dist/composition.d.ts

@@ -1,6 +1,5 @@
 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';
@@ -9,33 +8,38 @@ import type { PluginSystem } from './plugin-system';
 import type { EventSystem, Plugin, Region } from './plugins';
 import type { MeshRendererOptions, Renderer } from './render';
 import { RenderFrame } from './render';
-import type { Scene, SceneType } from './scene';
+import type { Scene } from './scene';
 import type { Texture } from './texture';
 import type { Disposable, LostHandler } from './utils';
-import type { VFXItemProps } from './vfx-item';
 import { VFXItem } from './vfx-item';
 import type { CompositionEvent } from './events';
 import { EventEmitter } from './events';
-import type { PostProcessVolume } from './components/post-process-volume';
+import type { PostProcessVolume } from './components';
 import { SceneTicking } from './composition/scene-ticking';
+/**
+ * 合成统计信息
+ */
 export interface CompositionStatistic {
-    loadTime: number;
     loadStart: number;
+    loadTime: number;
+    /**
+     * Shader 编译耗时
+     */
+    compileTime: number;
+    /**
+     * 从加载到渲染第一帧的时间（含 Shader 编译）
+     */
     firstFrameTime: number;
-    precompileTime: number;
 }
+/**
+ * 合成消息对象
+ */
 export interface MessageItem {
     id: string;
     name: string;
     phrase: number;
     compositionId: string;
 }
-export interface CompItemClickedData {
-    name: string;
-    id: string;
-    hitPositions: Vector3[];
-    position: Vector3;
-}
 /**
  *
  */
@@ -44,6 +48,9 @@ export interface CompositionHitTestOptions {
     stop?: (region: Region) => boolean;
     skip?: (item: VFXItem) => boolean;
 }
+/**
+ *
+ */
 export interface CompositionProps {
     reusable?: boolean;
     baseRenderOrder?: number;
@@ -61,6 +68,9 @@ export interface CompositionProps {
  */
 export declare class Composition extends EventEmitter<CompositionEvent<Composition>> implements Disposable, LostHandler {
     renderer: Renderer;
+    /**
+     *
+     */
     sceneTicking: SceneTicking;
     /**
      * 当前帧的渲染数据对象
@@ -87,12 +97,15 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
      * 是否播放完成后销毁 texture 对象
      */
     keepResource: boolean;
-    extraCamera: VFXItem;
     /**
      * 合成内的元素否允许点击、拖拽交互
      * @since 1.6.0
      */
     interactive: boolean;
+    /**
+     * 合成是否结束
+     */
+    isEnded: boolean;
     compositionSourceManager: CompositionSourceManager;
     /**
      * 合成id
@@ -117,7 +130,7 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
     /**
      * 是否在合成结束时自动销毁引用的纹理，合成重播时不销毁
      */
-    autoRefTex: boolean;
+    readonly autoRefTex: boolean;
     /**
      * 当前合成名称
      */
@@ -133,7 +146,7 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
     /**
      * 合成对应的 url 或者 JSON
      */
-    readonly url: SceneType;
+    readonly url: Scene.LoadType;
     /**
      * 合成根元素
      */
@@ -145,19 +158,19 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
     /**
      * 预合成的合成属性，在 content 中会被其元素属性覆盖
      */
-    refCompositionProps: Map<string, VFXItemProps>;
+    readonly refCompositionProps: Map<string, spec.CompositionData>;
     /**
      * 合成的相机对象
      */
     readonly camera: Camera;
     /**
-     * 合成全局时间
+     * 后处理渲染配置
      */
-    globalTime: number;
+    globalVolume?: PostProcessVolume;
     /**
-     * 后处理渲染配置
+     * 是否开启后处理
      */
-    globalVolume: PostProcessVolume;
+    postProcessingEnabled: boolean;
     protected rendererOptions: MeshRendererOptions | null;
     protected assigned: boolean;
     /**
@@ -175,6 +188,7 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
      */
     private paused;
     private lastVideoUpdateTime;
+    private isEndCalled;
     private readonly texInfo;
     /**
      * 合成中消息元素创建/销毁时触发的回调
@@ -187,7 +201,6 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
      * @param compositionSourceManager
      */
     constructor(props: CompositionProps, scene: Scene);
-    initializeSceneTicking(item: VFXItem): void;
     /**
      * 所有合成 Item 的根变换
      */
@@ -294,7 +307,6 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
      * @param deltaTime - 更新的时间步长
      */
     update(deltaTime: number): void;
-    private toLocalTime;
     private shouldDispose;
     private getUpdateTime;
     private callAwake;
@@ -302,7 +314,6 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
      * 构建父子树，同时保存到 itemCacheMap 中便于查找
      */
     private buildItemTree;
-    private getParentIdWithoutSuffix;
     /**
      * 更新视频数据到纹理
      * @override

package/dist/downloader.d.ts

@@ -1,8 +1,5 @@
 type SuccessHandler<T> = (data: T) => void;
 type ErrorHandler = (status: number, responseText: string) => void;
-/**
- *
- */
 /**
  * JSON 值，它可以是字符串、数字、布尔值、对象或者 JSON 值的数组。
  *

package/dist/effects-object.d.ts

@@ -5,15 +5,35 @@ import type { Engine } from './engine';
  */
 export declare abstract class EffectsObject {
     engine: Engine;
+    /**
+     *
+     * @param obj
+     * @returns
+     */
     static is(obj: unknown): obj is EffectsObject;
     protected guid: string;
     /**
      * 存储需要序列化的数据
      */
     readonly taggedProperties: Record<string, any>;
+    /**
+     *
+     * @param engine
+     */
     constructor(engine: Engine);
+    /**
+     *
+     * @returns
+     */
     getInstanceId(): string;
+    /**
+     *
+     * @param guid
+     */
     setInstanceId(guid: string): void;
+    /**
+     *
+     */
     toData(): void;
     /**
      * 反序列化函数
@@ -21,5 +41,8 @@ export declare abstract class EffectsObject {
      * @param data - 对象的序列化的数据
      */
     fromData(data: spec.EffectsObjectData): void;
+    /**
+     *
+     */
     dispose(): void;
 }

package/dist/engine.d.ts

@@ -11,9 +11,15 @@ import type { Disposable } from './utils';
  * Engine 基类，负责维护所有 GPU 资源的管理及销毁
  */
 export declare class Engine implements Disposable {
+    /**
+     * 渲染器
+     */
     renderer: Renderer;
     emptyTexture: Texture;
     transparentTexture: Texture;
+    /**
+     * GPU 能力
+     */
     gpuCapability: GPUCapability;
     jsonSceneData: SceneData;
     objectInstance: Record<string, EffectsObject>;
@@ -29,6 +35,9 @@ export declare class Engine implements Disposable {
     protected geometries: Geometry[];
     protected meshes: Mesh[];
     protected renderPasses: RenderPass[];
+    /**
+     *
+     */
     constructor();
     /**
      * 创建 Engine 对象。

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

@@ -1,3 +1,6 @@
+/**
+ *
+ */
 export type EventEmitterListener<P extends any[]> = (...callbackArgs: P) => void;
 /**
  * 事件监听器选项
@@ -8,6 +11,9 @@ export type EventEmitterOptions = {
      */
     once?: boolean;
 };
+/**
+ * 事件监听器
+ */
 export declare class EventEmitter<T extends Record<string, any[]>> {
     private listeners;
     /**

package/dist/events/types.d.ts

@@ -14,7 +14,7 @@ export type ItemEvent = {
     ['message']: [message: Omit<MessageItem, 'compositionId'>];
 };
 /**
- * Compositio 可以绑定的事件
+ * Composition 可以绑定的事件
  */
 export type CompositionEvent<C> = {
     /**

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 export * as math from '@galacean/effects-math/es/core/index';
 export * as spec from '@galacean/effects-specification';
+export * from './asset';
+export * from './binary-asset';
 export * from './asset-loader';
 export * from './asset-manager';
 export * from './camera';
@@ -32,8 +34,8 @@ export * from './ticker';
 export * from './transform';
 export * from './utils';
 export * from './vfx-item';
-export * from './binary-asset';
 export * from './effects-object';
 export * from './effects-package';
 export * from './events';
+export * from './pass-render-level';
 export declare const version: string;