@vsleem-realsee-viewer/bimsee-plugin 2.0.17 → 2.0.19

package/README.internal.md

@@ -1,10 +1,12 @@
-# Bimsee BIM容器组件
+# 1. Bimsee嵌套组件
 
-## 介绍
+## 1.1 介绍
 
 用于将BIM模型展示在页面上的组件，组件包含蒙层容器组件和相关交互等功能
 
-### BimseeProps 参数说明
+依赖@vsleem-realsee-viewer/shared（共享类）
+
+## 1.2 BimseeProps 参数说明
 
 | 参数名              | 类型                                                     | 默认值                      | 说明                       |
 | ------------------- | -------------------------------------------------------- | --------------------------- | -------------------------- |
@@ -18,7 +20,7 @@
 | `fetchSuccess?`     | `(res?: Coordinate) => void`                             | -                           | 坐标系树请求成功           |
 | `fetchError?`       | `(error: any) => void`                                   | -                           | 请求失败回调               |
 
-### AppSetting 类型说明
+## 1.3 AppSetting 类型说明
 
 | 参数名          | 类型     | 默认值                   | 说明                                                   |
 | --------------- | -------- | ------------------------ | ------------------------------------------------------ |
@@ -27,14 +29,14 @@
 | `obsPrefix?`    | `string` | -                        | 用于在对象存储中组织文件的目录路径(不可用)             |
 | `obsType?`      | `string` | hs                       | 指定使用的对象存储服务提供商 huawei \| aliyun \| hs 等 |
 
-### SearchInfo 类型说明
+## 1.4 SearchInfo 类型说明
 
 | 参数名      | 类型     | 默认值 | 说明              |
 | ----------- | -------- | ------ | ----------------- |
 | `projectId` | `number` | -      | 项目唯一标识      |
 | `modelCsId` | `number` | -      | bim模型坐标系标识 |
 
-### BimseeStore 类型说明
+## 1.5 BimseeStore 类型说明
 
 | 属性/方法               | 类型/签名                                               | 说明                                 |
 | ----------------------- | ------------------------------------------------------- | ------------------------------------ |
@@ -50,7 +52,7 @@
 | `setReferPoint`         | `(current: TrackPoint, options: ViewerOptions) => void` | 设置参考点                           |
 | `normalizeToModelPoint` | `(current: TrackPoint) => TrackPoint \| undefined`      | 设置模型的坐标点                     |
 
-### BimseeElement 实例对象
+## 1.6 BimseeElement 实例对象
 
 | 属性/方法     | 类型签名                                           | 说明                                               |
 | ------------- | -------------------------------------------------- | -------------------------------------------------- |
@@ -60,7 +62,7 @@
 | `getState()`  | `() => BimseeProps`                                | 获取初始化配置（返回原始配置参数）                 |
 | `setState()`  | `(options: Partial<UpdatableBimseeProps>) => void` | 动态更新可修改配置（注意：部分配置初始化后不可更改 |
 
-### BimseeEvents 事件说明
+## 1.7 BimseeEvents 事件说明
 
 | 事件名称                | 参数类型                       | 说明                   |
 | ----------------------- | ------------------------------ | ---------------------- |
@@ -75,7 +77,7 @@
 | `maskerZoomUpdated`     | `(e: any) => void`             | 蒙层缩放到指定级别事件 |
 | `maskerPositionUpdated` | `(e: any) => void`             | 蒙层旋转到指定位置事件 |
 
-### Bimsee Slot 插槽说明
+## 1.8 Bimsee Slot 插槽说明
 
 | 插槽名称  | 参数类型               | 说明     |
 | --------- | ---------------------- | -------- |
@@ -96,11 +98,13 @@ type maskerSlot =slot & {
 }
 ```
 
-# Masker 蒙层组件
+# 2. Masker 蒙层组件
+
+## 2.1 介绍
 
-## 介绍
+一个覆盖在BIM上的蒙层组件
 
-### MaskerProps 类型说明
+## 2.2 MaskerProps 类型说明
 
 | 参数名            | 类型      | 默认值 | 说明                   |
 | ----------------- | --------- | ------ | ---------------------- |
@@ -113,7 +117,7 @@ type maskerSlot =slot & {
 | `mouseover?`      | `boolean` | -      | 鼠标悬浮               |
 | `mousedown?`      | `boolean` | -      | 鼠标按下               |
 
-### MaskerElement 实例对象
+## 2.3 MaskerElement 实例对象
 
 | 方法/属性           | 类型签名                                   | 说明                     |
 | ------------------- | ------------------------------------------ | ------------------------ |
@@ -137,7 +141,7 @@ type maskerSlot =slot & {
 | `getCameraHFov`     | `() => number \| undefined`                | 获取当前相机视野角度     |
 | `getCameraStatus`   | `() => CameraStatus \| undefined`          | 获取相机状态             |
 
-### DataHelper 数据转换对象
+## 2.4 DataHelper 数据转换对象
 
 | 属性                         | 类型                                               | 描述                                 |
 | ---------------------------- | -------------------------------------------------- | ------------------------------------ |
@@ -146,7 +150,7 @@ type maskerSlot =slot & {
 | `fovToZoomLevel`             | `(fov: number) => number`                          | 将视野转换为缩放级别                 |
 | `zoomLevelToFov`             | `(level: number) => number`                        | 将缩放级别转换为视野                 |
 
-### MaskerEvents 事件说明
+## 2.5 MaskerEvents 事件说明
 
 | 事件名称          | 描述                   | 参数类型         |
 | ----------------- | ---------------------- | ---------------- |
@@ -156,7 +160,7 @@ type maskerSlot =slot & {
 | `zoomUpdated`     | 蒙层缩放到指定级别事件 | (e: any) => void |
 | `positionUpdated` | 蒙层旋转到指定位置事件 | (e: any) => void |
 
-# 导出的类型声明对象
+# 3. 导出的类型声明对象
 
 ```js
 // 配置相关类型导出
@@ -188,18 +192,18 @@ export {
 
 ```
 
-# 示例
+# 4. 示例
 
 通过以下方式来注册组件
 
-### 安装
+## 4.1 安装
 
-`npm install @vsleem-realsee-viewer/bimsee-plugin @vsleem-realsee-viewer/shared`
+`npm install @vsleem-realsee-viewer/realsee-plugin @vsleem-realsee-viewer/bimsee-plugin @vsleem-realsee-viewer/shared`
 
-`pnpm add @vsleem-realsee-viewer/bimsee-plugin @vsleem-realsee-viewer/shared`
+`pnpm add @vsleem-realsee-viewer/realsee-plugin @vsleem-realsee-viewer/bimsee-plugin @vsleem-realsee-viewer/shared`
 
-### 例子
+## 4.2 例子
 
-`vsleem-realsee-demo仓库下的DualseePlugin.vue`
+`vsleem-realsee-demo仓库下的viewer/dualsee`
 
 仓库地址：https://gitee.com/yangleistudio/vsleem-realsee-demo

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vsleem-realsee-viewer/bimsee-plugin",
-  "version": "2.0.17",
+  "version": "2.0.19",
   "description": "Bimsee plugin for VSLeem RealSee Viewer",
   "main": "./dist/index.umd.js",
   "module": "./dist/index.mjs",
@@ -13,11 +13,11 @@
     "dist"
   ],
   "dependencies": {
-    "@vsleem-realsee-viewer/shared": "2.0.17"
+    "@vsleem-realsee-viewer/shared": "2.0.19"
   },
   "peerDependencies": {
     "vue": "^3.0.0",
-    "@vsleem-realsee-viewer/shared": "2.0.17"
+    "@vsleem-realsee-viewer/shared": "2.0.19"
   },
   "peerDependenciesMeta": {
     "vue": {