@web-ar-studio/webar-engine-sdk 1.0.11 → 1.0.13

package/dist/index.d.ts

@@ -13,11 +13,18 @@ declare const EVENT_LOST = "lost";
 declare const EVENT_POSE = "pose";
 declare const EVENT_PROCESS = "process";
 declare const EVENT_XR_SESSION = "xrsession";
+declare const EVENT_XR_SELECT = "xrselect";
+declare const EVENT_XR_ROTATE_START = "xrrotatestart";
+declare const EVENT_XR_ROTATE = "xrrotate";
+declare const EVENT_XR_PINCH_START = "xrpinchstart";
+declare const EVENT_XR_PINCH = "xrpinch";
+declare const EVENT_XR_PAN_START = "xrpanstart";
+declare const EVENT_XR_PAN_MOVE = "xrpanmove";
+declare const EVENT_XR_VIEWER_POSE = "xrviewerpose";
 declare const EVENT_RESIZE = "resize";
 declare const EVENT_DEVICE_ORIENTATION = "deviceorientation";
 declare const EVENT_SCREEN_ORIENTATION = "change";
 declare const EVENT_VISIBILITY = "visibilitychange";
-declare const EVENT_SELECT = "select";
 declare const EVENT_FRAME = "frame";
 declare const DATA_ERROR = "DataError";
 declare const EVENT_ERROR = "EventError";
@@ -79,7 +86,7 @@ type TConfigData = {
     anchor?: never;
 } | {
     mode: typeof PROJECT_MODE_SLAM_WEBXR;
-    uiContainer: Element;
+    uiContainer?: Element;
     fov?: never;
     near?: never;
     far?: never;
@@ -106,7 +113,7 @@ type TConfigData = {
     anchor: TAnchorType;
 });
 
-type TEventWASType = typeof EVENT_DETECTED | typeof EVENT_LOST | typeof EVENT_POSE | typeof EVENT_PROCESS | typeof EVENT_XR_SESSION | typeof EVENT_RESIZE | typeof EVENT_DEVICE_ORIENTATION | typeof EVENT_SCREEN_ORIENTATION | typeof EVENT_VISIBILITY | typeof EVENT_SELECT | typeof EVENT_FRAME;
+type TEventWASType = typeof EVENT_DETECTED | typeof EVENT_LOST | typeof EVENT_POSE | typeof EVENT_PROCESS | typeof EVENT_XR_SESSION | typeof EVENT_XR_SELECT | typeof EVENT_XR_ROTATE_START | typeof EVENT_XR_ROTATE | typeof EVENT_XR_PINCH_START | typeof EVENT_XR_PINCH | typeof EVENT_XR_PAN_START | typeof EVENT_XR_PAN_MOVE | typeof EVENT_XR_VIEWER_POSE | typeof EVENT_RESIZE | typeof EVENT_DEVICE_ORIENTATION | typeof EVENT_SCREEN_ORIENTATION | typeof EVENT_VISIBILITY | typeof EVENT_FRAME;
 
 type TVector = {
     x: number;
@@ -145,21 +152,38 @@ type TEventPoseData = {
     landmarksData?: TVector[];
 };
 
+type XREvent = {
+    rotation: number;
+    scale: number;
+    deltaX: number;
+    deltaY: number;
+    clientX: number;
+    clientY: number;
+};
+
+type TXRViewerPose = {
+    positionVector: TVector;
+    rotationQuaternion: TQuaternion;
+    scaleVector: TVector;
+    projectionMatrix: Float32Array;
+};
+
 type TEventWASCallBack = {
     (detectedData: TEventDetectedData[]): void;
     (lostData: TEventLostData[]): void;
     (poseData: TEventPoseData[]): void;
     (isProcess: boolean): void;
     (isActive: boolean): void;
+    (event: XREvent): void;
+    (XRViewerPose: TXRViewerPose | undefined): void;
     (event: UIEvent): void;
     (event: DeviceOrientationEvent): void;
     (angle: number): void;
     (isVisible: boolean): void;
-    (): void;
     (deltaTime: number): void;
 };
 
-type TEventType = typeof EVENT_DETECTED | typeof EVENT_LOST | typeof EVENT_POSE | typeof EVENT_PROCESS | typeof EVENT_XR_SESSION | typeof EVENT_RESIZE | typeof EVENT_DEVICE_ORIENTATION | typeof EVENT_SCREEN_ORIENTATION | typeof EVENT_VISIBILITY | typeof EVENT_SELECT | typeof EVENT_FRAME;
+type TEventType = typeof EVENT_DETECTED | typeof EVENT_LOST | typeof EVENT_POSE | typeof EVENT_PROCESS | typeof EVENT_XR_SESSION | typeof EVENT_XR_SELECT | typeof EVENT_XR_ROTATE_START | typeof EVENT_XR_ROTATE | typeof EVENT_XR_PINCH_START | typeof EVENT_XR_PINCH | typeof EVENT_XR_PAN_START | typeof EVENT_XR_PAN_MOVE | typeof EVENT_XR_VIEWER_POSE | typeof EVENT_RESIZE | typeof EVENT_DEVICE_ORIENTATION | typeof EVENT_SCREEN_ORIENTATION | typeof EVENT_VISIBILITY | typeof EVENT_FRAME;
 
 type TViewportSizes = {
     width: number;
@@ -179,15 +203,13 @@ type TTriggerSize = {
     height: number;
 };
 
-type TEventEmitType = typeof EVENT_DETECTED | typeof EVENT_LOST | typeof EVENT_POSE | typeof EVENT_PROCESS | typeof EVENT_XR_SESSION | typeof EVENT_SELECT;
+type TEventEmitType = typeof EVENT_DETECTED | typeof EVENT_LOST | typeof EVENT_POSE | typeof EVENT_PROCESS | typeof EVENT_XR_SESSION | typeof EVENT_XR_SELECT | typeof EVENT_XR_ROTATE_START | typeof EVENT_XR_ROTATE | typeof EVENT_XR_PINCH_START | typeof EVENT_XR_PINCH | typeof EVENT_XR_PAN_START | typeof EVENT_XR_PAN_MOVE | typeof EVENT_XR_VIEWER_POSE;
 
-type TEventEmitData = TEventDetectedData[] | TEventLostData[] | TEventPoseData[] | boolean;
+type TEventEmitData = TEventDetectedData[] | TEventLostData[] | TEventPoseData[] | TXRViewerPose | XREvent | boolean;
 
-type TXRViewerPose = {
-    positionVector: TVector;
-    rotationQuaternion: TQuaternion;
-    scaleVector: TVector;
-    projectionMatrix: Float32Array;
+type TSizes = {
+    width: number;
+    height: number;
 };
 
 interface IWAS {
@@ -198,6 +220,7 @@ interface IWAS {
     setMediaStream(): Promise<void>;
     getTriggerSize(triggerId: number): TTriggerSize | null;
     getTriggerScale(triggerId: number): TVector | null;
+    getSizes(): TSizes;
     getViewportSizes(): TViewportSizes;
     getFaceMeshTriangulation(): Uint16Array;
     getFaceMeshTriangulationFillMouth(): Uint16Array;
@@ -208,9 +231,11 @@ interface IWAS {
     getIsSupportXRSession(): Promise<boolean>;
     getIsActiveXRSession(): boolean;
     endXRSession(): void;
-    getXRViewerPose(): TXRViewerPose | null;
+    getXRFramebuffer(): WebGLFramebuffer | null;
+    getXRCameraImage(): WebGLTexture | null;
     emit(type: TEventEmitType, data?: TEventEmitData): void;
     getDeltaTime(): number;
+    getElapsedTime(): number;
 }
 
 declare class WAS implements IWAS {
@@ -256,11 +281,12 @@ declare class WAS implements IWAS {
     on(type: typeof EVENT_POSE, callBack: (poseData: TEventPoseData[]) => void): Promise<void>;
     on(type: typeof EVENT_PROCESS, callBack: (isProcess: boolean) => void): Promise<void>;
     on(type: typeof EVENT_XR_SESSION, callBack: (isActive: boolean) => void): Promise<void>;
+    on(type: typeof EVENT_XR_SELECT | typeof EVENT_XR_ROTATE_START | typeof EVENT_XR_ROTATE | typeof EVENT_XR_PINCH_START | typeof EVENT_XR_PINCH | typeof EVENT_XR_PAN_START | typeof EVENT_XR_PAN_MOVE, callBack: (event: XREvent) => void): Promise<void>;
+    on(type: typeof EVENT_XR_VIEWER_POSE, callBack: (XRViewerPose: TXRViewerPose | undefined) => void): Promise<void>;
     on(type: typeof EVENT_RESIZE, callBack: (event: UIEvent) => void): Promise<void>;
     on(type: typeof EVENT_DEVICE_ORIENTATION, callBack: (event: DeviceOrientationEvent) => void): Promise<void>;
     on(type: typeof EVENT_SCREEN_ORIENTATION, callBack: (angle: number) => void): Promise<void>;
     on(type: typeof EVENT_VISIBILITY, callBack: (isVisible: boolean) => void): Promise<void>;
-    on(type: typeof EVENT_SELECT, callBack: () => void): Promise<void>;
     on(type: typeof EVENT_FRAME, callBack: (deltaTime: number) => void): Promise<void>;
     un(type: TEventType): Promise<void>;
     dispose(): Promise<void>;
@@ -287,6 +313,7 @@ declare class WAS implements IWAS {
     private drawVideo;
     getTriggerSize(triggerId: number): TTriggerSize | null;
     getTriggerScale(triggerId: number): TVector | null;
+    getSizes(): TSizes;
     getViewportSizes(): TViewportSizes;
     getFaceMeshTriangulation(): Uint16Array;
     getFaceMeshTriangulationFillMouth(): Uint16Array;
@@ -297,9 +324,11 @@ declare class WAS implements IWAS {
     getIsSupportXRSession(): Promise<boolean>;
     getIsActiveXRSession(): boolean;
     endXRSession(): void;
-    getXRViewerPose(): TXRViewerPose | null;
+    getXRFramebuffer(): WebGLFramebuffer | null;
+    getXRCameraImage(): WebGLTexture | null;
     emit(type: TEventEmitType, data?: TEventEmitData): void;
     getDeltaTime(): number;
+    getElapsedTime(): number;
 }
 
-export { ANCHOR_TYPE_BOTTOM_LEFT, ANCHOR_TYPE_BOTTOM_LIP, ANCHOR_TYPE_BOTTOM_RIGHT, ANCHOR_TYPE_CENTER, ANCHOR_TYPE_CHIN, ANCHOR_TYPE_LEFT_EAR, ANCHOR_TYPE_LEFT_EYE, ANCHOR_TYPE_LEFT_EYEBROW, ANCHOR_TYPE_NOSE_BASE, ANCHOR_TYPE_NOSE_BRIDGE, ANCHOR_TYPE_NOSE_TIP, ANCHOR_TYPE_ORIGIN, ANCHOR_TYPE_RIGHT_EAR, ANCHOR_TYPE_RIGHT_EYE, ANCHOR_TYPE_RIGHT_EYEBROW, ANCHOR_TYPE_TOP_LEFT, ANCHOR_TYPE_TOP_RIGHT, DATA_ERROR, DEVICE_ERROR, EVENT_DETECTED, EVENT_DEVICE_ORIENTATION, EVENT_ERROR, EVENT_FRAME, EVENT_LOST, EVENT_POSE, EVENT_PROCESS, EVENT_RESIZE, EVENT_SCREEN_ORIENTATION, EVENT_SELECT, EVENT_VISIBILITY, EVENT_XR_SESSION, GL_ERROR, HTML_ERROR, PROJECT_MODE_FACE, PROJECT_MODE_IMAGE, PROJECT_MODE_MIX, PROJECT_MODE_QR, PROJECT_MODE_SLAM_3DOF, PROJECT_MODE_SLAM_WEBXR, type TEventDetectedData, type TEventLostData, type TEventPoseData, TRIGGER_MODE_FACE, TRIGGER_MODE_IMAGE, TRIGGER_MODE_QR, TRIGGER_MODE_SLAM_WEBXR, type TTriggerSize, type TViewportSizes, type TXRViewerPose, VIDEO_ERROR, WORKER_ERROR, XR_ERROR, WAS as default };
+export { ANCHOR_TYPE_BOTTOM_LEFT, ANCHOR_TYPE_BOTTOM_LIP, ANCHOR_TYPE_BOTTOM_RIGHT, ANCHOR_TYPE_CENTER, ANCHOR_TYPE_CHIN, ANCHOR_TYPE_LEFT_EAR, ANCHOR_TYPE_LEFT_EYE, ANCHOR_TYPE_LEFT_EYEBROW, ANCHOR_TYPE_NOSE_BASE, ANCHOR_TYPE_NOSE_BRIDGE, ANCHOR_TYPE_NOSE_TIP, ANCHOR_TYPE_ORIGIN, ANCHOR_TYPE_RIGHT_EAR, ANCHOR_TYPE_RIGHT_EYE, ANCHOR_TYPE_RIGHT_EYEBROW, ANCHOR_TYPE_TOP_LEFT, ANCHOR_TYPE_TOP_RIGHT, DATA_ERROR, DEVICE_ERROR, EVENT_DETECTED, EVENT_DEVICE_ORIENTATION, EVENT_ERROR, EVENT_FRAME, EVENT_LOST, EVENT_POSE, EVENT_PROCESS, EVENT_RESIZE, EVENT_SCREEN_ORIENTATION, EVENT_VISIBILITY, EVENT_XR_PAN_MOVE, EVENT_XR_PAN_START, EVENT_XR_PINCH, EVENT_XR_PINCH_START, EVENT_XR_ROTATE, EVENT_XR_ROTATE_START, EVENT_XR_SELECT, EVENT_XR_SESSION, EVENT_XR_VIEWER_POSE, GL_ERROR, HTML_ERROR, PROJECT_MODE_FACE, PROJECT_MODE_IMAGE, PROJECT_MODE_MIX, PROJECT_MODE_QR, PROJECT_MODE_SLAM_3DOF, PROJECT_MODE_SLAM_WEBXR, type TEventDetectedData, type TEventLostData, type TEventPoseData, TRIGGER_MODE_FACE, TRIGGER_MODE_IMAGE, TRIGGER_MODE_QR, TRIGGER_MODE_SLAM_WEBXR, type TSizes, type TTriggerSize, type TViewportSizes, type TXRViewerPose, VIDEO_ERROR, WORKER_ERROR, type XREvent, XR_ERROR, WAS as default };