@belife/belife-bim-air 1.6.1-zy.86.patch.8 → 1.6.1-zy.86.patch.9

package/docs/web/347/253/257//347/256/241/347/220/206/345/231/250-/351/232/224/347/246/273/347/256/241/347/220/206/345/231/250/357/274/210IsolationManager/357/274/211.md

@@ -0,0 +1,147 @@
+# 隔离管理器（IsolationManager）
+
+## Constructors
+
+------
+
+### • new  IsolationManager(viewer)
+
+**功能描述**：创建隔离管理器。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| viewer   | Viewer   | 是       | 视图     |
+
+------
+
+## Properties
+
+------
+### dataManagerBase
+
+**功能描述**：数据管理的基本类
+
+------
+
+### styleManagerBase
+
+**功能描述**：样式管理的基本类
+
+------
+## **Accessors**
+------
+### isolationDatas
+
+**功能描述**：用于访问隔离相关数据
+
+------
+### isolationStyleSegment
+
+**功能描述**：隔离样式类
+
+------
+### material
+
+**功能描述**：用户创建材质，设置颜色、图片、贴图等
+
+------
+### segmentObject
+
+**功能描述**：获取当前隔离的一个节点
+
+------
+### segmentObjects
+
+**功能描述**：获取当前隔离的全部节点
+
+------
+### viewer
+------
+## Methods
+------
+### clearAllIsolation
+
+**功能描述**
+
+取消所有隔离
+
+**请求体参数**
+
+无
+
+**返回参数**
+
+无
+
+------
+### clearIsolation
+
+**功能描述**
+
+根据传入的一个或多个TreeNodeObject或者SegmentObject对象数组进行取消隔离
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| objs | TreeNodeObject(TreeNodeObject.md)  []\|\|SegmentObject(SegmentObject.md)[] | 是 | TreeNodeObject[]/SegmentObject[]（树节点对象数组/模型节点对象数组） |
+
+**返回参数**
+
+无
+
+------
+### isIsolation
+
+**功能描述**
+
+根据传入的一个TreeNodeObject或者SegmentObject对象判断是否隔离
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| obj | TreeNodeObject(TreeNodeObject.md)  \|\|SegmentObject(SegmentObject.md) | 是 | TreeNodeObject/SegmentObject（树节点对象/模型节点对象） |
+
+**返回参数**
+
+boolean
+
+------
+### isolation
+
+**功能描述**
+
+根据传入的一个或多个TreeNodeObject或者SegmentObject对象数组进行隔离
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| objs | TreeNodeObject(TreeNodeObject.md)  []\|\|SegmentObject(SegmentObject.md)[] | 是 | TreeNodeObject[]/SegmentObject[]（树节点对象数组/模型节点对象数组） |
+
+**返回参数**
+
+boolean
+
+------
+### isolationInvert
+
+**功能描述**
+
+根据传入的一个或多个TreeNodeObject或者SegmentObject对象数组进行隔离反转，每调用一次反转一次
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| objs | TreeNodeObject(TreeNodeObject.md)  []\|\|SegmentObject(SegmentObject.md)[] | 是 | TreeNodeObject[]/SegmentObject[]（树节点对象数组/模型节点对象数组） |
+
+**返回参数**
+
+无
+
+------
+

package/docs/web/347/253/257//347/256/241/347/220/206/345/231/250-/351/235/242/346/235/277/347/256/241/347/220/206/345/231/250/357/274/210PanelManager/357/274/211.md

@@ -0,0 +1,71 @@
+# 面板管理器（PanelManager）
+## Constructors
+
+------
+
+### • new PanelManager(viewer)
+
+**功能描述**：创建面板管理器。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| viewer   | Viewer   | 是       | 视图     |
+
+------
+
+## **Accessors**
+
+------
+### collisionPanel
+
+**功能描述**：碰撞面板
+
+------
+### drawingPanel
+
+**功能描述**：绘制面板
+
+------
+### info
+
+**功能描述**：信息
+
+------
+### propertyPanel
+
+**功能描述**：属性面板
+
+------
+### setting
+
+**功能描述**：配置
+
+------
+### snapshoot
+
+**功能描述**：快照
+
+------
+### structureTree
+
+**功能描述**：结构树
+
+------
+### viewPlanPanel
+
+**功能描述**：视图平面面板
+
+------
+### viewPointPanel
+
+**功能描述**：视点面板
+
+------
+### viewer
+
+**功能描述**：视图
+
+------
+

package/docs/web/347/253/257//347/256/241/347/220/206/345/231/250-/351/253/230/344/272/256/347/256/241/347/220/206/345/231/250/357/274/210HighlightManager/357/274/211.md

@@ -0,0 +1,127 @@
+# 高亮管理器（HighlightManager）
+
+## Constructors
+
+------
+
+### • new  HighlightManager (viewer)
+
+**功能描述**：创建高亮管理器。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| viewer   | Viewer   | 是       | 视图     |
+
+------
+
+## Properties
+
+------
+### dataManagerBase
+
+****功能描述**：**数据管理的基本类
+
+------
+### styleManagerBase
+
+****功能描述**：**样式管理的基本类
+
+------
+## **Accessors**
+------
+### highlightDatas
+
+**功能描述**：高亮数据
+
+------
+### material
+
+**功能描述**：用户创建材质，设置颜色、图片、贴图等
+
+------
+### segmentObject
+
+**功能描述**：获取当前高亮的一个节点
+
+------
+### segmentObjects
+
+**功能描述**：获取当前高亮的全部节点
+
+------
+### viewer
+
+**功能描述**：视图
+
+------
+## Methods
+------
+### clearAllHighlight
+
+**功能描述**
+
+取消所有高亮
+
+**请求体参数**
+
+无
+
+**返回参数**
+
+无
+
+------
+### clearHighlight
+
+**功能描述**
+
+根据传入的一个或多个TreeNodeObject或者SegmentObject对象数组清除高亮
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| objs | TreeNodeObject(TreeNodeObject.md)  []\|\|SegmentObject(SegmentObject.md)[] | 是 | TreeNodeObject[]/SegmentObject[]（树节点对象数组/模型节点对象数组） |
+
+**返回参数**
+
+无
+
+------
+### highlight
+
+**功能描述**
+
+根据传入的一个或多个TreeNodeObject或者SegmentObject对象数组高亮对应节点
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| objs | TreeNodeObject(TreeNodeObject.md)  []\|\|SegmentObject(SegmentObject.md)[] |  | TreeNodeObject[]/SegmentObject[]（树节点对象数组/模型节点对象数组） |
+
+**返回参数**
+
+无
+
+------
+### isHighlight
+
+**功能描述**
+
+根据传入的一个TreeNodeObject或者SegmentObject对象判断节点是否高亮
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| obj | TreeNodeObject(TreeNodeObject.md)  \|\|SegmentObject(SegmentObject.md) | 是 | TreeNodeObject/SegmentObject（树节点对象/模型节点对象） |
+
+**返回参数**
+
+boolean
+
+------
+

package/docs/web/347/253/257//351/205/215/347/275/256-/345/212/240/350/275/275/351/200/211/351/241/271/357/274/210LoaderOptions/357/274/211.md

@@ -0,0 +1,57 @@
+# 加载选项（LoaderOptions）
+
+## Properties
+
+------
+
+### isInitDataBase: boolean
+
+**功能描述**：是否初始化内核数据库。
+
+------
+
+### isShareArrayBuffer: boolean
+
+**功能描述**：是否启用共享内存。
+
+------
+
+### key: string
+
+**功能描述**：是否初始化内核数据库。
+
+------
+
+### secret: string
+
+**功能描述**：用户的密钥。
+
+------
+
+### text: Object
+
+**功能描述**：三维文字配置。
+
+**类型声明**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述       |
+| :------- | -------- | -------- | -------------- |
+| fonts    | string[] | 否       | 文字包路径数组 |
+| isLoad   | boolean  | 是       | 是否加载文字包 |
+
+------
+
+### url: string
+
+**功能描述**：请求wasm（面向Web的二进制格式  ）文件的url。
+
+------
+
+### userService: string
+
+**功能描述**：用户服务Url。
+
+------
+
+###  
+

package/docs/web/347/253/257//351/205/215/347/275/256-/346/230/276/347/244/272/350/276/271/346/241/206/357/274/210ShowBorder/357/274/211.md

@@ -0,0 +1,32 @@
+# 显示边框（ShowBorder）
+
+## Enumeration Members
+
+------
+
+### Default
+
+Default= 2 
+
+默认
+
+------
+
+####Off
+
+Off =1
+
+不显示边框
+
+------
+
+### On
+
+On= 0
+
+显示边框
+
+------
+
+### 
+

package/docs/web/347/253/257//351/205/215/347/275/256-/350/247/206/345/233/276/351/200/211/351/241/271/357/274/210viewerOptions/357/274/211.md

@@ -0,0 +1,144 @@
+# 视图选项（viewerOptions）
+
+## Properties
+
+------
+
+### background: string|number[]
+
+**功能描述**：视图的背景，可传3位、6位、12位的RGB number类型数组或图片地址。
+
+------
+
+### **components**: Object
+
+**功能描述**：构件配置。
+
+**类型声明**
+
+| 参数名称                          | 参数类型                                                     | 是否必填 | 参数描述                                                 |
+| --------------------------------- | ------------------------------------------------------------ | -------- | -------------------------------------------------------- |
+| bottomToolbarButtons              | { active: boolean ; clickFun: () => void ; icon: string ; title: string  }[] | 否       | 底部工具栏配置                                           |
+| compass                           | { position?: {} ; visible?: boolean  }                       | 否       | 罗盘配置                                                 |
+| compass.position                  | {}                                                           | 否       | 罗盘位置                                                 |
+| compass.visible                   | boolean                                                      | 否       | 罗盘的可见性                                             |
+| contextMenu                       | { buttons?: ButtonConfig[] ; selectedButtons?: ButtonConfig[] ; visible?: boolean  } | 否       | 右键菜单配置                                             |
+| contextMenu.buttons               | ButtonConfig[]                                               | 否       | 选中构件前的按钮列表                                     |
+| contextMenu.selectedButtons       | ButtonConfig[]                                               | 否       | 选中构件后的按钮列表                                     |
+| contextMenu.visible               | boolean                                                      | 否       | 右键菜单的可见性                                         |
+| loading                           | { background?: string ; visible?: boolean  }                 | 否       | 加载弹框配置                                             |
+| loading.background                | string                                                       | 否       | 加载弹框颜色                                             |
+| loading.visible                   | boolean                                                      | 否       | 加载弹框的可见性                                         |
+| property                          | { tabs?: { component: any ; name: string  }[]  }             | 否       | 属性框配置                                               |
+| property.tabs                     | { component: any ; name: string  }[]                         | 否       | 属性框tab                                                |
+| roamToolbar                       | { buttons?: { active: boolean ; clickFun: () => void ; icon: string ; title: string  }[] ; pathRoam?: { visible?: boolean  }  } | 否       | 漫游工具栏配置                                           |
+| roamToolbar.buttons               | { active: boolean ; clickFun: () => void ; icon: string ; title: string  }[] | 否       | 拓展工具栏按钮                                           |
+| roamToolbar.pathRoam              | { visible?: boolean  }                                       | 否       | 路径漫游面板的路径                                       |
+| roamToolbar.pathRoam.visible      | boolean                                                      | 否       | 漫游工具栏的可见性                                       |
+| structureTree                     | { activeTabName?: string ; clickFun?: (data: TreeNodeObject) => void ; defaultTab?: { checkFun?: (data: TreeNodeObject, __namedParameters: Object) => void ; clickFun?: (data: TreeNodeObject) => void ; visible?: boolean  } ; tabClickFun?: (data: any) => void ; tabs?: { component: any ; name: string  }[]  } | 否       | 结构树配置                                               |
+| structureTree.activeTabName       | string                                                       | 否       | 当前激活的Tab名字                                        |
+| structureTree.clickFun            | (data: TreeNodeObject) => void                               | 否       | 默认Tab结构树点击方法，已弃用，建议用defaultTab.clickFun |
+| structureTree.defaultTab          | { checkFun?: (data: TreeNodeObject, __namedParameters: Object) => void ; clickFun?: (data: TreeNodeObject) => void ; visible?: boolean  } | 否       | 默认Tab配置                                              |
+| structureTree.defaultTab.checkFun | (data: TreeNodeObject, __namedParameters: Object) => void    | 否       | 默认Tab结构树节点显示隐藏方法                            |
+| structureTree.defaultTab.clickFun | (data: TreeNodeObject) => void                               | 否       | 默认Tab结构树节点点击方法                                |
+| structureTree.defaultTab.visible  | boolean                                                      | 否       | 是否显示默认Tab                                          |
+| structureTree.tabClickFun         | (data: any) => void                                          | 否       | 切换Tab的回调函数                                        |
+| structureTree.tabs                | { component: any ; name: string  }[]                         | 否       | 拓展Tabs配置                                             |
+
+------
+
+### **displayEffect**: Object
+
+**功能描述**：显示效果配置。
+
+**类型声明**
+
+| 参数名称   | 参数类型   | 是否必填 | 参数描述         |
+| :--------- | ---------- | -------- | ---------------- |
+| ambient    | number     | 否       | 模型曝光度       |
+| showBorder | ShowBorder | 否       | 模型是否显示线框 |
+
+------
+
+### elementId: string
+
+**功能描述**：元素Id，视图所在的html元素。
+
+------
+
+### events: Object
+
+**功能描述**：事件设置。
+
+**类型声明**
+
+| 参数名称            | 参数类型     | 是否必填 | 参数描述         |
+| :------------------ | ------------ | -------- | ---------------- |
+| lButtonState        | LButtonState | 否       | 鼠标左键状态     |
+| mouseWheelDirection | boolean      | 否       | 鼠标中键滚动方向 |
+
+------
+
+### fileService: string
+
+**功能描述**：请求文件的后台地址。
+
+------
+
+### isShowLoading: boolean
+
+**功能描述**：是否显示加载转动图标。
+
+------
+
+### modelService: string
+
+**功能描述**：请求模型的后台地址。
+
+------
+
+### renderingOptions: Object
+
+**功能描述**：模型渲染配置。
+
+**类型声明**
+
+| 参数名称               | 参数类型 | 是否必填 | 参数描述   |
+| ---------------------- | -------- | -------- | ---------- |
+| logarithmicDepthBuffer | boolean  | 否       | 重合面优化 |
+
+------
+
+### styles: Object
+
+**功能描述**：样式设置。
+
+**类型声明**
+
+| 参数名称         | 参数类型                                    | 是否必填 | 参数描述     |
+| ---------------- | ------------------------------------------- | -------- | ------------ |
+| panel            | { background?: string ; opacity?: number  } | 否       | 板的样式设置 |
+| panel.background | string                                      | 否       | 板背景颜色   |
+| panel.opacity    | number                                      | 否       | 板不透明度   |
+
+------
+
+### tag: string
+
+**功能描述**：用以筛选不同加载方式下的视点、碰撞、漫游数据，可传项目id作区分。
+
+------
+
+### toolbarVisible: ToolbarVisible
+
+**功能描述**：底部按钮显示隐藏控制。
+
+------
+
+### viewerType: ViewerType
+
+**功能描述**：视图类型，区分模型加载方式。
+
+------
+
+### 

package/docs//345/212/240/350/275/275/346/230/276/347/244/272/346/250/241/345/236/213.md

@@ -0,0 +1,99 @@
+# 加载显示模型
+
+要显示一个模型首先需要先加载 BimAir 的全部依赖，调用 `BimAir.Loader()` 加载 Longan 内核的和其他必要的文件，在 `BimAir.Loader()` 返回的 Promise 内创建一个 `BimAir.Viewer` 来作为承载模型的容器，最后执行 `viewer.loadModels()` 请求加载模型
+
+## 加载依赖
+
+```js
+BimAir.Loader({
+  /**
+   * 配置是否开启SharedArrayBuffer，若关闭，viewer.isUpdateTt 需要同步设 false，
+   * 若开启，则需要在请求头添加以下两行
+   * "Cross-Origin-Embedder-Policy": *"require-corp",
+   * "Cross-Origin-Opener-Policy": "same-origin",
+   */
+  isShareArrayBuffer: false,
+  url: "https://static.graphicstone.com/bimAir", // url 是 longan依赖文件路径前缀，若文件已放到 /public/js 则不需要设置，函数内部拼成的完整url实际是 https://static.graphicstone.com/bimAir/js/longan/longan.js
+  isInitDataBase: false, //通常我们会在创建 Viewer 的时候执行 InitDataBase 初始化图形数据库，如果你不需要创建 Viewer 而想要直接管理数据，可提前 InitDataBase
+});
+```
+
+完整配置可查看[Options](./配置/LoaderOptions.md)
+
+## 创建 Viewer 容器
+
+三维模型需要显示在一个容器上，Viewer 就是一个通过 id 与 html 元素绑定的容器。
+
+```js
+let options = {
+  elementId: "viewer", //与html元素的id一致
+  modelService: "https://static.graphicstone.com/modelApi", //模型加载的后台服务
+  fileService: "https://static.graphicstone.com/fileApi", //文件管理的后台服务
+};
+let viewer = new BimAir.Viewer(options);
+```
+
+完整配置可查看[Options](./配置/Options.md)
+
+## 加载模型
+
+创建完 viewer 后需要通过 loadModels 加载模型，需要传入模型 id 和模型版本，版本可不传，默认为当前版本
+
+```js
+viewer.loadModels([{ id: "6253e9d6b0545a0a6e49bf85", version: 0 }], true, true);
+```
+
+完整接口可查看[Viewer.loadModels](./classes/Viewer.md#loadmodels)
+
+#### 完整例子
+
+```html
+<template>
+  <div id="app">
+    <div id="viewerWrapper">
+      <viewer-wrapper elementId="viewer"></viewer-wrapper>
+    </div>
+  </div>
+</template>
+<script>
+  import Vue from "vue";
+  import BimAir from "gs-bim-air";
+  import "gs-bim-air/lib/BimAir.css";
+
+  Vue.use(BimAir.ViewerWrapper);
+
+  export default {
+    name: "App",
+    components: {},
+    methods: {},
+
+    mounted() {
+      let options = {
+        elementId: "viewer",
+        modelService: "https://static.graphicstone.com/modelApi",
+        fileService: "https://static.graphicstone.com/fileApi",
+      };
+
+      BimAir.Loader().then(() => {
+        let viewer = new BimAir.Viewer(options);
+
+        viewer.loadModels(["6253e9d6b0545a0a6e49bf85"]).then(() => {
+          viewer.fitWorld();
+        });
+      });
+    },
+  };
+</script>
+
+<style>
+  #app {
+    margin: 0;
+    padding: 0;
+    height: 100vh;
+  }
+
+  #viewerWrapper {
+    height: 100vh;
+  }
+</style>
+```