@vsleem-realsee-viewer/dualsee-plugin 2.0.15 → 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.
Files changed (11) hide show
  1. package/{README.md → README.internal.md} +91 -73
  2. package/dist/components/Dualsee.vue.d.ts +201 -201
  3. package/dist/hooks/useBasicRealsee.d.ts +5 -5
  4. package/dist/hooks/useReferRealsee.d.ts +5 -5
  5. package/dist/index.css +2 -2
  6. package/dist/index.d.ts +7 -6
  7. package/dist/index.mjs +398 -398
  8. package/dist/index.umd.js +1 -1
  9. package/dist/settings/index.d.ts +1 -1
  10. package/dist/types/dualsee.d.ts +11 -9
  11. package/package.json +7 -7
package/{README.md → README.internal.md} RENAMED
@@ -1,29 +1,33 @@
1
1
  #
2
2
 
3
- # Dualsee 双重场景组件
3
+ # Dualsee 双重全景组件
4
4
 
5
5
  ## 介绍
6
6
 
7
- 用于将双重场景展示在页面上的组件，组件有视图对比，BIM对比和相关交互等功能
7
+ 用于将双重全景展示在页面上的组件，组件有视图对比，BIM对比和相关交互等功能
8
8
 
9
9
  ### DualseeProps 参数说明
10
10
 
11
- | 参数名 | 类型 | 默认值 | 说明 |
12
- | ---------------------- | ---------------- | -------------------------- | ---------------- |
13
- | `appSetting` | `AppSetting` | 请查看AppSetting类型默认值 | 全局设置 |
14
- | `dualseeSetting?` | `DualseeSetting` | 未使用 | 双重场景配置 |
15
- | `dualseeLock?` | `LockProps` | 请查看LockProps类型默认值 | 双重场景锁配置 |
16
- | `basicRealsee` | `RealseeProps` | - | 基础全景 |
17
- | `referRealsee?` | `RealseeProps` | - | 对比全景 |
18
- | `referBimsee?` | `BimseeProps` | - | 对比BIM |
19
- | `dualseeLockVisible?` | `boolean` | false | 锁是否可见 |
20
- | `referRealseeVisible?` | `boolean` | false | 对比全景是否可见 |
21
- | `referBimseeVisible?` | `boolean` | false | 对比BIM是否可见 |
22
-
23
- ### DualseeSetting 类型说明
24
-
25
- | 参数名 | 类型 | 默认值 | 说明 |
26
- | ------ | ---- | ------ | ---- |
11
+ | 参数名 | 类型 | 默认值 | 说明 |
12
+ | ---------------------- | ------------------- | -------------------------- | ---------------------------------------- |
13
+ | `appSetting` | `AppSetting` | 请查看AppSetting类型默认值 | 全局设置 |
14
+ | `dualseeSetting?` | `DualseeSetting` | 未使用 | 双重全景配置 |
15
+ | `dualseeLock?` | `LockProps` | 请查看LockProps类型默认值 | 双重全景锁配置 |
16
+ | `basicRealsee` | `BasicRealseeProps` | - | 基础全景参数(与RealseeProps类型基本相同) |
17
+ | `referRealsee?` | `ReferRealseeProps` | - | 对比全景参数(与RealseeProps类型基本相同) |
18
+ | `referBimsee?` | `ReferBimseeProps` | - | 对比BIM参数(与BimseeProps类型基本相同) |
19
+ | `dualseeLockVisible?` | `boolean` | false | 锁是否可见 |
20
+ | `referRealseeVisible?` | `boolean` | false | 对比全景是否可见 |
21
+ | `referBimseeVisible?` | `boolean` | false | 对比BIM是否可见 |
22
+
23
+ ### 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 等 |
27
31
 
28
32
  ### DualseeElement 实例对象
29
33
 
@@ -31,10 +35,10 @@
31
35
  | ---------------------- | --------------------------------------------------- | ------------------------ |
32
36
  | `getState` | `() => UpdatableDualseeProps` | 获取当前配置选项 |
33
37
  | `setState` | `(options: Partial<UpdatableDualseeProps>) => void` | 设置配置选项 |
34
- | `getDualseeLock` | `() => LockElement \ undefined` | 获取锁元素引用 |
35
- | `getBasicRealsee` | `() => RealseeElement \ undefined` | 获取基础全景元素引用 |
36
- | `getReferRealsee` | `() => RealseeElement \ undefined` | 获取对比全景元素引用 |
37
- | `getReferBimsee` | `() => BimseeElement \ undefined` | 获取对比BIM元素引用 |
38
+ | `getDualseeLock` | `() => LockElement \| undefined` | 获取锁元素引用 |
39
+ | `getBasicRealsee` | `() => RealseeElement \| undefined` | 获取基础全景元素引用 |
40
+ | `getReferRealsee` | `() => RealseeElement \| undefined` | 获取对比全景元素引用 |
41
+ | `getReferBimsee` | `() => BimseeElement \| undefined` | 获取对比BIM元素引用 |
38
42
  | `toggleReferRealsee` | `() => void` | 切换对比全景显示状态 |
39
43
  | `showReferRealsee` | `() => void` | 显示对比全景 |
40
44
  | `hideReferRealsee` | `() => void` | 隐藏对比全景 |
@@ -48,65 +52,71 @@
48
52
 
49
53
  | 事件名称 | 参数类型 | 描述 |
50
54
  | -------------------------------- | ------------------------------- | -------------------- |
51
- | `basic-ready` | `() => void` | 基础场景就绪 |
52
- | `basic-change-model` | `(model: Coordinate) => void` | 基础场景切换模型 |
53
- | `basic-change-record` | `(record: TrackRecord) => void` | 基础场景切换记录 |
54
- | `basic-change-point` | `(point: TrackPoint) => void` | 基础场景切换点位 |
55
+ | `basic-ready` | `() => void` | 基础全景就绪 |
56
+ | `basic-reload` | `() => void` | 基础全景重新加载 |
57
+ | `basic-destroy` | `() => void` | 基础全景销毁 |
58
+ | `basic-change-model` | `(model: Coordinate) => void` | 基础全景切换模型 |
59
+ | `basic-change-record` | `(record: TrackRecord) => void` | 基础全景切换记录 |
60
+ | `basic-change-point` | `(point: TrackPoint) => void` | 基础全景切换点位 |
55
61
  | `basic-map-ready` | `() => void` | 基础地图就绪 |
56
62
  | `basic-map-resize` | `() => void` | 基础地图大小改变 |
57
63
  | `basic-map-collapse` | `(value: number) => void` | 基础地图折叠状态改变 |
58
64
  | `basic-map-dragger` | `() => void` | 基础地图拖拽 |
59
65
  | `basic-map-select-point` | `(point: TrackPoint) => void` | 基础地图选择点位 |
60
66
  | `basic-map-angle-updated` | `(value: number) => void` | 基础地图角度更新 |
61
- | `basic-viewer-ready` | `() => void` | 基础查看器就绪 |
62
- | `basic-viewer-click` | `(e: any) => void` | 基础查看器点击 |
63
- | `basic-viewer-mousedown` | `(e: any) => void` | 基础查看器鼠标按下 |
64
- | `basic-viewer-zoom-updated` | `(e: any) => void` | 基础查看器缩放更新 |
65
- | `basic-viewer-position-updated` | `(e: any) => void` | 基础查看器位置更新 |
67
+ | `basic-viewer-ready` | `() => void` | 基础视图就绪 |
68
+ | `basic-viewer-click` | `(e: any) => void` | 基础视图点击 |
69
+ | `basic-viewer-mousedown` | `(e: any) => void` | 基础视图鼠标按下 |
70
+ | `basic-viewer-size-updated` | `(e: any) => void` | 基础视图容器大小更新 |
71
+ | `basic-viewer-zoom-updated` | `(e: any) => void` | 基础视图缩放更新 |
72
+ | `basic-viewer-position-updated` | `(e: any) => void` | 基础视图位置更新 |
66
73
  | `basic-viewer-panorama-loaded` | `(e: any) => void` | 基础全景图加载完成 |
67
- | `basic-viewer-select-point` | `(point: TrackPoint) => void` | 基础查看器选择点位 |
68
- | `basic-viewer-select-marker` | `(point: TrackPoint) => void` | 基础查看器选择标记 |
74
+ | `basic-viewer-panorama-error` | `(e: any) => void` | 基础全景图加载失败 |
75
+ | `basic-viewer-select-point` | `(point: TrackPoint) => void` | 基础视图选择点位 |
76
+ | `basic-viewer-select-marker` | `(point: TrackPoint) => void` | 基础视图选择标记 |
69
77
  | `basic-playbar-ready` | `() => void` | 基础播放条就绪 |
70
78
  | `basic-playbar-backward` | `(value: number) => void` | 基础播放条后退 |
71
79
  | `basic-playbar-pause` | `(value: number) => void` | 基础播放条暂停 |
72
80
  | `basic-playbar-play` | `(value: number) => void` | 基础播放条播放 |
73
81
  | `basic-playbar-forward` | `(value: number) => void` | 基础播放条前进 |
74
82
  | `basic-playbar-slider` | `(value: number) => void` | 基础播放条滑块拖动 |
75
- | `basic-playbar-speed-updated` | `(speed: number) => void` | 基础播放条速度更新 |
76
- | `basic-playbar-delay-updated` | `(delay: number) => void` | 基础播放条延迟更新 |
77
- | `basic-playbar-step-updated` | `(step: number) => void` | 基础播放条步进更新 |
83
+ | `basic-playbar-speed` | `(speed: number) => void` | 基础播放条速度更新 |
78
84
  | `basic-playbar-select-point` | `(point: TrackPoint) => void` | 基础播放条选择点位 |
79
- | `refer-ready` | `() => void` | 对比场景就绪 |
80
- | `refer-change-model` | `(model: Coordinate) => void` | 对比场景切换模型 |
81
- | `refer-change-record` | `(record: TrackRecord) => void` | 对比场景切换记录 |
82
- | `refer-change-point` | `(point: TrackPoint) => void` | 对比场景切换点位 |
85
+ | `refer-ready` | `() => void` | 对比全景就绪 |
86
+ | `refer-reload` | `() => void` | 对比全景重新加载 |
87
+ | `refer-destroy` | `() => void` | 对比全景销毁 |
88
+ | `refer-change-model` | `(model: Coordinate) => void` | 对比全景切换模型 |
89
+ | `refer-change-record` | `(record: TrackRecord) => void` | 对比全景切换记录 |
90
+ | `refer-change-point` | `(point: TrackPoint) => void` | 对比全景切换点位 |
83
91
  | `refer-map-ready` | `() => void` | 对比地图就绪 |
84
92
  | `refer-map-resize` | `() => void` | 对比地图大小改变 |
85
93
  | `refer-map-collapse` | `(value: number) => void` | 对比地图折叠状态改变 |
86
94
  | `refer-map-dragger` | `() => void` | 对比地图拖拽 |
87
95
  | `refer-map-select-point` | `(point: TrackPoint) => void` | 对比地图选择点位 |
88
96
  | `refer-map-angle-updated` | `(value: number) => void` | 对比地图角度更新 |
89
- | `refer-viewer-ready` | `() => void` | 对比查看器就绪 |
90
- | `refer-viewer-click` | `(e: any) => void` | 对比查看器点击 |
91
- | `refer-viewer-mousedown` | `(e: any) => void` | 对比查看器鼠标按下 |
92
- | `refer-viewer-zoom-updated` | `(e: any) => void` | 对比查看器缩放更新 |
93
- | `refer-viewer-position-updated` | `(e: any) => void` | 对比查看器位置更新 |
97
+ | `refer-viewer-ready` | `() => void` | 对比视图就绪 |
98
+ | `refer-viewer-click` | `(e: any) => void` | 对比视图点击 |
99
+ | `refer-viewer-mousedown` | `(e: any) => void` | 对比视图鼠标按下 |
100
+ | `refer-viewer-size-updated` | `(e: any) => void` | 基础视图容器大小更新 |
101
+ | `refer-viewer-zoom-updated` | `(e: any) => void` | 对比视图缩放更新 |
102
+ | `refer-viewer-position-updated` | `(e: any) => void` | 对比视图位置更新 |
94
103
  | `refer-viewer-panorama-loaded` | `(e: any) => void` | 对比全景图加载完成 |
95
- | `refer-viewer-select-point` | `(point: TrackPoint) => void` | 对比查看器选择点位 |
96
- | `refer-viewer-select-marker` | `(point: TrackPoint) => void` | 对比查看器选择标记 |
104
+ | `refer-viewer-panorama-error` | `(e: any) => void` | 基础全景图加载失败 |
105
+ | `refer-viewer-select-point` | `(point: TrackPoint) => void` | 对比视图选择点位 |
106
+ | `refer-viewer-select-marker` | `(point: TrackPoint) => void` | 对比视图选择标记 |
97
107
  | `refer-playbar-ready` | `() => void` | 对比播放条就绪 |
98
108
  | `refer-playbar-backward` | `(value: number) => void` | 对比播放条后退 |
99
109
  | `refer-playbar-pause` | `(value: number) => void` | 对比播放条暂停 |
100
110
  | `refer-playbar-play` | `(value: number) => void` | 对比播放条播放 |
101
111
  | `refer-playbar-forward` | `(value: number) => void` | 对比播放条前进 |
102
112
  | `refer-playbar-slider` | `(index: number) => void` | 对比播放条滑块拖动 |
103
- | `refer-playbar-speed-updated` | `(speed : number) => void` | 对比播放条速度更新 |
104
- | `refer-playbar-delay-updated` | `(delay: number) => void` | 对比播放条延迟更新 |
105
- | `refer-playbar-step-updated` | `(step : number) => void` | 对比播放条步进更新 |
113
+ | `refer-playbar-speed` | `(speed : number) => void` | 对比播放条速度更新 |
106
114
  | `refer-playbar-select-point` | `(point: TrackPoint) => void` | 对比播放条选择点位 |
107
115
  | `lock-locked-updated` | `(distance: number)=>void` | 锁状态更新 |
108
116
  | `lock-distance-updated` | `(locked: boolean)=> void` | 锁距离更新 |
109
117
  | `bimsee-ready` | `() => void` | BIM组件就绪 |
118
+ | `bimsee-reload` | `() => void` | BIM组件重新加载 |
119
+ | `bimsee-destroy` | `() => void` | BIM组件销毁 |
110
120
  | `bimsee-change-model` | `(model: Coordinate) => void` | BIM切换模型 |
111
121
  | `bimsee-change-point` | `(point?: Point ) => void` | BIM切换坐标点 |
112
122
  | `bimsee-masker-ready` | `(e: any) => void` | BIM蒙层就绪 |
@@ -167,12 +177,14 @@ lock相关插槽请参考Lock组件插槽说明
167
177
 
168
178
  ### LockElement 实例对象
169
179
 
170
- | 属性/方法 | 类型/签名 | 说明 |
171
- | ------------- | --------------------------------------- | ---------- |
172
- | `getState` | `() => LockProps` | 获取锁参数 |
173
- | `setState` | `(options: UpdatableLockProps) => void` | 设置锁参数 |
174
- | `setDistance` | `(distance: number) => void` | 设置距离值 |
175
- | `setLocked` | `(locked: boolean) => void` | 设置锁状态 |
180
+ | 属性/方法 | 类型/签名 | 说明 |
181
+ | -------------- | --------------------------------------- | ---------- |
182
+ | `getState` | `() => LockProps` | 获取锁参数 |
183
+ | `setState` | `(options: UpdatableLockProps) => void` | 设置锁参数 |
184
+ | `setDistance` | `(distance: number) => void` | 设置距离值 |
185
+ | `setLocked` | `(locked: boolean) => void` | 设置锁状态 |
186
+ | `showDistance` | `() => void` | 显示距离 |
187
+ | `hideDistance` | `() => void` | 隐藏距离 |
176
188
 
177
189
  ### LockEvents 事件说明
178
190
 
@@ -190,32 +202,38 @@ lock相关插槽请参考Lock组件插槽说明
190
202
 
191
203
  ```
192
204
  type slot = {
193
- locked?: boolean | undefined;
194
- distance?: number | undefined;
195
- showDistance?: boolean | undefined;
196
- maxMatchDistance?: number | undefined;
205
+ locked?: boolean | undefined;
206
+ distance?: number | undefined;
207
+ showDistance?: boolean | undefined;
208
+ maxMatchDistance?: number | undefined;
197
209
  }
198
210
  ```
199
211
 
200
212
  # 导出的类型声明对象
201
213
 
202
214
  ```js
215
+
216
+ /** 配置相关类型导出 */
217
+ export type { AppSetting /** 应用设置 */ } from '@vsleem-realsee-viewer/dualsee-plugin';
218
+
203
219
  export type {
204
- //Dualsee相关
205
- DualseeSetting, //场景设置
206
- DualseeProps, //场景参数
207
- UpdatableDualseeProps, //场景状态
208
- DualseeElement, //场景对象
209
- //Lock相关
210
- LockProps, //锁参数
211
- UpdatableLockProps, //可更新锁参数
212
- LockElement, //锁对象
220
+ BasicRealseeProps /** 基础全景参数 */,
221
+ DualseeElement /** 全景对象 */,
222
+ /** Dualsee相关 */
223
+ DualseeProps /** 全景参数 */,
224
+ LockElement /** 锁对象 */,
225
+ /** Lock相关 */
226
+ LockProps /** 锁参数 */,
227
+ ReferBimseeProps /** 对比BIM参数 */,
228
+ ReferRealseeProps /** 对比全景参数 */,
229
+ UpdatableDualseeProps /** 全景状态 */,
230
+ UpdatableLockProps /** 可更新锁参数 */,
213
231
  } from '@vsleem-realsee-viewer/dualsee-plugin';
214
232
 
215
- export {
216
- LOCK_CONFIG, // 锁默认配置
217
- DUALSEE_CONFIG, //双重场景默认配置
218
- } from '@vsleem-realsee-viewer/dualsee-plugin';
233
+ export { DUALSEE_CONFIG /** 双重全景默认配置 */, LOCK_CONFIG /** 锁默认配置 */ } from '@vsleem-realsee-viewer/dualsee-plugin';
234
+
235
+ /** 错误代码code */
236
+ export { DualseeErrorCode } from '@vsleem-realsee-viewer/dualsee-plugin';
219
237
 
220
238
  ```
221
239