@realsee/five 6.5.4 → 6.6.0-alpha.1

package/five/index.d.ts

@@ -264,6 +264,8 @@ export declare function createDebugBoundingMesh(boundingVolume: BoundingVolume,
 
 export declare function createWorks(workArray: Work[]): Works;
 
+export declare type CubeFace = 'right' | 'left' | 'up' | 'down' | 'front' | 'back';
+
 export declare class CullingVolume {
     static get MASK_OUTSIDE(): number;
     static get MASK_INSIDE(): number;
@@ -649,6 +651,7 @@ export declare class Five extends Subscribe<EventTypes> {
     /** 当前加载的 work 数据 */
     get works(): Works;
     get work(): Work;
+    get observers(): readonly WorkObserver[];
     get models(): Models;
     get model(): Model;
     /**
@@ -715,10 +718,6 @@ export declare class Five extends Subscribe<EventTypes> {
      * 获取显示用的画布（Canvas DOM节点）
      */
     getElement(): HTMLCanvasElement | undefined;
-    /**
-     * 获取观测点
-     */
-    get observers(): WorkResolvedObserver[];
     /**
      * 强制渲染
      * @description
@@ -1142,8 +1141,6 @@ export declare interface GestureEvent extends StateEvent {
 
 export declare type GestureTypes = "pan" | "tap" | "dbltap" | "pinch" | "press" | "mouseWheel" | "mouseMove";
 
-export declare function getFetcher(work: Work): Fetcher;
-
 export declare function getViewportScale(): number;
 
 /**
@@ -1225,7 +1222,7 @@ export declare interface Intersection extends THREE_2.Intersection {
     /** 楼层 */
     floor: number;
     model?: Model;
-    viewLayer?: Tile3DModel;
+    viewLayer?: ViewLayer;
 }
 
 export declare class IntersectMesh extends THREE_2.Object3D implements IntersectMeshInterface {
@@ -1785,6 +1782,7 @@ export declare function loadX3p(url: string, options?: {
 }): Promise<LoadResultType>;
 
 export declare interface LoosePanoWork {
+    name?: string;
     code?: string;
     up: string;
     down: string;
@@ -1795,9 +1793,15 @@ export declare interface LoosePanoWork {
     size: number;
 }
 
-export declare type LooseWork = {
+export declare interface LooseWork {
     work_code?: string;
     code?: string;
+    resource_code?: string;
+    basic_code?: string;
+    vr_code?: string;
+    workCode?: string;
+    project_id?: string;
+    name?: string;
     modelAsync?: boolean;
     initial?: LooseWorkInitial;
     base_url?: string;
@@ -1805,22 +1809,31 @@ export declare type LooseWork = {
     panorama?: {
         base_url?: string;
         pano_high_cube_base_url?: string;
+        pano_cube_base_url?: string;
         info?: LooseWorkPanorama[];
         list?: LooseWorkPanorama[];
     };
     observers?: LooseWorkObserver[];
-};
+}
 
-export declare type LooseWorkInitial = {
+export declare interface LooseWorkInitial {
     mode?: string;
     pano_index?: number;
+    panoIndex?: number;
     pano?: number;
     longitude?: number;
     latitude?: number;
+    fov?: number;
+    distance?: number;
+    offset?: number[] | {
+        x: number;
+        y: number;
+        z: number;
+    };
     heading?: number;
-};
+}
 
-export declare type LooseWorkModel = {
+export declare interface LooseWorkModel {
     file_url?: string;
     material_textures?: string[];
     material_base_url?: string;
@@ -1838,50 +1851,50 @@ export declare type LooseWorkModel = {
         tileset_url: string;
     }
     ];
-};
+}
 
-export declare type LooseWorkObserver = {
+export declare interface LooseWorkObserver {
     active?: boolean;
     index?: number;
-    visible_nodes: number[];
-    accessible_nodes: number[];
-    quaternion: {
+    visible_nodes?: number[];
+    visibleNodes?: number[];
+    accessible_nodes?: number[];
+    accessibleNodes?: number[];
+    quaternion?: {
         y: number;
         x: number;
         z: number;
         w: number;
     };
-    standing_position: number[];
-    position: number[];
+    standing_position?: number[];
+    standingPosition?: number[];
+    position?: number[];
     floor?: number;
     floor_index?: number;
-};
+    floorIndex?: number;
+    derived_id?: number;
+    derived_id_str?: string;
+}
 
-export declare type LooseWorkPanorama = {
+export declare interface LooseWorkPanorama extends Record<CubeFace, string> {
     active?: boolean;
     loadable?: boolean;
     index?: number;
-    up: string;
-    down: string;
-    right: string;
-    left: string;
-    front: string;
-    back: string;
     video?: LooseWorkVideo;
     tiles?: number[];
     size_list?: number[];
-};
+}
 
-export declare type LooseWorkVideo = {
+export declare interface LooseWorkVideo {
     source: string;
     matrix: number[];
     size: number[];
-};
+}
 
-export declare type LooseWorkWithExtrinsics = ParseWorkOptions & {
+export declare interface LooseWorkWithExtrinsics extends ParseOptions {
     /** work 数据 */
     work: LooseWork;
-};
+}
 
 export declare function makeBoundingVolume(header: BoundingVolumeJson | BoundingVolume): BoundingVolume;
 
@@ -2336,8 +2349,6 @@ export declare interface NetworkOptions {
     requestProxy?: (url: string) => string | Promise<string>;
     /** 网络消息追踪 */
     networkSubscribe?: NetworkSubscribe;
-    /** 安全域名 */
-    allowHosts?: string[];
 }
 
 export declare type NetworkProgressCallback = (percent: number) => void;
@@ -2363,7 +2374,7 @@ export declare class NetworkResponseError extends Error {
     constructor(source: string, type: NetworkType, status: number);
 }
 
-export declare type NetworkState = "ok" | "preload" | "error" | "proxy-error" | "timeout" | "forbidden";
+export declare type NetworkState = "ok" | "preload" | "error" | "timeout" | "forbidden";
 
 export declare class NetworkSubscribe extends Subscribe<{
     network(source: string, type: NetworkType, state: NetworkState, detail: string): void;
@@ -2376,7 +2387,7 @@ export declare class NetworkTimeoutError extends Error {
     constructor(source: string, type: NetworkType, timeout: number);
 }
 
-export declare type NetworkType = "XMLHttpRequest" | "Script" | "Image" | "Link";
+export declare type NetworkType = "XMLHttpRequest" | "Image" | "Link";
 
 export declare interface ObjectEvent extends BaseEvent {
     object: THREE_2.Object3D;
@@ -2687,6 +2698,8 @@ declare interface ParameterMaterialValue {
     receiveShadow: boolean;
     /** 半透明叠加渲染*/
     useAddBlend: boolean;
+    /** 包围盒 */
+    boundingBox: THREE_2.Box3;
 }
 export { ParameterMaterialValue as ModelMaterialValues }
 export { ParameterMaterialValue }
@@ -2729,15 +2742,7 @@ declare interface ParameterValue extends ParameterMaterialValue, ParameterTilese
 export { ParameterValue as PBMParameters }
 export { ParameterValue }
 
-/**
- * 解析 Work 数据
- * @param obj - work 数据，从如数开发者平台获取
- * @param options - 配置参数， 可以在此二次设置 baseURL 等参数
- * @returns - 签署过的 Work 数据结构
- */
-export declare function parseWork(obj: Work | LoosePanoWork | LooseWork | string | any, options?: ParseWorkOptions): Work;
-
-export declare type ParseWorkOptions = {
+export declare type ParseOptions = {
     /** 位姿 */
     transform?: THREE_2.Matrix4 | number[];
     /** 重置 WorkCode */
@@ -2748,14 +2753,16 @@ export declare type ParseWorkOptions = {
     shortPath?: boolean;
     /** 资源使用 jsonp 方式发布 */
     jsonp?: boolean;
-    traverseResource?: (resource: {
-        origin: string;
-        absolute: string;
-        relative: string;
-        type: "panorama" | "texture" | "model";
-    }) => void;
 };
 
+/**
+ * 解析 Work 数据
+ * @param obj - work 数据，从如数开发者平台获取
+ * @param options - 配置参数， 可以在此二次设置 baseURL 等参数
+ * @returns - 签署过的 Work 数据结构
+ */
+export declare function parseWork(obj: Work | LoosePanoWork | LooseWork | string | any, options?: ParseOptions): Work;
+
 export declare type PBMAlphaMode = 'OPAQUE' | 'MASK' | 'BLEND';
 
 export declare interface PBMClipperParameter {
@@ -3150,14 +3157,13 @@ export declare type RegionBoundingVolumeJson = {
     region: number[];
 };
 
-export declare function registerFetcher(work: Work, fetcher: Fetcher): Map<Work, Fetcher>;
-
 export declare interface RenderEvent extends BaseEvent {
     needsRender: boolean;
 }
 
 export declare interface ResolvedParameterValue extends ParameterValue {
     versions: string[];
+    version: string;
 }
 
 /** Five 场景*/
@@ -3308,7 +3314,7 @@ export declare class TextureLoader {
         timeout?: number;
         fetcher: Fetcher;
     }, 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: {
+    loadCubeTexture(sources: Record<CubeFace, string>, options: {
         imageURL?: {
             transform?: (source: string, options: ImageURLOptions) => string;
             options?: ImageURLOptions;
@@ -3326,27 +3332,11 @@ export declare class TextureLoader {
 }
 
 /**
- * 图片参数
+ * 材质的图片参数
  */
-export declare interface TextureOptions {
-    /**
-     * url 地址转化
-     * @param url - 原始地址
-     * @param options - 当前地址参数
-     * @returns 转化后地址
-     */
-    transform?: (url: string, options: ImageURLOptions) => string;
-    /** 图片尺寸参数 尽量使用 2 的幂次 如 256 512 1024 */
-    size?: number;
-    /** 图片质量参数(0-100) */
-    quality?: number;
-    /** 图片格式参数 */
-    format?: "jpg" | "png" | "heif" | "webp" | "avif";
+export declare interface TextureOptions extends ImageOptions {
     /** 针对 textureOptions 是否自动通过模型贴图的数量计算需要的模型贴图的尺寸 默认 true */
     autoResize?: boolean;
-    /** 锐化参数 海外不支持 */
-    sharpen?: number;
-    mappings?: ImageURLMappings;
 }
 
 export declare class Tile {
@@ -3461,7 +3451,6 @@ export declare class Tile3DModel extends THREE_2.Object3D {
     loadTrajectory(trajectory: Trajectory): Promise<void>;
     unloadTrajectory(trajectory: Trajectory): Promise<void>;
     intersectRaycaster(raycaster: THREE_2.Raycaster, filterFloorIndex?: undefined | null | number, sortByDistance?: boolean, target?: Intersection[]): Intersection[];
-    private cloneSkipBackfaceObject;
     update(renderer: THREE_2.WebGLRenderer, camera: Camera, modelScene: ModelScene, model: Model): boolean;
     dispose(): void;
     /**
@@ -3958,29 +3947,33 @@ export declare interface WebXRControllerParams {
 
 export declare type WebXRControllerType = 'tap' | 'press' | 'axes' | 'buttonUp' | 'buttonDown';
 
-export declare class Work {
-    /** 名称 */
-    name: string;
-    /** 根地址 */
-    baseURL: string;
+export declare interface Work {
+    /** 数据签发人 */
+    issuer: string;
     /** 编号 */
     workCode: string;
     /** 允许访问的安全域名 */
-    allowHosts: string[];
+    allowHosts: readonly string[];
     /** 过期时间 */
     expire: Date;
+    /** 名称 */
+    name: string;
+    /** 根地址 */
+    baseURL: string;
     /** 初始化参数 */
     initial: WorkInitial;
+    /** 相对位姿 */
+    transform: THREE_2.Matrix4;
     /** 模型参数 */
     model?: WorkModel;
     /** 全景点位信息 */
-    observers: WorkObserver[];
-    /** 全景点位包围盒 */
+    observers: readonly WorkObserver[];
+}
+
+export declare class Work {
+    jsonp: boolean;
+    shortPath: boolean;
     observerBox: THREE_2.Box3;
-    /** 数据签发人 */
-    issuer: string;
-    /** 位姿修正 */
-    transform: THREE_2.Matrix4;
     /**
      * 控制参数
      * @deprecated 通过 work.transform 替换
@@ -3992,10 +3985,12 @@ export declare class Work {
          */
         transform: THREE_2.Matrix4;
     };
-    /** 原始数据 */
+    /**
+     * 原始数据
+     * @deprecated 通过 work.toJSON 替换
+     */
     raw: {
         works: string[];
-        options: string;
     };
     /**
      * 解析 Work 数据
@@ -4004,31 +3999,22 @@ export declare class Work {
      * @returns - 签署过的 Work 数据结构
      */
     static parse: typeof parseWork;
-    constructor(obj: Work | LoosePanoWork | LooseWork | (Work | LooseWork)[] | any, options: ParseWorkOptions);
+    constructor(obj: Work | LoosePanoWork | LooseWork | (Work | LooseWork)[] | any, options: ParseOptions);
+    getURL(source: string): string;
+    verifyURL(source: string): boolean;
     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 WorkCubeImage extends Record<CubeFace, string> {
+    work: Work;
 }
 
 /** 全景图 */
 export declare interface WorkImage extends WorkCubeImage {
     /** 分辨率表 */
-    sizeList?: number[];
+    sizeList: readonly number[];
     /** 瓦片信息 */
-    tiles?: WorkTile[];
+    tiles: readonly WorkTile[];
 }
 
 /** 初始化位姿参数 */
@@ -4050,6 +4036,30 @@ export declare interface WorkInitial {
     distance?: number;
 }
 
+export declare interface WorkInitialJson {
+    mode?: string;
+    pano_index?: number;
+    longitude?: number;
+    latitude?: number;
+    fov?: number;
+    offset?: number[];
+    distance?: number;
+}
+
+export declare interface WorkJson {
+    _signature: string;
+    allow_hosts: string[];
+    expire_at: string;
+    code: string;
+    name?: string;
+    project_id?: string;
+    base_url: string;
+    initial?: WorkInitialJson;
+    model?: WorkModelJson;
+    observers?: WorkObserverJson[];
+    panorama?: WorkPanoramasJson;
+}
+
 /** 模型数据 */
 export declare interface WorkModel {
     /** work */
@@ -4057,20 +4067,35 @@ export declare interface WorkModel {
     /** 模型文件地址 at3d / domez */
     file?: string;
     /** 模型贴图文件地址 */
-    textures?: string[];
+    textures?: readonly string[];
     /** 模型贴图文件地址的父目录 */
     textureBase?: string;
     /** 3d tile */
-    layers: WorkModelLayer[];
+    layers: readonly WorkModelLayer[];
+}
+
+export declare interface WorkModelJson {
+    file_url?: string;
+    material_textures?: string[];
+    material_base_url?: string;
+    layers?: WorkModelLayerJson[];
 }
 
 export declare interface WorkModelLayer {
+    work: Work;
     type: 'point_cloud' | 'mesh';
     name: string;
     upAxis: string;
     tileset: string;
 }
 
+export declare interface WorkModelLayerJson {
+    name?: string;
+    type?: string;
+    up_axis: string;
+    tileset_url: string;
+}
+
 /** 每个点位的数据 */
 export declare interface WorkObserver {
     /** work */
@@ -4079,10 +4104,6 @@ export declare interface WorkObserver {
     index: number;
     /** 序号 */
     panoIndex: number;
-    /** 点位序号 */
-    panoId: PanoId;
-    /** 点位序号 */
-    pano: Pano;
     /** 点位所在楼层 */
     floorIndex: number;
     /** 点位 derived_id */
@@ -4098,13 +4119,9 @@ export declare interface WorkObserver {
     /** 点位视频 */
     video?: WorkVideo;
     /** 可以看到的相关点位序号 */
-    visibleNodes: number[];
-    /** 可以看到的相关点位序号 */
-    visibleIds: PanoId[];
+    visibleNodes: readonly number[];
     /** 可以连通的相关点位序号 */
-    accessibleNodes: number[];
-    /** 可以看到的相关点位序号 */
-    accessibleIds: PanoId[];
+    accessibleNodes: readonly number[];
     /** 点位和模型的地面坐标 */
     standingPosition: THREE_2.Vector3;
     /** 点位和模型的观察点坐标 */
@@ -4113,32 +4130,65 @@ export declare interface WorkObserver {
     quaternion: THREE_2.Quaternion;
     /** 点位和模型的旋转对齐关系矩阵 */
     matrix: THREE_2.Matrix4;
-    /** 点位和模型的地面坐标 */
-    getResolvedStandingPosition(target: THREE_2.Vector3): typeof target;
-    /** 点位和模型的观察点坐标 */
-    getResolvedPosition(target: THREE_2.Vector3): typeof target;
-    /** 点位和模型的旋转对齐关系四元数 */
-    getResolvedQuaternion(target: THREE_2.Quaternion): typeof target;
-    /** 点位和模型的旋转对齐关系矩阵 */
-    getResolvedMatrix(target: THREE_2.Matrix4): typeof target;
 }
 
-export declare const workRawMapping: WeakMap<Work, {
-    works: string[];
-    options: string;
-}>;
+export declare interface WorkObserverJson {
+    index: number;
+    floor_index: number;
+    position: number[];
+    standing_position: number[];
+    quaternion: {
+        x: number;
+        y: number;
+        z: number;
+        w: number;
+    };
+    visible_nodes: number[];
+    accessible_nodes: number[];
+}
 
-export declare interface WorkResolvedObserver extends Omit<WorkObserver, 'getResolvedStandingPosition' | 'getResolvedPosition' | 'getResolvedQuaternion' | 'getResolvedMatrix'> {
+export declare interface WorkPanoramaJson {
+    index: number;
+    active?: boolean;
+    loadable?: boolean;
+    derived_id?: number;
+    derived_id_str?: string;
+    size_list: number[];
+    up: string;
+    down: string;
+    right: string;
+    left: string;
+    front: string;
+    back: string;
+    video?: {
+        source: string;
+        matrix: number[];
+        size: number[];
+    };
+}
+
+export declare interface WorkPanoramasJson {
+    count: number;
+    list: WorkPanoramaJson[];
+}
+
+export declare interface WorkResolvedObserver extends WorkObserver {
     isResolved: true;
+    panoId: PanoId;
+    pano: Pano;
+    accessibleIds: readonly PanoId[];
+    visibleIds: readonly PanoId[];
+}
+
+export declare class WorkResolvedObserver {
+    constructor(observer: WorkObserver);
 }
 
 export declare type Works = ReadonlyArray<Work> & {
-    resolvedObservers: WorkResolvedObserver[];
-    resolvedObserverBox: THREE_2.Box3;
     initial: WorkInitial;
     getWork(workCode: string): Work | undefined;
+    getObserver(pano: PanoId | Pano | number): WorkObserver | undefined;
     getResolvedObserver(pano: PanoId | Pano | number): WorkResolvedObserver | undefined;
-    update(): void;
 };
 
 export declare interface WorksEvent extends BaseEvent {
@@ -4157,8 +4207,11 @@ export declare interface WorkTile extends WorkCubeImage {
     scale: number;
 }
 
+export declare function workToJson(work: Work): WorkJson;
+
 /** 全景视频贴片 */
 export declare interface WorkVideo {
+    work: Work;
     /** 视频源 url */
     source: string;
     /** 视频源变化矩阵 */