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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/package.json +2 -2
  2. package/types/IProgress.d.ts +15 -0
  3. package/types/physics/joints/IHingeJoint.d.ts +1 -1
  4. package/types/renderingHardwareInterface/IHardwareRenderer.d.ts +6 -0
  5. package/types/xr/IXRDevice.d.ts +27 -0
  6. package/types/xr/IXRFrame.d.ts +13 -0
  7. package/types/xr/IXRInputEvent.d.ts +17 -0
  8. package/types/xr/IXRSession.d.ts +81 -0
  9. package/types/xr/feature/IXRFeature.d.ts +12 -0
  10. package/types/xr/feature/IXRFeatureDescriptor.d.ts +7 -0
  11. package/types/xr/feature/IXRFeatureManager.d.ts +52 -0
  12. package/types/xr/feature/IXRHitResult.d.ts +17 -0
  13. package/types/xr/feature/IXRMovementTracking.d.ts +5 -0
  14. package/types/xr/feature/IXRPlatformFeature.d.ts +11 -0
  15. package/types/xr/feature/trackable/IXRReferenceImage.d.ts +13 -0
  16. package/types/xr/feature/trackable/IXRRequestTracking.d.ts +12 -0
  17. package/types/xr/feature/trackable/IXRRequestTrackingAnchor.d.ts +7 -0
  18. package/types/xr/feature/trackable/IXRRequestTrackingImage.d.ts +7 -0
  19. package/types/xr/feature/trackable/IXRTrackable.d.ts +14 -0
  20. package/types/xr/feature/trackable/IXRTrackableFeature.d.ts +16 -0
  21. package/types/xr/feature/trackable/IXRTracked.d.ts +14 -0
  22. package/types/xr/feature/trackable/IXRTrackedAnchor.d.ts +5 -0
  23. package/types/xr/feature/trackable/IXRTrackedImage.d.ts +6 -0
  24. package/types/xr/feature/trackable/IXRTrackedPlane.d.ts +6 -0
  25. package/types/xr/feature/trackable/anchor/IXRAnchorTracking.d.ts +5 -0
  26. package/types/xr/feature/trackable/anchor/IXRRequestAnchorTracking.d.ts +6 -0
  27. package/types/xr/feature/trackable/image/IXRImageTracking.d.ts +5 -0
  28. package/types/xr/feature/trackable/image/IXRRequestImageTracking.d.ts +5 -0
  29. package/types/xr/feature/trackable/image/IXRTrackedImage.d.ts +5 -0
  30. package/types/xr/feature/trackable/plane/IXRPlaneTracking.d.ts +7 -0
  31. package/types/xr/feature/trackable/plane/IXRRequestPlaneTracking.d.ts +4 -0
  32. package/types/xr/feature/trackable/plane/IXRTrackedPlane.d.ts +11 -0
  33. package/types/xr/feature/trackable/request/IXRRequestTracking.d.ts +5 -0
  34. package/types/xr/feature/trackable/request/IXRRequestTrackingAnchor.d.ts +6 -0
  35. package/types/xr/feature/trackable/request/IXRRequestTrackingImage.d.ts +6 -0
  36. package/types/xr/feature/trackable/request/IXRRequestTrackingPlane.d.ts +5 -0
  37. package/types/xr/feature/trackable/tracked/IXRTracked.d.ts +14 -0
  38. package/types/xr/feature/trackable/tracked/IXRTrackedAnchor.d.ts +3 -0
  39. package/types/xr/feature/trackable/tracked/IXRTrackedImage.d.ts +4 -0
  40. package/types/xr/feature/trackable/tracked/IXRTrackedPlane.d.ts +6 -0
  41. package/types/xr/index.d.ts +22 -0
  42. package/types/xr/input/IXRInput.d.ts +11 -0
  43. package/types/xr/input/IXRInputManager.d.ts +10 -0
  44. package/types/xr/input/IXRPose.d.ts +10 -0
  45. package/types/xr/session/IXRSessionDescriptor.d.ts +10 -0
  46. package/types/xr/session/IXRSessionManager.d.ts +7 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@galacean/engine-design",
3
- "version": "1.1.0-beta.2",
3
+ "version": "1.1.0-beta.20",
4
4
  "publishConfig": {
5
5
  "access": "public",
6
6
  "registry": "https://registry.npmjs.org"
@@ -14,7 +14,7 @@
14
14
  ],
15
15
  "types": "types/index.d.ts",
16
16
  "dependencies": {
17
- "@galacean/engine-math": "1.1.0-beta.2"
17
+ "@galacean/engine-math": "1.1.0-beta.20"
18
18
  },
19
19
  "scripts": {
20
20
  "b:types": "tsc"
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Progress interface.
3
+ */
4
+ export interface IProgress {
5
+ detail?: {
6
+ [key: string]: {
7
+ loaded: number;
8
+ total: number;
9
+ };
10
+ };
11
+ task: {
12
+ loaded: number;
13
+ total: number;
14
+ };
15
+ }
@@ -19,7 +19,7 @@ export interface IHingeJoint extends IJoint {
19
19
  /**
20
20
  * The angular velocity of the joint in degrees per second.
21
21
  */
22
- getVelocity(): Readonly<Vector3>;
22
+ getVelocity(): Readonly<number>;
23
23
  /**
24
24
  * Set a cone hard limit.
25
25
  * @param lowerLimit The lower angle of the limit
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Hardware graphics API renderer.
3
+ */
4
+ export interface IHardwareRenderer {
5
+ [key: string]: any;
6
+ }
@@ -0,0 +1,27 @@
1
+ import { IHardwareRenderer } from "../renderingHardwareInterface";
2
+ import { IXRSession } from "./IXRSession";
3
+ import { IXRFeature } from "./feature/IXRFeature";
4
+ import { IXRFeatureDescriptor } from "./feature/IXRFeatureDescriptor";
5
+ /**
6
+ * The interface of XR device.
7
+ */
8
+ export interface IXRDevice {
9
+ /**
10
+ * Whether the device is supported.
11
+ * @param mode - The mode of the session.
12
+ */
13
+ isSupported(mode: number): Promise<void>;
14
+ /**
15
+ * Get the platform feature instance of this device
16
+ * @param engine - The engine.
17
+ * @param type - The type of the feature.
18
+ */
19
+ createFeature(type: number): IXRFeature;
20
+ /**
21
+ * Request a session.
22
+ * @param engine - The engine
23
+ * @param mode - The mode of the session
24
+ * @param requestFeatures - The requested features
25
+ */
26
+ requestSession(rhi: IHardwareRenderer, mode: number, requestFeatures: IXRFeatureDescriptor[]): Promise<IXRSession>;
27
+ }
@@ -0,0 +1,13 @@
1
+ import { IXRInput } from "./input/IXRInput";
2
+ /**
3
+ * The base interface of XR frame.
4
+ * It can be understood as a snapshot of
5
+ * the information of each input in this frame.
6
+ */
7
+ export interface IXRFrame {
8
+ /**
9
+ * Update xr input information.
10
+ * @param inputs - xr input
11
+ */
12
+ updateInputs(inputs: IXRInput[]): void;
13
+ }
@@ -0,0 +1,17 @@
1
+ /**
2
+ * Unified XR input events.
3
+ */
4
+ export interface IXRInputEvent {
5
+ /** Interaction type. */
6
+ targetRayMode: number;
7
+ /** Specific interactions. */
8
+ type: number;
9
+ /** Type of interactive input. */
10
+ input: number;
11
+ /** Touch id. (Meaningful when and only when targetRayMode is screen) */
12
+ id?: number;
13
+ /** X coordinate on screen. (Meaningful when and only when targetRayMode is screen) */
14
+ x?: number;
15
+ /** Y coordinate on screen. (Meaningful when and only when targetRayMode is screen) */
16
+ y?: number;
17
+ }
@@ -0,0 +1,81 @@
1
+ import { IXRFrame } from "./IXRFrame";
2
+ import { IXRInputEvent } from "./IXRInputEvent";
3
+ /**
4
+ * The base interface of XR session.
5
+ * Can be understood as an XR context.
6
+ */
7
+ export interface IXRSession {
8
+ /**
9
+ * Fixed foveation for XR.
10
+ */
11
+ fixedFoveation: number;
12
+ /**
13
+ * Returns the XR information of this frame.
14
+ */
15
+ get frame(): IXRFrame;
16
+ /**
17
+ * Return the event received in this frame.
18
+ */
19
+ get events(): IXRInputEvent[];
20
+ /**
21
+ * Returns the current frame rate.
22
+ */
23
+ get frameRate(): number;
24
+ /**
25
+ * Returns the frame rate supported by the device.
26
+ */
27
+ get supportedFrameRates(): Float32Array;
28
+ /**
29
+ * Returns the device's default main framebuffer.
30
+ */
31
+ get framebuffer(): WebGLFramebuffer;
32
+ /**
33
+ * Returns the width of the device's default main framebuffer.
34
+ */
35
+ get framebufferWidth(): number;
36
+ /**
37
+ * Returns the height of the device's default main framebuffer.
38
+ */
39
+ get framebufferHeight(): number;
40
+ /**
41
+ * Add event listener for XR session.
42
+ */
43
+ addEventListener(): void;
44
+ /**
45
+ * Remove event listener for XR session.
46
+ */
47
+ removeEventListener(): void;
48
+ /**
49
+ * Reset event flow.
50
+ */
51
+ resetEvents(): void;
52
+ /**
53
+ * Ends the xr session. Returns a promise which resolves when the
54
+ * session has been start.
55
+ */
56
+ start(): Promise<void>;
57
+ /**
58
+ * Ends the xr session. Returns a promise which resolves when the
59
+ * session has been start.
60
+ */
61
+ stop(): Promise<void>;
62
+ /**
63
+ * Ends the xr session. Returns a promise which resolves when the
64
+ * session has been shut down.
65
+ */
66
+ end(): Promise<void>;
67
+ /**
68
+ * Schedules the specified method to be called the next time the user agent
69
+ * is working on rendering an animation frame for the WebXR device. Returns an
70
+ * integer value which can be used to identify the request for the purposes of
71
+ * canceling the callback using cancelAnimationFrame(). This method is comparable
72
+ * to the Window.requestAnimationFrame() method.
73
+ */
74
+ requestAnimationFrame(callback: FrameRequestCallback): number;
75
+ /**
76
+ * Removes a callback from the animation frame painting callback from
77
+ * XRSession's set of animation frame rendering callbacks, given the
78
+ * identifying handle returned by a previous call to requestAnimationFrame().
79
+ */
80
+ cancelAnimationFrame(id: number): void;
81
+ }
@@ -0,0 +1,12 @@
1
+ import { IXRFeatureDescriptor } from "./IXRFeatureDescriptor";
2
+ /**
3
+ * The base interface of the platform feature.
4
+ * Responsible for the implementation of specific features of different XR backends.
5
+ */
6
+ export interface IXRFeature {
7
+ /**
8
+ * Returns whether the feature is supported.
9
+ * @param descriptor - The descriptor of the feature
10
+ */
11
+ isSupported(descriptor: IXRFeatureDescriptor): Promise<void>;
12
+ }
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Descriptors for XR features.
3
+ */
4
+ export interface IXRFeatureDescriptor {
5
+ /** The type of the feature. */
6
+ type: number;
7
+ }
@@ -0,0 +1,52 @@
1
+ import { IXRFeatureDescriptor } from "./IXRFeatureDescriptor";
2
+ import { IXRFeature } from "./IXRFeature";
3
+ import { IXRSession } from "../IXRSession";
4
+ import { IXRFrame } from "../IXRFrame";
5
+ export interface IXRFeatureManager {
6
+ _feature: IXRFeature;
7
+ /** The descriptor of the feature. */
8
+ descriptor: IXRFeatureDescriptor;
9
+ /** Whether this feature enabled. */
10
+ enabled: boolean;
11
+ /**
12
+ * Returns whether the feature is supported.
13
+ * @param descriptor - The descriptor of the feature
14
+ */
15
+ isSupported(descriptor?: IXRFeatureDescriptor): Promise<void>;
16
+ /**
17
+ * Initialize the feature.
18
+ */
19
+ initialize(): Promise<void>;
20
+ /**
21
+ * Enable an instance of a feature.
22
+ */
23
+ onEnable(): void;
24
+ /**
25
+ * Disable an instance of a feature.
26
+ */
27
+ onDisable(): void;
28
+ /**
29
+ * Update an instance of a feature.
30
+ */
31
+ onUpdate(session: IXRSession, frame: IXRFrame): void;
32
+ /**
33
+ * Destroy an instance of a feature.
34
+ */
35
+ onDestroy(): void;
36
+ /**
37
+ * Called when the session is initialized.
38
+ */
39
+ onSessionInit(): void;
40
+ /**
41
+ * Called when session starts.
42
+ */
43
+ onSessionStart(): void;
44
+ /**
45
+ * Called when the session is stopped.
46
+ */
47
+ onSessionStop(): void;
48
+ /**
49
+ * Called when the session is destroyed.
50
+ */
51
+ onSessionDestroy(): void;
52
+ }
@@ -0,0 +1,17 @@
1
+ import { Vector3 } from "@galacean/engine-math";
2
+ /**
3
+ * XR hit result.
4
+ * It is the detection result returned by using XR HitTest feature.
5
+ */
6
+ export interface IXRHitResult {
7
+ /** The position of the hit point. */
8
+ point: Vector3;
9
+ /** The normal of the hit point. */
10
+ normal: Vector3;
11
+ /** The distance from the origin of the ray to the hit point. */
12
+ distance: number;
13
+ /** The id of the hit tracked object, such as the id of IXRTrackedPlane. */
14
+ hitId: number;
15
+ /** The type of tracked object detected, such as XRHitTestType.Plane */
16
+ hitType: number;
17
+ }
@@ -0,0 +1,5 @@
1
+ import { IXRFeature } from "./IXRFeature";
2
+ export interface IXRMovementTracking extends IXRFeature {
3
+ get trackingMode(): number;
4
+ set trackingMode(value: number);
5
+ }
@@ -0,0 +1,11 @@
1
+ import { IXRFeatureDescriptor } from "./IXRFeatureDescriptor";
2
+ export interface IXRPlatformFeature {
3
+ _isSupported(descriptor: IXRFeatureDescriptor): Promise<void>;
4
+ _initialize(descriptor: IXRFeatureDescriptor): Promise<void>;
5
+ _onUpdate(): void;
6
+ _onDestroy(): void;
7
+ _onSessionInit(): void;
8
+ _onSessionStart(): void;
9
+ _onSessionStop(): void;
10
+ _onSessionDestroy(): void;
11
+ }
@@ -0,0 +1,13 @@
1
+ /**
2
+ * An interface that defines a reference image.
3
+ */
4
+ export interface IXRReferenceImage {
5
+ /** The name of the image. */
6
+ name: string;
7
+ /** The src of the image. */
8
+ src: string | HTMLImageElement | SVGImageElement | HTMLVideoElement | HTMLCanvasElement | Blob | ImageData | ImageBitmap | OffscreenCanvas;
9
+ /** The width of the image in meters. */
10
+ physicalWidth: number;
11
+ /** The height of the image in meters. */
12
+ physicalHeight: number;
13
+ }
@@ -0,0 +1,12 @@
1
+ import { IXRTracked } from "./IXRTracked";
2
+ /**
3
+ * The base interface for request tracking in XR.
4
+ */
5
+ export interface IXRRequestTracking<T extends IXRTracked> {
6
+ /** The status of the current request tracking. */
7
+ state: number;
8
+ /** Tracked instances, make up from the tracking data returned by Session. */
9
+ tracked: T[];
10
+ /** Determines whether the specified request tracking are equals. */
11
+ equals(other: IXRRequestTracking<T>): boolean;
12
+ }
@@ -0,0 +1,7 @@
1
+ import { IXRPose } from "../../input/IXRPose";
2
+ import { IXRTrackedAnchor } from "./IXRTrackedAnchor";
3
+ export interface IXRRequestTrackingAnchor {
4
+ state: number;
5
+ pose: IXRPose;
6
+ trackedAnchor?: IXRTrackedAnchor;
7
+ }
@@ -0,0 +1,7 @@
1
+ import { IXRReferenceImage } from "./IXRReferenceImage";
2
+ import { IXRTrackedImage } from "./IXRTrackedImage";
3
+ export interface IXRRequestTrackingImage {
4
+ state: number;
5
+ image: IXRReferenceImage;
6
+ trackedImage?: IXRTrackedImage;
7
+ }
@@ -0,0 +1,14 @@
1
+ import { IXRPose } from "../../input/IXRPose";
2
+ /**
3
+ * The base interface of XR trackable.
4
+ */
5
+ export interface IXRTrackable {
6
+ /** Id of the trackable. */
7
+ id: number;
8
+ /** The pose of the trackable. */
9
+ pose: IXRPose;
10
+ /** The tracking state of the trackable. */
11
+ state: number;
12
+ /** The modified frame count of the trackable. */
13
+ frameCount: number;
14
+ }
@@ -0,0 +1,16 @@
1
+ import { IXRFeature } from "../IXRFeature";
2
+ import { IXRTracked } from "./IXRTracked";
3
+ import { IXRSession } from "../../IXRSession";
4
+ import { IXRFrame } from "../../IXRFrame";
5
+ import { IXRRequestTracking } from "./IXRRequestTracking";
6
+ export interface IXRTrackableFeature<TXRTracked extends IXRTracked, TXRRequestTracking extends IXRRequestTracking<TXRTracked>> extends IXRFeature {
7
+ /**
8
+ * Initialize the feature.
9
+ * @param descriptor - The descriptor of the feature
10
+ */
11
+ initialize(requestTrackings: TXRRequestTracking[]): Promise<void>;
12
+ getTrackedResult(session: IXRSession, frame: IXRFrame, requestTrackings: TXRRequestTracking[]): void;
13
+ checkAvailable(session: IXRSession, frame: IXRFrame, requestTrackings: TXRRequestTracking[]): boolean;
14
+ addRequestTracking?(requestTracking: TXRRequestTracking): void;
15
+ delRequestTracking?(requestTracking: TXRRequestTracking): void;
16
+ }
@@ -0,0 +1,14 @@
1
+ import { IXRPose } from "../../input/IXRPose";
2
+ /**
3
+ * The base interface of XR trackable.
4
+ */
5
+ export interface IXRTracked {
6
+ /** The unique id of the trackable. */
7
+ id: number;
8
+ /** The pose of the trackable. */
9
+ pose: IXRPose;
10
+ /** The tracking state of the trackable. */
11
+ state: number;
12
+ /** The modified frame count of the trackable. */
13
+ frameCount: number;
14
+ }
@@ -0,0 +1,5 @@
1
+ import { IXRRequestTrackingAnchor } from "./IXRRequestTrackingAnchor";
2
+ import { IXRTrackable } from "./IXRTrackable";
3
+ export interface IXRTrackedAnchor extends IXRTrackable {
4
+ requestTracking: IXRRequestTrackingAnchor;
5
+ }
@@ -0,0 +1,6 @@
1
+ import { IXRTrackable } from "./IXRTrackable";
2
+ import { IXRRequestTrackingImage } from "./IXRRequestTrackingImage";
3
+ export interface IXRTrackedImage extends IXRTrackable {
4
+ requestTracking: IXRRequestTrackingImage;
5
+ measuredWidthInMeters: number;
6
+ }
@@ -0,0 +1,6 @@
1
+ import { Vector3 } from "@galacean/engine-math";
2
+ import { IXRTrackable } from "./IXRTrackable";
3
+ export interface IXRTrackedPlane extends IXRTrackable {
4
+ orientation: "horizontal" | "vertical";
5
+ polygon: Vector3[];
6
+ }
@@ -0,0 +1,5 @@
1
+ import { IXRRequestAnchorTracking } from "./IXRRequestAnchorTracking";
2
+ import { IXRTrackableFeature } from "../IXRTrackableFeature";
3
+ import { IXRTracked } from "../IXRTracked";
4
+ export interface IXRAnchorTracking extends IXRTrackableFeature<IXRTracked, IXRRequestAnchorTracking> {
5
+ }
@@ -0,0 +1,6 @@
1
+ import { IXRRequestTracking } from "../IXRRequestTracking";
2
+ import { IXRPose } from "../../../input/IXRPose";
3
+ import { IXRTracked } from "../IXRTracked";
4
+ export interface IXRRequestAnchorTracking extends IXRRequestTracking<IXRTracked> {
5
+ pose: IXRPose;
6
+ }
@@ -0,0 +1,5 @@
1
+ import { IXRRequestImageTracking } from "./IXRRequestImageTracking";
2
+ import { IXRTrackableFeature } from "../IXRTrackableFeature";
3
+ import { IXRTrackedImage } from "./IXRTrackedImage";
4
+ export interface IXRImageTracking extends IXRTrackableFeature<IXRTrackedImage, IXRRequestImageTracking> {
5
+ }
@@ -0,0 +1,5 @@
1
+ import { IXRRequestTracking } from "../IXRRequestTracking";
2
+ import { IXRTrackedImage } from "./IXRTrackedImage";
3
+ export interface IXRRequestImageTracking extends IXRRequestTracking<IXRTrackedImage> {
4
+ image: any;
5
+ }
@@ -0,0 +1,5 @@
1
+ import { IXRTracked } from "../IXRTracked";
2
+ export interface IXRTrackedImage extends IXRTracked {
3
+ /** The width of the image in meters in the physical world. */
4
+ measuredWidthInMeters: number;
5
+ }
@@ -0,0 +1,7 @@
1
+ import { IXRRequestPlaneTracking } from "./IXRRequestPlaneTracking";
2
+ import { IXRTrackableFeature } from "../IXRTrackableFeature";
3
+ import { IXRTrackedPlane } from "./IXRTrackedPlane";
4
+ export interface IXRPlaneTracking extends IXRTrackableFeature<IXRTrackedPlane, IXRRequestPlaneTracking> {
5
+ get detectionMode(): number;
6
+ set detectionMode(mode: number);
7
+ }
@@ -0,0 +1,4 @@
1
+ import { IXRRequestTracking } from "../IXRRequestTracking";
2
+ import { IXRTrackedPlane } from "./IXRTrackedPlane";
3
+ export interface IXRRequestPlaneTracking extends IXRRequestTracking<IXRTrackedPlane> {
4
+ }
@@ -0,0 +1,11 @@
1
+ import { Vector3 } from "@galacean/engine-math";
2
+ import { IXRTracked } from "../IXRTracked";
3
+ export interface IXRTrackedPlane extends IXRTracked {
4
+ /** Whether the detected plane is horizontal or vertical. */
5
+ orientation: number;
6
+ /** The points that make up this plane.
7
+ * Note: These points are in the plane coordinate system,
8
+ * and their Y coordinates are all zero.
9
+ */
10
+ polygon: Vector3[];
11
+ }
@@ -0,0 +1,5 @@
1
+ import { IXRTracked } from "../tracked/IXRTracked";
2
+ export interface IXRRequestTracking<T extends IXRTracked> {
3
+ state: number;
4
+ tracked: T[];
5
+ }
@@ -0,0 +1,6 @@
1
+ import { IXRPose } from "../../../input/IXRPose";
2
+ import { IXRTrackedAnchor } from "../tracked/IXRTrackedAnchor";
3
+ import { IXRRequestTracking } from "./IXRRequestTracking";
4
+ export interface IXRRequestTrackingAnchor extends IXRRequestTracking<IXRTrackedAnchor> {
5
+ pose: IXRPose;
6
+ }
@@ -0,0 +1,6 @@
1
+ import { IXRReferenceImage } from "../IXRReferenceImage";
2
+ import { IXRTrackedImage } from "../tracked/IXRTrackedImage";
3
+ import { IXRRequestTracking } from "./IXRRequestTracking";
4
+ export interface IXRRequestTrackingImage extends IXRRequestTracking<IXRTrackedImage> {
5
+ image: IXRReferenceImage;
6
+ }
@@ -0,0 +1,5 @@
1
+ import { IXRTrackedPlane } from "../tracked/IXRTrackedPlane";
2
+ import { IXRRequestTracking } from "./IXRRequestTracking";
3
+ export interface IXRRequestTrackingPlane extends IXRRequestTracking<IXRTrackedPlane> {
4
+ orientation: number;
5
+ }
@@ -0,0 +1,14 @@
1
+ import { IXRPose } from "../../../input/IXRPose";
2
+ /**
3
+ * The base interface of XR trackable.
4
+ */
5
+ export interface IXRTracked {
6
+ /** Id of the trackable. */
7
+ id: number;
8
+ /** The pose of the trackable. */
9
+ pose: IXRPose;
10
+ /** The tracking state of the trackable. */
11
+ state: number;
12
+ /** The modified frame count of the trackable. */
13
+ frameCount: number;
14
+ }
@@ -0,0 +1,3 @@
1
+ import { IXRTracked } from "./IXRTracked";
2
+ export interface IXRTrackedAnchor extends IXRTracked {
3
+ }
@@ -0,0 +1,4 @@
1
+ import { IXRTracked } from "./IXRTracked";
2
+ export interface IXRTrackedImage extends IXRTracked {
3
+ measuredWidthInMeters: number;
4
+ }
@@ -0,0 +1,6 @@
1
+ import { Vector3 } from "@galacean/engine-math";
2
+ import { IXRTracked } from "./IXRTracked";
3
+ export interface IXRTrackedPlane extends IXRTracked {
4
+ orientation: "horizontal" | "vertical";
5
+ polygon: Vector3[];
6
+ }
@@ -0,0 +1,22 @@
1
+ export type { IXRFeature } from "./feature/IXRFeature";
2
+ export type { IXRFeatureManager } from "./feature/IXRFeatureManager";
3
+ export type { IXRFeatureDescriptor } from "./feature/IXRFeatureDescriptor";
4
+ export type { IXRMovementTracking } from "./feature/IXRMovementTracking";
5
+ export type { IXRHitResult } from "./feature/IXRHitResult";
6
+ export type { IXRTrackableFeature } from "./feature/trackable/IXRTrackableFeature";
7
+ export type { IXRDevice } from "./IXRDevice";
8
+ export type { IXRInput } from "./input/IXRInput";
9
+ export type { IXRPose } from "./input/IXRPose";
10
+ export type { IXRRequestTracking } from "./feature/trackable/IXRRequestTracking";
11
+ export type { IXRTracked } from "./feature/trackable/IXRTracked";
12
+ export type { IXRTrackedImage } from "./feature/trackable/image/IXRTrackedImage";
13
+ export type { IXRImageTracking } from "./feature/trackable/image/IXRImageTracking";
14
+ export type { IXRRequestImageTracking } from "./feature/trackable/image/IXRRequestImageTracking";
15
+ export type { IXRTrackedPlane } from "./feature/trackable/plane/IXRTrackedPlane";
16
+ export type { IXRPlaneTracking } from "./feature/trackable/plane/IXRPlaneTracking";
17
+ export type { IXRRequestPlaneTracking } from "./feature/trackable/plane/IXRRequestPlaneTracking";
18
+ export type { IXRAnchorTracking } from "./feature/trackable/anchor/IXRAnchorTracking";
19
+ export type { IXRRequestAnchorTracking } from "./feature/trackable/anchor/IXRRequestAnchorTracking";
20
+ export type { IXRFrame } from "./IXRFrame";
21
+ export type { IXRSession } from "./IXRSession";
22
+ export type { IXRInputEvent } from "./IXRInputEvent";
@@ -0,0 +1,11 @@
1
+ import { IXRPose } from "./IXRPose";
2
+ export interface IXRInput {
3
+ /** The type of the input. */
4
+ type: number;
5
+ /** The pose of the input. */
6
+ pose: IXRPose;
7
+ /** The tracking state of xr input. */
8
+ trackingState: number;
9
+ /** The update frame count of xr input. */
10
+ frameCount: number;
11
+ }
@@ -0,0 +1,10 @@
1
+ import { IXRInput } from "./IXRInput";
2
+ export interface IXRInputManager {
3
+ getInput(inputSource: number): IXRInput;
4
+ _onSessionInit(): void;
5
+ _onSessionStart(): void;
6
+ _onSessionStop(): void;
7
+ _onSessionDestroy(): void;
8
+ _onUpdate(): void;
9
+ _onDestroy(): void;
10
+ }
@@ -0,0 +1,10 @@
1
+ import { Matrix, Quaternion, Vector3 } from "@galacean/engine-math";
2
+ /**
3
+ * Data interface for describing gestures in the XR world.
4
+ */
5
+ export interface IXRPose {
6
+ position: Vector3;
7
+ rotation: Quaternion;
8
+ matrix?: Matrix;
9
+ inverseMatrix?: Matrix;
10
+ }
@@ -0,0 +1,10 @@
1
+ import { IXRFeatureDescriptor } from "../feature/IXRFeatureDescriptor";
2
+ /**
3
+ * Interface for XR session descriptors
4
+ */
5
+ export interface IXRSessionDescriptor {
6
+ /** The type of XR session. */
7
+ mode: number;
8
+ /** Requested features. */
9
+ requestFeatures: IXRFeatureDescriptor[];
10
+ }
@@ -0,0 +1,7 @@
1
+ import { IXRFeatureDescriptor } from "../feature/IXRFeatureDescriptor";
2
+ export interface IXRSessionManager {
3
+ initialize(mode: number, requestFeatures: IXRFeatureDescriptor[]): Promise<void>;
4
+ start(): Promise<void>;
5
+ stop(): Promise<void>;
6
+ destroy(): Promise<void>;
7
+ }