@galacean/engine-xr 0.0.0-experimental-stateMachine.0 → 0.0.0-experimental-1.3-xr.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-xr",
-  "version": "0.0.0-experimental-stateMachine.0",
+  "version": "0.0.0-experimental-1.3-xr.1",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -11,6 +11,9 @@
   "debug": "src/index.ts",
   "browser": "dist/browser.js",
   "types": "types/index.d.ts",
+  "scripts": {
+    "b:types": "tsc"
+  },
   "umd": {
     "name": "Galacean.XR",
     "globals": {
@@ -23,13 +26,10 @@
     "types/**/*"
   ],
   "devDependencies": {
-    "@galacean/engine": "0.0.0-experimental-stateMachine.0",
-    "@galacean/engine-design": "0.0.0-experimental-stateMachine.0"
+    "@galacean/engine-design": "workspace:*",
+    "@galacean/engine": "workspace:*"
   },
   "peerDependencies": {
-    "@galacean/engine": "0.0.0-experimental-stateMachine.0"
-  },
-  "scripts": {
-    "b:types": "tsc"
+    "@galacean/engine": "workspace:*"
   }
-}
+}

package/types/XRManagerExtended.d.ts

@@ -14,8 +14,9 @@ export declare class XRManagerExtended extends XRManager {
     sessionManager: XRSessionManager;
     /** Camera manager for XR. */
     cameraManager: XRCameraManager;
+    /** All initialized features at this moment. */
+    readonly features: XRFeature[];
     private _origin;
-    private _features;
     /**
      * The current origin of XR space.
      * @remarks The connection point between the virtual world and the real world ( XR Space )
@@ -34,14 +35,13 @@ export declare class XRManagerExtended extends XRManager {
      * @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
@@ -71,17 +71,6 @@ declare module "@galacean/engine" {
          */
         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 +83,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/component/TrackedComponent.d.ts

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

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

@@ -0,0 +1,27 @@
+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/index.d.ts

@@ -26,3 +26,6 @@ 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";
+export * from "./loader/XRSceneExtendParser";

package/types/loader/IXRScene.d.ts

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

@@ -0,0 +1,9 @@
+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/XRReferenceImageDecoder.d.ts

@@ -0,0 +1,5 @@
+import { BufferReader, Engine } from "@galacean/engine";
+import { XRReferenceImage } from "../feature/trackable/image/XRReferenceImage";
+export declare class XRReferenceImageDecoder {
+    static decode(engine: Engine, bufferReader: BufferReader): Promise<XRReferenceImage>;
+}

package/types/loader/XRReferenceImageLoader.d.ts

@@ -0,0 +1,5 @@
+import { AssetPromise, Loader, LoadItem, ResourceManager } from "@galacean/engine";
+import { XRReferenceImage } from "../feature/trackable/image/XRReferenceImage";
+export declare class XRReferenceImageLoader extends Loader<XRReferenceImage> {
+    load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<XRReferenceImage>;
+}

package/types/loader/XRSceneCustomParser.d.ts

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

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

@@ -0,0 +1,37 @@
+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;
+}

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
+     */
+    addChangedListener(listener: (state: XRSessionState) => void): void;
+    /**
+     * Remove a listening function of session state changes.
+     * @param listener - The listening function
+     */
+    removeChangedListener(listener: (state: XRSessionState) => void): void;
     private _onSessionExit;
 }

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License
-
-Copyright (c) 2020 - present Ant Group
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.