@galacean/effects-core 2.0.0-alpha.11 → 2.0.0-alpha.13

package/dist/asset-loader.d.ts

@@ -17,12 +17,6 @@ export declare class AssetLoader {
 export declare class Database {
     loadGUID(guid: string): Promise<EffectsObject | undefined>;
 }
-export interface GeometryData extends spec.EffectsObjectData {
-    vertexData: spec.VertexData;
-    indexFormat: number;
-    indexOffset: number;
-    buffer: string;
-}
 export interface EffectComponentData extends spec.EffectsObjectData {
     _priority: number;
     item: spec.DataPath;

package/dist/binary-asset.d.ts

@@ -0,0 +1,6 @@
+import type { EffectsObjectData } from '@galacean/effects-specification';
+import { EffectsObject } from './effects-object';
+export declare class BinaryAsset extends EffectsObject {
+    buffer: ArrayBuffer;
+    fromData(data: EffectsObjectData): void;
+}

package/dist/comp-vfx-item.d.ts

@@ -1,21 +1,37 @@
 import type { Ray } from '@galacean/effects-math/es/core/ray';
+import * as spec from '@galacean/effects-specification';
 import { ItemBehaviour } from './components';
 import type { CompositionHitTestOptions } from './composition';
-import type { Region } from './plugins';
-import { TimelineComponent } from './plugins';
-import type { VFXItemContent } from './vfx-item';
+import type { ContentOptions } from './composition-source-manager';
+import type { Region, TrackAsset } from './plugins';
+import { ObjectBindingTrack } from './plugins';
 import { VFXItem } from './vfx-item';
+export interface SceneBinding {
+    key: ObjectBindingTrack;
+    value: VFXItem;
+}
+export interface SceneBindingData {
+    key: spec.DataPath;
+    value: spec.DataPath;
+}
 /**
  * @since 2.0.0
  * @internal
  */
 export declare class CompositionComponent extends ItemBehaviour {
+    time: number;
     startTime: number;
     refId: string;
-    items: VFXItem<VFXItemContent>[];
-    timelineComponents: TimelineComponent[];
-    timelineComponent: TimelineComponent;
+    items: VFXItem[];
+    data: ContentOptions;
+    private reusable;
+    private sceneBindings;
+    private masterTracks;
+    private timelineAsset;
+    private timelinePlayable;
+    private graph;
     start(): void;
+    initializeTrackBindings(masterTracks: TrackAsset[]): void;
     update(dt: number): void;
     /**
      * 重置元素状态属性
@@ -24,4 +40,5 @@ export declare class CompositionComponent extends ItemBehaviour {
     createContent(): void;
     onDestroy(): void;
     hitTest(ray: Ray, x: number, y: number, regions: Region[], force?: boolean, options?: CompositionHitTestOptions): Region[];
+    fromData(data: any): void;
 }

package/dist/components/component.d.ts

@@ -1,5 +1,5 @@
 import { EffectsObject } from '../effects-object';
-import type { VFXItem, VFXItemContent } from '../vfx-item';
+import type { VFXItem } from '../vfx-item';
 /**
  * @since 2.0.0
  * @internal
@@ -9,7 +9,7 @@ export declare abstract class Component extends EffectsObject {
     /**
      * 附加到的 VFXItem 对象
      */
-    item: VFXItem<VFXItemContent>;
+    item: VFXItem;
     /**
      * 附加到的 VFXItem 对象 Transform 组件
      */

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

@@ -1,4 +1,5 @@
 import * as spec from '@galacean/effects-specification';
+import type { SceneBindingData } from './comp-vfx-item';
 import type { Engine } from './engine';
 import type { PluginSystem } from './plugin-system';
 import type { GlobalVolume } from './render';
@@ -15,6 +16,8 @@ export interface ContentOptions {
     camera: spec.CameraOptions;
     startTime: number;
     globalVolume: GlobalVolume;
+    timelineAsset: spec.DataPath;
+    sceneBindings: SceneBindingData[];
 }
 /**
  * 合成资源管理

package/dist/composition.d.ts

@@ -11,7 +11,7 @@ import type { Scene, SceneType } from './scene';
 import type { Texture } from './texture';
 import { Transform } from './transform';
 import type { Disposable, LostHandler } from './utils';
-import type { VFXItemContent, VFXItemProps } from './vfx-item';
+import type { VFXItemProps } from './vfx-item';
 import { VFXItem } from './vfx-item';
 export interface CompositionStatistic {
     loadTime: number;
@@ -30,13 +30,13 @@ export interface MessageItem {
 export interface CompositionHitTestOptions {
     maxCount?: number;
     stop?: (region: Region) => boolean;
-    skip?: (item: VFXItem<VFXItemContent>) => boolean;
+    skip?: (item: VFXItem) => boolean;
 }
 export interface CompositionProps {
     reusable?: boolean;
     baseRenderOrder?: number;
     renderer: Renderer;
-    onPlayerPause?: (item: VFXItem<any>) => void;
+    onPlayerPause?: (item: VFXItem) => void;
     onMessageItem?: (item: MessageItem) => void;
     onEnd?: (composition: Composition) => void;
     event?: EventSystem;
@@ -81,12 +81,12 @@ export declare class Composition implements Disposable, LostHandler {
      * 是否播放完成后销毁 texture 对象
      */
     keepResource: boolean;
-    extraCamera: VFXItem<VFXItemContent>;
+    extraCamera: VFXItem;
     /**
      * 合成结束行为是 spec.END_BEHAVIOR_PAUSE 或 spec.END_BEHAVIOR_PAUSE_AND_DESTROY 时执行的回调
      * @internal
      */
-    onPlayerPause?: (item: VFXItem<any>) => void;
+    onPlayerPause?: (item: VFXItem) => void;
     /**
      * 单个合成结束时的回调
      */
@@ -142,11 +142,11 @@ export declare class Composition implements Disposable, LostHandler {
     /**
      * 合成根元素
      */
-    rootItem: VFXItem<VFXItemContent>;
+    rootItem: VFXItem;
     /**
      * 预合成数组
      */
-    readonly refContent: VFXItem<VFXItemContent>[];
+    readonly refContent: VFXItem[];
     /**
      * 预合成的合成属性，在 content 中会被其元素属性覆盖
      */
@@ -159,6 +159,7 @@ export declare class Composition implements Disposable, LostHandler {
      * 合成全局时间
      */
     globalTime: number;
+    editorScaleRatio: number;
     protected rendererOptions: MeshRendererOptions | null;
     protected assigned: boolean;
     /**
@@ -181,7 +182,6 @@ export declare class Composition implements Disposable, LostHandler {
     private readonly globalVolume;
     private readonly texInfo;
     private readonly postLoaders;
-    private rootTimeline;
     /**
      * Composition 构造函数
      * @param props - composition 的创建参数
@@ -189,12 +189,6 @@ export declare class Composition implements Disposable, LostHandler {
      * @param compositionSourceManager
      */
     constructor(props: CompositionProps, scene: Scene, compositionSourceManager: CompositionSourceManager);
-    /**
-     * 合成结束回调
-     * @param {(composition: Composition) => void} func
-     * @deprecated since 2.0 - use `onEnd` instead
-     */
-    set handleEnd(func: (composition: Composition) => void);
     /**
      * 获取场景中的纹理数组
      */
@@ -202,7 +196,7 @@ export declare class Composition implements Disposable, LostHandler {
     /**
      * 获取合成中所有元素
      */
-    get items(): VFXItem<VFXItemContent>[];
+    get items(): VFXItem[];
     /**
      * 获取合成开始渲染的时间
      */
@@ -278,7 +272,7 @@ export declare class Composition implements Disposable, LostHandler {
      * @param time - 相对 startTime 的时间
      */
     setTime(time: number): void;
-    addItem(item: VFXItem<VFXItemContent>): void;
+    addItem(item: VFXItem): void;
     /**
      * 前进合成到指定时间
      * @param time - 相对0时刻的时间
@@ -290,6 +284,7 @@ export declare class Composition implements Disposable, LostHandler {
      */
     protected reset(): void;
     prepareRender(): void;
+    private gatherRendererComponent;
     /**
      * 是否合成需要重新播放
      * @returns 重新播放合成标志位
@@ -306,6 +301,7 @@ export declare class Composition implements Disposable, LostHandler {
      * @param skipRender - 是否需要渲染
      */
     update(deltaTime: number, skipRender?: boolean): void;
+    private toLocalTime;
     private getUpdateTime;
     private callStart;
     private callUpdate;
@@ -335,7 +331,7 @@ export declare class Composition implements Disposable, LostHandler {
      * @param name - 元素名称
      * @returns 元素对象
      */
-    getItemByName(name: string): VFXItem<VFXItemContent> | undefined;
+    getItemByName(name: string): VFXItem | undefined;
     /**
      * 获取指定位置和相机连成的射线
      * @param x
@@ -361,13 +357,13 @@ export declare class Composition implements Disposable, LostHandler {
      * @param item - 交互元素
      * @param type - 交互类型
      */
-    addInteractiveItem(item: VFXItem<VFXItemContent>, type: spec.InteractType): string | undefined;
+    addInteractiveItem(item: VFXItem, type: spec.InteractType): string | undefined;
     /**
      * InteractItem 生命周期结束时的调用
      * @param item - 交互元素
      * @param type - 交互类型
      */
-    removeInteractiveItem(item: VFXItem<VFXItemContent>, type: spec.InteractType): void;
+    removeInteractiveItem(item: VFXItem, type: spec.InteractType): void;
     /**
      * 销毁插件 Item 中保存的纹理数组
      * @internal
@@ -379,7 +375,7 @@ export declare class Composition implements Disposable, LostHandler {
      * @internal
      * @param item - 需要销毁的 item
      */
-    destroyItem(item: VFXItem<VFXItemContent>): void;
+    destroyItem(item: VFXItem): void;
     lost(e: Event): void;
     /**
      * 合成对象销毁
@@ -397,6 +393,15 @@ export declare class Composition implements Disposable, LostHandler {
      * 合成整体在水平方向移动 x 像素，垂直方向移动 y 像素
      */
     translateByPixel(x: number, y: number): void;
+    /**
+     * 设置合成在画布上的像素位置
+     * Tips:
+     *  - 坐标原点在 canvas 左上角，x 正方向水平向右， y 正方向垂直向下
+     *  - 设置后会覆盖原有的位置信息
+     * @param x - x 坐标
+     * @param y - y 坐标
+     */
+    setPositionByPixel(x: number, y: number): void;
     /**
      * 设置合成在 3D 坐标轴上相对当前的位移
      */

package/dist/decorators.d.ts

@@ -1,4 +1,4 @@
 export declare const effectsClassStore: Record<string, any>;
 export declare function getMergedStore(target: any): any;
-export declare function serialize(sourceName?: string): (target: any, propertyKey: any) => void;
+export declare function serialize(type?: string, sourceName?: string): (target: any, propertyKey: any) => void;
 export declare function effectsClass(className: any): (target: any, context?: any) => void;

package/dist/engine.d.ts

@@ -5,10 +5,10 @@ import type { EffectsObject } from './effects-object';
 import type { Material } from './material';
 import type { GPUCapability, Geometry, Mesh, RenderPass, Renderer, ShaderLibrary } from './render';
 import type { Scene } from './scene';
-import { Texture } from './texture';
+import type { Texture } from './texture';
 import type { Disposable } from './utils';
 /**
- * Engine 基类，负责维护所有 GPU 资源的销毁
+ * Engine 基类，负责维护所有 GPU 资源的管理及销毁
  */
 export declare class Engine implements Disposable {
     renderer: Renderer;
@@ -19,6 +19,10 @@ export declare class Engine implements Disposable {
     objectInstance: Record<string, EffectsObject>;
     assetLoader: AssetLoader;
     database?: Database;
+    /**
+     * 渲染过程中错误队列
+     */
+    renderErrors: Set<Error>;
     protected destroyed: boolean;
     protected textures: Texture[];
     protected materials: Material[];
@@ -37,7 +41,7 @@ export declare class Engine implements Disposable {
     getInstance(id: string): EffectsObject;
     removeInstance(id: string): void;
     addPackageDatas(scene: Scene): void;
-    createVFXItemsAsync(scene: Scene): Promise<void>;
+    createVFXItems(scene: Scene): Promise<void>;
     addTexture(tex: Texture): void;
     removeTexture(tex: Texture): void;
     addMaterial(mat: Material): void;
@@ -50,7 +54,6 @@ export declare class Engine implements Disposable {
     removeRenderPass(pass: RenderPass): void;
     get isDestroyed(): boolean;
     getShaderLibrary(): ShaderLibrary;
-    private createDefaultTexture;
     /**
      * 销毁所有缓存的资源
      */

package/dist/fallback/migration.d.ts

@@ -1,4 +1,4 @@
-import type { JSONScene, JSONSceneLegacy, BaseContent } from '@galacean/effects-specification';
+import type { BaseContent, JSONScene, JSONSceneLegacy } from '@galacean/effects-specification';
 /**
  * 2.1 以下版本数据适配（mars-player@2.4.0 及以上版本支持 2.1 以下数据的适配）
  */

package/dist/fallback/utils.d.ts

@@ -1,17 +1,6 @@
 import type { FixedNumberExpression, RGBAColorValue, ColorExpression, NumberExpression, GradientColor, FixedVec3Expression, vec4, vec3, BezierKeyframeValue, vec2 } from '@galacean/effects-specification';
 import { ParticleOrigin } from '@galacean/effects-specification';
 export declare function arrAdd<T>(arr: T[], item: T): boolean | undefined;
-/**
- * @deprecated 请直接使用 Array.prototype.forEach 或 for...of
- * @param object
- * @param callback
- * @returns the mutated input object
- */
-export declare function forEach<T>(object: null | undefined | {
-    [key: string]: T | Record<any, T>;
-}, callback: (val: T, key: string) => void, thisObj?: any): {
-    [key: string]: T | Record<any, T>;
-} | null | undefined;
 export declare function ensureFixedNumber(a: any): FixedNumberExpression | undefined;
 export declare function ensureFixedNumberWithRandom(a: any, p: number): FixedNumberExpression | undefined;
 export declare function ensureRGBAValue(a: any): RGBAColorValue;

package/dist/gl/create-gl-context.d.ts

@@ -1,3 +1,4 @@
+export type GLType = 'webgl' | 'webgl2';
 /**
  * Helper class to create a WebGL Context
  *
@@ -6,4 +7,4 @@
  * @param options
  * @returns
  */
-export declare function createGLContext(canvas: HTMLCanvasElement | OffscreenCanvas, glType: "webgl" | "webgl2" | undefined, options: WebGLContextAttributes): WebGLRenderingContext | WebGL2RenderingContext;
+export declare function createGLContext(canvas: HTMLCanvasElement | OffscreenCanvas, glType: GLType | undefined, options: WebGLContextAttributes): WebGLRenderingContext | WebGL2RenderingContext;

package/dist/gl/index.d.ts

@@ -1,6 +1,9 @@
+import * as spec from '@galacean/effects-specification';
 export * from './create-gl-context';
 export * from './gpu-time';
 export declare const initErrors: string[];
 export declare const glContext: WebGL2RenderingContext;
 export declare function initGLContext(): void;
 export declare function isWebGL2(gl: WebGLRenderingContext | WebGL2RenderingContext): gl is WebGL2RenderingContext;
+export declare function vertexFormatType2GLType(formatType: spec.VertexFormatType): spec.BufferType;
+export declare function glType2VertexFormatType(webglType: spec.BufferType): spec.VertexFormatType;

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 export * as math from '@galacean/effects-math/es/core/index';
 export * as spec from '@galacean/effects-specification';
-export { getStandardComposition, getStandardImage, getStandardItem, getStandardJSON, ensureFixedNumber, normalizeColor, } from './fallback';
+export * from './asset-loader';
 export * from './asset-manager';
 export * from './camera';
+export * from './canvas-pool';
 export * from './comp-vfx-item';
 export * from './components';
 export * from './composition';
@@ -10,10 +11,10 @@ export * from './composition-source-manager';
 export * from './config';
 export * from './constants';
 export * from './decorators';
-export * from './asset-loader';
 export * from './downloader';
 export * from './effects-object';
 export * from './engine';
+export { ensureFixedNumber, getStandardComposition, getStandardImage, getStandardItem, getStandardJSON, normalizeColor } from './fallback';
 export * from './gl';
 export * from './material';
 export * from './math';
@@ -22,13 +23,13 @@ export * from './plugin-system';
 export * from './plugins';
 export * from './render';
 export * from './scene';
+export * from './serialization-helper';
 export * from './shader';
 export * from './shape';
 export * from './template-image';
 export * from './texture';
-export * from './serialization-helper';
 export * from './ticker';
 export * from './transform';
 export * from './utils';
 export * from './vfx-item';
-export * from './canvas-pool';
+export * from './binary-asset';