@galacean/effects-core 2.0.0-alpha.14 → 2.0.0-alpha.16

package/dist/pass-render-level.d.ts

@@ -1 +1,3 @@
-export declare function passRenderLevel(l?: string, renderLevel?: string): boolean;
+import * as spec from '@galacean/effects-specification';
+import type { SceneRenderLevel } from './scene';
+export declare function passRenderLevel(l?: spec.RenderLevel, renderLevel?: SceneRenderLevel): boolean;

package/dist/plugin-system.d.ts

@@ -28,6 +28,6 @@ export declare class PluginSystem {
     createPluginItem(name: string, props: VFXItemProps, composition: Composition): VFXItem;
     processRawJSON(json: spec.JSONScene, options: SceneLoadOptions): Promise<void[]>;
     private callStatic;
-    precompile(compositions: spec.Composition[], renderer: Renderer, options?: PrecompileOptions): Promise<void[]>;
+    precompile(compositions: spec.CompositionData[], renderer: Renderer, options?: PrecompileOptions): Promise<void[]>;
     loadResources(scene: Scene, options: SceneLoadOptions): Promise<void[]>;
 }

package/dist/plugins/cal/calculate-item.d.ts

@@ -1,5 +1,5 @@
 import type { Euler, Vector3 } from '@galacean/effects-math/es/core/index';
-import * as spec from '@galacean/effects-specification';
+import type * as spec from '@galacean/effects-specification';
 import type { ValueGetter } from '../../math';
 import { TrackAsset } from '../timeline/track';
 import type { TimelineAsset } from './timeline-asset';
@@ -19,22 +19,12 @@ export type ItemLinearVelOverLifetime = {
     z?: ValueGetter<number>;
     enabled?: boolean;
 };
-export interface CalculateItemOptions {
-    start: number;
-    duration: number;
-    looping: boolean;
-    endBehavior: number;
-    startRotation?: number;
-    start3DRotation?: number;
-}
 /**
  * @since 2.0.0
  * @internal
  */
 export declare class ObjectBindingTrack extends TrackAsset {
-    options: CalculateItemOptions;
     data: spec.EffectsObjectData;
     create(timelineAsset: TimelineAsset): void;
-    toLocalTime(time: number): number;
     fromData(data: spec.EffectsObjectData): void;
 }

package/dist/plugins/cal/calculate-vfx-item.d.ts

@@ -7,7 +7,7 @@ import type { ItemBasicTransform, ItemLinearVelOverLifetime } from './calculate-
 import type { FrameContext, PlayableGraph } from './playable-graph';
 import { Playable, PlayableAsset } from './playable-graph';
 import { EffectsObject } from '../../effects-object';
-import type { VFXItem } from '../../vfx-item';
+import { VFXItem } from '../../vfx-item';
 /**
  * @since 2.0.0
  * @internal

package/dist/plugins/cal/timeline-asset.d.ts

@@ -8,7 +8,6 @@ export interface TimelineAssetData extends EffectsObjectData {
 }
 export declare class TimelineAsset extends PlayableAsset {
     tracks: TrackAsset[];
-    graph: PlayableGraph;
     createPlayable(graph: PlayableGraph): Playable;
     createTrack<T extends TrackAsset>(classConstructor: new (engine: Engine) => T, parent: TrackAsset, name?: string): T;
     fromData(data: TimelineAssetData): void;

package/dist/plugins/index.d.ts

@@ -22,6 +22,8 @@ export * from './timeline/track';
 export * from './timeline/tracks/transform-track';
 export * from './timeline/tracks/activation-track';
 export * from './timeline/tracks/sprite-color-track';
+export * from './timeline/tracks/sub-composition-track';
+export * from './timeline/playables/sub-composition-playable-asset';
 export * from './cal/timeline-asset';
 export * from './text/text-item';
 export * from './text/text-loader';

package/dist/plugins/particle/particle-system.d.ts

@@ -48,7 +48,7 @@ type ParticleOptions = {
     maxCount: number;
     gravity: vec3;
     gravityModifier: ValueGetter<number>;
-    renderLevel?: string;
+    renderLevel?: spec.RenderLevel;
     particleFollowParent?: boolean;
     forceTarget?: {
         curve: ValueGetter<number>;

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

@@ -9,7 +9,6 @@ import type { Renderer } from '../../render';
 import { Geometry } from '../../render';
 import type { GeometryFromShape } from '../../shape';
 import type { Texture } from '../../texture';
-import type { CalculateItemOptions } from '../cal/calculate-item';
 import type { FrameContext, PlayableGraph } from '../cal/playable-graph';
 import { Playable, PlayableAsset } from '../cal/playable-graph';
 import type { BoundingBoxTriangle, HitTestTriangleParams } from '../interact/click-handler';
@@ -29,8 +28,8 @@ export interface SpriteItemProps extends Omit<spec.SpriteContent, 'renderer'> {
  */
 export type SpriteItemOptions = {
     startColor: vec4;
-    renderLevel?: string;
-} & CalculateItemOptions;
+    renderLevel?: spec.RenderLevel;
+};
 /**
  * 图层元素渲染属性, 经过处理后的 spec.SpriteContent.renderer
  */

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

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

package/dist/plugins/timeline/playables/sub-composition-clip-playable.d.ts

@@ -0,0 +1,5 @@
+import type { FrameContext } from '../../cal/playable-graph';
+import { Playable } from '../../cal/playable-graph';
+export declare class SubCompositionClipPlayable extends Playable {
+    processFrame(context: FrameContext): void;
+}

package/dist/plugins/timeline/playables/sub-composition-playable-asset.d.ts

@@ -0,0 +1,5 @@
+import type { Playable, PlayableGraph } from '../../cal/playable-graph';
+import { PlayableAsset } from '../../cal/playable-graph';
+export declare class SubCompositionPlayableAsset extends PlayableAsset {
+    createPlayable(graph: PlayableGraph): Playable;
+}

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

@@ -13,19 +13,18 @@ export declare class TrackAsset extends PlayableAsset {
     private clipSeed;
     private clips;
     protected children: TrackAsset[];
-    initializeBinding(parentBinding: object): void;
     /**
-     * @internal
+     * 重写该方法以获取自定义对象绑定
      */
-    initializeBindingRecursive(parentBinding: object): void;
-    createOutput(): PlayableOutput;
-    createPlayableGraph(graph: PlayableGraph, runtimeClips: RuntimeClip[]): Playable;
-    createMixerPlayableGraph(graph: PlayableGraph, runtimeClips: RuntimeClip[]): Playable;
-    compileClips(graph: PlayableGraph, timelineClips: TimelineClip[], runtimeClips: RuntimeClip[]): Playable;
+    resolveBinding(parentBinding: object): object;
     /**
      * 重写该方法以创建自定义混合器
      */
     createTrackMixer(graph: PlayableGraph): Playable;
+    createOutput(): PlayableOutput;
+    createPlayableGraph(graph: PlayableGraph, runtimeClips: RuntimeClip[]): Playable;
+    createMixerPlayableGraph(graph: PlayableGraph, runtimeClips: RuntimeClip[]): Playable;
+    compileClips(graph: PlayableGraph, timelineClips: TimelineClip[], runtimeClips: RuntimeClip[]): Playable;
     createPlayable(graph: PlayableGraph): Playable;
     getChildTracks(): TrackAsset[];
     addChild(child: TrackAsset): void;

package/dist/plugins/timeline/tracks/activation-track.d.ts

@@ -1,6 +1,5 @@
 import type { PlayableGraph, Playable } from '../../cal/playable-graph';
 import { TrackAsset } from '../track';
 export declare class ActivationTrack extends TrackAsset {
-    initializeBinding(parentBinding: object): void;
     createTrackMixer(graph: PlayableGraph): Playable;
 }

package/dist/plugins/timeline/tracks/sub-composition-track.d.ts

@@ -0,0 +1,4 @@
+import { TrackAsset } from '../track';
+export declare class SubCompositionTrack extends TrackAsset {
+    resolveBinding(parentBinding: object): object;
+}

package/dist/scene.d.ts

@@ -1,7 +1,9 @@
 import type * as spec from '@galacean/effects-specification';
 import type { Texture } from './texture';
 import type { PluginSystem } from './plugin-system';
+import type { PickEnum } from './utils';
 export type ImageSource = spec.TemplateImage | spec.Image | spec.CompressedImage;
+export type SceneRenderLevel = PickEnum<spec.RenderLevel, spec.RenderLevel.A | spec.RenderLevel.B | spec.RenderLevel.S>;
 /**
  * 场景类型
  */
@@ -9,7 +11,7 @@ export interface Scene {
     readonly jsonScene: spec.JSONScene;
     readonly bins: ArrayBuffer[];
     readonly pluginSystem: PluginSystem;
-    readonly renderLevel?: spec.RenderLevel;
+    readonly renderLevel?: SceneRenderLevel;
     readonly storage: Record<string, any>;
     textureOptions: Record<string, any>[];
     images: ImageSource[];
@@ -57,9 +59,9 @@ export interface SceneLoadOptions {
      * 渲染分级。
      * 分级之后，只会加载当前渲染等级的资源。
      * 当渲染等级被设置为 B 后，player 的 fps 会降到 30 帧
-     * @default 's'
+     * @default 'S'
      */
-    renderLevel?: spec.RenderLevel;
+    renderLevel?: SceneRenderLevel;
     /**
      * 资源加载超时，时间单位秒
      * @default 10s

package/dist/serialization-helper.d.ts

@@ -8,6 +8,7 @@ export declare class SerializationHelper {
     static checkTypedArray(obj: any): boolean;
     static checkDataPath(value: any): boolean;
     static checkGLTFNode(value: any): boolean;
+    static checkImageSource(value: any): boolean;
     private static deserializeProperty;
     private static deserializePropertyAsync;
     private static serializeObjectProperty;

package/dist/utils/index.d.ts

@@ -9,6 +9,9 @@ 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 declare enum DestroyOptions {
     destroy = 0,
     keep = 1,
@@ -63,7 +66,9 @@ export declare function isFunction(obj: any): boolean;
  * @return {boolean}
  */
 export declare function isObject(obj: any): boolean;
+export declare function isCanvas(canvas: HTMLCanvasElement): boolean;
 export declare function deepClone(obj: any): any;
 export declare function random(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;

package/dist/vfx-item.d.ts

@@ -1,9 +1,8 @@
 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 } from './components';
+import { RendererComponent, ItemBehaviour } from './components';
 import type { Composition } from './composition';
 import { EffectsObject } from './effects-object';
 import type { Engine } from './engine';
@@ -60,10 +59,6 @@ export declare class VFXItem extends EffectsObject implements Disposable {
      * 元素是否可用
      */
     ended: boolean;
-    /**
-     * 元素在合成中的索引
-     */
-    listIndex: number;
     /**
      * 元素名称
      */
@@ -92,6 +87,7 @@ export declare class VFXItem extends EffectsObject implements Disposable {
      * 元素动画的速度
      */
     private speed;
+    private listIndex;
     static isComposition(item: VFXItem): boolean;
     static isSprite(item: VFXItem): boolean;
     static isParticle(item: VFXItem): boolean;
@@ -108,6 +104,11 @@ export declare class VFXItem extends EffectsObject implements Disposable {
      * 播放完成后是否需要再使用，是的话生命周期结束后不会 dispose
      */
     get compositionReusable(): boolean;
+    /**
+     * 元素在合成中的索引
+     */
+    get renderOrder(): number;
+    set renderOrder(value: number);
     /**
      * 设置元素的动画速度
      * @param speed - 速度

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-core",
-  "version": "2.0.0-alpha.14",
+  "version": "2.0.0-alpha.16",
   "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.0.0-alpha.16",
+    "@galacean/effects-specification": "2.0.0-alpha.17",
     "@galacean/effects-math": "1.1.0",
     "uuid": "9.0.1"
   },