@galacean/engine-core 0.0.0-experimental-animator-additive.1

package/types/Entity.d.ts

@@ -0,0 +1,151 @@
+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";
+/**
+ * Entity, be used as components container.
+ */
+export declare class Entity extends EngineObject {
+    /** The name of entity. */
+    name: string;
+    /** The layer the entity belongs to. */
+    layer: Layer;
+    /** Transform component. */
+    readonly transform: Transform;
+    private _parent;
+    private _activeChangedComponents;
+    /**
+     * Whether to activate locally.
+     */
+    get isActive(): boolean;
+    set isActive(value: boolean);
+    /**
+     * Whether it is active in the hierarchy.
+     */
+    get isActiveInHierarchy(): boolean;
+    /**
+     * The parent entity.
+     */
+    get parent(): Entity;
+    set parent(value: Entity);
+    /**
+     * The children entities
+     */
+    get children(): Readonly<Entity[]>;
+    /**
+     * @deprecated Please use `children.length` property instead.
+     * Number of the children entities
+     */
+    get childCount(): number;
+    /**
+     * The scene the entity belongs to.
+     */
+    get scene(): Scene;
+    /**
+     * The sibling index.
+     */
+    get siblingIndex(): number;
+    set siblingIndex(value: number);
+    /**
+     * Create a entity.
+     * @param engine - The engine the entity belongs to
+     */
+    constructor(engine: Engine, name?: string);
+    /**
+     * Add component based on the component type.
+     * @param type - The type of the component
+     * @returns	The component which has been added
+     */
+    addComponent<T extends Component>(type: new (entity: Entity) => T): T;
+    /**
+     * Get component which match the type.
+     * @param type - The type of the component
+     * @returns	The first component which match type
+     */
+    getComponent<T extends Component>(type: new (entity: Entity) => T): T;
+    /**
+     * Get components which match the type.
+     * @param type - The type of the component
+     * @param results - The components which match type
+     * @returns	The components which match type
+     */
+    getComponents<T extends Component>(type: new (entity: Entity) => T, results: T[]): T[];
+    /**
+     * Get the components which match the type of the entity and it's children.
+     * @param type - The component type
+     * @param results - The components collection
+     * @returns	The components collection which match the type
+     */
+    getComponentsIncludeChildren<T extends Component>(type: new (entity: Entity) => T, results: T[]): T[];
+    /**
+     * Add child entity.
+     * @param child - The child entity which want to be added
+     */
+    addChild(child: Entity): void;
+    /**
+     * Add child entity at specified index.
+     * @param index - specified index
+     * @param child - The child entity which want to be added
+     */
+    addChild(index: number, child: Entity): void;
+    /**
+     * Remove child entity.
+     * @param child - The child entity which want to be removed
+     */
+    removeChild(child: Entity): void;
+    /**
+     * @deprecated Please use `children` property instead.
+     * Find child entity by index.
+     * @param index - The index of the child entity
+     * @returns	The component which be found
+     */
+    getChild(index: number): Entity;
+    /**
+     * Find entity by name.
+     * @param name - The name of the entity which want to be found
+     * @returns The component which be found
+     */
+    findByName(name: string): Entity;
+    /**
+     * Find the entity by path.
+     * @param path - The path fo the entity eg: /entity
+     * @returns The component which be found
+     */
+    findByPath(path: string): Entity;
+    /**
+     * Create child entity.
+     * @param name - The child entity's name
+     * @returns The child entity
+     */
+    createChild(name?: string): Entity;
+    /**
+     * Clear children entities.
+     */
+    clearChildren(): void;
+    /**
+     * Clone.
+     * @returns Cloned entity
+     */
+    clone(): Entity;
+    /**
+     * Destroy self.
+     */
+    destroy(): void;
+    private _addToChildrenList;
+    private _setParent;
+    private _getComponentsInChildren;
+    private _setActiveComponents;
+    private _setActiveInHierarchy;
+    private _setInActiveInHierarchy;
+    private _setTransformDirty;
+    private _setSiblingIndex;
+    private _invModelMatrix;
+    private _inverseWorldMatFlag;
+    /**
+     * @deprecated
+     */
+    getInvModelMatrix(): Matrix;
+}

package/types/Layer.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Layer, used for bit operations.
+ */
+export declare enum Layer {
+    /** Layer 0. */
+    Layer0 = 1,
+    /** Layer 1. */
+    Layer1 = 2,
+    /** Layer 2. */
+    Layer2 = 4,
+    /** Layer 3. */
+    Layer3 = 8,
+    /** Layer 4. */
+    Layer4 = 16,
+    /** Layer 5. */
+    Layer5 = 32,
+    /** Layer 6. */
+    Layer6 = 64,
+    /** Layer 7. */
+    Layer7 = 128,
+    /** Layer 8. */
+    Layer8 = 256,
+    /** Layer 9. */
+    Layer9 = 512,
+    /** Layer 10. */
+    Layer10 = 1024,
+    /** Layer 11. */
+    Layer11 = 2048,
+    /** Layer 12. */
+    Layer12 = 4096,
+    /** Layer 13. */
+    Layer13 = 8192,
+    /** Layer 14. */
+    Layer14 = 16384,
+    /** Layer 15. */
+    Layer15 = 32768,
+    /** Layer 16. */
+    Layer16 = 65536,
+    /** Layer 17. */
+    Layer17 = 131072,
+    /** Layer 18. */
+    Layer18 = 262144,
+    /** Layer 19. */
+    Layer19 = 524288,
+    /** Layer 20. */
+    Layer20 = 1048576,
+    /** Layer 21. */
+    Layer21 = 2097152,
+    /** Layer 22. */
+    Layer22 = 4194304,
+    /** Layer 23. */
+    Layer23 = 8388608,
+    /** Layer 24. */
+    Layer24 = 16777216,
+    /** Layer 25. */
+    Layer25 = 33554432,
+    /** Layer 26. */
+    Layer26 = 67108864,
+    /** Layer 27. */
+    Layer27 = 134217728,
+    /** Layer 28. */
+    Layer28 = 268435456,
+    /** Layer 29. */
+    Layer29 = 536870912,
+    /** Layer 30. */
+    Layer30 = 1073741824,
+    /** Layer 31. */
+    Layer31 = 2147483648,
+    /** All layers. */
+    Everything = 4294967295,
+    /** None layer. */
+    Nothing = 0
+}

package/types/ListenerUpdateFlag.d.ts

@@ -0,0 +1,12 @@
+import { UpdateFlag } from "./UpdateFlag";
+/**
+ * Used to update tags.
+ */
+export declare class ListenerUpdateFlag extends UpdateFlag {
+    /** Listener. */
+    listener: Function;
+    /**
+     * @inheritdoc
+     */
+    dispatch(param?: Object): void;
+}

package/types/Platform.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The platform (including operating system and hardware) is running on.
+ */
+export declare enum Platform {
+    /** Android platform. */
+    Android = 0,
+    /** IPhone platform. */
+    IPhone = 1,
+    /** IPad platform. */
+    IPad = 2,
+    /** Mac platform. */
+    Mac = 3,
+    /** Unknown platform. */
+    Unknown = 4
+}

package/types/RenderPipeline/Basic2DBatcher.d.ts

@@ -0,0 +1,20 @@
+import { Camera } from "../Camera";
+import { Engine } from "../Engine";
+import { Material } from "../material";
+import { SpriteElement } from "./SpriteElement";
+import { SpriteMaskElement } from "./SpriteMaskElement";
+import { TextRenderElement } from "./TextRenderElement";
+export declare abstract class Basic2DBatcher {
+    /** 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;
+    clear(): void;
+    destroy(): void;
+    private _createMesh;
+    private _updateData;
+    private _getSubMeshFromPool;
+}

package/types/RenderPipeline/BasicRenderPipeline.d.ts

@@ -0,0 +1,66 @@
+import { Camera } from "../Camera";
+import { Layer } from "../Layer";
+import { Material } from "../material";
+import { RenderTarget, TextureCubeFace } from "../texture";
+import { RenderContext } from "./RenderContext";
+import { RenderElement } from "./RenderElement";
+import { RenderPass } from "./RenderPass";
+/**
+ * Basic render pipeline.
+ */
+export declare class BasicRenderPipeline {
+    private static _tempVector0;
+    private static _tempVector1;
+    private _camera;
+    private _defaultPass;
+    private _renderPassArray;
+    private _lastCanvasSize;
+    private _cascadedShadowCaster;
+    /**
+     * Create a basic render pipeline.
+     * @param camera - Camera
+     */
+    constructor(camera: Camera);
+    /**
+     * Default render pass.
+     */
+    get defaultRenderPass(): RenderPass;
+    /**
+     * Add render pass.
+     * @param nameOrPass - The name of this Pass or RenderPass object. When it is a name, the following parameters need to be provided
+     * @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 mask - Perform bit and operations with Entity.Layer to filter the objects that this Pass needs to render
+     */
+    addRenderPass(nameOrPass: string | RenderPass, priority?: number, renderTarget?: RenderTarget, replaceMaterial?: Material, mask?: Layer): void;
+    /**
+     * Remove render pass by name or render pass object.
+     * @param nameOrPass - Render pass name or render pass object
+     */
+    removeRenderPass(nameOrPass: string | RenderPass): void;
+    /**
+     * Get render pass by name.
+     * @param  name - Render pass name
+     */
+    getRenderPass(name: string): RenderPass;
+    /**
+     * Destroy internal resources.
+     */
+    destroy(): void;
+    /**
+     * Perform scene rendering.
+     * @param context - Render context
+     * @param cubeFace - Render surface of cube texture
+     * @param mipLevel - Set mip level the data want to write
+     */
+    render(context: RenderContext, cubeFace?: TextureCubeFace, mipLevel?: number): void;
+    private _drawRenderPass;
+    /**
+     * Push a render element to the render queue.
+     * @param element - Render element
+     */
+    pushPrimitive(element: RenderElement): void;
+    private _drawBackgroundTexture;
+    private _callRender;
+}

package/types/RenderPipeline/ClassPool.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Class pool utils.
+ */
+export declare class ClassPool<T> {
+    private _elementPoolIndex;
+    private _elementPool;
+    private _type;
+    constructor(type: new () => T);
+    /**
+     * Get element from pool.
+     */
+    getFromPool(): T;
+    /**
+     * Reset pool.
+     */
+    resetPool(): void;
+}

package/types/RenderPipeline/MeshRenderData.d.ts

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

package/types/RenderPipeline/MeshRenderElement.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 { ShaderPass } from "../shader/ShaderPass";
+import { RenderState } from "../shader/state/RenderState";
+import { RenderElement } from "./RenderElement";
+/**
+ * Render element.
+ */
+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;
+}

package/types/RenderPipeline/RenderContext.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

@@ -0,0 +1,11 @@
+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;
+}

package/types/RenderPipeline/RenderPass.d.ts

@@ -0,0 +1,55 @@
+import { Color } from "@galacean/engine-math";
+import { Camera } from "../Camera";
+import { CameraClearFlags } from "../enums/CameraClearFlags";
+import { Layer } from "../Layer";
+import { Material } from "../material/Material";
+import { RenderTarget } from "../texture/RenderTarget";
+import { RenderQueue } from "./RenderQueue";
+/**
+ * RenderPass.
+ */
+declare class RenderPass {
+    name: string;
+    enabled: boolean;
+    priority: number;
+    renderTarget: RenderTarget;
+    replaceMaterial: Material;
+    mask: Layer;
+    renderOverride: boolean;
+    clearFlags: CameraClearFlags | undefined;
+    clearColor: Color | undefined;
+    /**
+     * Create a 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 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);
+    /**
+     * Rendering callback, will be executed if renderOverride is set to true.
+     * @param camera - Camera
+     * @param opaqueQueue - Opaque queue
+     * @param alphaTestQueue - Alpha test queue
+     * @param transparentQueue - Transparent queue
+     */
+    render(camera: Camera, opaqueQueue: RenderQueue, alphaTestQueue: RenderQueue, transparentQueue: RenderQueue): void;
+    /**
+     * Post rendering callback.
+     * @param camera - Camera
+     * @param opaqueQueue - Opaque queue
+     * @param alphaTestQueue - Alpha test queue
+     * @param transparentQueue - Transparent queue
+     */
+    preRender(camera: Camera, opaqueQueue: RenderQueue, alphaTestQueue: RenderQueue, transparentQueue: RenderQueue): void;
+    /**
+     * Post rendering callback.
+     * @param camera - Camera
+     * @param opaqueQueue - Opaque queue
+     * @param alphaTestQueue - Alpha test queue
+     * @param transparentQueue - Transparent queue
+     */
+    postRender(camera: Camera, opaqueQueue: RenderQueue, alphaTestQueue: RenderQueue, transparentQueue: RenderQueue): void;
+}
+export { RenderPass };

package/types/RenderPipeline/RenderQueue.d.ts

@@ -0,0 +1,38 @@
+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[];
+    private _spriteBatcher;
+    constructor(engine: Engine);
+    /**
+     * Push a render element.
+     */
+    pushPrimitive(element: RenderElement): void;
+    render(camera: Camera, replaceMaterial: Material, mask: Layer, customShader: Shader): void;
+    /**
+     * Clear collection.
+     */
+    clear(): void;
+    /**
+     * Destroy internal resources.
+     */
+    destroy(): void;
+    /**
+     * Sort the elements.
+     */
+    sort(compareFunc: Function): void;
+    /**
+     * @remarks
+     * Modified based on v8.
+     * https://github.com/v8/v8/blob/7.2-lkgr/src/js/array.js
+     */
+    private _quickSort;
+    private _insertionSort;
+}

package/types/RenderPipeline/SpriteBatcher.d.ts

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

package/types/RenderPipeline/SpriteElement.d.ts

@@ -0,0 +1,13 @@
+import { RenderData2D } from "../2d/data/RenderData2D";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { ShaderPass } from "../shader";
+import { RenderState } from "../shader/state/RenderState";
+import { Texture2D } from "../texture";
+import { RenderElement } from "./RenderElement";
+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;
+}

package/types/RenderPipeline/SpriteMaskBatcher.d.ts

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

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

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

package/types/RenderPipeline/SpriteMaskRenderData.d.ts

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

package/types/RenderPipeline/SpriteRenderData.d.ts

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

package/types/RenderPipeline/TextRenderData.d.ts

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

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