@vsleem-realsee-viewer/bimsee-plugin 2.0.16 → 2.0.18
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.
- package/{README.md → README.internal.md} +108 -92
- package/dist/index.d.ts +4 -4
- package/dist/types/bimsee.d.ts +5 -2
- package/package.json +3 -3
|
@@ -1,59 +1,74 @@
|
|
|
1
|
-
# Bimsee
|
|
1
|
+
# 1. Bimsee嵌套组件
|
|
2
2
|
|
|
3
|
-
## 介绍
|
|
3
|
+
## 1.1 介绍
|
|
4
4
|
|
|
5
5
|
用于将BIM模型展示在页面上的组件，组件包含蒙层容器组件和相关交互等功能
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
依赖@vsleem-realsee-viewer/shared（共享类）
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
| ------------------- | ------------------------------------------------------- | --------------------------- | -------------------------- |
|
|
11
|
-
| `appSetting` | `AppSetting` | 请查看AppSetting类型默认值 | 应用全局配置 |
|
|
12
|
-
| `searchInfo` | `SearchInfo` | - | 数据查询条件参数 |
|
|
13
|
-
| `bimseeSetting?` | `BimseeSetting` | - | 暂未使用 |
|
|
14
|
-
| `masker?` | `MaskerProps` | 请查看MaskerProps类型默认值 | 蒙层相关属性配置 |
|
|
15
|
-
| `immediate?` | `boolean` | true | 是否立即发起数据请求 |
|
|
16
|
-
| `delay?` | `number` | 0 | 请求延迟时间（单位：毫秒） |
|
|
17
|
-
| `handleResponseFn?` | `(res?: Coordinate) => Promise<Coordinate \ undefined>` | - | 处理坐标系树响应 |
|
|
18
|
-
| `fetchSuccess?` | `(res?: Coordinate) => void` | - | 坐标系树请求成功 |
|
|
19
|
-
| `fetchError?` | `(error: any) => void` | - | 请求失败回调 |
|
|
9
|
+
## 1.2 BimseeProps 参数说明
|
|
20
10
|
|
|
21
|
-
|
|
11
|
+
| 参数名 | 类型 | 默认值 | 说明 |
|
|
12
|
+
| ------------------- | -------------------------------------------------------- | --------------------------- | -------------------------- |
|
|
13
|
+
| `appSetting` | `AppSetting` | 请查看AppSetting类型默认值 | 应用全局配置 |
|
|
14
|
+
| `searchInfo` | `SearchInfo` | - | 数据查询条件参数 |
|
|
15
|
+
| `bimseeSetting?` | `BimseeSetting` | - | 暂未使用 |
|
|
16
|
+
| `masker?` | `MaskerProps` | 请查看MaskerProps类型默认值 | 蒙层相关属性配置 |
|
|
17
|
+
| `immediate?` | `boolean` | true | 是否立即发起数据请求 |
|
|
18
|
+
| `delay?` | `number` | 0 | 请求延迟时间（单位：毫秒） |
|
|
19
|
+
| `handleResponseFn?` | `(res?: Coordinate) => Promise<Coordinate \| undefined>` | - | 处理坐标系树响应 |
|
|
20
|
+
| `fetchSuccess?` | `(res?: Coordinate) => void` | - | 坐标系树请求成功 |
|
|
21
|
+
| `fetchError?` | `(error: any) => void` | - | 请求失败回调 |
|
|
22
|
+
|
|
23
|
+
## 1.3 AppSetting 类型说明
|
|
24
|
+
|
|
25
|
+
| 参数名 | 类型 | 默认值 | 说明 |
|
|
26
|
+
| --------------- | -------- | ------------------------ | ------------------------------------------------------ |
|
|
27
|
+
| `baseUrl?` | `string` | `https://vsleem.com/api` | 用于配置应用后端服务的根路径 |
|
|
28
|
+
| `authorizeCode` | `string` | - | 用于API身份验证和授权的凭证 |
|
|
29
|
+
| `obsPrefix?` | `string` | - | 用于在对象存储中组织文件的目录路径(不可用) |
|
|
30
|
+
| `obsType?` | `string` | hs | 指定使用的对象存储服务提供商 huawei \| aliyun \| hs 等 |
|
|
31
|
+
|
|
32
|
+
## 1.4 SearchInfo 类型说明
|
|
22
33
|
|
|
23
34
|
| 参数名 | 类型 | 默认值 | 说明 |
|
|
24
35
|
| ----------- | -------- | ------ | ----------------- |
|
|
25
36
|
| `projectId` | `number` | - | 项目唯一标识 |
|
|
26
37
|
| `modelCsId` | `number` | - | bim模型坐标系标识 |
|
|
27
38
|
|
|
28
|
-
|
|
39
|
+
## 1.5 BimseeStore 类型说明
|
|
29
40
|
|
|
30
|
-
| 属性/方法 | 类型/签名
|
|
31
|
-
| ----------------------- |
|
|
32
|
-
| `ready` | `boolean`
|
|
33
|
-
| `coordinateTree?` | `Coordinate`
|
|
34
|
-
| `mappedCoordinateTree?` | `Coordinate`
|
|
35
|
-
| `currentModel?` | `Coordinate`
|
|
36
|
-
| `currentSpace?` | `Coordinate`
|
|
37
|
-
| `currentPoint?` | `Point`
|
|
38
|
-
| `reload` | `(searchInfo: SearchInfo) => Promise<void>`
|
|
39
|
-
| `selectModel` | `(coordinate: Partial<Coordinate>) => void`
|
|
40
|
-
| `
|
|
41
|
+
| 属性/方法 | 类型/签名 | 说明 |
|
|
42
|
+
| ----------------------- | ------------------------------------------------------- | ------------------------------------ |
|
|
43
|
+
| `ready` | `boolean` | 是否加载完成 |
|
|
44
|
+
| `coordinateTree?` | `Coordinate` | 坐标树结构 |
|
|
45
|
+
| `mappedCoordinateTree?` | `Coordinate` | 映射后的坐标树结构 |
|
|
46
|
+
| `currentModel?` | `Coordinate` | 当前模型坐标系 |
|
|
47
|
+
| `currentSpace?` | `Coordinate` | 当前空间坐标系 |
|
|
48
|
+
| `currentPoint?` | `Point` | 当前模型的点 |
|
|
49
|
+
| `reload` | `(searchInfo: SearchInfo) => Promise<void>` | 重新加载数据 |
|
|
50
|
+
| `selectModel` | `(coordinate: Partial<Coordinate>) => void` | 选择模型（找不到对应模型时抛出错误） |
|
|
51
|
+
| `selectPoint` | ` (point: Point) => void` | 设置模型的坐标点 |
|
|
52
|
+
| `setReferPoint` | `(current: TrackPoint, options: ViewerOptions) => void` | 设置参考点 |
|
|
53
|
+
| `normalizeToModelPoint` | `(current: TrackPoint) => TrackPoint \| undefined` | 设置模型的坐标点 |
|
|
41
54
|
|
|
42
|
-
|
|
55
|
+
## 1.6 BimseeElement 实例对象
|
|
43
56
|
|
|
44
57
|
| 属性/方法 | 类型签名 | 说明 |
|
|
45
58
|
| ------------- | -------------------------------------------------- | -------------------------------------------------- |
|
|
46
59
|
| `storeRef` | `ComputedRef<BimseeStore>` | 响应式存储对象引用 |
|
|
47
60
|
| `getStore()` | `() => BimseeStore` | 获取状态管理库实例 |
|
|
48
|
-
| `getMasker()` | `() => MaskerElement
|
|
61
|
+
| `getMasker()` | `() => MaskerElement \| undefined` | 获取蒙层容器控制器 |
|
|
49
62
|
| `getState()` | `() => BimseeProps` | 获取初始化配置（返回原始配置参数） |
|
|
50
63
|
| `setState()` | `(options: Partial<UpdatableBimseeProps>) => void` | 动态更新可修改配置（注意：部分配置初始化后不可更改 |
|
|
51
64
|
|
|
52
|
-
|
|
65
|
+
## 1.7 BimseeEvents 事件说明
|
|
53
66
|
|
|
54
67
|
| 事件名称 | 参数类型 | 说明 |
|
|
55
68
|
| ----------------------- | ------------------------------ | ---------------------- |
|
|
56
|
-
| `ready` | `() => void` |
|
|
69
|
+
| `ready` | `() => void` | 准备就绪事件 |
|
|
70
|
+
| `reload` | `() => void` | 重新加载事件 |
|
|
71
|
+
| `destroy` | `() => void` | 组件销毁事件 |
|
|
57
72
|
| `changeModel` | `(model?: Coordinate) => void` | 切换模型事件 |
|
|
58
73
|
| `changePoint` | `(point?: Point) => void` | 切换坐标点事件 |
|
|
59
74
|
| `maskerReady` | `() => void` | 蒙层准备就绪事件 |
|
|
@@ -62,7 +77,7 @@
|
|
|
62
77
|
| `maskerZoomUpdated` | `(e: any) => void` | 蒙层缩放到指定级别事件 |
|
|
63
78
|
| `maskerPositionUpdated` | `(e: any) => void` | 蒙层旋转到指定位置事件 |
|
|
64
79
|
|
|
65
|
-
|
|
80
|
+
## 1.8 Bimsee Slot 插槽说明
|
|
66
81
|
|
|
67
82
|
| 插槽名称 | 参数类型 | 说明 |
|
|
68
83
|
| --------- | ---------------------- | -------- |
|
|
@@ -83,59 +98,59 @@ type maskerSlot =slot & {
|
|
|
83
98
|
}
|
|
84
99
|
```
|
|
85
100
|
|
|
86
|
-
# Masker 蒙层组件
|
|
87
|
-
|
|
88
|
-
## 介绍
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
|
95
|
-
|
|
|
96
|
-
| `
|
|
97
|
-
| `
|
|
98
|
-
| `
|
|
99
|
-
| `
|
|
100
|
-
| `minFov?`
|
|
101
|
-
| `maxFov?`
|
|
102
|
-
| `mouseover?`
|
|
103
|
-
| `mousedown?`
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
| 方法/属性 | 类型签名
|
|
108
|
-
| ------------------- |
|
|
109
|
-
| `dataHelper` | `DataHelper`
|
|
110
|
-
| `isMouseover` | `() => boolean`
|
|
111
|
-
| `isMousedown` | `() => boolean`
|
|
112
|
-
| `setState` | `(options?: Partial<MaskerProps>) => void`
|
|
113
|
-
| `
|
|
114
|
-
| `
|
|
115
|
-
| `
|
|
116
|
-
| `
|
|
117
|
-
| `
|
|
118
|
-
| `
|
|
119
|
-
| `
|
|
120
|
-
| `
|
|
121
|
-
| `
|
|
122
|
-
| `
|
|
123
|
-
| `
|
|
124
|
-
| `
|
|
125
|
-
| `
|
|
126
|
-
| `
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
|
132
|
-
|
|
|
133
|
-
| `modelPointToCameraPosition` | `(point: Point) => Vector3`
|
|
134
|
-
| `maskerRotateToCameraTarget` | `(rotate: Position, position: Vector3) => Vector3`
|
|
135
|
-
| `fovToZoomLevel` | `(fov: number) => number`
|
|
136
|
-
| `zoomLevelToFov` | `(level: number) => number`
|
|
137
|
-
|
|
138
|
-
|
|
101
|
+
# 2. Masker 蒙层组件
|
|
102
|
+
|
|
103
|
+
## 2.1 介绍
|
|
104
|
+
|
|
105
|
+
一个覆盖在BIM上的蒙层组件
|
|
106
|
+
|
|
107
|
+
## 2.2 MaskerProps 类型说明
|
|
108
|
+
|
|
109
|
+
| 参数名 | 类型 | 默认值 | 说明 |
|
|
110
|
+
| ----------------- | --------- | ------ | ---------------------- |
|
|
111
|
+
| `visible?` | `boolean` | true | 是否可见 |
|
|
112
|
+
| `defaultYaw?` | `number` | 0 | 默认偏航角(球面基准) |
|
|
113
|
+
| `defaultPitch?` | `number` | 0 | 默认俯仰角(球面基准) |
|
|
114
|
+
| `defaultZoomLvl?` | `number` | 30 | 默认缩放级别(球面基准) |
|
|
115
|
+
| `minFov?` | `number` | 20 | 最小视野角度 |
|
|
116
|
+
| `maxFov?` | `number` | 120 | 最大视野角度 |
|
|
117
|
+
| `mouseover?` | `boolean` | - | 鼠标悬浮 |
|
|
118
|
+
| `mousedown?` | `boolean` | - | 鼠标按下 |
|
|
119
|
+
|
|
120
|
+
## 2.3 MaskerElement 实例对象
|
|
121
|
+
|
|
122
|
+
| 方法/属性 | 类型签名 | 说明 |
|
|
123
|
+
| ------------------- | ------------------------------------------ | ------------------------ |
|
|
124
|
+
| `dataHelper` | `DataHelper` | 用于蒙层的数据转换器集合 |
|
|
125
|
+
| `isMouseover` | `() => boolean` | 检查鼠标是否悬停 |
|
|
126
|
+
| `isMousedown` | `() => boolean` | 检查鼠标是否按下 |
|
|
127
|
+
| `setState` | `(options?: Partial<MaskerProps>) => void` | 更新蒙层配置选项 |
|
|
128
|
+
| `setVisible` | `(visible: boolean) => void` | 设置蒙层是否显示 |
|
|
129
|
+
| `setMousedown` | `(mousedown: boolean) => void` | 设置鼠标按下状态 |
|
|
130
|
+
| `setMouseover` | `(mouseover: boolean) => void` | 设置鼠标悬停状态 |
|
|
131
|
+
| `setMinFov` | `(minFov: number) => void` | 设置最小视野 |
|
|
132
|
+
| `setMaxFov` | `(maxFov: number) => void` | 设置最大视野 |
|
|
133
|
+
| `setMaskerStatus` | `(options: ViewerOptions) => void` | 更新蒙层状态 |
|
|
134
|
+
| `zoom` | `(level: number) => void` | 缩放到指定级别 |
|
|
135
|
+
| `rotate` | `(position: Position) => void` | 旋转蒙层到指定位置 |
|
|
136
|
+
| `getState` | ` () => MaskerProps` | 获取当前蒙层状态 |
|
|
137
|
+
| `getPosition` | `() => Position` | 获取当前位置(yaw/pitch) |
|
|
138
|
+
| `getZoomLevel` | ` () => number` | 获取当前缩放级别 |
|
|
139
|
+
| `getCameraPosition` | `() => Vector3 \| undefined` | 获取当前相机位置 |
|
|
140
|
+
| `getCameraTarget` | `() => Vector3 \| undefined` | 获取当前相机视角 |
|
|
141
|
+
| `getCameraHFov` | `() => number \| undefined` | 获取当前相机视野角度 |
|
|
142
|
+
| `getCameraStatus` | `() => CameraStatus \| undefined` | 获取相机状态 |
|
|
143
|
+
|
|
144
|
+
## 2.4 DataHelper 数据转换对象
|
|
145
|
+
|
|
146
|
+
| 属性 | 类型 | 描述 |
|
|
147
|
+
| ---------------------------- | -------------------------------------------------- | ------------------------------------ |
|
|
148
|
+
| `modelPointToCameraPosition` | `(point: Point) => Vector3` | 将当前模型的坐标转成三维相机位置坐标 |
|
|
149
|
+
| `maskerRotateToCameraTarget` | `(rotate: Position, position: Vector3) => Vector3` | 将球面坐标转换为三维目标点坐标 |
|
|
150
|
+
| `fovToZoomLevel` | `(fov: number) => number` | 将视野转换为缩放级别 |
|
|
151
|
+
| `zoomLevelToFov` | `(level: number) => number` | 将缩放级别转换为视野 |
|
|
152
|
+
|
|
153
|
+
## 2.5 MaskerEvents 事件说明
|
|
139
154
|
|
|
140
155
|
| 事件名称 | 描述 | 参数类型 |
|
|
141
156
|
| ----------------- | ---------------------- | ---------------- |
|
|
@@ -145,11 +160,12 @@ type maskerSlot =slot & {
|
|
|
145
160
|
| `zoomUpdated` | 蒙层缩放到指定级别事件 | (e: any) => void |
|
|
146
161
|
| `positionUpdated` | 蒙层旋转到指定位置事件 | (e: any) => void |
|
|
147
162
|
|
|
148
|
-
# 导出的类型声明对象
|
|
163
|
+
# 3. 导出的类型声明对象
|
|
149
164
|
|
|
150
165
|
```js
|
|
151
166
|
// 配置相关类型导出
|
|
152
167
|
export type {
|
|
168
|
+
AppSetting, // 应用设置
|
|
153
169
|
SearchInfo, // 搜索信息
|
|
154
170
|
BimseeSetting, //bim配置
|
|
155
171
|
CameraStatus, //相机状态
|
|
@@ -176,18 +192,18 @@ export {
|
|
|
176
192
|
|
|
177
193
|
```
|
|
178
194
|
|
|
179
|
-
# 示例
|
|
195
|
+
# 4. 示例
|
|
180
196
|
|
|
181
197
|
通过以下方式来注册组件
|
|
182
198
|
|
|
183
|
-
|
|
199
|
+
## 4.1 安装
|
|
184
200
|
|
|
185
|
-
`npm install @vsleem-realsee-viewer/bimsee-plugin @vsleem-realsee-viewer/shared`
|
|
201
|
+
`npm install @vsleem-realsee-viewer/realsee-plugin @vsleem-realsee-viewer/bimsee-plugin @vsleem-realsee-viewer/shared`
|
|
186
202
|
|
|
187
|
-
`pnpm add @vsleem-realsee-viewer/bimsee-plugin @vsleem-realsee-viewer/shared`
|
|
203
|
+
`pnpm add @vsleem-realsee-viewer/realsee-plugin @vsleem-realsee-viewer/bimsee-plugin @vsleem-realsee-viewer/shared`
|
|
188
204
|
|
|
189
|
-
|
|
205
|
+
## 4.2 例子
|
|
190
206
|
|
|
191
|
-
`vsleem-realsee-demo仓库下的
|
|
207
|
+
`vsleem-realsee-demo仓库下的viewer/dualsee`
|
|
192
208
|
|
|
193
209
|
仓库地址：https://gitee.com/yangleistudio/vsleem-realsee-demo
|
package/dist/index.d.ts
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
export { Bimsee as BimseePlugin } from './components';
|
|
3
3
|
export { default as Bimsee } from './components/Bimsee.vue';
|
|
4
4
|
/** 配置相关类型导出 */
|
|
5
|
-
export type {
|
|
5
|
+
export type { AppSetting /** 应用设置 */, BimseeSetting /** bim配置 */, CameraStatus /** 相机状态 */, SearchInfo /** 搜索信息 */, ViewerOptions /** 视图选项 */, } from './types';
|
|
6
6
|
/** 组件属性类型导出 */
|
|
7
|
-
export type {
|
|
7
|
+
export type { BimseeElement /** Bimsee 元素类型 */, BimseeProps /** Bimsee 组件属性 */, BimseeStore /** Bimsee 状态管理元素类型 */, MaskerElement /** 蒙层元素类型 */, MaskerProps /** 蒙层属性 */,
|
|
8
8
|
/** Bimsee 相关 */
|
|
9
|
-
UpdatableBimseeProps /** 可更新的Bimsee属性 */,
|
|
9
|
+
UpdatableBimseeProps /** 可更新的Bimsee属性 */,
|
|
10
10
|
/** 蒙层相关 */
|
|
11
|
-
UpdatableMaskerProps /** 可更新的蒙层属性 */,
|
|
11
|
+
UpdatableMaskerProps /** 可更新的蒙层属性 */, } from './types';
|
|
12
12
|
export { BIMSEE_CONFIG /** Realsee 默认设置 */, MASKER_CONFIG /** 蒙层默认配置 */, } from './settings';
|
package/dist/types/bimsee.d.ts
CHANGED
|
@@ -1,7 +1,10 @@
|
|
|
1
|
+
import { AppSetting as AppConfig, Coordinate } from '@vsleem-realsee-viewer/shared';
|
|
1
2
|
import { ComputedRef } from 'vue';
|
|
2
|
-
import {
|
|
3
|
+
import { MaskerElement, MaskerProps } from './masker';
|
|
3
4
|
import { BimseeStore } from './store';
|
|
4
|
-
|
|
5
|
+
/**应用设置 */
|
|
6
|
+
export type AppSetting = AppConfig;
|
|
7
|
+
/** 搜索参数 */
|
|
5
8
|
export type SearchInfo = {
|
|
6
9
|
projectId: number /** 项目id */;
|
|
7
10
|
modelCsId: number /** bim模型坐标系id */;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vsleem-realsee-viewer/bimsee-plugin",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.18",
|
|
4
4
|
"description": "Bimsee plugin for VSLeem RealSee Viewer",
|
|
5
5
|
"main": "./dist/index.umd.js",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -13,11 +13,11 @@
|
|
|
13
13
|
"dist"
|
|
14
14
|
],
|
|
15
15
|
"dependencies": {
|
|
16
|
-
"@vsleem-realsee-viewer/shared": "2.0.
|
|
16
|
+
"@vsleem-realsee-viewer/shared": "2.0.18"
|
|
17
17
|
},
|
|
18
18
|
"peerDependencies": {
|
|
19
19
|
"vue": "^3.0.0",
|
|
20
|
-
"@vsleem-realsee-viewer/shared": "2.0.
|
|
20
|
+
"@vsleem-realsee-viewer/shared": "2.0.18"
|
|
21
21
|
},
|
|
22
22
|
"peerDependenciesMeta": {
|
|
23
23
|
"vue": {
|