@realsee/five 5.0.0-alpha.149 → 5.0.0-alpha.150

package/five/index.d.ts

@@ -5,6 +5,7 @@ import * as THREE_2 from 'three';
 import Vector3 from '@math.gl/core/dist/esm/classes/vector3';
 
 export declare interface AddableObject extends THREE_2.Object3D {
+    needsPerToOrt?: boolean;
     needsRender?: boolean;
     mixer?: THREE_2.AnimationMixer;
     setResolution?(width: number, height: number): void;
@@ -122,6 +123,22 @@ export declare interface CameraPose {
     offset: THREE_2.Vector3;
 }
 
+export declare class Clipper {
+    numPlanes: number;
+    clipperPlanes: Float32Array | null;
+    clipperFloors: number[] | null;
+    private static sharedInstance?;
+    static get shared(): Clipper;
+    constructor();
+    update(clipperParameter: ClipperParameter | ClipperParameter[], camera: THREE_2.Camera): void;
+    private projectPlanes;
+}
+
+export declare interface ClipperParameter {
+    clippingBoxMatrix: THREE_2.Matrix4;
+    floorIndex?: number;
+}
+
 export declare type ControllerCustomInitTypes = {
     Floorplan: FloorplanControllerCustomInitArgs;
     Topview: TopviewControllerCustomInitArgs;
@@ -659,6 +676,8 @@ export declare class Five extends Subscribe<EventTypes> {
     currentMode?: Mode;
     /** 内部使用的 `THREE.Scene` */
     scene: Scene;
+    /** 内部使用的产生视差的物体Scene `THREE.Scene` */
+    parallaxScene: Scene;
     /** 内部使用的 `Camera` */
     camera: Camera;
     /**
@@ -762,7 +781,24 @@ export declare class Five extends Subscribe<EventTypes> {
     private screenBuffer?;
     private analysis?;
     private renderSwitch01;
+    /**
+     * gpu_picking
+     */
+    private gpuPickingRenderTarget;
+    private meshReplaceMaterialMap;
+    private meshOriginMaterialMap;
     constructor(initArgs?: FiveInitArgs);
+    /**
+     * GPU Picking 获取选中的 mesh
+     * @param x - 屏幕坐标 x
+     * @param y - 屏幕坐标 y
+     * @param colorMap - 需要选取的 mesh 的颜色与 uuid 的映射
+     * @param modelColor - 指定的模型颜色
+     * @returns 选中 mesh 的 uuid
+     */
+    getGPUPicking(x: number, y: number, colorMap: {
+        [key: string]: THREE_2.Color;
+    }, pixelRatio?: number, modelColor?: THREE_2.Vector3): string | false;
     /**
      * 析构 five 对象。
      * @description
@@ -1014,6 +1050,8 @@ export declare class Five extends Subscribe<EventTypes> {
     private applyController;
     /** 移除事件绑定 */
     private removeEventListeners;
+    /** 销毁GPU Picking 所用的材质 */
+    private diposeGPUPickingMaterial;
 }
 
 /** Five 初始化参数 */
@@ -1178,6 +1216,10 @@ export declare interface FiveInitArgs {
      * 是否使用webgl2渲染执行环境, 默认值 false
      */
     webgl2?: boolean;
+    /**
+     * 是否开启模型裁切
+     */
+    localClippingEnabled?: boolean;
     /**
      * 请求代理
      * @param url - 发起的请求
@@ -1290,7 +1332,7 @@ export declare interface ImageURLOptions {
 }
 
 export declare class InternalWebGLRenderer extends THREE_2.WebGLRenderer {
-    constructor({ preserveDrawingBuffer, backgroundColor, backgroundAlpha, pixelRatio, antialias, webgl2 }: {
+    constructor({ preserveDrawingBuffer, backgroundColor, backgroundAlpha, pixelRatio, antialias, webgl2, }: {
         preserveDrawingBuffer?: boolean;
         backgroundColor?: number | THREE_2.Color;
         backgroundAlpha?: number;
@@ -1616,7 +1658,7 @@ export declare type ModelEventType = {
      * 模型 bvh树 计算完成
      * @description
      * bvh 树用于高效的碰撞检测，可以在 `model.bvh` 属性来设置是否开启。默认开启。
-     * bvh 树计算需要一定事件，可能会暂时影响一些性能。计算完毕后，会对碰撞检测带来质的提升。
+     * bvh 树计算需要一定时间，可能会暂时影响一些性能。计算完毕后，会对碰撞检测带来质的提升。
      */
     bvhLoaded(): void;
     /** 模型三角面片结构加载完成 */
@@ -1689,6 +1731,22 @@ export declare type NetWorkMeta = {
     size?: number;
 };
 
+export declare interface NetworkOptions {
+    /** 超时时间 */
+    timeout?: number;
+    /** 请求代理 */
+    requestProxy?: (url: string) => string | Promise<string>;
+    /** 网络消息追踪 */
+    networkSubscribe?: NetworkSubscribe;
+    /** 安全域名 */
+    allowHosts?: string[];
+}
+
+export declare type NetworkResponse<T = any, E extends NetWorkMeta | NetWorkMeta[] = NetWorkMeta> = {
+    body: T;
+    meta: E;
+};
+
 export declare type NetworkState = "ok" | "preload" | "error" | "proxy-error" | "timeout" | "forbidden";
 
 export declare class NetworkSubscribe extends Subscribe<{
@@ -1920,14 +1978,22 @@ export declare class PBMMaterial extends THREE_2.ShaderMaterial implements PBMPa
     progress: number;
     /** 全景图通过过度黑色混合 */
     useBlackTransition: boolean;
-    /** XR模式防止申请纹理显存时的黑色过渡 */
-    useXRBlackTransition: boolean;
     perspToOrtho: number;
     /** 模型透明度 */
     opacity: number;
     originOpacity: number;
+    /** 楼层参数*/
+    floorIndex: number;
     /** 楼层切割参数*/
     floorInfo: THREE_2.Vector3 | null;
+    /** 对外模型裁切参数*/
+    clippers: ClipperParameter | ClipperParameter[] | null;
+    /** 对内模型裁切参数 裁切平面*/
+    clipperPlanesArray: Float32Array | null;
+    /** 对内模型裁切参数 裁切盒关联楼层*/
+    clipperFloors: number[] | null;
+    /** 模型颜色*/
+    modelColorInfo: THREE_2.Vector3 | null;
     constructor(parameters?: Partial<PBMParameters>);
 }
 
@@ -1941,9 +2007,9 @@ export declare class PBMMesh extends THREE_2.Mesh<THREE_2.BufferGeometry, PBMMat
 
 export declare interface PBMPanoPicture {
     /** 起始点位全景图 */
-    map: THREE_2.CubeTexture;
+    map: THREE_2.CubeTexture | TileCubeTextureTarget;
     /** 亮度增益 */
-    luminanceMap: THREE_2.CubeTexture | null;
+    luminanceMap: null | THREE_2.CubeTexture | TileCubeTextureTarget;
     /** 起始点全景图变换矩阵 4x4 */
     matrix: THREE_2.Matrix4;
 }
@@ -1960,13 +2026,21 @@ export declare interface PBMParameters {
     progress: number;
     /** 全景图通过过度黑色混合 */
     useBlackTransition: boolean;
-    /** XR模式防止申请纹理显存时的黑色过渡 */
-    useXRBlackTransition: boolean;
     perspToOrtho: number;
     /** 模型透明度 */
     opacity: number;
+    /** 楼层参数*/
+    floorIndex: number;
     /** 楼层切割参数*/
     floorInfo?: THREE_2.Vector3 | null;
+    /** 模型裁切参数（工程侧调用）*/
+    clippers?: ClipperParameter | ClipperParameter[] | null;
+    /** 模型裁切平面参数（内部调用） */
+    clipperPlanesArray?: Float32Array | null;
+    /** 模型裁切平面参数（内部调用） */
+    clipperFloors?: number[] | null;
+    /** 模型颜色*/
+    modelColorInfo?: THREE_2.Vector3 | null;
 }
 
 /**
@@ -2106,6 +2180,59 @@ export declare namespace SubscribeMixinType {
     }
 }
 
+export declare class TextureLoader {
+    private timeout?;
+    private allowHosts?;
+    private requestProxy?;
+    private networkSubscribe?;
+    constructor(options: NetworkOptions);
+    setAllowHosts(allowHosts: string[]): void;
+    setRequestProxy(requestProxy: (url: string) => string): void;
+    setNetworkSubscribe(networkSubscribe: NetworkSubscribe): void;
+    loadTexture(source: string, options?: {
+        imageURL?: {
+            transform?: (source: string, options: ImageURLOptions) => string;
+            options?: ImageURLOptions;
+        };
+        flipY?: boolean;
+        format?: THREE_2.PixelFormat;
+        minFilter?: THREE_2.TextureFilter;
+        magFilter?: THREE_2.TextureFilter;
+        wrapS?: THREE_2.Wrapping;
+        wrapT?: THREE_2.Wrapping;
+        maxSize?: THREE_2.Vector2;
+        preInit?: boolean;
+        viaAjax?: boolean;
+    }, onLoad?: (response: NetworkResponse<THREE_2.Texture>) => void, onError?: (error: Error) => void, onProgress?: (percent: number) => void, renderer?: THREE_2.WebGLRenderer): Promise<NetworkResponse<THREE_2.Texture>>;
+    loadCubeTexture(sources: WorkCubeImage, options: {
+        imageURL?: {
+            transform?: (source: string, options: ImageURLOptions) => string;
+            options?: ImageURLOptions;
+        };
+        format?: THREE_2.PixelFormat;
+        minFilter?: THREE_2.TextureFilter;
+        magFilter?: THREE_2.TextureFilter;
+        wrapS?: THREE_2.Wrapping;
+        wrapT?: THREE_2.Wrapping;
+        preInit?: boolean;
+        viaAjax?: boolean;
+    }, onLoad: (response: NetworkResponse<THREE_2.CubeTexture, NetWorkMeta[]>) => void, onError: (error: Error) => void, onProgress: (percent: number) => void, renderer: THREE_2.WebGLRenderer): Promise<NetworkResponse<THREE_2.CubeTexture, NetWorkMeta[]>>;
+    loadTiledCubeTexture(sources: WorkCubeImage, tileSources: WorkTile[], options: {
+        tileImageSize?: number;
+        tileMaxLevel?: number;
+        imageURL?: {
+            transform?: (source: string, options: ImageURLOptions) => string;
+            options?: ImageURLOptions;
+        };
+        format?: THREE_2.PixelFormat;
+        minFilter?: THREE_2.TextureFilter;
+        magFilter?: THREE_2.TextureFilter;
+        wrapS?: THREE_2.Wrapping;
+        wrapT?: THREE_2.Wrapping;
+        viaAjax?: boolean;
+    }, onLoad: (response: NetworkResponse<TileCubeTextureTarget, NetWorkMeta[]>) => void, onError: (error: Error) => void, onProgress: (percent: number) => void, renderer: THREE_2.WebGLRenderer): Promise<NetworkResponse<TileCubeTextureTarget, NetWorkMeta[]>>;
+}
+
 /**
  * 图片参数
  */
@@ -2273,7 +2400,7 @@ export declare class TileBoundingSphere {
     transform(transform: Matrix4): this;
     distanceSquaredTo(point: number[]): number;
     distanceTo(point: number[]): number;
-    intersectPlane(plane: TilePlane): number;
+    intersectPlane(plane: TilePlane): 0 | 1 | -1;
 }
 
 export declare interface TileBoundingVolume {
@@ -2330,6 +2457,55 @@ export declare interface TileContent {
     rtcCenter?: Float32Array;
 }
 
+export declare interface TileCubeNode {
+    level: number;
+    face: "up" | "down" | "left" | "right" | "front" | "back";
+    position: THREE_2.Vector2;
+    size: number;
+    box: THREE_2.Box3;
+    children: TileCubeNode[];
+}
+
+export declare class TileCubeTextureTarget {
+    private tileTree;
+    private tileSources;
+    private options;
+    private renderer;
+    name: string;
+    needsRender: boolean;
+    private disposed;
+    private loadedCubeNodes;
+    private loadingCubeNodes;
+    private baseCubeTexture;
+    private _cubeRenderTarget;
+    private textures;
+    constructor(baseCubeTexture: THREE_2.CubeTexture, tileTree: TileCubeTree, tileSources: WorkTile[], options: {
+        textureSize: number;
+        tileImageSize: number;
+        textureLoader: TextureLoader;
+        imageURL?: {
+            transform?: (source: string, options: ImageURLOptions) => string;
+            options?: ImageURLOptions;
+        };
+        format?: THREE_2.PixelFormat;
+        minFilter?: THREE_2.TextureFilter;
+        magFilter?: THREE_2.TextureFilter;
+        wrapS?: THREE_2.Wrapping;
+        wrapT?: THREE_2.Wrapping;
+    }, renderer: THREE_2.WebGLRenderer);
+    get cubeRenderTarget(): THREE_2.WebGLCubeRenderTarget | null;
+    set cubeRenderTarget(cubeRenderTarget: THREE_2.WebGLCubeRenderTarget | null);
+    private requestTile;
+    update(frustum: THREE_2.Frustum, level: number): void;
+    get tilePending(): number;
+    get texture(): THREE_2.Texture;
+    dispose(): void;
+}
+
+export declare interface TileCubeTree {
+    children: TileCubeNode[];
+}
+
 export declare class TileCullingVolume {
     static get MASK_OUTSIDE(): number;
     static get MASK_INSIDE(): number;
@@ -2365,7 +2541,7 @@ export declare class TileOrientedBoundingBox {
     clone(): TileOrientedBoundingBox;
     equals(right: TileOrientedBoundingBox): boolean;
     getBoundingSphere(result?: TileBoundingSphere): TileBoundingSphere;
-    intersectPlane(plane: TilePlane): number;
+    intersectPlane(plane: TilePlane): 0 | 1 | -1;
     distanceTo(point: number[]): number;
     distanceSquaredTo(point: number[]): number;
     computePlaneDistances(position: Vector3, direction: Vector3, result?: number[]): number[];