@galacean/effects-core 2.0.0-alpha.1 → 2.0.0-alpha.11

package/dist/asset-loader.d.ts

@@ -1,4 +1,4 @@
-import type * as spec from '@galacean/effects-specification';
+import * as spec from '@galacean/effects-specification';
 import type { EffectsObject } from './effects-object';
 import type { Engine } from './engine';
 import type { VFXItemProps } from './vfx-item';
@@ -17,96 +17,20 @@ export declare class AssetLoader {
 export declare class Database {
     loadGUID(guid: string): Promise<EffectsObject | undefined>;
 }
-export declare enum DataType {
-    VFXItemData = 0,
-    EffectComponent = 1,
-    Material = 2,
-    Shader = 3,
-    SpriteComponent = 4,
-    ParticleSystem = 5,
-    InteractComponent = 6,
-    CameraController = 7,
-    Geometry = 8,
-    Texture = 9,
-    TextComponent = 10,
-    MeshComponent = 10000,
-    SkyboxComponent = 10001,
-    LightComponent = 10002,
-    CameraComponent = 10003,
-    ModelPluginComponent = 10004,
-    TreeComponent = 10005
-}
-export interface DataPath {
-    id: string;
-}
-export interface EffectsObjectData {
-    id: string;
-    name?: string;
-    dataType: number;
-}
-export interface MaterialData extends EffectsObjectData {
-    shader: DataPath;
-    blending?: boolean;
-    zWrite?: boolean;
-    zTest?: boolean;
-    floats: Record<string, number>;
-    ints: Record<string, number>;
-    vector2s?: Record<string, spec.vec2>;
-    vector3s?: Record<string, spec.vec3>;
-    vector4s: Record<string, {
-        x: number;
-        y: number;
-        z: number;
-        w: number;
-    }>;
-    colors: Record<string, {
-        r: number;
-        g: number;
-        b: number;
-        a: number;
-    }>;
-    matrices?: Record<string, spec.mat4>;
-    matrice3s?: Record<string, spec.mat3>;
-    textures?: Record<string, DataPath>;
-    floatArrays?: Record<string, number[]>;
-    vector4Arrays?: Record<string, number[]>;
-    matrixArrays?: Record<string, number[]>;
-}
-export interface GeometryData extends EffectsObjectData {
-    vertexData: VertexData;
+export interface GeometryData extends spec.EffectsObjectData {
+    vertexData: spec.VertexData;
     indexFormat: number;
     indexOffset: number;
     buffer: string;
 }
-export interface VertexData {
-    vertexCount: number;
-    channels: VertexChannel[];
-}
-export interface VertexChannel {
-    offset: number;
-    format: number;
-    dimension: number;
-}
-export interface ShaderData extends EffectsObjectData {
-    vertex: string;
-    fragment: string;
-    properties?: string;
-}
-export interface EffectComponentData extends EffectsObjectData {
+export interface EffectComponentData extends spec.EffectsObjectData {
     _priority: number;
-    item: DataPath;
-    materials: DataPath[];
-    geometry: DataPath;
+    item: spec.DataPath;
+    materials: spec.DataPath[];
+    geometry: spec.DataPath;
 }
 export type VFXItemData = VFXItemProps & {
-    dataType: DataType;
-    components: DataPath[];
+    dataType: spec.DataType;
+    components: spec.DataPath[];
 };
-export type SceneData = Record<string, EffectsObjectData>;
-export interface EffectsPackageData {
-    fileSummary: {
-        guid: string;
-        assetType: string;
-    };
-    exportObjects: EffectsObjectData[];
-}
+export type SceneData = Record<string, spec.EffectsObjectData>;

package/dist/asset-manager.d.ts

@@ -1,86 +1,7 @@
-import * as spec from '@galacean/effects-specification';
 import { Downloader } from './downloader';
-import type { Scene } from './scene';
+import type { Scene, SceneLoadOptions, SceneType } from './scene';
 import type { Disposable } from './utils';
 import type { Renderer } from './render';
-/**
- * 场景加载参数
- */
-export interface SceneLoadOptions {
-    /**
-     * 动态数据的参数
-     * key 是 JSON 中配置的字段名
-     * value 是要使用的值，图片使用 url 链接
-     * 图片链接可以使用数组传递，如果第一个加载失败，将尝试使用第二个地址
-     *
-     * @example
-     * ``` ts
-     * {
-     *   variables: {
-     *     bg: ['url','fallback_url'], // 如果两个图片都失败，将会触发加载失败
-     *     fg: 'url' // 如果图片加载失败，将会触发加载失败,
-     *     amount: 88.8,
-     *     name: 'abc'
-     *   }
-     * }
-     * ```
-     */
-    variables?: Record<string, number | string | string[]>;
-    /**
-     * 模板图片缩放倍数
-     * @default 1 如果图片比较糊，可以用 2（但会增大图片内存）
-     */
-    templateScale?: number;
-    /**
-     * 是否使用压缩纹理
-     */
-    useCompressedTexture?: boolean;
-    /**
-     * 渲染分级。
-     * 分级之后，只会加载当前渲染等级的资源。
-     * 当渲染等级被设置为 B 后，player 的 fps 会降到 30 帧
-     * @default 's'
-     */
-    renderLevel?: spec.RenderLevel;
-    /**
-     * 资源加载超时，时间单位秒
-     * @default 10s
-     */
-    timeout?: number;
-    /***
-     * 用于给 plugin 的加载数据
-     * key/value 的内容由 plugin 自己实现
-     */
-    pluginData?: Record<string, any>;
-    /**
-     * 场景加载时的环境（加载后把 env 结果写入 scene）
-     * @default '' - 编辑器中为 'editor'
-     */
-    env?: string;
-    /**
-     * 加载后是否自动播放
-     * @default true
-     */
-    autoplay?: boolean;
-    /**
-     * 合成播放完成后是否需要再使用，是的话生命周期结束后不会 `dispose`
-     * @default false
-     */
-    reusable?: boolean;
-    /**
-     * 播放速度，当速度为负数时，合成倒播
-     */
-    speed?: number;
-}
-/**
- * 接受用于加载的数据类型
- */
-export type SceneType = string | Scene | Record<string, unknown>;
-export type SceneWithOptionsType = {
-    scene: SceneType;
-    options: SceneLoadOptions;
-};
-export type SceneLoadType = SceneType | SceneWithOptionsType;
 /**
  * 资源管理器
  * 用于加载和动效中所有的资源文件，包括图片、插件、图层粒子数据等

package/dist/asset-migrations.d.ts

@@ -1,6 +1,4 @@
-import * as spec from '@galacean/effects-specification';
-import type { Scene } from './scene';
-export declare function version3Migration(scene: Record<string, any>): Scene;
+import type * as spec from '@galacean/effects-specification';
 /**
  * 提取并转换 JSON 数据中的 anchor 值
  */

package/dist/canvas-pool.d.ts

@@ -0,0 +1,10 @@
+declare class CanvasPool {
+    readonly elements: HTMLCanvasElement[];
+    constructor();
+    dispose(): void;
+    getCanvas(): HTMLCanvasElement;
+    saveCanvas(canvas: HTMLCanvasElement): void;
+}
+export declare const canvasPool: CanvasPool;
+export declare function getDefaultTemplateCanvasPool(): CanvasPool;
+export {};

package/dist/components/component.d.ts

@@ -13,7 +13,7 @@ export declare abstract class Component extends EffectsObject {
     /**
      * 附加到的 VFXItem 对象 Transform 组件
      */
-    get transform(): import("..").Transform;
+    get transform(): import("@galacean/effects-core").Transform;
     onAttached(): void;
     onDestroy(): void;
     fromData(data: any): void;

package/dist/composition.d.ts

@@ -7,13 +7,12 @@ import type { PluginSystem } from './plugin-system';
 import type { EventSystem, Region } from './plugins';
 import type { MeshRendererOptions, Renderer } from './render';
 import { RenderFrame } from './render';
-import type { Scene } from './scene';
+import type { Scene, SceneType } from './scene';
 import type { Texture } from './texture';
 import { Transform } from './transform';
 import type { Disposable, LostHandler } from './utils';
 import type { VFXItemContent, VFXItemProps } from './vfx-item';
 import { VFXItem } from './vfx-item';
-import type { SceneType } from './asset-manager';
 export interface CompositionStatistic {
     loadTime: number;
     loadStart: number;
@@ -239,6 +238,12 @@ export declare class Composition implements Disposable, LostHandler {
      * @param speed - 速度
      */
     setSpeed(speed: number): void;
+    /**
+     * 设置合成的可见性
+     * @since 2.0.0
+     * @param visible - 是否可见
+     */
+    setVisible(visible: boolean): void;
     /**
      * 获取合成的动画速度
      * @returns
@@ -342,7 +347,7 @@ export declare class Composition implements Disposable, LostHandler {
      * 获取 engine 对象
      * @returns
      */
-    getEngine(): import("./engine").Engine;
+    getEngine(): import("@galacean/effects-core").Engine;
     /**
      * Item 求交测试，返回求交结果列表，x 和 y 是归一化到[-1, 1]区间的值，原点在左上角
      * @param x - 鼠标或触点的 x，已经归一化到[-1, 1]

package/dist/constants.d.ts

@@ -4,7 +4,6 @@ export declare const SEMANTIC_PRE_COLOR_ATTACHMENT_SIZE_0 = "PRE_COLOR_SIZE_0";
 export declare const SEMANTIC_MAIN_PRE_COLOR_ATTACHMENT_0 = "PRE_MAIN_COLOR_0";
 export declare const SEMANTIC_MAIN_PRE_COLOR_ATTACHMENT_SIZE_0 = "PRE_MAIN_COLOR_SIZE_0";
 export declare const PLAYER_OPTIONS_ENV_EDITOR = "editor";
-export declare const FILTER_NAME_NONE = "none";
 export declare const HELP_LINK: {
     'Filter not imported': string;
     'Item duration can\'t be less than 0': string;

package/dist/decorators.d.ts

@@ -1,4 +1,4 @@
-export declare const effectsClassStore: Record<number, any>;
+export declare const effectsClassStore: Record<string, any>;
 export declare function getMergedStore(target: any): any;
 export declare function serialize(sourceName?: string): (target: any, propertyKey: any) => void;
 export declare function effectsClass(className: any): (target: any, context?: any) => void;

package/dist/downloader.d.ts

@@ -3,12 +3,6 @@ type ErrorHandler = (status: number, responseText: string) => void;
 /**
  *
  */
-type VideoLoadOptions = {
-    /**
-     * 视频是否循环播放
-     */
-    loop?: boolean;
-};
 /**
  * JSON 值，它可以是字符串、数字、布尔值、对象或者 JSON 值的数组。
  *
@@ -77,7 +71,7 @@ export declare function loadBlob(url: string): Promise<Blob>;
 /**
  * 异步加载一个视频文件
  * @param url - 视频文件的 URL 或 MediaProvider 对象
- * @param options - 加载参数
  */
-export declare function loadVideo(url: string | MediaProvider, options?: VideoLoadOptions): Promise<HTMLVideoElement>;
+export declare function loadVideo(url: string | MediaProvider): Promise<HTMLVideoElement>;
+export declare function loadMedia(url: string | string[], loadFn: (url: string) => Promise<HTMLImageElement | HTMLVideoElement>): Promise<HTMLImageElement | HTMLVideoElement>;
 export {};

package/dist/effects-object.d.ts

@@ -1,4 +1,4 @@
-import type { EffectsObjectData } from './asset-loader';
+import type * as spec from '@galacean/effects-specification';
 import type { Engine } from './engine';
 /**
  * @since 2.0.0
@@ -20,6 +20,6 @@ export declare abstract class EffectsObject {
      *
      * @param data - 对象的序列化的数据
      */
-    fromData(data: EffectsObjectData): void;
+    fromData(data: spec.EffectsObjectData): void;
     dispose(): void;
 }

package/dist/engine.d.ts

@@ -1,4 +1,5 @@
-import type { Database, EffectsObjectData, SceneData } from './asset-loader';
+import * as spec from '@galacean/effects-specification';
+import type { Database, SceneData } from './asset-loader';
 import { AssetLoader } from './asset-loader';
 import type { EffectsObject } from './effects-object';
 import type { Material } from './material';
@@ -30,8 +31,8 @@ export declare class Engine implements Disposable {
      */
     static create: (gl: WebGLRenderingContext | WebGL2RenderingContext) => Engine;
     clearResources(): void;
-    addEffectsObjectData(data: EffectsObjectData): void;
-    findEffectsObjectData(uuid: string): EffectsObjectData;
+    addEffectsObjectData(data: spec.EffectsObjectData): void;
+    findEffectsObjectData(uuid: string): spec.EffectsObjectData;
     addInstance(effectsObject: EffectsObject): void;
     getInstance(id: string): EffectsObject;
     removeInstance(id: string): void;

package/dist/fallback/camera.d.ts

@@ -0,0 +1,2 @@
+import type { CameraContent } from '@galacean/effects-specification';
+export declare function getStandardCameraContent(model: any): CameraContent;

package/dist/fallback/index.d.ts

@@ -0,0 +1,12 @@
+import type { BaseItem, Composition, CompressedImage, Image, JSONScene, ParticleItem, RenderLevel, SpriteItem, TemplateImage } from '@galacean/effects-specification';
+export * from './utils';
+export declare function getStandardJSON(json: any): JSONScene;
+export declare function getStandardImage(image: any, index: number, imageTags: RenderLevel[]): TemplateImage | Image | CompressedImage;
+export declare function getStandardComposition(composition: any, opt?: {
+    plugins?: string[];
+    requires?: string[];
+}): Composition;
+export declare function getStandardItem(item: any, opt?: {
+    plugins?: string[];
+    requires?: string[];
+}): SpriteItem | ParticleItem | BaseItem;

package/dist/fallback/interact.d.ts

@@ -0,0 +1,2 @@
+import type { InteractContent } from '@galacean/effects-specification';
+export declare function getStandardInteractContent(ui: any): InteractContent;

package/dist/fallback/migration.d.ts

@@ -0,0 +1,18 @@
+import type { JSONScene, JSONSceneLegacy, BaseContent } from '@galacean/effects-specification';
+/**
+ * 2.1 以下版本数据适配（mars-player@2.4.0 及以上版本支持 2.1 以下数据的适配）
+ */
+export declare function version21Migration(json: JSONSceneLegacy): JSONSceneLegacy;
+/**
+ * 2.2 以下版本数据适配（mars-player@2.5.0 及以上版本支持 2.2 以下数据的适配）
+ */
+export declare function version22Migration(json: JSONSceneLegacy): JSONSceneLegacy;
+/**
+ * 3.0 以下版本数据适配（runtime 2.0及以上版本支持）
+ */
+export declare function version30Migration(json: JSONSceneLegacy): JSONScene;
+/**
+ * 2.5 以下版本 赫尔米特数据转换成贝塞尔数据
+ */
+export declare function version24Migration(json: JSONScene): JSONScene;
+export declare function convertParam(content: BaseContent | undefined | null): void;

package/dist/fallback/particle.d.ts

@@ -0,0 +1,2 @@
+import type { ParticleContent } from '@galacean/effects-specification';
+export declare function getStandardParticleContent(particle: any): ParticleContent;

package/dist/fallback/sprite.d.ts

@@ -0,0 +1,3 @@
+import type { BaseItemTransform, NullContent, SpriteContent } from '@galacean/effects-specification';
+export declare function getStandardNullContent(sprite: any, transform: BaseItemTransform): NullContent;
+export declare function getStandardSpriteContent(sprite: any, transform: BaseItemTransform): SpriteContent;

package/dist/fallback/utils.d.ts

@@ -0,0 +1,36 @@
+import type { FixedNumberExpression, RGBAColorValue, ColorExpression, NumberExpression, GradientColor, FixedVec3Expression, vec4, vec3, BezierKeyframeValue, vec2 } from '@galacean/effects-specification';
+import { ParticleOrigin } from '@galacean/effects-specification';
+export declare function arrAdd<T>(arr: T[], item: T): boolean | undefined;
+/**
+ * @deprecated 请直接使用 Array.prototype.forEach 或 for...of
+ * @param object
+ * @param callback
+ * @returns the mutated input object
+ */
+export declare function forEach<T>(object: null | undefined | {
+    [key: string]: T | Record<any, T>;
+}, callback: (val: T, key: string) => void, thisObj?: any): {
+    [key: string]: T | Record<any, T>;
+} | null | undefined;
+export declare function ensureFixedNumber(a: any): FixedNumberExpression | undefined;
+export declare function ensureFixedNumberWithRandom(a: any, p: number): FixedNumberExpression | undefined;
+export declare function ensureRGBAValue(a: any): RGBAColorValue;
+export declare function ensureColorExpression(a: any, normalized?: boolean): ColorExpression | undefined;
+export declare function ensureNumberExpression(a: any): NumberExpression | undefined;
+export declare function ensureValueGetter(a: any): any;
+export declare function ensureGradient(a: any, normalized?: boolean): GradientColor | undefined;
+export declare function colorToArr(hex: string | number[], normalized?: boolean): vec4;
+export declare function normalizeColor(a: number[]): number[] | undefined;
+export declare function parsePercent(c: string): number;
+export declare function getGradientColor(color: string | Array<string | number[]> | GradientColor, normalized?: boolean): GradientColor | undefined;
+export declare function ensureFixedVec3(a: any): FixedVec3Expression | undefined;
+export declare function objectValueToNumber(o: Record<string, any>): object;
+export declare function deleteEmptyValue(o: Record<string, any>): object;
+export declare function quatFromXYZRotation(out: vec4 | number[], x: number, y: number, z: number): vec4;
+export declare function rotationZYXFromQuat(out: vec3 | number[], quat: vec4): vec3;
+/**
+ * 提取并转换 JSON 数据中的 anchor 值
+ */
+export declare function convertAnchor(anchor?: vec2, particleOrigin?: ParticleOrigin): vec2;
+export declare const particleOriginTranslateMap: Record<number, vec2>;
+export declare function getBezierCurveFromHermiteInGE(geHermiteCurves: number[][]): BezierKeyframeValue[];

package/dist/image-asset.d.ts

@@ -0,0 +1,5 @@
+import { EffectsObject } from './effects-object';
+import type { ImageSource } from './scene';
+export declare class ImageAsset extends EffectsObject {
+    data: ImageSource;
+}

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export * as math from '@galacean/effects-math/es/core/index';
 export * as spec from '@galacean/effects-specification';
-export { getStandardComposition, getStandardImage, getStandardItem, getStandardJSON, } from '@galacean/effects-specification/dist/fallback';
+export { getStandardComposition, getStandardImage, getStandardItem, getStandardJSON, ensureFixedNumber, normalizeColor, } from './fallback';
 export * from './asset-manager';
 export * from './camera';
 export * from './comp-vfx-item';
@@ -22,7 +22,6 @@ export * from './plugin-system';
 export * from './plugins';
 export * from './render';
 export * from './scene';
-export * from './semantic-map';
 export * from './shader';
 export * from './shape';
 export * from './template-image';
@@ -32,3 +31,4 @@ export * from './ticker';
 export * from './transform';
 export * from './utils';
 export * from './vfx-item';
+export * from './canvas-pool';