@galacean/engine-core 1.0.0-beta.1 → 1.0.0-beta.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-core",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.11",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -15,10 +15,10 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-math": "1.0.0-beta.1"
+    "@galacean/engine-math": "1.0.0-beta.11"
   },
   "devDependencies": {
-    "@galacean/engine-design": "1.0.0-beta.1"
+    "@galacean/engine-design": "1.0.0-beta.11"
   },
   "scripts": {
     "b:types": "tsc"

package/types/2d/atlas/SpriteAtlas.d.ts

@@ -29,5 +29,4 @@ export declare class SpriteAtlas extends ReferResource {
      * @param engine - Engine to which the SpriteAtlas belongs
      */
     constructor(engine: Engine);
-    protected _onDestroy(): void;
 }

package/types/2d/sprite/Sprite.d.ts

@@ -8,8 +8,10 @@ import { Texture2D } from "../../texture/Texture2D";
 export declare class Sprite extends ReferResource {
     /** The name of sprite. */
     name: string;
-    private _width;
-    private _height;
+    private _automaticWidth;
+    private _automaticHeight;
+    private _customWidth;
+    private _customHeight;
     private _positions;
     private _uvs;
     private _bounds;
@@ -28,11 +30,19 @@ export declare class Sprite extends ReferResource {
     set texture(value: Texture2D);
     /**
      * The width of the sprite (in world coordinates).
+     *
+     * @remarks
+     * If width is set, return the set value,
+     * otherwise return the width calculated according to `Texture.width`, `Sprite.region`, `Sprite.atlasRegion`, `Sprite.atlasRegionOffset` and `Engine._pixelsPerUnit`.
      */
     get width(): number;
     set width(value: number);
     /**
      * The height of the sprite (in world coordinates).
+     *
+     * @remarks
+     * If height is set, return the set value,
+     * otherwise return the height calculated according to `Texture.height`, `Sprite.region`, `Sprite.atlasRegion`, `Sprite.atlasRegionOffset` and `Engine._pixelsPerUnit`.
      */
     get height(): number;
     set height(value: number);
@@ -86,7 +96,6 @@ export declare class Sprite extends ReferResource {
      * @returns Cloned sprite
      */
     clone(): Sprite;
-    protected _onDestroy(): void;
     private _calDefaultSize;
     private _updatePositions;
     private _updateUVs;

package/types/2d/sprite/SpriteMask.d.ts

@@ -1,27 +1,34 @@
-import { BoundingBox } from "@galacean/engine-math";
-import { RenderContext } from "../../RenderPipeline/RenderContext";
 import { Renderer } from "../../Renderer";
-import { ICustomClone } from "../../clone/ComponentCloner";
 import { Sprite } from "./Sprite";
 /**
  * A component for masking Sprites.
  */
-export declare class SpriteMask extends Renderer implements ICustomClone {
+export declare class SpriteMask extends Renderer {
     /** The mask layers the sprite mask influence to. */
     influenceLayers: number;
     private _sprite;
-    private _width;
-    private _height;
+    private _automaticWidth;
+    private _automaticHeight;
+    private _customWidth;
+    private _customHeight;
     private _flipX;
     private _flipY;
     private _alphaCutoff;
     /**
-     * Render width.
+     * Render width (in world coordinates).
+     *
+     * @remarks
+     * If width is set, return the set value,
+     * otherwise return `SpriteMask.sprite.width`.
      */
     get width(): number;
     set width(value: number);
     /**
-     * Render height.
+     * Render height (in world coordinates).
+     *
+     * @remarks
+     * If height is set, return the set value,
+     * otherwise return `SpriteMask.sprite.height`.
      */
     get height(): number;
     set height(value: number);
@@ -45,14 +52,6 @@ export declare class SpriteMask extends Renderer implements ICustomClone {
      */
     get alphaCutoff(): number;
     set alphaCutoff(value: number);
-    protected _updateBounds(worldBounds: BoundingBox): void;
-    /**
-     * @inheritdoc
-     */
-    protected _render(context: RenderContext): void;
-    /**
-     * @inheritdoc
-     */
-    protected _onDestroy(): void;
+    private _calDefaultSize;
     private _onSpriteChange;
 }

package/types/2d/sprite/SpriteRenderer.d.ts

@@ -1,7 +1,5 @@
-import { BoundingBox, Color } from "@galacean/engine-math";
-import { RenderContext } from "../../RenderPipeline/RenderContext";
+import { Color } from "@galacean/engine-math";
 import { Renderer } from "../../Renderer";
-import { ICustomClone } from "../../clone/ComponentCloner";
 import { SpriteDrawMode } from "../enums/SpriteDrawMode";
 import { SpriteMaskInteraction } from "../enums/SpriteMaskInteraction";
 import { SpriteTileMode } from "../enums/SpriteTileMode";
@@ -9,15 +7,17 @@ import { Sprite } from "./Sprite";
 /**
  * Renders a Sprite for 2D graphics.
  */
-export declare class SpriteRenderer extends Renderer implements ICustomClone {
+export declare class SpriteRenderer extends Renderer {
     private _drawMode;
     private _assembler;
     private _tileMode;
     private _tiledAdaptiveThreshold;
     private _color;
     private _sprite;
-    private _width;
-    private _height;
+    private _automaticWidth;
+    private _automaticHeight;
+    private _customWidth;
+    private _customHeight;
     private _flipX;
     private _flipY;
     private _maskLayer;
@@ -48,12 +48,20 @@ export declare class SpriteRenderer extends Renderer implements ICustomClone {
     get color(): Color;
     set color(value: Color);
     /**
-     * Render width.
+     * Render width (in world coordinates).
+     *
+     * @remarks
+     * If width is set, return the set value,
+     * otherwise return `SpriteRenderer.sprite.width`.
      */
     get width(): number;
     set width(value: number);
     /**
-     * Render height.
+     * Render height (in world coordinates).
+     *
+     * @remarks
+     * If height is set, return the set value,
+     * otherwise return `SpriteRenderer.sprite.height`.
      */
     get height(): number;
     set height(value: number);
@@ -77,9 +85,7 @@ export declare class SpriteRenderer extends Renderer implements ICustomClone {
      */
     get maskInteraction(): SpriteMaskInteraction;
     set maskInteraction(value: SpriteMaskInteraction);
-    protected _updateShaderData(context: RenderContext): void;
-    protected _updateBounds(worldBounds: BoundingBox): void;
-    protected _render(context: RenderContext): void;
+    private _calDefaultSize;
     private _updateStencilState;
     private _onSpriteChange;
 }

package/types/2d/text/Font.d.ts

@@ -18,5 +18,4 @@ export declare class Font extends ReferResource {
      */
     get name(): string;
     constructor(engine: Engine, name?: string);
-    protected _onDestroy(): void;
 }

package/types/2d/text/TextRenderer.d.ts

@@ -1,9 +1,6 @@
 import { BoundingBox, Color } from "@galacean/engine-math";
 import { Entity } from "../../Entity";
-import { RenderContext } from "../../RenderPipeline/RenderContext";
 import { Renderer } from "../../Renderer";
-import { TransformModifyFlags } from "../../Transform";
-import { ICustomClone } from "../../clone/ComponentCloner";
 import { FontStyle } from "../enums/FontStyle";
 import { SpriteMaskInteraction } from "../enums/SpriteMaskInteraction";
 import { TextHorizontalAlignment, TextVerticalAlignment } from "../enums/TextAlignment";
@@ -12,7 +9,7 @@ import { Font } from "./Font";
 /**
  * Renders a text for 2D graphics.
  */
-export declare class TextRenderer extends Renderer implements ICustomClone {
+export declare class TextRenderer extends Renderer {
     private static _charRenderDataPool;
     private static _tempVec30;
     private static _tempVec31;
@@ -107,13 +104,8 @@ export declare class TextRenderer extends Renderer implements ICustomClone {
      */
     get bounds(): BoundingBox;
     constructor(entity: Entity);
-    protected _onDestroy(): void;
-    protected _updateShaderData(context: RenderContext): void;
-    protected _updateBounds(worldBounds: BoundingBox): void;
-    protected _render(context: RenderContext): void;
     private _updateStencilState;
     private _resetSubFont;
     private _updatePosition;
     private _updateLocalData;
-    protected _onTransformChanged(bit: TransformModifyFlags): void;
 }

package/types/Camera.d.ts

@@ -12,8 +12,6 @@ import { RenderTarget } from "./texture/RenderTarget";
  * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
  */
 export declare class Camera extends Component {
-    /** Shader data. */
-    readonly shaderData: ShaderData;
     /** Rendering priority - A Camera with higher priority will be rendered on top of a camera with lower priority. */
     priority: number;
     /** Whether to enable frustum culling, it is enabled by default. */
@@ -28,6 +26,7 @@ export declare class Camera extends Component {
      * @remarks Support bit manipulation, corresponding to `Layer`.
      */
     cullingMask: Layer;
+    private _shaderData;
     private _isProjMatSetting;
     private _nearClipPlane;
     private _farClipPlane;
@@ -46,6 +45,10 @@ export declare class Camera extends Component {
     private _inverseProjectionMatrix;
     private _lastAspectSize;
     private _invViewProjMat;
+    /**
+     * Shader data.
+     */
+    get shaderData(): ShaderData;
     /**
      * Near clip plane - the closest point to the camera when rendering occurs.
      */
@@ -211,10 +214,6 @@ export declare class Camera extends Component {
      * @inheritdoc
      */
     _onDisable(): void;
-    /**
-     * @inheritdoc
-     */
-    protected _onDestroy(): void;
     private _projMatChange;
     private _innerViewportToWorldPoint;
     private _updateShaderData;

package/types/Component.d.ts

@@ -21,5 +21,4 @@ export declare class Component extends EngineObject {
      */
     get scene(): Scene;
     constructor(entity: Entity);
-    protected _onDestroy(): void;
 }

package/types/Engine.d.ts

@@ -17,7 +17,6 @@ export declare class Engine extends EventDispatcher {
     readonly physicsManager: PhysicsManager;
     /** Input manager of Engine. */
     readonly inputManager: InputManager;
-    protected _canvas: Canvas;
     private _settings;
     private _resourceManager;
     private _sceneManager;
@@ -115,7 +114,6 @@ export declare class Engine extends EventDispatcher {
      * @remarks If call during frame execution will delay until the end of the frame
      */
     destroy(): void;
-    protected _initialize(configuration: EngineConfiguration): Promise<Engine>;
     private _createSpriteMaterial;
     private _createSpriteMaskMaterial;
     private _onDeviceLost;

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

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

package/types/RenderPipeline/MeshRenderData.d.ts

@@ -2,14 +2,16 @@ 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 {
+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/RenderElement.d.ts

@@ -1,9 +1,11 @@
 import { ShaderPass } from "../shader/ShaderPass";
 import { RenderState } from "../shader/state/RenderState";
+import { IPoolElement } from "./IPoolElement";
 import { RenderData } from "./RenderData";
-export declare class RenderElement {
+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/SpriteMaskRenderData.d.ts

@@ -1,10 +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 {
+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

@@ -2,11 +2,13 @@ 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 {
+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

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

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 { ICustomClone } from "./clone/ComponentCloner";
 import { Material } from "./material";
 import { ShaderData } from "./shader/ShaderData";
 /**
  * Basis for all renderers.
  * @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

@@ -18,10 +18,6 @@ export declare class Scene extends EngineObject {
     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. */
@@ -32,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;
@@ -40,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

@@ -118,5 +118,4 @@ export declare class Script extends Component {
      * Called at the end of the destroyed frame.
      */
     onDestroy(): void;
-    protected _onDestroy(): void;
 }

package/types/animation/Animator.d.ts

@@ -14,8 +14,7 @@ export declare class Animator extends Component {
     protected _animatorController: AnimatorController;
     protected _controllerUpdateFlag: BoolUpdateFlag;
     private _animatorLayersData;
-    private _crossOwnerCollection;
-    private _animationCurveOwners;
+    private _curveOwnerPool;
     private _animationEventHandlerPool;
     private _tempAnimatorStateInfo;
     private _controlledRenderers;
@@ -61,7 +60,7 @@ export declare class Animator extends Component {
     private _saveAnimatorStateData;
     private _saveAnimatorEventHandlers;
     private _clearCrossData;
-    private _addCrossCurveData;
+    private _addCrossOwner;
     private _prepareCrossFading;
     private _prepareStandbyCrossFading;
     private _prepareFixedPoseCrossFading;

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

@@ -2,5 +2,4 @@ import { Engine } from "../Engine";
 import { ReferResource } from "./ReferResource";
 export declare abstract class GraphicsResource extends ReferResource {
     protected constructor(engine: Engine);
-    protected _onDestroy(): void;
 }

package/types/asset/ReferResource.d.ts

@@ -19,5 +19,4 @@ export declare abstract class ReferResource extends EngineObject implements IRef
      * @returns Whether the release was successful.
      */
     destroy(force?: boolean): boolean;
-    protected _onDestroy(): void;
 }

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,7 +9,6 @@ export declare class CubeProbe extends Probe {
      * The position of the probe can be set, the default is the origin [0,0,0].
      */
     position: Vector3;
-    protected readonly _isCube: boolean;
     private oriViewMatrix;
     private _oriFieldOfView;
     onBeginRender(camera: Camera): void;

package/types/graphic/Buffer.d.ts

@@ -91,7 +91,6 @@ export declare class Buffer extends GraphicsResource {
      */
     getData(data: ArrayBufferView, bufferByteOffset: number, dataOffset: number, dataLength: number): void;
     _rebuild(): void;
-    protected _onDestroy(): void;
     /**
      * @deprecated
      */

package/types/graphic/Mesh.d.ts

@@ -1,10 +1,8 @@
 import { BoundingBox } from "@galacean/engine-math";
-import { GraphicsResource } from "../asset/GraphicsResource";
 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.
  */
@@ -57,7 +55,5 @@ export declare abstract class Mesh extends GraphicsResource {
     clearSubMesh(): void;
     _addReferCount(value: number): void;
     _rebuild(): void;
-    protected _setVertexElements(elements: VertexElement[]): void;
-    protected _setIndexBufferBinding(binding: IndexBufferBinding | null): void;
     private _onBoundsChanged;
 }

package/types/graphic/SubMesh.d.ts

@@ -1,8 +1,9 @@
+import { IPoolElement } from "../RenderPipeline/IPoolElement";
 import { MeshTopology } from "./enums/MeshTopology";
 /**
  * Sub-mesh, mainly contains drawing information.
  */
-export declare class SubMesh {
+export declare class SubMesh implements IPoolElement {
     /** Start drawing offset. */
     start: number;
     /** Drawing count. */
@@ -16,4 +17,5 @@ export declare class SubMesh {
      * @param topology - Drawing topology
      */
     constructor(start?: number, count?: number, topology?: MeshTopology);
+    dispose?(): void;
 }

package/types/index.d.ts

@@ -22,7 +22,7 @@ export { AssetPromise } from "./asset/AssetPromise";
 export type { LoadItem } from "./asset/LoadItem";
 export { AssetType } from "./asset/AssetType";
 export { ReferResource } from "./asset/ReferResource";
-export * from "./RenderPipeline";
+export * from "./RenderPipeline/Index";
 export * from "./base";
 export { Background } from "./Background";
 export { BackgroundMode } from "./enums/BackgroundMode";

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