@realsee/five 6.0.0-alpha.3 → 6.0.0-alpha.31

package/five/index.d.ts

@@ -118,7 +118,8 @@ export declare class BVH {
 export declare class BVHIntersect {
     triangle: [BVHVector3, BVHVector3, BVHVector3];
     intersectionPoint: BVHVector3;
-    constructor(triangle: [BVHVector3, BVHVector3, BVHVector3], intersectionPoint: BVHVector3);
+    triangleIndex: number;
+    constructor(triangle: [BVHVector3, BVHVector3, BVHVector3], intersectionPoint: BVHVector3, triangleIndex: number);
 }
 
 /**
@@ -210,7 +211,7 @@ export declare class Clipper {
     private static sharedInstance?;
     static get shared(): Clipper;
     constructor();
-    update(clipperParameters: ClipperParameter[], camera: THREE_2.Camera): void;
+    update(clipperParameter: ClipperParameter | ClipperParameter[], camera: THREE_2.Camera): void;
     private projectPlanes;
 }
 
@@ -284,6 +285,14 @@ export declare type ControllerEventTypes = {
     "xr.session.start"(event: XRSessionEvent_2): void;
     /** XR 手势（按钮） */
     "xr.gesture.tap"(event: XRGestureEvent): void;
+    /** XR 手势（按钮） */
+    "xr.gesture.press"(event: XRGestureEvent): void;
+    /** XR 手势（按钮） */
+    "xr.gesture.buttonUp"(event: XRGestureEvent): void;
+    /** XR 手势（按钮） */
+    "xr.gesture.buttonDown"(event: XRGestureEvent): void;
+    /** XR手柄更新*/
+    "xr.controller.update"(event: XRControllerEvent): void;
     /** 抛出错误 */
     "error"(error: Error): void;
 };
@@ -307,6 +316,8 @@ export declare class CullingVolume {
  */
 export declare function defaultImageURLTransform(source: string, options: ImageURLOptions): string;
 
+export declare const defaultPbmParameters: PBMParameters;
+
 export declare interface DepthPanoramaControllerCustomInitArgs extends PanoramaLikeControllerCustomInitArgs {
     /** 最远可移动观察点距离 */
     maxAccessibleDistance?: number;
@@ -343,6 +354,8 @@ export declare type EventTypes = Pick<ControllerEventTypes, typeof PROXY_CONTROL
     "works.request"(event: WorksEvent): void;
     /** 加载 work */
     "works.load"(event: WorksEvent): void;
+    /** 加载 work 并 controller ready */
+    "works.ready"(event: WorksEvent): void;
     /** 设置 state */
     "state.set"(event: StateEvent): void;
     /** 当 state 变化 */
@@ -396,6 +409,8 @@ export declare class Five extends Subscribe<EventTypes> {
     static get version(): string;
     static get dracoPath(): string;
     static set dracoPath(path: string);
+    static get ktx2Path(): string;
+    static set ktx2Path(path: string);
     /**
      * Five 的显示模式，可以通过 `five.changeMode` `five.setState` 来切换
      * @description
@@ -427,6 +442,8 @@ export declare class Five extends Subscribe<EventTypes> {
     currentMode: Mode;
     /** 内部使用的 `THREE.Scene` */
     scene: Scene;
+    /** 供外部放置需要在xr场景下产生遮挡的物体们*/
+    xrCustomObjectsScene: THREE_2.Scene;
     /** 内部使用的 `Camera` */
     camera: Camera;
     /**
@@ -602,11 +619,17 @@ export declare class Five extends Subscribe<EventTypes> {
      */
     get enableIOSEDR(): boolean;
     set enableIOSEDR(enable: boolean);
+    /**
+     * 后处理类型
+     */
+    get postProcessingType(): PostProcessingType;
     /**
      * 是否开启EDL模式
      */
     get enableEDL(): boolean;
     set enableEDL(enable: boolean);
+    get enableHQ(): boolean;
+    set enableHQ(enable: boolean);
     /**
      * 是否开启后处理
      */
@@ -1018,6 +1041,8 @@ parameters: Parameters<T>[1]
 export declare type FivePluginInstance<T extends FivePlugin<any, any>> = ReturnType<T>;
 
 export declare interface FloorplanControllerCustomInitArgs {
+    /** 默认水平角 */
+    defaultLongitude?: number;
     /** 默认俯仰角 */
     defaultLatitude?: number;
     /** 最大俯仰角 */
@@ -1090,8 +1115,9 @@ export declare interface ImageOptions {
 }
 
 export declare function imageSupport(): Promise<{
-    avif: boolean;
     webp: boolean;
+    avif: boolean;
+    heif: boolean;
 }>;
 
 export declare interface ImageURLMappings {
@@ -1148,6 +1174,7 @@ export declare interface Intersection {
     } | null;
     /** 焦点距离 */
     distance: number;
+    floor: number;
 }
 
 export declare class IntersectMesh extends THREE_2.Object3D implements IntersectMeshInterface {
@@ -1462,6 +1489,17 @@ export declare type LegacyEventType = {
      * axes代表控制杆，axes数组的0-1元素分别代表左控制器的左（-1）右（1）,左控制器的上（-1）下（1），axes数组的2-3元素同理
      */
     webXRControllerEvent(type: WebXRControllerType, key: WebXRControllerKey, params: WebXRControllerParams): void;
+    /**
+     * xr控制器的Axes原始实时数据状态
+     */
+    webXRAxesUpdate(type: 'left' | 'right', param: WebXRAxesParams): void;
+    /**
+     * xr控制器的控制器射线更新
+     */
+    webXRControllerRayUpdate(raycaster: {
+        leftRay: THREE_2.Raycaster;
+        rightRay: THREE_2.Raycaster;
+    }): void;
     /**
      * 准备加载 Work 数据
      * @param input - 输入的 work
@@ -1560,6 +1598,53 @@ export declare type LegacyEventType = {
     network(source: string, type: NetworkType, state: NetworkState, detail: string): void;
 };
 
+export declare function loadAt3d(url: string, options: {
+    textureOptions?: TextureOptions;
+    textureBaseUri?: string;
+    textureArray?: string[];
+    allowHosts?: string[];
+    requestProxy?: (url: string) => string | Promise<string>;
+    networkSubscribe?: NetworkSubscribe;
+}): Promise<ParsedResultType>;
+
+export declare function loadB3dm(url: string, options: {
+    upAxis: 'X' | 'Y' | 'Z';
+    allowHosts?: string[];
+    requestProxy?: (url: string) => string | Promise<string>;
+    networkSubscribe?: NetworkSubscribe;
+}): Promise<ParsedResultType>;
+
+export declare function loadDome(url: string, options: {
+    textureOptions: TextureOptions;
+    textureBaseUri?: string;
+    allowHosts?: string[];
+    requestProxy?: (url: string) => string | Promise<string>;
+    networkSubscribe?: NetworkSubscribe;
+}): Promise<ParsedResultType>;
+
+export declare function loadDomez(url: string, options: {
+    textureOptions: TextureOptions;
+    textureBaseUri?: string;
+    allowHosts?: string[];
+    requestProxy?: (url: string) => string | Promise<string>;
+    networkSubscribe?: NetworkSubscribe;
+}): Promise<ParsedResultType>;
+
+export declare function loadPbm(url: string, options: {
+    textureOptions?: TextureOptions;
+    textureBaseUri?: string;
+    textureArray?: string[];
+    allowHosts?: string[];
+    requestProxy?: (url: string) => string | Promise<string>;
+    networkSubscribe?: NetworkSubscribe;
+}): Promise<ParsedResultType>;
+
+export declare function loadPnts(url: string, options: {
+    allowHosts?: string[];
+    requestProxy?: (url: string) => string | Promise<string>;
+    networkSubscribe?: NetworkSubscribe;
+}): Promise<ParsedResultType>;
+
 export declare type LooseWork = {
     work_code?: string;
     code?: string;
@@ -1668,6 +1753,8 @@ export declare type LooseWorkWithExtrinsics = {
 };
 
 export declare interface MapviewControllerCustomInitArgs {
+    /** 默认水平角 */
+    defaultLongitude?: number;
     /** 默认俯仰角 */
     defaultLatitude?: number;
     /** 默认相机距离 */
@@ -1801,7 +1888,7 @@ export declare class Model extends THREE_2.Object3D {
      * @param floors - 和某一楼层做碰撞检测， 不传为和所有楼层做碰撞检测
      * @returns 返回碰撞
      */
-    intersectRaycaster(raycaster: THREE_2.Raycaster): Intersection[];
+    intersectRaycaster(raycaster: THREE_2.Raycaster, floor?: number | null): Intersection[];
     /**
      * 加载模型
      * @param work - work 的
@@ -1834,7 +1921,7 @@ export declare interface ModelLodOptions {
     maxDepth?: number;
 }
 
-export declare type ModelMaterialValues = Pick<PBMParameters, 'pano0' | 'pano1' | 'modelAlpha' | 'progress' | 'useBlackTransition' | 'opacity' | 'constantColor' | 'useEDL' | 'pointShape' | 'pointColorType' | 'pointSizeType' | 'pointSize' | 'pointMinSize' | 'pointMaxSize' | 'pointSizeAdaptiveScale' | 'gradientTexture'>;
+export declare type ModelMaterialValues = Pick<PBMParameters, 'pano0' | 'pano1' | 'modelAlpha' | 'progress' | 'useBlackTransition' | 'opacity' | 'constantColor' | 'useEDL' | 'useHQWeight' | 'useHQDepth' | 'pointShape' | 'pointColorType' | 'pointSizeType' | 'pointSize' | 'pointMinSize' | 'pointMaxSize' | 'pointSizeAdaptiveScale' | 'gradientTexture'>;
 
 export declare type Models = Model[] & {
     needsRender: boolean;
@@ -2157,6 +2244,13 @@ export declare interface PanoTextureEvent extends BaseEvent {
     error: Error | null;
 }
 
+export declare type ParsedResultType = {
+    type: 'b3dm' | 'pnts' | 'at3d' | 'pbm' | 'dome' | 'domez' | 'glb';
+    byteLength: number;
+    uri: string;
+    object: THREE_2.Object3D;
+};
+
 /**
  * 解析 Work 数据
  * @param obj - work 数据，从如数开发者平台获取
@@ -2237,41 +2331,45 @@ export declare class PBMMeshMaterial extends THREE_2.ShaderMaterial implements P
     /** 更新版本 */
     pbmMaterialParametersVersion: number;
     /** 起始点 */
-    pano0: PBMPanoPicture | null;
+    pano0: PBMParameters['pano0'];
     /** 结束点 */
-    pano1: PBMPanoPicture | null;
+    pano1: PBMParameters['pano1'];
     /** 模型贴图和全景图的混合程度 [0-1] */
-    modelAlpha: number;
+    modelAlpha: PBMParameters['modelAlpha'];
     /** 全景图混合程度 [0-1] */
-    progress: number;
+    progress: PBMParameters['progress'];
     /** 全景图通过过度黑色混合 */
-    useBlackTransition: boolean;
+    useBlackTransition: PBMParameters['useBlackTransition'];
     /** 模型透明度 */
-    opacity: number;
+    opacity: PBMParameters['opacity'];
     /** 模型颜色*/
-    constantColor: THREE_2.Vector3 | null;
+    constantColor: PBMParameters['constantColor'];
     /** 楼层参数*/
-    floorIndex: number;
+    floorIndex: PBMParameters['floorIndex'];
     /** 对外模型裁切参数*/
-    clippers: ClipperParameter[] | null;
+    clippers: PBMParameters['clippers'];
     /** edl*/
-    useEDL: boolean;
+    useEDL: PBMParameters['useEDL'];
+    /** hq*/
+    useHQWeight: PBMParameters['useHQWeight'];
+    /** HQDepthMask*/
+    useHQDepth: PBMParameters['useHQDepth'];
     /** 点云着色方式*/
-    pointColorType: PBMPointColorType;
+    pointColorType: PBMParameters['pointColorType'];
     /** 点云大小绘制方式*/
-    pointSizeType: PBMPointSizeType;
+    pointSizeType: PBMParameters['pointSizeType'];
     /** 点云形状*/
-    pointShape: PBMPointShapeType;
+    pointShape: PBMParameters['pointShape'];
     /** 点云基础大小*/
-    pointSize: number;
+    pointSize: PBMParameters['pointSize'];
     /** 自适应点云大小因子*/
-    pointSizeAdaptiveScale: number;
+    pointSizeAdaptiveScale: PBMParameters['pointSizeAdaptiveScale'];
     /** 点云最大尺寸*/
-    pointMinSize: number;
+    pointMinSize: PBMParameters['pointMinSize'];
     /** 点云最小尺寸*/
-    pointMaxSize: number;
+    pointMaxSize: PBMParameters['pointMaxSize'];
     /** 高程彩色图*/
-    gradientTexture: THREE_2.Texture | null;
+    gradientTexture: PBMParameters['gradientTexture'];
     constructor(parameters?: Partial<PBMParameters>);
     update(renderer: THREE_2.WebGLRenderer, camera: Camera, cache: PBMMaterialReferenceCache): void;
 }
@@ -2307,12 +2405,16 @@ export declare interface PBMParameters {
     constantColor: THREE_2.Vector3 | null;
     /** 是否使用EDL*/
     useEDL: boolean;
+    /** 是否使用HQ*/
+    useHQWeight: boolean;
+    /** 是否使用HQ_DEPTH_MASK*/
+    useHQDepth: boolean;
     /** 点云形状*/
-    pointShape: PBMPointShapeType;
+    pointShape: 'SQUARE' | 'CIRCLE';
     /** 点云着色方式*/
-    pointColorType: PBMPointColorType;
+    pointColorType: 'RGB' | 'ALTITUDE';
     /** 点云大小绘制方式*/
-    pointSizeType: PBMPointSizeType;
+    pointSizeType: 'FIXED' | 'ADAPTIVE';
     /** 点云基础大小*/
     pointSize: number;
     /** 点云最大尺寸*/
@@ -2325,21 +2427,6 @@ export declare interface PBMParameters {
     gradientTexture: THREE_2.Texture | null;
 }
 
-export declare enum PBMPointColorType {
-    RGB = "rgb",
-    ALTITUDE = "altitude"
-}
-
-export declare enum PBMPointShapeType {
-    SQUARE = "square",
-    CIRCLE = "circle"
-}
-
-export declare enum PBMPointSizeType {
-    FIXED = "fixed",
-    ADAPTIVE = "adaptive"
-}
-
 /**
  * 相机位姿
  * [[include: coordinate.md]]
@@ -2357,7 +2444,9 @@ export declare interface Pose {
     distance: number;
 }
 
-export declare const PROXY_CONTROLLER_EVENT_NAMES: readonly ["gesture.pan", "gesture.tap", "gesture.press", "gesture.pinch", "gesture.mousewheel", "gesture.mousemove", "gesture.momentum", "initAnimation.start", "initAnimation.end", "camera.update", "intersect.update", "pano.select", "pano.moveTo", "pano.moving", "pano.arrived", "pano.cancel", "pano.error", "pano.texture.load", "pano.texture.progress", "pano.texture.success", "pano.texture.error", "pano.texture.abort", "xr.session.start", "xr.session.end", "xr.gesture.tap"];
+export declare type PostProcessingType = 'edl' | 'hq' | 'luminance' | null;
+
+export declare const PROXY_CONTROLLER_EVENT_NAMES: readonly ["gesture.pan", "gesture.tap", "gesture.press", "gesture.pinch", "gesture.mousewheel", "gesture.mousemove", "gesture.momentum", "initAnimation.start", "initAnimation.end", "camera.update", "intersect.update", "pano.select", "pano.moveTo", "pano.moving", "pano.arrived", "pano.cancel", "pano.error", "pano.texture.load", "pano.texture.progress", "pano.texture.success", "pano.texture.error", "pano.texture.abort", "xr.session.start", "xr.session.end", "xr.gesture.tap", "xr.gesture.press", "xr.gesture.buttonUp", "xr.gesture.buttonDown", "xr.controller.update"];
 
 export declare class RegionBoundingVolume implements BoundingVolume {
     type: "regin";
@@ -2726,7 +2815,9 @@ export declare class Tile3DModel extends THREE_2.Object3D {
     static DEFAULT_MAX_MEMORY_USAGE: number;
     static DEFAULT_MAX_SCREEN_SPACE_ERROR: number;
     static DEFAULT_MAX_REQUESTS: number;
+    objType: 'mesh' | 'point_cloud';
     workCode: string;
+    search: string;
     tileset: Tileset;
     maxLevelOfDetail: number;
     boundingBox: THREE_2.Box3;
@@ -2736,12 +2827,12 @@ export declare class Tile3DModel extends THREE_2.Object3D {
     disposed: boolean;
     needsRender: boolean;
     lastRefineTime: number;
-    private nodeGroup;
-    private debugBoundingGroup;
+    nodeGroup: THREE_2.Group;
+    debugBoundingGroup: THREE_2.Group;
     private nodes;
     private debugBoundings;
     private unloadTileQueue;
-    constructor(workCode: string, tilesetHeader: TilesetHeader, options: Partial<Tile3DModelLoaderOptions>);
+    constructor(workCode: string, objType: 'mesh' | 'point_cloud', tilesetHeader: TilesetHeader, options: Partial<Tile3DModelLoaderOptions>);
     get debug(): boolean;
     set debug(value: boolean);
     get maxMemoryUsage(): number;
@@ -2757,7 +2848,7 @@ export declare class Tile3DModel extends THREE_2.Object3D {
         requestProxy?: (url: string) => string | Promise<string>;
         networkSubscribe?: NetworkSubscribe;
     }): Promise<boolean>;
-    intersectRaycaster(raycaster: THREE_2.Raycaster): Intersection[];
+    intersectRaycaster(raycaster: THREE_2.Raycaster, distanceOrder: boolean): Intersection[];
     update(renderer: THREE_2.WebGLRenderer, camera: Camera): void;
     dispose(): void;
 }
@@ -2768,11 +2859,12 @@ export declare interface Tile3DModelLoaderOptions {
     allowHosts?: string[];
     requestProxy?: (url: string) => string | Promise<string>;
     networkSubscribe?: NetworkSubscribe;
+    search?: string;
     onError?: (error: Error) => void;
 }
 
 export declare type TileContentData = {
-    type: 'b3dm' | 'pnts' | 'at3d' | 'pbm';
+    type: 'b3dm' | 'pnts' | 'at3d' | 'pbm' | 'dome' | 'domez' | 'glb';
     byteLength: number;
     uri: string;
     object: TileNode;
@@ -2843,9 +2935,10 @@ export declare interface TileHeader {
 }
 
 export declare class TileNode extends THREE_2.Group {
+    objType: 'mesh' | 'point_cloud';
     bvhTree: BVH | undefined;
-    objType: 'mesh' | 'points';
-    constructor(obj: THREE_2.Object3D, objType: 'mesh' | 'points');
+    private floorsArray;
+    constructor(obj: THREE_2.Object3D, objType: 'mesh' | 'point_cloud');
     buildBvhTree(): void;
     intersectRaycaster(raycaster: THREE_2.Raycaster): Intersection[];
     dispose(): void;
@@ -2859,7 +2952,7 @@ export declare class Tileset {
     asset: {
         version: string;
         tilesetVersion: string;
-        gltfUpAxis: "X" | "Y" | "Z";
+        gltfUpAxis: "Y" | "Z";
     };
     id: string;
     frameNumber: number;
@@ -2926,7 +3019,7 @@ export declare interface TilesetHeader {
     asset: {
         version: string;
         tilesetVersion?: string;
-        gltfUpAxis?: "X" | "Y" | "Z";
+        gltfUpAxis?: "Y" | "Z";
     };
     properties?: Record<string, any>;
     geometricError: number;
@@ -2990,13 +3083,30 @@ export declare enum VolumePlaneIntersect {
 export declare interface VRPanoramaControllerCustomInitArgs extends Omit<PanoramaControllerCustomInitArgs, "maxLatitude" | "minLatitude"> {
 }
 
+export declare interface WebXRAxesParams {
+    raycaster: {
+        leftRay: THREE_2.Raycaster;
+        rightRay: THREE_2.Raycaster;
+    };
+    axesState: {
+        up: number;
+        down: number;
+        left: number;
+        right: number;
+    };
+    deltaTime: number;
+}
+
 export declare type WebXRControllerKey = XRGestureEvent['buttons'];
 
 export declare interface WebXRControllerParams {
-    raycaster: THREE_2.Raycaster[];
+    raycaster: {
+        leftRay: THREE_2.Raycaster;
+        rightRay: THREE_2.Raycaster;
+    };
 }
 
-export declare type WebXRControllerType = 'tap' | 'press' | 'axes';
+export declare type WebXRControllerType = 'tap' | 'press' | 'axes' | 'buttonUp' | 'buttonDown';
 
 export declare class Work {
     /** 名称 */
@@ -3197,15 +3307,51 @@ export declare class XRButton {
     static createButton(onClickHook: () => void): HTMLAnchorElement | HTMLButtonElement;
 }
 
+export declare interface XRControllerEvent extends BaseEvent {
+    left: {
+        axes: {
+            up: number;
+            down: number;
+            left: number;
+            right: number;
+        };
+        raycaster: THREE_2.Raycaster;
+        deltaTime: number;
+    };
+    right: {
+        axes: {
+            up: number;
+            down: number;
+            left: number;
+            right: number;
+        };
+        raycaster: THREE_2.Raycaster;
+        deltaTime: number;
+    };
+    buttons: {
+        X: boolean;
+        Y: boolean;
+        LeftTrigger: boolean;
+        LeftPinch: boolean;
+        A: boolean;
+        B: boolean;
+        RightTrigger: boolean;
+        RightPinch: boolean;
+    };
+}
+
 export declare interface XRGestureEvent extends BaseEvent {
     session: XRSession | null;
-    buttons: null | 'A' | 'B' | 'X' | 'Y' | 'RightTrigger' | 'RightPinch' | 'LeftTrigger' | 'LeftPinch' | 'LeftAxesLeft' | 'LeftAxesRight' | 'LeftAxesUp' | 'LeftAxesDown' | 'RightAxesLeft' | 'RightAxesRight' | 'RightAxesUp' | 'RightAxesDown';
+    buttons: 'A' | 'B' | 'X' | 'Y' | 'RightTrigger' | 'RightPinch' | 'LeftTrigger' | 'LeftPinch' | 'LeftAxesLeft' | 'LeftAxesRight' | 'LeftAxesUp' | 'LeftAxesDown' | 'RightAxesLeft' | 'RightAxesRight' | 'RightAxesUp' | 'RightAxesDown';
     machineType: 'Pico' | 'Oculus';
     isFirst: boolean;
     isFinal: boolean;
     controllers: {
-        raycaster: THREE_2.Raycaster;
-    }[];
+        raycaster: {
+            leftRay: THREE_2.Raycaster;
+            rightRay: THREE_2.Raycaster;
+        };
+    };
 }
 
 export declare interface XRPanoramaControllerCustomInitArgs extends Omit<PanoramaControllerCustomInitArgs, "maxLatitude" | "minLatitude"> {