@galacean/engine-core 1.5.13 → 1.6.0-alpha.0

package/package.json

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

package/types/Engine.d.ts

@@ -32,7 +32,6 @@ export declare class Engine extends EventDispatcher {
     private _destroyed;
     private _frameInProcess;
     private _waitingDestroy;
-    private _isDeviceLost;
     private _waitingGC;
     private _postProcessPasses;
     private _activePostProcessPasses;

package/types/Transform.d.ts

@@ -29,7 +29,7 @@ export declare class Transform extends Component {
     private _worldForward;
     private _worldRight;
     private _worldUp;
-    private _isParentDirty;
+    protected _isParentDirty: boolean;
     private _parentTransformCache;
     private _dirtyFlag;
     /**
@@ -192,7 +192,16 @@ export declare class Transform extends Component {
      * @param worldUp - Up direction in world space, default is Vector3(0, 1, 0)
      */
     lookAt(targetPosition: Vector3, worldUp?: Vector3): void;
-    protected _onDestroy(): void;
+    protected _onLocalMatrixChanging?(): void;
+    protected _onWorldMatrixChange(): void;
+    protected _isContainDirtyFlags(targetDirtyFlags: number): boolean;
+    protected _isContainDirtyFlag(type: number): boolean;
+    protected _setDirtyFlagTrue(type: number): void;
+    protected _setDirtyFlagFalse(type: number): void;
+    protected _worldAssociatedChange(type: number): void;
+    protected _getParentTransform(): Transform | null;
+    protected _onPositionChanged(): void;
+    protected _onWorldPositionChanged(): 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.
@@ -239,18 +248,10 @@ export declare class Transform extends Component {
      * @param flags - Dirty flag
      */
     private _updateAllWorldFlag;
-    private _getParentTransform;
     private _getScaleMatrix;
-    private _isContainDirtyFlags;
-    private _isContainDirtyFlag;
-    private _setDirtyFlagTrue;
-    private _setDirtyFlagFalse;
-    private _worldAssociatedChange;
     private _rotateByQuat;
     private _translate;
     private _rotateXYZ;
-    private _onPositionChanged;
-    private _onWorldPositionChanged;
     private _onRotationChanged;
     private _onWorldRotationChanged;
     private _onRotationQuaternionChanged;
@@ -264,3 +265,38 @@ export declare class Transform extends Component {
      */
     registerWorldChangeFlag(): BoolUpdateFlag;
 }
+/**
+ * Dirty flag of transform.
+ */
+export declare enum TransformModifyFlags {
+    LocalEuler = 1,
+    LocalQuat = 2,
+    WorldPosition = 4,
+    WorldEuler = 8,
+    WorldQuat = 16,
+    WorldScale = 32,
+    LocalMatrix = 64,
+    WorldMatrix = 128,
+    /** This is an internal flag used to assist in determining the dispatch
+     *  of world scaling dirty flags in the case of non-uniform scaling.
+     */
+    IsWorldUniformScaling = 256,
+    /** WorldMatrix | WorldPosition */
+    WmWp = 132,
+    /** WorldMatrix | WorldEuler | WorldQuat */
+    WmWeWq = 152,
+    /** WorldMatrix | WorldEuler | WorldQuat | WorldScale*/
+    WmWeWqWs = 184,
+    /** WorldMatrix | WorldPosition | WorldEuler | WorldQuat */
+    WmWpWeWq = 156,
+    /** WorldMatrix | WorldScale */
+    WmWs = 160,
+    /** WorldMatrix | WorldScale | WorldUniformScaling */
+    WmWsWus = 416,
+    /** WorldMatrix | WorldPosition | WorldScale */
+    WmWpWs = 164,
+    /** WorldMatrix | WorldPosition | WorldEuler | WorldQuat | WorldScale */
+    WmWpWeWqWs = 188,
+    /** WorldMatrix | WorldPosition | WorldEuler | WorldQuat | WorldScale | WorldUniformScaling */
+    WmWpWeWqWsWus = 444
+}

package/types/asset/AssetPromise.d.ts

@@ -66,12 +66,13 @@ export declare class AssetPromise<T> implements PromiseLike<T> {
      */
     catch(onRejected: (reason: any) => any): AssetPromise<T>;
     /**
-     * Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
-     * resolved value cannot be modified from the callback.
-     * @param onfinally The callback to execute when the Promise is settled (fulfilled or rejected).
-     * @returns A Promise for the completion of the callback.
+     * Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected).
+     * The callback result is ignored and the original value/reason is preserved per Promise spec.
+     * Returns an AssetPromise to keep chainability with AssetPromise methods.
+     * @param onFinally - The callback to execute when the Promise is settled.
+     * @returns An AssetPromise for the completion of the callback.
      */
-    finally(onFinally?: () => void): Promise<T>;
+    finally(onFinally?: () => void): AssetPromise<T>;
     /**
      * Cancel promise request.
      * @returns Asset promise

package/types/base/Constant.d.ts

@@ -99,6 +99,7 @@ export declare enum GLCapabilityType {
     fragDepth = "EXT_frag_depth",
     astc = "WEBGL_compressed_texture_astc",
     astc_webkit = "WEBKIT_WEBGL_compressed_texture_astc",
+    astc_hdr = "WEBGL_compressed_texture_astc_hdr",
     etc = "WEBGL_compressed_texture_etc",
     etc_webkit = "WEBKIT_WEBGL_compressed_texture_etc",
     etc1 = "WEBGL_compressed_texture_etc1",

package/types/index.d.ts

@@ -11,7 +11,7 @@ export { Script } from "./Script";
 export { Renderer, RendererUpdateFlags } from "./Renderer";
 export { dependentComponents, DependentMode } from "./ComponentsDependencies";
 export { Camera } from "./Camera";
-export { Transform } from "./Transform";
+export { Transform, TransformModifyFlags } from "./Transform";
 export { BoolUpdateFlag } from "./BoolUpdateFlag";
 export type { EngineSettings } from "./EngineSettings";
 export type { EngineConfiguration } from "./Engine";

package/types/material/PBRMaterial.d.ts

@@ -1,12 +1,21 @@
-import { Color, Vector2 } from "@galacean/engine-math";
+import { Color, Vector2, Vector4 } from "@galacean/engine-math";
 import { Engine } from "../Engine";
 import { Texture2D } from "../texture/Texture2D";
-import { PBRBaseMaterial } from "./PBRBaseMaterial";
+import { BaseMaterial } from "./BaseMaterial";
 import { RefractionMode } from "./enums/Refraction";
+import { TextureCoordinate } from "./enums/TextureCoordinate";
 /**
  * PBR (Metallic-Roughness Workflow) Material.
  */
-export declare class PBRMaterial extends PBRBaseMaterial {
+export declare class PBRMaterial extends BaseMaterial {
+    private static _occlusionTextureIntensityProp;
+    private static _occlusionTextureCoordProp;
+    private static _occlusionTextureProp;
+    private static _clearCoatProp;
+    private static _clearCoatTextureProp;
+    private static _clearCoatRoughnessProp;
+    private static _clearCoatRoughnessTextureProp;
+    private static _clearCoatNormalTextureProp;
     private static _metallicProp;
     private static _roughnessProp;
     private static _roughnessMetallicTextureProp;
@@ -30,10 +39,92 @@ export declare class PBRMaterial extends PBRBaseMaterial {
     private static _attenuationDistanceProp;
     private static _thicknessProp;
     private static _thicknessTextureProp;
+    private static _specularTextureMacro;
+    private static _specularColorTextureMacro;
+    private static _specularIntensityProp;
+    private static _specularColorProp;
+    private static _specularIntensityTextureProp;
+    private static _specularColorTextureProp;
     private _refractionMode;
     private _anisotropyRotation;
     private _iridescenceRange;
     private _sheenEnabled;
+    /**
+     * Base color.
+     */
+    get baseColor(): Color;
+    set baseColor(value: Color);
+    /**
+     * Base texture.
+     */
+    get baseTexture(): Texture2D;
+    set baseTexture(value: Texture2D);
+    /**
+     * Normal texture.
+     */
+    get normalTexture(): Texture2D;
+    set normalTexture(value: Texture2D);
+    /**
+     * Normal texture intensity.
+     */
+    get normalTextureIntensity(): number;
+    set normalTextureIntensity(value: number);
+    /**
+     * Emissive color.
+     */
+    get emissiveColor(): Color;
+    set emissiveColor(value: Color);
+    /**
+     * Emissive texture.
+     */
+    get emissiveTexture(): Texture2D;
+    set emissiveTexture(value: Texture2D);
+    /**
+     * Occlusion texture.
+     */
+    get occlusionTexture(): Texture2D;
+    set occlusionTexture(value: Texture2D);
+    /**
+     * Occlusion texture intensity.
+     */
+    get occlusionTextureIntensity(): number;
+    set occlusionTextureIntensity(value: number);
+    /**
+     * Occlusion texture uv coordinate.
+     * @remarks Must be UV0 or UV1.
+     */
+    get occlusionTextureCoord(): TextureCoordinate;
+    set occlusionTextureCoord(value: TextureCoordinate);
+    /**
+     * Tiling and offset of main textures.
+     */
+    get tilingOffset(): Vector4;
+    set tilingOffset(value: Vector4);
+    /**
+     * The clearCoat layer intensity, default 0.
+     */
+    get clearCoat(): number;
+    set clearCoat(value: number);
+    /**
+     * The clearCoat layer intensity texture.
+     */
+    get clearCoatTexture(): Texture2D;
+    set clearCoatTexture(value: Texture2D);
+    /**
+     * The clearCoat layer roughness, default 0.
+     */
+    get clearCoatRoughness(): number;
+    set clearCoatRoughness(value: number);
+    /**
+     * The clearCoat layer roughness texture.
+     */
+    get clearCoatRoughnessTexture(): Texture2D;
+    set clearCoatRoughnessTexture(value: Texture2D);
+    /**
+     * The clearCoat normal map texture.
+     */
+    get clearCoatNormalTexture(): Texture2D;
+    set clearCoatNormalTexture(value: Texture2D);
     /**
      * Index Of Refraction.
      * @defaultValue `1.5`
@@ -184,6 +275,28 @@ export declare class PBRMaterial extends PBRBaseMaterial {
      */
     get thicknessTexture(): Texture2D;
     set thicknessTexture(value: Texture2D);
+    /**
+     * The intensity of the specular reflection.
+     * @defaultValue `1.0`
+     */
+    get specularIntensity(): number;
+    set specularIntensity(value: number);
+    /**
+     * The F0 color of the specular reflection.
+     * @defaultValue `[1,1,1]`
+     */
+    get specularColor(): Color;
+    set specularColor(value: Color);
+    /**
+     * The intensity of the specular reflection, stored in alpha(A) channel. This will be multiplied by `specularIntensity`.
+     */
+    get specularIntensityTexture(): Texture2D;
+    set specularIntensityTexture(value: Texture2D);
+    /**
+     * The F0 color of the specular reflection, stored in the RGB channels. This will be multiplied by `specularColor`.
+     */
+    get specularColorTexture(): Texture2D;
+    set specularColorTexture(value: Texture2D);
     /**
      * Create a pbr metallic-roughness workflow material instance.
      * @param engine - Engine to which the material belongs

package/types/material/index.d.ts

@@ -4,8 +4,6 @@ export { BlendMode } from "./enums/BlendMode";
 export { RenderFace } from "./enums/RenderFace";
 export { TextureCoordinate } from "./enums/TextureCoordinate";
 export { Material } from "./Material";
-export { PBRBaseMaterial } from "./PBRBaseMaterial";
 export { PBRMaterial } from "./PBRMaterial";
-export { PBRSpecularMaterial } from "./PBRSpecularMaterial";
 export { UnlitMaterial } from "./UnlitMaterial";
 export { RefractionMode } from "./enums/Refraction";

package/types/physics/PhysicsScene.d.ts

@@ -1,12 +1,14 @@
-import { Ray, Vector3 } from "@galacean/engine-math";
+import { Ray, Vector3, Quaternion } from "@galacean/engine-math";
 import { Layer } from "../Layer";
 import { Scene } from "../Scene";
 import { HitResult } from "./HitResult";
+import { ColliderShape } from "./shape";
 /**
  * A physics scene is a collection of colliders and constraints which can interact.
  */
 export declare class PhysicsScene {
     private static _collision;
+    private static _identityQuaternion;
     private _scene;
     private _restTime;
     private _fixedTimeStep;
@@ -89,5 +91,74 @@ export declare class PhysicsScene {
      * @returns Returns True if the ray intersects with a collider, otherwise false.
      */
     raycast(ray: Ray, distance: number, layerMask: Layer, outHitResult: HitResult): boolean;
+    /**
+     * Casts a box through the Scene and returns true if there is any hit.
+     * @param center - The center of the box
+     * @param halfExtents - Half the size of the box in each dimension
+     * @param direction - The direction to sweep along
+     * @param orientation - The rotation of the box. @defaultValue `Quaternion(0, 0, 0, 1)`
+     * @param distance - The max distance to sweep. @defaultValue `Number.MAX_VALUE`
+     * @param layerMask - Layer mask that is used to selectively ignore Colliders when sweeping. @defaultValue `Layer.Everything`
+     * @param outHitResult - Optional HitResult object to store detailed hit information
+     * @returns Returns true if the box intersects with any collider, otherwise false
+     */
+    boxCast(center: Vector3, halfExtents: Vector3, direction: Vector3, orientation?: Quaternion, distance?: number, layerMask?: Layer, outHitResult?: HitResult): boolean;
+    /**
+     * Casts a sphere through the Scene and returns true if there is any hit.
+     * @param center - The center of the sphere
+     * @param radius - The radius of the sphere
+     * @param direction - The direction to sweep along
+     * @param distance - The max distance to sweep. @defaultValue `Number.MAX_VALUE`
+     * @param layerMask - Layer mask that is used to selectively ignore Colliders when sweeping. @defaultValue `Layer.Everything`
+     * @param outHitResult - If true is returned, outHitResult will contain more detailed collision information
+     * @returns Returns True if the sphere intersects with any collider, otherwise false
+     */
+    sphereCast(center: Vector3, radius: number, direction: Vector3, distance?: number, layerMask?: Layer, outHitResult?: HitResult): boolean;
+    /**
+     * Casts a capsule through the Scene and returns true if there is any hit.
+     * @param center - The center of the capsule
+     * @param radius - The radius of the capsule
+     * @param height - The height of the capsule
+     * @param direction - The direction to sweep along
+     * @param orientation - The rotation of the capsule. @defaultValue `Quaternion(0, 0, 0, 1)`
+     * @param distance - The max distance to sweep. @defaultValue `Number.MAX_VALUE`
+     * @param layerMask - Layer mask that is used to selectively ignore Colliders when sweeping. @defaultValue `Layer.Everything`
+     * @param outHitResult - If true is returned, outHitResult will contain more detailed collision information
+     * @returns Returns True if the capsule intersects with any collider, otherwise false
+     */
+    capsuleCast(center: Vector3, radius: number, height: number, direction: Vector3, orientation?: Quaternion, distance?: number, layerMask?: Layer, outHitResult?: HitResult): boolean;
+    /**
+     * Get all colliders that overlap with a box in the scene.
+     * @param center - The center of the box
+     * @param halfExtents - Half the size of the box in each dimension
+     * @param orientation - The rotation of the box. @defaultValue `Quaternion(0, 0, 0, 1)`
+     * @param layerMask - Layer mask that is used to selectively filter colliders. @defaultValue `Layer.Everything`
+     * @param shapes - Array to store overlapping collider shapes. @defaultValue `[]`
+     * @returns The collider shapes overlapping with the box
+     */
+    overlapBoxAll(center: Vector3, halfExtents: Vector3, orientation?: Quaternion, layerMask?: Layer, shapes?: ColliderShape[]): ColliderShape[];
+    /**
+     * Get all colliders that overlap with a sphere in the scene.
+     * @param center - The center of the sphere
+     * @param radius - The radius of the sphere
+     * @param layerMask - Layer mask that is used to selectively filter colliders. @defaultValue `Layer.Everything`
+     * @param shapes - Array to store overlapping collider shapes. @defaultValue `[]`
+     * @returns The collider shapes overlapping with the sphere
+     */
+    overlapSphereAll(center: Vector3, radius: number, layerMask?: Layer, shapes?: ColliderShape[]): ColliderShape[];
+    /**
+     * Get all colliders that overlap with a capsule in the scene.
+     * @param center - The center of the capsule
+     * @param radius - The radius of the capsule
+     * @param height - The height of the capsule
+     * @param orientation - The rotation of the capsule. @defaultValue `Quaternion(0, 0, 0, 1)`
+     * @param layerMask - Layer mask that is used to selectively filter colliders. @defaultValue `Layer.Everything`
+     * @param shapes - Array to store overlapping collider shapes. @defaultValue `[]`
+     * @returns The collider shapes overlapping with the capsule
+     */
+    overlapCapsuleAll(center: Vector3, radius: number, height: number, orientation?: Quaternion, layerMask?: Layer, shapes?: ColliderShape[]): ColliderShape[];
     private _setGravity;
+    private _createPreFilter;
+    private _createHitCallback;
+    private _clearHitResult;
 }

package/types/texture/enums/TextureFormat.d.ts

@@ -30,6 +30,8 @@ export declare enum TextureFormat {
     BC3 = 11,
     /** RGB(A) compressed format, 128 bits per 4x4 pixel block. */
     BC7 = 12,
+    /** RGB HDR compressed format, 8 bits per pixel. */
+    BC6H = 100,
     /** RGB compressed format, 4 bits per pixel. */
     ETC1_RGB = 13,
     /** RGB compressed format, 4 bits per pixel. */

package/types/material/PBRBaseMaterial.d.ts

@@ -1,101 +0,0 @@
-import { Color, Vector4 } from "@galacean/engine-math";
-import { Engine } from "../Engine";
-import { Shader } from "../shader/Shader";
-import { Texture2D } from "../texture/Texture2D";
-import { BaseMaterial } from "./BaseMaterial";
-import { TextureCoordinate } from "./enums/TextureCoordinate";
-/**
- * PBR (Physically-Based Rendering) Material.
- */
-export declare abstract class PBRBaseMaterial extends BaseMaterial {
-    private static _occlusionTextureIntensityProp;
-    private static _occlusionTextureCoordProp;
-    private static _occlusionTextureProp;
-    private static _clearCoatProp;
-    private static _clearCoatTextureProp;
-    private static _clearCoatRoughnessProp;
-    private static _clearCoatRoughnessTextureProp;
-    private static _clearCoatNormalTextureProp;
-    /**
-     * Base color.
-     */
-    get baseColor(): Color;
-    set baseColor(value: Color);
-    /**
-     * Base texture.
-     */
-    get baseTexture(): Texture2D;
-    set baseTexture(value: Texture2D);
-    /**
-     * Normal texture.
-     */
-    get normalTexture(): Texture2D;
-    set normalTexture(value: Texture2D);
-    /**
-     * Normal texture intensity.
-     */
-    get normalTextureIntensity(): number;
-    set normalTextureIntensity(value: number);
-    /**
-     * Emissive color.
-     */
-    get emissiveColor(): Color;
-    set emissiveColor(value: Color);
-    /**
-     * Emissive texture.
-     */
-    get emissiveTexture(): Texture2D;
-    set emissiveTexture(value: Texture2D);
-    /**
-     * Occlusion texture.
-     */
-    get occlusionTexture(): Texture2D;
-    set occlusionTexture(value: Texture2D);
-    /**
-     * Occlusion texture intensity.
-     */
-    get occlusionTextureIntensity(): number;
-    set occlusionTextureIntensity(value: number);
-    /**
-     * Occlusion texture uv coordinate.
-     * @remarks Must be UV0 or UV1.
-     */
-    get occlusionTextureCoord(): TextureCoordinate;
-    set occlusionTextureCoord(value: TextureCoordinate);
-    /**
-     * Tiling and offset of main textures.
-     */
-    get tilingOffset(): Vector4;
-    set tilingOffset(value: Vector4);
-    /**
-     * The clearCoat layer intensity, default 0.
-     */
-    get clearCoat(): number;
-    set clearCoat(value: number);
-    /**
-     * The clearCoat layer intensity texture.
-     */
-    get clearCoatTexture(): Texture2D;
-    set clearCoatTexture(value: Texture2D);
-    /**
-     * The clearCoat layer roughness, default 0.
-     */
-    get clearCoatRoughness(): number;
-    set clearCoatRoughness(value: number);
-    /**
-     * The clearCoat layer roughness texture.
-     */
-    get clearCoatRoughnessTexture(): Texture2D;
-    set clearCoatRoughnessTexture(value: Texture2D);
-    /**
-     * The clearCoat normal map texture.
-     */
-    get clearCoatNormalTexture(): Texture2D;
-    set clearCoatNormalTexture(value: Texture2D);
-    /**
-     * Create a pbr base material instance.
-     * @param engine - Engine to which the material belongs
-     * @param shader - Shader used by the material
-     */
-    protected constructor(engine: Engine, shader: Shader);
-}

package/types/material/PBRSpecularMaterial.d.ts

@@ -1,38 +0,0 @@
-import { Color } from "@galacean/engine-math";
-import { Engine } from "../Engine";
-import { Texture2D } from "../texture/Texture2D";
-import { PBRBaseMaterial } from "./PBRBaseMaterial";
-/**
- * PBR (Specular-Glossiness Workflow) Material.
- */
-export declare class PBRSpecularMaterial extends PBRBaseMaterial {
-    private static _specularColorProp;
-    private static _glossinessProp;
-    private static _specularGlossinessTextureProp;
-    private static _specularGlossinessTextureMacro;
-    /**
-     * Specular color.
-     */
-    get specularColor(): Color;
-    set specularColor(value: Color);
-    /**
-     * Glossiness.
-     */
-    get glossiness(): number;
-    set glossiness(value: number);
-    /**
-     * Specular glossiness texture.
-     * @remarks RGB is specular, A is glossiness
-     */
-    get specularGlossinessTexture(): Texture2D;
-    set specularGlossinessTexture(value: Texture2D);
-    /**
-     * Create a pbr specular-glossiness workflow material instance.
-     * @param engine - Engine to which the material belongs
-     */
-    constructor(engine: Engine);
-    /**
-     * @inheritdoc
-     */
-    clone(): PBRSpecularMaterial;
-}