@galacean/engine-core 1.0.0-beta.0 → 1.0.0-beta.10

package/package.json

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

package/types/2d/data/RenderData2D.d.ts

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

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

@@ -1,6 +1,6 @@
 import { Rect, Vector2, Vector4 } from "@galacean/engine-math";
-import { ReferResource } from "../../asset/ReferResource";
 import { Engine } from "../../Engine";
+import { ReferResource } from "../../asset/ReferResource";
 import { Texture2D } from "../../texture/Texture2D";
 /**
  * 2D sprite.
@@ -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);

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

@@ -1,27 +1,34 @@
-import { BoundingBox } from "@galacean/engine-math";
-import { ICustomClone } from "../../clone/ComponentCloner";
 import { Renderer } from "../../Renderer";
-import { RenderContext } from "../../RenderPipeline/RenderContext";
 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,19 +52,6 @@ export declare class SpriteMask extends Renderer implements ICustomClone {
      */
     get alphaCutoff(): number;
     set alphaCutoff(value: number);
-    /**
-     * @override
-     */
-    protected _updateBounds(worldBounds: BoundingBox): void;
-    /**
-     * @override
-     * @inheritdoc
-     */
-    protected _render(context: RenderContext): void;
-    /**
-     * @override
-     * @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 { ICustomClone } from "../../clone/ComponentCloner";
+import { Color } from "@galacean/engine-math";
 import { Renderer } from "../../Renderer";
-import { RenderContext } from "../../RenderPipeline/RenderContext";
 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,18 +85,7 @@ export declare class SpriteRenderer extends Renderer implements ICustomClone {
      */
     get maskInteraction(): SpriteMaskInteraction;
     set maskInteraction(value: SpriteMaskInteraction);
-    /**
-     * @override
-     */
-    protected _updateShaderData(context: RenderContext): void;
-    /**
-     * @override
-     */
-    protected _updateBounds(worldBounds: BoundingBox): void;
-    /**
-     * @override
-     */
-    protected _render(context: RenderContext): void;
+    private _calDefaultSize;
     private _updateStencilState;
     private _onSpriteChange;
 }

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

@@ -1,9 +1,6 @@
 import { BoundingBox, Color } from "@galacean/engine-math";
-import { ICustomClone } from "../../clone/ComponentCloner";
 import { Entity } from "../../Entity";
 import { Renderer } from "../../Renderer";
-import { RenderContext } from "../../RenderPipeline/RenderContext";
-import { TransformModifyFlags } from "../../Transform";
 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,21 +104,8 @@ export declare class TextRenderer extends Renderer implements ICustomClone {
      */
     get bounds(): BoundingBox;
     constructor(entity: Entity);
-    /**
-     * @override
-     */
-    protected _updateShaderData(context: RenderContext): void;
-    /**
-     * @override
-     */
-    protected _updateBounds(worldBounds: BoundingBox): void;
-    /**
-     * @override
-     */
-    protected _render(context: RenderContext): void;
     private _updateStencilState;
     private _resetSubFont;
     private _updatePosition;
     private _updateLocalData;
-    protected _onTransformChanged(bit: TransformModifyFlags): void;
 }

package/types/Camera.d.ts

@@ -204,20 +204,13 @@ export declare class Camera extends Component {
      */
     resetReplacementShader(): void;
     /**
-     * @override
      * @inheritdoc
      */
     _onEnable(): void;
     /**
-     * @override
      * @inheritdoc
      */
     _onDisable(): void;
-    /**
-     * @override
-     * @inheritdoc
-     */
-    protected _onDestroy(): void;
     private _projMatChange;
     private _innerViewportToWorldPoint;
     private _updateShaderData;

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/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.
  */

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

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

package/types/RenderPipeline/TextRenderElement.d.ts

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

package/types/Renderer.d.ts

@@ -1,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 { ShaderData } from "./shader/ShaderData";
+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;
@@ -108,12 +107,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";

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/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/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,8 +2,4 @@ import { Engine } from "../Engine";
 import { ReferResource } from "./ReferResource";
 export declare abstract class GraphicsResource extends ReferResource {
     protected constructor(engine: Engine);
-    /**
-     * @override
-     */
-    protected _onDestroy(): void;
 }

package/types/asset/IRefObject.d.ts

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

package/types/asset/RefObject.d.ts

@@ -0,0 +1,27 @@
+import { EngineObject } from "../base/EngineObject";
+import { Engine } from "../Engine";
+import { IRefObject } from "./IRefObject";
+/**
+ * The base class of assets, with reference counting capability.
+ */
+export declare abstract class RefObject extends EngineObject implements IRefObject {
+    /** Whether to ignore the garbage collection check, if it is true, it will not be affected by ResourceManager.gc(). */
+    isGCIgnored: boolean;
+    private _refCount;
+    /**
+     * Counted by valid references.
+     */
+    get refCount(): number;
+    protected constructor(engine: Engine);
+    /**
+     * Destroy self.
+     * @param force - Whether to force the destruction, if it is false, refCount = 0 can be released successfully.
+     * @returns Whether the release was successful.
+     */
+    destroy(force?: boolean): boolean;
+    /**
+     * Called when the resource is destroyed.
+     * Subclasses can override this function.
+     */
+    protected abstract _onDestroy(): void;
+}

package/types/asset/ReferResource.d.ts

@@ -14,14 +14,9 @@ export declare abstract class ReferResource extends EngineObject implements IRef
     get refCount(): number;
     protected constructor(engine: Engine);
     /**
-     * @override
      * Destroy self.
      * @param force - Whether to force the destruction, if it is false, refCount = 0 can be released successfully.
      * @returns Whether the release was successful.
      */
     destroy(force?: boolean): boolean;
-    /**
-     * @override
-     */
-    protected _onDestroy(): void;
 }

package/types/base/Event.d.ts

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

package/types/base/Util.d.ts

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

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

package/types/env-probe/Probe.d.ts

@@ -46,13 +46,7 @@ export declare abstract class Probe extends Script {
      * @remarks Prevent issue: Feedback Loops Between Textures and the Framebuffer.
      */
     onTextureChange(renderColorTexture: Texture): void;
-    /**
-     * @override
-     */
     onBeginRender(camera: Camera): void;
-    /**
-     * @override
-     */
     onEndRender(camera: Camera): void;
     protected _reset(): void;
 }

package/types/graphic/Buffer.d.ts

@@ -90,9 +90,6 @@ export declare class Buffer extends GraphicsResource {
      * @param dataLength - Output data length
      */
     getData(data: ArrayBufferView, bufferByteOffset: number, dataOffset: number, dataLength: number): void;
-    /**
-     * @override
-     */
     _rebuild(): 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.
  */
@@ -55,15 +53,7 @@ export declare abstract class Mesh extends GraphicsResource {
      * Clear all sub-mesh.
      */
     clearSubMesh(): void;
-    /**
-     * @override
-     */
     _addReferCount(value: number): void;
-    /**
-     * @override
-     */
     _rebuild(): void;
-    protected _setVertexElements(elements: VertexElement[]): void;
-    protected _setIndexBufferBinding(binding: IndexBufferBinding | null): void;
     private _onBoundsChanged;
 }

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