@galacean/effects-core 2.1.0-alpha.9 → 2.1.0

package/dist/material/material.d.ts

@@ -51,7 +51,6 @@ export interface MaterialProps {
  * Material 抽象类
  */
 export declare abstract class Material extends EffectsObject implements Disposable {
-    shader: Shader;
     shaderVariant: ShaderVariant;
     shaderSource: ShaderWithSource;
     stringTags: Record<string, string>;
@@ -62,11 +61,25 @@ export declare abstract class Material extends EffectsObject implements Disposab
     readonly props: MaterialProps;
     protected destroyed: boolean;
     protected initialized: boolean;
+    protected shaderDirty: boolean;
+    private _shader;
     /**
      *
      * @param props - 材质属性
      */
     constructor(engine: Engine, props?: MaterialProps);
+    get shader(): Shader;
+    set shader(value: Shader);
+    /**
+     * 材质的主纹理
+     */
+    get mainTexture(): Texture;
+    set mainTexture(value: Texture);
+    /**
+     * 材质的主颜色
+     */
+    get color(): Color;
+    set color(value: Color);
     /******** effects-core 中会调用 引擎必须实现 ***********************/
     /**
      * 设置 Material 的颜色融合开关

package/dist/plugins/cal/playable-graph.d.ts

@@ -22,6 +22,7 @@ export declare class PlayableGraph {
 export declare class Playable implements Disposable {
     onPlayablePlayFlag: boolean;
     onPlayablePauseFlag: boolean;
+    private duration;
     private destroyed;
     private inputs;
     private inputOuputPorts;
@@ -49,6 +50,8 @@ export declare class Playable implements Disposable {
     setInputWeight(inputIndex: number, weight: number): void;
     setTime(time: number): void;
     getTime(): number;
+    setDuration(duration: number): void;
+    getDuration(): number;
     getPlayState(): PlayState;
     setTraversalMode(mode: PlayableTraversalMode): void;
     getTraversalMode(): PlayableTraversalMode;

package/dist/plugins/interact/interact-item.d.ts

@@ -6,6 +6,7 @@ import { RendererComponent } from '../../components';
 import type { DragEventType } from './interact-vfx-item';
 import type { Renderer } from '../../render';
 /**
+ * 交互组件
  * @since 2.0.0
  */
 export declare class InteractComponent extends RendererComponent {
@@ -29,9 +30,9 @@ export declare class InteractComponent extends RendererComponent {
         dxRange: [min: number, max: number];
         dyRange: [min: number, max: number];
     };
+    private duringPlay;
     /** 是否响应点击和拖拽交互事件 */
     private _interactive;
-    private hasBeenAddedToComposition;
     set interactive(enable: boolean);
     get interactive(): boolean;
     getDragRangeX(): [min: number, max: number];
@@ -39,6 +40,8 @@ export declare class InteractComponent extends RendererComponent {
     getDragRangeY(): [min: number, max: number];
     setDragRangeY(min: number, max: number): void;
     onStart(): void;
+    onDisable(): void;
+    onEnable(): void;
     onUpdate(dt: number): void;
     render(renderer: Renderer): void;
     onDestroy(): void;

package/dist/plugins/interact/mesh-collider.d.ts

@@ -1,11 +1,15 @@
 import type { Geometry } from '../../render/geometry';
 import type { BoundingBoxTriangle } from './click-handler';
 import type { Matrix4 } from '@galacean/effects-math/es/core/matrix4';
+/**
+ *
+ */
 export declare class MeshCollider {
     private boundingBoxData;
     private geometry;
     private triangles;
     getBoundingBoxData(): BoundingBoxTriangle;
+    getBoundingBox(): BoundingBoxTriangle;
     setGeometry(geometry: Geometry, worldMatrix?: Matrix4): void;
     private geometryToTriangles;
 }

package/dist/plugins/shape/graphics-path.d.ts

@@ -4,6 +4,7 @@
  */
 import type { Matrix4 } from '@galacean/effects-math/es/core/matrix4';
 import { ShapePath } from './shape-path';
+import type { StarType } from './poly-star';
 export declare class GraphicsPath {
     instructions: PathInstruction[];
     private dirty;
@@ -47,17 +48,18 @@ export declare class GraphicsPath {
     ellipse(x: number, y: number, radiusX: number, radiusY: number, transform?: Matrix4): this;
     /**
      * Draws a rectangle shape. This method adds a new rectangle path to the current drawing.
-     * @param x - The x-coordinate of the top-left corner of the rectangle.
-     * @param y - The y-coordinate of the top-left corner of the rectangle.
+     * @param x - The x-coordinate of the upper-left corner of the rectangle.
+     * @param y - The y-coordinate of the upper-left corner of the rectangle.
      * @param w - The width of the rectangle.
      * @param h - The height of the rectangle.
      * @param transform - An optional `Matrix` object to apply a transformation to the rectangle.
      * @returns The instance of the current object for chaining.
      */
     rect(x: number, y: number, w: number, h: number, transform?: Matrix4): this;
+    polyStar(pointCount: number, outerRadius: number, innerRadius: number, outerRoundness: number, innerRoundness: number, starType: StarType, transform?: Matrix4): this;
     clear(): GraphicsPath;
 }
 export interface PathInstruction {
-    action: 'moveTo' | 'lineTo' | 'quadraticCurveTo' | 'bezierCurveTo' | 'arc' | 'closePath' | 'addPath' | 'arcTo' | 'ellipse' | 'rect' | 'roundRect' | 'arcToSvg' | 'poly' | 'circle' | 'regularPoly' | 'roundPoly' | 'roundShape' | 'filletRect' | 'chamferRect';
+    action: 'moveTo' | 'lineTo' | 'quadraticCurveTo' | 'bezierCurveTo' | 'arc' | 'closePath' | 'addPath' | 'arcTo' | 'ellipse' | 'rect' | 'roundRect' | 'arcToSvg' | 'poly' | 'circle' | 'regularPoly' | 'roundPoly' | 'roundShape' | 'filletRect' | 'chamferRect' | 'polyStar';
     data: any[];
 }

package/dist/plugins/shape/poly-star.d.ts

@@ -0,0 +1,42 @@
+import { ShapePrimitive } from './shape-primitive';
+export declare enum StarType {
+    Star = 0,
+    Polygon = 1
+}
+export declare class PolyStar extends ShapePrimitive {
+    pointCount: number;
+    outerRadius: number;
+    innerRadius: number;
+    outerRoundness: number;
+    innerRoundness: number;
+    starType: StarType;
+    /**
+     * bezier 顶点
+     */
+    private v;
+    /**
+     * bezier 缓入点
+     */
+    private in;
+    /**
+     * bezier 缓出点
+     */
+    private out;
+    /**
+     *
+     * @param pointCount - 多边形顶点数量
+     * @param outerRadius - 外半径大小
+     * @param innerRadius - 内半径大小
+     * @param outerRoundness - 外顶点圆滑度百分比
+     * @param innerRoundness - 内顶点圆滑度百分比
+     * @param starType - PolyStar 类型
+     */
+    constructor(pointCount?: number, outerRadius?: number, innerRadius?: number, outerRoundness?: number, innerRoundness?: number, starType?: StarType);
+    clone(): ShapePrimitive;
+    copyFrom(source: PolyStar): void;
+    copyTo(destination: PolyStar): void;
+    build(points: number[]): void;
+    triangulate(points: number[], vertices: number[], verticesOffset: number, indices: number[], indicesOffset: number): void;
+    private buildStarPath;
+    private buildPolygonPath;
+}

package/dist/plugins/shape/rectangle.d.ts

@@ -1,6 +1,6 @@
 import { ShapePrimitive } from './shape-primitive';
 /**
- * The `Rectangle` object is an area defined by its position, as indicated by its top-left corner
+ * The `Rectangle` object is an area defined by its position, as indicated by its upper-left corner
  * point (`x`, `y`) and by its `width` and its `height`.
  */
 export declare class Rectangle extends ShapePrimitive {

package/dist/plugins/shape/shape-path.d.ts

@@ -6,6 +6,7 @@ import type { Matrix4 } from '@galacean/effects-math/es/core/matrix4';
 import { Polygon } from './polygon';
 import type { GraphicsPath } from './graphics-path';
 import type { ShapePrimitive } from './shape-primitive';
+import type { StarType } from './poly-star';
 export declare class ShapePath {
     private graphicsPath;
     currentPoly: Polygon | null;
@@ -42,6 +43,17 @@ export declare class ShapePath {
      * @returns The instance of the current object for chaining.
      */
     ellipse(x: number, y: number, radiusX: number, radiusY: number, transform?: Matrix4): this;
+    polyStar(pointCount: number, outerRadius: number, innerRadius: number, outerRoundness: number, innerRoundness: number, starType: StarType, transform?: Matrix4): this;
+    /**
+     * Draws a rectangle shape. This method adds a new rectangle path to the current drawing.
+     * @param x - The x-coordinate of the upper-left corner of the rectangle.
+     * @param y - The y-coordinate of the upper-left corner of the rectangle.
+     * @param w - The width of the rectangle.
+     * @param h - The height of the rectangle.
+     * @param transform - An optional `Matrix` object to apply a transformation to the rectangle.
+     * @returns The instance of the current object for chaining.
+     */
+    rect(x: number, y: number, w: number, h: number, transform?: Matrix4): this;
     /**
      * Draws a given shape on the canvas.
      * This is a generic method that can draw any type of shape specified by the `ShapePrimitive` parameter.

package/dist/plugins/shape/shape-primitive.d.ts

@@ -1,6 +1,5 @@
 export declare abstract class ShapePrimitive {
     /** Checks whether the x and y coordinates passed to this function are contained within this ShapePrimitive. */
-    abstract contains(x: number, y: number): boolean;
     /** Checks whether the x and y coordinates passed to this function are contained within the stroke of this shape */
     /** Creates a clone of this ShapePrimitive instance. */
     abstract clone(): ShapePrimitive;
@@ -10,9 +9,7 @@ export declare abstract class ShapePrimitive {
     abstract copyTo(destination: ShapePrimitive): void;
     /** Returns the framing rectangle of the ShapePrimitive as a Rectangle object. */
     /** The X coordinate of the shape */
-    abstract getX(): number;
     /** The Y coordinate of the shape */
-    abstract getY(): number;
     abstract build(points: number[]): void;
     abstract triangulate(points: number[], vertices: number[], verticesOffset: number, indices: number[], indicesOffset: number): void;
 }

package/dist/plugins/sprite/sprite-item.d.ts

@@ -3,11 +3,10 @@ import type { Engine } from '../../engine';
 import type { GeometryDrawMode } from '../../render';
 import { Geometry } from '../../render';
 import type { GeometryFromShape } from '../../shape';
-import type { Texture } from '../../texture';
+import { type Texture } from '../../texture';
 import type { PlayableGraph, Playable } from '../cal/playable-graph';
 import { PlayableAsset } from '../cal/playable-graph';
 import type { ColorPlayableAssetData } from '../../animation';
-import type { ItemRenderer } from '../../components';
 import { BaseRenderComponent } from '../../components/base-render-component';
 /**
  * 用于创建 spriteItem 的数据类型, 经过处理后的 spec.SpriteContent
@@ -27,12 +26,6 @@ export type SpriteItemOptions = {
     startColor: spec.vec4;
     renderLevel?: spec.RenderLevel;
 };
-/**
- * 图层元素渲染属性, 经过处理后的 spec.SpriteContent.renderer
- */
-export interface SpriteItemRenderer extends ItemRenderer {
-    shape?: GeometryFromShape;
-}
 export type splitsDataType = [r: number, x: number, y: number, w: number, h: number | undefined][];
 export declare class SpriteColorPlayableAsset extends PlayableAsset {
     data: ColorPlayableAssetData;

package/dist/plugins/text/text-item.d.ts

@@ -28,6 +28,8 @@ export declare class TextComponent extends BaseRenderComponent {
      * 文本行数
      */
     lineCount: number;
+    protected readonly SCALE_FACTOR = 0.1;
+    protected readonly ALPHA_FIX_VALUE: number;
     constructor(engine: Engine, props?: TextItemProps);
     onUpdate(dt: number): void;
     fromData(data: TextItemProps): void;

package/dist/plugins/timeline/playable-assets/color-property-playable-asset.d.ts

@@ -2,6 +2,6 @@ import type { Playable, PlayableGraph } from '../../cal/playable-graph';
 import { PlayableAsset } from '../../cal/playable-graph';
 import * as spec from '@galacean/effects-specification';
 export declare class ColorPropertyPlayableAsset extends PlayableAsset {
-    curveData: spec.ColorCurveData;
+    curveData: spec.ColorCurveValue;
     createPlayable(graph: PlayableGraph): Playable;
 }

package/dist/plugins/timeline/playable-assets/index.d.ts

@@ -1,3 +1,5 @@
+export * from './color-property-playable-asset';
 export * from './float-property-playable-asset';
 export * from './sub-composition-playable-asset';
 export * from './timeline-asset';
+export * from './vector4-property-playable-asset';

package/dist/plugins/timeline/playable-assets/timeline-asset.d.ts

@@ -6,8 +6,16 @@ import type { Constructor } from '../../../utils';
 import { TrackInstance } from '../track-instance';
 export declare class TimelineAsset extends PlayableAsset {
     tracks: TrackAsset[];
+    private cacheFlattenedTracks;
+    get flattenedTracks(): TrackAsset[];
     createPlayable(graph: PlayableGraph): Playable;
     createTrack<T extends TrackAsset>(classConstructor: Constructor<T>, parent: TrackAsset, name?: string): T;
+    /**
+     * Invalidates the asset, called when tracks data changed
+     */
+    private invalidate;
+    private addSubTracksRecursive;
+    private sortTracks;
     fromData(data: spec.TimelineAssetData): void;
 }
 export declare class TimelinePlayable extends Playable {
@@ -17,8 +25,6 @@ export declare class TimelinePlayable extends Playable {
     evaluate(): void;
     compileTracks(graph: PlayableGraph, tracks: TrackAsset[]): void;
     private updateTrackAnimatedObject;
-    private sortTracks;
-    private addSubTracksRecursive;
 }
 export declare class TrackSortWrapper {
     track: TrackAsset;

package/dist/plugins/timeline/playable-assets/vector4-property-playable-asset.d.ts

@@ -2,6 +2,6 @@ import type { Playable, PlayableGraph } from '../../cal/playable-graph';
 import { PlayableAsset } from '../../cal/playable-graph';
 import type * as spec from '@galacean/effects-specification';
 export declare class Vector4PropertyPlayableAsset extends PlayableAsset {
-    curveData: spec.Vector4CurveData;
+    curveData: spec.Vector4CurveValue;
     createPlayable(graph: PlayableGraph): Playable;
 }

package/dist/plugins/timeline/playables/activation-mixer-playable.d.ts

@@ -2,6 +2,4 @@ import type { FrameContext } from '../../cal/playable-graph';
 import { Playable } from '../../cal/playable-graph';
 export declare class ActivationMixerPlayable extends Playable {
     processFrame(context: FrameContext): void;
-    private hideRendererComponents;
-    private showRendererComponents;
 }

package/dist/render/render-frame.d.ts

@@ -15,6 +15,7 @@ import type { RenderPassClearAction, RenderPassColorAttachmentOptions, RenderPas
 import { RenderPass } from './render-pass';
 import type { Renderer } from './renderer';
 import type { PostProcessVolume, RendererComponent } from '../components';
+import type { Vector3 } from '@galacean/effects-math/es/core/vector3';
 /**
  * 渲染数据，保存了当前渲染使用到的数据。
  */
@@ -194,6 +195,7 @@ export declare class RenderFrame implements Disposable {
     readonly transparentTexture: Texture;
     protected destroyed: boolean;
     protected renderPassInfoMap: WeakMap<RenderPass, RenderPassInfo>;
+    private drawObjectPass;
     constructor(options: RenderFrameOptions);
     get renderPasses(): RenderPass[];
     get isDestroyed(): boolean;
@@ -201,13 +203,13 @@ export declare class RenderFrame implements Disposable {
      * 根据 Mesh 优先级添加到 RenderPass
      * @param mesh - 要添加的 Mesh 对象
      */
-    addMeshToDefaultRenderPass(mesh?: RendererComponent): void;
+    addMeshToDefaultRenderPass(mesh: RendererComponent): void;
     /**
      * 把 Mesh 从 RenderPass 中移除，
      * 如果 renderPass 中没有 mesh，此 renderPass 会被删除
      * @param mesh - 要删除的 Mesh 对象
      */
-    removeMeshFromDefaultRenderPass(mesh: Mesh): void;
+    removeMeshFromDefaultRenderPass(mesh: RendererComponent): void;
     /**
      * 销毁 RenderFrame
      * @param options - 可以有选择销毁一些对象
@@ -262,6 +264,7 @@ export declare function findPreviousRenderPass(renderPasses: RenderPass[], rende
 export declare class GlobalUniforms {
     floats: Record<string, number>;
     ints: Record<string, number>;
+    vector3s: Record<string, Vector3>;
     vector4s: Record<string, Vector4>;
     matrices: Record<string, Matrix4>;
     samplers: string[];

package/dist/render/renderer.d.ts

@@ -1,4 +1,4 @@
-import type { Matrix4, Vector4 } from '@galacean/effects-math/es/core/index';
+import type { Matrix4, Vector3, Vector4 } from '@galacean/effects-math/es/core/index';
 import type { RendererComponent } from '../components';
 import type { Engine } from '../engine';
 import type { Material } from '../material';
@@ -21,6 +21,7 @@ export declare class Renderer implements LostHandler, RestoreHandler {
     setGlobalFloat(name: string, value: number): void;
     setGlobalInt(name: string, value: number): void;
     setGlobalVector4(name: string, value: Vector4): void;
+    setGlobalVector3(name: string, value: Vector3): void;
     setGlobalMatrix(name: string, value: Matrix4): void;
     getFramebuffer(): Framebuffer | null;
     setFramebuffer(framebuffer: Framebuffer | null): void;

package/dist/shape/geometry.d.ts

@@ -13,7 +13,7 @@ type ShapeGeometryPre = {
     p: spec.ShapePoints[1];
     s: spec.ShapeSplits[1];
 };
-export type ShapeData = {
+export type ShapeGeometryData = {
     gs: ShapeGeometryPre[];
 } | {
     g: ShapeGeometryPre;
@@ -25,6 +25,6 @@ export declare function getGeometryTriangles(geometry: spec.ShapeGeometry, optio
     aPoint: Float32Array;
     index: Uint16Array;
 };
-export declare function getGeometryByShape(shape: ShapeData, uvTransform?: number[]): GeometryFromShape;
+export declare function getGeometryByShape(shape: ShapeGeometryData, uvTransform?: number[]): GeometryFromShape;
 export declare function rotateVec2(out: vec2 | number[], vec2: vec2, angleInRad: number): vec2;
 export {};

package/dist/transform.d.ts

@@ -12,6 +12,9 @@ export interface TransformProps {
     anchor?: spec.vec2 | Vector2;
     valid?: boolean;
 }
+/**
+ *
+ */
 export declare class Transform implements Disposable {
     /**
      * 转换右手坐标系左手螺旋对应的四元数到对应的旋转角
@@ -79,6 +82,11 @@ export declare class Transform implements Disposable {
      * 最终模型矩阵对应变换的缓存，当自身矩阵或父矩阵有修改时需要更新
      */
     private readonly worldTRSCache;
+    /**
+     *
+     * @param props
+     * @param parent
+     */
     constructor(props?: TransformProps, parent?: Transform);
     set parentTransform(transform: Transform | null);
     get parentTransform(): Transform | null;

package/dist/vfx-item.d.ts

@@ -59,10 +59,6 @@ export declare class VFXItem extends EffectsObject implements Disposable {
      * 元素动画结束时行为（如何处理元素）
      */
     endBehavior: spec.EndBehavior;
-    /**
-     * 元素是否可用
-     */
-    ended: boolean;
     /**
      * 元素名称
      */
@@ -75,17 +71,19 @@ export declare class VFXItem extends EffectsObject implements Disposable {
      * 元素创建的数据图层/粒子/模型等
      */
     _content?: VFXItemContent;
-    reusable: boolean;
     type: spec.ItemType;
     props: VFXItemProps;
     isDuringPlay: boolean;
     components: Component[];
     rendererComponents: RendererComponent[];
     /**
-     * 元素可见性，该值的改变会触发 `handleVisibleChanged` 回调
-     * @protected
+     * 元素是否激活
+     */
+    private active;
+    /**
+     * 元素组件是否显示，用于批量开关元素组件
      */
-    protected visible: boolean;
+    private visible;
     /**
      * 元素动画的速度
      */
@@ -93,13 +91,54 @@ export declare class VFXItem extends EffectsObject implements Disposable {
     private listIndex;
     private isEnabled;
     private eventProcessor;
+    /**
+     *
+     * @param item
+     * @returns
+     */
     static isComposition(item: VFXItem): boolean;
+    /**
+     *
+     * @param item
+     * @returns
+     */
     static isSprite(item: VFXItem): boolean;
+    /**
+     *
+     * @param item
+     * @returns
+     */
     static isParticle(item: VFXItem): boolean;
+    /**
+     *
+     * @param item
+     * @returns
+     */
     static isNull(item: VFXItem): boolean;
+    /**
+     *
+     * @param item
+     * @returns
+     */
     static isTree(item: VFXItem): boolean;
+    /**
+     *
+     * @param item
+     * @returns
+     */
     static isCamera(item: VFXItem): boolean;
+    /**
+     *
+     * @param ancestorCandidate
+     * @param descendantCandidate
+     * @returns
+     */
     static isAncestor(ancestorCandidate: VFXItem, descendantCandidate: VFXItem): boolean;
+    /**
+     *
+     * @param engine
+     * @param props
+     */
     constructor(engine: Engine, props?: VFXItemProps);
     /**
      * 返回元素创建的数据
@@ -175,24 +214,32 @@ export declare class VFXItem extends EffectsObject implements Disposable {
      */
     getComponents<T extends Component>(classConstructor: Constructor<T>): T[];
     setParent(vfxItem: VFXItem): void;
-    /**
-     * 元素动画结束播放时回调函数
-     * @override
-     */
-    onEnd(): void;
     /**
      * 设置元素的透明度
      * @param opacity - 透明度值，范围 [0,1]
      */
     setOpacity(opacity: number): void;
     /**
-     * 获取元素显隐属性
+     * 激活或停用 VFXItem
      */
-    getVisible(): boolean;
+    setActive(value: boolean): void;
     /**
-     * 设置元素显隐属性 会触发 `handleVisibleChanged` 回调
+     * 当前 VFXItem 是否激活
+     */
+    get isActive(): boolean;
+    /**
+     * 设置元素的显隐，该设置会批量开关元素组件
      */
     setVisible(visible: boolean): void;
+    /**
+     * 元素组件显隐状态
+     */
+    get isVisible(): boolean;
+    /**
+     * 元素组件显隐状态
+     * @deprecated use isVisible instead
+     */
+    getVisible(): boolean;
     /**
      * 获取元素变换包括位置、旋转、缩放
      * @param transform 将元素变换拷贝到该对象，并将其作为返回值
@@ -247,12 +294,6 @@ export declare class VFXItem extends EffectsObject implements Disposable {
      * 获取元素当前世界坐标
      */
     getCurrentPosition(): Vector3;
-    /**
-     * 是否到达元素的结束时间
-     * @param now
-     * @returns
-     */
-    isEnded(now: number): boolean;
     find(name: string): VFXItem | undefined;
     fromData(data: VFXItemData): void;
     toData(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-core",
-  "version": "2.1.0-alpha.9",
+  "version": "2.1.0",
   "description": "Galacean Effects runtime core for the web",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",
@@ -42,7 +42,7 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "@galacean/effects-specification": "2.1.0-alpha.1",
+    "@galacean/effects-specification": "2.1.0",
     "@galacean/effects-math": "1.1.0",
     "flatbuffers": "24.3.25",
     "uuid": "9.0.1",