@galacean/engine-core 1.3.24 → 1.4.0-alpha.1

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

@@ -16,6 +16,7 @@ export { BoolUpdateFlag } from "./BoolUpdateFlag";
 export type { EngineSettings } from "./EngineSettings";
 export type { EngineConfiguration } from "./Engine";
 export { request } from "./asset/request";
+export type { RequestConfig } from "./asset/request";
 export { Loader } from "./asset/Loader";
 export { ContentRestorer } from "./asset/ContentRestorer";
 export { ResourceManager, resourceLoader } from "./asset/ResourceManager";
@@ -36,6 +37,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";
@@ -58,5 +60,6 @@ export * from "./clone/CloneManager";
 export * from "./renderingHardwareInterface/index";
 export * from "./physics/index";
 export * from "./Utils";
+export * from "./audio/index";
 export { ShaderMacroCollection } from "./shader/ShaderMacroCollection";
 export * from "./postProcess";

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, Color } from "@galacean/engine-math";
 import { Engine } from "../Engine";
 import { Texture2D } from "../texture/Texture2D";
 import { PBRBaseMaterial } from "./PBRBaseMaterial";
@@ -12,6 +13,15 @@ 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;
+    private _sheenEnabled;
+    private static _sheenColorProp;
+    private static _sheenRoughnessProp;
+    private static _sheenTextureProp;
+    private static _sheenRoughnessTextureProp;
     /**
      * Index Of Refraction.
      * @defaultValue `1.5`
@@ -56,11 +66,66 @@ 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);
+    /**
+     * Sheen color.
+     * @defaultValue `[0,0,0]`
+     */
+    get sheenColor(): Color;
+    set sheenColor(value: Color);
+    /**
+     * Sheen roughness, from 0.0 to 1.0.
+     * @defaultValue `0.0`
+     */
+    get sheenRoughness(): number;
+    set sheenRoughness(value: number);
+    /**
+     * Sheen color texture, multiply ‘sheenColor’.
+     */
+    get sheenColorTexture(): Texture2D;
+    set sheenColorTexture(value: Texture2D);
+    /**
+     * Sheen roughness texture.
+     * @remarks Use alpha channel, and multiply 'sheenRoughness'.
+     */
+    get sheenRoughnessTexture(): Texture2D;
+    set sheenRoughnessTexture(value: Texture2D);
     /**
      * Create a pbr metallic-roughness workflow material instance.
      * @param engine - Engine to which the material belongs
      */
     constructor(engine: Engine);
+    private _onIridescenceRangeChanged;
     /**
      * @inheritdoc
      */

package/types/physics/CharacterController.d.ts

@@ -11,7 +11,8 @@ export declare class CharacterController extends Collider {
     private _upDirection;
     private _slopeLimit;
     /**
-     * The step offset for the controller.
+     * The step offset for the controller, the value must be greater than or equal to 0.
+     * @remarks Character can overcome obstacle less than the height(stepOffset + contractOffset of the shape).
      */
     get stepOffset(): number;
     set stepOffset(value: number);
@@ -26,7 +27,8 @@ export declare class CharacterController extends Collider {
     get upDirection(): Vector3;
     set upDirection(value: Vector3);
     /**
-     * The slope limit for the controller.
+     * The slope limit for the controller, the value is the cosine value of the maximum slope angle.
+     * @defaultValue 0.707(the cosine value of 45 degrees)
      */
     get slopeLimit(): number;
     set slopeLimit(value: number);
@@ -43,10 +45,7 @@ export declare class CharacterController extends Collider {
      * @param shape - Collider shape
      */
     addShape(shape: ColliderShape): void;
-    /**
-     * Remove all shape attached.
-     */
-    clearShapes(): void;
+    protected _syncNative(): void;
     private _syncWorldPositionFromPhysicalSpace;
     private _setUpDirection;
 }

package/types/physics/Collider.d.ts

@@ -27,5 +27,7 @@ export declare class Collider extends Component implements ICustomClone {
      * Remove all shape attached.
      */
     clearShapes(): void;
-    protected _addPhysicsShape(shape: ColliderShape): void;
+    protected _syncNative(): void;
+    protected _addNativeShape(shape: ColliderShape): void;
+    protected _removeNativeShape(shape: ColliderShape): void;
 }

package/types/physics/DynamicCollider.d.ts

@@ -18,6 +18,8 @@ export declare class DynamicCollider extends Collider {
     private _constraints;
     private _collisionDetectionMode;
     private _sleepThreshold;
+    private _automaticCenterOfMass;
+    private _automaticInertiaTensor;
     /**
      * The linear damping of the dynamic collider.
      */
@@ -43,13 +45,27 @@ export declare class DynamicCollider extends Collider {
      */
     get mass(): number;
     set mass(value: number);
+    /**
+     * Whether or not to calculate the center of mass automatically, if true, the center of mass will be calculated based on the associated shapes.
+     * @remarks Affected by the position, rotation of the shapes.
+     */
+    get automaticCenterOfMass(): boolean;
+    set automaticCenterOfMass(value: boolean);
     /**
      * The center of mass relative to the transform's origin.
+     * @remarks The center of mass is automatically calculated, if you want to set it manually, please set automaticCenterOfMass to false.
      */
     get centerOfMass(): Vector3;
     set centerOfMass(value: Vector3);
+    /**
+     * Whether or not to calculate the inertia tensor automatically, if true, the inertia tensor will be calculated based on the associated shapes and mass.
+     * @remarks Affected by the position, rotation of the shapes and the mass of the collider.
+     */
+    get automaticInertiaTensor(): boolean;
+    set automaticInertiaTensor(value: boolean);
     /**
      * The diagonal inertia tensor of mass relative to the center of mass.
+     * @remarks The inertia tensor is automatically calculated, if you want to set it manually, please set automaticInertiaTensor to false.
      */
     get inertiaTensor(): Vector3;
     set inertiaTensor(value: Vector3);
@@ -118,14 +134,21 @@ export declare class DynamicCollider extends Collider {
      * Forces a collider to sleep at least one frame.
      */
     sleep(): void;
+    /**
+     * Returns whether the collider is sleeping.
+     * @returns True if the collider is sleeping, false otherwise.
+     */
+    isSleeping(): boolean;
     /**
      * Forces a collider to wake up.
      */
     wakeUp(): void;
+    protected _syncNative(): void;
+    private _setMassAndUpdateInertia;
     private _setLinearVelocity;
     private _setAngularVelocity;
-    private _setCenterOfMass;
-    private _setInertiaTensor;
+    private _handleCenterOfMassChanged;
+    private _handleInertiaTensorChanged;
 }
 /**
  * The collision detection mode constants.

package/types/physics/PhysicsMaterial.d.ts

@@ -11,7 +11,7 @@ export declare class PhysicsMaterial {
     private _destroyed;
     constructor();
     /**
-     * The coefficient of bounciness.
+     * The coefficient of bounciness, ranging from 0 to 1.
      */
     get bounciness(): number;
     set bounciness(value: number);

package/types/physics/joint/FixedJoint.d.ts

@@ -1,3 +1,4 @@
 import { Joint } from "./Joint";
 export declare class FixedJoint extends Joint {
+    protected _createJoint(): void;
 }

package/types/physics/joint/HingeJoint.d.ts

@@ -2,6 +2,7 @@ import { Vector3 } from "@galacean/engine-math";
 import { Joint } from "./Joint";
 import { JointLimits } from "./JointLimits";
 import { JointMotor } from "./JointMotor";
+import { Entity } from "../../Entity";
 /**
  * A joint which behaves in a similar way to a hinge or axle.
  */
@@ -9,18 +10,15 @@ export declare class HingeJoint extends Joint {
     private _axis;
     private _hingeFlags;
     private _useSpring;
-    private _jointMonitor;
+    private _jointMotor;
     private _limits;
+    private _angle;
+    private _velocity;
     /**
      * The anchor rotation.
      */
     get axis(): Vector3;
     set axis(value: Vector3);
-    /**
-     * The swing offset.
-     */
-    get swingOffset(): Vector3;
-    set swingOffset(value: Vector3);
     /**
      * The current angle in degrees of the joint relative to its rest position.
      */
@@ -54,4 +52,9 @@ export declare class HingeJoint extends Joint {
      */
     get limits(): JointLimits;
     set limits(value: JointLimits);
+    constructor(entity: Entity);
+    protected _createJoint(): void;
+    protected _syncNative(): void;
+    private _onMotorChanged;
+    private _onLimitsChanged;
 }

package/types/physics/joint/Joint.d.ts

@@ -3,43 +3,55 @@ import { Vector3 } from "@galacean/engine-math";
 import { Component } from "../../Component";
 import { Entity } from "../../Entity";
 import { Collider } from "../Collider";
-import { ICustomClone } from "../../clone/ComponentCloner";
 /**
  * A base class providing common functionality for joints.
  * @decorator `@dependentComponents(Collider, DependentMode.CheckOnly)`
  */
-export declare class Joint extends Component implements ICustomClone {
+export declare abstract class Joint extends Component {
+    private static _tempVector3;
     protected _colliderInfo: JointColliderInfo;
     protected _connectedColliderInfo: JointColliderInfo;
     protected _nativeJoint: IJoint;
     private _force;
     private _torque;
+    private _automaticConnectedAnchor;
     /**
      * The connected collider.
      */
     get connectedCollider(): Collider;
     set connectedCollider(value: Collider);
+    /**
+     * The connected anchor position.
+     * @remarks If connectedCollider is set, this anchor is relative offset, or the anchor is world position.
+     */
+    get anchor(): Vector3;
+    set anchor(value: Vector3);
     /**
      * The connected anchor position.
      * @remarks If connectedCollider is set, this anchor is relative offset, or the anchor is world position.
      */
     get connectedAnchor(): Vector3;
     set connectedAnchor(value: Vector3);
+    /**
+     * Whether or not to calculate the connectedAnchor automatically, if true, the connectedAnchor will be calculated automatically to match the global position of the anchor property.
+     */
+    get automaticConnectedAnchor(): boolean;
+    set automaticConnectedAnchor(value: boolean);
     /**
      *  The scale to apply to the inverse mass of collider 0 for resolving this constraint.
      */
     get connectedMassScale(): number;
     set connectedMassScale(value: number);
-    /**
-     * The scale to apply to the inverse inertia of collider0 for resolving this constraint.
-     */
-    get connectedInertiaScale(): number;
-    set connectedInertiaScale(value: number);
     /**
      * The scale to apply to the inverse mass of collider 1 for resolving this constraint.
      */
     get massScale(): number;
     set massScale(value: number);
+    /**
+     * The scale to apply to the inverse inertia of collider0 for resolving this constraint.
+     */
+    get connectedInertiaScale(): number;
+    set connectedInertiaScale(value: number);
     /**
      * The scale to apply to the inverse inertia of collider1 for resolving this constraint.
      */
@@ -56,4 +68,10 @@ export declare class Joint extends Component implements ICustomClone {
     get breakTorque(): number;
     set breakTorque(value: number);
     constructor(entity: Entity);
+    protected abstract _createJoint(): void;
+    protected _syncNative(): void;
+    private _calculateConnectedAnchor;
+    private _onSelfTransformChanged;
+    private _onConnectedTransformChanged;
+    private _updateActualAnchor;
 }

package/types/physics/joint/JointLimits.d.ts

@@ -1,15 +1,39 @@
+import { UpdateFlagManager } from "../../UpdateFlagManager";
 /**
  * JointLimits is used to limit the joints angle.
  */
 export declare class JointLimits {
-    /** The upper angular limit (in degrees) of the joint. */
-    max: number;
-    /** The lower angular limit (in degrees) of the joint. */
-    min: number;
-    /** Distance inside the limit value at which the limit will be considered to be active by the solver. */
-    contactDistance: number;
-    /** The spring forces used to reach the target position. */
-    stiffness: number;
-    /** The damper force uses to dampen the spring. */
-    damping: number;
+    /** @internal */
+    _updateFlagManager: UpdateFlagManager;
+    private _max;
+    private _min;
+    private _contactDistance;
+    private _stiffness;
+    private _damping;
+    /**
+     * The upper angular limit (in radians) of the joint.
+     */
+    get max(): number;
+    set max(value: number);
+    /**
+     * The lower angular limit (in radians) of the joint.
+     */
+    get min(): number;
+    set min(value: number);
+    /**
+     * Distance inside the limit value at which the limit will be considered to be active by the solver.
+     * Default is the lesser of 0.1 radians, and 0.49 * (upperLimit - lowerLimit)
+     */
+    get contactDistance(): number;
+    set contactDistance(value: number);
+    /**
+     * The spring forces used to reach the target position.
+     */
+    get stiffness(): number;
+    set stiffness(value: number);
+    /**
+     * The damper force uses to dampen the spring.
+     */
+    get damping(): number;
+    set damping(value: number);
 }

package/types/physics/joint/JointMotor.d.ts

@@ -1,13 +1,32 @@
+import { UpdateFlagManager } from "../../UpdateFlagManager";
 /**
  * The JointMotor is used to motorize a joint.
  */
 export declare class JointMotor {
-    /** The motor will apply a force up to force to achieve targetVelocity. */
-    targetVelocity: number;
-    /** The force limit.*/
-    forceLimit: number;
-    /** Gear ration for the motor */
-    gearRation: number;
-    /** If freeSpin is enabled the motor will only accelerate but never slow down. */
-    freeSpin: boolean;
+    /** @internal */
+    _updateFlagManager: UpdateFlagManager;
+    private _targetVelocity;
+    private _forceLimit;
+    private _gearRatio;
+    private _freeSpin;
+    /**
+     * The motor will apply a force up to force to achieve targetVelocity.
+     */
+    get targetVelocity(): number;
+    set targetVelocity(value: number);
+    /**
+     * The force limit.
+     */
+    get forceLimit(): number;
+    set forceLimit(value: number);
+    /**
+     * Gear ration for the motor
+     */
+    get gearRatio(): number;
+    set gearRatio(value: number);
+    /**
+     * If freeSpin is enabled the motor will only accelerate but never slow down.
+     */
+    get freeSpin(): boolean;
+    set freeSpin(value: boolean);
 }

package/types/physics/joint/SpringJoint.d.ts

@@ -1,4 +1,3 @@
-import { Vector3 } from "@galacean/engine-math";
 import { Joint } from "./Joint";
 /**
  * A joint that maintains an upper or lower bound (or both) on the distance between two points on different objects.
@@ -9,11 +8,6 @@ export declare class SpringJoint extends Joint {
     private _tolerance;
     private _stiffness;
     private _damping;
-    /**
-     * The swing offset.
-     */
-    get swingOffset(): Vector3;
-    set swingOffset(value: Vector3);
     /**
      * The minimum distance.
      */
@@ -39,4 +33,6 @@ export declare class SpringJoint extends Joint {
      */
     get damping(): number;
     set damping(value: number);
+    protected _createJoint(): void;
+    protected _syncNative(): void;
 }

package/types/physics/shape/BoxColliderShape.d.ts

@@ -11,5 +11,6 @@ export declare class BoxColliderShape extends ColliderShape {
     get size(): Vector3;
     set size(value: Vector3);
     constructor();
+    protected _syncNative(): void;
     private _setSize;
 }

package/types/physics/shape/CapsuleColliderShape.d.ts

@@ -23,4 +23,5 @@ export declare class CapsuleColliderShape extends ColliderShape {
     get upAxis(): ColliderShapeUpAxis;
     set upAxis(value: ColliderShapeUpAxis);
     constructor();
+    protected _syncNative(): void;
 }

package/types/physics/shape/ColliderShape.d.ts

@@ -22,7 +22,7 @@ export declare abstract class ColliderShape implements ICustomClone {
      */
     get id(): number;
     /**
-     * Contact offset for this shape.
+     * Contact offset for this shape, the value must be greater than or equal to 0.
      */
     get contactOffset(): number;
     set contactOffset(value: number);
@@ -47,6 +47,7 @@ export declare abstract class ColliderShape implements ICustomClone {
     get isTrigger(): boolean;
     set isTrigger(value: boolean);
     protected constructor();
+    protected _syncNative(): void;
     private _setPosition;
     private _setRotation;
 }

package/types/physics/shape/SphereColliderShape.d.ts

@@ -10,5 +10,5 @@ export declare class SphereColliderShape extends ColliderShape {
     get radius(): number;
     set radius(value: number);
     constructor();
-    _cloneTo(target: SphereColliderShape): void;
+    protected _syncNative(): void;
 }