@galacean/engine-core 1.1.0-beta.3 → 1.1.0-beta.31

package/package.json

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

package/types/2d/atlas/types.d.ts

@@ -1,3 +1,4 @@
+import { AssetType } from "../../asset/AssetType";
 import { TextureFilterMode, TextureFormat, TextureWrapMode } from "../../texture";
 /**
  * The original data type of the atlas.
@@ -16,6 +17,8 @@ export interface AtlasConfig {
     atlasItems: {
         /** The url of the sub atlas. */
         img: string;
+        /** Image type. */
+        type: AssetType;
         /** Sprites contained in the sub atlas. */
         sprites: AtlasSprite[];
     }[];

package/types/2d/enums/SpriteModifyFlags.d.ts

@@ -9,5 +9,6 @@ export declare enum SpriteModifyFlags {
     atlasRegionOffset = 16,
     region = 32,
     pivot = 64,
-    border = 128
+    border = 128,
+    destroy = 256
 }

package/types/Background.d.ts

@@ -33,11 +33,19 @@ export declare class Background {
      */
     get texture(): Texture2D;
     set texture(value: Texture2D);
+    /**
+     * Background texture fill mode.
+     * @remarks When `mode` is `BackgroundMode.Texture`, the property will take effects.
+     * @defaultValue `BackgroundTextureFillMode.FitHeight`
+     */
+    get textureFillMode(): BackgroundTextureFillMode;
     set textureFillMode(value: BackgroundTextureFillMode);
     /**
      * Constructor of Background.
      * @param _engine Engine Which the background belongs to.
      */
     constructor(_engine: Engine);
+    private _initMesh;
+    private _initMaterial;
     private _createPlane;
 }

package/types/Component.d.ts

@@ -5,8 +5,8 @@ import { Scene } from "./Scene";
  * The base class of the components.
  */
 export declare class Component extends EngineObject {
+    protected _phasedActiveInScene: boolean;
     private _phasedActive;
-    private _phasedActiveInScene;
     private _enabled;
     /**
      * Indicates whether the component is enabled.

package/types/DisorderedArray.d.ts

@@ -17,7 +17,7 @@ export declare class DisorderedArray<T> {
      * @returns The replaced item is used to reset its index
      */
     deleteByIndex(index: number): T;
-    forEach(callbackFn: (e: T) => void): void;
+    forEach(callbackFn: (element: T) => void, swapFn: (element: T, index: number) => void): void;
     forEachAndClean(callbackFn: (e: T) => void): void;
     garbageCollection(): void;
     private _startLoop;

package/types/Scene.d.ts

@@ -41,6 +41,12 @@ export declare class Scene extends EngineObject {
     private _fogEnd;
     private _fogDensity;
     private _fogParams;
+    private _isActive;
+    /**
+     * Whether the scene is active.
+     */
+    get isActive(): boolean;
+    set isActive(value: boolean);
     /**
      * Scene-related shader data.
      */

package/types/animation/AnimatorLayerMask.d.ts

@@ -0,0 +1,45 @@
+import { Entity } from "../Entity";
+import { LayerPathMask } from "./LayerPathMask";
+/**
+ * AnimatorLayerMask is used to mask out certain entities from being animated by an AnimatorLayer.
+ */
+export declare class AnimatorLayerMask {
+    /**
+     * Creates an AnimatorLayerMask instance by specifying an entity.
+     * This will automatically add path masks for the entity and all its children.
+     * @param entity - The root entity to create path masks for
+     */
+    static createByEntity(entity: Entity): AnimatorLayerMask;
+    private static _addPathMaskWithChildren;
+    private _pathMasks;
+    private _pathMaskMap;
+    /**
+     * The list of path masks.
+     */
+    get pathMasks(): Readonly<LayerPathMask[]>;
+    /**
+     * Adds a path mask to the AnimatorLayerMask, the root path is "".
+     * @param path - The path to add a mask for
+     * @returns The created or existing LayerPathMask
+     */
+    addPathMask(path: string): LayerPathMask;
+    /**
+     * Removes a path mask from the AnimatorLayerMask.
+     * @param path - The path of the mask to remove
+     */
+    removePathMask(path: any): void;
+    /**
+     * Get a path mask based on the given path.
+     * @param path - The path of the mask to get
+     * @returns The LayerPathMask for the given path
+     */
+    getPathMask(path: string): LayerPathMask;
+    /**
+     * Sets the active state of a path mask.
+     * If recursive is true, it also sets the active state of all child path masks.
+     * @param path - The path of the mask to modify
+     * @param active - The active state to set
+     * @param withChildren - Whether to apply the active state recursively to child paths
+     */
+    setPathMaskActive(path: string, active: boolean, withChildren?: boolean): void;
+}

package/types/animation/LayerPathMask.d.ts

@@ -0,0 +1,16 @@
+/**
+ * LayerPathMask represents a mask for a specific entity in an animation layer.
+ * It is used to control the animation whether to be applied to the entity or not.
+ */
+export declare class LayerPathMask {
+    /**
+     * It identifies a particular entity in the hierarchy.
+     * Example: "arm/left/hand" could be a path to the left hand of a character.
+     */
+    path: string;
+    /**
+     * The active property is indicating whether the animation at this path is active or not.
+     * When true, the animation for this path is applied; when false, the animation for this path is ignored.
+     */
+    active: boolean;
+}

package/types/animation/animationCurve/AnimationStringCurve.d.ts

@@ -0,0 +1,7 @@
+import { AnimationCurve } from "./AnimationCurve";
+/**
+ * Store a collection of Keyframes that can be evaluated over time.
+ */
+export declare class AnimationStringCurve extends AnimationCurve<string> {
+    constructor();
+}

package/types/asset/AssetPromise.d.ts

@@ -13,6 +13,7 @@ export declare class AssetPromise<T> implements PromiseLike<T> {
     get [Symbol.toStringTag](): string;
     private _promise;
     private _state;
+    private _progress;
     private _onProgressCallback;
     private _onCancelHandler;
     private _reject;

package/types/asset/ResourceManager.d.ts

@@ -104,7 +104,6 @@ export declare class ResourceManager {
     private _gc;
     private _getResolveResource;
     private _parseURL;
-    private _getParameterByName;
     private _parseQueryPath;
 }
 /**

package/types/lighting/DirectLight.d.ts

@@ -7,7 +7,6 @@ export declare class DirectLight extends Light {
     private static _cullingMaskProperty;
     private static _colorProperty;
     private static _directionProperty;
-    private static _combinedData;
     private _reverseDirection;
     /**
      * Get direction.
@@ -18,3 +17,11 @@ export declare class DirectLight extends Light {
      */
     get reverseDirection(): Vector3;
 }
+/**
+ * Shader properties data of direct lights in the scene.
+ */
+export interface IDirectLightShaderData {
+    cullingMask: Int32Array;
+    color: Float32Array;
+    direction: Float32Array;
+}

package/types/lighting/Light.d.ts

@@ -6,10 +6,6 @@ import { ShadowType } from "../shadow";
  * Light base class.
  */
 export declare abstract class Light extends Component {
-    /**
-     * Each type of light source is at most 10, beyond which it will not take effect.
-     * */
-    protected static _maxLight: number;
     /** Light Intensity */
     intensity: number;
     /**

package/types/lighting/LightManager.d.ts

@@ -2,5 +2,12 @@
  * Light manager.
  */
 export declare class LightManager {
+    /**
+     * Each type of light source is at most 10, beyond which it will not take effect.
+     * */
+    private static _maxLight;
+    private _directData;
+    private _pointData;
+    private _spotData;
     private _getSunLightIndex;
 }

package/types/lighting/PointLight.d.ts

@@ -8,7 +8,6 @@ export declare class PointLight extends Light {
     private static _colorProperty;
     private static _positionProperty;
     private static _distanceProperty;
-    private static _combinedData;
     /** Defines a distance cutoff at which the light's intensity must be considered zero. */
     distance: number;
     /**
@@ -16,3 +15,12 @@ export declare class PointLight extends Light {
      */
     get position(): Vector3;
 }
+/**
+ * Shader properties data of point lights in the scene.
+ */
+export interface IPointLightShaderData {
+    cullingMask: Int32Array;
+    color: Float32Array;
+    position: Float32Array;
+    distance: Float32Array;
+}

package/types/lighting/SpotLight.d.ts

@@ -11,7 +11,6 @@ export declare class SpotLight extends Light {
     private static _distanceProperty;
     private static _angleCosProperty;
     private static _penumbraCosProperty;
-    private static _combinedData;
     /** Defines a distance cutoff at which the light's intensity must be considered zero. */
     distance: number;
     /** Angle, in radians, from centre of spotlight where falloff begins. */
@@ -33,3 +32,15 @@ export declare class SpotLight extends Light {
      */
     get reverseDirection(): Vector3;
 }
+/**
+ * Shader properties data of spot lights in the scene.
+ */
+export interface ISpotLightShaderData {
+    cullingMask: Int32Array;
+    color: Float32Array;
+    position: Float32Array;
+    direction: Float32Array;
+    distance: Float32Array;
+    angleCos: Float32Array;
+    penumbraCos: Float32Array;
+}

package/types/mesh/SkinnedMeshRenderer.d.ts

@@ -9,11 +9,11 @@ export declare class SkinnedMeshRenderer extends MeshRenderer {
     private static _jointCountProperty;
     private static _jointSamplerProperty;
     private static _jointMatrixProperty;
+    private _localBounds;
     private _jointDataCreateCache;
     private _blendShapeWeights;
     private _maxVertexUniformVectors;
     private _rootBone;
-    private _localBounds;
     private _jointMatrices;
     private _jointTexture;
     private _bones;

package/types/particle/ParticleGenerator.d.ts

@@ -1,4 +1,3 @@
-import { ParticleRenderer } from "./ParticleRenderer";
 import { ParticleStopMode } from "./enums/ParticleStopMode";
 import { ColorOverLifetimeModule } from "./modules/ColorOverLifetimeModule";
 import { EmissionModule } from "./modules/EmissionModule";
@@ -47,7 +46,6 @@ export declare class ParticleGenerator {
      */
     get randomSeed(): number;
     set randomSeed(value: number);
-    constructor(renderer: ParticleRenderer);
     /**
      * Start emitting particles.
      * @param withChildren - Whether to start the particle generator of the child entity

package/types/particle/index.d.ts

@@ -1,3 +1,4 @@
+export { ParticleGenerator } from "./ParticleGenerator";
 export { ParticleMaterial } from "./ParticleMaterial";
 export { ParticleRenderer } from "./ParticleRenderer";
 export { ParticleCurveMode } from "./enums/ParticleCurveMode";
@@ -7,6 +8,15 @@ export { ParticleScaleMode } from "./enums/ParticleScaleMode";
 export { ParticleSimulationSpace } from "./enums/ParticleSimulationSpace";
 export { ParticleStopMode } from "./enums/ParticleStopMode";
 export { Burst } from "./modules/Burst";
+export { ColorOverLifetimeModule } from "./modules/ColorOverLifetimeModule";
+export { EmissionModule } from "./modules/EmissionModule";
+export { MainModule } from "./modules/MainModule";
 export { ParticleCompositeCurve } from "./modules/ParticleCompositeCurve";
+export { ParticleCompositeGradient } from "./modules/ParticleCompositeGradient";
 export { CurveKey, ParticleCurve } from "./modules/ParticleCurve";
+export { GradientAlphaKey, GradientColorKey, ParticleGradient } from "./modules/ParticleGradient";
+export { RotationOverLifetimeModule } from "./modules/RotationOverLifetimeModule";
+export { SizeOverLifetimeModule } from "./modules/SizeOverLifetimeModule";
+export { TextureSheetAnimationModule } from "./modules/TextureSheetAnimationModule";
+export { VelocityOverLifetimeModule } from "./modules/VelocityOverLifetimeModule";
 export * from "./modules/shape/index";

package/types/particle/modules/EmissionModule.d.ts

@@ -13,7 +13,6 @@ export declare class EmissionModule extends ParticleGeneratorModule {
     /** The shape of the emitter. */
     shape: BaseShape;
     private _bursts;
-    private _frameRateTime;
     private _currentBurstIndex;
     private _burstRand;
     /**

package/types/particle/modules/MainModule.d.ts

@@ -26,22 +26,19 @@ export declare class MainModule implements ICustomClone {
     startSpeed: ParticleCompositeCurve;
     /** A flag to enable specifying particle size individually for each axis. */
     startSize3D: boolean;
-    /** The initial size of particles when the Particle Generator first spawns them. */
-    startSize: ParticleCompositeCurve;
     /** The initial size of particles along the x-axis when the Particle Generator first spawns them. */
     startSizeX: ParticleCompositeCurve;
     /** The initial size of particles along the y-axis when the Particle Generator first spawns them. */
     startSizeY: ParticleCompositeCurve;
     /** The initial size of particles along the z-axis when the Particle Generator first spawns them. */
     startSizeZ: ParticleCompositeCurve;
-    /** A flag to enable 3D particle rotation. */
+    /** A flag to enable 3D particle rotation, when disabled, only `startRotationZ` is used. */
     startRotation3D: boolean;
-    /** The initial rotation of particles when the Particle Generator first spawns them. */
-    startRotation: ParticleCompositeCurve;
     /** The initial rotation of particles around the x-axis when emitted.*/
     startRotationX: ParticleCompositeCurve;
     /** The initial rotation of particles around the y-axis when emitted. */
     startRotationY: ParticleCompositeCurve;
+    /** The initial rotation of particles around the z-axis when emitted. */
     startRotationZ: ParticleCompositeCurve;
     /** Makes some particles spin in the opposite direction. */
     flipRotation: number;
@@ -57,7 +54,6 @@ export declare class MainModule implements ICustomClone {
     scalingMode: ParticleScaleMode;
     /** If set to true, the Particle Generator automatically begins to play on startup. */
     playOnEnabled: boolean;
-    private _maxParticles;
     private _generator;
     private _gravity;
     /**
@@ -65,4 +61,9 @@ export declare class MainModule implements ICustomClone {
      */
     get maxParticles(): number;
     set maxParticles(value: number);
+    /**
+     * The initial size of particles when the Particle Generator first spawns them.
+     */
+    get startSize(): ParticleCompositeCurve;
+    set startSize(value: ParticleCompositeCurve);
 }

package/types/particle/modules/ParticleGeneratorModule.d.ts

@@ -7,6 +7,5 @@ export declare abstract class ParticleGeneratorModule {
     /** Specifies whether the module is enabled or not. */
     enabled: boolean;
     protected _generator: ParticleGenerator;
-    constructor(generator: ParticleGenerator);
     protected _enableMacro(shaderData: ShaderData, lastEnableMacro: ShaderMacro, enableMacro: ShaderMacro): ShaderMacro;
 }

package/types/particle/modules/ParticleGradient.d.ts

@@ -63,32 +63,52 @@ export declare class ParticleGradient {
     setKeys(colorKeys: GradientColorKey[], alphaKeys: GradientAlphaKey[]): void;
     private _addKey;
     private _removeKey;
+    private _setColorTypeArrayDirty;
+    private _setAlphaTypeArrayDirty;
 }
 /**
  * The color key of the particle gradient.
  */
 export declare class GradientColorKey {
-    /** The key time. */
-    time: number;
-    /** The key color. */
-    color: Color;
-    constructor(
-    /** The key time. */
-    time: number, 
-    /** The key color. */
-    color: Color);
+    private _time;
+    private _color;
+    /**
+     * The key time.
+     */
+    get time(): number;
+    set time(value: number);
+    /**
+     * The key color.
+     */
+    get color(): Color;
+    set color(value: Color);
+    /**
+     * Constructor of GradientColorKey.
+     * @param time - The time of the gradient colorKey
+     * @param color - The alpha component of the gradient colorKey
+     */
+    constructor(time: number, color: Color);
 }
 /**
  * The alpha key of the particle gradient.
  */
 export declare class GradientAlphaKey {
-    /** The key time. */
-    time: number;
-    /** The key alpha. */
-    alpha: number;
-    constructor(
-    /** The key time. */
-    time: number, 
-    /** The key alpha. */
-    alpha: number);
+    private _time;
+    private _alpha;
+    /**
+     * The key time.
+     */
+    get time(): number;
+    set time(value: number);
+    /**
+     * The key alpha.
+     */
+    get alpha(): number;
+    set alpha(value: number);
+    /**
+     * Constructor of GradientAlphaKey.
+     * @param time - The time of the gradient alpha key
+     * @param alpha - The alpha component of the gradient alpha key
+     */
+    constructor(time: number, alpha: number);
 }

package/types/particle/modules/RotationOverLifetimeModule.d.ts

@@ -18,7 +18,7 @@ export declare class RotationOverLifetimeModule extends ParticleGeneratorModule
     static readonly _maxCurveXProperty: ShaderProperty;
     static readonly _maxCurveYProperty: ShaderProperty;
     static readonly _maxCurveZProperty: ShaderProperty;
-    /** Specifies whether the rotation is separate on each axis, when disabled only z axis is used. */
+    /** Specifies whether the rotation is separate on each axis, when disabled, only `rotationZ` is used. */
     separateAxes: boolean;
     /** Rotation over lifetime for z axis. */
     rotationX: ParticleCompositeCurve;

package/types/particle/modules/TextureSheetAnimationModule.d.ts

@@ -26,10 +26,6 @@ export declare class TextureSheetAnimationModule extends ParticleGeneratorModule
      * */
     get tiling(): Vector2;
     set tiling(value: Vector2);
-    /**
-     * @inheritDoc
-     */
-    cloneTo(dest: TextureSheetAnimationModule): void;
 }
 /**
  * Texture sheet animation type.

package/types/physics/Collider.d.ts

@@ -1,11 +1,12 @@
 import { BoolUpdateFlag } from "../BoolUpdateFlag";
 import { Component } from "../Component";
 import { ColliderShape } from "./shape/ColliderShape";
+import { ICustomClone } from "../clone/ComponentCloner";
 /**
  * Base class for all colliders.
  * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
  */
-export declare class Collider extends Component {
+export declare class Collider extends Component implements ICustomClone {
     protected _updateFlag: BoolUpdateFlag;
     protected _shapes: ColliderShape[];
     /**
@@ -26,4 +27,5 @@ export declare class Collider extends Component {
      * Remove all shape attached.
      */
     clearShapes(): void;
+    protected _addPhysicsShape(shape: ColliderShape): void;
 }

package/types/physics/PhysicsMaterial.d.ts

@@ -8,6 +8,7 @@ export declare class PhysicsMaterial {
     private _staticFriction;
     private _bounceCombine;
     private _frictionCombine;
+    private _destroyed;
     constructor();
     /**
      * The coefficient of bounciness.

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

@@ -28,7 +28,7 @@ export declare class HingeJoint extends Joint {
     /**
      * The angular velocity of the joint in degrees per second.
      */
-    get velocity(): Readonly<Vector3>;
+    get velocity(): Readonly<number>;
     /**
      * Enables the joint's limits. Disabled by default.
      */

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

@@ -3,13 +3,14 @@ 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 {
-    protected _connectedCollider: JointCollider;
-    protected _collider: JointCollider;
+export declare class Joint extends Component implements ICustomClone {
+    protected _colliderInfo: JointColliderInfo;
+    protected _connectedColliderInfo: JointColliderInfo;
     protected _nativeJoint: IJoint;
     private _force;
     private _torque;

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

@@ -1,10 +1,11 @@
 import { PhysicsMaterial } from "../PhysicsMaterial";
 import { Vector3 } from "@galacean/engine-math";
 import { Collider } from "../Collider";
+import { ICustomClone } from "../../clone/ComponentCloner";
 /**
  * Abstract class for collider shapes.
  */
-export declare abstract class ColliderShape {
+export declare abstract class ColliderShape implements ICustomClone {
     private static _idGenerator;
     protected _id: number;
     protected _material: PhysicsMaterial;

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

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

package/types/shader/Shader.d.ts

@@ -19,7 +19,7 @@ export declare class Shader {
      * // Import shaderLab
      * import { ShaderLab } from "@galacean/engine-shader-lab";
      * // Create engine with shaderLab
-     * const engine = await WebGLEngine.create({ canvas: "canvas", new ShaderLab() });
+     * const engine = await WebGLEngine.create({ canvas: "canvas", shader: new ShaderLab() });
      * ...
      * ```
      *

package/types/xr/XRManager.d.ts

@@ -1,31 +1,5 @@
-import { Engine } from "../Engine";
-import { EnumXRMode } from "./enum/EnumXRMode";
-import { EnumXRFeature } from "./enum/EnumXRFeature";
-import { EnumXRTrackingMode } from "./enum/EnumXRTrackingMode";
-import { XRFeature } from "./feature/XRFeature";
-import { EnumXRSubsystem } from "./enum/EnumXRSubsystem";
-import { XRProvider } from "./provider/XRProvider";
-import { XRSubsystem } from "./subsystem/XRSubsystem";
-type FeatureConstructor = new (engine: Engine) => XRFeature;
+/**
+ * XRManager located in the main package, its implementation logic is XRManagerExtended in the sub-package engine-xr.
+ */
 export declare class XRManager {
-    private _engine;
-    private _provider;
-    private _features;
-    private _subsystems;
-    private _isPaused;
-    isSupportedMode(mode: EnumXRMode): Promise<void>;
-    isSupportedTrackingMode(mode: EnumXRTrackingMode): Promise<void>;
-    isSupportedFeature(feature: EnumXRFeature): Promise<void>;
-    getFeature<T extends XRFeature>(feature: EnumXRFeature): T;
-    enableFeature(feature: EnumXRFeature): void;
-    disableFeature(feature: EnumXRFeature): void;
-    getSubsystem<T extends XRSubsystem>(subsystem: EnumXRSubsystem): T;
-    initialize(mode: EnumXRMode, trackingMode: EnumXRTrackingMode, requestFeatures?: EnumXRFeature[]): Promise<void>;
-    start(): Promise<void>;
-    pause(): void;
-    resume(): void;
-    destroy(): void;
-    constructor(engine: Engine, type: new (engine: Engine) => XRProvider);
 }
-export declare function registerFeature(feature: EnumXRFeature, dependentSubsystem?: EnumXRSubsystem[]): (featureConstructor: FeatureConstructor) => void;
-export {};

package/types/xr/XRPose.d.ts

@@ -0,0 +1,15 @@
+import { IXRPose } from "@galacean/engine-design";
+import { Matrix, Quaternion, Vector3 } from "@galacean/engine-math";
+/**
+ * Data for describing pose in the XR space.
+ */
+export declare class XRPose implements IXRPose {
+    /** The position of the pose in XR space. */
+    position: Vector3;
+    /** The rotation of the pose in XR space. */
+    rotation: Quaternion;
+    /** The matrix of the pose in XR space. */
+    matrix: Matrix;
+    /** The inverse matrix of the pose in XR space. */
+    inverseMatrix: Matrix;
+}