@galacean/engine-core 1.0.0 → 1.0.2

package/types/Entity.d.ts

@@ -1,10 +1,10 @@
 import { Matrix } from "@galacean/engine-math";
-import { EngineObject } from "./base";
 import { Component } from "./Component";
 import { Engine } from "./Engine";
 import { Layer } from "./Layer";
 import { Scene } from "./Scene";
 import { Transform } from "./Transform";
+import { EngineObject } from "./base";
 /**
  * Entity, be used as components container.
  */
@@ -65,7 +65,7 @@ export declare class Entity extends EngineObject {
      * @param type - The type of the component
      * @returns	The first component which match type
      */
-    getComponent<T extends Component>(type: new (entity: Entity) => T): T;
+    getComponent<T extends Component>(type: new (entity: Entity) => T): T | null;
     /**
      * Get components which match the type.
      * @param type - The type of the component

package/types/RenderPipeline/Basic2DBatcher.d.ts

@@ -1,19 +1,18 @@
 import { Camera } from "../Camera";
 import { Engine } from "../Engine";
-import { Material } from "../material";
-import { SpriteElement } from "./SpriteElement";
-import { SpriteMaskElement } from "./SpriteMaskElement";
-import { TextRenderElement } from "./TextRenderElement";
+import { ShaderTagKey } from "../shader/ShaderTagKey";
+import { RenderElement } from "./RenderElement";
 export declare abstract class Basic2DBatcher {
+    protected static _disableBatchTag: ShaderTagKey;
     /** The maximum number of vertex. */
     static MAX_VERTEX_COUNT: number;
     static _canUploadSameBuffer: boolean;
     constructor(engine: Engine);
-    drawElement(element: SpriteMaskElement | SpriteElement | TextRenderElement, camera: Camera, replaceMaterial: Material): void;
-    private _drawSubElement;
-    flush(camera: Camera, replaceMaterial: Material): void;
+    drawElement(element: RenderElement, camera: Camera): void;
+    flush(camera: Camera): void;
     clear(): void;
     destroy(): void;
+    private _drawSubElement;
     private _createMesh;
     private _updateData;
     private _getSubMeshFromPool;

package/types/RenderPipeline/BasicRenderPipeline.d.ts

@@ -3,14 +3,14 @@ import { Layer } from "../Layer";
 import { Material } from "../material";
 import { RenderTarget, TextureCubeFace } from "../texture";
 import { RenderContext } from "./RenderContext";
-import { RenderElement } from "./RenderElement";
+import { RenderData } from "./RenderData";
 import { RenderPass } from "./RenderPass";
 /**
  * Basic render pipeline.
  */
 export declare class BasicRenderPipeline {
-    private static _tempVector0;
-    private static _tempVector1;
+    private static _shadowCasterPipelineStageTagValue;
+    private static _forwardPipelineStageTagValue;
     private _camera;
     private _defaultPass;
     private _renderPassArray;
@@ -57,10 +57,12 @@ export declare class BasicRenderPipeline {
     render(context: RenderContext, cubeFace?: TextureCubeFace, mipLevel?: number): void;
     private _drawRenderPass;
     /**
-     * Push a render element to the render queue.
-     * @param element - Render element
+     * Push render data to render queue.
+     * @param context - Render context
+     * @param data - Render data
      */
-    pushPrimitive(element: RenderElement): void;
+    pushRenderData(context: RenderContext, data: RenderData): void;
+    private pushRenderDataWihShader;
     private _drawBackgroundTexture;
     private _callRender;
 }

package/types/RenderPipeline/ClassPool.d.ts

@@ -1,7 +1,8 @@
+import { IPoolElement } from "./IPoolElement";
 /**
  * Class pool utils.
  */
-export declare class ClassPool<T> {
+export declare class ClassPool<T extends IPoolElement> {
     private _elementPoolIndex;
     private _elementPool;
     private _type;
@@ -14,4 +15,5 @@ export declare class ClassPool<T> {
      * Reset pool.
      */
     resetPool(): void;
+    garbageCollection(): void;
 }

package/types/RenderPipeline/CullingResults.d.ts

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

package/types/RenderPipeline/DepthOnlyPass.d.ts

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

package/types/RenderPipeline/IPoolElement.d.ts

@@ -0,0 +1,3 @@
+export interface IPoolElement {
+    dispose?(): void;
+}

package/types/RenderPipeline/MeshRenderData.d.ts

@@ -0,0 +1,17 @@
+import { Mesh } from "../graphic/Mesh";
+import { SubMesh } from "../graphic/SubMesh";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { IPoolElement } from "./IPoolElement";
+import { RenderData } from "./RenderData";
+/**
+ * Render element.
+ */
+export declare class MeshRenderData extends RenderData implements IPoolElement {
+    /** Mesh. */
+    mesh: Mesh;
+    /** Sub mesh. */
+    subMesh: SubMesh;
+    set(component: Renderer, material: Material, mesh: Mesh, subMesh: SubMesh): void;
+    dispose(): void;
+}

package/types/RenderPipeline/MeshRenderElement.d.ts

@@ -4,14 +4,16 @@ 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 {
+export declare class MeshRenderElement extends RenderElement implements IPoolElement {
     /** 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/RenderData.d.ts

@@ -0,0 +1,7 @@
+import { Material } from "../material";
+import { Renderer } from "../Renderer";
+export declare class RenderData {
+    component: Renderer;
+    material: Material;
+    multiRenderData: boolean;
+}

package/types/RenderPipeline/RenderElement.d.ts

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

package/types/RenderPipeline/RenderElementX.d.ts

@@ -0,0 +1,12 @@
+import { Renderer } from "../Renderer";
+import { Primitive } from "../graphic/Primitive";
+import { Material } from "../material/Material";
+import { ShaderPass } from "../shader/ShaderPass";
+import { IPoolElement } from "./IPoolElement";
+export declare class RenderElementX implements IPoolElement {
+    shaderPasses: ReadonlyArray<ShaderPass>;
+    component: Renderer;
+    material: Material;
+    primitive: Primitive;
+    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): void;
     /**
      * Clear collection.
      */

package/types/RenderPipeline/SpriteElement.d.ts

@@ -4,10 +4,12 @@ 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 {
+export declare class SpriteElement extends RenderElement implements IPoolElement {
     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,10 +1,12 @@
 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 {
+export declare class SpriteMaskElement extends RenderElement implements IPoolElement {
     renderData: RenderData2D;
     isAdd: boolean;
     constructor();
     setValue(component: Renderer, renderData: RenderData2D, material: Material): void;
+    dispose(): void;
 }

package/types/RenderPipeline/SpriteMaskRenderData.d.ts

@@ -0,0 +1,12 @@
+import { VertexData2D } from "../2d/data/VertexData2D";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { IPoolElement } from "./IPoolElement";
+import { RenderData } from "./RenderData";
+export declare class SpriteMaskRenderData extends RenderData implements IPoolElement {
+    isAdd: boolean;
+    verticesData: VertexData2D;
+    constructor();
+    set(component: Renderer, material: Material, verticesData: VertexData2D): void;
+    dispose(): void;
+}

package/types/RenderPipeline/SpriteRenderData.d.ts

@@ -0,0 +1,14 @@
+import { VertexData2D } from "../2d/data/VertexData2D";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { Texture2D } from "../texture";
+import { IPoolElement } from "./IPoolElement";
+import { RenderData } from "./RenderData";
+export declare class SpriteRenderData extends RenderData implements IPoolElement {
+    verticesData: VertexData2D;
+    texture: Texture2D;
+    dataIndex: number;
+    constructor();
+    set(component: Renderer, material: Material, verticesData: VertexData2D, texture: Texture2D, dataIndex?: number): void;
+    dispose(): void;
+}

package/types/RenderPipeline/TextRenderData.d.ts

@@ -0,0 +1,8 @@
+import { IPoolElement } from "./IPoolElement";
+import { RenderData } from "./RenderData";
+import { SpriteRenderData } from "./SpriteRenderData";
+export declare class TextRenderData extends RenderData implements IPoolElement {
+    charsData: SpriteRenderData[];
+    constructor();
+    dispose(): void;
+}

package/types/RenderPipeline/TextRenderElement.d.ts

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

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

@@ -0,0 +1,9 @@
+/**
+ * Pipeline stage.
+ */
+export declare enum PipelineStage {
+    /** Shadow caster stage. */
+    ShadowCaster = "ShadowCaster",
+    /** Forward shading stage. */
+    Forward = "Forward"
+}

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

@@ -1,14 +1,13 @@
-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 { Material } from "./material/Material";
+import { ICustomClone } from "./clone/ComponentCloner";
+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 {
+export declare class Renderer extends Component implements ICustomClone {
     private static _tempVector0;
     private static _receiveShadowMacro;
     private static _localMatrixProperty;
@@ -18,12 +17,11 @@ export declare class Renderer extends Component {
     private static _mvInvMatrixProperty;
     private static _normalMatrixProperty;
     private static _rendererLayerProperty;
-    /** ShaderData related to renderer. */
-    readonly shaderData: ShaderData;
     _renderFrameCount: number;
     protected _overrideUpdate: boolean;
     protected _materials: Material[];
     protected _dirtyUpdateFlag: number;
+    private _shaderData;
     private _mvMatrix;
     private _mvpMatrix;
     private _mvInvMatrix;
@@ -32,6 +30,10 @@ export declare class Renderer extends Component {
     private _priority;
     private _receiveShadows;
     protected _rendererLayer: Vector4;
+    /**
+     * ShaderData related to renderer.
+     */
+    get shaderData(): ShaderData;
     /**
      * Whether it is culled in the current frame and does not participate in rendering.
      */
@@ -108,12 +110,5 @@ 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

@@ -1,8 +1,8 @@
 import { Color, Vector3 } from "@galacean/engine-math";
 import { Background } from "./Background";
-import { EngineObject } from "./base";
 import { Engine } from "./Engine";
 import { Entity } from "./Entity";
+import { EngineObject } from "./base";
 import { FogMode } from "./enums/FogMode";
 import { AmbientLight } from "./lighting/AmbientLight";
 import { ShaderData } from "./shader/ShaderData";
@@ -14,12 +14,10 @@ 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. */
-    readonly background: Background;
-    /** Scene-related shader data. */
-    readonly shaderData: ShaderData;
     /** If cast shadows. */
     castShadows: boolean;
     /** The resolution of the shadow maps. */
@@ -30,6 +28,8 @@ export declare class Scene extends EngineObject {
     shadowFourCascadeSplits: Vector3;
     /** Max Shadow distance. */
     shadowDistance: number;
+    private _background;
+    private _shaderData;
     private _shadowCascades;
     private _ambientLight;
     private _fogMode;
@@ -38,6 +38,14 @@ export declare class Scene extends EngineObject {
     private _fogEnd;
     private _fogDensity;
     private _fogParams;
+    /**
+     * Scene-related shader data.
+     */
+    get shaderData(): ShaderData;
+    /**
+     * The background of the scene.
+     */
+    get background(): Background;
     /**
      *  Number of cascades to use for directional light shadows.
      */

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/Ticker.d.ts

@@ -0,0 +1,30 @@
+export declare class Ticker {
+    private _vSyncCount;
+    private _vSyncCounter;
+    private _requestId;
+    private _animationLoop;
+    private _requestAnimationFrame;
+    private _cancelAnimationFrame;
+    /**
+     * The number of vertical synchronization means the number of vertical blanking for one frame.
+     * @remarks 0 means that the vertical synchronization is turned off.
+     */
+    get vSyncCount(): number;
+    set vSyncCount(value: number);
+    get requestAnimationFrame(): (...params: any[]) => any;
+    set requestAnimationFrame(func: (...params: any[]) => any);
+    get cancelAnimationFrame(): (...params: any[]) => any;
+    set cancelAnimationFrame(func: (...params: any[]) => any);
+    get animationLoop(): (...params: any[]) => any;
+    set animationLoop(func: (...params: any[]) => any);
+    /**
+     * Pause the engine.
+     */
+    pause(): void;
+    /**
+     * Resume the engine.
+     */
+    resume(): void;
+    private _onAnimationFrame;
+    constructor();
+}