@galacean/engine-xr 1.3.0-alpha.3 → 1.3.0-beta.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-xr",
-  "version": "1.3.0-alpha.3",
+  "version": "1.3.0-beta.10",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -23,11 +23,11 @@
     "types/**/*"
   ],
   "devDependencies": {
-    "@galacean/engine-design": "1.3.0-alpha.3",
-    "@galacean/engine": "1.3.0-alpha.3"
+    "@galacean/engine-design": "1.3.0-beta.10",
+    "@galacean/engine": "1.3.0-beta.10"
   },
   "peerDependencies": {
-    "@galacean/engine": "1.3.0-alpha.3"
+    "@galacean/engine": "1.3.0-beta.10"
   },
   "scripts": {
     "b:types": "tsc"

package/types/XRManagerExtended.d.ts

@@ -1,59 +1,12 @@
-import { Entity, XRManager } from "@galacean/engine";
+import { Entity } from "@galacean/engine";
 import { XRFeature } from "./feature/XRFeature";
 import { XRCameraManager } from "./feature/camera/XRCameraManager";
 import { XRInputManager } from "./input/XRInputManager";
 import { XRSessionManager } from "./session/XRSessionManager";
 import { XRSessionMode } from "./session/XRSessionMode";
-/**
- * XRManager is the entry point of the XR system.
- */
-export declare class XRManagerExtended extends XRManager {
-    /** Input manager for XR. */
-    inputManager: XRInputManager;
-    /** Session manager for XR. */
-    sessionManager: XRSessionManager;
-    /** Camera manager for XR. */
-    cameraManager: XRCameraManager;
-    private _origin;
-    private _features;
-    /**
-     * The current origin of XR space.
-     * @remarks The connection point between the virtual world and the real world ( XR Space )
-     */
-    get origin(): Entity;
-    set origin(value: Entity);
-    /**
-     * Check if the specified feature is supported.
-     * @param type - The type of the feature
-     * @returns If the feature is supported
-     */
-    isSupportedFeature<T extends XRFeature>(feature: TFeatureConstructor<T>): boolean;
-    /**
-     * Add feature based on the xr feature type.
-     * @param type - The type of the feature
-     * @param args - The constructor params of the feature
-     * @returns The feature which has been added
-     */
-    addFeature<T extends new (xrManager: XRManagerExtended, ...args: any[]) => XRFeature>(type: T, ...args: TFeatureConstructorArguments<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: TFeatureConstructor<T>): T | null;
-    getFeatures<T extends XRFeature>(type: TFeatureConstructor<T>, out?: T[]): T[];
-    /**
-     * Enter XR immersive mode, when you call this method, it will initialize and display the XR virtual world.
-     * @param sessionMode - The mode of the session
-     * @param autoRun - Whether to automatically run the session, when `autoRun` is set to true, xr will start working immediately after initialization. Otherwise, you need to call `sessionManager.run` later to work.
-     * @returns A promise that resolves if the XR virtual world is entered, otherwise rejects
-     */
-    enterXR(sessionMode: XRSessionMode, autoRun?: boolean): Promise<void>;
-    /**
-     * Exit XR immersive mode, when you call this method, it will destroy the XR virtual world.
-     * @returns A promise that resolves if the XR virtual world is destroyed, otherwise rejects
-     */
-    exitXR(): Promise<void>;
+export interface IXRListener {
+    fn: (...args: any[]) => any;
+    destroyed?: boolean;
 }
 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;
@@ -65,23 +18,14 @@ declare module "@galacean/engine" {
         sessionManager: XRSessionManager;
         /** Camera manager for XR. */
         cameraManager: XRCameraManager;
+        /** Initialized features. */
+        get features(): XRFeature[];
         /**
          * The current origin of XR space.
          * @remarks The connection point between the virtual world and the real world ( XR Space )
          */
         get origin(): Entity;
         set origin(value: Entity);
-        /**
-         * Get all initialized features at this moment.
-         * @param type - The type of the feature
-         */
-        getFeatures<T extends XRFeature>(type: TFeatureConstructor<T>): T[];
-        /**
-         * Get all initialized features at this moment.
-         * @param type - The type of the feature
-         * @param out - Save all features in `out`
-         */
-        getFeatures<T extends XRFeature>(type: TFeatureConstructor<T>, out: T[]): T[];
         /**
          * Check if the specified feature is supported.
          * @param type - The type of the feature
@@ -94,14 +38,13 @@ declare module "@galacean/engine" {
          * @param args - The constructor params of the feature
          * @returns The feature which has been added
          */
-        addFeature<T extends new (xrManager: XRManagerExtended, ...args: any[]) => XRFeature>(type: T, ...args: TFeatureConstructorArguments<T>): XRFeature | null;
+        addFeature<T extends new (xrManager: XRManagerExtended, ...args: any[]) => XRFeature>(type: T, ...args: TFeatureConstructorArguments<T>): InstanceType<T> | 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: TFeatureConstructor<T>): T | null;
-        getFeatures<T extends XRFeature>(type: TFeatureConstructor<T>, out?: T[]): T[];
         /**
          * Enter XR immersive mode, when you call this method, it will initialize and display the XR virtual world.
          * @param sessionMode - The mode of the session

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

@@ -6,7 +6,7 @@ import { XRTracked } from "./XRTracked";
 /**
  * The base class of XR trackable manager.
  */
-export declare abstract class XRTrackableFeature<T extends XRTracked, K extends XRRequestTracking<T>> extends XRFeature<IXRTrackablePlatformFeature<T, K>> {
+export declare abstract class XRTrackableFeature<T extends XRTracked = XRTracked, K extends XRRequestTracking<T> = XRRequestTracking<T>> extends XRFeature<IXRTrackablePlatformFeature<T, K>> {
     protected static _uuid: number;
     protected _requestTrackings: K[];
     protected _tracked: T[];
@@ -28,7 +28,6 @@ export declare abstract class XRTrackableFeature<T extends XRTracked, K extends
     _onUpdate(): void;
     _onSessionStop(): void;
     _onSessionExit(): void;
-    _onDestroy(): void;
     protected _addRequestTracking(requestTracking: K): void;
     protected _removeRequestTracking(requestTracking: K): void;
     protected _removeAllRequestTrackings(): void;

package/types/index.d.ts

@@ -1,6 +1,8 @@
 import "./XRManagerExtended";
 export { XRPose } from "./XRPose";
 export { XRFeature } from "./feature/XRFeature";
+export { XRTrackableFeature } from "./feature/trackable/XRTrackableFeature";
+export { XRTracked } from "./feature/trackable/XRTracked";
 export { XRCameraManager } from "./feature/camera/XRCameraManager";
 export { TrackableType } from "./feature/hitTest/TrackableType";
 export { XRHitResult } from "./feature/hitTest/XRHitResult";
@@ -26,3 +28,5 @@ export { XRFeatureType } from "./feature/XRFeatureType";
 export { XRRequestTrackingState } from "./feature/trackable/XRRequestTrackingState";
 export { XRInputEventType } from "./input/XRInputEventType";
 export { XRTargetRayMode } from "./input/XRTargetRayMode";
+export * from "./loader/XRReferenceImageDecoder";
+export * from "./loader/XRReferenceImageLoader";

package/types/session/XRSessionManager.d.ts

@@ -11,6 +11,7 @@ export declare class XRSessionManager {
     private _rhi;
     private _raf;
     private _caf;
+    private _listeners;
     /**
      * The current session mode( AR or VR ).
      */
@@ -41,5 +42,15 @@ export declare class XRSessionManager {
      * Stop the session.
      */
     stop(): void;
+    /**
+     * Add a listening function for session state changes.
+     * @param listener - The listening function
+     */
+    addStateChangedListener(listener: (state: XRSessionState) => void): void;
+    /**
+     * Remove a listening function of session state changes.
+     * @param listener - The listening function
+     */
+    removeStateChangedListener(listener: (state: XRSessionState) => void): void;
     private _onSessionExit;
 }

package/types/session/XRSessionState.d.ts

@@ -4,10 +4,12 @@
 export declare enum XRSessionState {
     /** Not initialized. */
     None = 0,
+    /** Initializing session. */
+    Initializing = 1,
     /** Initialized but not started. */
-    Initialized = 1,
+    Initialized = 2,
     /** Running. */
-    Running = 2,
+    Running = 3,
     /** Paused. */
-    Paused = 3
+    Paused = 4
 }

package/types/component/TrackedComponent.d.ts

@@ -1,10 +0,0 @@
-import { Script } from "@galacean/engine";
-import { XRTracked } from "../feature/trackable/XRTracked";
-export declare class TrackedComponent<T extends XRTracked> extends Script {
-    private _data;
-    private _destroyedOnRemoval;
-    get destroyedOnRemoval(): boolean;
-    set destroyedOnRemoval(value: boolean);
-    get data(): T;
-    set data(value: T);
-}

package/types/component/XRTrackedComponent.d.ts

@@ -1,16 +0,0 @@
-import { Script } from "@galacean/engine";
-import { XRTracked } from "../feature/trackable/XRTracked";
-export declare class XRTrackedComponent<T extends XRTracked> extends Script {
-    private _data;
-    private _destroyedOnRemoval;
-    /**
-     * Tracking data of the TrackedObject.
-     */
-    get data(): T;
-    set data(value: T);
-    /**
-     * Whether to destroy when tracking is removed, default is true.
-     */
-    get destroyedOnRemoval(): boolean;
-    set destroyedOnRemoval(value: boolean);
-}

package/types/component/XRTrackedObjectManager.d.ts

@@ -1,27 +0,0 @@
-import { Entity, Script, XRManager } from "@galacean/engine";
-import { XRFeature } from "../feature/XRFeature";
-import { XRTrackableFeature } from "../feature/trackable/XRTrackableFeature";
-import { XRTracked } from "../feature/trackable/XRTracked";
-import { XRTrackedComponent } from "./XRTrackedComponent";
-/**
- * 被追踪到的所有对象
- */
-export declare class XRTrackedObjectManager<T extends XRTracked> extends Script {
-    private _prefab;
-    private _trackIdToIndex;
-    private _feature;
-    private _trackedComponents;
-    get prefab(): Entity;
-    set prefab(value: Entity);
-    getTrackedComponentByTrackId(trackId: number): XRTrackedComponent<T>;
-    constructor(entity: Entity, feature: TFeatureConstructor<XRTrackableFeature>);
-    onEnable(): void;
-    onDisable(): void;
-    private _onXRSessionInit;
-    private _onXRSessionExit;
-    private _onChanged;
-    private _createOrUpdateTrackedComponents;
-    private _createTrackedComponents;
-}
-type TFeatureConstructor<T extends XRFeature> = new (xrManager: XRManager, ...args: any[]) => T;
-export {};

package/types/loader/IXRScene.d.ts

@@ -1,40 +0,0 @@
-import { IReferable, IScene, ISceneConfig, IVector3, IVector4 } from "@galacean/engine";
-import { XRFeatureType } from "../feature/XRFeatureType";
-import { XRPlaneMode } from "../feature/trackable/plane/XRPlaneMode";
-interface IXRSceneConfig extends ISceneConfig {
-    xr?: {
-        sessionMode: number;
-        origin: string;
-        camera: string;
-        leftCamera: string;
-        rightCamera: string;
-        features: IXRFeatureSchema[];
-    };
-}
-export interface IXRScene extends Omit<IScene, "scene"> {
-    scene: IXRSceneConfig;
-}
-export interface IXRFeatureSchema {
-    type: XRFeatureType;
-    enable: boolean;
-}
-export interface IAnchorTrackingSchema extends IXRFeatureSchema {
-    anchors: IAnchor[];
-    prefab: null | IReferable;
-}
-export interface IImageTrackingSchema extends IXRFeatureSchema {
-    images: IReferable[];
-    prefab: null | IReferable;
-}
-export interface IHitTestSchema extends IXRFeatureSchema {
-    prefab: null | IReferable;
-}
-export interface IPlaneTrackingSchema extends IXRFeatureSchema {
-    detectionMode: XRPlaneMode;
-    prefab: null | IReferable;
-}
-export interface IAnchor {
-    position: IVector3;
-    rotation: IVector4;
-}
-export {};

package/types/loader/XRCustomParser.d.ts

@@ -1,9 +0,0 @@
-import { Engine, IScene, ParserContext, Scene } from "@galacean/engine";
-export declare class XRExtendParser {
-    parse(engine: Engine, context: ParserContext<IScene, Scene>, data: IScene): Promise<void>;
-    private _addImageTracking;
-    private _addPlaneTracking;
-    private _addAnchorTracking;
-    private _addHitTest;
-    private _setCamera;
-}

package/types/loader/XRSceneCustomParser.d.ts

@@ -1,4 +0,0 @@
-import { CustomParser, Engine, IScene, Scene } from "@galacean/engine";
-export declare class XRSceneCustomParser extends CustomParser {
-    onAfterSceneParse(engine: Engine, data: IScene, scene: Scene): void;
-}

package/types/loader/XRSceneExtendParser.d.ts

@@ -1,4 +0,0 @@
-import { Engine, IScene, ParserContext, Scene } from "@galacean/engine";
-export declare class XRSceneExtendParser {
-    static parse(engine: Engine, context: ParserContext<IScene, Scene>, data: IScene): Promise<void>;
-}

package/types/loader/XRSceneSchema.d.ts

@@ -1,37 +0,0 @@
-import { IReferable, IVector3, IVector4 } from "@galacean/engine";
-import { XRFeatureType } from "../feature/XRFeatureType";
-import { XRPlaneMode } from "../feature/trackable/plane/XRPlaneMode";
-declare module "@galacean/engine" {
-    interface ISceneConfig {
-        xr: {
-            sessionMode: number;
-            origin: string;
-            camera: string;
-            leftCamera: string;
-            rightCamera: string;
-            features: IXRFeatureSchema[];
-        };
-    }
-}
-export interface IXRFeatureSchema {
-    type: XRFeatureType;
-    enable: boolean;
-}
-export interface IAnchorTrackingSchema extends IXRFeatureSchema {
-    anchors: IAnchor[];
-    prefab: null | IReferable;
-}
-export interface IImageTrackingSchema extends IXRFeatureSchema {
-    images: IReferable[];
-    prefab: null | IReferable;
-}
-export interface IHitTestSchema extends IXRFeatureSchema {
-}
-export interface IPlaneTrackingSchema extends IXRFeatureSchema {
-    detectionMode: XRPlaneMode;
-    prefab: null | IReferable;
-}
-export interface IAnchor {
-    position: IVector3;
-    rotation: IVector4;
-}