@galacean/effects-core 2.0.0-alpha.15 → 2.0.0-alpha.17

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/plugins/cal/calculate-item.d.ts

@@ -1,5 +1,4 @@
 import type { Euler, Vector3 } from '@galacean/effects-math/es/core/index';
-import type * as spec from '@galacean/effects-specification';
 import type { ValueGetter } from '../../math';
 import { TrackAsset } from '../timeline/track';
 import type { TimelineAsset } from './timeline-asset';
@@ -24,7 +23,5 @@ export type ItemLinearVelOverLifetime = {
  * @internal
  */
 export declare class ObjectBindingTrack extends TrackAsset {
-    data: spec.EffectsObjectData;
     create(timelineAsset: TimelineAsset): void;
-    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/index.d.ts

@@ -25,5 +25,4 @@ 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';
+export * from './text';

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

@@ -24,5 +24,5 @@ export declare class InteractComponent extends RendererComponent {
     beginDragTarget(options: spec.DragInteractOption, eventSystem: EventSystem): void;
     getHitTestParams: (force?: boolean) => HitTestTriangleParams | void;
     getBoundingBox(): BoundingBoxTriangle | void;
-    fromData(data: any): void;
+    fromData(data: spec.InteractContent): void;
 }

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>;
@@ -192,6 +192,6 @@ export declare class ParticleSystem extends Component {
     resumeParticleEmission(): void;
     getBoundingBox(): void | BoundingBoxSphere;
     getHitTestParams: (force?: boolean) => void | HitTestCustomParams;
-    fromData(data: any): void;
+    fromData(data: unknown): void;
 }
 export {};

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

@@ -28,7 +28,7 @@ export interface SpriteItemProps extends Omit<spec.SpriteContent, 'renderer'> {
  */
 export type SpriteItemOptions = {
     startColor: vec4;
-    renderLevel?: string;
+    renderLevel?: spec.RenderLevel;
 };
 /**
  * 图层元素渲染属性, 经过处理后的 spec.SpriteContent.renderer

package/dist/plugins/text/index.d.ts

@@ -0,0 +1,4 @@
+export * from './text-item';
+export * from './text-layout';
+export * from './text-style';
+export * from './text-loader';

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/track.d.ts

@@ -2,6 +2,20 @@ import { ItemEndBehavior } from '@galacean/effects-specification';
 import type { Engine } from '../../engine';
 import type { PlayableGraph } from '../cal/playable-graph';
 import { Playable, PlayableAsset, PlayableOutput } from '../cal/playable-graph';
+/**
+ * @since 2.0.0
+ * @internal
+ */
+export declare class TimelineClip {
+    id: string;
+    name: string;
+    start: number;
+    duration: number;
+    asset: PlayableAsset;
+    endBehaviour: ItemEndBehavior;
+    constructor();
+    toLocalTime(time: number): number;
+}
 /**
  * @since 2.0.0
  * @internal
@@ -38,20 +52,6 @@ export declare enum TrackType {
     MasterTrack = 0,
     ObjectTrack = 1
 }
-/**
- * @since 2.0.0
- * @internal
- */
-export declare class TimelineClip {
-    id: string;
-    name: string;
-    start: number;
-    duration: number;
-    asset: PlayableAsset;
-    endBehaviour: ItemEndBehavior;
-    constructor();
-    toLocalTime(time: number): number;
-}
 export declare class RuntimeClip {
     clip: TimelineClip;
     playable: Playable;

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

@@ -1,14 +1,15 @@
+import type * as spec from '@galacean/effects-specification';
 import { EffectsObject } from './effects-object';
 export declare class SerializationHelper {
     static collectSerializableObject(effectsObject: EffectsObject, res: Record<string, EffectsObject>): void;
     static serializeEffectObject(effectsObject: EffectsObject): Record<string, any>;
     static serializeTaggedProperties(effectsObject: EffectsObject, serializedData?: Record<string, any>): Record<string, any>;
-    static deserializeTaggedProperties(serializedData: Record<string, any>, effectsObject: EffectsObject): void;
-    static deserializeTaggedPropertiesAsync(serializedData: Record<string, any>, effectsObject: EffectsObject): Promise<void>;
-    static checkTypedArray(obj: any): boolean;
-    static checkDataPath(value: any): boolean;
+    static deserializeTaggedProperties(serializedData: spec.EffectsObjectData, effectsObject: EffectsObject): void;
+    static deserializeTaggedPropertiesAsync(serializedData: spec.EffectsObjectData, effectsObject: EffectsObject): Promise<void>;
+    static checkTypedArray(obj: unknown): boolean;
+    static checkDataPath(value: unknown): value is spec.DataPath;
     static checkGLTFNode(value: any): boolean;
-    static checkImageSource(value: any): boolean;
+    static checkImageSource(value: HTMLCanvasElement): boolean;
     private static deserializeProperty;
     private static deserializePropertyAsync;
     private static serializeObjectProperty;

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/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/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,
@@ -32,17 +35,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,22 +53,27 @@ 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: any): boolean;
+export declare function isObject(obj: unknown): obj is Record<string | symbol, unknown>;
 export declare function isCanvas(canvas: HTMLCanvasElement): boolean;
-export declare function deepClone(obj: any): any;
-export declare function random(min: number, max: number): number;
+/**
+ * 生成一个位于 min 和 max 之间的随机数
+ * @param min
+ * @param max
+ * @returns
+ */
+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;

package/dist/vfx-item.d.ts

@@ -1,9 +1,7 @@
 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, ItemBehaviour } from './components';
 import type { Composition } from './composition';
 import { EffectsObject } from './effects-object';
 import type { Engine } from './engine';
@@ -60,10 +58,6 @@ export declare class VFXItem extends EffectsObject implements Disposable {
      * 元素是否可用
      */
     ended: boolean;
-    /**
-     * 元素在合成中的索引
-     */
-    listIndex: number;
     /**
      * 元素名称
      */
@@ -92,6 +86,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 +103,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.15",
+  "version": "2.0.0-alpha.17",
   "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.17",
+    "@galacean/effects-specification": "2.0.0-alpha.19",
     "@galacean/effects-math": "1.1.0",
     "uuid": "9.0.1"
   },