@galacean/engine-core 2.0.0-alpha.2 → 2.0.0-alpha.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-core",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.21",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -18,10 +18,10 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-math": "2.0.0-alpha.2"
+    "@galacean/engine-math": "2.0.0-alpha.21"
   },
   "devDependencies": {
-    "@galacean/engine-design": "2.0.0-alpha.2"
+    "@galacean/engine-design": "2.0.0-alpha.21"
   },
   "scripts": {
     "b:types": "tsc"

package/types/2d/text/TextRenderer.d.ts

@@ -29,6 +29,7 @@ export declare class TextRenderer extends Renderer implements ITextRenderer {
     private _fontSize;
     private _fontStyle;
     private _lineSpacing;
+    private _characterSpacing;
     private _horizontalAlignment;
     private _verticalAlignment;
     private _enableWrapping;
@@ -69,10 +70,15 @@ export declare class TextRenderer extends Renderer implements ITextRenderer {
     get fontStyle(): FontStyle;
     set fontStyle(value: FontStyle);
     /**
-     * The space between two lines (in pixels).
+     * The space between two lines, in em (ratio of fontSize).
      */
     get lineSpacing(): number;
     set lineSpacing(value: number);
+    /**
+     * The space between two characters, in em (ratio of fontSize).
+     */
+    get characterSpacing(): number;
+    set characterSpacing(value: number);
     /**
      * The horizontal alignment.
      */

package/types/ComponentsManager.d.ts

@@ -12,8 +12,6 @@ export declare class ComponentsManager {
     private _onUpdateScripts;
     private _onLateUpdateScripts;
     private _onPhysicsUpdateScripts;
-    private _pendingDestroyScripts;
-    private _disposeDestroyScripts;
     private _onUpdateAnimations;
     private _onUpdateRenderers;
     private _componentsContainerPool;
@@ -37,14 +35,12 @@ export declare class ComponentsManager {
     removeOnUpdateAnimations(animation: Animator): void;
     addOnUpdateRenderers(renderer: Renderer): void;
     removeOnUpdateRenderers(renderer: Renderer): void;
-    addPendingDestroyScript(component: Script): void;
     callScriptOnStart(): void;
     callScriptOnUpdate(deltaTime: number): void;
     callScriptOnLateUpdate(deltaTime: number): void;
     callScriptOnPhysicsUpdate(): void;
     callAnimationUpdate(deltaTime: number): void;
     callRendererOnUpdate(deltaTime: number): void;
-    handlingInvalidScripts(): void;
     callCameraOnBeginRender(camera: Camera): void;
     callCameraOnEndRender(camera: Camera): void;
     getActiveChangedTempList(): Component[];

package/types/Engine.d.ts

@@ -3,6 +3,7 @@ import { Canvas } from "./Canvas";
 import { EngineSettings } from "./EngineSettings";
 import { Entity } from "./Entity";
 import { SceneManager } from "./SceneManager";
+import { RenderingStatistics } from "./asset/RenderingStatistics";
 import { ResourceManager } from "./asset/ResourceManager";
 import { EventDispatcher, Time } from "./base";
 import { InputManager } from "./input";
@@ -30,7 +31,6 @@ export declare class Engine extends EventDispatcher {
     private _vSyncCounter;
     private _targetFrameInterval;
     private _destroyed;
-    private _frameInProcess;
     private _waitingDestroy;
     private _waitingGC;
     private _postProcessPasses;
@@ -56,6 +56,10 @@ export declare class Engine extends EventDispatcher {
      * The time information of the engine.
      */
     get time(): Time;
+    /**
+     * Rendering statistics.
+     */
+    get renderingStatistics(): RenderingStatistics;
     /**
      * Whether the engine is paused.
      */
@@ -120,6 +124,7 @@ export declare class Engine extends EventDispatcher {
      * @param pass - Post process pass to add
      */
     addPostProcessPass(pass: PostProcessPass): void;
+    private _processPendingDestroyObjects;
     private _destroy;
     /**
      * Destroy engine.

package/types/RenderPipeline/RenderTargetPool.d.ts

@@ -0,0 +1 @@
+export {};

package/types/Renderer.d.ts

@@ -3,7 +3,6 @@ import { Component } from "./Component";
 import { Entity } from "./Entity";
 import { RenderContext } from "./RenderPipeline/RenderContext";
 import { TransformModifyFlags } from "./Transform";
-import { IComponentCustomClone } from "./clone/ComponentCloner";
 import { SpriteMaskLayer } from "./enums/SpriteMaskLayer";
 import { Material } from "./material";
 import { ShaderData } from "./shader/ShaderData";
@@ -11,7 +10,7 @@ import { ShaderData } from "./shader/ShaderData";
  * Basis for all renderers.
  * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
  */
-export declare class Renderer extends Component implements IComponentCustomClone {
+export declare class Renderer extends Component {
     private static _tempVector0;
     private static _receiveShadowMacro;
     private static _localMatrixProperty;

package/types/Signal.d.ts

@@ -0,0 +1,58 @@
+import { Component } from "./Component";
+/**
+ * Signal is a typed event mechanism for Galacean Engine.
+ * @typeParam T - Tuple type of the signal arguments
+ */
+export declare class Signal<T extends any[] = []> {
+    private _listeners;
+    /**
+     * Add a listener for this signal.
+     * @param fn - The callback function
+     * @param target - The `this` context for the callback
+     */
+    on(fn: (...args: T) => void, target?: any): void;
+    /**
+     * Add a structured binding listener. Structured bindings support clone remapping.
+     * @param target - The target component
+     * @param methodName - The method name to invoke on the target
+     * @param args - Pre-resolved arguments
+     */
+    on(target: Component, methodName: string, ...args: any[]): void;
+    /**
+     * Add a one-time listener that is automatically removed after first invocation.
+     * @param fn - The callback function
+     * @param target - The `this` context for the callback
+     */
+    once(fn: (...args: T) => void, target?: any): void;
+    /**
+     * Add a one-time structured binding listener.
+     * @param target - The target component
+     * @param methodName - The method name to invoke on the target
+     * @param args - Pre-resolved arguments
+     */
+    once(target: Component, methodName: string, ...args: any[]): void;
+    /**
+     * Remove a listener. Both `fn` and `target` must match the values passed to `on`/`once`.
+     * @param fn - The callback function to remove
+     * @param target - The `this` context that was used when adding the listener
+     */
+    off(fn: (...args: T) => void, target?: any): void;
+    /**
+     * Remove a structured binding listener by target and method name.
+     * @param target - The target component
+     * @param methodName - The method name
+     */
+    off(target: Component, methodName: string): void;
+    /**
+     * Remove all listeners, or all listeners for a specific target.
+     * @param target - If provided, only remove listeners bound to this target
+     */
+    removeAll(target?: any): void;
+    /**
+     * Invoke the signal, calling all listeners in order.
+     * @param args - Arguments to pass to each listener
+     */
+    invoke(...args: T): void;
+    private _cloneArguments;
+    private _addListener;
+}

package/types/animation/Animator.d.ts

@@ -133,8 +133,7 @@ export declare class Animator extends Component {
     private _updateCrossFadeData;
     private _preparePlayOwner;
     private _applyStateTransitions;
-    private _checkNoExitTimeTransition;
-    private _checkCrossFadeInterrupt;
+    private _tryCrossFadeInterrupt;
     private _checkNoExitTimeTransitions;
     private _checkSubTransition;
     private _checkBackwardsSubTransition;
@@ -146,9 +145,6 @@ export declare class Animator extends Component {
     private _fireAnimationEvents;
     private _fireSubAnimationEvents;
     private _fireBackwardSubAnimationEvents;
-    private _callAnimatorScriptOnEnter;
-    private _callAnimatorScriptOnUpdate;
-    private _callAnimatorScriptOnExit;
     private _checkAnyAndEntryState;
     private _checkRevertOwner;
     private _fireAnimationEventsAndCallScripts;

package/types/animation/AnimatorState.d.ts

@@ -11,6 +11,10 @@ export declare class AnimatorState {
     speed: number;
     /** The wrap mode used in the state. */
     wrapMode: WrapMode;
+    private _onStateEnterScripts;
+    private _onStateUpdateScripts;
+    private _onStateExitScripts;
+    private _engine;
     private _clipStartTime;
     private _clipEndTime;
     private _clip;

package/types/animation/AnimatorStateMachine.d.ts

@@ -9,6 +9,7 @@ export interface AnimatorStateMap {
 export declare class AnimatorStateMachine {
     /** The list of states. */
     readonly states: AnimatorState[];
+    private _engine;
     /**
      * The state will be played automatically.
      * @remarks When the Animator's AnimatorController changed or the Animator's onEnable be triggered.

package/types/animation/StateMachineScript.d.ts

@@ -1,9 +1,11 @@
 import { Animator } from "../animation/Animator";
 import { AnimatorState } from "../animation/AnimatorState";
+import { EngineObject } from "../base/EngineObject";
 /**
  * StateMachineScript is a component that can be added to a animator state. It's the base class every script on a state derives from.
  */
-export declare class StateMachineScript {
+export declare class StateMachineScript extends EngineObject {
+    constructor();
     /**
      * onStateEnter is called when a transition starts and the state machine starts to evaluate this state.
      * @param animator - The animator
@@ -25,8 +27,5 @@ export declare class StateMachineScript {
      * @param layerIndex - The index of the layer where the state is located
      */
     onStateExit(animator: Animator, animatorState: AnimatorState, layerIndex: number): void;
-    /**
-     * Destroy this instance.
-     */
-    destroy(): void;
+    protected _onDestroy(): void;
 }

package/types/asset/AssetType.d.ts

@@ -2,20 +2,11 @@
  * Asset Type.
  */
 export declare enum AssetType {
-    /**
-     * Plain text.
-     * @remarks Will not be cached based on url in ResourceManager.
-     */
+    /** Plain text. */
     Text = "Text",
-    /**
-     * JSON.
-     * @remarks Will not be cached based on url in ResourceManager.
-     */
+    /** JSON. */
     JSON = "JSON",
-    /**
-     * ArrayBuffer.
-     * @remarks Will not be cached based on url in ResourceManager.
-     */
+    /** ArrayBuffer. */
     Buffer = "Buffer",
     /** 2D Texture. */
     Texture2D = "Texture2D",
@@ -48,11 +39,9 @@ export declare enum AssetType {
     /** Sprite Atlas. */
     SpriteAtlas = "SpriteAtlas",
     /** Ambient light. */
-    Env = "Environment",
+    AmbientLight = "AmbientLight",
     /** Scene. */
     Scene = "Scene",
-    /** HDR to cube. */
-    HDR = "HDR",
     /** Font. */
     Font = "Font",
     /** Source Font, include ttf, otf and woff. */
@@ -62,5 +51,7 @@ export declare enum AssetType {
     /** Project asset. */
     Project = "project",
     /** PhysicsMaterial. */
-    PhysicsMaterial = "PhysicsMaterial"
+    PhysicsMaterial = "PhysicsMaterial",
+    /** RenderTarget. */
+    RenderTarget = "RenderTarget"
 }

package/types/asset/BufferAsset.d.ts

@@ -0,0 +1,9 @@
+import { EngineObject } from "../base/EngineObject";
+/**
+ * Buffer asset for storing binary data.
+ */
+export declare class BufferAsset extends EngineObject {
+    /** The binary buffer data. */
+    buffer: ArrayBuffer;
+    protected _onDestroy(): void;
+}

package/types/asset/JSONAsset.d.ts

@@ -0,0 +1,9 @@
+import { EngineObject } from "../base/EngineObject";
+/**
+ * JSON asset for storing parsed JSON data.
+ */
+export declare class JSONAsset extends EngineObject {
+    /** The parsed JSON data. */
+    data: Object;
+    protected _onDestroy(): void;
+}

package/types/asset/RenderingStatistics.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Rendering statistics.
+ */
+export declare class RenderingStatistics {
+    /**
+     * Memory used by all textures, in bytes.
+     */
+    get textureMemory(): number;
+    /**
+     * Memory used by all buffers, in bytes.
+     */
+    get bufferMemory(): number;
+    /**
+     * Total memory used, in bytes.
+     */
+    get totalMemory(): number;
+}

package/types/asset/ResourceManager.d.ts

@@ -34,30 +34,30 @@ export declare class ResourceManager {
      * @param engine - Engine to which the current ResourceManager belongs
      */
     constructor(engine: Engine);
-    /**
-     * Load asset asynchronously through the path.
-     * @param path - Path
-     * @returns Asset promise
-     */
-    load<T>(path: string): AssetPromise<T>;
-    /**
-     * Load asset collection asynchronously through urls.
-     * @param paths - Path collections
-     * @returns Asset Promise
-     */
-    load(paths: string[]): AssetPromise<Object[]>;
     /**
      * Load the asset asynchronously by asset item information.
      * @param assetItem - AssetItem
      * @returns AssetPromise
      */
-    load<T>(assetItem: LoadItem): AssetPromise<T>;
+    load<T extends EngineObject>(assetItem: LoadItem): AssetPromise<T>;
     /**
      * Load the asset collection asynchronously by loading the information collection.
      * @param assetItems - Asset collection
      * @returns AssetPromise
      */
-    load(assetItems: LoadItem[]): AssetPromise<Object[]>;
+    load<T extends EngineObject[]>(assetItems: LoadItem[]): AssetPromise<T>;
+    /**
+     * Load asset collection asynchronously through urls.
+     * @param paths - Path collections
+     * @returns Asset Promise
+     */
+    load<T extends EngineObject[]>(paths: string[]): AssetPromise<T>;
+    /**
+     * Load asset asynchronously through the path.
+     * @param path - Path
+     * @returns Asset promise
+     */
+    load<T extends EngineObject>(path: string): AssetPromise<T>;
     /**
      * Get the resource from cache by asset url, return the resource object if it loaded, otherwise return null.
      * @param url - Resource url

package/types/asset/TextAsset.d.ts

@@ -0,0 +1,9 @@
+import { EngineObject } from "../base/EngineObject";
+/**
+ * Text asset for storing plain text data.
+ */
+export declare class TextAsset extends EngineObject {
+    /** The text content. */
+    text: string;
+    protected _onDestroy(): void;
+}

package/types/base/EngineObject.d.ts

@@ -2,16 +2,20 @@ import { Engine } from "../Engine";
 /**
  * EngineObject.
  */
-export declare abstract class EngineObject {
+export declare class EngineObject {
     private static _instanceIdCounter;
-    /** Engine unique id. */
     readonly instanceId: number;
-    protected _engine: Engine;
     protected _destroyed: boolean;
     /**
      * Get the engine which the object belongs.
      */
     get engine(): Engine;
+    /**
+     * Whether this object is pending destruction.
+     * @remarks `destroy()` has been called but the actual destruction is deferred until end of frame,
+     * during this period all properties are still accessible.
+     */
+    get pendingDestroy(): boolean;
     /**
      * Whether it has been destroyed.
      */

package/types/clone/CloneUtils.d.ts

@@ -0,0 +1 @@
+export {};

package/types/clone/ComponentCloner.d.ts

@@ -5,8 +5,6 @@ import { Entity } from "../Entity";
  */
 export interface ICustomClone {
 }
-export interface IComponentCustomClone {
-}
 export declare class ComponentCloner {
     /**
      * Clone component.

package/types/graphic/Buffer.d.ts

@@ -10,7 +10,6 @@ export declare class Buffer extends GraphicsResource {
     private _type;
     private _byteLength;
     private _bufferUsage;
-    private _platformBuffer;
     private _readable;
     private _data;
     /**
@@ -106,6 +105,14 @@ export declare class Buffer extends GraphicsResource {
      * @param dataLength - Output data length
      */
     getData(data: ArrayBufferView, bufferByteOffset: number, dataOffset: number, dataLength: number): void;
+    /**
+     * Copy data from another buffer on the GPU.
+     * @param srcBuffer - Source buffer
+     * @param srcByteOffset - Byte offset in the source buffer
+     * @param dstByteOffset - Byte offset in this buffer
+     * @param byteLength - Number of bytes to copy
+     */
+    copyFromBuffer(srcBuffer: Buffer, srcByteOffset: number, dstByteOffset: number, byteLength: number): void;
     /**
      * Mark buffer as readable, the `data` property will be not accessible anymore.
      */

package/types/graphic/TransformFeedback.d.ts

@@ -0,0 +1 @@
+export {};

package/types/graphic/TransformFeedbackPrimitive.d.ts

@@ -0,0 +1 @@
+export {};

package/types/graphic/TransformFeedbackShader.d.ts

@@ -0,0 +1 @@
+export {};

package/types/graphic/TransformFeedbackSimulator.d.ts

@@ -0,0 +1 @@
+export {};

package/types/graphic/enums/BufferBindFlag.d.ts

@@ -2,8 +2,8 @@
  * Buffer binding flag.
  */
 export declare enum BufferBindFlag {
-    /** Vertex buffer binding flag */
+    /** Vertex buffer binding flag. */
     VertexBuffer = 0,
-    /** Index buffer binding flag */
+    /** Index buffer binding flag. */
     IndexBuffer = 1
 }

package/types/index.d.ts

@@ -8,6 +8,7 @@ export { SceneManager } from "./SceneManager";
 export { Entity } from "./Entity";
 export { Component } from "./Component";
 export { Script } from "./Script";
+export { Signal } from "./Signal";
 export { Renderer, RendererUpdateFlags } from "./Renderer";
 export { dependentComponents, DependentMode } from "./ComponentsDependencies";
 export { Camera } from "./Camera";
@@ -20,11 +21,15 @@ export { request } from "./asset/request";
 export type { RequestConfig } from "./asset/request";
 export { Loader } from "./asset/Loader";
 export { ContentRestorer } from "./asset/ContentRestorer";
+export { RenderingStatistics } from "./asset/RenderingStatistics";
 export { ResourceManager, resourceLoader } from "./asset/ResourceManager";
 export { AssetPromise } from "./asset/AssetPromise";
 export type { LoadItem } from "./asset/LoadItem";
 export { AssetType } from "./asset/AssetType";
 export { ReferResource } from "./asset/ReferResource";
+export { TextAsset } from "./asset/TextAsset";
+export { JSONAsset } from "./asset/JSONAsset";
+export { BufferAsset } from "./asset/BufferAsset";
 export * from "./RenderPipeline/index";
 export * from "./base";
 export { Background } from "./Background";
@@ -59,6 +64,7 @@ export * from "./env-probe/index";
 export * from "./shader/index";
 export * from "./Layer";
 export * from "./clone/CloneManager";
+export { CloneUtils } from "./clone/CloneUtils";
 export * from "./renderingHardwareInterface/index";
 export * from "./physics/index";
 export * from "./Utils";

package/types/lighting/AmbientLight.d.ts

@@ -9,7 +9,6 @@ import { DiffuseMode } from "./enums/DiffuseMode";
 export declare class AmbientLight extends ReferResource {
     private static _shMacro;
     private static _specularMacro;
-    private static _decodeRGBMMacro;
     private static _diffuseColorProperty;
     private static _diffuseSHProperty;
     private static _diffuseIntensityProperty;
@@ -24,12 +23,6 @@ export declare class AmbientLight extends ReferResource {
     private _diffuseMode;
     private _shArray;
     private _scenes;
-    private _specularTextureDecodeRGBM;
-    /**
-     * Whether to decode from specularTexture with RGBM format.
-     */
-    get specularTextureDecodeRGBM(): boolean;
-    set specularTextureDecodeRGBM(value: boolean);
     /**
      * Diffuse mode of ambient light.
      */
@@ -65,6 +58,5 @@ export declare class AmbientLight extends ReferResource {
     constructor(engine: Engine);
     private _setDiffuseMode;
     private _setSpecularTexture;
-    private _setSpecularTextureDecodeRGBM;
     private _preComputeSH;
 }

package/types/mesh/Skin.d.ts

@@ -1,11 +1,10 @@
 import { Matrix } from "@galacean/engine-math";
 import { Entity } from "../Entity";
 import { EngineObject } from "../base/EngineObject";
-import { IComponentCustomClone } from "../clone/ComponentCloner";
 /**
  * Skin used for skinned mesh renderer.
  */
-export declare class Skin extends EngineObject implements IComponentCustomClone {
+export declare class Skin extends EngineObject {
     name: string;
     /** Inverse bind matrices. */
     inverseBindMatrices: Matrix[];

package/types/particle/ParticleGenerator.d.ts

@@ -2,6 +2,7 @@ import { ParticleStopMode } from "./enums/ParticleStopMode";
 import { ColorOverLifetimeModule } from "./modules/ColorOverLifetimeModule";
 import { EmissionModule } from "./modules/EmissionModule";
 import { ForceOverLifetimeModule } from "./modules/ForceOverLifetimeModule";
+import { LimitVelocityOverLifetimeModule } from "./modules/LimitVelocityOverLifetimeModule";
 import { MainModule } from "./modules/MainModule";
 import { RotationOverLifetimeModule } from "./modules/RotationOverLifetimeModule";
 import { SizeOverLifetimeModule } from "./modules/SizeOverLifetimeModule";
@@ -16,11 +17,13 @@ export declare class ParticleGenerator {
     private static _tempVector22;
     private static _tempVector30;
     private static _tempVector31;
+    private static _tempVector32;
     private static _tempMat;
     private static _tempColor0;
     private static _tempParticleRenderers;
     private static readonly _particleIncreaseCount;
     private static readonly _transformedBoundsIncreaseCount;
+    private static readonly _transformFeedbackMacro;
     /** Use auto random seed. */
     useAutoRandomSeed: boolean;
     /** Main module. */
@@ -31,6 +34,8 @@ export declare class ParticleGenerator {
     readonly velocityOverLifetime: VelocityOverLifetimeModule;
     /** Force over lifetime module. */
     readonly forceOverLifetime: ForceOverLifetimeModule;
+    /** Limit velocity over lifetime module. */
+    readonly limitVelocityOverLifetime: LimitVelocityOverLifetimeModule;
     /** Size over lifetime module. */
     readonly sizeOverLifetime: SizeOverLifetimeModule;
     /** Rotation over lifetime module. */
@@ -80,6 +85,8 @@ export declare class ParticleGenerator {
      */
     emit(count: number): void;
     private _addNewParticle;
+    private _addFeedbackParticle;
+    private _clearActiveParticles;
     private _retireActiveParticles;
     private _freeRetiredParticles;
     private _addActiveParticlesToVertexBuffer;

package/types/particle/ParticleTransformFeedbackSimulator.d.ts

@@ -0,0 +1 @@
+export {};

package/types/particle/enums/attributes/ParticleFeedbackVertexAttribute.d.ts

@@ -0,0 +1 @@
+export {};

package/types/particle/index.d.ts

@@ -19,4 +19,5 @@ export { RotationOverLifetimeModule } from "./modules/RotationOverLifetimeModule
 export { SizeOverLifetimeModule } from "./modules/SizeOverLifetimeModule";
 export { TextureSheetAnimationModule } from "./modules/TextureSheetAnimationModule";
 export { VelocityOverLifetimeModule } from "./modules/VelocityOverLifetimeModule";
+export { LimitVelocityOverLifetimeModule } from "./modules/LimitVelocityOverLifetimeModule";
 export * from "./modules/shape/index";