@realsee/five 5.0.0-alpha.20 → 5.0.0-alpha.200

package/server/index.d.ts

@@ -1,5 +1,67 @@
 import * as THREE_2 from 'three';
 
+export declare class BVH {
+    private trianglesArray;
+    private offsetArray;
+    private maxTrianglesPerNode;
+    private bboxArray;
+    private rootNode;
+    private nodesToSplit;
+    constructor(trianglesArray: Float32Array, maxTrianglesPerNode: number);
+    private splitNode;
+    /**
+     * 计算射线与三角形的碰撞
+     * @param rayOrigin - 射线的原点坐标
+     * @param rayDirection - 设想的方向向量
+     * @param backfaceCulling - 是否背面剔除
+     * @return 碰撞焦点数组
+     */
+    intersectRay(rayOrigin: BVHVector3, rayDirection: BVHVector3, backfaceCulling: boolean): BVHIntersect[];
+    dispose(): void;
+}
+
+export declare class BVHIntersect {
+    triangle: [BVHVector3, BVHVector3, BVHVector3];
+    triangleIndex: number;
+    intersectionPoint: BVHVector3;
+    constructor(triangle: [BVHVector3, BVHVector3, BVHVector3], triangleIndex: number, intersectionPoint: BVHVector3);
+}
+
+/**
+ * A node in the BVH structure
+ * @param extents - the min coords of this node's bounding box
+ * @param startIndex - an index in the bbox array, where the first element of this node is located
+ * @param endIndex - an index in the bbox array, where the last of this node is located, plus 1 (meaning that its non-inclusive).
+ * @param level - distance of this node from the root for the bvh tree. root node has level=0, its children have level=1 etc.
+ */
+export declare class BVHNode {
+    extents: ArrayLike<number>;
+    startIndex: number;
+    endIndex: number;
+    level: number;
+    node0: BVHNode | null;
+    node1: BVHNode | null;
+    constructor(extents: ArrayLike<number>, startIndex: number, endIndex: number, level: number);
+    clearShapes(): void;
+}
+
+export declare class BVHVector3 {
+    x: number;
+    y: number;
+    z: number;
+    constructor(x: number, y: number, z: number);
+    copy(v: BVHVector3): this;
+    set(x: number, y: number, z: number): this;
+    fromArray(array: number[], firstElementPos?: number): this;
+    add(v: BVHVector3): this;
+    multiplyScalar(scalar: number): this;
+    subVectors(a: BVHVector3, b: BVHVector3): this;
+    dot(v: BVHVector3): number;
+    cross(v: BVHVector3): this;
+    crossVectors(a: BVHVector3, b: BVHVector3): this;
+    clone(): BVHVector3;
+}
+
 /**
  * Five 模型事件列表
  * @description
@@ -106,7 +168,15 @@ export declare type LooseWorkPanorama = {
     front: string;
     back: string;
     video?: LooseWorkVideo;
-    tiles?: string;
+    luminance?: {
+        up: string;
+        down: string;
+        right: string;
+        left: string;
+        front: string;
+        back: string;
+    };
+    tiles?: number[];
 };
 
 export declare type LooseWorkVideo = {
@@ -121,6 +191,7 @@ export declare type LooseWorkVideo = {
  * - **Model**: 模型游走模式
  * - **Floorplan**: 模型查看模式
  * - **Topview**: 户型图模式
+ * - **Mapview**: 地图模式
  * - **DepthPanorama**: 深度图游走模式
  * - **VRPanorama**: VR眼镜模式
  */
@@ -129,6 +200,8 @@ export declare type Mode =
 "Floorplan" | 
 /** 户型图模式 */
 "Topview" | 
+/** 地图模式 */
+"Mapview" | 
 /** 全景图游走模式 */
 "Panorama" | 
 /** VR眼镜模式 */
@@ -136,7 +209,9 @@ export declare type Mode =
 /** 模型游走模式 */
 "Model" | 
 /** 深度图游走模式 */
-"DepthPanorama";
+"DepthPanorama" | 
+/** XR眼镜模式*/
+"XRPanorama";
 
 /**
  * Five 模型
@@ -155,6 +230,12 @@ export declare class Model extends PBMGroup implements Subscribe<EventType> {
     bounding: THREE_2.Box3;
     /** 当前显示的楼层 */
     shownfloor: number | null;
+    /** 楼层的数量 */
+    floorLength: number;
+    /** 模型瓦片 */
+    originModel?: PBMContainer;
+    /** 模型瓦片 */
+    tiledModel: undefined;
     /**
      * 判断是否注册了事件
      * 具体可查看 {@link Subscribe.hasListener}
@@ -181,7 +262,7 @@ export declare class Model extends PBMGroup implements Subscribe<EventType> {
      */
     emit: SubscribeMixinType.emit<EventType>;
     /** bvh 树的计算结果 */
-    bvhs: any[] & {
+    bvhs: BVH[] & {
         loaded?: boolean;
     };
     constructor();
@@ -191,8 +272,13 @@ export declare class Model extends PBMGroup implements Subscribe<EventType> {
      * @returns 所有模型边界线
      */
     getEdges(threshold?: number): THREE_2.Line3[];
-    /** 获取当前楼层数 */
+    /**
+     * 获取当前楼层数
+     * @deprecated
+     * 请使用 floorLength 参数代替
+     */
     hasFloors(): number;
+    private hasFloors_;
     /**
      * 显示某楼层
      * @example
@@ -211,13 +297,13 @@ export declare class Model extends PBMGroup implements Subscribe<EventType> {
      * @returns 返回碰撞
      */
     intersectRaycaster(raycaster: THREE_2.Raycaster, floors?: number | number[]): Intersection[];
-    buildBVH(): Promise<void>;
+    buildBVH(): void;
     /**
      * 加载模型
      * @param workModel - work 的 model 内容
      * @param imageOptions - 图片参数
      */
-    load(workModel: WorkModel): void;
+    load(workModel: WorkModel): Promise<void>;
     /**
      * 析构函数
      * @description
@@ -226,7 +312,33 @@ export declare class Model extends PBMGroup implements Subscribe<EventType> {
     dispose(): void;
 }
 
-export declare function parseWork(obj: Work | LooseWork | any): Work;
+/**
+ * 解析 Work 数据
+ * @param obj - work 数据，从如数开发者平台获取
+ * @param options - 配置参数， 可以在此二次设置 baseURL 等参数
+ * @param urlTransform - 配置参数， URL 解析规则
+ * @returns - 签署过的 Work 数据结构
+ */
+export declare function parseWork(obj: Work | LooseWork | string | any, options?: ParseWorkOptions, urlTransform?: (origin: string, absolute: string, relative: string, type: "panorama" | "texture" | "model") => void): Work;
+
+export declare type ParseWorkOptions = {
+    /** 重写 work 中的资源前缀 */
+    baseURL?: string;
+    /** work 中的资源地址使用短地址 */
+    shortPath?: boolean;
+    /** work 中的资源使用 jsonp 方式发布 */
+    jsonp?: boolean;
+    /** work 中模型是否计算bvh碰撞数，默认计算 true */
+    modelBvh?: boolean;
+};
+
+/** PBM 模型组 */
+export declare class PBMContainer extends THREE_2.Group {
+    /** 是否需要更新按需渲染 */
+    needsRender: boolean;
+    /** 析构模型网格 */
+    disposeGeometry(): void;
+}
 
 /** PBM 模型组 */
 export declare class PBMGroup extends THREE_2.Group {
@@ -251,14 +363,16 @@ export declare class PBMMesh extends THREE_2.Mesh<THREE_2.BufferGeometry> {
  * [[include: coordinate.md]]
  */
 export declare interface Pose {
-    /** 相机俯仰角 */
-    longitude: number;
     /** 相机偏航角 */
+    longitude: number;
+    /** 相机俯仰角 */
     latitude: number;
     /** 相机可视角度（垂直）*/
     fov: number;
     /** 相机位置*/
     offset: THREE_2.Vector3;
+    /** 相机距离 */
+    distance: number;
 }
 
 /**
@@ -277,8 +391,6 @@ export declare interface State extends Pose {
     panoIndex: number;
 }
 
-export declare function stringifyWork(work: Work): LooseWork;
-
 /**
  * 监听者模式
  * @template T - 预设的监听回调类型
@@ -357,57 +469,140 @@ export declare namespace SubscribeMixinType {
     }
 }
 
-export declare type Work = {
-    uuid: string;
+export declare class Work {
+    /** 名称 */
+    name: string;
+    /** 编号 */
+    workCode: string;
+    /** 允许访问的安全域名 */
+    allowHosts: string[];
+    /** 过期时间 */
+    expire: Date;
+    /** 初始化参数 */
     initial: WorkInitial;
+    /** 模型参数 */
     model?: WorkModel;
+    /** 全景点位信息 */
     observers: WorkObserver[];
-};
+    /** 包围盒子 */
+    boundingBox: THREE_2.Box3;
+    /** 数据签发人 */
+    issuer: string;
+    /** 原始数据 */
+    raw: {
+        works: string[];
+        options: string;
+    };
+    /**
+     * 解析 Work 数据
+     * @param obj - work 数据，从如数开发者平台获取
+     * @param options - 配置参数， 可以在此二次设置 baseURL 等参数
+     * @param urlTransform - 配置参数， URL 解析规则
+     * @returns - 签署过的 Work 数据结构
+     */
+    static parse: typeof parseWork;
+    constructor();
+    toJSON(): any;
+}
 
-/** 全景图 */
-export declare type WorkImages = {
+export declare interface WorkCubeImage {
+    /** 全景图 up */
     up: string;
+    /** 全景图 down */
     down: string;
+    /** 全景图 right */
     right: string;
+    /** 全景图 left */
     left: string;
+    /** 全景图 front */
     front: string;
+    /** 全景图 back */
     back: string;
+}
+
+/** 全景图 */
+export declare interface WorkImage extends WorkCubeImage {
+    /** 深度图 */
     depth?: string;
-    tiles?: string;
-};
+    /** 光照强度图 */
+    luminance?: WorkCubeImage;
+    /** 瓦片信息 */
+    tiles?: WorkTile[];
+}
 
 /** 初始化位姿参数 */
-export declare type WorkInitial = Omit<State, "offset">;
+export declare interface WorkInitial extends Omit<State, "offset" | "distance"> {
+}
 
 /** 模型数据 */
-export declare type WorkModel = {
+export declare interface WorkModel {
+    /** 模型文件地址 at3d / domez */
     file: string;
+    /** 模型贴图文件地址 */
     textures: string[];
+    /** 模型贴图文件地址的父目录 */
     textureBase: string;
+    /** 是否开启 bvh 碰撞树，开启会大大加快射线碰撞的执行效率 */
     bvh: boolean;
-    async: boolean;
-};
+    tiles?: WorkModelTiles;
+    maxDepth?: number;
+}
+
+/** 模型瓦片 */
+export declare interface WorkModelTiles {
+    tileset_url: string;
+    tileset_url_md5: string;
+    b3md_mappings_url: string;
+    b3md_mappings_url_md5: string;
+}
 
 /** 每个点位的数据 */
-export declare type WorkObserver = {
+export declare interface WorkObserver {
+    /** 点位序号 */
     panoIndex: number;
+    /** 点位是否激活可用 */
     active: boolean;
+    /** 点位是否可加载 */
     loadable: boolean;
-    images: WorkImages;
+    /** 点位全景图 */
+    images: WorkImage;
+    /** 点位视频 */
     video?: WorkVideo;
+    /** 可以看到的相关点位序号 */
     visibleNodes: number[];
+    /** 可以连通的相关点位序号 */
     accessibleNodes: number[];
+    /** 点位和模型的旋转对齐关系四元数 */
     quaternion: THREE_2.Quaternion;
+    /** 点位和模型的地面位置坐标关系 */
     standingPosition: THREE_2.Vector3;
+    /** 点位和模型的观察点坐标关系 */
     position: THREE_2.Vector3;
+    /** 点位所在楼层 */
     floorIndex: number;
-};
+    /** 点位 derived_id */
+    derivedId?: number;
+}
+
+export declare interface WorkTile {
+    level: number;
+    size: number;
+    up: string;
+    down: string;
+    right: string;
+    left: string;
+    front: string;
+    back: string;
+}
 
 /** 全景视频贴片 */
-export declare type WorkVideo = {
+export declare interface WorkVideo {
+    /** 视频源 url */
     source: string;
+    /** 视频源变化矩阵 */
     matrix: THREE_2.Matrix4;
+    /** 视频源长宽尺寸 */
     size: THREE_2.Vector2;
-};
+}
 
 export { }