@galacean/effects-core 2.0.0-alpha.9 → 2.0.0-beta.0

package/dist/shader/shader-factory.d.ts

@@ -0,0 +1,35 @@
+import type { ShaderMacros } from '../render';
+import { ShaderType } from '../material';
+export interface ShaderCodeOptions {
+    level: number;
+    shaderType: ShaderType;
+    shader: string;
+    macros?: ShaderMacros;
+    removeVersion?: boolean;
+}
+export declare class ShaderFactory {
+    static registerInclude(includeName: string, includeSource: string): void;
+    static unRegisterInclude(includeName: string): void;
+    static unRegisterAllIncludes(): void;
+    /**
+     * 生成 shader，检测到 WebGL1 上下文会降级
+     * @param macros - 宏定义数组
+     * @param shader - 原始 shader 文本
+     * @param shaderType - shader 类型
+     * @return 去除版本号的 shader 文本
+     */
+    static genFinalShaderCode(options: ShaderCodeOptions): string;
+    /**
+     * Convert lower GLSL version to GLSL 300 es.
+     * @param source - code
+     * @param isFragment - Whether it is a fragment shader.
+     * */
+    private static convertTo300;
+    private static parseIncludes;
+    private static genMacroString;
+    private static genShaderVersion;
+    private static isVersion300;
+    private static removeWebGLVersion;
+    private static has300Output;
+    private static replaceMRTShader;
+}

package/dist/shape/shape.d.ts

@@ -18,4 +18,4 @@ export type ShapeGenerator = Shape & {
     alignSpeedDirection?: boolean;
     upDirection?: Vector3;
 };
-export declare function createShape(shapeOptions: spec.ParticleShape): Shape;
+export declare function createShape(shapeOptions?: spec.ParticleShape): Shape;

package/dist/template-image.d.ts

@@ -1,5 +1,5 @@
-import type { TemplateContent } from '@galacean/effects-specification';
-export declare function getBackgroundImage(template: TemplateContent, variables?: Record<string, number | string | string[]>): string | number | string[] | undefined;
+import type * as spec from '@galacean/effects-specification';
+export declare function getBackgroundImage(template: spec.TemplateContent, variables?: spec.TemplateVariables): string | string[] | HTMLImageElement | HTMLImageElement[] | undefined;
 /**
  * @param url
  * @param template
@@ -7,4 +7,4 @@ export declare function getBackgroundImage(template: TemplateContent, variables?
  * @param options
  * @returns
  */
-export declare function combineImageTemplate(url: string | HTMLImageElement, template?: TemplateContent, variables?: Record<string, number | string>): Promise<HTMLImageElement>;
+export declare function combineImageTemplate(url: string | HTMLImageElement, template?: spec.TemplateContent, variables?: spec.TemplateVariables): Promise<HTMLImageElement>;

package/dist/texture/texture.d.ts

@@ -82,3 +82,5 @@ export declare abstract class Texture extends EffectsObject {
     protected assembleOptions(options: TextureSourceOptions): TextureSourceOptions;
 }
 export declare function generateHalfFloatTexture(engine: Engine, data: Uint16Array, width: number, height: number): Texture;
+export declare function generateWhiteTexture(engine: Engine): Texture;
+export declare function generateTransparentTexture(engine: Engine): Texture;

package/dist/texture/types.d.ts

@@ -148,7 +148,7 @@ export interface Texture2DSourceOptionsCompressed extends TextureOptionsBase {
     mipmaps: TextureDataType[];
     target?: WebGLRenderingContext['TEXTURE_2D'] | WebGLRenderingContext['TEXTURE_CUBE_MAP'];
 }
-export interface Texture2DSourceOptionsFrameBuffer extends TextureOptionsBase {
+export interface Texture2DSourceOptionsFramebuffer extends TextureOptionsBase {
     sourceType: TextureSourceType.framebuffer;
     data?: {
         width: number;
@@ -160,6 +160,6 @@ export interface Texture2DSourceOptionsNone extends TextureOptionsBase {
     sourceType?: TextureSourceType.none;
     target?: GLenum;
 }
-export type Texture2DSourceOptions = Texture2DSourceOptionsImage | Texture2DSourceOptionsData | Texture2DSourceOptionsVideo | Texture2DSourceOptionsImageMipmaps | Texture2DSourceOptionsCompressed | Texture2DSourceOptionsFrameBuffer | Texture2DSourceOptionsNone;
+export type Texture2DSourceOptions = Texture2DSourceOptionsImage | Texture2DSourceOptionsData | Texture2DSourceOptionsVideo | Texture2DSourceOptionsImageMipmaps | Texture2DSourceOptionsCompressed | Texture2DSourceOptionsFramebuffer | Texture2DSourceOptionsNone;
 export type TextureSourceOptions = Texture2DSourceOptions | TextureCubeSourceOptions;
 export {};

package/dist/texture/utils.d.ts

@@ -1,5 +1,6 @@
 import type * as spec from '@galacean/effects-specification';
 import type { Texture2DSourceOptions, TextureCubeSourceOptions } from './types';
+import type { Engine } from '../engine';
 type TextureJSONOptions = spec.SerializedTextureSource & spec.TextureConfigOptionsBase & spec.TextureFormatOptions;
-export declare function deserializeMipmapTexture(texOpts: TextureJSONOptions, bins: ArrayBuffer[], files?: spec.BinaryFile[]): Promise<Texture2DSourceOptions | TextureCubeSourceOptions>;
+export declare function deserializeMipmapTexture(textureOptions: TextureJSONOptions, bins: ArrayBuffer[], engine: Engine, files?: spec.BinaryFile[]): Promise<Texture2DSourceOptions | TextureCubeSourceOptions>;
 export {};

package/dist/ticker.d.ts

@@ -9,7 +9,7 @@ export declare class Ticker {
     private interval;
     private intervalId;
     private resetTickers;
-    private _deltaTime;
+    private dt;
     constructor(fps?: number);
     /**
      * 获取定时器当前帧更新的时间
@@ -22,7 +22,7 @@ export declare class Ticker {
     setFPS(fps: number): void;
     /**
      * 获取定时器暂停标志位
-     * @returns 暂停标志位
+     * @returns
      */
     getPaused(): boolean;
     /**

package/dist/transform.d.ts

@@ -22,7 +22,7 @@ export declare class Transform implements Disposable {
     static getRotation(quat: Quaternion, out: Euler): Euler;
     engine: Engine;
     name: string;
-    taggedProperties: Record<string, any>;
+    taggedProperties: spec.TransformData;
     /**
      * 自身位移
      */
@@ -223,8 +223,8 @@ export declare class Transform implements Disposable {
      * 获取 Transform 是否生效
      */
     getValid(): boolean;
-    toData(): Record<string, any>;
-    fromData(data: any): void;
+    toData(): spec.TransformData;
+    fromData(data: spec.TransformData): void;
     dispose(): void;
     private updateTRSCache;
     private dispatchValueChange;

package/dist/utils/array.d.ts

@@ -16,4 +16,4 @@ export declare function removeItem<T>(arr: T[], value: T): T[];
  * @returns
  */
 export declare function addItemWithOrder<T extends Record<string, any>>(arr: T[], item: T, property: string, descending?: boolean): void;
-export declare function enlargeBuffer<T extends TypedArray>(typeArray: T, length: number, increase: number | undefined, maxSize: number): T;
+export declare function enlargeBuffer<T extends TypedArray>(typeArray: T, length: number, maxSize: number, increase?: number): T;

package/dist/utils/device.d.ts

@@ -1,4 +1,8 @@
 export declare function getPixelRatio(): number;
 export declare function isIOS(): boolean;
+export declare function isIOSByUA(): number;
 export declare function isAndroid(): boolean;
 export declare function isSimulatorCellPhone(): boolean;
+export declare function isMiniProgram(): boolean;
+export declare function isAlipayMiniApp(): boolean;
+export declare function isWechatMiniApp(): boolean;

package/dist/utils/index.d.ts

@@ -4,11 +4,18 @@ export * from './device';
 export * from './image-data';
 export * from './sortable';
 export * from './asserts';
-export * from './timeline-component';
+export * from './text';
 export * from './logger';
 export type Immutable<O> = O extends Record<any, any> ? {
     readonly [key in keyof O]: Immutable<O[key]>;
 } : O extends Array<infer X> ? ReadonlyArray<X> : O;
+export type PickEnum<T, K extends T> = {
+    [P in keyof K]: P extends K ? P : never;
+};
+export interface Constructor<T = unknown> {
+    new (...args: any[]): T;
+}
+export type Nullable<T> = T | null;
 export declare enum DestroyOptions {
     destroy = 0,
     keep = 1,
@@ -32,17 +39,17 @@ export declare function noop(): void;
  *
  * @static
  * @function isString
- * @param {object} obj - 要判断的对象
- * @return {boolean}
+ * @param obj - 要判断的对象
+ * @return
  */
-export declare function isString(obj: any): obj is string;
+export declare function isString(obj: unknown): obj is string;
 /**
  * 判断对象是否是`Array`类型
  *
  * @static
  * @function isArray
- * @param {object} obj - 要判断的对象
- * @return {boolean}
+ * @param obj - 要判断的对象
+ * @return
  */
 export declare const isArray: (arg: any) => arg is any[];
 /**
@@ -50,20 +57,28 @@ export declare const isArray: (arg: any) => arg is any[];
  *
  * @static
  * @function isFunction
- * @param {object} obj - 要判断的对象
- * @return {boolean}
+ * @param obj - 要判断的对象
+ * @return
  */
-export declare function isFunction(obj: any): boolean;
+export declare function isFunction(obj: unknown): boolean;
 /**
  * 判断对象是否是`Object`类型
  *
  * @static
  * @function isObject
- * @param {object} obj - 要判断的对象
- * @return {boolean}
+ * @param obj - 要判断的对象
+ * @return
+ */
+export declare function isObject(obj: unknown): obj is Record<string | symbol, unknown>;
+export declare function isCanvas(canvas: HTMLCanvasElement): boolean;
+/**
+ * 生成一个位于 min 和 max 之间的随机数
+ * @param min
+ * @param max
+ * @returns
  */
-export declare function isObject(obj: any): boolean;
-export declare function deepClone(obj: any): any;
-export declare function random(min: number, max: number): number;
+export declare function randomInRange(min: number, max: number): number;
 export declare function throwDestroyedError(): void;
 export declare function generateGUID(): string;
+export declare function base64ToFile(base64: string, filename?: string, contentType?: string): File;
+export declare function applyMixins<T extends Constructor, K extends Constructor>(derivedCtrl: T, baseCtrls: K[]): void;

package/dist/utils/text.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 判断是否为可解析的字体
+ * - 首字母不能为数字或 `.`
+ * - 不能包含特殊字符，`_-` 是被允许的
+ * @param fontFamily - 字体名称
+ * @returns
+ */
+export declare function isValidFontFamily(fontFamily: string): boolean;

package/dist/vfx-item.d.ts

@@ -1,18 +1,15 @@
 import { Vector3 } from '@galacean/effects-math/es/core/vector3';
 import * as spec from '@galacean/effects-specification';
 import type { VFXItemData } from './asset-loader';
-import { RendererComponent } from './components';
-import type { Component } from './components/component';
-import { ItemBehaviour } from './components/component';
+import type { Component, RendererComponent, Behaviour } from './components';
 import type { Composition } from './composition';
 import { EffectsObject } from './effects-object';
 import type { Engine } from './engine';
 import type { BoundingBoxData, CameraController, HitTestBoxParams, HitTestCustomParams, HitTestSphereParams, HitTestTriangleParams, InteractComponent, ParticleSystem, SpriteComponent } from './plugins';
-import { TimelineComponent } from './plugins';
 import { Transform } from './transform';
-import { type Disposable } from './utils';
-export type VFXItemContent = ParticleSystem | SpriteComponent | TimelineComponent | CameraController | InteractComponent | void | {};
-export type VFXItemConstructor = new (enigne: Engine, props: VFXItemProps, composition: Composition) => VFXItem<VFXItemContent>;
+import type { Constructor, Disposable } from './utils';
+export type VFXItemContent = ParticleSystem | SpriteComponent | CameraController | InteractComponent | undefined | {};
+export type VFXItemConstructor = new (engine: Engine, props: VFXItemProps, composition: Composition) => VFXItem;
 export type VFXItemProps = spec.Item & {
     items: VFXItemProps[];
     startTime: number;
@@ -23,7 +20,7 @@ export type VFXItemProps = spec.Item & {
 /**
  * 所有元素的继承的抽象类
  */
-export declare class VFXItem<T extends VFXItemContent> extends EffectsObject implements Disposable {
+export declare class VFXItem extends EffectsObject implements Disposable {
     /**
      * 元素绑定的父元素，
      * 1. 当元素没有绑定任何父元素时，parent为空，transform.parentTransform 为 composition.transform
@@ -31,8 +28,8 @@ export declare class VFXItem<T extends VFXItemContent> extends EffectsObject imp
      * 3. 当元素绑定 TreeItem 的node时，parent为treeItem, transform.parentTransform 为 tree.nodes[i].transform(绑定的node节点上的transform)
      * 4. 当元素绑定 TreeItem 本身时，行为表现和绑定 nullItem 相同
      */
-    parent?: VFXItem<VFXItemContent>;
-    children: VFXItem<VFXItemContent>[];
+    parent?: VFXItem;
+    children: VFXItem[];
     /**
      * 元素的变换包含位置、旋转、缩放。
      */
@@ -45,10 +42,6 @@ export declare class VFXItem<T extends VFXItemContent> extends EffectsObject imp
      * 元素动画的持续时间
      */
     duration: number;
-    /**
-     * 元素当前更新归一化时间，开始时为 0，结束时为 1
-     */
-    lifetime: number;
     /**
      * 父元素的 id
      */
@@ -60,15 +53,11 @@ export declare class VFXItem<T extends VFXItemContent> extends EffectsObject imp
     /**
      * 元素动画结束时行为（如何处理元素）
      */
-    endBehavior: spec.ItemEndBehavior | spec.ParentItemEndBehavior;
+    endBehavior: spec.EndBehavior;
     /**
      * 元素是否可用
      */
     ended: boolean;
-    /**
-     * 元素在合成中的索引
-     */
-    listIndex: number;
     /**
      * 元素名称
      */
@@ -77,23 +66,15 @@ export declare class VFXItem<T extends VFXItemContent> extends EffectsObject imp
      * 元素 id 唯一
      */
     id: string;
-    oldId: string;
     /**
      * 元素创建的数据图层/粒子/模型等
      */
-    _content?: T;
-    /**
-     * 元素动画是否延迟播放
-     */
-    delaying: boolean;
-    /**
-     * 元素动画的速度
-     */
+    _content?: VFXItemContent;
+    reusable: boolean;
     type: spec.ItemType;
-    stopped: boolean;
     props: VFXItemProps;
     components: Component[];
-    itemBehaviours: ItemBehaviour[];
+    itemBehaviours: Behaviour[];
     rendererComponents: RendererComponent[];
     /**
      * 元素可见性，该值的改变会触发 `handleVisibleChanged` 回调
@@ -101,31 +82,31 @@ export declare class VFXItem<T extends VFXItemContent> extends EffectsObject imp
      */
     protected visible: boolean;
     /**
-     * 是否允许渲染，元素生命周期开始后为 true，结束时为 false
-     * @protected
+     * 元素动画的速度
      */
-    protected _contentVisible: boolean;
     private speed;
-    static isComposition(item: VFXItem<VFXItemContent>): item is VFXItem<void>;
-    static isSprite(item: VFXItem<VFXItemContent>): item is VFXItem<SpriteComponent>;
-    static isParticle(item: VFXItem<VFXItemContent>): item is VFXItem<ParticleSystem>;
-    static isNull(item: VFXItem<VFXItemContent>): item is VFXItem<void>;
-    static isTree(item: VFXItem<VFXItemContent>): item is VFXItem<void>;
-    static isCamera(item: VFXItem<VFXItemContent>): item is VFXItem<void>;
-    static isExtraCamera(item: VFXItem<VFXItemContent>): item is VFXItem<CameraController>;
+    private listIndex;
+    static isComposition(item: VFXItem): boolean;
+    static isSprite(item: VFXItem): boolean;
+    static isParticle(item: VFXItem): boolean;
+    static isNull(item: VFXItem): boolean;
+    static isTree(item: VFXItem): boolean;
+    static isCamera(item: VFXItem): boolean;
+    static isExtraCamera(item: VFXItem): boolean;
     constructor(engine: Engine, props?: VFXItemProps);
     /**
      * 返回元素创建的数据
      */
-    get content(): T;
+    get content(): VFXItemContent;
     /**
      * 播放完成后是否需要再使用，是的话生命周期结束后不会 dispose
      */
-    get reusable(): boolean;
+    get compositionReusable(): boolean;
     /**
-     * 获取元素生命周期是否开始
+     * 元素在合成中的索引
      */
-    get lifetimeStarted(): boolean;
+    get renderOrder(): number;
+    set renderOrder(value: number);
     /**
      * 设置元素的动画速度
      * @param speed - 速度
@@ -140,24 +121,20 @@ export declare class VFXItem<T extends VFXItemContent> extends EffectsObject imp
      * 添加组件
      * @param classConstructor - 要添加的组件类型
      */
-    addComponent<T extends Component>(classConstructor: new (engine: Engine) => T): T;
+    addComponent<T extends Component>(classConstructor: Constructor<T>): T;
     /**
      * 获取某一类型的组件。如果当前元素绑定了多个同类型的组件只返回第一个
      * @param classConstructor - 要获取的组件类型
      * @returns 查询结果中符合类型的第一个组件
      */
-    getComponent<T extends Component>(classConstructor: new (engine: Engine) => T): T | undefined;
+    getComponent<T extends Component>(classConstructor: Constructor<T>): T;
     /**
      * 获取某一类型的所有组件
      * @param classConstructor - 要获取的组件
      * @returns 一个组件列表，包含所有符合类型的组件
      */
-    getComponents<T extends Component>(classConstructor: new (engine: Engine) => T): T[];
-    setParent(vfxItem: VFXItem<VFXItemContent>): void;
-    /**
-     * 停止播放元素动画
-     */
-    stop(): void;
+    getComponents<T extends Component>(classConstructor: Constructor<T>): T[];
+    setParent(vfxItem: VFXItem): void;
     /**
      * 元素动画结束播放时回调函数
      * @override
@@ -210,7 +187,12 @@ export declare class VFXItem<T extends VFXItemContent> extends EffectsObject imp
      */
     scale(x: number, y: number, z: number): void;
     /**
-     * 设置元素的在画布上的像素位置, 坐标原点在 canvas 中心，x 正方向水平向右， y 正方向垂直向下
+     * 设置元素在画布上的像素位置
+     * Tips:
+     *  - 坐标原点在 canvas 左上角，x 正方向水平向右， y 正方向垂直向下
+     *  - 设置后会覆盖原有的位置信息
+     * @param x - x 坐标
+     * @param y - y 坐标
      */
     setPositionByPixel(x: number, y: number): void;
     /**
@@ -233,7 +215,7 @@ export declare class VFXItem<T extends VFXItemContent> extends EffectsObject imp
     /**
      * 获取元素用于计算光线投射的面片类型和参数
      * @override
-     * @param force 元素没有开启交互也返回参数
+     * @param force - 元素没有开启交互也返回参数
      */
     getHitTestParams(force?: boolean): void | HitTestBoxParams | HitTestTriangleParams | HitTestSphereParams | HitTestCustomParams;
     /**
@@ -246,7 +228,7 @@ export declare class VFXItem<T extends VFXItemContent> extends EffectsObject imp
      * @returns
      */
     isEnded(now: number): boolean;
-    find(name: string): VFXItem<VFXItemContent> | undefined;
+    find(name: string): VFXItem | undefined;
     fromData(data: VFXItemData): void;
     toData(): void;
     translateByPixel(x: number, y: number): void;
@@ -262,9 +244,3 @@ export declare namespace Item {
     function isParticle(item: spec.Item): item is spec.ParticleItem;
     function isNull(item: spec.Item): item is spec.NullItem;
 }
-/**
- * (待废弃) 根据元素的类型创建对应的 `VFXItem` 实例
- * @param props
- * @param composition
- */
-export declare function createVFXItem(props: VFXItemProps, composition: Composition): VFXItem<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-core",
-  "version": "2.0.0-alpha.9",
+  "version": "2.0.0-beta.0",
   "description": "Galacean Effects runtime core for the web",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",
@@ -42,15 +42,17 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "@galacean/effects-specification": "2.0.0-alpha.8",
-    "@galacean/effects-math": "1.1.0-alpha.0",
+    "@galacean/effects-specification": "2.0.0-beta.0",
+    "@galacean/effects-math": "1.1.0",
+    "flatbuffers": "24.3.25",
     "uuid": "9.0.1"
   },
   "scripts": {
     "prebuild": "pnpm clean",
-    "build": "pnpm build:declaration && pnpm build:module",
+    "build": "pnpm build:fbs && pnpm build:declaration && pnpm build:module",
+    "build:fbs": "node ../../scripts/flatc ./src/__definations__/index.fbs",
     "build:module": "rollup -c",
     "build:declaration": "tsc -d --emitDeclarationOnly",
-    "clean": "rimraf dist && rimraf '*+(.tsbuildinfo)'"
+    "clean": "rimraf dist && rimraf \"*+(.tsbuildinfo)\""
   }
 }

package/dist/asset-migrations.d.ts

@@ -1,5 +0,0 @@
-import type * as spec from '@galacean/effects-specification';
-/**
- * 提取并转换 JSON 数据中的 anchor 值
- */
-export declare function convertAnchor(anchor?: spec.vec2, particleOrigin?: spec.ParticleOrigin): spec.vec2;

package/dist/plugins/cal/animation-mixer-playable.d.ts

@@ -1,4 +0,0 @@
-import { AnimationPlayable } from './animation-playable';
-export declare class AnimationMixerPlayable extends AnimationPlayable {
-    processFrame(dt: number): void;
-}

package/dist/plugins/cal/animation-playable-output.d.ts

@@ -1,4 +0,0 @@
-import { PlayableOutput } from './playable-graph';
-export declare class AnimationPlayableOutput extends PlayableOutput {
-    processFrame(dt: number): void;
-}

package/dist/plugins/cal/track.d.ts

@@ -1,34 +0,0 @@
-import type { VFXItem, VFXItemContent } from '../../vfx-item';
-import { Playable, PlayableAsset, PlayableOutput } from './playable-graph';
-/**
- * @since 2.0.0
- * @internal
- */
-export declare class Track extends PlayableAsset {
-    id: string;
-    name: string;
-    bindingItem: VFXItem<VFXItemContent>;
-    private clips;
-    private clipSeed;
-    createOutput(): PlayableOutput;
-    /**
-     * 重写该方法以创建自定义混合器
-     */
-    createMixerPlayable(): Playable;
-    createPlayable(): Playable;
-    createClip<T extends Playable>(classConstructor: new () => T, name?: string): TimelineClip;
-    getClips(): TimelineClip[];
-    findClip(name: string): TimelineClip | undefined;
-    private addClip;
-}
-/**
- * @since 2.0.0
- * @internal
- */
-export declare class TimelineClip {
-    id: string;
-    name: string;
-    start: number;
-    duration: number;
-    playable: Playable;
-}

package/dist/utils/timeline-component.d.ts

@@ -1,6 +0,0 @@
-import type * as spec from '@galacean/effects-specification';
-export interface TimelineComponentOptions {
-    sizeOverLifetime?: spec.SizeOverLifetime;
-    rotationOverLifetime?: spec.RotationOverLifetime;
-    positionOverLifetime?: spec.PositionOverLifetime;
-}