@galacean/engine-core 1.0.0 → 1.1.0-alpha.1

package/types/SceneManager.d.ts

@@ -1,20 +1,35 @@
-import { AssetPromise } from "./asset/AssetPromise";
 import { Engine } from "./Engine";
 import { Scene } from "./Scene";
+import { AssetPromise } from "./asset/AssetPromise";
 /**
  * Scene manager.
  */
 export declare class SceneManager {
     readonly engine: Engine;
     /**
-     * Get the activated scene.
+     * Get the scene list.
      */
-    get activeScene(): Scene;
-    set activeScene(scene: Scene);
+    get scenes(): ReadonlyArray<Scene>;
+    /**
+     * Add scene.
+     * @param scene - The scene which want to be added
+     */
+    addScene(scene: Scene): void;
+    /**
+     * Add scene at specified index.
+     * @param index - specified index
+     * @param child - The scene which want to be added
+     */
+    addScene(index: number, scene: Scene): void;
+    /**
+     * Remove scene.
+     * @param scene - The scene which want to be removed
+     */
+    removeScene(scene: Scene): void;
     /**
      * Load and activate scene.
      * @param url - the path of the scene
-     * @param destroyOldScene - whether to destroy old scene information
+     * @param destroyOldScene - whether to destroy old scene
      * @returns scene promise
      */
     loadScene(url: string, destroyOldScene?: boolean): AssetPromise<Scene>;
@@ -25,4 +40,12 @@ export declare class SceneManager {
      * @param destScene - target scene
      */
     mergeScenes(sourceScene: Scene, destScene: Scene): void;
+    /**
+     * @deprecated
+     * Please use `scenes` instead.
+     *
+     * Get the first scene.
+     */
+    get activeScene(): Scene;
+    set activeScene(scene: Scene);
 }

package/types/Script.d.ts

@@ -2,6 +2,7 @@ import { Camera } from "./Camera";
 import { Component } from "./Component";
 import { Pointer } from "./input";
 import { ColliderShape } from "./physics";
+import { Collision } from "./physics/Collision";
 /**
  * Script class, used for logic writing.
  */
@@ -22,12 +23,12 @@ export declare class Script extends Component {
     onStart(): void;
     /**
      * The main loop, called frame by frame.
-     * @param deltaTime - The deltaTime when the script update.
+     * @param deltaTime - The delta time since last frame in seconds
      */
     onUpdate(deltaTime: number): void;
     /**
      * Called after the onUpdate finished, called frame by frame.
-     * @param deltaTime - The deltaTime when the script update.
+     * @param deltaTime - The delta time since last frame in seconds
      */
     onLateUpdate(deltaTime: number): void;
     /**
@@ -45,37 +46,39 @@ export declare class Script extends Component {
      */
     onPhysicsUpdate(): void;
     /**
-     * Called when the collision enter.
+     * Called when the trigger enter.
      * @param other - ColliderShape
      */
     onTriggerEnter(other: ColliderShape): void;
     /**
-     * Called when the collision stay.
-     * @remarks onTriggerStay is called every frame while the collision stay.
+     * Called when the trigger exit.
      * @param other - ColliderShape
      */
     onTriggerExit(other: ColliderShape): void;
     /**
-     * Called when the collision exit.
+     * Called when the trigger stay.
+     * @remarks onTriggerStay is called every frame while the trigger stay.
      * @param other - ColliderShape
      */
     onTriggerStay(other: ColliderShape): void;
     /**
      * Called when the collision enter.
-     * @param other - ColliderShape
+     * @param other - The Collision data associated with this collision event
+     * @remarks The Collision data will be invalid after this call, you should copy the data if needed.
      */
-    onCollisionEnter(other: ColliderShape): void;
+    onCollisionEnter(other: Collision): void;
     /**
-     * Called when the collision stay.
-     * @remarks onTriggerStay is called every frame while the collision stay.
-     * @param other - ColliderShape
+     * Called when the collision exit.
+     * @param other - The Collision data associated with this collision event
+     * @remarks The Collision data will be invalid after this call, you should copy the data if needed.
      */
-    onCollisionExit(other: ColliderShape): void;
+    onCollisionExit(other: Collision): void;
     /**
-     * Called when the collision exit.
-     * @param other - ColliderShape
+     * Called when the collision stay.
+     * @param other - The Collision data associated with this collision event
+     * @remarks The Collision data will be invalid after this call, you should copy the data if needed.
      */
-    onCollisionStay(other: ColliderShape): void;
+    onCollisionStay(other: Collision): void;
     /**
      * Called when the pointer is down while over the ColliderShape.
      * @param pointer - The pointer that triggered

package/types/Transform.d.ts

@@ -24,6 +24,9 @@ export declare class Transform extends Component {
     private _lossyWorldScale;
     private _localMatrix;
     private _worldMatrix;
+    private _worldForward;
+    private _worldRight;
+    private _worldUp;
     private _isParentDirty;
     private _parentTransformCache;
     private _dirtyFlag;
@@ -135,23 +138,17 @@ export declare class Transform extends Component {
      */
     setWorldRotationQuaternion(x: number, y: number, z: number, w: number): void;
     /**
-     * Get the forward direction in world space.
-     * @param forward - Forward vector
-     * @returns Forward vector
+     * The forward direction in world space.
      */
-    getWorldForward(forward: Vector3): Vector3;
+    get worldForward(): Vector3;
     /**
-     * Get the right direction in world space.
-     * @param right - Right vector
-     * @returns Right vector
+     * The right direction in world space.
      */
-    getWorldRight(right: Vector3): Vector3;
+    get worldRight(): Vector3;
     /**
-     * Get the up direction in world space.
-     * @param up - Up vector
-     * @returns Up vector
+     * The up direction in world space.
      */
-    getWorldUp(up: Vector3): Vector3;
+    get worldUp(): Vector3;
     /**
      * Translate in the direction and distance of the translation.
      * @param translation - Direction and distance of translation

package/types/Utils.d.ts

@@ -1,3 +1,31 @@
 export declare class Utils {
+    /**
+     * Fast remove an element from array.
+     * @param array - Array
+     * @param item - Element
+     */
+    static removeFromArray(array: any[], item: any): boolean;
+    /**
+     * Decodes a given Uint8Array into a string.
+     */
+    static decodeText(array: Uint8Array): string;
+    /**
+     * Judge whether the url is absolute url.
+     * @param url - The url to be judged.
+     * @returns Whether the url is absolute url.
+     */
+    static isAbsoluteUrl(url: string): boolean;
+    /**
+     * Get the values of an object.
+     */
+    static objectValues(obj: any): any[];
+    /**
+     * Convert a relative URL to an absolute URL based on a given base URL.
+     * @param baseUrl - The base url.
+     * @param relativeUrl - The relative url.
+     * @returns The resolved url.
+     */
+    static resolveAbsoluteUrl(baseUrl: string, relativeUrl: string): string;
     private static _stringToPath;
+    private static _formatRelativePath;
 }

package/types/animation/AnimationClip.d.ts

@@ -1,3 +1,4 @@
+import { EngineObject } from "../base/EngineObject";
 import { Component } from "../Component";
 import { Entity } from "../Entity";
 import { AnimationClipCurveBinding } from "./AnimationClipCurveBinding";
@@ -7,7 +8,7 @@ import { KeyframeValueType } from "./Keyframe";
 /**
  * Stores keyframe based animations.
  */
-export declare class AnimationClip {
+export declare class AnimationClip extends EngineObject {
     readonly name: string;
     private _length;
     private _events;

package/types/animation/Animator.d.ts

@@ -13,9 +13,9 @@ export declare class Animator extends Component {
     speed: number;
     protected _animatorController: AnimatorController;
     protected _controllerUpdateFlag: BoolUpdateFlag;
+    protected _updateMark: number;
     private _animatorLayersData;
-    private _crossOwnerCollection;
-    private _animationCurveOwners;
+    private _curveOwnerPool;
     private _animationEventHandlerPool;
     private _tempAnimatorStateInfo;
     private _controlledRenderers;
@@ -56,12 +56,11 @@ export declare class Animator extends Component {
      */
     findAnimatorState(stateName: string, layerIndex?: number): AnimatorState;
     private _getAnimatorStateInfo;
-    private _saveDefaultValues;
     private _getAnimatorStateData;
     private _saveAnimatorStateData;
     private _saveAnimatorEventHandlers;
     private _clearCrossData;
-    private _addCrossCurveData;
+    private _addCrossOwner;
     private _prepareCrossFading;
     private _prepareStandbyCrossFading;
     private _prepareFixedPoseCrossFading;
@@ -72,6 +71,7 @@ export declare class Animator extends Component {
     private _updatePlayingState;
     private _updateCrossFade;
     private _updateCrossFadeFromPose;
+    private _updateFinishedState;
     private _updateCrossFadeData;
     private _preparePlay;
     private _checkTransition;
@@ -83,4 +83,5 @@ export declare class Animator extends Component {
     private _callAnimatorScriptOnUpdate;
     private _callAnimatorScriptOnExit;
     private _checkAutoPlay;
+    private _checkRevertOwner;
 }

package/types/animation/animationCurve/AnimationFloatArrayCurve.d.ts

@@ -6,7 +6,6 @@ import { AnimationCurve } from "./AnimationCurve";
 export declare class AnimationFloatArrayCurve extends AnimationCurve<Float32Array> {
     /**
      * @inheritdoc
-     * @override
      */
     addKey(key: Keyframe<Float32Array>): void;
 }

package/types/animation/enums/LayerState.d.ts

@@ -9,5 +9,7 @@ export declare enum LayerState {
     /** CrossFading state. */
     CrossFading = 2,
     /** FixedCrossFading state. */
-    FixedCrossFading = 3
+    FixedCrossFading = 3,
+    /** Finished state. */
+    Finished = 4
 }

package/types/animation/internal/AnimationCurveLayerOwner.d.ts

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

package/types/asset/AssetType.d.ts

@@ -6,47 +6,49 @@ export declare enum AssetType {
      * Plain text.
      * @remarks Will not be cached based on url in ResourceManager.
      */
-    Text = "text",
+    Text = "Text",
     /**
      * JSON.
      * @remarks Will not be cached based on url in ResourceManager.
      */
-    JSON = "json",
+    JSON = "JSON",
     /**
      * ArrayBuffer.
      * @remarks Will not be cached based on url in ResourceManager.
      */
-    Buffer = "buffer",
+    Buffer = "Buffer",
     /** 2D Texture. */
-    Texture2D = "texture2d",
+    Texture2D = "Texture2D",
     /** Cube Texture. */
-    TextureCube = "texture-cube",
+    TextureCube = "TextureCube",
     /** Material. */
-    Material = "material",
+    Material = "Material",
     /** Mesh. */
-    Mesh = "mesh",
+    Mesh = "Mesh",
     /** AnimationClip. */
     AnimationClip = "AnimationClip",
     /** AnimatorController. */
     AnimatorController = "AnimatorController",
     /** Prefab.*/
-    Prefab = "prefab",
+    GLTF = "GLTF",
     /** Compress Texture. */
-    KTX = "ktx",
+    KTX = "KTX",
     /** Cube Compress Texture. */
-    KTXCube = "ktx-cube",
+    KTXCube = "KTXCube",
+    /** KTX2 Compress Texture */
+    KTX2 = "KTX2",
     /** Sprite. */
-    Sprite = "sprite",
+    Sprite = "Sprite",
     /** Sprite Atlas. */
-    SpriteAtlas = "sprite-atlas",
+    SpriteAtlas = "SpriteAtlas",
     /** Ambient light. */
-    Env = "environment",
+    Env = "Environment",
     /** Scene. */
-    Scene = "scene",
+    Scene = "Scene",
     /** HDR to cube. */
     HDR = "HDR",
     /** Font. */
-    Font = "font",
+    Font = "Font",
     /** Source Font, include ttf、 otf and woff. */
-    SourceFont = "source-font"
+    SourceFont = "SourceFont"
 }

package/types/asset/ContentRestorer.d.ts

@@ -0,0 +1,17 @@
+import { EngineObject } from "../base";
+import { AssetPromise } from "./AssetPromise";
+/**
+ * ContentRestorer is a base class for all content restore info classes.
+ */
+export declare abstract class ContentRestorer<T extends EngineObject> {
+    resource: T;
+    /**
+     * @param resource - The resource object of the content restorer
+     */
+    constructor(resource: T);
+    /**
+     * Restore the content of the resource.
+     * @returns The promise of the restored content if the content is restored asynchronously, otherwise returns undefined
+     */
+    abstract restoreContent(): AssetPromise<T> | void;
+}

package/types/asset/GraphicsResource.d.ts

@@ -0,0 +1,5 @@
+import { Engine } from "../Engine";
+import { ReferResource } from "./ReferResource";
+export declare abstract class GraphicsResource extends ReferResource {
+    protected constructor(engine: Engine);
+}

package/types/asset/IReferable.d.ts

@@ -0,0 +1,2 @@
+export interface IReferable {
+}

package/types/asset/LoadItem.d.ts

@@ -1,15 +1,12 @@
+type PickOnlyOne<T extends {}, Keys extends keyof T = keyof T> = Keys extends unknown ? {
+    [K in Keys]: T[Keys];
+} & {
+    [K in Exclude<keyof T, Keys>]?: never;
+} : never;
 /**
  * Used to describe loading asset.
  */
 export type LoadItem = {
-    /**
-     * Loading url.
-     */
-    url?: string;
-    /**
-     * Available when AssetType is TextureCube.
-     */
-    urls?: string[];
     /**
      * Asset Type.
      */
@@ -30,4 +27,14 @@ export type LoadItem = {
      * Additional parameters for specified loader.
      */
     params?: Record<string, any>;
-};
+} & PickOnlyOne<{
+    /**
+     * Loading url.
+     */
+    url: string;
+    /**
+     * Available when AssetType is TextureCube.
+     */
+    urls: string[];
+}>;
+export {};

package/types/asset/Loader.d.ts

@@ -1,3 +1,4 @@
+import { Engine, EngineConfiguration } from "../Engine";
 import { AssetPromise } from "./AssetPromise";
 import { LoadItem } from "./LoadItem";
 import { RequestConfig } from "./request";
@@ -25,6 +26,7 @@ export declare abstract class Loader<T> {
     };
     private static _engineObjects;
     constructor(useCache: boolean);
-    request: <U>(url: string, config: RequestConfig) => AssetPromise<U>;
+    initialize?(engine: Engine, configuration: EngineConfiguration): Promise<void>;
     abstract load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<T> | Record<string, AssetPromise<any>>;
+    request: <U>(url: string, config: RequestConfig) => AssetPromise<U>;
 }

package/types/asset/ReferResource.d.ts

@@ -0,0 +1,22 @@
+import { EngineObject } from "../base/EngineObject";
+import { Engine } from "../Engine";
+import { IReferable } from "./IReferable";
+/**
+ * The base class of assets, with reference counting capability.
+ */
+export declare abstract class ReferResource extends EngineObject implements IReferable {
+    /** Whether to ignore the garbage collection check, if it is true, it will not be affected by ResourceManager.gc(). */
+    isGCIgnored: boolean;
+    private _refCount;
+    /**
+     * Counted by valid references.
+     */
+    get refCount(): number;
+    protected constructor(engine: Engine);
+    /**
+     * Destroy self.
+     * @param force - Whether to force the destruction, if it is false, refCount = 0 can be released successfully.
+     * @returns Whether the release was successful.
+     */
+    destroy(force?: boolean): boolean;
+}

package/types/asset/ResourceManager.d.ts

@@ -1,4 +1,4 @@
-import { Engine } from "..";
+import { ContentRestorer, Engine, EngineObject } from "..";
 import { AssetPromise } from "./AssetPromise";
 import { Loader } from "./Loader";
 import { LoadItem } from "./LoadItem";
@@ -7,8 +7,6 @@ import { LoadItem } from "./LoadItem";
  */
 export declare class ResourceManager {
     readonly engine: Engine;
-    /** Loader collection. */
-    private static _loaders;
     private static _extTypeMapping;
     private static _getTypeByUrl;
     /** The number of retries after failing to load assets. */
@@ -17,14 +15,17 @@ export declare class ResourceManager {
     retryInterval: number;
     /** The default timeout period for loading assets, in milliseconds. */
     timeout: number;
-    /** Asset path pool, key is asset ID, value is asset path */
+    private _loadingPromises;
+    /** Asset path pool, key is the `instanceID` of resource, value is asset path. */
     private _assetPool;
-    /** Asset pool, the key is the asset path and the value is the asset. */
+    /** Asset url pool, key is the asset path and the value is the asset. */
     private _assetUrlPool;
-    /** Reference counted object pool, key is the object ID, and reference counted objects are put into this pool. */
-    private _refObjectPool;
-    /** Loading promises. */
-    private _loadingPromises;
+    /** Referable resource pool, key is the `instanceID` of resource. */
+    private _referResourcePool;
+    /** Graphic resource pool, key is the `instanceID` of resource. */
+    private _graphicResourcePool;
+    /** Restorable resource information pool, key is the `instanceID` of resource. */
+    private _contentRestorerPool;
     /**
      * Create a ResourceManager.
      * @param engine - Engine to which the current ResourceManager belongs
@@ -85,6 +86,11 @@ export declare class ResourceManager {
      * @remarks The release principle is that it is not referenced by the components, including direct and indirect reference.
      */
     gc(): void;
+    /**
+     * Add content restorer.
+     * @param restorer - The restorer
+     */
+    addContentRestorer<T extends EngineObject>(restorer: ContentRestorer<T>): void;
     private _assignDefaultOptions;
     private _loadSingleItem;
     private _gc;
@@ -96,6 +102,6 @@ export declare class ResourceManager {
 /**
  * Declare ResourceLoader's decorator.
  * @param assetType - Type of asset
- * @param extnames - Name of file extension
+ * @param extNames - Name of file extension
  */
-export declare function resourceLoader(assetType: string, extnames: string[], useCache?: boolean): <T extends Loader<any>>(Target: new (useCache: boolean) => T) => void;
+export declare function resourceLoader(assetType: string, extNames: string[], useCache?: boolean): <T extends Loader<any>>(Target: new (useCache: boolean) => T) => void;

package/types/asset/request.d.ts

@@ -17,9 +17,13 @@ export declare class MultiExecutor {
     private interval;
     private _timeoutId;
     private _currentCount;
+    private _onComplete;
+    private _onError;
+    private _error;
     constructor(execFunc: (count?: number) => Promise<any>, totalCount: number, interval: number);
-    private done;
-    start(done?: Function): void;
-    stop(): void;
+    start(): this;
+    onComplete(func: Function): this;
+    onError(func: Function): this;
+    cancel(): void;
     private exec;
 }

package/types/base/Constant.d.ts

@@ -105,6 +105,8 @@ export declare enum GLCapabilityType {
     pvrtc = "WEBGL_compressed_texture_pvrtc",
     pvrtc_webkit = "WEBKIT_WEBGL_compressed_texture_pvrtc",
     s3tc = "WEBGL_compressed_texture_s3tc",
-    s3tc_webkit = "WEBKIT_WEBGL_compressed_texture_s3tc"
+    s3tc_webkit = "WEBKIT_WEBGL_compressed_texture_s3tc",
+    bptc = "EXT_texture_compression_bptc",
+    WEBGL_lose_context = "WEBGL_lose_context"
 }
 export type TypedArray = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array;

package/types/base/EngineObject.d.ts

@@ -21,4 +21,5 @@ export declare abstract class EngineObject {
      * Destroy self.
      */
     destroy(): void;
+    protected _onDestroy(): void;
 }

package/types/base/EventDispatcher.d.ts

@@ -1,11 +1,10 @@
-import { Event } from "./Event";
 /**
  * EventDispatcher, which can be inherited as a base class.
  */
 export declare class EventDispatcher {
+    private static _dispatchingListenersPool;
     private _events;
     private _eventCount;
-    private _dispatchingListeners;
     /**
      * Determine whether there is event listening.
      * @param event - Event name
@@ -44,15 +43,6 @@ export declare class EventDispatcher {
      * @returns This
      */
     once(event: string, fn: Function): EventDispatcher;
-    /**
-     * @deprecated Use `on/once` instead.
-     * Add a listener function with the specified event name.
-     * @param event - Event name
-     * @param fn - Function
-     * @param once - Is it a one-time listener
-     * @returns this
-     */
-    addEventListener(event: string, fn: Function, once?: boolean): EventDispatcher;
     /**
      * Remove the event listener(s) of the specified event name.
      * @param event - Event name
@@ -71,9 +61,6 @@ export declare class EventDispatcher {
      * @param event - Event name, delete all events if not passed
      */
     removeAllEventListeners(event?: string): void;
-    /**
-     * @deprecated Use `dispatch` instead.
-     */
-    trigger(e: Event): void;
+    private _addEventListener;
     private _clearEvent;
 }

package/types/base/Time.d.ts

@@ -1,41 +1,44 @@
 /**
- * Tools for calculating the time per frame.
+ * Provide time related information.
  */
 export declare class Time {
-    private _clock;
-    private _timeScale;
+    private static _elapsedTimeProperty;
+    private static _deltaTimeProperty;
+    private _frameCount;
     private _deltaTime;
-    private _startTime;
-    private _lastTickTime;
+    private _actualDeltaTime;
+    private _elapsedTime;
+    private _actualElapsedTime;
+    private _lastSystemTime;
+    private _elapsedTimeValue;
+    private _deltaTimeValue;
+    /** Maximum delta time allowed per frame in seconds. */
+    maximumDeltaTime: number;
+    /** The scale of time. */
+    timeScale: number;
     get frameCount(): number;
     /**
-     * Constructor of the Time.
-     */
-    constructor();
-    reset(): void;
-    /**
-     * Current Time
-     */
-    get nowTime(): number;
-    /**
-     * Time between two ticks
+     * The delta time in seconds from the last frame to the current frame.
+     *
+     * @remarks When the frame rate is low or stutter occurs, `deltaTime` will not exceed the value of `maximumDeltaTime` * `timeScale`.
      */
     get deltaTime(): number;
     /**
-     * Scaled delta time.
+     * The amount of elapsed time in seconds since the start of the engine.
      */
-    get timeScale(): number;
-    set timeScale(s: number);
+    get elapsedTime(): number;
     /**
-     * Unscaled delta time.
+     * The actual delta time in seconds from the last frame to the current frame.
+     *
+     * @remarks The actual delta time is not affected by `maximumDeltaTime` and `timeScale`.
      */
-    get unscaledDeltaTime(): number;
+    get actualDeltaTime(): number;
     /**
-     * The elapsed time, after the clock is initialized.
+     * The amount of actual elapsed time in seconds since the start of the engine.
      */
-    get timeSinceStartup(): number;
+    get actualElapsedTime(): number;
     /**
-     * Call every frame, update delta time and other data.
+     * Constructor of the Time.
      */
-    tick(): void;
+    constructor();
 }

package/types/base/index.d.ts

@@ -1,7 +1,5 @@
-export { Event } from "./Event";
 export { EventDispatcher } from "./EventDispatcher";
 export { Logger } from "./Logger";
 export { Time } from "./Time";
-export { Util, ObjectValues } from "./Util";
 export { EngineObject } from "./EngineObject";
 export * from "./Constant";