@vsleem-realsee-viewer/shared 1.1.4 → 2.0.0

package/README.md

@@ -2,7 +2,7 @@
 
 # Coordinate 坐标系类
 
-该类设计适用于建筑信息模型(Bimface)、地理信息系统(GIS)等需要复杂空间关系管理的场景。
+该类设计适用于建筑信息模型(Bim)、地理信息系统(GIS)等需要复杂空间关系管理的场景。
 
 ## 属性说明
 
@@ -63,7 +63,7 @@
 
 # DataSource 数据源类
 
-该类类用于管理 Bimface、GIS、数字孪生的层级结构与空间关系
+该类类用于管理 Bim、GIS、数字孪生的层级结构与空间关系
 
 ## 静态方法说明
 

package/dist/index.d.ts

@@ -35,12 +35,16 @@ export declare class AppError extends Error {
  * 业务错误码枚举（扩展无返回值错误）
  */
 export declare enum AppErrorCode {
-    GEO_POINT_NO_PLANE = 9000,
-    POINT_AND_GIS_NO_MAPPING = 9010,
-    POINT_NO_PLANE = 9011,
-    RELATIVE_MAP_MAPPING_SAME = 9020,
-    RELATIVE_NO_PLANE = 9021,
-    RELATIVE_JSON_ERROR = 9022
+    GeoPointNoPlane = 9000,
+    PointUnmappedGIS = 9010,
+    PointNoXYZ = 9011,
+    PointNoPlane = 9012,
+    RelativePlaneUnmatch = 9020,
+    RelativeNoPlane = 9021,
+    RelativeJsonError = 9022,
+    RequestCodeError = 9030,
+    RequestResultError = 9031,
+    RequestUnknownError = 9032
 }
 
 export declare enum AppObsType {
@@ -301,6 +305,7 @@ export declare class Coordinate {
     get spaceList(): Coordinate[];
     get modelList(): Coordinate[];
     get fullName(): string;
+    setOptions(options?: Partial<Coordinate>): void;
     addChild(child: Partial<Coordinate> | Partial<Coordinate>[]): Promise<void>;
     removeChild(child: Partial<Coordinate> | Partial<Coordinate>[]): Promise<void>;
     updateChild(child: Partial<Coordinate> | Partial<Coordinate>[]): Promise<void>;
@@ -425,7 +430,7 @@ export declare type CoordinateModel = {
 
 export declare enum CoordinateModelType {
     CADModel = 5,//cad图片模型
-    BimfaceModel = 6,//bimface模型
+    BIMModel = 6,//bim模型
     ForgeModel = 7,//forge模型
     ThreeDModel = 8,//3d模型
     SkyMapModel = 9,//天地图模型
@@ -646,6 +651,10 @@ declare type MappingRecord = {
     srcCsId: number;
 };
 
+/**
+ * 点类，表示二维或三维空间中的点
+ * 支持直角坐标系(x,y,z)和地理坐标系(经度,纬度,高度)
+ */
 export declare class Point {
     x: number;
     y: number;
@@ -661,24 +670,87 @@ export declare class Point {
     hasAngle: boolean;
     plane: string;
     constructor(options?: Partial<Point>);
+    /**
+     * 计算两点之间的三维距离
+     * @param p1 点1
+     * @param p2 点2
+     * @returns 距离值
+     */
     static dist(p1: Point, p2: Point): number;
+    /**
+     * 计算两点在XZ平面上的距离
+     * @param p1 点1
+     * @param p2 点2
+     * @returns 距离值
+     */
     static distXZ(p1: Point, p2: Point): number;
+    /**
+     * 计算两点在XY平面上的距离
+     * @param p1 点1
+     * @param p2 点2
+     * @returns 距离值
+     */
     static distXY(p1: Point, p2: Point): number;
+    /**
+     * 角度转弧度
+     * @param degrees 角度值
+     * @returns 弧度值
+     */
     static toRadians(degrees: number): number;
+    /**
+     * 弧度转角度
+     * @param radians 弧度值
+     * @returns 角度值
+     */
     static toDegrees(radians: number): number;
+    /**
+     * 计算三点在XZ平面上的夹角 (以pb为顶点)
+     * @param pa 点A
+     * @param pb 点B (顶点)
+     * @param pc 点C
+     * @returns 夹角角度 (0-180度)
+     */
     static angleXZ(pa: Point, pb: Point, pc: Point): number;
+    /**
+     * 从字符串解析点坐标 ("x,y,z")
+     * @param point 坐标字符串
+     * @returns Point对象
+     */
     static toParse(point?: string): Point | undefined;
+    /**
+     * 将点坐标序列化为字符串 ("x,y,z")
+     * @param point 点对象
+     * @returns 坐标字符串
+     */
     static toStringify(point?: Point): string;
     /**
-     * 点的投射
-     * @param r //映射关系
-     * @param srcCoordinate  源坐标系
+     * 坐标投影转换
+     * @param r 映射关系
+     * @param srcCoordinate 源坐标系
      * @param dstCoordinate 目标坐标系
+     * @returns 转换后的点
+     * @throws AppError 当转换失败时抛出异常
      */
     projection(r: RelativeMap, srcCoordinate?: Coordinate, dstCoordinate?: Coordinate): Point | undefined;
-    project(r: RelativeMap): Point | undefined;
-    projectXZ(r: RelativeMap): Point;
-    projectXY(r: RelativeMap): Point;
+    /**
+     * 基础投影转换
+     * @param r 映射关系
+     * @returns 转换后的点
+     * @throws AppError 当没有坐标或平面无效时抛出异常
+     */
+    private project;
+    /**
+     * XZ平面投影转换
+     * @param r 映射关系
+     * @returns 转换后的点
+     */
+    private projectXZ;
+    /**
+     * XY平面投影转换
+     * @param r 映射关系
+     * @returns 转换后的点
+     */
+    private projectXY;
 }
 
 export declare class Position {