@vsleem-realsee-viewer/shared 2.0.16 → 2.0.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Coordinate 坐标系类
4
4
 
5
- 该类设计适用于建筑信息模型(Bim)、地理信息系统(GIS)等需要复杂空间关系管理的场景。
5
+ 该类设计适用于建筑信息模型(Bim)、地理信息系统(GIS)等需要复杂空间关系管理的全景。
6
6
 
7
7
  ## 属性说明
8
8
 
@@ -38,28 +38,28 @@
38
38
 
39
39
  ## 方法说明
40
40
 
41
- | 方法 | 类型 | 说明 |
42
- | ---------------------- | ----------------------------------------------------------------------------------- | -------------------------------------------- |
43
- | `constructor` | `(options?: Partial<Coordinate>) => Coordinate` | 初始化坐标系实例,支持部分属性配置 |
44
- | `addChild` | `(child: Partial<Coordinate> \ Partial<Coordinate>[]) => Promise<Coordinate>` | 添加一个或多个子坐标系,并建立映射关系 |
45
- | `removeChild` | `(child: Partial<Coordinate> \ Partial<Coordinate>[]) => Promise<void>` | 移除一个或多个子坐标系 |
46
- | `updateChild` | `(child: Partial<Coordinate> \ Partial<Coordinate>[]) => Promise<Coordinate>` | 更新子坐标系的属性信息 |
47
- | `bindChild` | `(child: Partial<Coordinate> \ Partial<Coordinate>[]) => Promise<Coordinate>` | 绑定子坐标系但不建立映射关系 |
48
- | `mergeChild` | `(result?: Coordinate[]) => Promise<void>` | 合并更新的子坐标系数据到当前树结构 |
49
- | `mappingTo` | `(result: ProjectionModel[]) => Promise<void>` | 将当前坐标系映射到目标坐标系组 |
50
- | `fromMapping` | `() => Promise<ProjectionModel \ undefined>` | 查询当前坐标系被哪些源坐标系映射 |
51
- | `findRoot` | `(mapped?: boolean) => Coordinate` | 递归查找根坐标系,可选是否只查找有映射关系的 |
52
- | `findChildModel` | `(type?: number \ number[], mapped?: boolean) => Coordinate \ undefined` | 查找符合条件的子模型坐标系 |
53
- | `findClosestModel` | `(type?: number \ number[], excludeNodes?: Coordinate[]) => Coordinate \ undefined` | 使用广度优先搜索查找最近的模型坐标系 |
54
- | `findParentSpace` | `() => Coordinate \ undefined` | 向上查找最近的父级空间坐标系 |
55
- | `findParentSpaceNames` | `(level?: number) => string[]` | 获取指定层级数的父空间名称列表 |
56
- | `findCsGroup` | `() => Coordinate[]` | 查找当前坐标系所在的分组 |
57
- | `findCsByLevel` | `(level: number) => Coordinate \ undefined` | 递归查找指定层级的坐标系 |
58
- | `findCsById` | `(id?: number) => Coordinate \ undefined` | 通过ID深度优先搜索查找坐标系 |
59
- | `getCsRoutes` | `(mapped?: boolean) => Coordinate[]` | 获取从当前坐标系到根系的路径数组 |
60
- | `getMappedCsTree` | `() => Coordinate` | 生成只包含有映射关系的坐标系树 |
61
- | `getDestRelativeMap` | `(dstCoordinate: Coordinate) => RelativeMap` | 计算到目标坐标系的相对变换关系 |
62
- | `getRelativeMaps` | `() => RelativeMap[]` | 获取从当前坐标系到根系的相对变换链 |
41
+ | 方法 | 类型 | 说明 |
42
+ | ---------------------- | ------------------------------------------------------------------------------------- | -------------------------------------------- |
43
+ | `constructor` | `(options?: Partial<Coordinate>) => Coordinate` | 初始化坐标系实例,支持部分属性配置 |
44
+ | `addChild` | `(child: Partial<Coordinate> \| Partial<Coordinate>[]) => Promise<Coordinate>` | 添加一个或多个子坐标系,并建立映射关系 |
45
+ | `removeChild` | `(child: Partial<Coordinate> \| Partial<Coordinate>[]) => Promise<void>` | 移除一个或多个子坐标系 |
46
+ | `updateChild` | `(child: Partial<Coordinate> \| Partial<Coordinate>[]) => Promise<Coordinate>` | 更新子坐标系的属性信息 |
47
+ | `bindChild` | `(child: Partial<Coordinate> \| Partial<Coordinate>[]) => Promise<Coordinate>` | 绑定子坐标系但不建立映射关系 |
48
+ | `mergeChild` | `(result?: Coordinate[]) => Promise<void>` | 合并更新的子坐标系数据到当前树结构 |
49
+ | `mappingTo` | `(result: ProjectionModel[]) => Promise<void>` | 将当前坐标系映射到目标坐标系组 |
50
+ | `fromMapping` | `() => Promise<ProjectionModel \| undefined>` | 查询当前坐标系被哪些源坐标系映射 |
51
+ | `findRoot` | `(mapped?: boolean) => Coordinate` | 递归查找根坐标系,可选是否只查找有映射关系的 |
52
+ | `findChildModel` | `(type?: number \| number[], mapped?: boolean) => Coordinate \| undefined` | 查找符合条件的子模型坐标系 |
53
+ | `findClosestModel` | `(type?: number \| number[], excludeNodes?: Coordinate[]) => Coordinate \| undefined` | 使用广度优先搜索查找最近的模型坐标系 |
54
+ | `findParentSpace` | `() => Coordinate \| undefined` | 向上查找最近的父级空间坐标系 |
55
+ | `findParentSpaceNames` | `(level?: number) => string[]` | 获取指定层级数的父空间名称列表 |
56
+ | `findCsGroup` | `() => Coordinate[]` | 查找当前坐标系所在的分组 |
57
+ | `findCsByLevel` | `(level: number) => Coordinate \| undefined` | 递归查找指定层级的坐标系 |
58
+ | `findCsById` | `(id?: number) => Coordinate \| undefined` | 通过ID深度优先搜索查找坐标系 |
59
+ | `getCsRoutes` | `(mapped?: boolean) => Coordinate[]` | 获取从当前坐标系到根系的路径数组 |
60
+ | `getMappedCsTree` | `() => Coordinate` | 生成只包含有映射关系的坐标系树 |
61
+ | `getDestRelativeMap` | `(dstCoordinate: Coordinate) => RelativeMap` | 计算到目标坐标系的相对变换关系 |
62
+ | `getRelativeMaps` | `() => RelativeMap[]` | 获取从当前坐标系到根系的相对变换链 |
63
63
 
64
64
  # DataSource 数据源类
65
65
 
@@ -67,17 +67,19 @@
67
67
 
68
68
  ## 静态方法说明
69
69
 
70
- | 方法 | 类型 | 说明 |
71
- | ---------------------- | -------------------------------------------------------------------------------- | ---------------------------- |
72
- | `getCoordinateTree` | `(projectId: number) => Promise<Coordinate \ undefined>` | 获取项目坐标系树结构 |
73
- | `addCoordinate` | `(parent: Coordinate, children: Partial<Coordinate>[]) => Promise<Coordinate[]>` | 添加子坐标系到指定父节点 |
74
- | `removeCoordinate` | `(parent: Coordinate, children: Partial<Coordinate>[]) => Promise<any>` | 删除指定坐标系 |
75
- | `updateCoordinate` | `(parent: Coordinate, children: Partial<Coordinate>[]) => Promise<Coordinate[]>` | 更新坐标系信息 |
76
- | `bindCoordinate` | `(parent: Coordinate, children: Partial<Coordinate>[]) => Promise<Coordinate[]>` | 绑定坐标系到父节点 |
77
- | `handleCoordinateList` | `(array: CoordinateModel[]) => Coordinate[]` | 转换原始数据为Coordinate对象 |
78
- | `buildCoordinateTree` | `(flatNodes: Coordinate[], rootId: number) => Coordinate` | 将扁平列表转为树形结构 |
79
- | `sortCoordinateTree` | `(node: Coordinate) => void` | 递归排序坐标系树 |
80
- | `filterSpaceTree` | `(tree: Coordinate[]) => Coordinate[]` | 过滤出空间坐标系树 |
70
+ | 方法 | 类型 | 说明 |
71
+ | ----------------------- | -------------------------------------------------------------------------------- | ------------------------------------ |
72
+ | `getCoordinateTree` | `(projectId: number) => Promise<Coordinate \| undefined>` | 获取项目坐标系树结构 |
73
+ | `parsedCoordinateTree` | `(tree: Coordinate) => Coordinate \| undefined` | 解析坐标系树 |
74
+ | `addCoordinate` | `(parent: Coordinate, children: Partial<Coordinate>[]) => Promise<Coordinate[]>` | 添加子坐标系到指定父节点 |
75
+ | `removeCoordinate` | `(parent: Coordinate, children: Partial<Coordinate>[]) => Promise<any>` | 删除指定坐标系 |
76
+ | `updateCoordinate` | `(parent: Coordinate, children: Partial<Coordinate>[]) => Promise<Coordinate[]>` | 更新坐标系信息 |
77
+ | `bindCoordinate` | `(parent: Coordinate, children: Partial<Coordinate>[]) => Promise<Coordinate[]>` | 绑定坐标系到父节点 |
78
+ | `handleCoordinateList` | `(array: CoordinateModel[]) => Coordinate[]` | 转换原始数据为Coordinate对象 |
79
+ | `buildCoordinateTree` | `(flatNodes: Coordinate[], rootId: number) => Coordinate` | 将扁平列表转为树形结构 |
80
+ | `flattenCoordinateTree` | `(tree: Coordinate \| Coordinate[]) => Coordinate[]` | 将树形结构的节点扁平化为一个一维数组 |
81
+ | `sortCoordinateTree` | `(node: Coordinate) => void` | 递归排序坐标系树 |
82
+ | `filterSpaceTree` | `(tree: Coordinate[]) => Coordinate[]` | 过滤出空间坐标系树 |
81
83
 
82
84
  # GeoPoint 地理坐标类
83
85
 
@@ -124,8 +126,8 @@
124
126
  | `constructor` | `(options?: Partial<RelativeMap>) => RelativeMap` | 初始化相对映射关系,支持部分属性配置 |
125
127
  | `addRelativeMap` | `(r1: RelativeMap, r2: RelativeMap) => RelativeMap` | 合并两个坐标变换(先应用r1后应用r2) |
126
128
  | `inverseRelativeMap` | `(r: RelativeMap) => RelativeMap` | 计算坐标变换的逆变换 |
127
- | `toParse` | `(r?: string) => RelativeMap \ undefined` | 从JSON字符串解析为RelativeMap对象 |
128
- | `toStringify` | `(r?: RelativeMap) => string \ undefined` | 将RelativeMap对象序列化为JSON字符串 |
129
+ | `toParse` | `(r?: string) => RelativeMap \| undefined` | 从JSON字符串解析为RelativeMap对象 |
130
+ | `toStringify` | `(r?: RelativeMap) => string \| undefined` | 将RelativeMap对象序列化为JSON字符串 |
129
131
 
130
132
  # Point 点坐标类
131
133
 
@@ -151,18 +153,18 @@
151
153
 
152
154
  ## 方法说明
153
155
 
154
- | 方法 | 类型 | 说明 |
155
- | ------------- | ----------------------------------------------------------------------------------------------- | ---------------------- |
156
- | `constructor` | `(options?: Partial<Point>) => Point` | 初始化点坐标 |
157
- | `dist` | `(p1: Point, p2: Point) => number` | 计算两点间三维距离 |
158
- | `distXZ` | `(p1: Point, p2: Point) => number` | 计算两点在XZ平面的距离 |
159
- | `distXY` | `(p1: Point, p2: Point) => number` | 计算两点在XY平面的距离 |
160
- | `toRadians` | `(degrees: number) => number` | 角度转弧度 |
161
- | `toDegrees` | `(radians: number) => number` | 弧度转角度 |
162
- | `angleXZ` | `(pa: Point, pb: Point, pc: Point) => number` | 计算三点在XZ平面的夹角 |
163
- | `toParse` | `(point?: string) => Point \ undefined` | 从字符串解析点坐标 |
164
- | `toStringify` | `(point?: Point) => string` | 将点坐标序列化为字符串 |
165
- | `projection` | `(r: RelativeMap, srcCoordinate?: Coordinate, dstCoordinate?: Coordinate) => Point \ undefined` | 坐标投影转换 |
166
- | `project` | `(r: RelativeMap) => Point \ undefined` | 基础坐标投影 |
167
- | `projectXZ` | `(r: RelativeMap) => Point` | XZ平面坐标投影 |
168
- | `projectXY` | `(r: RelativeMap) => Point` | XY平面坐标投影 |
156
+ | 方法 | 类型 | 说明 |
157
+ | ------------- | ------------------------------------------------------------------------------------------------ | ---------------------- |
158
+ | `constructor` | `(options?: Partial<Point>) => Point` | 初始化点坐标 |
159
+ | `dist` | `(p1: Point, p2: Point) => number` | 计算两点间三维距离 |
160
+ | `distXZ` | `(p1: Point, p2: Point) => number` | 计算两点在XZ平面的距离 |
161
+ | `distXY` | `(p1: Point, p2: Point) => number` | 计算两点在XY平面的距离 |
162
+ | `toRadians` | `(degrees: number) => number` | 角度转弧度 |
163
+ | `toDegrees` | `(radians: number) => number` | 弧度转角度 |
164
+ | `angleXZ` | `(pa: Point, pb: Point, pc: Point) => number` | 计算三点在XZ平面的夹角 |
165
+ | `toParse` | `(point?: string) => Point \| undefined` | 从字符串解析点坐标 |
166
+ | `toStringify` | `(point?: Point) => string` | 将点坐标序列化为字符串 |
167
+ | `projection` | `(r: RelativeMap, srcCoordinate?: Coordinate, dstCoordinate?: Coordinate) => Point \| undefined` | 坐标投影转换 |
168
+ | `project` | `(r: RelativeMap) => Point \| undefined` | 基础坐标投影 |
169
+ | `projectXZ` | `(r: RelativeMap) => Point` | XZ平面坐标投影 |
170
+ | `projectXY` | `(r: RelativeMap) => Point` | XY平面坐标投影 |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vsleem-realsee-viewer/shared",
3
- "version": "2.0.16",
3
+ "version": "2.0.17",
4
4
  "private": false,
5
5
  "description": "Shared utilities for VSLeem RealSee Viewer",
6
6
  "main": "./dist/index.umd.js",