@galacean/effects-core 2.7.3 → 2.8.0-alpha.0

package/dist/asset-manager.d.ts

@@ -9,7 +9,7 @@ import type { Renderer } from './render';
  * 用于加载和动效中所有的资源文件，包括图片、插件、图层粒子数据等
  */
 export declare class AssetManager implements Disposable {
-    options: Omit<SceneLoadOptions, 'speed' | 'autoplay' | 'reusable'>;
+    options: SceneLoadOptions;
     private readonly downloader;
     /**
      * 相对 url 的基本路径
@@ -40,16 +40,16 @@ export declare class AssetManager implements Disposable {
     /**
      * 字体加载方法
      * @param fonts - 字体定义数组
-     * @param [baseURL=location.href] - URL 的 base 字段
+     * @param [baseUrl=location.href] - URL 的 base 字段
      * @returns
      */
-    static loadFontFamily(fonts: spec.FontDefine[], baseURL?: string): Promise<void[] | undefined>;
+    static loadFontFamily(fonts: spec.FontDefine[], baseUrl?: string): Promise<void[] | undefined>;
     /**
      * 构造函数
      * @param options - 场景加载参数
      * @param downloader - 资源下载对象
      */
-    constructor(options?: Omit<SceneLoadOptions, 'speed' | 'autoplay' | 'reusable'>, downloader?: Downloader);
+    constructor(options?: SceneLoadOptions, downloader?: Downloader);
     updateOptions(options?: SceneLoadOptions): void;
     /**
      * 场景创建，通过 json 创建出场景对象，并进行提前编译等工作
@@ -59,7 +59,7 @@ export declare class AssetManager implements Disposable {
      * @returns
      */
     loadScene(url: Scene.LoadType, renderer?: Renderer, options?: {
-        env: string;
+        env?: string;
     }): Promise<Scene>;
     getAssets(): Record<string, ImageLike>;
     private processJSON;

package/dist/components/index.d.ts

@@ -2,6 +2,7 @@ export * from './animator';
 export * from './renderer-component';
 export * from './component';
 export * from './effect-component';
+export * from './position-constraint';
 export * from './post-process-volume';
 export * from './base-render-component';
 export * from './shape-component';

package/dist/components/position-constraint.d.ts

@@ -0,0 +1,92 @@
+import type { VFXItem } from '../vfx-item';
+import { Component } from './component';
+import type { ComponentData } from '@galacean/effects-specification';
+import type * as spec from '@galacean/effects-specification';
+export declare class ConstraintTarget {
+    target: VFXItem | null;
+    weight: number;
+}
+export interface ConstraintTargetData {
+    target: spec.DataPath;
+    weight: number;
+}
+export interface PositionConstraintData extends ComponentData {
+    positionAtRest: spec.Vector3Data;
+    positionOffset: spec.Vector3Data;
+    weight: number;
+    constrainX: boolean;
+    constrainY: boolean;
+    constrainZ: boolean;
+    targets: ConstraintTargetData[];
+}
+/**
+ * 位置约束组件
+ * 用于约束物体跟随目标对象的位置
+ */
+export declare class PositionConstraint extends Component {
+    /**
+     * 初始位置（当前元素的初始世界位置）
+     */
+    private positionAtRest;
+    /**
+     * 位置偏移
+     */
+    private positionOffset;
+    /**
+     * 约束权重 (0-1)
+     */
+    private weight;
+    /**
+     * 是否约束 X 轴
+     */
+    private constrainX;
+    /**
+     * 是否约束 Y 轴
+     */
+    private constrainY;
+    /**
+     * 是否约束 Z 轴
+     */
+    private constrainZ;
+    /**
+     * 约束目标
+     */
+    private targets;
+    onStart(): void;
+    onUpdate(dt: number): void;
+    /**
+     * 添加约束目标
+     * @param target - 目标元素
+     * @param weight - 权重值 (0-1)
+     */
+    addTarget(target: VFXItem, weight?: number): void;
+    /**
+     * 移除约束目标
+     * @param target - 要移除的目标元素
+     */
+    removeTarget(target: VFXItem): void;
+    /**
+     * 清除所有约束目标
+     */
+    clearTargets(): void;
+    /**
+     * 设置位置偏移
+     * @param x - X 轴偏移
+     * @param y - Y 轴偏移
+     * @param z - Z 轴偏移
+     */
+    setPositionOffset(x: number, y: number, z: number): void;
+    /**
+     * 设置全局约束权重
+     * @param weight - 权重值 (0-1)，0 表示保持初始位置，1 表示完全跟随目标
+     */
+    setWeight(weight: number): void;
+    /**
+     * 线性插值
+     * @param start - 起始值
+     * @param end - 结束值
+     * @param t - 插值因子 (0-1)
+     */
+    private lerp;
+    fromData(data: PositionConstraintData): void;
+}

package/dist/composition.d.ts

@@ -4,7 +4,7 @@ import type { Matrix4 } from '@galacean/effects-math/es/core/matrix4';
 import { Camera } from './camera';
 import { CompositionComponent } from './comp-vfx-item';
 import type { PluginSystem } from './plugin-system';
-import type { EventSystem, Plugin, Region } from './plugins';
+import type { EventSystem, Region } from './plugins';
 import type { Renderer } from './render';
 import { RenderFrame } from './render';
 import type { Scene } from './scene';
@@ -96,7 +96,7 @@ export interface CompositionProps {
      * @param message
      * @returns
      */
-    handleItemMessage: (message: MessageItem) => void;
+    onItemMessage?: (message: MessageItem) => void;
     /**
      *
      */
@@ -215,6 +215,10 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
      * 是否开启后处理
      */
     postProcessingEnabled: boolean;
+    /**
+     * 合成中消息元素创建/销毁时触发的回调
+     */
+    onItemMessage?: (message: MessageItem) => void;
     /**
      * 销毁状态位
      */
@@ -223,7 +227,6 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
      * 是否是否每次渲染时清除 RenderFrame 颜色缓存
      */
     protected readonly keepColorBuffer: boolean;
-    protected readonly postLoaders: Plugin[];
     protected rootComposition: CompositionComponent;
     /**
      * 合成暂停/播放 标识
@@ -232,10 +235,6 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
     private isEndCalled;
     private _textures;
     private videos;
-    /**
-     * 合成中消息元素创建/销毁时触发的回调
-     */
-    private handleItemMessage;
     /**
      * Composition 构造函数
      * @param props - composition 的创建参数

package/dist/constants.d.ts

@@ -7,4 +7,8 @@ export declare const PLAYER_OPTIONS_ENV_EDITOR = "editor";
 export declare const HELP_LINK: {
     'Item duration can\'t be less than 0': string;
     'ValueType: 21/22 is not supported': string;
+    'Container size overflowed': string;
+    'Container is not an HTMLElement': string;
+    'Invalid container size': string;
+    'DPI overflowed': string;
 };

package/dist/downloader.d.ts

@@ -52,6 +52,13 @@ export declare class Downloader {
      * @param onError - 下载失败后的回调函数
      */
     downloadBlob(url: string, onSuccess: SuccessHandler<Blob>, onError: ErrorHandler): void;
+    /**
+     * 下载一个文本文件
+     * @param url - 要下载的文本文件的 URL
+     * @param onSuccess - 下载成功后的回调函数
+     * @param onError - 下载失败后的回调函数
+     */
+    downloadText(url: string, onSuccess: SuccessHandler<string>, onError: ErrorHandler): void;
     private download;
     private start;
     private finish;

package/dist/engine.d.ts

@@ -6,10 +6,46 @@ import type { GPUCapability, Geometry, Mesh, RenderPass, Renderer, ShaderLibrary
 import type { Scene, SceneRenderLevel } from './scene';
 import type { Texture } from './texture';
 import type { Disposable } from './utils';
+import type { Composition } from './composition';
+import type { AssetManager } from './asset-manager';
+import { AssetService } from './asset-service';
+import { Ticker } from './ticker';
+import { EventSystem } from './plugins/interact/event-system';
+import type { GLType } from './gl/create-gl-context';
+import type { PointerEventData, Region } from './plugins/interact/click-handler';
+import { EventEmitter } from './events';
+export interface EngineOptions extends WebGLContextAttributes {
+    name?: string;
+    glType?: GLType;
+    fps?: number;
+    env?: string;
+    manualRender?: boolean;
+    pixelRatio?: number;
+    notifyTouch?: boolean;
+    interactive?: boolean;
+}
+type EngineEvent = {
+    contextlost: [eventData: {
+        engine: Engine;
+        e: Event;
+    }];
+    contextrestored: [engine: Engine];
+    rendererror: [e: Event | Error];
+    resize: [Engine];
+    click: [eventData: Region];
+    pointerdown: [eventData: PointerEventData];
+    pointerup: [eventData: PointerEventData];
+    pointermove: [eventData: PointerEventData];
+};
 /**
  * Engine 基类，负责维护所有 GPU 资源的管理及销毁
  */
-export declare class Engine implements Disposable {
+export declare class Engine extends EventEmitter<EngineEvent> implements Disposable {
+    name: string;
+    speed: number;
+    displayAspect: number;
+    displayScale: number;
+    offscreenMode: boolean;
     /**
      * 渲染器
      */
@@ -31,21 +67,37 @@ export declare class Engine implements Disposable {
      * 渲染过程中错误队列
      */
     renderErrors: Set<Error>;
-    protected destroyed: boolean;
+    compositions: Composition[];
+    assetManagers: AssetManager[];
+    assetService: AssetService;
+    eventSystem: EventSystem;
+    env: string;
+    /**
+     * 计时器
+     * 手动渲染 `manualRender=true` 时不创建计时器
+     */
+    ticker: Ticker | null;
+    canvas: HTMLCanvasElement;
+    /**
+     * 引擎的像素比
+     */
+    pixelRatio: number;
+    protected _disposed: boolean;
     protected textures: Texture[];
     protected materials: Material[];
     protected geometries: Geometry[];
     protected meshes: Mesh[];
     protected renderPasses: RenderPass[];
     private assetLoader;
+    get disposed(): boolean;
     /**
      *
      */
-    constructor();
+    constructor(canvas: HTMLCanvasElement, options?: EngineOptions);
     /**
      * 创建 Engine 对象。
      */
-    static create: (gl: WebGLRenderingContext | WebGL2RenderingContext) => Engine;
+    static create: (canvas: HTMLCanvasElement, options?: EngineOptions) => Engine;
     clearResources(): void;
     addEffectsObjectData(data: spec.EffectsObjectData): void;
     findEffectsObjectData(uuid: string): spec.EffectsObjectData;
@@ -56,7 +108,14 @@ export declare class Engine implements Disposable {
     findObject<T>(guid: spec.DataPath): T;
     removeInstance(id: string): void;
     addPackageDatas(scene: Scene): void;
-    createVFXItems(scene: Scene): Promise<void>;
+    runRenderLoop(renderFunction: (dt: number) => void): void;
+    render(dt: number): void;
+    /**
+     * 将渲染器重新和父容器大小对齐
+     */
+    resize(): void;
+    setSize(width: number, height: number): void;
+    private getTargetSize;
     addTexture(tex: Texture): void;
     removeTexture(tex: Texture): void;
     addMaterial(mat: Material): void;
@@ -67,10 +126,12 @@ export declare class Engine implements Disposable {
     removeMesh(mesh: Mesh): void;
     addRenderPass(pass: RenderPass): void;
     removeRenderPass(pass: RenderPass): void;
-    get isDestroyed(): boolean;
+    addComposition(composition: Composition): void;
+    removeComposition(composition: Composition): void;
     getShaderLibrary(): ShaderLibrary;
     /**
      * 销毁所有缓存的资源
      */
     dispose(): void;
 }
+export {};

package/dist/events/types.d.ts

@@ -1,9 +1,23 @@
 import type { MessageItem } from '../composition';
-import type { Region } from '../plugins';
+import type { PointerEventData, Region } from '../plugins';
+export type PointerEvent = {
+    /**
+     * 按下事件
+     */
+    ['pointerdown']: [eventData: PointerEventData];
+    /**
+     * 抬起事件
+     */
+    ['pointerup']: [eventData: PointerEventData];
+    /**
+     * 移动事件
+     */
+    ['pointermove']: [eventData: PointerEventData];
+};
 /**
  * Item 可以绑定的事件
  */
-export type ItemEvent = {
+export type ItemEvent = PointerEvent & {
     /**
      * 元素点击事件（编辑器设置交互行为“消息通知”）
      */
@@ -17,13 +31,19 @@ export type ItemEvent = {
 /**
  * Composition 可以绑定的事件
  */
-export type CompositionEvent<C> = {
+export type CompositionEvent<C> = PointerEvent & {
     /**
      * 合成点击事件
      */
     ['click']: [
         clickInfo: Region & {
+            /**
+             * @deprecated 2.8.0
+             */
             compositionName: string;
+            /**
+             * @deprecated 2.8.0
+             */
             compositionId: string;
         }
     ];
@@ -44,9 +64,14 @@ export type CompositionEvent<C> = {
      * 合成行为为循环时每次循环结束都会触发
      * 合成行为为销毁/冻结时只会触发一次
      */
-    ['end']: [endInfo: {
-        composition: C;
-    }];
+    ['end']: [
+        endInfo: {
+            /**
+             * @deprecated 2.8.0
+             */
+            composition: C;
+        }
+    ];
     /**
      * 时间跳转事件
      * 用于在合成中跳转到指定时间

package/dist/index.d.ts

@@ -23,6 +23,7 @@ export * from './material';
 export * from './math';
 export * from './paas-texture-cache';
 export * from './plugin-system';
+export * from './scene-loader';
 export * from './plugins';
 export * from './render';
 export * from './scene';