@galacean/engine-core 0.0.0-experimental-0.9-plus.8 → 0.0.0-experimental-ktx2.0

package/types/RenderPipeline/MeshRenderElement.d.ts

@@ -4,16 +4,14 @@ import { Material } from "../material/Material";
 import { Renderer } from "../Renderer";
 import { ShaderPass } from "../shader/ShaderPass";
 import { RenderState } from "../shader/state/RenderState";
-import { IPoolElement } from "./IPoolElement";
 import { RenderElement } from "./RenderElement";
 /**
  * Render element.
  */
-export declare class MeshRenderElement extends RenderElement implements IPoolElement {
+export declare class MeshRenderElement extends RenderElement {
     /** Mesh. */
     mesh: Mesh;
     /** Sub mesh. */
     subMesh: SubMesh;
     setValue(component: Renderer, mesh: Mesh, subMesh: SubMesh, material: Material, renderState: RenderState, shaderPass: ShaderPass): void;
-    dispose(): void;
 }

package/types/RenderPipeline/PipelinePass.d.ts

@@ -0,0 +1,16 @@
+import { Engine } from "../Engine";
+import { CullingResults } from "../RenderPipeline/CullingResults";
+import { RenderContext } from "../RenderPipeline/RenderContext";
+/**
+ * PipelinePass is a base class for all pipeline passes.
+ */
+export declare abstract class PipelinePass {
+    protected _engine: Engine;
+    constructor(engine: Engine);
+    /**
+     * Called before rendering a camera, override this method to configure the camera If you need to configure the camera clear flag or render target.
+     * @param context - Rendering context
+     * @param cullingResults - Culling results
+     */
+    abstract onRender(context: RenderContext, cullingResults: CullingResults): void;
+}

package/types/RenderPipeline/PipelineUtils.d.ts

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

package/types/RenderPipeline/RenderElement.d.ts

@@ -1,11 +1,9 @@
-import { Material } from "../material/Material";
-import { Renderer } from "../Renderer";
-import { ShaderPass } from "../shader";
-import { RenderState } from "../shader/state/RenderState";
-export declare class RenderElement {
-    component: Renderer;
-    material: Material;
-    multiRenderData: boolean;
-    renderState: RenderState;
-    shaderPass: ShaderPass;
+import { ShaderPass } from "../shader/ShaderPass";
+import { IPoolElement } from "./IPoolElement";
+import { RenderData } from "./RenderData";
+export declare class RenderElement implements IPoolElement {
+    data: RenderData;
+    shaderPasses: ReadonlyArray<ShaderPass>;
+    set(data: RenderData, shaderPasses: ReadonlyArray<ShaderPass>): void;
+    dispose(): void;
 }

package/types/RenderPipeline/RenderPass.d.ts

@@ -23,7 +23,7 @@ declare class RenderPass {
      * @param name - Pass name
      * @param priority - Priority, less than 0 before the default pass, greater than 0 after the default pass
      * @param renderTarget - The specified Render Target
-     * @param replaceMaterial -  Replaced material
+     * @param replaceMaterial - Replaced material
      * @param mask - Perform bit and operations with Entity.Layer to filter the objects that this Pass needs to render
      */
     constructor(name?: string, priority?: number, renderTarget?: any, replaceMaterial?: any, mask?: any);

package/types/RenderPipeline/RenderQueue.d.ts

@@ -1,21 +1,19 @@
 import { Camera } from "../Camera";
 import { Engine } from "../Engine";
 import { Layer } from "../Layer";
-import { Material } from "../material/Material";
-import { Shader } from "../shader";
 import { RenderElement } from "./RenderElement";
 /**
  * Render queue.
  */
 export declare class RenderQueue {
-    readonly items: RenderElement[];
+    readonly elements: RenderElement[];
     private _spriteBatcher;
     constructor(engine: Engine);
     /**
      * Push a render element.
      */
-    pushPrimitive(element: RenderElement): void;
-    render(camera: Camera, replaceMaterial: Material, mask: Layer, customShader: Shader): void;
+    pushRenderElement(element: RenderElement): void;
+    render(camera: Camera, mask: Layer, pipelineStageTagValue: string): void;
     /**
      * Clear collection.
      */

package/types/RenderPipeline/SpriteElement.d.ts

@@ -4,12 +4,10 @@ import { Renderer } from "../Renderer";
 import { ShaderPass } from "../shader";
 import { RenderState } from "../shader/state/RenderState";
 import { Texture2D } from "../texture";
-import { IPoolElement } from "./IPoolElement";
 import { RenderElement } from "./RenderElement";
-export declare class SpriteElement extends RenderElement implements IPoolElement {
+export declare class SpriteElement extends RenderElement {
     renderData: RenderData2D;
     texture: Texture2D;
     constructor();
     setValue(component: Renderer, renderDate: RenderData2D, material: Material, texture: Texture2D, renderState: RenderState, shaderPass: ShaderPass): void;
-    dispose(): void;
 }

package/types/RenderPipeline/SpriteMaskBatcher.d.ts

@@ -1,10 +1,11 @@
 import { Camera } from "../Camera";
 import { VertexElement } from "../graphic/VertexElement";
 import { Basic2DBatcher } from "./Basic2DBatcher";
-import { SpriteMaskElement } from "./SpriteMaskElement";
+import { RenderElement } from "./RenderElement";
+import { SpriteMaskRenderData } from "./SpriteMaskRenderData";
 export declare class SpriteMaskBatcher extends Basic2DBatcher {
     createVertexElements(vertexElements: VertexElement[]): number;
-    canBatch(preElement: SpriteMaskElement, curElement: SpriteMaskElement): boolean;
-    updateVertices(element: SpriteMaskElement, vertices: Float32Array, vertexIndex: number): number;
+    canBatch(preElement: RenderElement, curElement: RenderElement): boolean;
+    updateVertices(element: SpriteMaskRenderData, vertices: Float32Array, vertexIndex: number): number;
     drawBatches(camera: Camera): void;
 }

package/types/RenderPipeline/SpriteMaskElement.d.ts

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

package/types/RenderPipeline/TextRenderElement.d.ts

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

package/types/RenderPipeline/enums/PipelineStage.d.ts

@@ -2,6 +2,8 @@
  * Pipeline stage.
  */
 export declare enum PipelineStage {
+    /** DepthOnly stage. */
+    DepthOnly = "DepthOnly",
     /** Shadow caster stage. */
     ShadowCaster = "ShadowCaster",
     /** Forward shading stage. */

package/types/Renderer.d.ts

@@ -1,13 +1,11 @@
-import { BoundingBox, Matrix, Vector4 } from "@galacean/engine-math";
+import { BoundingBox, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
-import { RenderContext } from "./RenderPipeline/RenderContext";
-import { TransformModifyFlags } from "./Transform";
 import { ICustomClone } from "./clone/ComponentCloner";
-import { Material } from "./material/Material";
+import { Material } from "./material";
 import { ShaderData } from "./shader/ShaderData";
 /**
  * Basis for all renderers.
- * @decorator `@dependentComponents(Transform)`
+ * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
  */
 export declare class Renderer extends Component implements ICustomClone {
     private static _tempVector0;
@@ -112,12 +110,5 @@ export declare class Renderer extends Component implements ICustomClone {
      */
     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/Scene.d.ts

@@ -5,6 +5,7 @@ import { Entity } from "./Entity";
 import { EngineObject } from "./base";
 import { FogMode } from "./enums/FogMode";
 import { AmbientLight } from "./lighting/AmbientLight";
+import { PhysicsScene } from "./physics/PhysicsScene";
 import { ShaderData } from "./shader/ShaderData";
 import { ShadowCascadesMode } from "./shadow/enum/ShadowCascadesMode";
 import { ShadowResolution } from "./shadow/enum/ShadowResolution";
@@ -18,6 +19,8 @@ export declare class Scene extends EngineObject {
     private static _sunlightDirectionProperty;
     /** Scene name. */
     name: string;
+    /** Physics. */
+    readonly physics: PhysicsScene;
     /** If cast shadows. */
     castShadows: boolean;
     /** The resolution of the shadow maps. */
@@ -38,7 +41,6 @@ export declare class Scene extends EngineObject {
     private _fogEnd;
     private _fogDensity;
     private _fogParams;
-    private _sunlightVector3;
     /**
      * Scene-related shader data.
      */
@@ -141,10 +143,6 @@ export declare class Scene extends EngineObject {
      * @returns Entity
      */
     findEntityByPath(path: string): Entity | null;
-    /**
-     * Destroy this scene.
-     */
-    destroy(): void;
     private _addToRootEntityList;
     private _computeLinearFogParams;
     private _computeExponentialFogParams;

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
@@ -198,6 +195,7 @@ export declare class Transform extends Component {
      * @returns Change flag
      */
     registerWorldChangeFlag(): BoolUpdateFlag;
+    protected _onDestroy(): void;
     /**
      * Get worldMatrix: Will trigger the worldMatrix update of itself and all parent entities.
      * Get worldPosition: Will trigger the worldMatrix, local position update of itself and the worldMatrix update of all parent entities.

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