@galacean/engine-core 1.3.0-alpha.3 → 1.3.0-beta.10

package/package.json

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

package/types/Entity.d.ts

@@ -58,9 +58,10 @@ export declare class Entity extends EngineObject {
     /**
      * Add component based on the component type.
      * @param type - The type of the component
+     * @param args - The arguments of the component
      * @returns	The component which has been added
      */
-    addComponent<T extends Component>(type: new (entity: Entity) => T): T;
+    addComponent<T extends new (entity: Entity, ...args: any[]) => Component>(type: T, ...args: ComponentArguments<T>): InstanceType<T>;
     /**
      * Get component which match the type.
      * @param type - The type of the component
@@ -152,3 +153,5 @@ export declare class Entity extends EngineObject {
      */
     getInvModelMatrix(): Matrix;
 }
+type ComponentArguments<T extends new (entity: Entity, ...args: any[]) => Component> = T extends new (entity: Entity, ...args: infer P) => Component ? P : never;
+export {};

package/types/Renderer.d.ts

@@ -1,6 +1,7 @@
 import { BoundingBox, Matrix, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
 import { RenderContext } from "./RenderPipeline/RenderContext";
+import { Transform } from "./Transform";
 import { IComponentCustomClone } from "./clone/ComponentCloner";
 import { Material } from "./material";
 import { ShaderData } from "./shader/ShaderData";
@@ -23,6 +24,7 @@ export declare class Renderer extends Component implements IComponentCustomClone
     protected _materials: Material[];
     protected _dirtyUpdateFlag: number;
     protected _rendererLayer: Vector4;
+    protected _transform: Transform;
     private _shaderData;
     private _mvMatrix;
     private _mvpMatrix;
@@ -111,7 +113,10 @@ export declare class Renderer extends Component implements IComponentCustomClone
      */
     setMaterials(materials: Material[]): void;
     update(deltaTime: number): void;
-    protected _updateRendererShaderData(context: RenderContext): void;
+    /**
+     * Update once per frame per renderer, not influenced by batched.
+     */
+    protected _update(context: RenderContext): void;
     protected _updateWorldViewRelatedShaderData(context: RenderContext, worldMatrix: Matrix, batched: boolean): void;
     protected _updateProjectionRelatedShaderData(context: RenderContext, worldMatrix: Matrix, batched: boolean): void;
     private _setMaterial;

package/types/animation/Animator.d.ts

@@ -2,7 +2,7 @@ import { BoolUpdateFlag } from "../BoolUpdateFlag";
 import { Component } from "../Component";
 import { AnimatorController } from "./AnimatorController";
 import { AnimatorControllerLayer } from "./AnimatorControllerLayer";
-import { AnimatorControllerParameter } from "./AnimatorControllerParameter";
+import { AnimatorControllerParameter, AnimatorControllerParameterValue } from "./AnimatorControllerParameter";
 import { AnimatorState } from "./AnimatorState";
 import { AnimatorCullingMode } from "./enums/AnimatorCullingMode";
 /**
@@ -19,6 +19,7 @@ export declare class Animator extends Component {
     private _animatorLayersData;
     private _curveOwnerPool;
     private _animationEventHandlerPool;
+    private _parametersValueMap;
     private _tempAnimatorStateInfo;
     private _controlledRenderers;
     /**
@@ -75,6 +76,18 @@ export declare class Animator extends Component {
      * @param name - The name of the parameter
      */
     getParameter(name: string): AnimatorControllerParameter;
+    /**
+     * Get the value of the given parameter.
+     * @param name - The name of the parameter
+     * @param value - The value of the parameter
+     */
+    getParameterValue(name: string): AnimatorControllerParameterValue;
+    /**
+     * Set the value of the given parameter.
+     * @param name - The name of the parameter
+     * @param value - The value of the parameter
+     */
+    setParameterValue(name: string, value: AnimatorControllerParameterValue): void;
     private _getAnimatorStateInfo;
     private _getAnimatorStateData;
     private _saveAnimatorStateData;
@@ -87,7 +100,6 @@ export declare class Animator extends Component {
     private _prepareSrcCrossData;
     private _prepareDestCrossData;
     private _getAnimatorLayerData;
-    private _updateLayer;
     private _updateState;
     private _updatePlayingState;
     private _evaluatePlayingState;
@@ -115,4 +127,5 @@ export declare class Animator extends Component {
     private _callAnimatorScriptOnExit;
     private _checkAnyAndEntryState;
     private _checkRevertOwner;
+    private _fireAnimationEventsAndCallScripts;
 }

package/types/animation/AnimatorCondition.d.ts

@@ -1,4 +1,4 @@
-import { AnimatorControllerParameterValueType } from "./AnimatorControllerParameter";
+import { AnimatorControllerParameterValue } from "./AnimatorControllerParameter";
 import { AnimatorConditionMode } from "./enums/AnimatorConditionMode";
 /**
  * Condition that is used to determine if a transition must be taken.
@@ -9,5 +9,5 @@ export declare class AnimatorCondition {
     /** The name of the parameter used in the condition. */
     parameterName: string;
     /** The AnimatorParameter's threshold value for the condition to be true. */
-    threshold?: AnimatorControllerParameterValueType;
+    threshold?: AnimatorControllerParameterValue;
 }

package/types/animation/AnimatorController.d.ts

@@ -1,9 +1,11 @@
-import { AnimatorControllerParameter, AnimatorControllerParameterValueType } from "./AnimatorControllerParameter";
+import { AnimatorControllerParameter, AnimatorControllerParameterValue } from "./AnimatorControllerParameter";
 import { AnimatorControllerLayer } from "./AnimatorControllerLayer";
+import { ReferResource } from "../asset/ReferResource";
+import { Engine } from "../Engine";
 /**
  * Store the data for Animator playback.
  */
-export declare class AnimatorController {
+export declare class AnimatorController extends ReferResource {
     private _updateFlagManager;
     /**
      * The layers in the controller.
@@ -14,32 +16,30 @@ export declare class AnimatorController {
      */
     get parameters(): Readonly<AnimatorControllerParameter[]>;
     /**
-     * Add a parameter to the controller.
-     * @param name - The name of the parameter
-     * @param value - The value of the parameter
+     * Create an AnimatorController.
+     * @param engine - Engine to which the animatorController belongs
+     */
+    constructor(engine: Engine);
+    /**
+     * @deprecated
      */
-    addParameter(name: string, value?: AnimatorControllerParameterValueType): AnimatorControllerParameter;
+    constructor();
     /**
      * Add a parameter to the controller.
-     * @param parameter - The parameter
+     * @param name - The name of the parameter
+     * @param defaultValue - The default value of the parameter
      */
-    addParameter(parameter: AnimatorControllerParameter): AnimatorControllerParameter;
+    addParameter(name: string, defaultValue?: AnimatorControllerParameterValue): AnimatorControllerParameter;
     /**
-     * Remove a parameter from the controller.
-     * @param parameter - The parameter
+     * Remove a parameter from the controller by name.
+     * @param name - The parameter name
      */
-    removeParameter(parameter: AnimatorControllerParameter): void;
+    removeParameter(name: string): void;
     /**
      * Get the parameter by name.
      * @param name - The name of the parameter
      */
     getParameter(name: string): AnimatorControllerParameter;
-    /**
-     * Set the value of the given parameter.
-     * @param name - The name of the parameter
-     * @param value - The value of the parameter
-     */
-    setParameterValue(name: string, value: AnimatorControllerParameterValueType): void;
     /**
      * Get the layer by name.
      * @param name - The layer's name.

package/types/animation/AnimatorControllerParameter.d.ts

@@ -1,10 +1,14 @@
-export type AnimatorControllerParameterValueType = number | string | boolean;
+export type AnimatorControllerParameterValue = number | string | boolean;
 /**
  * Used to communicate between scripting and the controller, parameters can be set in scripting and used by the controller.
  */
 export declare class AnimatorControllerParameter {
-    /** The name of the parameter. */
-    name: string;
-    /** The value of the parameter. */
-    value: AnimatorControllerParameterValueType;
+    /** The default value of the parameter. */
+    defaultValue: AnimatorControllerParameterValue;
+    private _name;
+    /**
+     * The name of the parameter.
+     */
+    get name(): string;
+    set name(name: string);
 }

package/types/animation/AnimatorStateTransition.d.ts

@@ -1,4 +1,4 @@
-import { AnimatorControllerParameterValueType } from "./AnimatorControllerParameter";
+import { AnimatorControllerParameterValue } from "./AnimatorControllerParameter";
 import { AnimatorConditionMode } from "./enums/AnimatorConditionMode";
 import { AnimatorCondition } from "./AnimatorCondition";
 import { AnimatorState } from "./AnimatorState";
@@ -37,7 +37,7 @@ export declare class AnimatorStateTransition {
      * @param parameterName - The name of the parameter
      * @param threshold - The threshold value of the condition
      */
-    addCondition(mode: AnimatorConditionMode, parameterName: string, threshold?: AnimatorControllerParameterValueType): AnimatorCondition;
+    addCondition(mode: AnimatorConditionMode, parameterName: string, threshold?: AnimatorControllerParameterValue): AnimatorCondition;
     /**
      * Add a condition to a transition.
      * @param animatorCondition - The condition to add

package/types/animation/index.d.ts

@@ -20,3 +20,6 @@ export { WrapMode } from "./enums/WrapMode";
 export * from "./Keyframe";
 export * from "./AnimatorLayerMask";
 export { StateMachineScript } from "./StateMachineScript";
+export { AnimatorCondition } from "./AnimatorCondition";
+export * from "./AnimatorControllerParameter";
+export { LayerPathMask } from "./LayerPathMask";

package/types/asset/ResourceManager.d.ts

@@ -102,11 +102,13 @@ export declare class ResourceManager {
     addContentRestorer<T extends EngineObject>(restorer: ContentRestorer<T>): void;
     private _assignDefaultOptions;
     private _loadSingleItem;
-    private _pushSubAssetPromiseCallback;
+    private _loadMainAsset;
+    private _createSubAssetPromiseCallback;
     private _gc;
     private _getResolveResource;
     private _parseURL;
     private _parseQueryPath;
+    private _releaseSubAssetPromiseCallback;
 }
 /**
  * Declare ResourceLoader's decorator.

package/types/mesh/SkinnedMeshRenderer.d.ts

@@ -32,7 +32,7 @@ export declare class SkinnedMeshRenderer extends MeshRenderer {
      */
     get localBounds(): BoundingBox;
     set localBounds(value: BoundingBox);
-    protected _updateRendererShaderData(context: RenderContext): void;
+    protected _update(context: RenderContext): void;
     private _checkBlendShapeWeightLength;
     private _onLocalBoundsChanged;
     private _onSkinUpdated;

package/types/particle/ParticleRenderer.d.ts

@@ -41,7 +41,7 @@ export declare class ParticleRenderer extends Renderer {
     get mesh(): ModelMesh;
     set mesh(value: ModelMesh);
     protected _updateBounds(worldBounds: BoundingBox): void;
-    protected _updateRendererShaderData(context: RenderContext): void;
+    protected _update(context: RenderContext): void;
     protected _render(context: RenderContext): void;
     protected _onDestroy(): void;
 }

package/types/utils/SafeLoopArray.d.ts

@@ -22,6 +22,11 @@ export declare class SafeLoopArray<T> {
      * @param index - The index of the array
      */
     removeByIndex(index: number): void;
+    /**
+     * Remove item from array that pass the specified comparison function.
+     * @param filter - The comparison function
+     */
+    findAndRemove(filter: (value: T) => boolean): void;
     /**
      * The index of the item.
      * @param item - The item which want to get the index

package/types/utils/index.d.ts

@@ -1,3 +1,4 @@
 export { ClearableObjectPool } from "./ClearableObjectPool";
 export type { IPoolElement } from "./ObjectPool";
 export { ReturnableObjectPool } from "./ReturnableObjectPool";
+export { SafeLoopArray } from "./SafeLoopArray";

package/types/RenderPipeline/DynamicGeometryData.d.ts

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

package/types/RenderPipeline/DynamicGeometryDataManager.d.ts

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

package/types/RenderPipeline/RenderData2D.d.ts

@@ -1,14 +0,0 @@
-import { Primitive, SubMesh } from "../graphic";
-import { Material } from "../material/Material";
-import { Renderer } from "../Renderer";
-import { Texture2D } from "../texture";
-import { IPoolElement } from "../utils/Pool";
-import { Chunk } from "./DynamicGeometryData";
-import { RenderData } from "./RenderData";
-export declare class RenderData2D extends RenderData implements IPoolElement {
-    texture: Texture2D;
-    chunk: Chunk;
-    constructor();
-    set(component: Renderer, material: Material, primitive: Primitive, subPrimitive: SubMesh, texture?: Texture2D, chunk?: Chunk): void;
-    dispose(): void;
-}

package/types/RenderPipeline/RenderPass.d.ts

@@ -1,55 +0,0 @@
-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/enums/ForceUploadShaderDataFlag.d.ts

@@ -1,15 +0,0 @@
-/**
- * Force upload shader data flag.
- */
-export declare enum ForceUploadShaderDataFlag {
-    /** Upload nothing. */
-    None = 0,
-    /** Upload scene shader data. */
-    Scene = 1,
-    /** Upload camera shader data. */
-    Camera = 2,
-    /** Upload renderer shader data. */
-    Renderer = 4,
-    /** Upload material shader data. */
-    Material = 8
-}

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

@@ -1,13 +0,0 @@
-/**
- * RenderData usage.
- */
-export declare enum RenderDataUsage {
-    /** Usage for mesh. */
-    Mesh = 0,
-    /** Usage for sprite. */
-    Sprite = 1,
-    /** Usage for sprite mask. */
-    SpriteMask = 2,
-    /** Usage for text. */
-    Text = 3
-}

package/types/input/pointer/PointerEvent.d.ts

@@ -1,4 +0,0 @@
-import { Pointer } from "./Pointer";
-export declare class PointerEvent {
-    pointer: Pointer;
-}

package/types/input/pointer/PointerEventType.d.ts

@@ -1,7 +0,0 @@
-export declare enum PointerEventType {
-    Down = 0,
-    Up = 1,
-    Click = 2,
-    Enter = 3,
-    Exit = 4
-}

package/types/renderingHardwareInterface/IHardwareRenderer.d.ts

@@ -1,6 +0,0 @@
-/**
- * Hardware graphics API renderer.
- */
-export interface IHardwareRenderer {
-    [key: string]: any;
-}

package/types/ui/Image.d.ts

@@ -1,38 +0,0 @@
-import { Color } from "@galacean/engine-math";
-import { Sprite, SpriteDrawMode, SpriteTileMode } from "../2d";
-import { UIRenderer } from "./UIRenderer";
-export declare class Image extends UIRenderer {
-    private _color;
-    private _sprite;
-    private _drawMode;
-    private _assembler;
-    private _tileMode;
-    private _tiledAdaptiveThreshold;
-    /**
-     * The draw mode of the sprite renderer.
-     */
-    get drawMode(): SpriteDrawMode;
-    set drawMode(value: SpriteDrawMode);
-    /**
-     * The tiling mode of the sprite renderer. (Only works in tiled mode.)
-     */
-    get tileMode(): SpriteTileMode;
-    set tileMode(value: SpriteTileMode);
-    /**
-     * Stretch Threshold in Tile Adaptive Mode, specified in normalized. (Only works in tiled adaptive mode.)
-     */
-    get tiledAdaptiveThreshold(): number;
-    set tiledAdaptiveThreshold(value: number);
-    /**
-     * The Sprite to render.
-     */
-    get sprite(): Sprite;
-    set sprite(value: Sprite | null);
-    /**
-     * Rendering color for the Sprite graphic.
-     */
-    get color(): Color;
-    set color(value: Color);
-    protected _onDestroy(): void;
-    private _onSpriteChange;
-}

package/types/ui/RedBlackTree.d.ts

@@ -1,2 +0,0 @@
-export declare class RedBlackTree {
-}

package/types/ui/UICanvas.d.ts

@@ -1,55 +0,0 @@
-import { Vector2 } from "@galacean/engine-math";
-import { Camera } from "../Camera";
-import { Component } from "../Component";
-import { Entity } from "../Entity";
-import { RenderContext } from "../RenderPipeline/RenderContext";
-import { CanvasRenderMode } from "./enums/CanvasRenderMode";
-import { ResolutionAdaptationStrategy } from "./enums/ResolutionAdaptationStrategy";
-export declare class UICanvas extends Component {
-    private _renderMode;
-    private _renderCamera;
-    private _resolutionAdaptationStrategy;
-    private _sortOrder;
-    private _distance;
-    private _renderers;
-    private _transform;
-    private _uiTransform;
-    private _referenceResolution;
-    private _isRootCanvas;
-    private _enableBlocked;
-    private _parents;
-    private _hierarchyDirty;
-    get enableBlocked(): boolean;
-    set enableBlocked(value: boolean);
-    get referenceResolution(): Vector2;
-    set referenceResolution(val: Vector2);
-    get renderMode(): CanvasRenderMode;
-    set renderMode(mode: CanvasRenderMode);
-    get renderCamera(): Camera;
-    set renderCamera(val: Camera);
-    get resolutionAdaptationStrategy(): ResolutionAdaptationStrategy;
-    set resolutionAdaptationStrategy(val: ResolutionAdaptationStrategy);
-    get sortOrder(): number;
-    set sortOrder(val: number);
-    get distance(): number;
-    set distance(val: number);
-    constructor(entity: Entity);
-    _prepareRender(context: RenderContext): void;
-    private _adapterPoseInScreenSpace;
-    private _adapterSizeInScreenSpace;
-    private _walk;
-    private _addCameraListener;
-    private _removeCameraListener;
-    private _onCameraPropertyListener;
-    private _onCameraTransformListener;
-    private _addCanvasListener;
-    private _removeCanvasListener;
-    private _onCanvasSizeListener;
-    private _addParentListener;
-    private _removeParentListener;
-    private _onEntityListener;
-    private _onParentListener;
-    private _onReferenceResolutionChanged;
-    private _checkIsRootCanvas;
-    private _setIsRootCanvas;
-}

package/types/ui/UIRenderer.d.ts

@@ -1,14 +0,0 @@
-import { BoundingBox, Vector4 } from "@galacean/engine-math";
-import { Renderer } from "../Renderer";
-import { UITransform, UITransformModifyFlags } from "./UITransform";
-export declare class UIRenderer extends Renderer {
-    protected _uiTransform: UITransform;
-    protected _localBounds: BoundingBox;
-    protected _rayCastTarget: boolean;
-    protected _rayCastPadding: Vector4;
-    get rayCastTarget(): boolean;
-    set rayCastTarget(value: boolean);
-    get rayCastPadding(): Vector4;
-    set rayCastPadding(value: Vector4);
-    protected _onUITransformChanged(flag: UITransformModifyFlags): void;
-}

package/types/ui/UITransform.d.ts

@@ -1,20 +0,0 @@
-import { Vector2 } from "@galacean/engine-math";
-import { Component } from "../Component";
-import { Entity } from "../Entity";
-export declare class UITransform extends Component {
-    private _rect;
-    private _pivot;
-    get rect(): Vector2;
-    set rect(val: Vector2);
-    get pivot(): Vector2;
-    set pivot(val: Vector2);
-    constructor(entity: Entity);
-    private _onRectChange;
-    private _onPivotChange;
-}
-export declare enum UITransformModifyFlags {
-    /** Rect. */
-    Rect = 1,
-    /** Pivot. */
-    Pivot = 2
-}

package/types/ui/enums/BlockingObjects.d.ts

@@ -1,6 +0,0 @@
-export declare enum BlockingObjects {
-    None = 0,
-    TwoDimensional = 1,
-    ThreeDimensional = 2,
-    All = 3
-}

package/types/ui/enums/CanvasRenderMode.d.ts

@@ -1,8 +0,0 @@
-/**
- * Render mode for ui canvas.
- */
-export declare enum CanvasRenderMode {
-    ScreenSpaceOverlay = 0,
-    ScreenSpaceCamera = 1,
-    WorldSpace = 2
-}

package/types/ui/enums/ResolutionAdaptationStrategy.d.ts

@@ -1,10 +0,0 @@
-/**
- * Resolution adaptation strategy.
- */
-export declare enum ResolutionAdaptationStrategy {
-    WidthAdaptation = 0,
-    HeightAdaptation = 1,
-    BothAdaptation = 2,
-    ExpandAdaptation = 3,
-    ShrinkAdaptation = 4
-}

package/types/ui/index.d.ts

@@ -1,6 +0,0 @@
-export { CanvasRenderMode } from "./enums/CanvasRenderMode";
-export { ResolutionAdaptationStrategy } from "./enums/ResolutionAdaptationStrategy";
-export { UICanvas } from "./UICanvas";
-export { UIRenderer } from "./UIRenderer";
-export { Image } from "./Image";
-export { UITransform } from "./UITransform";

package/types/utils/Pool.d.ts

@@ -1,12 +0,0 @@
-export interface IPoolElement {
-    dispose?(): void;
-}
-export declare class Pool<T extends IPoolElement> {
-    private _type;
-    private _elementPool;
-    private _elementPoolIndex;
-    constructor(type: new () => T, count?: number);
-    alloc(): T;
-    free(element: T): void;
-    dispose(): void;
-}