@galacean/engine-xr 2.0.0-alpha.44 → 2.0.0-alpha.45

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-xr",
-  "version": "2.0.0-alpha.44",
+  "version": "2.0.0-alpha.45",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -27,11 +27,11 @@
     "types/**/*"
   ],
   "devDependencies": {
-    "@galacean/engine-design": "2.0.0-alpha.44",
-    "@galacean/engine": "2.0.0-alpha.44"
+    "@galacean/engine-design": "2.0.0-alpha.45",
+    "@galacean/engine": "2.0.0-alpha.45"
   },
   "peerDependencies": {
-    "@galacean/engine": "2.0.0-alpha.44"
+    "@galacean/engine": "2.0.0-alpha.45"
   },
   "scripts": {
     "b:types": "tsc"

package/types/XRManagerExtended.d.ts

@@ -1,9 +1,59 @@
-import { Entity } from "@galacean/engine";
+import { CameraClearFlags, CameraType, Engine, Entity, XRManager } from "@galacean/engine";
+import { IXRDevice } from "@galacean/engine-design";
 import { XRFeature } from "./feature/XRFeature";
+import { XRFeatureType } from "./feature/XRFeatureType";
 import { XRCameraManager } from "./feature/camera/XRCameraManager";
 import { XRInputManager } from "./input/XRInputManager";
 import { XRSessionManager } from "./session/XRSessionManager";
 import { XRSessionMode } from "./session/XRSessionMode";
+/**
+ * @internal
+ */
+export declare class XRManagerExtended extends XRManager {
+    /** @internal */
+    static _featureMap: Map<TFeatureConstructor<XRFeature>, XRFeatureType>;
+    inputManager: XRInputManager;
+    sessionManager: XRSessionManager;
+    cameraManager: XRCameraManager;
+    /** @internal */
+    _platformDevice: IXRDevice;
+    private _features;
+    private _origin;
+    get features(): XRFeature[];
+    get origin(): Entity;
+    set origin(value: Entity);
+    isSupportedFeature<T extends XRFeature>(feature: TFeatureConstructor<T>): boolean;
+    addFeature<T extends new (xrManager: XRManagerExtended, ...args: any[]) => XRFeature>(type: T, ...args: TFeatureConstructorArguments<T>): InstanceType<T> | null;
+    getFeature<T extends XRFeature>(type: TFeatureConstructor<T>): T | null;
+    enterXR(sessionMode: XRSessionMode, autoRun?: boolean): Promise<void>;
+    exitXR(): Promise<void>;
+    _initialize(engine: Engine, xrDevice: IXRDevice): void;
+    _update(): void;
+    _destroy(): void;
+    _getRequestAnimationFrame(): (callback: FrameRequestCallback) => number;
+    _getCancelAnimationFrame(): (id: number) => void;
+    _getCameraIgnoreClearFlags(type: CameraType): CameraClearFlags;
+    /**
+     * @internal
+     */
+    _onSessionStop(): void;
+    /**
+     * @internal
+     */
+    _onSessionInit(): void;
+    /**
+     * @internal
+     */
+    _onSessionStart(): void;
+    /**
+     * @internal
+     */
+    _onSessionExit(): void;
+}
+/**
+ * @internal
+ */
+export declare function registerXRFeature<T extends XRFeature>(type: XRFeatureType): (feature: TFeatureConstructor<T>) => void;
 type TFeatureConstructor<T extends XRFeature> = new (xrManager: XRManagerExtended, ...args: any[]) => T;
 type TFeatureConstructorArguments<T extends new (xrManager: XRManagerExtended, ...args: any[]) => XRFeature> = T extends new (xrManager: XRManagerExtended, ...args: infer P) => XRFeature ? P : never;
 declare module "@galacean/engine" {
@@ -53,6 +103,30 @@ declare module "@galacean/engine" {
          * @returns A promise that resolves if the XR virtual world is destroyed, otherwise rejects
          */
         exitXR(): Promise<void>;
+        /**
+         * @internal
+         */
+        _initialize(engine: Engine, xrDevice: IXRDevice): void;
+        /**
+         * @internal
+         */
+        _getRequestAnimationFrame(): (callback: FrameRequestCallback) => number;
+        /**
+         * @internal
+         */
+        _getCancelAnimationFrame(): (id: number) => void;
+        /**
+         * @internal
+         */
+        _getCameraIgnoreClearFlags(type: CameraType): CameraClearFlags;
+        /**
+         * @internal
+         */
+        _update(): void;
+        /**
+         * @internal
+         */
+        _destroy(): void;
     }
 }
 export {};

package/types/feature/XRFeature.d.ts

@@ -7,10 +7,48 @@ import { XRFeatureType } from "./XRFeatureType";
 export declare abstract class XRFeature<T extends IXRPlatformFeature = IXRPlatformFeature> {
     protected _xrManager: XRManagerExtended;
     protected _type: XRFeatureType;
+    /** @internal */
+    _platformFeature: T;
     protected _enabled: boolean;
     /**
      * Returns whether the feature is enabled.
      */
     get enabled(): boolean;
     set enabled(value: boolean);
+    /**
+     * @internal
+     */
+    constructor(_xrManager: XRManagerExtended, _type: XRFeatureType, ...args: any[]);
+    /**
+     * @internal
+     */
+    _onEnable(): void;
+    /**
+     * @internal
+     */
+    _onDisable(): void;
+    /**
+     * @internal
+     */
+    _onUpdate(): void;
+    /**
+     * @internal
+     */
+    _onSessionInit(): void;
+    /**
+     * @internal
+     */
+    _onSessionStart(): void;
+    /**
+     * @internal
+     */
+    _onSessionStop(): void;
+    /**
+     * @internal
+     */
+    _onSessionExit(): void;
+    /**
+     * @internal
+     */
+    _onDestroy(): void;
 }

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

@@ -1,4 +1,5 @@
-import { Camera } from "@galacean/engine";
+import { Camera, CameraClearFlags, CameraType } from "@galacean/engine";
+import { XRManagerExtended } from "../../XRManagerExtended";
 import { XRTrackedInputDevice } from "../../input/XRTrackedInputDevice";
 /**
  * The manager of XR camera.
@@ -10,6 +11,10 @@ export declare class XRCameraManager {
      */
     get fixedFoveation(): number;
     set fixedFoveation(value: number);
+    /**
+     * @internal
+     */
+    constructor(_xrManager: XRManagerExtended);
     /**
      * Attach the camera to the specified input type(Camera, LeftCamera or RightCamera).
      * The camera entity need to be moved to the XROrigin entity.
@@ -23,4 +28,24 @@ export declare class XRCameraManager {
      * @returns The camera that was detached
      */
     detachCamera(type: XRTrackedInputDevice.Camera | XRTrackedInputDevice.LeftCamera | XRTrackedInputDevice.RightCamera): Camera;
+    /**
+     * @internal
+     */
+    _onSessionStart(): void;
+    /**
+     * @internal
+     */
+    _onUpdate(): void;
+    /**
+     * @internal
+     */
+    _onSessionExit(): void;
+    /**
+     * @internal
+     */
+    _getIgnoreClearFlags(cameraType: CameraType): CameraClearFlags;
+    /**
+     * @internal
+     */
+    _onDestroy(): void;
 }

package/types/feature/trackable/XRRequestTracking.d.ts

@@ -1 +1,11 @@
-export {};
+import { XRRequestTrackingState } from "./XRRequestTrackingState";
+import { XRTracked } from "./XRTracked";
+/**
+ * @internal
+ */
+export declare abstract class XRRequestTracking<T extends XRTracked> {
+    /** The status of the current request tracking. */
+    state: XRRequestTrackingState;
+    /** Tracked instances, make up from the tracking data returned by Session. */
+    tracked: T[];
+}

package/types/input/XRCamera.d.ts

@@ -1,5 +1,5 @@
 import { IXRCamera } from "@galacean/engine-design";
-import { Matrix, Rect } from "@galacean/engine";
+import { Matrix, Rect, Camera } from "@galacean/engine";
 import { XRPose } from "../XRPose";
 import { XRInput } from "./XRInput";
 /**
@@ -12,4 +12,6 @@ export declare class XRCamera extends XRInput implements IXRCamera {
     viewport: Rect;
     /** The projection matrix of the camera. */
     projectionMatrix: Matrix;
+    /** @internal */
+    _camera: Camera;
 }

package/types/input/XRInput.d.ts

@@ -5,4 +5,8 @@ export declare class XRInput implements IXRInput {
     type: XRTrackedInputDevice;
     /** The tracking state of xr input. */
     trackingState: XRTrackingState;
+    /**
+     * @internal
+     */
+    constructor(type: XRTrackedInputDevice);
 }

package/types/input/XRInputManager.d.ts

@@ -1,4 +1,7 @@
-import { Signal } from "@galacean/engine";
+import { Engine, Signal } from "@galacean/engine";
+import { XRManagerExtended } from "../XRManagerExtended";
+import { XRCamera } from "./XRCamera";
+import { XRController } from "./XRController";
 import { XRInput } from "./XRInput";
 import { XRTrackedInputDevice } from "./XRTrackedInputDevice";
 /**
@@ -9,16 +12,32 @@ export declare class XRInputManager {
     private _engine;
     /** Signal emitted when tracked devices change. */
     readonly onTrackedDeviceChanged: Signal<[readonly XRInput[], readonly XRInput[]]>;
+    /** @internal */
+    _cameras: XRCamera[];
+    /** @internal */
+    _controllers: XRController[];
     private _added;
     private _removed;
     private _trackedDevices;
     private _statusSnapshot;
+    /**
+     * @internal
+     */
+    constructor(_xrManager: XRManagerExtended, _engine: Engine);
     /**
      * Returns the tracked device instance.
      * @param type - The tracked input device type
      * @returns The input instance
      */
     getTrackedDevice<T extends XRInput>(type: XRTrackedInputDevice): T;
+    /**
+     * @internal
+     */
+    _onUpdate(): void;
+    /**
+     * @internal
+     */
+    _onDestroy(): void;
     private _handleEvent;
     private _makeUpPointerEvent;
     /**

package/types/session/XRSessionManager.d.ts

@@ -1,4 +1,7 @@
-import { Signal } from "@galacean/engine";
+import { Engine, Signal } from "@galacean/engine";
+import { IXRSession } from "@galacean/engine-design";
+import { XRManagerExtended } from "../XRManagerExtended";
+import { XRFeature } from "../feature/XRFeature";
 import { XRSessionMode } from "./XRSessionMode";
 import { XRSessionState } from "./XRSessionState";
 /**
@@ -9,6 +12,8 @@ export declare class XRSessionManager {
     private _engine;
     /** Signal emitted when session state changes. */
     readonly onStateChanged: Signal<[XRSessionState]>;
+    /** @internal */
+    _platformSession: IXRSession;
     private _mode;
     private _state;
     private _rhi;
@@ -30,6 +35,10 @@ export declare class XRSessionManager {
      * Return the current frame rate as reported by the device.
      */
     get frameRate(): number;
+    /**
+     * @internal
+     */
+    constructor(_xrManager: XRManagerExtended, _engine: Engine);
     /**
      * Check if the specified mode is supported.
      * @param mode - The mode to check
@@ -44,7 +53,35 @@ export declare class XRSessionManager {
      * Stop the session.
      */
     stop(): void;
+    /**
+     * @internal
+     */
+    _setState(value: XRSessionState): void;
+    /**
+     * @internal
+     */
+    _initialize(mode: XRSessionMode, features: XRFeature[]): Promise<void>;
+    /**
+     * @internal
+     */
+    _onUpdate(): void;
+    /**
+     * @internal
+     */
+    _getRequestAnimationFrame(): (callback: FrameRequestCallback) => number;
+    /**
+     * @internal
+     */
+    _getCancelAnimationFrame(): (id: number) => void;
+    /**
+     * @internal
+     */
+    _exit(): Promise<void>;
     private _onSessionExit;
+    /**
+     * @internal
+     */
+    _onDestroy(): void;
     /**
      * Add a listening function for session state changes.
      * @deprecated Use `onStateChanged.on(listener)` instead.