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

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 in degrees for the controller, the value is the cosine value of the maximum slope angle.
+     * @defaultValue 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/Collision.d.ts

@@ -1,4 +1,22 @@
+import { ContactPoint } from "./ContactPoint";
 import { ColliderShape } from "./shape";
+/**
+ * Collision information between two shapes when they collide.
+ */
 export declare class Collision {
+    /** The target shape be collided. */
     shape: ColliderShape;
+    /**
+     * Count of contact points.
+     */
+    get contactCount(): number;
+    /**
+     * Get contact points.
+     * @param outContacts - The result of contact points
+     * @returns The actual count of contact points
+     *
+     * @remarks To optimize performance, the engine does not modify the length of the array you pass.
+     * You need to obtain the actual number of contact points from the function's return value.
+     */
+    getContacts(outContacts: ContactPoint[]): number;
 }

package/types/physics/ContactPoint.d.ts

@@ -0,0 +1,14 @@
+import { Vector3 } from "@galacean/engine-math";
+/**
+ * Describes a contact point where the collision occurs.
+ */
+export declare class ContactPoint {
+    /** The position of the contact point between the shapes, in world space. */
+    readonly position: Vector3;
+    /** The normal of the contacting surfaces at the contact point. The normal direction points from the second shape to the first shape. */
+    readonly normal: Vector3;
+    /** The impulse applied at the contact point, in world space. Divide by the simulation time step to get a force value. */
+    readonly impulse: Vector3;
+    /** The separation of the shapes at the contact point.  A negative separation denotes a penetration. */
+    separation: number;
+}

package/types/physics/DynamicCollider.d.ts

@@ -14,10 +14,13 @@ export declare class DynamicCollider extends Collider {
     private _maxAngularVelocity;
     private _maxDepenetrationVelocity;
     private _solverIterations;
+    private _useGravity;
     private _isKinematic;
     private _constraints;
     private _collisionDetectionMode;
     private _sleepThreshold;
+    private _automaticCenterOfMass;
+    private _automaticInertiaTensor;
     /**
      * The linear damping of the dynamic collider.
      */
@@ -34,7 +37,7 @@ export declare class DynamicCollider extends Collider {
     get linearVelocity(): Vector3;
     set linearVelocity(value: Vector3);
     /**
-     * The angular velocity vector of the dynamic collider measured in radians per second.
+     * The angular velocity vector of the dynamic collider measured in degrees per second.
      */
     get angularVelocity(): Vector3;
     set angularVelocity(value: Vector3);
@@ -43,18 +46,32 @@ 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);
     /**
-     * The maximum angular velocity of the collider measured in radians per second. (Default 7) range { 0, infinity }.
+     * The maximum angular velocity of the collider measured in degrees per second.
      */
     get maxAngularVelocity(): number;
     set maxAngularVelocity(value: number);
@@ -73,6 +90,11 @@ export declare class DynamicCollider extends Collider {
      */
     get solverIterations(): number;
     set solverIterations(value: number);
+    /**
+     * Controls whether gravity affects the dynamic collider.
+     */
+    get useGravity(): boolean;
+    set useGravity(value: boolean);
     /**
      * Controls whether physics affects the dynamic collider.
      */
@@ -118,14 +140,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);
@@ -35,4 +35,8 @@ export declare class PhysicsMaterial {
      */
     get frictionCombine(): PhysicsMaterialCombineMode;
     set frictionCombine(value: PhysicsMaterialCombineMode);
+    /**
+     * Destroy the material when the material is no be used by any shape.
+     */
+    destroy(): void;
 }

package/types/physics/index.d.ts

@@ -5,6 +5,8 @@ export { HitResult } from "./HitResult";
 export { PhysicsMaterial } from "./PhysicsMaterial";
 export { PhysicsScene } from "./PhysicsScene";
 export { StaticCollider } from "./StaticCollider";
+export { Collision } from "./Collision";
+export { ContactPoint } from "./ContactPoint";
 export * from "./enums";
 export * from "./joint";
 export * from "./shape";

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,45 +3,58 @@ 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;
+    private _updateConnectedActualAnchor;
     /**
      * The connected collider.
      */
     get connectedCollider(): Collider;
     set connectedCollider(value: Collider);
+    /**
+     * The anchor 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.
+     * The connectedAnchor is automatically calculated, if you want to set it manually, please set automaticConnectedAnchor to false
      */
     get connectedAnchor(): Vector3;
     set connectedAnchor(value: Vector3);
     /**
-     *  The scale to apply to the inverse mass of collider 0 for resolving this constraint.
+     * 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 connectedMassScale(): number;
-    set connectedMassScale(value: number);
+    get automaticConnectedAnchor(): boolean;
+    set automaticConnectedAnchor(value: boolean);
     /**
-     * The scale to apply to the inverse inertia of collider0 for resolving this constraint.
+     *  The scale to apply to the mass of collider 0 for resolving this constraint.
      */
-    get connectedInertiaScale(): number;
-    set connectedInertiaScale(value: number);
+    get connectedMassScale(): number;
+    set connectedMassScale(value: number);
     /**
-     * The scale to apply to the inverse mass of collider 1 for resolving this constraint.
+     * The scale to apply to the mass of collider 1 for resolving this constraint.
      */
     get massScale(): number;
     set massScale(value: number);
     /**
-     * The scale to apply to the inverse inertia of collider1 for resolving this constraint.
+     * The scale to apply to the inertia of collider0 for resolving this constraint.
+     */
+    get connectedInertiaScale(): number;
+    set connectedInertiaScale(value: number);
+    /**
+     * The scale to apply to the inertia of collider1 for resolving this constraint.
      */
     get inertiaScale(): number;
     set inertiaScale(value: number);
@@ -56,4 +69,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 degrees) of the joint.
+     */
+    get max(): number;
+    set max(value: number);
+    /**
+     * The lower angular limit (in degrees) 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,17 +22,17 @@ 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);
     /**
-     * Physical material.
+     * Physical material, material can't be null.
      */
     get material(): PhysicsMaterial;
     set material(value: PhysicsMaterial);
     /**
-     * The local rotation of this ColliderShape.
+     * The local rotation of this ColliderShape, in degrees.
      */
     get rotation(): Vector3;
     set rotation(value: Vector3);
@@ -47,6 +47,14 @@ export declare abstract class ColliderShape implements ICustomClone {
     get isTrigger(): boolean;
     set isTrigger(value: boolean);
     protected constructor();
+    /**
+     * Get the distance and the closest point on the shape from a point.
+     * @param point - Location in world space you want to find the closest point to
+     * @param outClosestPoint - The closest point on the shape in world space
+     * @returns The distance between the point and the shape
+     */
+    getClosestPoint(point: Vector3, outClosestPoint: Vector3): number;
+    protected _syncNative(): void;
     private _setPosition;
     private _setRotation;
 }

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

@@ -1,7 +1,9 @@
+import { Vector3 } from "@galacean/engine-math";
 import { ColliderShape } from "./ColliderShape";
 /**
  * Physical collider shape plane.
  */
 export declare class PlaneColliderShape extends ColliderShape {
     constructor();
+    getClosestPoint(point: Vector3, closestPoint: Vector3): number;
 }

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

package/types/postProcess/PostProcess.d.ts

@@ -0,0 +1,60 @@
+import { Component } from "../Component";
+import { Layer } from "../Layer";
+import { PostProcessEffect } from "./PostProcessEffect";
+/**
+ * Post Process component can be used for global or local post-processing.
+ */
+export declare class PostProcess extends Component {
+    /**
+     * The layer to which the PostProcess belongs.
+     */
+    layer: Layer;
+    /**
+     * The outer distance to start blending from, only takes effect when the `isGlobal` is false.
+     */
+    blendDistance: number;
+    private _priority;
+    private _isGlobal;
+    /**
+     * Whether the PostProcess is global.
+     * @remarks
+     * Specifies whether to apply the PostProcess to the entire Scene or in Colliders.
+     * Only support local PostProcess in physics enabled Scenes.
+     */
+    get isGlobal(): boolean;
+    set isGlobal(value: boolean);
+    /**
+     * A value which determines which PostProcess is being used when PostProcess have an equal amount of influence on the Scene.
+     * @remarks
+     * PostProcess with a higher priority will override lower ones.
+     */
+    get priority(): number;
+    set priority(value: number);
+    /**
+     * Get the PostProcessEffect by type.
+     * @param type - The type of PostProcessEffect
+     * @returns The PostProcessEffect found
+     */
+    getEffect<T extends typeof PostProcessEffect>(type: T): InstanceType<T>;
+    /**
+     * Add a PostProcessEffect to the PostProcess.
+     * @remarks Only one effect of the same type can be added to the PostProcess.
+     * @param type - The type of PostProcessEffect
+     * @returns The PostProcessEffect added
+     */
+    addEffect<T extends typeof PostProcessEffect>(type: T): InstanceType<T>;
+    /**
+     * Remove a PostProcessEffect from the PostProcess.
+     * @param type - The type of PostProcessEffect
+     * @returns The PostProcessEffect removed
+     */
+    removeEffect<T extends typeof PostProcessEffect>(type: T): InstanceType<T>;
+    /**
+     * @inheritdoc
+     */
+    _onEnableInScene(): void;
+    /**
+     * @inheritdoc
+     */
+    _onDisableInScene(): void;
+}

package/types/postProcess/PostProcessEffect.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The base class for post process effect.
+ */
+export declare class PostProcessEffect {
+    private _enabled;
+    private _parameters;
+    private _parameterInitialized;
+    /**
+     * Indicates whether the post process effect is enabled.
+     */
+    get enabled(): boolean;
+    set enabled(value: boolean);
+    /**
+     * Whether the post process effect is valid.
+     * @remarks
+     * This method can be overridden to control the effect's real validity.
+     */
+    isValid(): boolean;
+    /**
+     * Get all parameters of the post process effect.
+     * @remarks
+     * Only get the parameters that are initialized in the constructor.
+     * It will don't take effect if you add a new parameter after the post process effect is created, such as `effect.** = new PostProcessEffectParameter(1)`
+     */
+    private _getParameters;
+}

package/types/postProcess/PostProcessEffectParameter.d.ts

@@ -0,0 +1,25 @@
+import { Color, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
+import { Texture } from "../texture/Texture";
+/**
+ * Represents a parameter of a post process effect.
+ * @remarks
+ * The parameter will be mixed to a final value and be used in post process manager.
+ */
+export declare class PostProcessEffectParameter<T extends Number | Boolean | Color | Vector2 | Vector3 | Vector4 | Texture> {
+    /**
+     * Whether the parameter is enabled.
+     */
+    enabled: boolean;
+    private _value;
+    private _needLerp;
+    private _min?;
+    private _max?;
+    /**
+     * The value of the parameter.
+     */
+    get value(): T;
+    set value(value: T);
+    constructor(value: Exclude<T, number>, needLerp?: boolean);
+    constructor(value: Exclude<T, Boolean | Color | Vector2 | Vector3 | Vector4 | Texture>, needLerp?: boolean);
+    constructor(value: Exclude<T, Boolean | Color | Vector2 | Vector3 | Vector4 | Texture>, min?: number, max?: number, needLerp?: boolean);
+}

package/types/postProcess/PostProcessManager.d.ts

@@ -1 +1,37 @@
-export {};
+import { Scene } from "../Scene";
+import { PostProcessEffect } from "./PostProcessEffect";
+/**
+ * A global manager of the PostProcess.
+ */
+export declare class PostProcessManager {
+    readonly scene: Scene;
+    private static _tempColliders;
+    private static _tempVector3;
+    private _activePostProcesses;
+    private _swapRenderTarget;
+    private _srcRenderTarget;
+    private _destRenderTarget;
+    private _currentSourceRenderTarget;
+    private _currentDestRenderTarget;
+    private _blendEffectMap;
+    private _defaultEffectMap;
+    private _remainActivePassCount;
+    /**
+     * Create a PostProcessManager.
+     * @param scene - Scene to which the current PostProcessManager belongs
+     */
+    constructor(scene: Scene);
+    /**
+     * Get the blend effect by type.
+     * @remarks
+     * The blend effect is a post process effect that is used to blend all result of the effects by the type.
+     * @param type - The type of PostProcessEffect
+     * @returns The PostProcessEffect instance found
+     */
+    getBlendEffect<T extends typeof PostProcessEffect>(type: T): InstanceType<T>;
+    private _sortActivePostProcess;
+    private _resetDefaultValue;
+    private _initSwapRenderTarget;
+    private _swapRT;
+    private _getCurrentSourceTexture;
+}