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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-core",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.5",
   "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.5"
   },
   "devDependencies": {
-    "@galacean/engine-design": "2.0.0-alpha.2"
+    "@galacean/engine-design": "2.0.0-alpha.5"
   },
   "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/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",

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

@@ -20,11 +20,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";

package/types/physics/DynamicCollider.d.ts

@@ -124,19 +124,25 @@ export declare class DynamicCollider extends Collider {
      */
     applyTorque(torque: Vector3): void;
     /**
-     * Moves kinematically controlled dynamic actors through the game world.
-     * @param position - The desired position for the kinematic actor
+     * Moves the kinematic collider to the specified position.
+     * @remarks Only available when {@link isKinematic} is true.
+     * Unlike setting the transform directly (teleport), this method affects dynamic colliders along the movement path.
+     * @param position - The desired position for the kinematic collider
      */
     move(position: Vector3): void;
     /**
-     * Moves kinematically controlled dynamic actors through the game world.
-     * @param rotation - The desired rotation for the kinematic actor
+     * Moves the kinematic collider to the specified rotation.
+     * @remarks Only available when {@link isKinematic} is true.
+     * Unlike setting the transform directly (teleport), this method affects dynamic colliders along the movement path.
+     * @param rotation - The desired rotation for the kinematic collider
      */
     move(rotation: Quaternion): void;
     /**
-     * Moves kinematically controlled dynamic actors through the game world.
-     * @param position - The desired position for the kinematic actor
-     * @param rotation - The desired rotation for the kinematic actor
+     * Moves the kinematic collider to the specified position and rotation.
+     * @remarks Only available when {@link isKinematic} is true.
+     * Unlike setting the transform directly (teleport), this method affects dynamic colliders along the movement path.
+     * @param position - The desired position for the kinematic collider
+     * @param rotation - The desired rotation for the kinematic collider
      */
     move(position: Vector3, rotation: Quaternion): void;
     /**

package/types/physics/enums/MeshColliderShapeCookingFlag.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Cooking flags for {@link MeshColliderShape}.
+ */
+export declare enum MeshColliderShapeCookingFlag {
+    /** Remove degenerate triangles and coincident vertices. */
+    Cleaning = 1,
+    /** Weld vertices that are close to each other. Requires {@link MeshColliderShapeCookingFlag.Cleaning} to be enabled. */
+    VertexWelding = 2
+}

package/types/physics/enums/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./MeshColliderShapeCookingFlag";
 export * from "./PhysicsMaterialCombineMode";
 export * from "./ColliderShapeUpAxis";
 export * from "./ControllerCollisionFlag";

package/types/physics/shape/MeshColliderShape.d.ts

@@ -1,59 +1,45 @@
-import { Mesh } from "../../graphic/Mesh";
+import { ModelMesh } from "../../mesh/ModelMesh";
+import { Vector3 } from "@galacean/engine-math";
+import { MeshColliderShapeCookingFlag } from "../enums/MeshColliderShapeCookingFlag";
 import { ColliderShape } from "./ColliderShape";
 /**
- * Physical collider shape for mesh.
- * @remarks
- * - Triangle mesh (isConvex=false) works with StaticCollider or kinematic DynamicCollider
- * - Convex mesh (isConvex=true) works with both StaticCollider and DynamicCollider
- * @see https://nvidia-omniverse.github.io/PhysX/physx/5.4.1/docs/Geometry.html#triangle-meshes
+ * Collider shape based on mesh geometry, supporting both convex hull and triangle mesh modes.
  */
 export declare class MeshColliderShape extends ColliderShape {
+    private _mesh;
     private _isConvex;
-    private _vertices;
+    private _positions;
     private _indices;
-    private _doubleSided;
-    private _tightBounds;
-    private _indicesU16Cache;
+    private _cookingFlags;
+    private _isShapeAttached;
+    /**
+     * Cooking flags for this mesh collider shape.
+     */
+    get cookingFlags(): MeshColliderShapeCookingFlag;
+    set cookingFlags(value: MeshColliderShapeCookingFlag);
     /**
      * Whether to use convex mesh mode.
      * @remarks
-     * - Convex mesh: Works with all collider types, PhysX auto-computes convex hull
-     * - Triangle mesh: Works with StaticCollider or kinematic DynamicCollider, requires indices
-     * - After changing this property, you must call {@link setMesh} or {@link setMeshData} again to apply the change
+     * - When true, generates a convex hull from the mesh vertices. Works with all collider types.
+     * - When false, uses the original triangle mesh. Only works with StaticCollider or kinematic DynamicCollider, and the mesh must have indices.
      */
     get isConvex(): boolean;
     set isConvex(value: boolean);
     /**
-     * Whether the triangle mesh should be double-sided for collision detection.
-     * @remarks Only applies to triangle mesh (non-convex).
-     */
-    get doubleSided(): boolean;
-    set doubleSided(value: boolean);
-    /**
-     * Whether to use tight bounds for convex mesh.
-     * @remarks Only applies to convex mesh.
-     */
-    get tightBounds(): boolean;
-    set tightBounds(value: boolean);
-    /**
-     * Create a MeshColliderShape.
-     * @param isConvex - Whether to use convex mesh mode (default: false)
-     */
-    constructor(isConvex?: boolean);
-    /**
-     * Set mesh data directly from arrays.
-     * @param vertices - Vertex positions as Float32Array (x, y, z per vertex)
-     * @param indices - Triangle indices (required for triangle mesh, optional for convex)
+     * The mesh used for collision detection.
+     * @remarks The mesh must have accessible data (not released after upload).
      */
-    setMeshData(vertices: Float32Array, indices?: Uint16Array | Uint32Array): void;
+    get mesh(): ModelMesh;
+    set mesh(value: ModelMesh);
     /**
-     * Set mesh data from a Mesh object.
-     * @param mesh - The mesh to extract vertex and index data from
-     * @remarks The mesh must have accessible data (not released after upload)
+     * {@inheritDoc ColliderShape.getClosestPoint}
      */
-    setMesh(mesh: Mesh): void;
-    protected _syncNative(): void;
+    getClosestPoint(point: Vector3, outClosestPoint: Vector3): number;
+    private _clearMeshData;
+    private _destroyNativeShape;
     private _extractMeshData;
-    private _extractIndices;
-    private _updateNativeMesh;
+    private _updateNativeShapeData;
+    private _detachFromCollider;
+    private _attachToCollider;
+    private _createNativeShape;
 }

package/types/texture/RenderTarget.d.ts

@@ -12,6 +12,7 @@ export declare class RenderTarget extends GraphicsResource {
     private _height;
     private _colorTextures;
     private _depthTexture;
+    private _memorySize;
     /**
      * Whether to automatically generate multi-level textures.
      */

package/types/trail/TrailRenderer.d.ts

@@ -1,4 +1,4 @@
-import { BoundingBox } from "@galacean/engine-math";
+import { BoundingBox, Vector2 } from "@galacean/engine-math";
 import { RenderContext } from "../RenderPipeline/RenderContext";
 import { Renderer } from "../Renderer";
 import { ParticleCurve } from "../particle/modules/ParticleCurve";
@@ -31,6 +31,7 @@ export declare class TrailRenderer extends Renderer {
     /** The gradient describing the trail color from start to end. */
     colorGradient: ParticleGradient;
     private _trailParams;
+    private _textureScale;
     private _distanceParams;
     private _curveMaxTime;
     private _time;
@@ -55,21 +56,17 @@ export declare class TrailRenderer extends Renderer {
      */
     get time(): number;
     set time(value: number);
-    /**
-     * The width of the trail.
-     */
-    get width(): number;
-    set width(value: number);
     /**
      * The texture mapping mode for the trail.
      */
     get textureMode(): TrailTextureMode;
     set textureMode(value: TrailTextureMode);
     /**
-     * The texture scale when using Tile texture mode.
+     * Scale of the UV coordinates.
+     * x scales the coordinate along the trail, y scales the coordinate across the trail.
      */
-    get textureScale(): number;
-    set textureScale(value: number);
+    get textureScale(): Vector2;
+    set textureScale(value: Vector2);
     /**
      * Clear all trail points.
      */
@@ -89,4 +86,5 @@ export declare class TrailRenderer extends Renderer {
     private _getActivePointCount;
     private _addActivePointsToVertexBuffer;
     private _addSubRenderElement;
+    private _onTextureScaleChanged;
 }