@galacean/engine-core 1.1.0-beta.2 → 1.1.0-beta.20

package/types/xr/input/XRInputManager.d.ts

@@ -0,0 +1,58 @@
+import { IXRInput, IXRSession } from "@galacean/engine-design";
+import { Engine } from "../../Engine";
+import { XRController } from "./XRController";
+import { XRInputType } from "./XRInputType";
+import { UpdateFlagManager } from "../../UpdateFlagManager";
+import { XRTrackingState } from "./XRTrackingState";
+import { XRTrackedUpdateFlag } from "./XRTrackedUpdateFlag";
+/**
+ * The manager of XR input.
+ */
+export declare class XRInputManager {
+    protected _engine: Engine;
+    protected _session: IXRSession;
+    protected _inputs: IXRInput[];
+    protected _controllers: XRController[];
+    protected _added: IXRInput[];
+    protected _updated: IXRInput[];
+    protected _removed: IXRInput[];
+    protected _statusSnapshot: XRTrackingState[];
+    protected _trackingUpdate: UpdateFlagManager;
+    /**
+     * Returns the input instance.
+     * @param type - The input type
+     * @returns The input instance
+     */
+    getInput<T extends IXRInput>(type: XRInputType): T;
+    /**
+     * Add a listener to the input update event.
+     * @param listener - The listener to add
+     */
+    addListener(listener: (type: XRTrackedUpdateFlag, param: readonly IXRInput[]) => any): void;
+    /**
+     * Remove a listener from the input update event.
+     * @param listener - The listener to remove
+     */
+    removeListener(listener: (type: XRTrackedUpdateFlag, param: readonly IXRInput[]) => any): void;
+    /**
+     * Returns whether the button is pressed.
+     * @param button - The button to check
+     * @returns Whether the button is pressed
+     */
+    isButtonDown(button: number, out: XRController[]): XRController[];
+    /**
+     * Returns whether the button is lifted.
+     * @param button - The button to check
+     * @returns Whether the button is lifted
+     */
+    isButtonUp(button: number, out: XRController[]): XRController[];
+    /**
+     * Returns whether the button is held down.
+     * @param button - The button to check
+     * @returns Whether the button is held down
+     */
+    isButtonHeldDown(button: number, out: XRController[]): XRController[];
+    constructor(engine: Engine);
+    private _handleEvent;
+    private _makeUpPointerEvent;
+}

package/types/xr/input/XRInputType.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Enum for XR input type.
+ */
+export declare enum XRInputType {
+    /** Controller */
+    Controller = 0,
+    /** Left controller */
+    LeftController = 1,
+    /** Right controller */
+    RightController = 2,
+    /** Camera */
+    Camera = 3,
+    /** Left camera */
+    LeftCamera = 4,
+    /** Right camera */
+    RightCamera = 5,
+    /** Head */
+    LeftHand = 6,
+    /** Right hand */
+    RightHand = 7,
+    /** Length of input type */
+    Length = 8
+}

package/types/xr/input/XRTargetRayMode.d.ts

@@ -0,0 +1,12 @@
+/**
+ *  TargetRayMode indicates the method by which the target ray for
+ *  the input source should be generated and how it should be presented to the user.
+ */
+export declare enum XRTargetRayMode {
+    /** Eye */
+    Gaze = 0,
+    /** Controller */
+    TrackedPointer = 1,
+    /** Game pad */
+    Screen = 2
+}

package/types/xr/input/XRTrackedUpdateFlag.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Enum for XR tracked update flag.
+ */
+export declare enum XRTrackedUpdateFlag {
+    /** The object that was not tracked in the previous frame was tracked in this frame. */
+    Added = 0,
+    /** Both the previous frame and this frame are tracked */
+    Updated = 1,
+    /** The object that was tracked in the previous frame is not tracked in this frame. */
+    Removed = 2
+}

package/types/xr/input/XRTrackingState.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Enum for XR tracking state.
+ */
+export declare enum XRTrackingState {
+    /** Not tracking */
+    NotTracking = 0,
+    /** Tracking */
+    Tracking = 1,
+    /** Lost track */
+    TrackingLost = 2
+}

package/types/xr/session/XRSessionManager.d.ts

@@ -0,0 +1,76 @@
+import { IXRFrame, IXRSession, IXRFeatureDescriptor } from "@galacean/engine-design";
+import { Engine } from "../../Engine";
+import { XRSessionType } from "./XRSessionType";
+import { XRSessionState } from "./XRSessionState";
+type TXRSessionStateChangeListener = (from: XRSessionState, to: XRSessionState) => void;
+export declare class XRSessionManager {
+    protected _engine: Engine;
+    protected _session: IXRSession;
+    protected _frame: IXRFrame;
+    protected _state: XRSessionState;
+    private _rhi;
+    private _listeners;
+    /**
+     * Return the current session state.
+     */
+    get state(): XRSessionState;
+    /**
+     * Return the current session.
+     */
+    get session(): IXRSession;
+    /**
+     * Return a list of supported frame rates.(only available in-session)
+     */
+    get supportedFrameRate(): Float32Array;
+    /**
+     * Return the current frame rate as reported by the device.
+     */
+    get frameRate(): number;
+    /**
+     * Returns requestAnimationFrame in XR.
+     */
+    get requestAnimationFrame(): (callback: FrameRequestCallback) => number;
+    /**
+     * Returns cancelAnimationFrame in XR.
+     */
+    get cancelAnimationFrame(): (id: number) => void;
+    /**
+     * Initialize the session.
+     * @param mode - The mode of the session
+     * @param requestFeatures - The requested features
+     * @returns The promise of the session
+     */
+    initialize(mode: XRSessionType, requestFeatures: IXRFeatureDescriptor[]): Promise<IXRSession>;
+    /**
+     * Start the session.
+     * @returns The promise of the session
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the session.
+     * @returns The promise of the session
+     */
+    stop(): Promise<void>;
+    /**
+     * Destroy the session.
+     * @returns The promise of the session
+     */
+    destroy(): Promise<void>;
+    /**
+     * Add a session state change listener.
+     * @param listener - The listener to add
+     */
+    addSessionStateChangeListener(listener: TXRSessionStateChangeListener): void;
+    /**
+     * Remove a session state change listener.
+     * @param listener - The listener to remove
+     */
+    removeSessionStateChangeListener(listener: TXRSessionStateChangeListener): void;
+    /**
+     * Remove all session state change listeners.
+     */
+    removeAllSessionStateChangeListener(): void;
+    constructor(_engine: Engine);
+    private _dispatchSessionStateChange;
+}
+export {};

package/types/xr/session/XRSessionState.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The state of an XRSession.
+ */
+export declare enum XRSessionState {
+    /** Not initialized. */
+    None = 0,
+    /** Initialized but not started. */
+    Initialized = 1,
+    /** Running. */
+    Running = 2,
+    /** Paused. */
+    Paused = 3
+}

package/types/xr/session/XRSessionType.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The type of XR session.
+ */
+export declare enum XRSessionType {
+    AR = 0,
+    VR = 1
+}