@galacean/engine-core 1.0.0-beta.9 → 1.0.1

package/package.json

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

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

@@ -100,4 +100,7 @@ export declare class Sprite extends ReferResource {
     private _updatePositions;
     private _updateUVs;
     private _dispatchSpriteChange;
+    private _onRegionChange;
+    private _onPivotChange;
+    private _onBorderChange;
 }

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

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

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

@@ -1,6 +1,5 @@
 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";
@@ -8,7 +7,7 @@ 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;

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

@@ -1,7 +1,6 @@
 import { BoundingBox, Color } from "@galacean/engine-math";
 import { Entity } from "../../Entity";
 import { Renderer } from "../../Renderer";
-import { ICustomClone } from "../../clone/ComponentCloner";
 import { FontStyle } from "../enums/FontStyle";
 import { SpriteMaskInteraction } from "../enums/SpriteMaskInteraction";
 import { TextHorizontalAlignment, TextVerticalAlignment } from "../enums/TextAlignment";
@@ -10,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;

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

package/types/ComponentsManager.d.ts

@@ -2,6 +2,7 @@ import { Camera } from "./Camera";
 import { Component } from "./Component";
 import { Renderer } from "./Renderer";
 import { Script } from "./Script";
+import { Animator } from "./animation";
 /**
  * The manager of the components.
  */
@@ -26,8 +27,8 @@ export declare class ComponentsManager {
     removeOnLateUpdateScript(script: Script): void;
     addOnPhysicsUpdateScript(script: Script): void;
     removeOnPhysicsUpdateScript(script: Script): void;
-    addOnUpdateAnimations(animation: Component): void;
-    removeOnUpdateAnimations(animation: Component): void;
+    addOnUpdateAnimations(animation: Animator): void;
+    removeOnUpdateAnimations(animation: Animator): void;
     addOnUpdateRenderers(renderer: Renderer): void;
     removeOnUpdateRenderers(renderer: Renderer): void;
     addDisableScript(component: Script): void;

package/types/DisorderedArray.d.ts

@@ -7,11 +7,12 @@ export declare class DisorderedArray<T> {
     constructor(count?: number);
     add(element: T): void;
     delete(element: T): void;
+    set(index: number, element: T): void;
     get(index: number): T;
     /**
-     *
-     * @param index
-     * @returns The replaced item is used to reset its index.
+     * Delete the element at the specified index.
+     * @param index - The index of the element to be deleted
+     * @returns The replaced item is used to reset its index
      */
     deleteByIndex(index: number): T;
     garbageCollection(): void;

package/types/Engine.d.ts

@@ -1,14 +1,14 @@
 import { IPhysics } from "@galacean/engine-design";
-import { ResourceManager } from "./asset/ResourceManager";
-import { EventDispatcher, Time } from "./base";
 import { Canvas } from "./Canvas";
 import { EngineSettings } from "./EngineSettings";
 import { Entity } from "./Entity";
+import { SceneManager } from "./SceneManager";
+import { ResourceManager } from "./asset/ResourceManager";
+import { EventDispatcher, Time } from "./base";
 import { ColorSpace } from "./enums/ColorSpace";
 import { InputManager } from "./input";
 import { PhysicsManager } from "./physics";
 import { IHardwareRenderer } from "./renderingHardwareInterface";
-import { SceneManager } from "./SceneManager";
 /**
  * Engine.
  */
@@ -32,6 +32,7 @@ export declare class Engine extends EventDispatcher {
     private _frameInProcess;
     private _waitingDestroy;
     private _isDeviceLost;
+    private _waitingGC;
     private _animate;
     /**
      * Settings of Engine.
@@ -118,6 +119,7 @@ export declare class Engine extends EventDispatcher {
     private _createSpriteMaskMaterial;
     private _onDeviceLost;
     private _onDeviceRestored;
+    private _gc;
 }
 /**
  * Engine configuration.

package/types/Entity.d.ts

@@ -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/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

@@ -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/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,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/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/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,12 +1,13 @@
 import { BoundingBox, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
+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;
@@ -16,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;
@@ -30,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.
      */

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/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();
+}

package/types/Transform.d.ts

@@ -195,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/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,9 +71,12 @@ export declare class Animator extends Component {
     private _updatePlayingState;
     private _updateCrossFade;
     private _updateCrossFadeFromPose;
+    private _updateFinishedState;
     private _updateCrossFadeData;
     private _preparePlay;
     private _checkTransition;
+    private _checkSubTransition;
+    private _checkBackwardsSubTransition;
     private _crossFadeByTransition;
     private _fireAnimationEvents;
     private _fireSubAnimationEvents;
@@ -83,4 +85,5 @@ export declare class Animator extends Component {
     private _callAnimatorScriptOnUpdate;
     private _callAnimatorScriptOnExit;
     private _checkAutoPlay;
+    private _checkRevertOwner;
 }

package/types/animation/animationCurve/AnimationRectCurve.d.ts

@@ -0,0 +1,8 @@
+import { Rect } from "@galacean/engine-math";
+import { AnimationCurve } from "./AnimationCurve";
+/**
+ * Store a collection of Keyframes that can be evaluated over time.
+ */
+export declare class AnimationRectCurve extends AnimationCurve<Rect> {
+    constructor();
+}

package/types/animation/animationCurve/AnimationRefCurve.d.ts

@@ -0,0 +1,8 @@
+import { ReferResource } from "../../asset/ReferResource";
+import { AnimationCurve } from "./AnimationCurve";
+/**
+ * Store a collection of Keyframes that can be evaluated over time.
+ */
+export declare class AnimationRefCurve extends AnimationCurve<ReferResource> {
+    constructor();
+}

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/animation/internal/AnimationCurveLayerOwner.d.ts

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

package/types/animation/internal/AnimationCurveOwnerLayerData.d.ts

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

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

@@ -17,9 +17,13 @@ export declare class MultiExecutor {
     private interval;
     private _timeoutId;
     private _currentCount;
+    private _onComplete;
+    private _onError;
+    private _error;
     constructor(execFunc: (count?: number) => Promise<any>, totalCount: number, interval: number);
-    private done;
-    start(done?: Function): void;
-    stop(): void;
+    start(): this;
+    onComplete(func: Function): this;
+    onError(func: Function): this;
+    cancel(): void;
     private exec;
 }

package/types/base/EventDispatcher.d.ts

@@ -2,9 +2,9 @@
  * EventDispatcher, which can be inherited as a base class.
  */
 export declare class EventDispatcher {
+    private static _dispatchingListenersPool;
     private _events;
     private _eventCount;
-    private _dispatchingListeners;
     /**
      * Determine whether there is event listening.
      * @param event - Event name

package/types/enums/ActiveChangeFlag.d.ts

@@ -0,0 +1,6 @@
+export declare enum ActiveChangeFlag {
+    None = 0,
+    Scene = 1,
+    Hierarchy = 2,
+    All = 3
+}

package/types/enums/DepthTextureMode.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Depth texture mode.
+ */
+export declare enum DepthTextureMode {
+    None = 0,
+    PrePass = 1
+}

package/types/graphic/Primitive.d.ts

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

package/types/graphic/PrimitiveVertexBinding.d.ts

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