@galacean/engine-core 1.3.23 → 1.4.0-alpha.0

package/package.json

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

package/types/2d/index.d.ts

@@ -1,5 +1,4 @@
 export { SpriteMaskInteraction } from "./enums/SpriteMaskInteraction";
-export { SpriteMaskLayer } from "./enums/SpriteMaskLayer";
 export { TextHorizontalAlignment, TextVerticalAlignment } from "./enums/TextAlignment";
 export { OverflowMode } from "./enums/TextOverflow";
 export { FontStyle } from "./enums/FontStyle";

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

@@ -1,13 +1,14 @@
 import { BoundingBox } from "@galacean/engine-math";
 import { RenderContext } from "../../RenderPipeline/RenderContext";
 import { Renderer } from "../../Renderer";
+import { SpriteMaskLayer } from "../../enums/SpriteMaskLayer";
 import { Sprite } from "./Sprite";
 /**
  * A component for masking Sprites.
  */
 export declare class SpriteMask extends Renderer {
     /** The mask layers the sprite mask influence to. */
-    influenceLayers: number;
+    influenceLayers: SpriteMaskLayer;
     private _sprite;
     private _automaticWidth;
     private _automaticHeight;

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

@@ -88,7 +88,6 @@ export declare class SpriteRenderer extends Renderer {
     protected _render(context: RenderContext): void;
     protected _onDestroy(): void;
     private _calDefaultSize;
-    private _updateStencilState;
     private _onSpriteChange;
     private _onColorChanged;
 }

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

@@ -106,7 +106,6 @@ export declare class TextRenderer extends Renderer {
     constructor(entity: Entity);
     protected _updateBounds(worldBounds: BoundingBox): void;
     protected _render(context: RenderContext): void;
-    private _updateStencilState;
     private _resetSubFont;
     private _updatePosition;
     private _updateColor;

package/types/BasicResources.d.ts

@@ -1 +1,2 @@
-export {};
+import { RenderStateElementKey } from "./shader/enums/RenderStateElementKey";
+export type RenderStateElementMap = Record<RenderStateElementKey, number | boolean>;

package/types/Engine.d.ts

@@ -117,9 +117,6 @@ export declare class Engine extends EventDispatcher {
      * @remarks If call during frame execution will delay until the end of the frame
      */
     destroy(): void;
-    private _createSpriteMaterial;
-    private _createSpriteMaskMaterial;
-    private _createTextMaterial;
     private _onDeviceLost;
     private _onDeviceRestored;
     private _gc;

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

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

package/types/animation/Animator.d.ts

@@ -9,6 +9,7 @@ import { AnimatorCullingMode } from "./enums/AnimatorCullingMode";
  * The controller of the animation system.
  */
 export declare class Animator extends Component {
+    private static _passedTriggerParameterNames;
     /** Culling mode of this Animator. */
     cullingMode: AnimatorCullingMode;
     /** The playback speed of the Animator, 1.0 is normal playback speed. */
@@ -39,17 +40,25 @@ export declare class Animator extends Component {
      * Play a state by name.
      * @param stateName - The state name
      * @param layerIndex - The layer index(default -1). If layer is -1, play the first state with the given state name
-     * @param normalizedTimeOffset - The time offset between 0 and 1(default 0)
+     * @param normalizedTimeOffset - The normalized time offset (between 0 and 1, default 0) to start the state's animation from
      */
     play(stateName: string, layerIndex?: number, normalizedTimeOffset?: number): void;
     /**
-     * Create a cross fade from the current state to another state.
+     * Create a cross fade from the current state to another state with a normalized duration.
      * @param stateName - The state name
-     * @param normalizedTransitionDuration - The duration of the transition (normalized)
+     * @param normalizedDuration - The normalized duration of the transition, relative to the destination state's duration (range: 0 to 1)
      * @param layerIndex - The layer index(default -1). If layer is -1, play the first state with the given state name
-     * @param normalizedTimeOffset - The time offset between 0 and 1(default 0)
+     * @param normalizedTimeOffset - The normalized time offset (between 0 and 1, default 0) to start the destination state's animation from
      */
-    crossFade(stateName: string, normalizedTransitionDuration: number, layerIndex?: number, normalizedTimeOffset?: number): void;
+    crossFade(stateName: string, normalizedDuration: number, layerIndex?: number, normalizedTimeOffset?: number): void;
+    /**
+     * Create a cross fade from the current state to another state with a fixed duration.
+     * @param stateName - The state name
+     * @param fixedDuration - The duration of the transition in seconds
+     * @param layerIndex - The layer index(default -1). If layer is -1, play the first state with the given state name
+     * @param normalizedTimeOffset - The normalized time offset (between 0 and 1, default 0) to start the destination state's animation from
+     */
+    crossFadeInFixedDuration(stateName: string, fixedDuration: number, layerIndex?: number, normalizedTimeOffset?: number): void;
     /**
      * Evaluates the animator component based on deltaTime.
      * @param deltaTime - The deltaTime when the animation update
@@ -88,6 +97,17 @@ export declare class Animator extends Component {
      * @param value - The value of the parameter
      */
     setParameterValue(name: string, value: AnimatorControllerParameterValue): void;
+    /**
+     * Activate the trigger parameter by name.
+     * @param name - The name of the trigger parameter
+     */
+    activateTriggerParameter(name: string): void;
+    /**
+     * Reset the trigger parameter to deactivate it by name.
+     * @param name - The name of the trigger parameter
+     */
+    deactivateTriggerParameter(name: string): void;
+    private _crossFade;
     private _getAnimatorStateInfo;
     private _getAnimatorStateData;
     private _saveAnimatorStateData;
@@ -112,6 +132,7 @@ export declare class Animator extends Component {
     private _updateCrossFadeData;
     private _preparePlayOwner;
     private _applyStateTransitions;
+    private _checkNoExitTimeTransition;
     private _checkSubTransition;
     private _checkBackwardsSubTransition;
     private _applyTransitionsByCondition;
@@ -128,4 +149,5 @@ export declare class Animator extends Component {
     private _checkAnyAndEntryState;
     private _checkRevertOwner;
     private _fireAnimationEventsAndCallScripts;
+    private _deactivateTriggeredParameters;
 }

package/types/animation/AnimatorController.d.ts

@@ -31,10 +31,19 @@ export declare class AnimatorController extends ReferResource {
      */
     addParameter(name: string, defaultValue?: AnimatorControllerParameterValue): AnimatorControllerParameter;
     /**
-     * Remove a parameter from the controller by name.
-     * @param name - The parameter name
+     * Add a trigger parameter to the controller.
+     * @param name - The name of the parameter
+     */
+    addTriggerParameter(name: string): AnimatorControllerParameter;
+    /**
+     * Remove a parameter from the controller by name, including trigger parameters.
+     * @param name - The name of the parameter
      */
     removeParameter(name: string): void;
+    /**
+     * Clear all parameters, including trigger parameters.
+     */
+    clearParameters(): void;
     /**
      * Get the parameter by name.
      * @param name - The name of the parameter
@@ -59,4 +68,5 @@ export declare class AnimatorController extends ReferResource {
      * Clear layers.
      */
     clearLayers(): void;
+    private _addParameter;
 }

package/types/animation/AnimatorState.d.ts

@@ -14,7 +14,6 @@ export declare class AnimatorState {
     private _clipStartTime;
     private _clipEndTime;
     private _clip;
-    private _transitions;
     /**
      * The transitions that are going out of the state.
      */

package/types/animation/AnimatorStateMachine.d.ts

@@ -14,8 +14,6 @@ export declare class AnimatorStateMachine {
      * @remarks When the Animator's AnimatorController changed or the Animator's onEnable be triggered.
      */
     defaultState: AnimatorState;
-    private _entryTransitions;
-    private _anyStateTransitions;
     private _statesMap;
     /**
      * The list of entry transitions in the state machine.
@@ -52,7 +50,7 @@ export declare class AnimatorStateMachine {
      */
     addEntryStateTransition(transition: AnimatorStateTransition): AnimatorStateTransition;
     /**
-     * Add an entry transition to the destination state.
+     * Add an entry transition to the destination state, the default value of entry transition's hasExitTime is false.
      * @param animatorState - The destination state
      */
     addEntryStateTransition(animatorState: AnimatorState): AnimatorStateTransition;
@@ -67,7 +65,7 @@ export declare class AnimatorStateMachine {
      */
     addAnyStateTransition(transition: AnimatorStateTransition): AnimatorStateTransition;
     /**
-     * Add an any transition to the destination state.
+     * Add an any transition to the destination state, the default value of any transition's hasExitTime is false.
      * @param animatorState - The destination state
      */
     addAnyStateTransition(animatorState: AnimatorState): AnimatorStateTransition;
@@ -76,6 +74,12 @@ export declare class AnimatorStateMachine {
      * @param transition - The transition
      */
     removeAnyStateTransition(transition: AnimatorStateTransition): void;
-    private _addTransition;
-    private _removeTransition;
+    /**
+     * Clear all entry state transitions.
+     */
+    clearEntryStateTransitions(): void;
+    /**
+     * Clear all any state transitions.
+     */
+    clearAnyStateTransitions(): void;
 }

package/types/animation/AnimatorStateTransition.d.ts

@@ -1,12 +1,12 @@
-import { AnimatorControllerParameterValue } from "./AnimatorControllerParameter";
-import { AnimatorConditionMode } from "./enums/AnimatorConditionMode";
 import { AnimatorCondition } from "./AnimatorCondition";
+import { AnimatorControllerParameterValue } from "./AnimatorControllerParameter";
 import { AnimatorState } from "./AnimatorState";
+import { AnimatorConditionMode } from "./enums/AnimatorConditionMode";
 /**
  * Transitions define when and how the state machine switch from on state to another. AnimatorTransition always originate from a StateMachine or a StateMachine entry.
  */
 export declare class AnimatorStateTransition {
-    /** The duration of the transition. This is represented in normalized time. */
+    /** The duration of the transition. The duration is in normalized time by default. To set it to be in seconds, set isFixedDuration to true. */
     duration: number;
     /** The time at which the destination state will start. This is represented in normalized time. */
     offset: number;
@@ -16,8 +16,11 @@ export declare class AnimatorStateTransition {
     destinationState: AnimatorState;
     /** Mutes the transition. The transition will never occur. */
     mute: boolean;
+    /** Determines whether the duration of the transition is reported in a fixed duration in seconds or as a normalized time. */
+    isFixedDuration: boolean;
     private _conditions;
     private _solo;
+    private _hasExitTime;
     /**
      * Is the transition destination the exit of the current state machine.
      */
@@ -31,13 +34,18 @@ export declare class AnimatorStateTransition {
      * The conditions in the transition.
      */
     get conditions(): Readonly<AnimatorCondition[]>;
+    /**
+     * When active the transition will have an exit time condition.
+     */
+    get hasExitTime(): boolean;
+    set hasExitTime(value: boolean);
     /**
      * Add a condition to a transition.
-     * @param mode - The AnimatorCondition mode of the condition
      * @param parameterName - The name of the parameter
+     * @param mode - The AnimatorCondition mode of the condition
      * @param threshold - The threshold value of the condition
      */
-    addCondition(mode: AnimatorConditionMode, parameterName: string, threshold?: AnimatorControllerParameterValue): AnimatorCondition;
+    addCondition(parameterName: string, mode?: AnimatorConditionMode, threshold?: AnimatorControllerParameterValue): AnimatorCondition;
     /**
      * Add a condition to a transition.
      * @param animatorCondition - The condition to add

package/types/animation/AnimatorStateTransitionCollection.d.ts

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

package/types/asset/ResourceManager.d.ts

@@ -115,4 +115,6 @@ export declare class ResourceManager {
  * @param assetType - Type of asset
  * @param extNames - Name of file extension
  */
-export declare function resourceLoader(assetType: string, extNames: string[], useCache?: boolean): <T extends Loader<any>>(Target: new (useCache: boolean) => T) => void;
+export declare function resourceLoader(assetType: string, extNames: string[], useCache?: boolean): <T extends Loader<any>>(Target: {
+    new (useCache: boolean): T;
+}) => void;

package/types/base/Constant.d.ts

@@ -3,37 +3,37 @@
  */
 export declare enum DataType {
     /** Float */
-    FLOAT = 5126,
+    FLOAT = 5126,// gl.FLOAT
     /** Floating-point two-dimensional vector */
-    FLOAT_VEC2 = 35664,
+    FLOAT_VEC2 = 35664,// gl.FLOAT_VEC2
     /** Floating-point three-dimensional vector */
-    FLOAT_VEC3 = 35665,
+    FLOAT_VEC3 = 35665,// gl.FLOAT_VEC3
     /** Floating-point four-dimensional vector */
-    FLOAT_VEC4 = 35666,
+    FLOAT_VEC4 = 35666,// gl.FLOAT_VEC4
     /** Integer */
-    INT = 5124,
+    INT = 5124,// gl.INT
     /** Integer two-dimensional vector */
-    INT_VEC2 = 35667,
+    INT_VEC2 = 35667,// gl.INT_VEC2
     /** Integer three-dimensional vector */
-    INT_VEC3 = 35668,
+    INT_VEC3 = 35668,// gl.INT_VEC3
     /** Integer four-dimensional vector */
-    INT_VEC4 = 35669,
+    INT_VEC4 = 35669,// gl.INT_VEC4
     /** Boolean */
-    BOOL = 35670,
+    BOOL = 35670,// gl.BOOL
     /** Boolean two-dimensional vector */
-    BOOL_VEC2 = 35671,
+    BOOL_VEC2 = 35671,// gl.BOOL_VEC2
     /** Boolean three-dimensional vector */
-    BOOL_VEC3 = 35672,
+    BOOL_VEC3 = 35672,// gl.BOOL_VEC3
     /** Boolean four-dimensional vector */
-    BOOL_VEC4 = 35673,
+    BOOL_VEC4 = 35673,// gl.BOOL_VEC4
     /** Second-order matrix */
-    FLOAT_MAT2 = 35674,
+    FLOAT_MAT2 = 35674,// gl.FLOAT_MAT2
     /** Third-order matrix */
-    FLOAT_MAT3 = 35675,
+    FLOAT_MAT3 = 35675,// gl.FLOAT_MAT3
     /** Fourth-order matrix */
-    FLOAT_MAT4 = 35676,
+    FLOAT_MAT4 = 35676,// gl.FLOAT_MAT4
     /** Float array */
-    FLOAT_ARRAY = 35677,
+    FLOAT_ARRAY = 35677,// gl.FLOAT_ARRAY
     /** Floating-point two-dimensional vector array */
     FLOAT_VEC2_ARRAY = 100000,
     /** Floating-point three-dimensional vector array */
@@ -59,17 +59,17 @@ export declare enum DataType {
     /** Cube map texture sampler array */
     SAMPLER_CUBE_ARRAY = 100011,
     /** 2D sampler */
-    SAMPLER_2D = 35678,
+    SAMPLER_2D = 35678,// gl.SAMPLER_2D
     /** Cube map Texture sampler */
-    SAMPLER_CUBE = 35680,
+    SAMPLER_CUBE = 35680,// gl.SAMPLER_CUBE
     /** Byte */
-    BYTE = 5120,
+    BYTE = 5120,// gl.BYTE
     /** Unsigned byte */
-    UNSIGNED_BYTE = 5121,
+    UNSIGNED_BYTE = 5121,// gl.UNSIGNED_BYTE
     /** Short */
-    SHORT = 5122,
+    SHORT = 5122,// gl.SHORT
     /** Unsigned short */
-    UNSIGNED_SHORT = 5123,
+    UNSIGNED_SHORT = 5123,// gl.UNSIGNED_SHORT
     /** Unsigned int */
     UNSIGNED_INT = 5125
 }

package/types/{2d/enums → enums}/SpriteMaskLayer.d.ts

@@ -67,5 +67,7 @@ export declare enum SpriteMaskLayer {
     /** Mask layer 31. */
     Layer31 = 2147483648,
     /** All mask layers. */
-    Everything = 4294967295
+    Everything = 4294967295,
+    /** None mask layer. */
+    Nothing = 0
 }

package/types/index.d.ts

@@ -36,6 +36,7 @@ export { ReplacementFailureStrategy } from "./enums/ReplacementFailureStrategy";
 export { Downsampling } from "./enums/Downsampling";
 export { ColorSpace } from "./enums/ColorSpace";
 export { BackgroundTextureFillMode } from "./enums/BackgroundTextureFillMode";
+export { SpriteMaskLayer } from "./enums/SpriteMaskLayer";
 export { XRManager } from "./xr/XRManager";
 export * from "./utils/index";
 export * from "./input/index";

package/types/lighting/DirectLight.d.ts

@@ -7,6 +7,11 @@ export declare class DirectLight extends Light {
     private static _cullingMaskProperty;
     private static _colorProperty;
     private static _directionProperty;
+    /**
+     * The offset distance in the opposite direction of light direction when generating shadows.
+     * @remarks Increasing this value can avoid the holes in the shadow caused by low polygon models.
+     */
+    shadowNearPlaneOffset: number;
     private _reverseDirection;
     /**
      * Get direction.

package/types/lighting/Light.d.ts

@@ -19,7 +19,10 @@ export declare abstract class Light extends Component {
     shadowBias: number;
     /** Shadow mapping normal-based bias. */
     shadowNormalBias: number;
-    /** Near plane value to use for shadow frustums. */
+    /**
+     * @deprecated
+     * Please use `shadowNearPlaneOffset` instead.
+     */
     shadowNearPlane: number;
     private _shadowStrength;
     private _color;

package/types/material/PBRMaterial.d.ts

@@ -1,3 +1,4 @@
+import { Vector2 } from "@galacean/engine-math";
 import { Engine } from "../Engine";
 import { Texture2D } from "../texture/Texture2D";
 import { PBRBaseMaterial } from "./PBRBaseMaterial";
@@ -12,6 +13,10 @@ export declare class PBRMaterial extends PBRBaseMaterial {
     private static _anisotropyInfoProp;
     private static _anisotropyTextureProp;
     private _anisotropyRotation;
+    private static _iridescenceInfoProp;
+    private static _iridescenceThicknessTextureProp;
+    private static _iridescenceTextureProp;
+    private _iridescenceRange;
     /**
      * Index Of Refraction.
      * @defaultValue `1.5`
@@ -56,11 +61,43 @@ export declare class PBRMaterial extends PBRBaseMaterial {
      */
     get anisotropyTexture(): Texture2D;
     set anisotropyTexture(value: Texture2D);
+    /**
+     * The iridescence intensity factor, from 0.0 to 1.0.
+     * @defaultValue `0.0`
+     */
+    get iridescence(): number;
+    set iridescence(value: number);
+    /**
+     * The iridescence intensity texture, sampling red channel, and multiply 'iridescence'.
+     */
+    get iridescenceTexture(): Texture2D;
+    set iridescenceTexture(value: Texture2D);
+    /**
+     * The index of refraction of the dielectric thin-film layer, greater than or equal to 1.0.
+     * @defaultValue `1.3`
+     */
+    get iridescenceIOR(): number;
+    set iridescenceIOR(value: number);
+    /**
+     * The range of iridescence thickness, x is minimum, y is maximum.
+     *  @defaultValue `[100, 400]`.
+     */
+    get iridescenceThicknessRange(): Vector2;
+    set iridescenceThicknessRange(value: Vector2);
+    /**
+     * The thickness texture of the thin-film layer, sampling green channel.
+     * @remarks
+     * If iridescenceThicknessTexture is defined, iridescence thickness between the 'iridescenceThicknessRange'.
+     * If iridescenceThicknessTexture is not defined, iridescence thickness will use only 'iridescenceThicknessRange.y'.
+     */
+    get iridescenceThicknessTexture(): Texture2D;
+    set iridescenceThicknessTexture(value: Texture2D);
     /**
      * Create a pbr metallic-roughness workflow material instance.
      * @param engine - Engine to which the material belongs
      */
     constructor(engine: Engine);
+    private _onIridescenceRangeChanged;
     /**
      * @inheritdoc
      */