@realsee/five 6.6.0-alpha.0 → 6.6.0-alpha.2

package/five/index.d.ts

@@ -260,11 +260,17 @@ export declare const controllersDefaultInitArgs: {
     XRPanorama: Required<XRPanoramaControllerCustomInitArgs>;
 };
 
+/** 坐标转换成单位向量 */
+export declare function coordinatesToVector(coordinates: {
+    longitude: number;
+    latitude: number;
+}, target?: THREE_2.Vector3): THREE_2.Vector3;
+
 export declare function createDebugBoundingMesh(boundingVolume: BoundingVolume, level?: number): THREE_2.LineSegments<THREE_2.BufferGeometry, THREE_2.LineBasicMaterial> | null;
 
 export declare function createWorks(workArray: Work[]): Works;
 
-declare type CubeSource = Record<typeof FACE_ORDER[number], string>;
+export declare type CubeFace = 'right' | 'left' | 'up' | 'down' | 'front' | 'back';
 
 export declare class CullingVolume {
     static get MASK_OUTSIDE(): number;
@@ -378,8 +384,6 @@ export declare type EventTypes = Pick<ControllerEventTypes, typeof PROXY_CONTROL
     "dispose"(): void;
 };
 
-declare const FACE_ORDER: readonly ["right", "left", "up", "down", "front", "back"];
-
 export declare class Fetcher {
     private options;
     constructor(options?: NetworkOptions);
@@ -587,7 +591,7 @@ export declare class Five extends Subscribe<EventTypes> {
     set helperVisible(visible: boolean);
     private getBuiltinRenderer;
     get renderEffect(): 'default' | 'edl' | 'hq' | 'luminance';
-    set renderEffect(value: 'default' | 'edl' | 'hq' | 'luminance');
+    set renderEffect(value: "default" | "edl" | "hq" | "luminance");
     updateConfiguration(args: Pick<FiveInitArgs, "panorama" | "model" | "floorplan" | "topview" | "mapview" | "vrPanorama" | "imageOptions" | "textureOptions">, refresh?: boolean): void;
     /**
      * 将显示区域加载到页面 DOM 中
@@ -1145,6 +1149,16 @@ export declare type GestureTypes = "pan" | "tap" | "dbltap" | "pinch" | "press"
 
 export declare function getViewportScale(): number;
 
+/**
+ * 通过 heading 计算 longitude
+ *
+ *  @deprecated
+ * 不再使用 heading 这种计算方式。
+ *
+ * @param heading - 方向
+ */
+export declare function headingToLongitude(heading: number): number;
+
 /**
  * 图片参数
  */
@@ -1224,7 +1238,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 {
@@ -1783,6 +1797,16 @@ export declare function loadX3p(url: string, options?: {
     fetcher?: Fetcher;
 }): Promise<LoadResultType>;
 
+/**
+ * 通过经度计算 Heading, Heading 是个古老的参数，新的工程中请不要使用了
+ *
+ * @deprecated
+ * 不再使用 heading 这种计算方式。
+ *
+ * @param longitude - 经度
+ */
+export declare function longitudeToHeading(longitude: number): number;
+
 export declare interface LoosePanoWork {
     name?: string;
     code?: string;
@@ -1795,7 +1819,7 @@ export declare interface LoosePanoWork {
     size: number;
 }
 
-export declare type LooseWork = {
+export declare interface LooseWork {
     work_code?: string;
     code?: string;
     resource_code?: string;
@@ -1816,9 +1840,9 @@ export declare type LooseWork = {
         list?: LooseWorkPanorama[];
     };
     observers?: LooseWorkObserver[];
-};
+}
 
-export declare type LooseWorkInitial = {
+export declare interface LooseWorkInitial {
     mode?: string;
     pano_index?: number;
     panoIndex?: number;
@@ -1833,9 +1857,9 @@ export declare type LooseWorkInitial = {
         z: number;
     };
     heading?: number;
-};
+}
 
-export declare type LooseWorkModel = {
+export declare interface LooseWorkModel {
     file_url?: string;
     material_textures?: string[];
     material_base_url?: string;
@@ -1853,9 +1877,9 @@ export declare type LooseWorkModel = {
         tileset_url: string;
     }
     ];
-};
+}
 
-export declare type LooseWorkObserver = {
+export declare interface LooseWorkObserver {
     active?: boolean;
     index?: number;
     visible_nodes?: number[];
@@ -1876,33 +1900,27 @@ export declare type LooseWorkObserver = {
     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 = ParseOptions & {
+export declare interface LooseWorkWithExtrinsics extends ParseOptions {
     /** work 数据 */
     work: LooseWork;
-};
+}
 
 export declare function makeBoundingVolume(header: BoundingVolumeJson | BoundingVolume): BoundingVolume;
 
@@ -3322,7 +3340,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: CubeSource, options: {
+    loadCubeTexture(sources: Record<CubeFace, string>, options: {
         imageURL?: {
             transform?: (source: string, options: ImageURLOptions) => string;
             options?: ImageURLOptions;
@@ -3340,27 +3358,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 {
@@ -3916,6 +3918,12 @@ export declare class TrajectoryNode extends THREE_2.Object3D {
     clone(): this;
 }
 
+/** 单位向量转换成坐标 */
+export declare function vectorToCoordinates(vector: THREE_2.Vector3): {
+    longitude: number;
+    latitude: number;
+};
+
 export declare interface ViewLayer extends Tile3DModel {
 }
 
@@ -4029,20 +4037,8 @@ export declare class Work {
     toJSON(): any;
 }
 
-export declare interface WorkCubeImage {
+export declare interface WorkCubeImage extends Record<CubeFace, string> {
     work: Work;
-    /** 全景图 up */
-    up: string;
-    /** 全景图 down */
-    down: string;
-    /** 全景图 right */
-    right: string;
-    /** 全景图 left */
-    left: string;
-    /** 全景图 front */
-    front: string;
-    /** 全景图 back */
-    back: string;
 }
 
 /** 全景图 */