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

package/types/asset/IReferable.d.ts

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

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";
@@ -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/enums/ActiveChangeFlag.d.ts

@@ -0,0 +1,6 @@
+export declare enum ActiveChangeFlag {
+    None = 0,
+    Scene = 1,
+    Hierarchy = 2,
+    All = 3
+}

package/types/env-probe/CubeProbe.d.ts

@@ -9,15 +9,8 @@ export declare class CubeProbe extends Probe {
      * The position of the probe can be set, the default is the origin [0,0,0].
      */
     position: Vector3;
-    /**
-     * @override
-     */
-    protected readonly _isCube: boolean;
     private oriViewMatrix;
     private _oriFieldOfView;
-    /**
-     * @override
-     */
     onBeginRender(camera: Camera): void;
     /**
      * Store original camera parameters.

package/types/env-probe/Probe.d.ts

@@ -46,13 +46,7 @@ export declare abstract class Probe extends Script {
      * @remarks Prevent issue: Feedback Loops Between Textures and the Framebuffer.
      */
     onTextureChange(renderColorTexture: Texture): void;
-    /**
-     * @override
-     */
     onBeginRender(camera: Camera): void;
-    /**
-     * @override
-     */
     onEndRender(camera: Camera): void;
     protected _reset(): void;
 }

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.
      */
@@ -93,13 +90,9 @@ export declare class Buffer extends RefObject {
      * @param dataLength - Output data length
      */
     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,14 +1,12 @@
 import { BoundingBox } from "@galacean/engine-math";
-import { RefObject } from "../asset/RefObject";
 import { Engine } from "../Engine";
-import { MeshTopology } from "../graphic/enums/MeshTopology";
-import { IndexBufferBinding } from "../graphic/IndexBufferBinding";
+import { GraphicsResource } from "../asset/GraphicsResource";
 import { SubMesh } from "../graphic/SubMesh";
-import { VertexElement } from "../graphic/VertexElement";
+import { MeshTopology } from "../graphic/enums/MeshTopology";
 /**
  * Mesh.
  */
-export declare abstract class Mesh extends RefObject {
+export declare abstract class Mesh extends GraphicsResource {
     /** Name. */
     name: string;
     private _bounds;
@@ -55,16 +53,7 @@ export declare abstract class Mesh extends RefObject {
      * Clear all sub-mesh.
      */
     clearSubMesh(): void;
-    /**
-     * @override
-     */
-    _addRefCount(value: number): void;
-    /**
-     * @override
-     * Destroy.
-     */
-    _onDestroy(): void;
-    protected _setVertexElements(elements: VertexElement[]): void;
-    protected _setIndexBufferBinding(binding: IndexBufferBinding | null): void;
+    _addReferCount(value: number): void;
+    _rebuild(): 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/Index";
 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

@@ -1,14 +1,14 @@
+import { Vector3 } from "@galacean/engine-math";
 import { Keys } from "./enums/Keys";
-import { Pointer } from "./pointer/Pointer";
 import { PointerButton } from "./enums/PointerButton";
-import { Vector3 } from "@galacean/engine-math";
+import { Pointer } from "./pointer/Pointer";
 /**
  * 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/Light.d.ts

@@ -44,5 +44,4 @@ export declare abstract class Light extends Component {
      * Inverse view matrix.
      */
     get inverseViewMatrix(): Matrix;
-    protected _getLightColor(): Color;
 }

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;
     /**

package/types/material/BaseMaterial.d.ts

@@ -1,21 +1,21 @@
 import { Engine } from "../Engine";
-import { Shader } from "../shader";
+import { Shader, ShaderProperty } from "../shader";
 import { ShaderMacro } from "../shader/ShaderMacro";
 import { BlendMode } from "./enums/BlendMode";
 import { RenderFace } from "./enums/RenderFace";
 import { Material } from "./Material";
 export declare class BaseMaterial extends Material {
-    protected static _baseColorProp: import("../shader").ShaderProperty;
-    protected static _baseTextureProp: import("../shader").ShaderProperty;
     protected static _baseTextureMacro: ShaderMacro;
-    protected static _tilingOffsetProp: import("../shader").ShaderProperty;
-    protected static _normalTextureProp: import("../shader").ShaderProperty;
-    protected static _normalIntensityProp: import("../shader").ShaderProperty;
     protected static _normalTextureMacro: ShaderMacro;
-    protected static _emissiveColorProp: import("../shader").ShaderProperty;
-    protected static _emissiveTextureProp: import("../shader").ShaderProperty;
     protected static _emissiveTextureMacro: ShaderMacro;
     protected static _transparentMacro: ShaderMacro;
+    protected static _baseColorProp: ShaderProperty;
+    protected static _baseTextureProp: ShaderProperty;
+    protected static _tilingOffsetProp: ShaderProperty;
+    protected static _normalTextureProp: ShaderProperty;
+    protected static _normalIntensityProp: ShaderProperty;
+    protected static _emissiveColorProp: ShaderProperty;
+    protected static _emissiveTextureProp: ShaderProperty;
     private static _alphaCutoffProp;
     private static _alphaCutoffMacro;
     private _renderFace;
@@ -75,12 +75,10 @@ export declare class BaseMaterial extends Material {
      */
     setRenderFace(passIndex: number, renderFace: RenderFace): void;
     /**
-     * @override
      * Clone and return the instance.
      */
     clone(): BaseMaterial;
     /**
-     * @override
      * Clone to the target material.
      * @param target - target material
      */

package/types/material/BlinnPhongMaterial.d.ts

@@ -64,8 +64,5 @@ export declare class BlinnPhongMaterial extends BaseMaterial {
      * @param engine - Engine to which the material belongs
      */
     constructor(engine: Engine);
-    /**
-     * @override
-     */
     clone(): BlinnPhongMaterial;
 }

package/types/material/Material.d.ts

@@ -1,13 +1,13 @@
 import { IClone } from "@galacean/engine-design";
-import { RefObject } from "../asset/RefObject";
 import { Engine } from "../Engine";
+import { ReferResource } from "../asset/ReferResource";
 import { Shader } from "../shader/Shader";
 import { ShaderData } from "../shader/ShaderData";
 import { RenderState } from "../shader/state/RenderState";
 /**
  * Material.
  */
-export declare class Material extends RefObject implements IClone {
+export declare class Material extends ReferResource implements IClone {
     /** Name. */
     name: string;
     /** Shader data. */
@@ -40,12 +40,5 @@ export declare class Material extends RefObject implements IClone {
      * @param target - target material
      */
     cloneTo(target: Material): void;
-    /**
-     * @override
-     */
-    _addRefCount(value: number): void;
-    /**
-     * @override
-     */
-    protected _onDestroy(): void;
+    _addReferCount(value: number): void;
 }

package/types/material/PBRMaterial.d.ts

@@ -8,13 +8,22 @@ export declare class PBRMaterial extends PBRBaseMaterial {
     private static _metallicProp;
     private static _roughnessProp;
     private static _roughnessMetallicTextureProp;
+    private static _iorProp;
     /**
-     * Metallic, default 1.0.
+     * Index Of Refraction.
+     * @defaultValue `1.5`
+     */
+    get ior(): number;
+    set ior(v: number);
+    /**
+     * Metallic.
+     * @defaultValue `1.0`
      */
     get metallic(): number;
     set metallic(value: number);
     /**
-     * Roughness, default 1.0.
+     * Roughness. default 1.0.
+     * @defaultValue `1.0`
      */
     get roughness(): number;
     set roughness(value: number);
@@ -30,7 +39,7 @@ export declare class PBRMaterial extends PBRBaseMaterial {
      */
     constructor(engine: Engine);
     /**
-     * @override
+     * @inheritdoc
      */
     clone(): PBRMaterial;
 }

package/types/material/PBRSpecularMaterial.d.ts

@@ -32,7 +32,7 @@ export declare class PBRSpecularMaterial extends PBRBaseMaterial {
      */
     constructor(engine: Engine);
     /**
-     * @override
+     * @inheritdoc
      */
     clone(): PBRSpecularMaterial;
 }

package/types/material/UnlitMaterial.d.ts

@@ -27,7 +27,7 @@ export declare class UnlitMaterial extends BaseMaterial {
      */
     constructor(engine: Engine);
     /**
-     * @override
+     * @inheritdoc
      */
     clone(): UnlitMaterial;
 }

package/types/mesh/BlendShape.d.ts

@@ -6,7 +6,6 @@ import { BlendShapeFrame } from "./BlendShapeFrame";
 export declare class BlendShape {
     /** Name of BlendShape. */
     name: string;
-    private _dataChangeManager;
     private _frames;
     /**
      * Frames of BlendShape.
@@ -36,4 +35,5 @@ export declare class BlendShape {
     clearFrames(): void;
     private _addFrame;
     private _updateUseNormalAndTangent;
+    private _frameDataChangeListener;
 }

package/types/mesh/BlendShapeFrame.d.ts

@@ -5,12 +5,28 @@ import { Vector3 } from "@galacean/engine-math";
 export declare class BlendShapeFrame {
     /** Weight of BlendShapeFrame. */
     readonly weight: number;
-    /** Delta positions for the frame being added. */
-    readonly deltaPositions: Readonly<Readonly<Vector3>[]>;
-    /** Delta normals for the frame being added. */
-    readonly deltaNormals: Readonly<Readonly<Vector3[]> | null>;
-    /** Delta tangents for the frame being added. */
-    readonly deltaTangents: Readonly<Readonly<Vector3[]> | null>;
+    private _dirty;
+    private _deltaPositions;
+    private _deltaNormals;
+    private _deltaTangents;
+    /**
+     * Delta positions for the frame being added.
+     * @remarks Need to re-assign after modification to ensure that the modification takes effect.
+     */
+    get deltaPositions(): Vector3[];
+    set deltaPositions(value: Vector3[]);
+    /**
+     * Delta normals for the frame being added.
+     * @remarks Need to re-assign after modification to ensure that the modification takes effect.
+     */
+    get deltaNormals(): Vector3[];
+    set deltaNormals(value: Vector3[]);
+    /**
+     * Delta tangents for the frame being added.
+     * @remarks Need to re-assign after modification to ensure that the modification takes effect.
+     */
+    get deltaTangents(): Vector3[];
+    set deltaTangents(value: Vector3[]);
     /**
      * Create a BlendShapeFrame.
      * @param weight - Weight of BlendShapeFrame
@@ -20,3 +36,9 @@ export declare class BlendShapeFrame {
      */
     constructor(weight: number, deltaPositions: Vector3[], deltaNormals?: Vector3[], deltaTangents?: Vector3[]);
 }
+export declare enum BlendShapeFrameDirty {
+    Position = 1,
+    Normal = 2,
+    Tangent = 4,
+    All = 7
+}

package/types/mesh/MeshRenderer.d.ts

@@ -1,30 +1,25 @@
-import { BoundingBox } from "@galacean/engine-math";
-import { ICustomClone } from "../clone/ComponentCloner";
-import { Mesh } from "../graphic/Mesh";
 import { Renderer } from "../Renderer";
-import { RenderContext } from "../RenderPipeline/RenderContext";
+import { Mesh } from "../graphic/Mesh";
 /**
  * MeshRenderer Component.
  */
-export declare class MeshRenderer extends Renderer implements ICustomClone {
+export declare class MeshRenderer extends Renderer {
     private static _uvMacro;
     private static _uv1Macro;
     private static _normalMacro;
     private static _tangentMacro;
-    private static _vertexColorMacro;
+    private static _enableVertexColorMacro;
+    private _enableVertexColor;
     /**
      * Mesh assigned to the renderer.
      */
     get mesh(): Mesh;
     set mesh(value: Mesh);
     /**
-     * @override
-     */
-    protected _updateBounds(worldBounds: BoundingBox): void;
-    /**
-     * @override
+     * Whether enable vertex color.
      */
-    protected _render(context: RenderContext): void;
+    get enableVertexColor(): boolean;
+    set enableVertexColor(value: boolean);
     private _setMesh;
     private _onMeshChanged;
 }