@galacean/effects-core 2.0.3 → 2.1.0-alpha.0

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

@@ -1,5 +1,7 @@
 import type { Euler, Vector3 } from '@galacean/effects-math/es/core/index';
 import type { ValueGetter } from '../../math';
+import { TrackAsset } from '../timeline/track';
+import type { TimelineAsset } from './timeline-asset';
 /**
  * 基础位移属性数据
  */
@@ -16,3 +18,9 @@ export type ItemLinearVelOverLifetime = {
     z?: ValueGetter<number>;
     enabled?: boolean;
 };
+/**
+ * @since 2.0.0
+ */
+export declare class ObjectBindingTrack extends TrackAsset {
+    create(timelineAsset: TimelineAsset): void;
+}

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

@@ -2,10 +2,54 @@ import { Vector3 } from '@galacean/effects-math/es/core/vector3';
 import type { Quaternion } from '@galacean/effects-math/es/core/quaternion';
 import * as spec from '@galacean/effects-specification';
 import type { ValueGetter } from '../../math';
+import { AnimationPlayable } from './animation-playable';
+import type { ItemBasicTransform, ItemLinearVelOverLifetime } from './calculate-item';
 import type { FrameContext, PlayableGraph } from './playable-graph';
 import { Playable, PlayableAsset } from './playable-graph';
 import { EffectsObject } from '../../effects-object';
 import { VFXItem } from '../../vfx-item';
+/**
+ * @since 2.0.0
+ */
+export declare class TransformAnimationPlayable extends AnimationPlayable {
+    originalTransform: ItemBasicTransform;
+    protected sizeSeparateAxes: boolean;
+    protected sizeXOverLifetime: ValueGetter<number>;
+    protected sizeYOverLifetime: ValueGetter<number>;
+    protected sizeZOverLifetime: ValueGetter<number>;
+    protected rotationOverLifetime: {
+        asRotation?: boolean;
+        separateAxes?: boolean;
+        enabled?: boolean;
+        x?: ValueGetter<number>;
+        y?: ValueGetter<number>;
+        z?: ValueGetter<number>;
+    };
+    gravityModifier: ValueGetter<number>;
+    orbitalVelOverLifetime: {
+        x?: ValueGetter<number>;
+        y?: ValueGetter<number>;
+        z?: ValueGetter<number>;
+        center: [x: number, y: number, z: number];
+        asRotation?: boolean;
+        enabled?: boolean;
+    };
+    speedOverLifetime?: ValueGetter<number>;
+    linearVelOverLifetime: ItemLinearVelOverLifetime;
+    positionOverLifetime: spec.PositionOverLifetime;
+    gravity: Vector3;
+    direction: Vector3;
+    startSpeed: number;
+    data: TransformPlayableAssetData;
+    private velocity;
+    private binding;
+    start(): void;
+    processFrame(context: FrameContext): void;
+    /**
+     * 应用时间轴K帧数据到对象
+     */
+    private sampleAnimation;
+}
 export declare class TransformPlayableAsset extends PlayableAsset {
     transformAnimationData: TransformPlayableAssetData;
     createPlayable(graph: PlayableGraph): Playable;
@@ -25,6 +69,12 @@ export interface TransformPlayableAssetData extends spec.EffectsObjectData {
      */
     positionOverLifetime?: spec.PositionOverLifetime;
 }
+/**
+ * @since 2.0.0
+ */
+export declare class ActivationPlayable extends Playable {
+    processFrame(context: FrameContext): void;
+}
 export declare class ActivationPlayableAsset extends PlayableAsset {
     createPlayable(graph: PlayableGraph): Playable;
 }

package/dist/plugins/cal/playable-graph.d.ts

@@ -1,4 +1,94 @@
 import { EffectsObject } from '../../effects-object';
+import type { Disposable } from '../../utils';
+/**
+ * 动画图，负责更新所有的动画节点
+ * @since 2.0.0
+ */
+export declare class PlayableGraph {
+    private playableOutputs;
+    private playables;
+    evaluate(dt: number): void;
+    connect(source: Playable, sourceOutputPort: number, destination: Playable, destinationInputPort: number): void;
+    addOutput(output: PlayableOutput): void;
+    addPlayable(playable: Playable): void;
+    private processFrameWithRoot;
+    private prepareFrameWithRoot;
+    private updatePlayableTime;
+}
+/**
+ * 动画图可播放节点对象
+ * @since 2.0.0
+ */
+export declare class Playable implements Disposable {
+    onPlayablePlayFlag: boolean;
+    onPlayablePauseFlag: boolean;
+    overrideTimeNextEvaluation: boolean;
+    private destroyed;
+    private inputs;
+    private inputOuputPorts;
+    private inputWeight;
+    private outputs;
+    private playState;
+    private traversalMode;
+    /**
+     * 当前本地播放的时间
+     */
+    protected time: number;
+    constructor(graph: PlayableGraph, inputCount?: number);
+    play(): void;
+    pause(): void;
+    connectInput(inputPort: number, sourcePlayable: Playable, sourceOutputPort: number, weight?: number): void;
+    addInput(sourcePlayable: Playable, sourceOutputPort: number, weight?: number): void;
+    getInputCount(): number;
+    getInputs(): Playable[];
+    getInput(index: number): Playable;
+    getOutputCount(): number;
+    getOutputs(): Playable[];
+    getOutput(index: number): Playable;
+    getInputWeight(inputIndex: number): number;
+    setInputWeight(playable: Playable, weight: number): void;
+    setInputWeight(inputIndex: number, weight: number): void;
+    setTime(time: number): void;
+    getTime(): number;
+    getPlayState(): PlayState;
+    setTraversalMode(mode: PlayableTraversalMode): void;
+    getTraversalMode(): PlayableTraversalMode;
+    onPlayablePlay(context: FrameContext): void;
+    onPlayablePause(context: FrameContext): void;
+    prepareFrame(context: FrameContext): void;
+    processFrame(context: FrameContext): void;
+    onPlayableDestroy(): void;
+    dispose(): void;
+    private setOutput;
+    private setInput;
+}
+/**
+ * 动画图输出节点对象，将动画数据采样到绑定的元素属性上
+ * @since 2.0.0
+ */
+export declare class PlayableOutput {
+    /**
+     * 绑定到的动画 item
+     */
+    userData: object;
+    /**
+     * 源 playable 对象
+     */
+    sourcePlayable: Playable;
+    context: FrameContext;
+    /**
+     * 当前本地播放的时间
+     */
+    protected time: number;
+    private sourceOutputPort;
+    constructor();
+    setSourcePlayeble(playable: Playable, port?: number): void;
+    getSourceOutputPort(): number;
+    setUserData(value: object): void;
+    getUserData(): object;
+    prepareFrame(): void;
+    processFrame(): void;
+}
 export declare abstract class PlayableAsset extends EffectsObject {
     abstract createPlayable(graph: PlayableGraph): Playable;
 }

package/dist/plugins/camera/camera-controller-node.d.ts

@@ -4,6 +4,6 @@ import type { Engine } from '../../engine';
 export declare class CameraController extends Behaviour {
     private options;
     constructor(engine: Engine, props?: spec.CameraContent);
-    update(): void;
+    onUpdate(): void;
     fromData(data: spec.CameraContent): void;
 }

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

@@ -27,8 +27,8 @@ export declare class InteractComponent extends RendererComponent {
     private hasBeenAddedToComposition;
     set interactive(enable: boolean);
     get interactive(): boolean;
-    start(): void;
-    update(dt: number): void;
+    onStart(): void;
+    onUpdate(dt: number): void;
     render(renderer: Renderer): void;
     onDestroy(): void;
     endDragTarget(): void;

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

@@ -15,8 +15,8 @@ export declare class ParticleSystemRenderer extends RendererComponent {
     particleMesh: ParticleMesh;
     private trailMesh?;
     constructor(engine: Engine, particleMeshProps?: ParticleMeshProps, trailMeshProps?: TrailMeshProps);
-    start(): void;
-    update(dt: number): void;
+    onStart(): void;
+    onUpdate(dt: number): void;
     render(renderer: Renderer): void;
     reset(): void;
     updateTime(now: number, delta: number): void;

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

@@ -166,10 +166,10 @@ export declare class ParticleSystem extends Component {
     setOpacity(opacity: number): void;
     setParentTransform(transform: Transform): void;
     getTextures(): Texture[];
-    start(): void;
+    startEmit(): void;
     stop(): void;
     reset(): void;
-    onUpdate(delta: number): void;
+    update(delta: number): void;
     onDestroy(): void;
     getParticleBoxes(): {
         center: Vector3;

package/dist/plugins/particle/particle-vfx-item.d.ts

@@ -1,5 +1,15 @@
-import type { PlayableGraph } from '../cal/playable-graph';
+import type { FrameContext, PlayableGraph } from '../cal/playable-graph';
 import { Playable, PlayableAsset } from '../cal/playable-graph';
+import { ParticleSystem } from './particle-system';
+/**
+ * @since 2.0.0
+ */
+export declare class ParticleBehaviourPlayable extends Playable {
+    lastTime: number;
+    particleSystem: ParticleSystem;
+    start(context: FrameContext): void;
+    processFrame(context: FrameContext): void;
+}
 export declare class ParticleBehaviourPlayableAsset extends PlayableAsset {
     createPlayable(graph: PlayableGraph): Playable;
 }

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

@@ -129,8 +129,8 @@ export declare class SpriteComponent extends RendererComponent {
      */
     setTexture(texture: Texture): void;
     render(renderer: Renderer): void;
-    start(): void;
-    update(dt: number): void;
+    onStart(): void;
+    onUpdate(dt: number): void;
     onDestroy(): void;
     private getItemInitData;
     private setItem;

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

@@ -19,7 +19,7 @@ export declare class TextComponent extends SpriteComponent {
      */
     lineCount: number;
     constructor(engine: Engine, props?: spec.TextContent);
-    update(dt: number): void;
+    onUpdate(dt: number): void;
     fromData(data: SpriteItemProps): void;
     updateWithOptions(options: spec.TextContentOptions): void;
     updateTexture(flipY?: boolean): void;

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

@@ -1,5 +1,52 @@
-import { Playable } from '../cal/playable-graph';
+import { EndBehavior } from '@galacean/effects-specification';
+import type { PlayableGraph } from '../cal/playable-graph';
+import { Playable, PlayableAsset, PlayableOutput } from '../cal/playable-graph';
 import { ParticleSystem } from '../particle/particle-system';
+import type { Constructor } from '../../utils';
+/**
+ * @since 2.0.0
+ */
+export declare class TimelineClip {
+    id: string;
+    name: string;
+    start: number;
+    duration: number;
+    asset: PlayableAsset;
+    endBehavior: EndBehavior;
+    constructor();
+    toLocalTime(time: number): number;
+}
+/**
+ * @since 2.0.0
+ */
+export declare class TrackAsset extends PlayableAsset {
+    name: string;
+    binding: object;
+    trackType: TrackType;
+    private clipSeed;
+    private clips;
+    protected children: TrackAsset[];
+    /**
+     * 重写该方法以获取自定义对象绑定
+     */
+    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;
+    createClip<T extends PlayableAsset>(classConstructor: Constructor<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
@@ -14,3 +61,9 @@ export declare class RuntimeClip {
     set enable(value: boolean);
     evaluateAt(localTime: number): void;
 }
+/**
+ * @since 2.0.0
+ */
+export interface TimelineClipData {
+    asset: PlayableAsset;
+}

package/dist/ticker.d.ts

@@ -1,3 +1,4 @@
+export declare const DEFAULT_FPS = 60;
 /**
  * 定时器类
  */

package/dist/vfx-item.d.ts

@@ -2,7 +2,7 @@ import { Vector3 } from '@galacean/effects-math/es/core/vector3';
 import * as spec from '@galacean/effects-specification';
 import type { VFXItemData } from './asset-loader';
 import type { Component } from './components';
-import { RendererComponent, Behaviour } from './components';
+import { RendererComponent } from './components';
 import type { Composition } from './composition';
 import { EffectsObject } from './effects-object';
 import type { Engine } from './engine';
@@ -76,8 +76,8 @@ export declare class VFXItem extends EffectsObject implements Disposable {
     reusable: boolean;
     type: spec.ItemType;
     props: VFXItemProps;
+    isDuringPlay: boolean;
     components: Component[];
-    itemBehaviours: Behaviour[];
     rendererComponents: RendererComponent[];
     /**
      * 元素可见性，该值的改变会触发 `handleVisibleChanged` 回调
@@ -89,6 +89,7 @@ export declare class VFXItem extends EffectsObject implements Disposable {
      */
     private speed;
     private listIndex;
+    private isEnabled;
     private eventProcessor;
     static isComposition(item: VFXItem): boolean;
     static isSprite(item: VFXItem): boolean;
@@ -97,6 +98,7 @@ export declare class VFXItem extends EffectsObject implements Disposable {
     static isTree(item: VFXItem): boolean;
     static isCamera(item: VFXItem): boolean;
     static isExtraCamera(item: VFXItem): boolean;
+    static isAncestor(ancestorCandidate: VFXItem, descendantCandidate: VFXItem): boolean;
     constructor(engine: Engine, props?: VFXItemProps);
     /**
      * 返回元素创建的数据

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-core",
-  "version": "2.0.3",
+  "version": "2.1.0-alpha.0",
   "description": "Galacean Effects runtime core for the web",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",