@galacean/effects-core 2.1.0-alpha.0 → 2.1.0-alpha.10

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,12 +41,8 @@ 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;
-    /**
-     * 根据用户传入的参数修改场景数据
-     */
-    private updateSceneData;
     /**
      * 场景创建，通过 json 创建出场景对象，并进行提前编译等工作
      * @param url - json 的 URL 链接或者 json 对象
@@ -49,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;
@@ -57,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;
@@ -32,9 +29,11 @@ export declare class CompositionComponent extends Behaviour {
     getReusable(): boolean;
     onUpdate(dt: number): void;
     createContent(): void;
+    showItems(): void;
+    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;
+    private updateTrackAnimatedObject;
 }

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

@@ -0,0 +1,108 @@
+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';
+import type { GeometryFromShape } from '../shape';
+/**
+ * 图层元素渲染属性, 经过处理后的 spec.SpriteContent.renderer
+ */
+export interface ItemRenderer extends Required<Omit<spec.RendererOptions, 'texture' | 'shape' | 'anchor' | 'particleOrigin'>> {
+    order: number;
+    mask: number;
+    texture: Texture;
+    shape?: GeometryFromShape;
+    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;
+}
+/**
+ * @since 2.1.0
+ */
+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;
+    /**
+     *
+     * @param engine
+     */
+    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/effect-component.d.ts

@@ -1,42 +1,11 @@
-import { Matrix4 } from '@galacean/effects-math/es/core/matrix4';
 import type { Engine } from '../engine';
-import type { Material, MaterialDestroyOptions } from '../material';
-import type { BoundingBoxTriangle, HitTestTriangleParams } from '../plugins';
-import type { MeshDestroyOptions, Renderer } from '../render';
-import type { Geometry } from '../render';
-import { DestroyOptions } from '../utils';
-import { RendererComponent } from './renderer-component';
+import { MeshComponent } from './mesh-component';
 /**
  * @since 2.0.0
  */
-export declare class EffectComponent extends RendererComponent {
-    /**
-     * Mesh 的世界矩阵
-     */
-    worldMatrix: Matrix4;
-    /**
-     * Mesh 的 Geometry
-     */
-    geometry: Geometry;
-    private triangles;
-    private destroyed;
-    private hitTestGeometry;
+export declare class EffectComponent extends MeshComponent {
     constructor(engine: Engine);
     onStart(): void;
-    render(renderer: Renderer): void;
-    /**
-     * 设置当前 Mesh 的材质
-     * @param material - 要设置的材质
-     * @param destroy - 可选的材质销毁选项
-     */
-    setMaterial(material: Material, destroy?: MaterialDestroyOptions | DestroyOptions.keep): void;
-    getHitTestParams: (force?: boolean) => HitTestTriangleParams | void;
-    getBoundingBox(): BoundingBoxTriangle | void;
+    onUpdate(dt: number): void;
     fromData(data: unknown): void;
-    toData(): void;
-    /**
-     * 销毁当前资源
-     * @param options - 可选的销毁选项
-     */
-    dispose(options?: MeshDestroyOptions): void;
 }

package/dist/components/fake-3d-component.d.ts

@@ -0,0 +1,28 @@
+import { Component } from './component';
+import { EffectComponent } from './effect-component';
+export declare class Fake3DComponent extends Component {
+    loop: boolean;
+    amountOfMotion: number;
+    animationLength: number;
+    mode: Fake3DAnimationMode;
+    startPositionX: number;
+    startPositionY: number;
+    startPositionZ: number;
+    endPositionX: number;
+    endPositionY: number;
+    endPositionZ: number;
+    amplitudeX: number;
+    amplitudeY: number;
+    amplitudeZ: number;
+    phaseX: number;
+    phaseY: number;
+    phaseZ: number;
+    effectComponent: EffectComponent;
+    onStart(): void;
+    onUpdate(dt: number): void;
+    updateFake3D(): void;
+}
+export declare enum Fake3DAnimationMode {
+    Circular = 0,
+    Linear = 1
+}

package/dist/components/index.d.ts

@@ -2,3 +2,6 @@ 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';
+export * from './fake-3d-component';

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

@@ -0,0 +1,21 @@
+import type { BoundingBoxTriangle, HitTestTriangleParams } from '../plugins';
+import { MeshCollider } from '../plugins';
+import type { Geometry } from '../render/geometry';
+import type { Renderer } from '../render/renderer';
+import { RendererComponent } from './renderer-component';
+/**
+ * Mesh 组件
+ */
+export declare class MeshComponent extends RendererComponent {
+    /**
+     * 渲染的 Geometry
+     */
+    protected geometry: Geometry;
+    /**
+     * 用于点击测试的碰撞器
+     */
+    protected meshCollider: MeshCollider;
+    render(renderer: Renderer): void;
+    getHitTestParams: (force?: boolean) => HitTestTriangleParams | void;
+    getBoundingBox(): BoundingBoxTriangle | void;
+}

package/dist/components/post-process-volume.d.ts

@@ -1,7 +1,9 @@
 import { Behaviour } from './component';
+/**
+ * @since 2.1.0
+ */
 export declare class PostProcessVolume extends Behaviour {
-    useHDR: boolean;
-    useBloom: boolean;
+    bloomEnabled: boolean;
     threshold: number;
     bloomIntensity: number;
     brightness: number;
@@ -10,6 +12,6 @@ export declare class PostProcessVolume extends Behaviour {
     vignetteIntensity: number;
     vignetteSmoothness: number;
     vignetteRoundness: number;
-    useToneMapping: boolean;
+    toneMappingEnabled: boolean;
     onStart(): void;
 }

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

@@ -0,0 +1,291 @@
+import type * as spec from '@galacean/effects-specification';
+import type { Engine } from '../engine';
+import { MeshComponent } from './mesh-component';
+/**
+ * 图形组件
+ * @since 2.1.0
+ */
+export declare class ShapeComponent extends MeshComponent {
+    private path;
+    private curveValues;
+    private data;
+    private animated;
+    private vert;
+    private frag;
+    /**
+     *
+     * @param engine
+     */
+    constructor(engine: Engine);
+    onStart(): void;
+    onUpdate(dt: number): void;
+    private buildGeometryFromPath;
+    private buildPath;
+    fromData(data: ShapeComponentData): void;
+}
+/************************** Test Interface **********************************/
+/**
+ * 矢量图形组件
+ */
+export interface ShapeComponentData extends spec.ComponentData {
+    shapeDatas: ShapeData[];
+}
+/**
+ * 矢量图形类型
+ */
+export declare enum ShapeType {
+    /**
+     * 自定义图形
+     */
+    Custom = 0,
+    /**
+     * 矩形
+     */
+    Rectangle = 1,
+    /**
+     * 椭圆
+     */
+    Ellipse = 2,
+    /**
+     * 多边形
+     */
+    Polygon = 3,
+    /**
+     * 星形
+     */
+    Star = 4
+}
+export declare class ShapeData {
+    /**
+     * 矢量类型
+     */
+    type: ShapeType;
+}
+/**
+ * 自定义图形组件
+ */
+export interface CustomShapeData extends ShapeData {
+    /**
+     * 矢量类型 - 形状
+     */
+    type: ShapeType.Custom;
+    /**
+     * 路径点
+     */
+    points: spec.Vector3Data[];
+    /**
+     * 入射控制点
+     */
+    easingIns: spec.Vector3Data[];
+    /**
+     * 入射控制点
+     */
+    easingOuts: 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 {
+}
+/**
+ * 椭圆组件参数
+ */
+export interface EllipseData extends ShapeData {
+    type: ShapeType.Ellipse;
+    /**
+     * x 轴半径
+     * -- TODO 后续完善类型
+     * -- TODO 可以看一下用xRadius/yRadius 还是 width/height
+     */
+    xRadius: number;
+    /**
+     * y 轴半径
+     */
+    yRadius: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 描边属性
+     */
+    stroke?: ShapeStrokeParam;
+    /**
+     * 空间变换
+     */
+    transform?: spec.TransformData;
+}
+/**
+ * 星形参数
+ */
+export interface StarData extends ShapeData {
+    /**
+     * 顶点数 - 内外顶点同数
+     */
+    pointCount: number;
+    /**
+     * 内径
+     */
+    innerRadius: number;
+    /**
+     * 外径
+     */
+    outerRadius: number;
+    /**
+     * 内径点圆度
+     */
+    innerRoundness: number;
+    /**
+     * 外径点圆度
+     */
+    outerRoundness: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 描边属性
+     */
+    stroke?: ShapeStrokeParam;
+    /**
+     * 空间变换
+     */
+    transform?: spec.TransformData;
+}
+/**
+ * 多边形参数
+ */
+export interface PolygonData extends ShapeData {
+    /**
+     * 顶点数
+     */
+    pointCount: number;
+    /**
+     * 外切圆半径
+     */
+    radius: number;
+    /**
+     * 角点圆度
+     */
+    roundness: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 描边属性
+     */
+    stroke?: ShapeStrokeParam;
+    /**
+     * 空间变换
+     */
+    transform?: spec.TransformData;
+}
+/**
+ * 矩形参数
+ */
+export interface RectangleData extends ShapeData {
+    /**
+     * 宽度
+     */
+    width: number;
+    /**
+     * 高度
+     */
+    height: number;
+    /**
+     * 角点元素
+     */
+    roundness: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 描边属性
+     */
+    stroke?: ShapeStrokeParam;
+    /**
+     * 空间变换
+     */
+    transform?: spec.TransformData;
+}

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

@@ -1,9 +1,23 @@
-import { Component } from '../components/component';
+import { Component } from '../components';
+/**
+ *
+ */
 export declare class SceneTicking {
     update: UpdateTickData;
     lateUpdate: LateUpdateTickData;
+    /**
+     *
+     * @param obj
+     */
     addComponent(obj: Component): void;
+    /**
+     *
+     * @param obj
+     */
     removeComponent(obj: Component): void;
+    /**
+     *
+     */
     clear(): void;
 }
 declare class TickData {