@galacean/engine-core 0.9.0 → 1.0.0-beta.0

package/types/RenderPipeline/index.d.ts

@@ -0,0 +1,4 @@
+export { BasicRenderPipeline } from "./BasicRenderPipeline";
+export { PipelineStage } from "./enums/PipelineStage";
+export { RenderPass } from "./RenderPass";
+export { RenderQueue } from "./RenderQueue";

package/types/Renderer.d.ts

@@ -2,11 +2,11 @@ import { BoundingBox, Matrix, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
 import { RenderContext } from "./RenderPipeline/RenderContext";
 import { TransformModifyFlags } from "./Transform";
-import { Material } from "./material/Material";
 import { ShaderData } from "./shader/ShaderData";
+import { Material } from "./material";
 /**
  * Basis for all renderers.
- * @decorator `@dependentComponents(Transform)`
+ * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
  */
 export declare class Renderer extends Component {
     private static _tempVector0;

package/types/Scene.d.ts

@@ -14,6 +14,8 @@ import { ShadowResolution } from "./shadow/enum/ShadowResolution";
 export declare class Scene extends EngineObject {
     private static _fogColorProperty;
     private static _fogParamsProperty;
+    private static _sunlightColorProperty;
+    private static _sunlightDirectionProperty;
     /** Scene name. */
     name: string;
     /** The background of the 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/asset/AssetType.d.ts

@@ -6,47 +6,47 @@ 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",
     /** 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,9 @@
+import { Engine } from "../Engine";
+import { ReferResource } from "./ReferResource";
+export declare abstract class GraphicsResource extends ReferResource {
+    protected constructor(engine: Engine);
+    /**
+     * @override
+     */
+    protected _onDestroy(): void;
+}

package/types/asset/IReferable.d.ts

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

package/types/asset/{RefObject.d.ts → ReferResource.d.ts}

@@ -1,10 +1,10 @@
 import { EngineObject } from "../base/EngineObject";
 import { Engine } from "../Engine";
-import { IRefObject } from "./IRefObject";
+import { IReferable } from "./IReferable";
 /**
  * The base class of assets, with reference counting capability.
  */
-export declare abstract class RefObject extends EngineObject implements IRefObject {
+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;
@@ -14,14 +14,14 @@ export declare abstract class RefObject extends EngineObject implements IRefObje
     get refCount(): number;
     protected constructor(engine: Engine);
     /**
+     * @override
      * 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;
     /**
-     * Called when the resource is destroyed.
-     * Subclasses can override this function.
+     * @override
      */
-    protected abstract _onDestroy(): void;
+    protected _onDestroy(): void;
 }

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";
@@ -17,14 +17,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 +88,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 +104,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/base/Constant.d.ts

@@ -105,6 +105,7 @@ 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",
+    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,4 +1,3 @@
-import { Event } from "./Event";
 /**
  * EventDispatcher, which can be inherited as a base class.
  */
@@ -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";

package/types/graphic/Buffer.d.ts

@@ -1,4 +1,4 @@
-import { RefObject } from "../asset/RefObject";
+import { GraphicsResource } from "../asset/GraphicsResource";
 import { Engine } from "../Engine";
 import { BufferBindFlag } from "./enums/BufferBindFlag";
 import { BufferUsage } from "./enums/BufferUsage";
@@ -6,14 +6,11 @@ import { SetDataOptions } from "./enums/SetDataOptions";
 /**
  * Buffer.
  */
-export declare class Buffer extends RefObject {
-    _glBindTarget: number;
-    _glBufferUsage: number;
-    _nativeBuffer: WebGLBuffer;
-    private _hardwareRenderer;
+export declare class Buffer extends GraphicsResource {
     private _type;
     private _byteLength;
     private _bufferUsage;
+    private _platformBuffer;
     /**
      * Buffer binding flag.
      */
@@ -95,11 +92,10 @@ export declare class Buffer extends RefObject {
     getData(data: ArrayBufferView, bufferByteOffset: number, dataOffset: number, dataLength: number): void;
     /**
      * @override
-     * Destroy.
      */
-    _onDestroy(): void;
+    _rebuild(): void;
     /**
      * @deprecated
      */
-    resize(dataLength: number): void;
+    resize(byteLength: number): void;
 }

package/types/graphic/Mesh.d.ts

@@ -1,5 +1,5 @@
 import { BoundingBox } from "@galacean/engine-math";
-import { RefObject } from "../asset/RefObject";
+import { GraphicsResource } from "../asset/GraphicsResource";
 import { Engine } from "../Engine";
 import { MeshTopology } from "../graphic/enums/MeshTopology";
 import { IndexBufferBinding } from "../graphic/IndexBufferBinding";
@@ -8,7 +8,7 @@ import { VertexElement } from "../graphic/VertexElement";
 /**
  * Mesh.
  */
-export declare abstract class Mesh extends RefObject {
+export declare abstract class Mesh extends GraphicsResource {
     /** Name. */
     name: string;
     private _bounds;
@@ -58,12 +58,11 @@ export declare abstract class Mesh extends RefObject {
     /**
      * @override
      */
-    _addRefCount(value: number): void;
+    _addReferCount(value: number): void;
     /**
      * @override
-     * Destroy.
      */
-    _onDestroy(): void;
+    _rebuild(): void;
     protected _setVertexElements(elements: VertexElement[]): void;
     protected _setIndexBufferBinding(binding: IndexBufferBinding | null): void;
     private _onBoundsChanged;

package/types/index.d.ts

@@ -8,23 +8,21 @@ export { Entity } from "./Entity";
 export { Component } from "./Component";
 export { Script } from "./Script";
 export { Renderer } from "./Renderer";
-export { dependentComponents } from "./ComponentsDependencies";
+export { dependentComponents, DependentMode } from "./ComponentsDependencies";
 export { Camera } from "./Camera";
 export { Transform } from "./Transform";
 export { BoolUpdateFlag } from "./BoolUpdateFlag";
 export type { EngineSettings } from "./EngineSettings";
+export type { EngineConfiguration } from "./Engine";
 export { request } from "./asset/request";
 export { Loader } from "./asset/Loader";
+export { ContentRestorer } from "./asset/ContentRestorer";
 export { ResourceManager, resourceLoader } from "./asset/ResourceManager";
 export { AssetPromise } from "./asset/AssetPromise";
 export type { LoadItem } from "./asset/LoadItem";
 export { AssetType } from "./asset/AssetType";
-export { RefObject } from "./asset/RefObject";
-export { BasicRenderPipeline } from "./RenderPipeline/BasicRenderPipeline";
-export { RenderQueue } from "./RenderPipeline/RenderQueue";
-export { RenderPass } from "./RenderPipeline/RenderPass";
-export { MeshRenderElement } from "./RenderPipeline/MeshRenderElement";
-export { SpriteElement } from "./RenderPipeline/SpriteElement";
+export { ReferResource } from "./asset/ReferResource";
+export * from "./RenderPipeline";
 export * from "./base";
 export { Background } from "./Background";
 export { BackgroundMode } from "./enums/BackgroundMode";
@@ -51,3 +49,6 @@ export * from "./Layer";
 export * from "./clone/CloneManager";
 export * from "./renderingHardwareInterface/index";
 export * from "./physics/index";
+export * from "./Utils";
+export { Basic2DBatcher } from "./RenderPipeline/Basic2DBatcher";
+export { ShaderMacroCollection } from "./shader/ShaderMacroCollection";

package/types/input/InputManager.d.ts

@@ -6,9 +6,9 @@ import { Vector3 } from "@galacean/engine-math";
  * InputManager manages device input such as mouse, touch, keyboard, etc.
  */
 export declare class InputManager {
+    private _engine;
     /** Sometimes the input module will not be initialized, such as off-screen rendering. */
     private _initialized;
-    private _curFrameCount;
     private _wheelManager;
     private _pointerManager;
     private _keyboardManager;

package/types/input/interface/IInput.d.ts

@@ -2,7 +2,7 @@ export interface IInput {
     /**
      * Handler function updated every frame.
      */
-    _update(frameCount?: number): void;
+    _update(): void;
     /**
      * Function called when the engine is destroyed.
      */

package/types/lighting/DirectLight.d.ts

@@ -8,7 +8,6 @@ export declare class DirectLight extends Light {
     private static _colorProperty;
     private static _directionProperty;
     private static _combinedData;
-    private _forward;
     private _reverseDirection;
     /**
      * Get direction.

package/types/lighting/SpotLight.d.ts

@@ -18,7 +18,6 @@ export declare class SpotLight extends Light {
     angle: number;
     /** Angle, in radians, from falloff begins to ends. */
     penumbra: number;
-    private _forward;
     private _inverseDirection;
     private _projectMatrix;
     /**