@galacean/engine-xr 1.2.0-beta.5 → 1.2.0-beta.7

package/package.json

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

package/types/XRManagerExtended.d.ts

@@ -34,7 +34,7 @@ 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

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/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,9 @@
+import { Engine, IScene, ParserContext, Scene } from "@galacean/engine";
+export declare class XRSceneExtendParser {
+    static parse(engine: Engine, context: ParserContext<IScene, Scene>, data: IScene): Promise<void>;
+    private static _addImageTracking;
+    private static _addPlaneTracking;
+    private static _addAnchorTracking;
+    private static _addHitTest;
+    private static _setCamera;
+}

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;
+}