@realsee/five 5.0.0-alpha.135 → 5.0.0-alpha.136

package/five/index.d.ts

@@ -11,7 +11,7 @@ export declare interface AddableObject extends THREE_2.Object3D {
 }
 
 export declare interface AnimationFrame {
-    callback: (time: number, deltaTime: number) => void;
+    callback: (time: number, deltaTime: number, ...args: any[]) => void;
     once: boolean;
     delay: number;
     order: number;
@@ -21,11 +21,17 @@ export declare class AnimationFrameLoop {
     private frames;
     private time;
     private stoped;
+    private context?;
+    private requestId;
     private static sharedInstance?;
     static get shared(): AnimationFrameLoop;
     static getFrameTime(): number;
     constructor();
     private loop;
+    setContext(context: any): void;
+    getContext(): any;
+    private requestAnimationFrame;
+    private cancelAnimationFrame;
     private remove;
     /**
      * 添加到动画循环
@@ -124,6 +130,7 @@ export declare type ControllerCustomInitTypes = {
     Model: ModelControllerCustomInitArgs;
     DepthPanorama: DepthPanoramaControllerCustomInitArgs;
     Mapview: MapviewControllerCustomInitArgs;
+    XRPanorama: XRPanoramaControllerCustomInitArgs;
 };
 
 export declare type ControllerEventTypes = {
@@ -411,6 +418,14 @@ export declare type ControllerEventTypes = {
      * @param error - 抛出错误
      */
     error(error: Error): void;
+    /**
+     * webXR模式开始，webxr session完成坐标系矫正
+     */
+    webXRSessionStart(): void;
+    /**
+     * webXR模式结束,webxr session销毁
+     */
+    webXRSessionEnd(): void;
 };
 
 /**
@@ -618,6 +633,7 @@ export declare class Five extends Subscribe<EventTypes> {
      * Topview 户型图模式
      * DepthPanorama 深度图游走模式
      * VRPanorama VR眼镜模式
+     * XRPanorama VR硬件模式
      * ```
      */
     static Mode: Mirror<Mode>;
@@ -913,7 +929,7 @@ export declare class Five extends Subscribe<EventTypes> {
      * @param callback - 渲染完成回调
      */
     render(callback?: () => void, updateObjectResolution?: boolean): THREE_2.WebGLRenderTarget;
-    updateTime(time: number, deltaTime: number): void;
+    updateTime(time: number, deltaTime: number, ...args: any[]): void;
     /**
      * 但停自动播放
      */
@@ -1132,6 +1148,8 @@ export declare interface FiveInitArgs {
     depthPanorama?: ControllerCustomInitTypes["DepthPanorama"];
     /** VR眼镜模式下的特定参数 */
     vrPanorama?: ControllerCustomInitTypes["VRPanorama"];
+    /** XR眼镜模式下的特定参数 */
+    xrPanorama?: ControllerCustomInitTypes["XRPanorama"];
     /**
      * 模式间切换时的过度动画时间
      * @description
@@ -1439,7 +1457,9 @@ export declare type Mode =
 /** 模型游走模式 */
 "Model" | 
 /** 深度图游走模式 */
-"DepthPanorama";
+"DepthPanorama" | 
+/** XR眼镜模式*/
+"XRPanorama";
 
 /**
  * Five 模型
@@ -1834,6 +1854,8 @@ export declare class PBMMaterial extends THREE_2.ShaderMaterial implements PBMPa
     progress: number;
     /** 全景图通过过度黑色混合 */
     useBlackTransition: boolean;
+    /** XR模式防止申请纹理显存时的黑色过渡 */
+    useXRBlackTransition: boolean;
     perspToOrtho: number;
     /** 模型透明度 */
     opacity: number;
@@ -1872,6 +1894,8 @@ export declare interface PBMParameters {
     progress: number;
     /** 全景图通过过度黑色混合 */
     useBlackTransition: boolean;
+    /** XR模式防止申请纹理显存时的黑色过渡 */
+    useXRBlackTransition: boolean;
     perspToOrtho: number;
     /** 模型透明度 */
     opacity: number;
@@ -1896,7 +1920,7 @@ export declare interface Pose {
     distance: number;
 }
 
-export declare const PROXY_CONTROLLER_EVENT_NAMES: readonly ["cameraDirectionUpdate", "cameraUpdate", "cameraPositionUpdate", "panoSelected", "moveToPano", "moveToPanoCanceled", "panoWillArrive", "movingToPano", "panoArrived", "panoWillLoad", "panoLoaded", "panoLoadError", "initAnimationEnded", "initAnimationWillStart", "wantsGesture", "gesture", "wantsTapGesture", "tapGesture", "wantsPressGesture", "pressGesture", "wantsPanGesture", "wantsInteriaPan", "panGesture", "interiaPan", "wantsPinchGesture", "pinchGesture", "wantsMouseWheel", "mouseWheel", "wantsShowIntersectionOnModel", "intersectionOnModelUpdate", "intersectionHidden", "textureStartLoad", "textureLoading", "textureAbort", "textureLoaded", "textureError"];
+export declare const PROXY_CONTROLLER_EVENT_NAMES: readonly ["cameraDirectionUpdate", "cameraUpdate", "cameraPositionUpdate", "panoSelected", "moveToPano", "moveToPanoCanceled", "panoWillArrive", "movingToPano", "panoArrived", "panoWillLoad", "panoLoaded", "panoLoadError", "initAnimationEnded", "initAnimationWillStart", "wantsGesture", "gesture", "wantsTapGesture", "tapGesture", "wantsPressGesture", "pressGesture", "wantsPanGesture", "wantsInteriaPan", "panGesture", "interiaPan", "wantsPinchGesture", "pinchGesture", "wantsMouseWheel", "mouseWheel", "wantsShowIntersectionOnModel", "intersectionOnModelUpdate", "intersectionHidden", "textureStartLoad", "textureLoading", "textureAbort", "textureLoaded", "textureError", "webXRSessionStart", "webXRSessionEnd"];
 
 /** Five 场景*/
 export declare class Scene extends THREE_2.Scene {
@@ -2506,6 +2530,13 @@ export declare interface TopviewControllerCustomInitArgs extends Omit<FloorplanC
 export declare interface VRPanoramaControllerCustomInitArgs extends Omit<PanoramaControllerCustomInitArgs, "maxLatitude" | "minLatitude"> {
 }
 
+declare type WebXREventTypes = {
+    /** WebXR模式开始，session完成坐标系设置*/
+    webXRSessionStart(): void;
+    /** WebXR模式结束，销毁session*/
+    webXRSessionEnd(): void;
+};
+
 export declare class Work {
     /** 名称 */
     name: string;
@@ -2637,4 +2668,109 @@ export declare interface WorkVideo {
     size: THREE_2.Vector2;
 }
 
+export declare class XRButton {
+    static createButton(onClickHook: () => void): HTMLAnchorElement | HTMLButtonElement;
+}
+
+declare class XRController {
+    _targetRay: any;
+    _grip: any;
+    _hand: any;
+    _axes: number[];
+    constructor();
+    getHandSpace(): any;
+    getTargetRaySpace(): any;
+    getGripSpace(): any;
+    dispatchEvent(event: any): this;
+    disconnect(inputSource: XRInputSource): this;
+    getAxes(): number[];
+    update(inputSource: any, frame: any, referenceSpace: any): this;
+}
+
+declare type XRControllerRay = {
+    angularVelocity: THREE_2.Vector3;
+    linearVelocity: THREE_2.Vector3;
+    up: THREE_2.Vector3;
+    matrix: THREE_2.Matrix4;
+    position: THREE_2.Vector3;
+    rotation: THREE_2.Euler;
+};
+
+declare interface XRInitOption {
+    /** 使用WEBXR的当前设备*/
+    machineType: XRMachineType;
+    /** 全景模式还是视差模式*/
+    isPanorama: boolean;
+    /** 使用的参考空间类型*/
+    referenceSpaceType: XRReferenceSpaceType;
+}
+
+declare type XRMachineType = 'Pico' | 'Oculus';
+
+export declare class XRManager extends Subscribe<WebXREventTypes> {
+    /** 是否使用全景模式*/
+    isPanorama: boolean;
+    /** 当前的设备*/
+    machineType: XRMachineType;
+    /** 场景渲染器*/
+    renderer: THREE_2.WebGLRenderer;
+    /** opengles句柄*/
+    gl: WebGLRenderingContext;
+    /** 是否开启XR模式 */
+    enabled: boolean;
+    /** WebXR模式Context */
+    session: XRSession | null;
+    /** XR参考空间类型*/
+    referenceSpaceType: XRReferenceSpaceType;
+    /** XR参考空间 */
+    referenceSpace: XRReferenceSpace | null;
+    /** XR控制器 */
+    controllers: XRController[];
+    /** XR控制器控制数据 */
+    inputSourcesMap: Map<XRInputSource, XRController>;
+    /** XR双相机 */
+    cameraVR: THREE_2.ArrayCamera;
+    /** XR左眼相机*/
+    cameraL: THREE_2.PerspectiveCamera;
+    /** XR右眼相机*/
+    cameraR: THREE_2.PerspectiveCamera;
+    /** 是否在获取*/
+    isPresenting: boolean;
+    /** 视锥近面*/
+    private currentDepthNear;
+    /** 视锥远面*/
+    private currentDepthFar;
+    /** 左眼相机位姿*/
+    private cameraLPos;
+    /** 右眼相机位姿*/
+    private cameraRPos;
+    constructor(renderer: THREE_2.WebGLRenderer, gl: WebGLRenderingContext, options?: Partial<XRInitOption>);
+    getController(index: number): XRControllerRay;
+    getCameras(): any;
+    private updateCamera;
+    /**
+     * @author jsantell / https://www.jsantell.com/
+     *
+     * Assumes 2 cameras that are parallel and share an X-axis, and that
+     * the cameras' projection and world matrices have already been set.
+     * And that near and far planes are identical for both cameras.
+     * Visualization of this technique: https://computergraphics.stackexchange.com/a/4765
+     */
+    private setProjectionFromUnion;
+    /**
+     * 获取THREEJS用于渲染XR场景的双眼相机
+     * @param camera - 传统模式下渲染场景的THREEJS相机
+     * @returns - 用于渲染XR场景的双眼相机
+     */
+    getCamera(camera: THREE_2.PerspectiveCamera): any;
+    private updateInputSources;
+    private onSessionEvent;
+    private onSessionEnd;
+    private onRequestReferenceSpace;
+    setSession(value: XRSession | null): void;
+}
+
+declare interface XRPanoramaControllerCustomInitArgs extends Omit<PanoramaControllerCustomInitArgs, "maxLatitude" | "minLatitude"> {
+}
+
 export { }