@galacean/effects-core 2.2.6 → 2.3.0-alpha.1

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

@@ -1,11 +1,12 @@
 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 { 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 type { MaterialProps } from '../material';
 import { Material } from '../material';
 import type { GeometryFromShape } from '../shape';
 /**
@@ -78,11 +79,17 @@ export declare class BaseRenderComponent extends RendererComponent {
      */
     setColor(color: spec.vec4): void;
     /**
-     * 设置当前 Mesh 的纹理
+     * 使用纹理对象设置当前 Mesh 的纹理
      * @since 2.0.0
-     * @param texture - 纹理对象
+     * @param input - 纹理对象
      */
-    setTexture(texture: Texture): void;
+    setTexture(input: Texture): void;
+    /**
+     * 使用资源链接异步设置当前 Mesh 的纹理
+     * @param input - 资料链接
+     * @since 2.3.0
+     */
+    setTexture(input: string): Promise<void>;
     render(renderer: Renderer): void;
     onStart(): void;
     onDestroy(): void;
@@ -96,6 +103,7 @@ export declare class BaseRenderComponent extends RendererComponent {
         atlasOffset: number[];
     };
     protected createGeometry(mode: GeometryDrawMode): Geometry;
+    protected getMaterialProps(renderInfo: ItemRenderInfo, count: number): MaterialProps;
     protected createMaterial(renderInfo: ItemRenderInfo, count: number): Material;
     getTextures(): Texture[];
     /**

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

@@ -1,17 +1,105 @@
 import * as spec from '@galacean/effects-specification';
 import type { Engine } from '../engine';
 import { MeshComponent } from './mesh-component';
+interface ShapeAttribute {
+    /**
+     * 矢量图形类型
+     */
+    type: spec.ShapePrimitiveType;
+    /**
+     * 填充属性
+     */
+    fill?: spec.ShapeFillParam;
+}
+/**
+ * 椭圆组件参数
+ */
+export interface EllipseAttribute extends ShapeAttribute {
+    type: spec.ShapePrimitiveType.Ellipse;
+    /**
+     * x 轴半径
+     * -- TODO 后续完善类型
+     * -- TODO 可以看一下用xRadius/yRadius 还是 width/height
+     */
+    xRadius: number;
+    /**
+     * y 轴半径
+     */
+    yRadius: number;
+}
+/**
+ * 矩形参数
+ */
+export interface RectangleAttribute extends ShapeAttribute {
+    /**
+     * 宽度
+     */
+    width: number;
+    /**
+     * 高度
+     */
+    height: number;
+    /**
+     * 角点元素
+     */
+    roundness: number;
+}
+/**
+ * 星形参数
+ */
+export interface StarAttribute extends ShapeAttribute {
+    /**
+     * 顶点数 - 内外顶点同数
+     */
+    pointCount: number;
+    /**
+     * 内径
+     */
+    innerRadius: number;
+    /**
+     * 外径
+     */
+    outerRadius: number;
+    /**
+     * 内径点圆度
+     */
+    innerRoundness: number;
+    /**
+     * 外径点圆度
+     */
+    outerRoundness: number;
+}
+/**
+ * 多边形参数
+ */
+export interface PolygonAttribute extends ShapeAttribute {
+    /**
+     * 顶点数
+     */
+    pointCount: number;
+    /**
+     * 外切圆半径
+     */
+    radius: number;
+    /**
+     * 角点圆度
+     */
+    roundness: number;
+}
 /**
  * 图形组件
  * @since 2.1.0
  */
 export declare class ShapeComponent extends MeshComponent {
-    private path;
+    isStroke: boolean;
+    private graphicsPath;
     private curveValues;
-    private data;
-    private animated;
+    private shapeDirty;
+    private strokeAttributes;
+    private shapeAttribute;
     private vert;
     private frag;
+    get shape(): ShapeAttribute;
     /**
      *
      * @param engine
@@ -24,3 +112,4 @@ export declare class ShapeComponent extends MeshComponent {
     private setFillColor;
     fromData(data: spec.ShapeComponentData): void;
 }
+export {};

package/dist/composition.d.ts

@@ -21,6 +21,9 @@ import { SceneTicking } from './composition/scene-ticking';
  */
 export interface CompositionStatistic {
     loadStart: number;
+    /**
+     * 加载耗时
+     */
     loadTime: number;
     /**
      * Shader 编译耗时
@@ -35,30 +38,81 @@ export interface CompositionStatistic {
  * 合成消息对象
  */
 export interface MessageItem {
+    /**
+     * 元素 ID
+     */
     id: string;
+    /**
+     * 元素名称
+     */
     name: string;
-    phrase: number;
+    /**
+     * 消息阶段（2：开始，1：结束）
+     */
+    phrase: typeof spec.MESSAGE_ITEM_PHRASE_BEGIN | typeof spec.MESSAGE_ITEM_PHRASE_END;
+    /**
+     * 合成 ID
+     */
     compositionId: string;
 }
 /**
  *
  */
 export interface CompositionHitTestOptions {
+    /**
+     *
+     */
     maxCount?: number;
+    /**
+     *
+     * @param region
+     * @returns
+     */
     stop?: (region: Region) => boolean;
+    /**
+     *
+     * @param item
+     * @returns
+     */
     skip?: (item: VFXItem) => boolean;
 }
 /**
  *
  */
 export interface CompositionProps {
+    /**
+     *
+     */
     reusable?: boolean;
+    /**
+     *
+     */
     baseRenderOrder?: number;
+    /**
+     *
+     */
     renderer: Renderer;
+    /**
+     *
+     * @param message
+     * @returns
+     */
     handleItemMessage: (message: MessageItem) => void;
+    /**
+     *
+     */
     event?: EventSystem;
+    /**
+     *
+     */
     width: number;
+    /**
+     *
+     */
     height: number;
+    /**
+     *
+     */
     speed?: number;
 }
 /**
@@ -198,7 +252,6 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
      * Composition 构造函数
      * @param props - composition 的创建参数
      * @param scene
-     * @param compositionSourceManager
      */
     constructor(props: CompositionProps, scene: Scene);
     /**
@@ -261,11 +314,18 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
      * @returns
      */
     getSpeed(): number;
+    /**
+     *
+     */
     play(): void;
     /**
      * 暂停合成的播放
      */
     pause(): void;
+    /**
+     *
+     * @returns
+     */
     getPaused(): boolean;
     /**
      * 恢复合成的播放

package/dist/config.d.ts

@@ -2,5 +2,16 @@ export declare const RUNTIME_ENV = "runtime_env";
 export declare const RENDER_PREFER_LOOKUP_TEXTURE = "lookup_texture";
 export declare const TEMPLATE_USE_OFFSCREEN_CANVAS = "offscreen_canvas";
 export declare const POST_PROCESS_SETTINGS = "post_process_settings";
+/**
+ * 获取全局配置项
+ * @param name
+ * @returns
+ */
 export declare function getConfig<T extends number | boolean | string | Record<string, any>>(name: string): T;
+/**
+ * 设置全局配置项
+ * @param name
+ * @param value
+ * @returns
+ */
 export declare function setConfig<T extends number | boolean | string | Record<string, any>>(name: string, value: T): string | number | boolean | Record<string, any>;

package/dist/downloader.d.ts

@@ -1,4 +1,13 @@
+/**
+ * 成功处理程序
+ * @template T
+ */
 type SuccessHandler<T> = (data: T) => void;
+/**
+ * 错误处理程序
+ * @param status - HTTP 状态码
+ * @param responseText - 响应文本
+ */
 type ErrorHandler = (status: number, responseText: string) => void;
 /**
  * JSON 值，它可以是字符串、数字、布尔值、对象或者 JSON 值的数组。
@@ -79,5 +88,11 @@ export declare function loadBlob(url: string): Promise<Blob>;
  * @param url - 视频文件的 URL 或 MediaProvider 对象
  */
 export declare function loadVideo(url: string | MediaProvider): Promise<HTMLVideoElement>;
+/**
+ * 异步加载一个媒体文件
+ * @param url
+ * @param loadFn
+ * @returns
+ */
 export declare function loadMedia(url: string | string[], loadFn: (url: string) => Promise<HTMLImageElement | HTMLVideoElement>): Promise<HTMLImageElement | HTMLVideoElement>;
 export {};