@galacean/effects-core 2.1.0-alpha.5 → 2.1.0-alpha.7

package/dist/animation/color-playable.d.ts

@@ -0,0 +1,26 @@
+import * as spec from '@galacean/effects-specification';
+import { type ValueGetter } from '../math';
+import type { FrameContext } from '../plugins/cal/playable-graph';
+import { Playable } from '../plugins/cal/playable-graph';
+import { VFXItem } from '../vfx-item';
+import type { Material } from '../material';
+import type { ColorStop } from '../utils';
+import { BaseRenderComponent } from '../components';
+export interface ColorPlayableAssetData extends spec.EffectsObjectData {
+    colorOverLifetime?: spec.ColorOverLifetime;
+}
+export declare class ColorPlayable extends Playable {
+    clipData: {
+        colorOverLifetime?: spec.ColorOverLifetime;
+        startColor?: spec.RGBAColorValue;
+    };
+    colorOverLifetime: ColorStop[];
+    opacityOverLifetime: ValueGetter<number>;
+    startColor: spec.RGBAColorValue;
+    renderColor: spec.vec4;
+    activeComponent?: BaseRenderComponent;
+    activeMaterial?: Material;
+    processFrame(context: FrameContext): void;
+    create(clipData: ColorPlayableAssetData): this;
+    getActiveComponent(boundObject: VFXItem): BaseRenderComponent;
+}

package/dist/animation/index.d.ts

@@ -0,0 +1 @@
+export * from './color-playable';

package/dist/asset-manager.d.ts

@@ -1,5 +1,6 @@
 import { Downloader } from './downloader';
-import type { Scene, SceneLoadOptions, SceneType } from './scene';
+import type { SceneLoadOptions } from './scene';
+import { Scene } from './scene';
 import type { Disposable } from './utils';
 import type { Renderer } from './render';
 /**
@@ -7,20 +8,24 @@ import type { Renderer } from './render';
  * 用于加载和动效中所有的资源文件，包括图片、插件、图层粒子数据等
  */
 export declare class AssetManager implements Disposable {
-    private options;
+    options: Omit<SceneLoadOptions, 'speed' | 'autoplay' | 'reusable'>;
     private readonly downloader;
     /**
-     * 相对url的基本路径
+     * 相对 url 的基本路径
      */
     private baseUrl;
     /**
-     * 图像资源，用于创建和释放GPU纹理资源
+     * 图像资源，用于创建和释放 GPU 纹理资源
      */
     private assets;
+    /**
+     * TextureSource 来源
+     */
+    private sourceFrom;
     /**
      * 自定义文本缓存，随页面销毁而销毁
      */
-    static fonts: Set<string>;
+    private static fontCache;
     private id;
     /**
      * 加载超时时间
@@ -36,7 +41,7 @@ export declare class AssetManager implements Disposable {
      * @param options - 场景加载参数
      * @param downloader - 资源下载对象
      */
-    constructor(options?: SceneLoadOptions, downloader?: Downloader);
+    constructor(options?: Omit<SceneLoadOptions, 'speed' | 'autoplay' | 'reusable'>, downloader?: Downloader);
     updateOptions(options?: SceneLoadOptions): void;
     /**
      * 场景创建，通过 json 创建出场景对象，并进行提前编译等工作
@@ -45,7 +50,7 @@ export declare class AssetManager implements Disposable {
      * @param options - 扩展参数
      * @returns
      */
-    loadScene(url: SceneType, renderer?: Renderer, options?: {
+    loadScene(url: Scene.LoadType, renderer?: Renderer, options?: {
         env: string;
     }): Promise<Scene>;
     private precompile;
@@ -53,9 +58,12 @@ export declare class AssetManager implements Disposable {
     private processBins;
     private processFontURL;
     private processImages;
+    private processPluginAssets;
+    private prepareAssets;
     private processTextures;
     private loadJSON;
     private loadBins;
+    private assignImagesToAssets;
     private removeTimer;
     /**
      * 销毁方法

package/dist/asset.d.ts

@@ -0,0 +1,4 @@
+import { EffectsObject } from './effects-object';
+export declare class Asset<T> extends EffectsObject {
+    data: T;
+}

package/dist/binary-asset.d.ts

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

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

@@ -2,7 +2,6 @@ import type { Ray } from '@galacean/effects-math/es/core/ray';
 import * as spec from '@galacean/effects-specification';
 import { Behaviour } from './components';
 import type { CompositionHitTestOptions } from './composition';
-import type { ContentOptions } from './composition-source-manager';
 import type { Region, TrackAsset } from './plugins';
 import { VFXItem } from './vfx-item';
 export interface SceneBinding {
@@ -19,9 +18,7 @@ export interface SceneBindingData {
 export declare class CompositionComponent extends Behaviour {
     time: number;
     startTime: number;
-    refId: string;
     items: VFXItem[];
-    data: ContentOptions;
     private reusable;
     private sceneBindings;
     private timelineAsset;
@@ -36,7 +33,7 @@ export declare class CompositionComponent extends Behaviour {
     hideItems(): void;
     onDestroy(): void;
     hitTest(ray: Ray, x: number, y: number, regions: Region[], force?: boolean, options?: CompositionHitTestOptions): Region[];
-    fromData(data: unknown): void;
+    fromData(data: any): void;
     private resolveBindings;
     private resolveTrackBindingsWithRoot;
 }

package/dist/components/base-render-component.d.ts

@@ -0,0 +1,99 @@
+import * as spec from '@galacean/effects-specification';
+import { Matrix4 } from '@galacean/effects-math/es/core/matrix4';
+import { RendererComponent } from './renderer-component';
+import type { Texture } from '../texture';
+import type { GeometryDrawMode, Renderer } from '../render';
+import { Geometry } from '../render';
+import type { Engine } from '../engine';
+import type { BoundingBoxTriangle, HitTestTriangleParams } from '../plugins';
+import { Material } from '../material';
+/**
+ * 图层元素渲染属性, 经过处理后的 spec.SpriteContent.renderer
+ */
+export interface ItemRenderer extends Required<Omit<spec.RendererOptions, 'texture' | 'shape' | 'anchor' | 'particleOrigin'>> {
+    order: number;
+    mask: number;
+    texture: Texture;
+    anchor?: spec.vec2;
+    particleOrigin?: spec.ParticleOrigin;
+}
+/**
+ * 图层的渲染属性，用于 Mesh 的合并判断
+ */
+export interface ItemRenderInfo {
+    side: number;
+    occlusion: boolean;
+    blending: number;
+    cachePrefix: string;
+    mask: number;
+    maskMode: number;
+    cacheId: string;
+    wireframe?: boolean;
+}
+export declare class BaseRenderComponent extends RendererComponent {
+    interaction?: {
+        behavior: spec.InteractBehavior;
+    };
+    cachePrefix: string;
+    geoData: {
+        atlasOffset: number[] | spec.TypedArray;
+        index: number[] | spec.TypedArray;
+    };
+    anchor?: spec.vec2;
+    renderer: ItemRenderer;
+    emptyTexture: Texture;
+    color: spec.vec4;
+    worldMatrix: Matrix4;
+    geometry: Geometry;
+    protected renderInfo: ItemRenderInfo;
+    protected readonly wireframe?: boolean;
+    protected preMultiAlpha: number;
+    protected visible: boolean;
+    protected isManualTimeSet: boolean;
+    protected frameAnimationTime: number;
+    constructor(engine: Engine);
+    /**
+     * 设置当前 Mesh 的可见性。
+     * @param visible - true：可见，false：不可见
+     */
+    setVisible(visible: boolean): void;
+    /**
+     * 获取当前 Mesh 的可见性。
+     */
+    getVisible(): boolean;
+    /**
+     * 设置当前图层的颜色
+     * > Tips: 透明度也属于颜色的一部分，当有透明度/颜色 K 帧变化时，该 API 会失效
+     * @since 2.0.0
+     * @param color - 颜色值
+     */
+    setColor(color: spec.vec4): void;
+    /**
+     * 设置当前 Mesh 的纹理
+     * @since 2.0.0
+     * @param texture - 纹理对象
+     */
+    setTexture(texture: Texture): void;
+    render(renderer: Renderer): void;
+    onStart(): void;
+    onDestroy(): void;
+    protected getItemInitData(): {
+        atlasOffset: spec.TypedArray | number[];
+        index: number[];
+    };
+    protected setItem(): void;
+    protected getItemGeometryData(): {
+        index: number[];
+        atlasOffset: number[];
+    };
+    protected createGeometry(mode: GeometryDrawMode): Geometry;
+    protected createMaterial(renderInfo: ItemRenderInfo, count: number): Material;
+    getTextures(): Texture[];
+    /**
+     * 获取图层包围盒的类型和世界坐标
+     * @returns
+     */
+    getBoundingBox(): BoundingBoxTriangle | void;
+    getHitTestParams: (force?: boolean) => HitTestTriangleParams | undefined;
+}
+export declare function getImageItemRenderInfo(item: BaseRenderComponent): ItemRenderInfo;

package/dist/components/index.d.ts

@@ -2,3 +2,5 @@ export * from './renderer-component';
 export * from './component';
 export * from './effect-component';
 export * from './post-process-volume';
+export * from './base-render-component';
+export * from './shape-component';

package/dist/components/shape-component.d.ts

@@ -0,0 +1,206 @@
+import type * as spec from '@galacean/effects-specification';
+import type { Engine } from '../engine';
+import type { Renderer } from '../render';
+import { RendererComponent } from './renderer-component';
+/**
+ * 图形组件
+ * @since 2.1.0
+ */
+export declare class ShapeComponent extends RendererComponent {
+    private path;
+    private curveValues;
+    private geometry;
+    private data;
+    private dirty;
+    private vert;
+    private frag;
+    constructor(engine: Engine);
+    onUpdate(dt: number): void;
+    render(renderer: Renderer): void;
+    private buildGeometryFromPath;
+    private buildPath;
+    fromData(data: ShapeComponentData): void;
+}
+/************************** Test Interface **********************************/
+/**
+ * 矢量图形组件
+ */
+export interface ShapeComponentData extends spec.ComponentData {
+    /**
+     * 矢量类型
+     */
+    type: ComponentShapeType;
+}
+/**
+ * 矢量图形类型
+ */
+export declare enum ComponentShapeType {
+    /**
+     * 自定义图形
+     */
+    CUSTOM = 0,
+    /**
+     * 矩形
+     */
+    RECTANGLE = 1,
+    /**
+     * 椭圆
+     */
+    ELLIPSE = 2,
+    /**
+     * 多边形
+     */
+    POLYGON = 3,
+    /**
+     * 星形
+     */
+    STAR = 4
+}
+/**
+ * 自定义图形组件
+ */
+export interface ShapeCustomComponent extends ShapeComponentData {
+    /**
+     * 矢量类型 - 形状
+     */
+    type: ComponentShapeType.CUSTOM;
+    /**
+     * 矢量参数 - 形状
+     */
+    param: ShapeCustomParam;
+}
+/**
+ * 矢量路径参数
+ */
+export interface ShapeCustomParam {
+    /**
+     * 路径点
+     */
+    points: spec.Vector3Data[];
+    /**
+     * 入射控制点
+     */
+    easingIn: spec.Vector3Data[];
+    /**
+     * 入射控制点
+     */
+    easingOut: spec.Vector3Data[];
+    /**
+     * 自定义形状
+     */
+    shapes: CustomShape[];
+}
+/**
+ * 自定义形状参数
+ */
+export interface CustomShape {
+    /**
+     * 是否垂直与平面 - 用于减少实时运算
+     */
+    verticalToPlane: 'x' | 'y' | 'z' | 'none';
+    /**
+     * 点索引 - 用于构成闭合图形
+     */
+    indexes: CustomShapePoint[];
+    /**
+     * 是否为闭合图形 - 用于Stroke
+     */
+    close: boolean;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 描边属性
+     */
+    stroke?: ShapeStrokeParam;
+    /**
+     * 空间变换
+     */
+    transform?: spec.TransformData;
+}
+/**
+ * 自定义形状点
+ */
+export interface CustomShapePoint {
+    /**
+     * 顶点索引
+     */
+    point: number;
+    /**
+     * 入射点索引
+     */
+    easingIn: number;
+    /**
+     * 出射点索引
+     */
+    easingOut: number;
+}
+/**
+ * 矢量填充参数
+ */
+export interface ShapeFillParam {
+    /**
+     * 填充颜色
+     */
+    color: spec.ColorExpression;
+}
+/**
+ * 矢量描边参数
+ */
+export interface ShapeStrokeParam {
+    /**
+     * 线宽
+     */
+    width: number;
+    /**
+     * 线颜色
+     */
+    color: spec.ColorExpression;
+    /**
+     * 连接类型
+     */
+    connectType: ShapeConnectType;
+    /**
+     * 点类型
+     */
+    pointType: ShapePointType;
+}
+export declare enum ShapeConnectType {
+}
+export declare enum ShapePointType {
+}
+/**
+ * @description 椭圆组件参数
+ */
+export interface ShapeEllipseComponent extends ShapeComponentData {
+    type: ComponentShapeType.ELLIPSE;
+    param: ShapeEllipseParam;
+}
+/**
+ * @description 椭圆参数
+ */
+export interface ShapeEllipseParam {
+    /**
+     * @description x轴半径
+     * -- TODO 后续完善类型
+     * -- TODO 可以看一下用xRadius/yRadius 还是 width/height
+     */
+    xRadius: number;
+    /**
+     * @description y轴半径
+     */
+    yRadius: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 描边属性
+     */
+    stroke?: ShapeStrokeParam;
+    /**
+     * 空间变换
+     */
+    transform?: spec.TransformData;
+}

package/dist/composition/scene-ticking.d.ts

@@ -1,4 +1,4 @@
-import { Component } from '../components/component';
+import { Component } from '../components';
 export declare class SceneTicking {
     update: UpdateTickData;
     lateUpdate: LateUpdateTickData;

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

@@ -9,20 +9,25 @@ 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;
@@ -87,7 +92,6 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
      * 是否播放完成后销毁 texture 对象
      */
     keepResource: boolean;
-    extraCamera: VFXItem;
     /**
      * 合成内的元素否允许点击、拖拽交互
      * @since 1.6.0
@@ -133,7 +137,7 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
     /**
      * 合成对应的 url 或者 JSON
      */
-    readonly url: SceneType;
+    readonly url: Scene.LoadType;
     /**
      * 合成根元素
      */
@@ -145,7 +149,7 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
     /**
      * 预合成的合成属性，在 content 中会被其元素属性覆盖
      */
-    refCompositionProps: Map<string, VFXItemProps>;
+    refCompositionProps: Map<string, spec.CompositionData>;
     /**
      * 合成的相机对象
      */
@@ -298,7 +302,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/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;