@galacean/engine-core 0.0.0-experimental-1.0-xr.0 → 0.0.0-experimental-0.9-plus.7

package/types/RenderPipeline/SpriteMaskElement.d.ts

@@ -0,0 +1,10 @@
+import { RenderData2D } from "../2d/data/RenderData2D";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { RenderElement } from "./RenderElement";
+export declare class SpriteMaskElement extends RenderElement {
+    renderData: RenderData2D;
+    isAdd: boolean;
+    constructor();
+    setValue(component: Renderer, renderData: RenderData2D, material: Material): void;
+}

package/types/RenderPipeline/TextRenderElement.d.ts

@@ -0,0 +1,6 @@
+import { RenderElement } from "./RenderElement";
+import { SpriteElement } from "./SpriteElement";
+export declare class TextRenderElement extends RenderElement {
+    charElements: SpriteElement[];
+    constructor();
+}

package/types/Renderer.d.ts

@@ -1,12 +1,15 @@
-import { BoundingBox, Vector4 } from "@galacean/engine-math";
+import { BoundingBox, Matrix, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
-import { Material } from "./material";
+import { RenderContext } from "./RenderPipeline/RenderContext";
+import { TransformModifyFlags } from "./Transform";
+import { ICustomClone } from "./clone/ComponentCloner";
+import { Material } from "./material/Material";
 import { ShaderData } from "./shader/ShaderData";
 /**
  * Basis for all renderers.
- * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
+ * @decorator `@dependentComponents(Transform)`
  */
-export declare class Renderer extends Component {
+export declare class Renderer extends Component implements ICustomClone {
     private static _tempVector0;
     private static _receiveShadowMacro;
     private static _localMatrixProperty;
@@ -106,5 +109,12 @@ export declare class Renderer extends Component {
      */
     setMaterials(materials: Material[]): void;
     update(deltaTime: number): void;
+    protected _updateShaderData(context: RenderContext): void;
+    protected _updateTransformShaderData(context: RenderContext, worldMatrix: Matrix): void;
+    protected _registerEntityTransformListener(): void;
+    protected _updateBounds(worldBounds: BoundingBox): void;
+    protected _render(context: RenderContext): void;
+    private _createInstanceMaterial;
     private _setMaterial;
+    protected _onTransformChanged(type: TransformModifyFlags): void;
 }

package/types/SafeLoopArray.d.ts

@@ -0,0 +1,37 @@
+export declare class SafeLoopArray<T> {
+    private _array;
+    private _loopArray;
+    private _loopArrayDirty;
+    /**
+     * Get the length of the array.
+     */
+    get length(): number;
+    /**
+     * Push item to the array.
+     * @param item - The item which want to be pushed
+     */
+    push(item: T): void;
+    /**
+     * Splice the array.
+     * @param index - The index of the array
+     * @param deleteCount - The count of the array which want to be deleted
+     * @param item - The item which want to be added
+     */
+    splice(index: number, deleteCount: number, item?: T): void;
+    /**
+     * The index of the item.
+     * @param item - The item which want to get the index
+     * @returns Index of the item
+     */
+    indexOf(item: T): number;
+    /**
+     * Get the array.
+     * @returns The array
+     */
+    getArray(): ReadonlyArray<T>;
+    /**
+     * Get the array use for loop.
+     * @returns The array use for loop
+     */
+    getLoopArray(): ReadonlyArray<T>;
+}

package/types/Scene.d.ts

@@ -40,6 +40,7 @@ export declare class Scene extends EngineObject {
     private _fogEnd;
     private _fogDensity;
     private _fogParams;
+    private _sunlightVector3;
     /**
      *  Number of cascades to use for directional light shadows.
      */

package/types/Script.d.ts

@@ -2,7 +2,6 @@ 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.
  */
@@ -23,12 +22,12 @@ export declare class Script extends Component {
     onStart(): void;
     /**
      * The main loop, called frame by frame.
-     * @param deltaTime - The delta time since last frame in seconds
+     * @param deltaTime - The deltaTime when the script update.
      */
     onUpdate(deltaTime: number): void;
     /**
      * Called after the onUpdate finished, called frame by frame.
-     * @param deltaTime - The delta time since last frame in seconds
+     * @param deltaTime - The deltaTime when the script update.
      */
     onLateUpdate(deltaTime: number): void;
     /**
@@ -46,39 +45,37 @@ export declare class Script extends Component {
      */
     onPhysicsUpdate(): void;
     /**
-     * Called when the trigger enter.
+     * Called when the collision enter.
      * @param other - ColliderShape
      */
     onTriggerEnter(other: ColliderShape): void;
     /**
-     * Called when the trigger exit.
+     * Called when the collision stay.
+     * @remarks onTriggerStay is called every frame while the collision stay.
      * @param other - ColliderShape
      */
     onTriggerExit(other: ColliderShape): void;
     /**
-     * Called when the trigger stay.
-     * @remarks onTriggerStay is called every frame while the trigger stay.
+     * Called when the collision exit.
      * @param other - ColliderShape
      */
     onTriggerStay(other: ColliderShape): void;
     /**
      * Called when the collision enter.
-     * @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.
+     * @param other - ColliderShape
      */
-    onCollisionEnter(other: Collision): void;
+    onCollisionEnter(other: ColliderShape): void;
     /**
-     * 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.
+     * Called when the collision stay.
+     * @remarks onTriggerStay is called every frame while the collision stay.
+     * @param other - ColliderShape
      */
-    onCollisionExit(other: Collision): void;
+    onCollisionExit(other: ColliderShape): void;
     /**
-     * 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.
+     * Called when the collision exit.
+     * @param other - ColliderShape
      */
-    onCollisionStay(other: Collision): void;
+    onCollisionStay(other: ColliderShape): void;
     /**
      * Called when the pointer is down while over the ColliderShape.
      * @param pointer - The pointer that triggered

package/types/Transform.d.ts

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

package/types/Utils.d.ts

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

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

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

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

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

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

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

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 = "TextureCube",
+    TextureCube = "texture-cube",
     /** Material. */
-    Material = "Material",
+    Material = "material",
     /** Mesh. */
-    Mesh = "Mesh",
+    Mesh = "mesh",
     /** AnimationClip. */
     AnimationClip = "AnimationClip",
     /** AnimatorController. */
     AnimatorController = "AnimatorController",
     /** Prefab.*/
-    GLTF = "GLTF",
+    Prefab = "prefab",
     /** Compress Texture. */
-    KTX = "KTX",
+    KTX = "ktx",
     /** Cube Compress Texture. */
-    KTXCube = "KTXCube",
+    KTXCube = "ktx-cube",
     /** Sprite. */
-    Sprite = "Sprite",
+    Sprite = "sprite",
     /** Sprite Atlas. */
-    SpriteAtlas = "SpriteAtlas",
+    SpriteAtlas = "sprite-atlas",
     /** 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 = "SourceFont"
+    SourceFont = "source-font"
 }

package/types/asset/IRefObject.d.ts

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

package/types/asset/RefObject.d.ts

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

package/types/asset/ResourceManager.d.ts

@@ -1,4 +1,4 @@
-import { ContentRestorer, Engine, EngineObject } from "..";
+import { Engine } from "..";
 import { AssetPromise } from "./AssetPromise";
 import { Loader } from "./Loader";
 import { LoadItem } from "./LoadItem";
@@ -17,17 +17,14 @@ export declare class ResourceManager {
     retryInterval: number;
     /** The default timeout period for loading assets, in milliseconds. */
     timeout: number;
-    private _loadingPromises;
-    /** Asset path pool, key is the `instanceID` of resource, value is asset path. */
+    /** Asset path pool, key is asset ID, value is asset path */
     private _assetPool;
-    /** Asset url pool, key is the asset path and the value is the asset. */
+    /** Asset pool, the key is the asset path and the value is the asset. */
     private _assetUrlPool;
-    /** 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;
+    /** Reference counted object pool, key is the object ID, and reference counted objects are put into this pool. */
+    private _refObjectPool;
+    /** Loading promises. */
+    private _loadingPromises;
     /**
      * Create a ResourceManager.
      * @param engine - Engine to which the current ResourceManager belongs
@@ -88,11 +85,6 @@ 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;
@@ -104,6 +96,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,7 +105,6 @@ 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",
-    WEBGL_lose_context = "WEBGL_lose_context"
+    s3tc_webkit = "WEBKIT_WEBGL_compressed_texture_s3tc"
 }
 export type TypedArray = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array;

package/types/base/EngineObject.d.ts

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

package/types/base/Event.d.ts

@@ -0,0 +1,24 @@
+import { EventDispatcher } from "./EventDispatcher";
+export type Listener = ((e: Event) => any) & {
+    once?: boolean;
+};
+/** Event Object. * @class */
+export declare class Event {
+    get propagationStopped(): boolean;
+    get target(): EventDispatcher;
+    set target(t: EventDispatcher);
+    get timeStamp(): number;
+    get currentTarget(): EventDispatcher;
+    set currentTarget(t: EventDispatcher);
+    get bubbles(): boolean;
+    get type(): string | number;
+    data: any;
+    private _timeStamp;
+    private _target;
+    private _currentTarget;
+    private _bubbles;
+    private _propagationStopped;
+    private _type;
+    constructor(type: string | number, target?: EventDispatcher, data?: any, bubbles?: boolean);
+    stopPropagation(): void;
+}

package/types/base/EventDispatcher.d.ts

@@ -1,3 +1,4 @@
+import { Event } from "./Event";
 /**
  * EventDispatcher, which can be inherited as a base class.
  */
@@ -43,6 +44,15 @@ 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
@@ -61,6 +71,9 @@ export declare class EventDispatcher {
      * @param event - Event name, delete all events if not passed
      */
     removeAllEventListeners(event?: string): void;
-    private _addEventListener;
+    /**
+     * @deprecated Use `dispatch` instead.
+     */
+    trigger(e: Event): void;
     private _clearEvent;
 }

package/types/base/Time.d.ts

@@ -1,44 +1,43 @@
 /**
- * Provide time related information.
+ * Tools for calculating the time per frame.
  */
 export declare class Time {
     private static _elapsedTimeProperty;
-    private static _deltaTimeProperty;
-    private _frameCount;
+    private _clock;
+    private _timeScale;
     private _deltaTime;
-    private _actualDeltaTime;
-    private _elapsedTime;
-    private _actualElapsedTime;
-    private _lastSystemTime;
+    private _startTime;
+    private _lastTickTime;
     private _elapsedTimeValue;
-    private _deltaTimeValue;
-    /** Maximum delta time allowed per frame in seconds. */
-    maximumDeltaTime: number;
-    /** The scale of time. */
-    timeScale: number;
     get frameCount(): number;
     /**
-     * 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`.
+     * Constructor of the Time.
+     */
+    constructor();
+    reset(): void;
+    /**
+     * Current Time
+     */
+    get nowTime(): number;
+    /**
+     * Time between two ticks
      */
     get deltaTime(): number;
     /**
-     * The amount of elapsed time in seconds since the start of the engine.
+     * Scaled delta time.
      */
-    get elapsedTime(): number;
+    get timeScale(): number;
+    set timeScale(s: number);
     /**
-     * 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`.
+     * Unscaled delta time.
      */
-    get actualDeltaTime(): number;
+    get unscaledDeltaTime(): number;
     /**
-     * The amount of actual elapsed time in seconds since the start of the engine.
+     * The elapsed time, after the clock is initialized.
      */
-    get actualElapsedTime(): number;
+    get timeSinceStartup(): number;
     /**
-     * Constructor of the Time.
+     * Call every frame, update delta time and other data.
      */
-    constructor();
+    tick(): void;
 }

package/types/base/Util.d.ts

@@ -0,0 +1,14 @@
+export declare const Util: {
+    isArray: (value: any) => boolean;
+    isArrayLike(x: any): boolean;
+    clone<T>(obj: T): T;
+    downloadBlob(blob: Blob, fileName?: string): void;
+};
+export declare const isArrayLike: <T>(x: any) => x is ArrayLike<T>;
+/**
+ * Fastly remove an element from array.
+ * @param array - Array
+ * @param item - Element
+ */
+export declare function removeFromArray(array: any[], item: any): boolean;
+export declare function ObjectValues(obj: any): any[];

package/types/base/index.d.ts

@@ -1,5 +1,7 @@
+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,8 +9,15 @@ 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,7 +46,13 @@ 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;
 }