@galacean/effects-core 2.1.0-alpha.8 → 2.1.0-beta.0

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

@@ -29,8 +29,8 @@ export declare class CompositionComponent extends Behaviour {
     getReusable(): boolean;
     onUpdate(dt: number): void;
     createContent(): void;
-    showItems(): void;
-    hideItems(): void;
+    onEnable(): void;
+    onDisable(): void;
     onDestroy(): void;
     hitTest(ray: Ray, x: number, y: number, regions: Region[], force?: boolean, options?: CompositionHitTestOptions): Region[];
     fromData(data: any): void;

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

@@ -7,6 +7,7 @@ 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
  */
@@ -14,6 +15,7 @@ export interface ItemRenderer extends Required<Omit<spec.RendererOptions, 'textu
     order: number;
     mask: number;
     texture: Texture;
+    shape?: GeometryFromShape;
     anchor?: spec.vec2;
     particleOrigin?: spec.ParticleOrigin;
 }
@@ -30,6 +32,9 @@ export interface ItemRenderInfo {
     cacheId: string;
     wireframe?: boolean;
 }
+/**
+ * @since 2.1.0
+ */
 export declare class BaseRenderComponent extends RendererComponent {
     interaction?: {
         behavior: spec.InteractBehavior;
@@ -51,6 +56,10 @@ export declare class BaseRenderComponent extends RendererComponent {
     protected visible: boolean;
     protected isManualTimeSet: boolean;
     protected frameAnimationTime: number;
+    /**
+     *
+     * @param engine
+     */
     constructor(engine: Engine);
     /**
      * 设置当前 Mesh 的可见性。

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

@@ -1,43 +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;
     onUpdate(dt: number): 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;
     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

@@ -4,3 +4,4 @@ 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,14 +1,14 @@
+import * as spec from '@galacean/effects-specification';
 import { Behaviour } from './component';
+import type { Engine } from '../engine';
+/**
+ * @since 2.1.0
+ */
 export declare class PostProcessVolume extends Behaviour {
-    bloomEnabled: boolean;
-    threshold: number;
-    bloomIntensity: number;
-    brightness: number;
-    saturation: number;
-    contrast: number;
-    vignetteIntensity: number;
-    vignetteSmoothness: number;
-    vignetteRoundness: number;
-    toneMappingEnabled: boolean;
+    bloom: spec.Bloom;
+    vignette: spec.Vignette;
+    tonemapping: spec.Tonemapping;
+    colorAdjustments: spec.ColorAdjustments;
+    constructor(engine: Engine);
     onStart(): void;
 }

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

@@ -1,24 +1,27 @@
 import type * as spec from '@galacean/effects-specification';
 import type { Engine } from '../engine';
-import type { Renderer } from '../render';
-import { RendererComponent } from './renderer-component';
+import { MeshComponent } from './mesh-component';
 /**
  * 图形组件
  * @since 2.1.0
  */
-export declare class ShapeComponent extends RendererComponent {
+export declare class ShapeComponent extends MeshComponent {
     private path;
     private curveValues;
-    private geometry;
     private data;
     private animated;
     private vert;
     private frag;
+    /**
+     *
+     * @param engine
+     */
     constructor(engine: Engine);
+    onStart(): void;
     onUpdate(dt: number): void;
-    render(renderer: Renderer): void;
     private buildGeometryFromPath;
     private buildPath;
+    private setFillColor;
     fromData(data: ShapeComponentData): void;
 }
 /************************** Test Interface **********************************/
@@ -29,62 +32,53 @@ export interface ShapeComponentData extends spec.ComponentData {
     /**
      * 矢量类型
      */
-    type: ComponentShapeType;
+    type: ShapePrimitiveType;
 }
 /**
  * 矢量图形类型
  */
-export declare enum ComponentShapeType {
+export declare enum ShapePrimitiveType {
     /**
      * 自定义图形
      */
-    CUSTOM = 0,
+    Custom = 0,
     /**
      * 矩形
      */
-    RECTANGLE = 1,
+    Rectangle = 1,
     /**
      * 椭圆
      */
-    ELLIPSE = 2,
+    Ellipse = 2,
     /**
      * 多边形
      */
-    POLYGON = 3,
+    Polygon = 3,
     /**
      * 星形
      */
-    STAR = 4
+    Star = 4
 }
 /**
  * 自定义图形组件
  */
-export interface ShapeCustomComponent extends ShapeComponentData {
+export interface CustomShapeData extends ShapeComponentData {
     /**
      * 矢量类型 - 形状
      */
-    type: ComponentShapeType.CUSTOM;
-    /**
-     * 矢量参数 - 形状
-     */
-    param: ShapeCustomParam;
-}
-/**
- * 矢量路径参数
- */
-export interface ShapeCustomParam {
+    type: ShapePrimitiveType.Custom;
     /**
      * 路径点
      */
-    points: spec.Vector3Data[];
+    points: spec.Vector2Data[];
     /**
      * 入射控制点
      */
-    easingIn: spec.Vector3Data[];
+    easingIns: spec.Vector2Data[];
     /**
      * 入射控制点
      */
-    easingOut: spec.Vector3Data[];
+    easingOuts: spec.Vector2Data[];
     /**
      * 自定义形状
      */
@@ -94,10 +88,6 @@ export interface ShapeCustomParam {
  * 自定义形状参数
  */
 export interface CustomShape {
-    /**
-     * 是否垂直与平面 - 用于减少实时运算
-     */
-    verticalToPlane: 'x' | 'y' | 'z' | 'none';
     /**
      * 点索引 - 用于构成闭合图形
      */
@@ -143,7 +133,7 @@ export interface ShapeFillParam {
     /**
      * 填充颜色
      */
-    color: spec.ColorExpression;
+    color: spec.ColorData;
 }
 /**
  * 矢量描边参数
@@ -156,7 +146,7 @@ export interface ShapeStrokeParam {
     /**
      * 线颜色
      */
-    color: spec.ColorExpression;
+    color: spec.ColorData;
     /**
      * 连接类型
      */
@@ -171,24 +161,18 @@ export declare enum ShapeConnectType {
 export declare enum ShapePointType {
 }
 /**
- * @description 椭圆组件参数
- */
-export interface ShapeEllipseComponent extends ShapeComponentData {
-    type: ComponentShapeType.ELLIPSE;
-    param: ShapeEllipseParam;
-}
-/**
- * @description 椭圆参数
+ * 椭圆组件参数
  */
-export interface ShapeEllipseParam {
+export interface EllipseData extends ShapeComponentData {
+    type: ShapePrimitiveType.Ellipse;
     /**
-     * @description x轴半径
+     * x 轴半径
      * -- TODO 后续完善类型
      * -- TODO 可以看一下用xRadius/yRadius 还是 width/height
      */
     xRadius: number;
     /**
-     * @description y轴半径
+     * y 轴半径
      */
     yRadius: number;
     /**
@@ -204,3 +188,98 @@ export interface ShapeEllipseParam {
      */
     transform?: spec.TransformData;
 }
+/**
+ * 星形参数
+ */
+export interface StarData extends ShapeComponentData {
+    /**
+     * 顶点数 - 内外顶点同数
+     */
+    pointCount: number;
+    /**
+     * 内径
+     */
+    innerRadius: number;
+    /**
+     * 外径
+     */
+    outerRadius: number;
+    /**
+     * 内径点圆度
+     */
+    innerRoundness: number;
+    /**
+     * 外径点圆度
+     */
+    outerRoundness: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 描边属性
+     */
+    stroke?: ShapeStrokeParam;
+    /**
+     * 空间变换
+     */
+    transform?: spec.TransformData;
+}
+/**
+ * 多边形参数
+ */
+export interface PolygonData extends ShapeComponentData {
+    /**
+     * 顶点数
+     */
+    pointCount: number;
+    /**
+     * 外切圆半径
+     */
+    radius: number;
+    /**
+     * 角点圆度
+     */
+    roundness: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 描边属性
+     */
+    stroke?: ShapeStrokeParam;
+    /**
+     * 空间变换
+     */
+    transform?: spec.TransformData;
+}
+/**
+ * 矩形参数
+ */
+export interface RectangleData extends ShapeComponentData {
+    /**
+     * 宽度
+     */
+    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';
+/**
+ *
+ */
 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 {

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';
@@ -17,6 +16,9 @@ import type { CompositionEvent } from './events';
 import { EventEmitter } from './events';
 import type { PostProcessVolume } from './components';
 import { SceneTicking } from './composition/scene-ticking';
+/**
+ * 合成统计信息
+ */
 export interface CompositionStatistic {
     loadStart: number;
     loadTime: number;
@@ -29,18 +31,15 @@ export interface CompositionStatistic {
      */
     firstFrameTime: number;
 }
+/**
+ * 合成消息对象
+ */
 export interface MessageItem {
     id: string;
     name: string;
     phrase: number;
     compositionId: string;
 }
-export interface CompItemClickedData {
-    name: string;
-    id: string;
-    hitPositions: Vector3[];
-    position: Vector3;
-}
 /**
  *
  */
@@ -49,6 +48,9 @@ export interface CompositionHitTestOptions {
     stop?: (region: Region) => boolean;
     skip?: (item: VFXItem) => boolean;
 }
+/**
+ *
+ */
 export interface CompositionProps {
     reusable?: boolean;
     baseRenderOrder?: number;
@@ -66,6 +68,9 @@ export interface CompositionProps {
  */
 export declare class Composition extends EventEmitter<CompositionEvent<Composition>> implements Disposable, LostHandler {
     renderer: Renderer;
+    /**
+     *
+     */
     sceneTicking: SceneTicking;
     /**
      * 当前帧的渲染数据对象
@@ -97,6 +102,10 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
      * @since 1.6.0
      */
     interactive: boolean;
+    /**
+     * 合成是否结束
+     */
+    isEnded: boolean;
     compositionSourceManager: CompositionSourceManager;
     /**
      * 合成id
@@ -121,7 +130,7 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
     /**
      * 是否在合成结束时自动销毁引用的纹理，合成重播时不销毁
      */
-    autoRefTex: boolean;
+    readonly autoRefTex: boolean;
     /**
      * 当前合成名称
      */
@@ -149,7 +158,7 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
     /**
      * 预合成的合成属性，在 content 中会被其元素属性覆盖
      */
-    refCompositionProps: Map<string, spec.CompositionData>;
+    readonly refCompositionProps: Map<string, spec.CompositionData>;
     /**
      * 合成的相机对象
      */
@@ -179,6 +188,7 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
      */
     private paused;
     private lastVideoUpdateTime;
+    private isEndCalled;
     private readonly texInfo;
     /**
      * 合成中消息元素创建/销毁时触发的回调

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> = {
     /**