@galacean/engine-core 1.1.0-beta.23 → 1.1.0-beta.24

package/package.json

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

package/types/2d/data/RenderData2D.d.ts

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

package/types/RenderPipeline/MeshRenderData.d.ts

@@ -0,0 +1,17 @@
+import { Mesh } from "../graphic/Mesh";
+import { SubMesh } from "../graphic/SubMesh";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { IPoolElement } from "./IPoolElement";
+import { RenderData } from "./RenderData";
+/**
+ * Render element.
+ */
+export declare class MeshRenderData extends RenderData implements IPoolElement {
+    /** Mesh. */
+    mesh: Mesh;
+    /** Sub mesh. */
+    subMesh: SubMesh;
+    set(component: Renderer, material: Material, mesh: Mesh, subMesh: SubMesh): void;
+    dispose(): void;
+}

package/types/RenderPipeline/MeshRenderElement.d.ts

@@ -0,0 +1,19 @@
+import { Mesh } from "../graphic/Mesh";
+import { SubMesh } from "../graphic/SubMesh";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { ShaderPass } from "../shader/ShaderPass";
+import { RenderState } from "../shader/state/RenderState";
+import { IPoolElement } from "./IPoolElement";
+import { RenderElement } from "./RenderElement";
+/**
+ * Render element.
+ */
+export declare class MeshRenderElement extends RenderElement implements IPoolElement {
+    /** Mesh. */
+    mesh: Mesh;
+    /** Sub mesh. */
+    subMesh: SubMesh;
+    setValue(component: Renderer, mesh: Mesh, subMesh: SubMesh, material: Material, renderState: RenderState, shaderPass: ShaderPass): void;
+    dispose(): void;
+}

package/types/RenderPipeline/SpriteElement.d.ts

@@ -0,0 +1,15 @@
+import { RenderData2D } from "../2d/data/RenderData2D";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { ShaderPass } from "../shader";
+import { RenderState } from "../shader/state/RenderState";
+import { Texture2D } from "../texture";
+import { IPoolElement } from "./IPoolElement";
+import { RenderElement } from "./RenderElement";
+export declare class SpriteElement extends RenderElement implements IPoolElement {
+    renderData: RenderData2D;
+    texture: Texture2D;
+    constructor();
+    setValue(component: Renderer, renderDate: RenderData2D, material: Material, texture: Texture2D, renderState: RenderState, shaderPass: ShaderPass): void;
+    dispose(): void;
+}

package/types/RenderPipeline/SpriteMaskElement.d.ts

@@ -0,0 +1,12 @@
+import { RenderData2D } from "../2d/data/RenderData2D";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { IPoolElement } from "./IPoolElement";
+import { RenderElement } from "./RenderElement";
+export declare class SpriteMaskElement extends RenderElement implements IPoolElement {
+    renderData: RenderData2D;
+    isAdd: boolean;
+    constructor();
+    setValue(component: Renderer, renderData: RenderData2D, material: Material): void;
+    dispose(): void;
+}

package/types/RenderPipeline/TextRenderElement.d.ts

@@ -0,0 +1,8 @@
+import { IPoolElement } from "./IPoolElement";
+import { RenderElement } from "./RenderElement";
+import { SpriteElement } from "./SpriteElement";
+export declare class TextRenderElement extends RenderElement implements IPoolElement {
+    charElements: SpriteElement[];
+    constructor();
+    dispose(): void;
+}

package/types/asset/IRefObject.d.ts

@@ -0,0 +1,2 @@
+export interface IRefObject {
+}

package/types/asset/RefObject.d.ts

@@ -0,0 +1,27 @@
+import { EngineObject } from "../base/EngineObject";
+import { Engine } from "../Engine";
+import { IRefObject } from "./IRefObject";
+/**
+ * The base class of assets, with reference counting capability.
+ */
+export declare abstract class RefObject extends EngineObject implements IRefObject {
+    /** Whether to ignore the garbage collection check, if it is true, it will not be affected by ResourceManager.gc(). */
+    isGCIgnored: boolean;
+    private _refCount;
+    /**
+     * Counted by valid references.
+     */
+    get refCount(): number;
+    protected constructor(engine: Engine);
+    /**
+     * Destroy self.
+     * @param force - Whether to force the destruction, if it is false, refCount = 0 can be released successfully.
+     * @returns Whether the release was successful.
+     */
+    destroy(force?: boolean): boolean;
+    /**
+     * Called when the resource is destroyed.
+     * Subclasses can override this function.
+     */
+    protected abstract _onDestroy(): void;
+}

package/types/base/Event.d.ts

@@ -0,0 +1,24 @@
+import { EventDispatcher } from "./EventDispatcher";
+export type Listener = ((e: Event) => any) & {
+    once?: boolean;
+};
+/** Event Object. * @class */
+export declare class Event {
+    get propagationStopped(): boolean;
+    get target(): EventDispatcher;
+    set target(t: EventDispatcher);
+    get timeStamp(): number;
+    get currentTarget(): EventDispatcher;
+    set currentTarget(t: EventDispatcher);
+    get bubbles(): boolean;
+    get type(): string | number;
+    data: any;
+    private _timeStamp;
+    private _target;
+    private _currentTarget;
+    private _bubbles;
+    private _propagationStopped;
+    private _type;
+    constructor(type: string | number, target?: EventDispatcher, data?: any, bubbles?: boolean);
+    stopPropagation(): void;
+}

package/types/base/Util.d.ts

@@ -0,0 +1,14 @@
+export declare const Util: {
+    isArray: (value: any) => boolean;
+    isArrayLike(x: any): boolean;
+    clone<T>(obj: T): T;
+    downloadBlob(blob: Blob, fileName?: string): void;
+};
+export declare const isArrayLike: <T>(x: any) => x is ArrayLike<T>;
+/**
+ * Fastly remove an element from array.
+ * @param array - Array
+ * @param item - Element
+ */
+export declare function removeFromArray(array: any[], item: any): boolean;
+export declare function ObjectValues(obj: any): any[];

package/types/physics/PhysicsManager.d.ts

@@ -0,0 +1,78 @@
+import { Ray, Vector3 } from "@galacean/engine-math";
+import { Engine } from "../Engine";
+import { Layer } from "../Layer";
+import { HitResult } from "./HitResult";
+/**
+ * A physics manager is a collection of colliders and constraints which can interact.
+ */
+export declare class PhysicsManager {
+    private static _collision;
+    private _engine;
+    private _restTime;
+    private _fixedTimeStep;
+    private _colliders;
+    private _gravity;
+    private _nativePhysicsManager;
+    private _physicalObjectsMap;
+    private _onContactEnter;
+    private _onContactExit;
+    private _onContactStay;
+    private _onTriggerEnter;
+    private _onTriggerExit;
+    private _onTriggerStay;
+    /**
+     * The gravity of physics scene.
+     */
+    get gravity(): Vector3;
+    set gravity(value: Vector3);
+    /** The fixed time step in seconds at which physics are performed. */
+    get fixedTimeStep(): number;
+    set fixedTimeStep(value: number);
+    constructor(engine: Engine);
+    /**
+     * Casts a ray through the Scene and returns the first hit.
+     * @param ray - The ray
+     * @returns Returns True if the ray intersects with a collider, otherwise false
+     */
+    raycast(ray: Ray): boolean;
+    /**
+     * Casts a ray through the Scene and returns the first hit.
+     * @param ray - The ray
+     * @param outHitResult - If true is returned, outHitResult will contain more detailed collision information
+     * @returns Returns True if the ray intersects with a collider, otherwise false
+     */
+    raycast(ray: Ray, outHitResult: HitResult): boolean;
+    /**
+     * Casts a ray through the Scene and returns the first hit.
+     * @param ray - The ray
+     * @param distance - The max distance the ray should check
+     * @returns Returns True if the ray intersects with a collider, otherwise false
+     */
+    raycast(ray: Ray, distance: number): boolean;
+    /**
+     * Casts a ray through the Scene and returns the first hit.
+     * @param ray - The ray
+     * @param distance - The max distance the ray should check
+     * @param outHitResult - If true is returned, outHitResult will contain more detailed collision information
+     * @returns Returns True if the ray intersects with a collider, otherwise false
+     */
+    raycast(ray: Ray, distance: number, outHitResult: HitResult): boolean;
+    /**
+     * Casts a ray through the Scene and returns the first hit.
+     * @param ray - The ray
+     * @param distance - The max distance the ray should check
+     * @param layerMask - Layer mask that is used to selectively ignore Colliders when casting
+     * @returns Returns True if the ray intersects with a collider, otherwise false
+     */
+    raycast(ray: Ray, distance: number, layerMask: Layer): boolean;
+    /**
+     * Casts a ray through the Scene and returns the first hit.
+     * @param ray - The ray
+     * @param distance - The max distance the ray should check
+     * @param layerMask - Layer mask that is used to selectively ignore Colliders when casting
+     * @param outHitResult - If true is returned, outHitResult will contain more detailed collision information
+     * @returns Returns True if the ray intersects with a collider, otherwise false.
+     */
+    raycast(ray: Ray, distance: number, layerMask: Layer, outHitResult: HitResult): boolean;
+    private _setGravity;
+}

package/types/animation/AnimatorLayerMask.d.ts

@@ -1,45 +0,0 @@
-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

@@ -1,16 +0,0 @@
-/**
- * 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/xr/XRManager.d.ts

@@ -1,94 +0,0 @@
-import { XRInputManager } from "./input/XRInputManager";
-import { XRSessionManager } from "./session/XRSessionManager";
-import { XRCameraManager } from "./feature/camera/XRCameraManager";
-import { XRSessionMode } from "./session/XRSessionMode";
-import { XRFeature } from "./feature/XRFeature";
-import { IXRDevice } from "@galacean/engine-design/src/xr/IXRDevice";
-import { Engine } from "../Engine";
-import { Scene } from "../Scene";
-import { Entity } from "../Entity";
-type TConstructor<T extends new (engine: Engine, ...args: any[]) => XRFeature> = T extends new (engine: Engine, ...args: infer P) => XRFeature ? P : never;
-/**
- * XRManager is the entry point of the XR system.
- */
-export declare class XRManager {
-    /** Input manager for XR. */
-    inputManager: XRInputManager;
-    /** Session manager for XR. */
-    sessionManager: XRSessionManager;
-    /** Camera manager for XR. */
-    cameraManager: XRCameraManager;
-    private _engine;
-    private _scene;
-    private _origin;
-    private _mode;
-    private _features;
-    /**
-     * The current xr scene.
-     */
-    get scene(): Scene;
-    set scene(value: Scene);
-    /**
-     * The current xr origin.
-     */
-    get origin(): Entity;
-    set origin(value: Entity);
-    /**
-     * The current session mode( AR or VR ).
-     */
-    get mode(): XRSessionMode;
-    /**
-     * Check if the specified mode is supported.
-     * @param mode - The mode to check
-     * @returns A promise that resolves if the mode is supported, otherwise rejects
-     */
-    isSupportedSessionMode(mode: XRSessionMode): Promise<void>;
-    /**
-     * Check if the specified feature is supported.
-     * @param descriptors - The feature descriptor to check
-     * @returns A promise that resolves if the feature is supported, otherwise rejects
-     */
-    isSupportedFeature<T extends XRFeature>(type: new (engine: Engine) => T): Promise<void>;
-    /**
-     * Add feature based on the xr feature type.
-     * @param type - The type of the feature
-     * @returns The feature which has been added
-     */
-    addFeature<T extends new (engine: Engine, ...args: any[]) => XRFeature>(type: T, ...constructor: TConstructor<T>): XRFeature | null;
-    /**
-     * Get feature which match the type.
-     * @param type - The type of the feature
-     * @returns	The feature which match type
-     */
-    getFeature<T extends XRFeature>(type: new (engine: Engine, ...args: any[]) => T): T | null;
-    /**
-     * Disable all features.
-     */
-    disableAllFeatures(): void;
-    /**
-     * Enter the session.
-     * @returns A promise that resolves if the session is entered, otherwise rejects
-     */
-    enterXR(mode: XRSessionMode): Promise<void>;
-    /**
-     * Exit the session.
-     * @returns A promise that resolves if the session is destroyed, otherwise rejects
-     */
-    exitXR(): Promise<void>;
-    /**
-     * Start the session.
-     * @returns A promise that resolves if the session is started, otherwise rejects
-     */
-    run(): Promise<void>;
-    /**
-     * Stop the session.
-     * @returns A promise that resolves if the session is stopped, otherwise rejects
-     */
-    stop(): Promise<void>;
-    /**
-     * Destroy xr module.
-     */
-    destroy(): void;
-    constructor(engine: Engine, xrDevice: IXRDevice);
-}
-export {};

package/types/xr/feature/XRFeature.d.ts

@@ -1,60 +0,0 @@
-import { IXRFeatureConfig, IXRFeature, IXRPlatformFeature, IXRSession, IXRFrame } from "@galacean/engine-design";
-import { Engine } from "../../Engine";
-/**
- * The base class of XR feature manager.
- */
-export declare abstract class XRFeature<TConfig extends IXRFeatureConfig = IXRFeatureConfig, TFeature extends IXRPlatformFeature = IXRPlatformFeature> implements IXRFeature {
-    protected _engine: Engine;
-    _platformFeature: TFeature;
-    protected _enabled: boolean;
-    protected _config: TConfig;
-    /**
-     * Returns whether the feature is enabled.
-     */
-    get enabled(): boolean;
-    set enabled(value: boolean);
-    /**
-     * Returns whether the feature is supported.
-     * @returns The promise of the feature
-     */
-    isSupported(): Promise<void>;
-    /**
-     * Initialize the feature.
-     * @returns The promise of the feature
-     */
-    initialize(): Promise<void>;
-    /**
-     * Called when be enabled.
-     */
-    onEnable(): void;
-    /**
-     * Called when be disabled.
-     */
-    onDisable(): void;
-    /**
-     * Called when xr frame is updated.
-     * @param session - The xr session
-     * @param frame - The xr frame
-     */
-    onUpdate(session: IXRSession, frame: IXRFrame): void;
-    /**
-     * Called when the session is initialized.
-     */
-    onSessionInit(): void;
-    /**
-     * Called when session starts.
-     */
-    onSessionStart(): void;
-    /**
-     * Called when the session is stopped.
-     */
-    onSessionStop(): void;
-    /**
-     * Called when the session is destroyed.
-     */
-    onSessionDestroy(): void;
-    /**
-     * Called when the xr module is destroyed.
-     */
-    onDestroy(): void;
-}

package/types/xr/feature/XRFeatureManager.d.ts

@@ -1,65 +0,0 @@
-import { IXRFeatureDescriptor, IXRFeatureManager, IXRFeature, IXRSession, IXRFrame } from "@galacean/engine-design";
-import { Engine } from "../../Engine";
-/**
- * The base class of XR feature manager.
- */
-export declare abstract class XRFeatureManager<TDescriptor extends IXRFeatureDescriptor = IXRFeatureDescriptor, TFeature extends IXRFeature = IXRFeature> implements IXRFeatureManager {
-    protected _engine: Engine;
-    _platformFeature: TFeature;
-    protected _descriptor: TDescriptor;
-    protected _enabled: boolean;
-    /**
-     * Return the descriptor of the feature.
-     */
-    get descriptor(): TDescriptor;
-    set descriptor(value: TDescriptor);
-    /**
-     * Returns whether the feature is enabled.
-     */
-    get enabled(): boolean;
-    set enabled(value: boolean);
-    /**
-     * Returns whether the feature is supported.
-     * @param descriptor - The descriptor of the feature
-     * @returns The promise of the feature
-     */
-    isSupported(descriptor?: IXRFeatureDescriptor): Promise<void>;
-    /**
-     * Initialize the feature.
-     * @returns The promise of the feature
-     */
-    initialize(): Promise<void>;
-    /**
-     * Called when be enabled.
-     */
-    onEnable(): void;
-    /**
-     * Called when be disabled.
-     */
-    onDisable(): void;
-    /**
-     * Called when xr frame is updated.
-     */
-    onUpdate(session: IXRSession, frame: IXRFrame): void;
-    /**
-     * Called when the session is initialized.
-     */
-    onSessionInit(): void;
-    /**
-     * Called when session starts.
-     */
-    onSessionStart(): void;
-    /**
-     * Called when the session is stopped.
-     */
-    onSessionStop(): void;
-    /**
-     * Called when the session is destroyed.
-     */
-    onSessionDestroy(): void;
-    /**
-     * Called when the xr module is destroyed.
-     */
-    onDestroy(): void;
-    constructor(_engine: Engine);
-}

package/types/xr/feature/XRFeatureType.d.ts

@@ -1,15 +0,0 @@
-/**
- * Enum for XR feature type.
- */
-export declare enum XRFeatureType {
-    /** Movement tracking */
-    MovementTracking = 0,
-    /** Anchor tracking */
-    AnchorTracking = 1,
-    /** Image tracking */
-    ImageTracking = 2,
-    /** Plane tracking */
-    PlaneTracking = 3,
-    /** Hit test */
-    HitTest = 4
-}

package/types/xr/feature/camera/XRCameraManager.d.ts

@@ -1,34 +0,0 @@
-import { Camera } from "../../../Camera";
-import { Engine } from "../../../Engine";
-import { XRInputType } from "../../input/XRInputType";
-/**
- * The manager of XR camera.
- */
-export declare class XRCameraManager {
-    private _engine;
-    /**
-     * Attach the camera to the specified input type(Camera, LeftCamera or RightCamera).
-     * The camera entity need to be moved to the XROrigin entity.
-     * @param type - The input type
-     * @param camera - The camera to be attached
-     */
-    attachCamera(type: XRInputType.Camera | XRInputType.LeftCamera | XRInputType.RightCamera, camera: Camera): void;
-    /**
-     * Detach the camera from the specified input type.
-     * @param type - The input type
-     * @returns The camera that was detached
-     */
-    detachCamera(type: XRInputType.Camera | XRInputType.LeftCamera | XRInputType.RightCamera): Camera;
-    /**
-     * Get the camera by the specified input type.
-     * @param type - The input type
-     * @returns The camera
-     */
-    getCameraByType(type: XRInputType.Camera | XRInputType.LeftCamera | XRInputType.RightCamera): Camera;
-    /**
-     * Return fixed foveation of the camera.
-     */
-    get fixedFoveation(): number;
-    set fixedFoveation(value: number);
-    constructor(_engine: Engine);
-}

package/types/xr/feature/hitTest/TrackableType.d.ts

@@ -1,12 +0,0 @@
-/**
- * Enum for the types of hit test that can be performed.
- * Note: currently only supports plane.
- */
-export declare enum TrackableType {
-    /** None */
-    None = 0,
-    /** Tracked plane. */
-    Plane = 1,
-    /** All tracked objects. */
-    All = 1
-}

package/types/xr/feature/hitTest/XRHitTest.d.ts

@@ -1,41 +0,0 @@
-import { IXRHitResult } from "@galacean/engine-design";
-import { TrackableType } from "./TrackableType";
-import { Ray } from "@galacean/engine-math";
-import { XRFeature } from "../XRFeature";
-import { Engine } from "../../../Engine";
-/**
- * The manager of XR hit test.
- */
-export declare class XRHitTest extends XRFeature {
-    private _xrCameraManager;
-    private _tempRay;
-    private _tempVec2;
-    private _tempVec30;
-    private _tempVec31;
-    private _tempVec32;
-    private _tempVec33;
-    private _tempVec34;
-    private _tempVec35;
-    /**
-     * Hit test.
-     * @param ray - The ray to test
-     * @param type - The type of hit test
-     * @returns The hit result
-     */
-    hitTest(ray: Ray, type: TrackableType): IXRHitResult[];
-    /**
-     * Screen hit test.
-     * @param x - The x coordinate of the screen point (normalized)
-     * @param y - The y coordinate of the screen point (normalized)
-     * @param type - The type of hit test
-     * @returns The hit result
-     */
-    screenHitTest(x: number, y: number, type: TrackableType): IXRHitResult[];
-    private _hitTest;
-    /**
-     * @param engine - The engine
-     */
-    constructor(engine: Engine);
-    private _hitTestPlane;
-    private _checkPointerWithinPlane;
-}