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

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

@@ -0,0 +1,72 @@
+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 TrackAsset extends PlayableAsset {
+    name: string;
+    binding: object;
+    trackType: TrackType;
+    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;
+    /**
+     * 重写该方法以创建自定义混合器
+     */
+    createTrackMixer(graph: PlayableGraph): Playable;
+    createPlayable(graph: PlayableGraph): Playable;
+    getChildTracks(): TrackAsset[];
+    addChild(child: TrackAsset): void;
+    createClip<T extends PlayableAsset>(classConstructor: new (engine: Engine) => T, name?: string): TimelineClip;
+    getClips(): TimelineClip[];
+    findClip(name: string): TimelineClip | undefined;
+    addClip(clip: TimelineClip): void;
+    private createClipPlayable;
+}
+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;
+    parentMixer: Playable;
+    track: TrackAsset;
+    constructor(clip: TimelineClip, clipPlayable: Playable, parentMixer: Playable, track: TrackAsset);
+    set enable(value: boolean);
+    evaluateAt(localTime: number): void;
+    private onClipEnd;
+}
+/**
+ * @since 2.0.0
+ * @internal
+ */
+export interface TimelineClipData {
+    asset: PlayableAsset;
+}

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

@@ -0,0 +1,6 @@
+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/sprite-color-track.d.ts

@@ -0,0 +1,3 @@
+import { TrackAsset } from '../track';
+export declare class SpriteColorTrack extends TrackAsset {
+}

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

@@ -0,0 +1,3 @@
+import { TrackAsset } from '../track';
+export declare class TransformTrack extends TrackAsset {
+}

package/dist/render/framebuffer.d.ts

@@ -42,7 +42,7 @@ export declare class Framebuffer {
     getDepthTexture(): Texture | undefined;
     getStencilTexture(): Texture | undefined;
     getColorTextures(): Texture[];
-    dispose(opt?: {
+    dispose(options?: {
         depthStencilAttachment?: RenderPassDestroyAttachmentType;
     }): void;
 }

package/dist/render/geometry.d.ts

@@ -24,9 +24,10 @@ export interface GeometryProps {
      */
     maxVertex?: number;
 }
-export interface SubMesh {
-    offset: number;
-    count: number;
+export interface SkinProps {
+    boneNames?: string[];
+    rootBoneName?: string;
+    inverseBindMatrices?: number[];
 }
 /**
  * Geometry 抽象类
@@ -39,7 +40,7 @@ export declare abstract class Geometry extends EffectsObject {
     /**
      * 子网格数据
      */
-    subMeshes: SubMesh[];
+    subMeshes: spec.SubMesh[];
     /**
      * Geometry 创建函数
      */
@@ -104,6 +105,10 @@ export declare abstract class Geometry extends EffectsObject {
      * 获取当前 Geometry 的 drawcount
      */
     abstract getDrawCount(): number;
+    /**
+     * 获取当前 Geometry 关联的蒙皮数据
+     */
+    abstract getSkinProps(): SkinProps;
     /**
      * 初始化 GPU 资源
      * @override
@@ -114,4 +119,4 @@ export declare abstract class Geometry extends EffectsObject {
      */
     flush(): void;
 }
-export declare function generateEmptyTypedArray(type: number): Float32Array | Int32Array | Int16Array;
+export declare function generateEmptyTypedArray(type: number): Float32Array | Int16Array | Int32Array;

package/dist/render/gpu-capability.d.ts

@@ -1,5 +1,5 @@
+import type { GLType } from '../gl';
 import type { Immutable } from '../utils';
-export type GLType = 'webgl' | 'webgl2';
 export interface GPUCapabilityDetail {
     floatTexture: number;
     halfFloatTexture: number;
@@ -42,8 +42,8 @@ export declare class GPUCapability {
     drawBuffers(gl: WebGLRenderingContext | WebGL2RenderingContext, bufferStates: boolean[]): void;
     setTextureAnisotropic(gl: WebGLRenderingContext | WebGL2RenderingContext, target: GLenum, level: number): void;
 }
-export declare const COMPRESSED_TEXTURE: {
-    NONE: number;
-    PVRTC: number;
-    ASTC: number;
-};
+export declare enum COMPRESSED_TEXTURE {
+    NONE = 0,
+    PVRTC = 1,
+    ASTC = 2
+}

package/dist/render/renderer.d.ts

@@ -8,8 +8,9 @@ import type { Geometry } from './geometry';
 import type { RenderFrame, RenderingData } from './render-frame';
 import type { RenderPassClearAction, RenderPassStoreAction } from './render-pass';
 import type { ShaderLibrary } from './shader';
+import type { GLType } from '../gl';
 export declare class Renderer implements LostHandler, RestoreHandler {
-    static create: (canvas: HTMLCanvasElement | OffscreenCanvas, framework: 'webgl' | 'webgl2', renderOptions?: WebGLContextAttributes) => Renderer;
+    static create: (canvas: HTMLCanvasElement | OffscreenCanvas, framework: GLType, renderOptions?: WebGLContextAttributes) => Renderer;
     engine: Engine;
     env: string;
     /**

package/dist/render/semantic-map.d.ts

@@ -8,7 +8,7 @@ export declare class SemanticMap implements Disposable {
     constructor(semantics?: Record<string, SemanticGetter>);
     toObject(): Record<string, SemanticGetter>;
     setSemantic(name: string, value?: SemanticGetter): void;
-    getSemanticValue(name: string, state: RenderingData): number | Float32Array | Int32Array | Float64Array | Uint8Array | Uint32Array | Uint16Array | Int8Array | Int16Array | number[] | number[][] | import("@galacean/effects-core").Texture | import("@galacean/effects-math/es/core").Vector2 | import("@galacean/effects-math/es/core").Vector3 | import("@galacean/effects-math/es/core").Vector4 | import("@galacean/effects-math/es/core").Matrix3 | import("@galacean/effects-math/es/core").Matrix4 | import("@galacean/effects-core").Texture[] | import("packages/effects-core/src/material/types").UniformStruct | import("packages/effects-core/src/material/types").UniformStruct[] | SemanticFunc | undefined;
+    getSemanticValue(name: string, state: RenderingData): number | Float32Array | Float64Array | Uint8Array | Uint32Array | Uint16Array | Int8Array | Int16Array | Int32Array | number[] | number[][] | import("@galacean/effects-core").Texture | import("@galacean/effects-math/es/core").Vector2 | import("@galacean/effects-math/es/core").Vector3 | import("@galacean/effects-math/es/core").Vector4 | import("@galacean/effects-math/es/core").Matrix3 | import("@galacean/effects-math/es/core").Matrix4 | import("@galacean/effects-core").Texture[] | import("packages/effects-core/src/material/types").UniformStruct | import("packages/effects-core/src/material/types").UniformStruct[] | SemanticFunc | undefined;
     hasSemanticValue(name: string): boolean;
     dispose(): void;
 }

package/dist/texture/texture.d.ts

@@ -83,3 +83,4 @@ export declare abstract class Texture extends EffectsObject {
 }
 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/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/utils/device.d.ts

@@ -2,3 +2,4 @@ export declare function getPixelRatio(): number;
 export declare function isIOS(): boolean;
 export declare function isAndroid(): boolean;
 export declare function isSimulatorCellPhone(): boolean;
+export declare function isAlipayMiniApp(): boolean;

package/dist/utils/index.d.ts

@@ -4,7 +4,7 @@ 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]>;

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

@@ -8,11 +8,10 @@ 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>;
+export type VFXItemContent = ParticleSystem | SpriteComponent | CameraController | InteractComponent | void | {};
+export type VFXItemConstructor = new (engine: Engine, props: VFXItemProps, composition: Composition) => VFXItem;
 export type VFXItemProps = spec.Item & {
     items: VFXItemProps[];
     startTime: number;
@@ -23,7 +22,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 +30,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 +44,6 @@ export declare class VFXItem<T extends VFXItemContent> extends EffectsObject imp
      * 元素动画的持续时间
      */
     duration: number;
-    /**
-     * 元素当前更新归一化时间，开始时为 0，结束时为 1
-     */
-    lifetime: number;
     /**
      * 父元素的 id
      */
@@ -81,16 +76,9 @@ export declare class VFXItem<T extends VFXItemContent> extends EffectsObject imp
     /**
      * 元素创建的数据图层/粒子/模型等
      */
-    _content?: T;
-    /**
-     * 元素动画是否延迟播放
-     */
-    delaying: boolean;
-    /**
-     * 元素动画的速度
-     */
+    _content?: VFXItemContent;
+    reusable: boolean;
     type: spec.ItemType;
-    stopped: boolean;
     props: VFXItemProps;
     components: Component[];
     itemBehaviours: ItemBehaviour[];
@@ -101,31 +89,25 @@ 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>;
+    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 lifetimeStarted(): boolean;
+    get compositionReusable(): boolean;
     /**
      * 设置元素的动画速度
      * @param speed - 速度
@@ -146,18 +128,14 @@ export declare class VFXItem<T extends VFXItemContent> extends EffectsObject imp
      * @param classConstructor - 要获取的组件类型
      * @returns 查询结果中符合类型的第一个组件
      */
-    getComponent<T extends Component>(classConstructor: new (engine: Engine) => T): T | undefined;
+    getComponent<T extends Component>(classConstructor: new (engine: Engine) => T): T;
     /**
      * 获取某一类型的所有组件
      * @param classConstructor - 要获取的组件
      * @returns 一个组件列表，包含所有符合类型的组件
      */
     getComponents<T extends Component>(classConstructor: new (engine: Engine) => T): T[];
-    setParent(vfxItem: VFXItem<VFXItemContent>): void;
-    /**
-     * 停止播放元素动画
-     */
-    stop(): void;
+    setParent(vfxItem: VFXItem): void;
     /**
      * 元素动画结束播放时回调函数
      * @override
@@ -210,7 +188,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;
     /**
@@ -246,7 +229,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;
@@ -267,4 +250,4 @@ export declare namespace Item {
  * @param props
  * @param composition
  */
-export declare function createVFXItem(props: VFXItemProps, composition: Composition): VFXItem<any>;
+export declare function createVFXItem(props: VFXItemProps, composition: Composition): VFXItem;

package/package.json

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

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;
-}