@vsleem-realsee-viewer/dualsee-plugin 2.1.3 → 2.1.4
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.internal.md +233 -3
- package/package.json +7 -7
package/README.internal.md
CHANGED
|
@@ -6,6 +6,17 @@
|
|
|
6
6
|
|
|
7
7
|
依赖@vsleem-realsee-viewer/realsee-plugin（全景组件），@vsleem-realsee-viewer/bimsee-plugin（BIM嵌套组件），@vsleem-realsee-viewer/shared（共享类）
|
|
8
8
|
|
|
9
|
+
## 目录
|
|
10
|
+
|
|
11
|
+
- [1. Dualsee全景对比组件](#1-dualsee全景对比组件)
|
|
12
|
+
- [2. Lock 同步锁组件](#2-lock-同步锁组件)
|
|
13
|
+
- [3. 枚举类型](#3-枚举类型)
|
|
14
|
+
- [4. 类型定义详解](#4-类型定义详解)
|
|
15
|
+
- [5. Hooks](#5-hooks)
|
|
16
|
+
- [6. 配置常量](#6-配置常量)
|
|
17
|
+
- [7. 导出说明](#7-导出说明)
|
|
18
|
+
- [8. 示例](#8-示例)
|
|
19
|
+
|
|
9
20
|
## 1.3 DualseeProps 参数说明
|
|
10
21
|
|
|
11
22
|
| 参数名 | 类型 | 默认值 | 说明 |
|
|
@@ -241,18 +252,237 @@ export { DualseeErrorCode } from '@vsleem-realsee-viewer/dualsee-plugin';
|
|
|
241
252
|
|
|
242
253
|
```
|
|
243
254
|
|
|
244
|
-
#
|
|
255
|
+
# 3. 枚举类型
|
|
256
|
+
|
|
257
|
+
## 3.1 DualseeErrorCode 错误码
|
|
258
|
+
|
|
259
|
+
| 值 | 说明 |
|
|
260
|
+
| --------------------------- | ---------------------------------------- |
|
|
261
|
+
| `DualseeNoBIMModel` (12000) | 没有找到对应的BIM模型（Dualsee相关操作） |
|
|
262
|
+
|
|
263
|
+
---
|
|
264
|
+
|
|
265
|
+
# 4. 类型定义详解
|
|
266
|
+
|
|
267
|
+
## 4.1 DualseeProps 双重全景参数
|
|
268
|
+
|
|
269
|
+
```typescript
|
|
270
|
+
type DualseeProps = {
|
|
271
|
+
appSetting: AppSetting; // 全局设置
|
|
272
|
+
dualseeSetting?: DualseeSetting; // 双重全景配置（暂未使用）
|
|
273
|
+
basicRealsee: BasicRealseeProps; // 基础全景
|
|
274
|
+
referRealsee?: ReferRealseeProps; // 对比全景
|
|
275
|
+
referBimsee?: ReferBimseeProps; // 对比bim
|
|
276
|
+
dualseeLock?: LockProps; // 双重全景锁配置
|
|
277
|
+
dualseeLockVisible?: boolean; // 锁是否可见
|
|
278
|
+
referRealseeVisible?: boolean; // 对比全景是否可见
|
|
279
|
+
referBimseeVisible?: boolean; // 对比BIM是否可见
|
|
280
|
+
};
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
## 4.2 BasicRealseeProps 基础全景参数
|
|
284
|
+
|
|
285
|
+
继承自 RealseeOptions（排除 appSetting）。
|
|
286
|
+
|
|
287
|
+
```typescript
|
|
288
|
+
type BasicRealseeProps = Omit<RealseeOptions, 'appSetting'>;
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
## 4.3 ReferRealseeProps 对比全景参数
|
|
292
|
+
|
|
293
|
+
继承自 RealseeOptions（排除 appSetting 和 searchInfo），searchInfo 为可选。
|
|
294
|
+
|
|
295
|
+
```typescript
|
|
296
|
+
type ReferRealseeProps = Omit<RealseeOptions, 'appSetting' | 'searchInfo'> & {
|
|
297
|
+
searchInfo?: RealseeSearchInfo;
|
|
298
|
+
};
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
## 4.4 ReferBimseeProps 对比BIM参数
|
|
302
|
+
|
|
303
|
+
继承自 BimseeOptions（排除 appSetting 和 searchInfo），searchInfo 为可选。
|
|
304
|
+
|
|
305
|
+
```typescript
|
|
306
|
+
type ReferBimseeProps = Omit<BimseeOptions, 'appSetting' | 'searchInfo'> & {
|
|
307
|
+
searchInfo?: BimseeSearchInfo;
|
|
308
|
+
};
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
## 4.5 DualseeElement 双重全景对象
|
|
312
|
+
|
|
313
|
+
| 方法/属性 | 类型签名 | 说明 |
|
|
314
|
+
| ---------------------- | --------------------------------------------------- | ------------------------ |
|
|
315
|
+
| `getState` | `() => UpdatableDualseeProps` | 获取当前配置选项 |
|
|
316
|
+
| `setState` | `(options: Partial<UpdatableDualseeProps>) => void` | 设置配置选项 |
|
|
317
|
+
| `getDualseeLock` | `() => LockElement \| undefined` | 获取锁元素引用 |
|
|
318
|
+
| `getBasicRealsee` | `() => RealseeElement \| undefined` | 获取基础全景元素引用 |
|
|
319
|
+
| `getReferRealsee` | `() => RealseeElement \| undefined` | 获取对比全景元素引用 |
|
|
320
|
+
| `getReferBimsee` | `() => BimseeElement \| undefined` | 获取对比BIM元素引用 |
|
|
321
|
+
| `toggleReferRealsee` | `() => void` | 切换对比全景显示状态 |
|
|
322
|
+
| `showReferRealsee` | `() => void` | 显示对比全景 |
|
|
323
|
+
| `hideReferRealsee` | `() => void` | 隐藏对比全景 |
|
|
324
|
+
| `toggleReferBimsee` | `() => void` | 切换Bimsee面全景显示状态 |
|
|
325
|
+
| `showReferBimsee` | `() => Promise<void>` | 显示Bimsee面全景 |
|
|
326
|
+
| `hideReferBimsee` | `() => void` | 隐藏Bimsee面全景 |
|
|
327
|
+
| `setReferRealseePoint` | `(current?: TrackPoint) => void` | 设置对比视图的点 |
|
|
328
|
+
| `setReferBimseePoint` | `(current?: TrackPoint) => void` | 设置对比BIM的点 |
|
|
329
|
+
|
|
330
|
+
## 4.6 LockProps 锁参数
|
|
331
|
+
|
|
332
|
+
```typescript
|
|
333
|
+
type LockProps = {
|
|
334
|
+
locked?: boolean; // 锁状态
|
|
335
|
+
distance?: number; // 两点之间的距离
|
|
336
|
+
showDistance?: boolean; // 是否显示距离
|
|
337
|
+
maxMatchDistance?: number; // 匹配点最大距离（毫米，默认5000）
|
|
338
|
+
};
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
## 4.7 LockElement 锁对象
|
|
342
|
+
|
|
343
|
+
| 方法/属性 | 类型签名 | 说明 |
|
|
344
|
+
| -------------- | --------------------------------------- | ---------- |
|
|
345
|
+
| `getState` | `() => LockProps` | 获取锁参数 |
|
|
346
|
+
| `setState` | `(options: UpdatableLockProps) => void` | 设置锁参数 |
|
|
347
|
+
| `setDistance` | `(distance: number) => void` | 设置距离值 |
|
|
348
|
+
| `setLocked` | `(locked: boolean) => void` | 设置锁状态 |
|
|
349
|
+
| `showDistance` | `() => void` | 显示距离 |
|
|
350
|
+
| `hideDistance` | `() => void` | 隐藏距离 |
|
|
351
|
+
|
|
352
|
+
## 4.8 UpdatableDualseeProps 可更新双重全景参数
|
|
353
|
+
|
|
354
|
+
```typescript
|
|
355
|
+
type UpdatableDualseeProps = Partial<DualseeProps>;
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
## 4.9 UpdatableLockProps 可更新锁参数
|
|
359
|
+
|
|
360
|
+
```typescript
|
|
361
|
+
type UpdatableLockProps = Partial<LockProps>;
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
---
|
|
365
|
+
|
|
366
|
+
# 5. Hooks
|
|
367
|
+
|
|
368
|
+
## 5.1 useDualsee
|
|
369
|
+
|
|
370
|
+
双重全景组件的核心 Hook，管理组件状态和生命周期。
|
|
371
|
+
|
|
372
|
+
| 参数 | 类型 | 说明 |
|
|
373
|
+
| ------------------- | ---------------------------------- | ---------------- |
|
|
374
|
+
| `props` | `DualseeProps` | 组件属性 |
|
|
375
|
+
| `dualseeLockElRef` | `Ref<LockElement \| undefined>` | 锁元素引用 |
|
|
376
|
+
| `basicRealseeElRef` | `Ref<RealseeElement \| undefined>` | 基础全景元素引用 |
|
|
377
|
+
| `referRealseeElRef` | `Ref<RealseeElement \| undefined>` | 对比全景元素引用 |
|
|
378
|
+
| `referBimseeElRef` | `Ref<BimseeElement \| undefined>` | 对比BIM元素引用 |
|
|
379
|
+
|
|
380
|
+
## 5.2 useLock
|
|
381
|
+
|
|
382
|
+
同步锁组件的核心 Hook，管理锁状态和交互。
|
|
383
|
+
|
|
384
|
+
| 参数 | 类型 | 说明 |
|
|
385
|
+
| ------- | ----------- | ---------- |
|
|
386
|
+
| `props` | `LockProps` | 锁属性 |
|
|
387
|
+
| `emit` | `EmitType` | 事件发射器 |
|
|
388
|
+
|
|
389
|
+
## 5.3 useDualseeLock
|
|
390
|
+
|
|
391
|
+
双重全景锁 Hook，管理 Dualsee 与 Lock 的交互。
|
|
392
|
+
|
|
393
|
+
## 5.4 useBasicRealsee
|
|
394
|
+
|
|
395
|
+
基础全景 Hook，管理基础 Realsee 实例。
|
|
396
|
+
|
|
397
|
+
## 5.5 useReferRealsee
|
|
398
|
+
|
|
399
|
+
对比全景 Hook，管理对比 Realsee 实例。
|
|
400
|
+
|
|
401
|
+
## 5.6 useReferBimsee
|
|
402
|
+
|
|
403
|
+
对比BIM Hook，管理对比 Bimsee 实例。
|
|
404
|
+
|
|
405
|
+
## 5.7 useDualseeContext
|
|
406
|
+
|
|
407
|
+
双重全景上下文 Hook，提供跨组件状态共享。
|
|
408
|
+
|
|
409
|
+
---
|
|
410
|
+
|
|
411
|
+
# 6. 配置常量
|
|
412
|
+
|
|
413
|
+
## 6.1 LOCK_CONFIG 锁配置
|
|
414
|
+
|
|
415
|
+
```typescript
|
|
416
|
+
{
|
|
417
|
+
locked: true, // 锁状态
|
|
418
|
+
distance: 0, // 距离
|
|
419
|
+
showDistance: true, // 是否显示距离
|
|
420
|
+
maxMatchDistance: 5000, // 匹配点最大距离（毫米）
|
|
421
|
+
}
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
## 6.2 DUALSEE_CONFIG 双重全景配置
|
|
425
|
+
|
|
426
|
+
```typescript
|
|
427
|
+
{
|
|
428
|
+
appSetting: APP_SETTING, // 全局设置
|
|
429
|
+
dualseeLock: LOCK_CONFIG, // 锁配置
|
|
430
|
+
dualseeLockVisible: false, // 锁是否可见
|
|
431
|
+
referRealseeVisible: false, // 对比全景是否可见
|
|
432
|
+
referBimseeVisible: false, // 对比BIM是否可见
|
|
433
|
+
}
|
|
434
|
+
```
|
|
435
|
+
|
|
436
|
+
---
|
|
437
|
+
|
|
438
|
+
# 7. 导出说明
|
|
439
|
+
|
|
440
|
+
```js
|
|
441
|
+
/** 组件导出 */
|
|
442
|
+
export { Dualsee as default, Dualsee as DualseePlugin } from '@vsleem-realsee-viewer/dualsee-plugin';
|
|
443
|
+
|
|
444
|
+
/** 配置相关类型导出 */
|
|
445
|
+
export type { AppSetting } from '@vsleem-realsee-viewer/dualsee-plugin';
|
|
446
|
+
|
|
447
|
+
/** 组件属性类型导出 */
|
|
448
|
+
export type {
|
|
449
|
+
BasicRealseeProps, // 基础全景参数
|
|
450
|
+
DualseeElement, // 全景对象
|
|
451
|
+
DualseeProps, // 全景参数
|
|
452
|
+
LockElement, // 锁对象
|
|
453
|
+
LockProps, // 锁参数
|
|
454
|
+
ReferBimseeProps, // 对比BIM参数
|
|
455
|
+
ReferRealseeProps, // 对比全景参数
|
|
456
|
+
UpdatableDualseeProps, // 全景状态
|
|
457
|
+
UpdatableLockProps, // 可更新锁参数
|
|
458
|
+
} from '@vsleem-realsee-viewer/dualsee-plugin';
|
|
459
|
+
|
|
460
|
+
/** 配置常量导出 */
|
|
461
|
+
export {
|
|
462
|
+
DUALSEE_CONFIG, // 双重全景默认配置
|
|
463
|
+
LOCK_CONFIG, // 锁默认配置
|
|
464
|
+
} from '@vsleem-realsee-viewer/dualsee-plugin';
|
|
465
|
+
|
|
466
|
+
/** 错误代码code */
|
|
467
|
+
export { DualseeErrorCode } from '@vsleem-realsee-viewer/dualsee-plugin';
|
|
468
|
+
```
|
|
469
|
+
|
|
470
|
+
---
|
|
471
|
+
|
|
472
|
+
# 8. 示例
|
|
245
473
|
|
|
246
474
|
通过以下方式来注册组件
|
|
247
475
|
|
|
248
|
-
##
|
|
476
|
+
## 8.1 安装
|
|
249
477
|
|
|
250
478
|
`npm install @vsleem-realsee-viewer/realsee-plugin @vsleem-realsee-viewer/bimsee-plugin @vsleem-realsee-viewer/shared`
|
|
251
479
|
|
|
252
480
|
`pnpm add @vsleem-realsee-viewer/realsee-plugin @vsleem-realsee-viewer/bimsee-plugin @vsleem-realsee-viewer/shared`
|
|
253
481
|
|
|
254
|
-
##
|
|
482
|
+
## 8.2 例子
|
|
255
483
|
|
|
256
484
|
`vsleem-realsee-demo仓库下的views/dualsee`
|
|
257
485
|
|
|
258
486
|
仓库地址：https://gitee.com/yangleistudio/vsleem-realsee-demo
|
|
487
|
+
|
|
488
|
+
---
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vsleem-realsee-viewer/dualsee-plugin",
|
|
3
|
-
"version": "2.1.
|
|
3
|
+
"version": "2.1.4",
|
|
4
4
|
"description": "Dualsee plugin for VSLeem RealSee Viewer",
|
|
5
5
|
"main": "./dist/index.umd.js",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -13,15 +13,15 @@
|
|
|
13
13
|
"dist"
|
|
14
14
|
],
|
|
15
15
|
"dependencies": {
|
|
16
|
-
"@vsleem-realsee-viewer/realsee-plugin": "2.1.
|
|
17
|
-
"@vsleem-realsee-viewer/bimsee-plugin": "2.1.
|
|
18
|
-
"@vsleem-realsee-viewer/shared": "2.1.
|
|
16
|
+
"@vsleem-realsee-viewer/realsee-plugin": "2.1.4",
|
|
17
|
+
"@vsleem-realsee-viewer/bimsee-plugin": "2.1.4",
|
|
18
|
+
"@vsleem-realsee-viewer/shared": "2.1.4"
|
|
19
19
|
},
|
|
20
20
|
"peerDependencies": {
|
|
21
21
|
"vue": "^3.0.0",
|
|
22
|
-
"@vsleem-realsee-viewer/realsee-plugin": "2.1.
|
|
23
|
-
"@vsleem-realsee-viewer/bimsee-plugin": "2.1.
|
|
24
|
-
"@vsleem-realsee-viewer/shared": "2.1.
|
|
22
|
+
"@vsleem-realsee-viewer/realsee-plugin": "2.1.4",
|
|
23
|
+
"@vsleem-realsee-viewer/bimsee-plugin": "2.1.4",
|
|
24
|
+
"@vsleem-realsee-viewer/shared": "2.1.4"
|
|
25
25
|
},
|
|
26
26
|
"peerDependenciesMeta": {
|
|
27
27
|
"vue": {
|