@realsee/five 5.0.0-alpha.100

package/server/index.d.ts

@@ -0,0 +1,568 @@
+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
+ * 可以通过 `five.model.on(METHOD_NAME, METHOD)` 调用
+ */
+declare interface EventCallback extends EventType {
+}
+export { EventCallback }
+export { EventCallback as ModelEventCallback }
+
+/**
+ * 模型事件列表
+ * @description
+ * 具体事件列表 请查看 {@link ModelEventCallback}
+ */
+declare type EventType = {
+    /**
+     * 模型 bvh树 计算完成
+     * @description
+     * bvh 树用于高效的碰撞检测，可以在 `model.bvh` 属性来设置是否开启。默认开启。
+     * bvh 树计算需要一定事件，可能会暂时影响一些性能。计算完毕后，会对碰撞检测带来质的提升。
+     */
+    bvhLoaded(): void;
+    /** 模型三角面片结构加载完成 */
+    geometryLoaded(): void;
+    /** 模型材质结构加载完成 */
+    materialLoaded(): void;
+    /** 模型加载完成 */
+    loaded(): void;
+    /**
+     * 内部错误
+     * @param error - 错误对象
+     */
+    error(error: Error): void;
+};
+export { EventType }
+export { EventType as ModelEventType }
+
+export declare interface Intersection {
+    /** 焦点坐标 */
+    point: THREE_2.Vector3;
+    /** 焦点面片 */
+    face?: {
+        normal: THREE_2.Vector3;
+    } | null;
+    /** 焦点距离 */
+    distance: number;
+}
+
+export declare type LooseWork = {
+    bvh?: boolean;
+    modelAsync?: boolean;
+    initial?: LooseWorkInitial;
+    base_url?: string;
+    model?: LooseWorkModel;
+    panorama: {
+        base_url?: string;
+        pano_high_cube_base_url?: string;
+        info?: LooseWorkPanorama[];
+        list?: LooseWorkPanorama[];
+    };
+    observers: LooseWorkObserver[];
+};
+
+export declare type LooseWorkInitial = {
+    pano_index?: number;
+    pano?: number;
+    longitude?: number;
+    latitude?: number;
+    heading?: number;
+};
+
+export declare type LooseWorkModel = {
+    file_url: string;
+    material_textures?: string[];
+    material_base_url?: string;
+};
+
+export declare type LooseWorkObserver = {
+    active?: boolean;
+    index?: number;
+    visible_nodes: number[];
+    accessible_nodes: number[];
+    quaternion: {
+        y: number;
+        x: number;
+        z: number;
+        w: number;
+    };
+    standing_position: number[];
+    position: number[];
+    floor?: number;
+    floor_index?: number;
+};
+
+export declare type LooseWorkPanorama = {
+    active?: boolean;
+    loadable?: boolean;
+    index?: number;
+    up: string;
+    down: string;
+    right: string;
+    left: string;
+    front: string;
+    back: string;
+    video?: LooseWorkVideo;
+    luminance?: {
+        up: string;
+        down: string;
+        right: string;
+        left: string;
+        front: string;
+        back: string;
+    };
+    tiles?: number[];
+};
+
+export declare type LooseWorkVideo = {
+    source: string;
+    matrix: number[];
+    size: number[];
+};
+
+/**
+ * Five 的显示模式，可以通过 `five.changeMode` `five.setState` 来切换
+ * - **Panorama**: 全景图游走模式
+ * - **Model**: 模型游走模式
+ * - **Floorplan**: 模型查看模式
+ * - **Topview**: 户型图模式
+ * - **DepthPanorama**: 深度图游走模式
+ * - **VRPanorama**: VR眼镜模式
+ */
+export declare type Mode = 
+/** 模型查看模式 */
+"Floorplan" | 
+/** 户型图模式 */
+"Topview" | 
+/** 全景图游走模式 */
+"Panorama" | 
+/** VR眼镜模式 */
+"VRPanorama" | 
+/** 模型游走模式 */
+"Model" | 
+/** 深度图游走模式 */
+"DepthPanorama";
+
+/**
+ * Five 模型
+ * @description
+ * 通过 work 数据加载, 适配 at3d、pbm、dome、domez 格式的文件
+ * 可以通过 jsonp 解析 base64 的 dataURL 内容，
+ * 需要满足 your/path/filename.at3d.json_xxxxxx,
+ * 通过 json_xxxxxx(<dataURL>) 方式返回。
+ */
+export declare class Model extends PBMGroup implements Subscribe<EventType> {
+    /** 是否加载完成 */
+    loaded: boolean;
+    /** 是否未加载 */
+    empty: boolean;
+    /** 外接盒子的大小 */
+    bounding: THREE_2.Box3;
+    /** 当前显示的楼层 */
+    shownfloor: number | null;
+    /**
+     * 判断是否注册了事件
+     * 具体可查看 {@link Subscribe.hasListener}
+     */
+    hasListener: SubscribeMixinType.hasListener<EventType>;
+    /**
+     * 注册事件
+     * 具体可查看 {@link Subscribe.on}
+     */
+    on: SubscribeMixinType.on<EventType>;
+    /**
+     * 注册事件(是否只执行一次)
+     * 具体可查看 {@link Subscribe.once}
+     */
+    once: SubscribeMixinType.once<EventType>;
+    /**
+     * 解除事件
+     * 具体可查看 {@link Subscribe.off}
+     */
+    off: SubscribeMixinType.off<EventType>;
+    /**
+     * 触发事件
+     * 具体可查看 {@link Subscribe.emit}
+     */
+    emit: SubscribeMixinType.emit<EventType>;
+    /** bvh 树的计算结果 */
+    bvhs: BVH[] & {
+        loaded?: boolean;
+    };
+    constructor();
+    /**
+     * 获取模型边界线
+     * @param threshold - 面片间夹角阈值
+     * @returns 所有模型边界线
+     */
+    getEdges(threshold?: number): THREE_2.Line3[];
+    /** 获取当前楼层数 */
+    hasFloors(): number;
+    /**
+     * 显示某楼层
+     * @example
+     * ```
+     * model.show() //显示全部楼层
+     * model.show(1) //显示第一楼层
+     * model.show(1, 0) //显示第一楼层, 并且其他楼层透明度为 0
+     * ```
+     */
+    show(): void;
+    show(floorIndex: number, hideOpacity?: number): void;
+    /**
+     * 计算模型射线碰撞检测
+     * @param raycaster - THREE 射线对象
+     * @param floors - 和某一楼层做碰撞检测， 不传为和所有楼层做碰撞检测
+     * @returns 返回碰撞
+     */
+    intersectRaycaster(raycaster: THREE_2.Raycaster, floors?: number | number[]): Intersection[];
+    buildBVH(): void;
+    /**
+     * 加载模型
+     * @param workModel - work 的 model 内容
+     * @param imageOptions - 图片参数
+     */
+    load(workModel: WorkModel): Promise<void>;
+    /**
+     * 析构函数
+     * @description
+     * 一旦析构，则不能使用
+     */
+    dispose(): void;
+}
+
+/**
+ * 解析 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 PBMGroup extends THREE_2.Group {
+    /** 楼层序号 */
+    floorIndex: number;
+    /** 是否需要更新按需渲染 */
+    needsRender: boolean;
+    /** 析构模型网格 */
+    disposeGeometry(): void;
+}
+
+/** PBM 对象 */
+export declare class PBMMesh extends THREE_2.Mesh<THREE_2.BufferGeometry> {
+    /** 楼层序号 */
+    floorIndex: number;
+    /** 是否需要更新按需渲染 */
+    needsRender: boolean;
+}
+
+/**
+ * 相机位姿
+ * [[include: coordinate.md]]
+ */
+export declare interface Pose {
+    /** 相机俯仰角 */
+    longitude: number;
+    /** 相机偏航角 */
+    latitude: number;
+    /** 相机可视角度（垂直）*/
+    fov: number;
+    /** 相机位置*/
+    offset: THREE_2.Vector3;
+}
+
+/**
+ * 状态
+ * @description
+ * ```text
+ * 可以通过 five.state 和 five.setState 来获取和设置。
+ * 通过 state 设置后，five 会通过合适的动画运动来达到设置的位置。
+ * 来迎合一些通过数据驱动的场景。
+ * ```
+ */
+export declare interface State extends Pose {
+    /** 模态 */
+    mode: Mode;
+    /** 观察点序号 */
+    panoIndex: number;
+}
+
+/**
+ * 监听者模式
+ * @template T - 预设的监听回调类型
+ * @example
+ * ```
+ * new Subscribe<{
+ * "foo": [arg1: number, arg2: string],
+ * "bar": [arg: boolean],
+ * }>()
+ * ```
+ */
+export declare class Subscribe<T extends SubscribeEventMap> {
+    /**
+     * 判断是否注册了事件
+     * @param name - 事件类型
+     */
+    hasListener(name: keyof T): boolean;
+    /**
+     * 注册事件
+     * @param name - 事件类型
+     * @param callback - 事件回调函数
+     * @param once - 是否只执行一次
+     * @returns 解除事件
+     * @template K - 预设的监听事件名称
+     * @template C - 回调函数函数上下文
+     */
+    on<K extends keyof T>(name: K, callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>, once?: boolean): () => void;
+    /**
+     * 注册事件(是否只执行一次)
+     * @param name - 事件类型
+     * @param callback - 事件回调函数
+     * @returns 解除事件
+     * @template K - 预设的监听事件名称
+     * @template C - 回调函数函数上下文
+     */
+    once<K extends keyof T>(name: K, callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>): () => void;
+    /**
+     * 解除事件
+     *
+     * 如果 name 不传的话解除对应所有事件
+     * 如果 name, callback 不传的话解除所有name的所有事件
+     * @param name - 事件类型
+     * @param callback - 事件回调函数
+     * @template K - 预设的监听事件名称
+     */
+    off<K extends keyof T>(name?: K, callback?: (...args: Parameters<T[K]>) => ReturnType<T[K]>): void;
+    /**
+     * 触发事件
+     * @param name - 事件类型
+     * @param data - 触发事件的数据
+     * @returns canceled 是否被触发取消
+     * @template K - 预设的监听事件名称
+     */
+    emit<K extends keyof T>(name: K, ...data: Parameters<T[K]>): boolean;
+}
+
+export declare type SubscribeEventMap = {
+    [name: string]: (...args: any[]) => void | boolean;
+};
+
+export declare namespace SubscribeMixinType {
+    export interface hasListener<T extends SubscribeEventMap> {
+        (name: keyof T): boolean;
+    }
+    export interface on<T extends SubscribeEventMap> {
+        <K extends keyof T>(name: K, callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>, once?: boolean): () => void;
+    }
+    export interface once<T extends SubscribeEventMap> {
+        <K extends keyof T>(name: K, callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>): () => void;
+    }
+    export interface off<T extends SubscribeEventMap> {
+        <K extends keyof T>(names?: K | K[], callback?: (...args: any[]) => any): void;
+    }
+    export interface emit<T extends SubscribeEventMap> {
+        <K extends keyof T>(name: K, ...data: Parameters<T[K]>): boolean;
+    }
+}
+
+export declare class Work {
+    /** 名称 */
+    name: string;
+    /** 编号 */
+    workCode: string;
+    /** 允许访问的安全域名 */
+    allowHosts: string[];
+    /** 过期时间 */
+    expire: Date;
+    /** 初始化参数 */
+    initial: WorkInitial;
+    /** 模型参数 */
+    model?: WorkModel;
+    /** 全景点位信息 */
+    observers: WorkObserver[];
+    /** 数据签发人 */
+    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 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;
+    /** 光照强度图 */
+    luminance?: WorkCubeImage;
+    /** 瓦片信息 */
+    tiles?: WorkTile[];
+}
+
+/** 初始化位姿参数 */
+export declare interface WorkInitial extends Omit<State, "offset"> {
+}
+
+/** 模型数据 */
+export declare interface WorkModel {
+    /** 模型文件地址 at3d / domez */
+    file: string;
+    /** 模型贴图文件地址 */
+    textures: string[];
+    /** 模型贴图文件地址的父目录 */
+    textureBase: string;
+    /** 是否开启 bvh 碰撞树，开启会大大加快射线碰撞的执行效率 */
+    bvh: boolean;
+}
+
+/** 每个点位的数据 */
+export declare interface WorkObserver {
+    /** 点位序号 */
+    panoIndex: number;
+    /** 点位是否激活可用 */
+    active: boolean;
+    /** 点位是否可加载 */
+    loadable: boolean;
+    /** 点位全景图 */
+    images: WorkImage;
+    /** 点位视频 */
+    video?: WorkVideo;
+    /** 可以看到的相关点位序号 */
+    visibleNodes: number[];
+    /** 可以连通的相关点位序号 */
+    accessibleNodes: number[];
+    /** 点位和模型的旋转对齐关系四元数 */
+    quaternion: THREE_2.Quaternion;
+    /** 点位和模型的地面位置坐标关系 */
+    standingPosition: THREE_2.Vector3;
+    /** 点位和模型的观察点坐标关系 */
+    position: THREE_2.Vector3;
+    /** 点位所在楼层 */
+    floorIndex: number;
+}
+
+export declare interface WorkTile {
+    level: number;
+    size: number;
+    up: string;
+    down: string;
+    right: string;
+    left: string;
+    front: string;
+    back: string;
+}
+
+/** 全景视频贴片 */
+export declare interface WorkVideo {
+    /** 视频源 url */
+    source: string;
+    /** 视频源变化矩阵 */
+    matrix: THREE_2.Matrix4;
+    /** 视频源长宽尺寸 */
+    size: THREE_2.Vector2;
+}
+
+export { }