gs-bim-air 0.1.3-0.37 → 0.1.3-0.38

package/docs/.vuepress/config.js

@@ -8,6 +8,7 @@ module.exports = {
     lineNumbers: true,
   },
   dest: "public/docsHtml",
+  home: "/快速上手/",
   themeConfig: {
     sidebarDepth: 2,
     smoothScroll: true,
@@ -22,7 +23,7 @@ module.exports = {
     sidebar: [
       {
         title: "简介",
-        collapsable: true,
+        collapsable: false,
         children: ["/简介.md"],
       },
       {
@@ -66,7 +67,6 @@ module.exports = {
           },
         ],
       },
-
       {
         title: "BimAir文档",
         collapsable: false,

package/docs/classes/Longan.BaseShader.md

@@ -40,6 +40,7 @@
 - [customBlinnPhong](Longan.BaseShader.md#customblinnphong)
 - [customEdgeFragment](Longan.BaseShader.md#customedgefragment)
 - [customTextureSampling](Longan.BaseShader.md#customtexturesampling)
+- [customVertexPos](Longan.BaseShader.md#customvertexpos)
 - [fragment](Longan.BaseShader.md#fragment)
 - [fragmentIn](Longan.BaseShader.md#fragmentin)
 - [fragmentMain](Longan.BaseShader.md#fragmentmain)
@@ -54,6 +55,7 @@
 - [vertexMain](Longan.BaseShader.md#vertexmain)
 - [vertexOut](Longan.BaseShader.md#vertexout)
 - [vertexUniform](Longan.BaseShader.md#vertexuniform)
+- [vertexVoid](Longan.BaseShader.md#vertexvoid)
 
 ### Methods
 
@@ -83,9 +85,9 @@
 
 ### \_fragment
 
-• **\_fragment**: `string`
+• **\_fragment**: `string` = `null`
 
-#### Overrides
+#### Inherited from
 
 [Shader](Longan.Shader.md).[_fragment](Longan.Shader.md#_fragment)
 
@@ -143,9 +145,9 @@ ___
 
 ### \_vertex
 
-• **\_vertex**: `string`
+• **\_vertex**: `string` = `null`
 
-#### Overrides
+#### Inherited from
 
 [Shader](Longan.Shader.md).[_vertex](Longan.Shader.md#_vertex)
 
@@ -239,6 +241,16 @@ ___
 
 ___
 
+### customVertexPos
+
+• `get` **customVertexPos**(): `string`
+
+#### Returns
+
+`string`
+
+___
+
 ### fragment
 
 • `get` **fragment**(): `string`
@@ -247,7 +259,7 @@ ___
 
 `string`
 
-#### Inherited from
+#### Overrides
 
 Shader.fragment
 
@@ -403,7 +415,7 @@ ___
 
 `string`
 
-#### Inherited from
+#### Overrides
 
 Shader.vertex
 
@@ -437,6 +449,16 @@ ___
 
 `string`
 
+___
+
+### vertexVoid
+
+• `get` **vertexVoid**(): `string`
+
+#### Returns
+
+`string`
+
 ## Methods
 
 ### finaComponent

package/docs/classes/Longan.Viewer.md

@@ -99,6 +99,7 @@
 - [sceneKey](Longan.Viewer.md#scenekey)
 - [sceneSegment](Longan.Viewer.md#scenesegment)
 - [screenSegment](Longan.Viewer.md#screensegment)
+- [selectDistanceTolerance](Longan.Viewer.md#selectdistancetolerance)
 - [selectionManager](Longan.Viewer.md#selectionmanager)
 - [selectionTolerance](Longan.Viewer.md#selectiontolerance)
 - [smoothTransition](Longan.Viewer.md#smoothtransition)
@@ -1211,6 +1212,28 @@ ___
 
 ___
 
+### selectDistanceTolerance
+
+• `get` **selectDistanceTolerance**(): `number`
+
+#### Returns
+
+`number`
+
+• `set` **selectDistanceTolerance**(`selectDistanceTolerance`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `selectDistanceTolerance` | `number` |
+
+#### Returns
+
+`void`
+
+___
+
 ### selectionManager
 
 • `get` **selectionManager**(): [`SelectionManager`](Longan.SelectionManager.md)

package/docs/classes/Viewer.md

@@ -109,6 +109,7 @@
 - [sceneKey](Viewer.md#scenekey)
 - [sceneSegment](Viewer.md#scenesegment)
 - [screenSegment](Viewer.md#screensegment)
+- [selectDistanceTolerance](Viewer.md#selectdistancetolerance)
 - [selectionManager](Viewer.md#selectionmanager)
 - [selectionTolerance](Viewer.md#selectiontolerance)
 - [smoothTransition](Viewer.md#smoothtransition)
@@ -1565,6 +1566,36 @@ LonganViewer.screenSegment
 
 ___
 
+### selectDistanceTolerance
+
+• `get` **selectDistanceTolerance**(): `number`
+
+#### Returns
+
+`number`
+
+#### Inherited from
+
+LonganViewer.selectDistanceTolerance
+
+• `set` **selectDistanceTolerance**(`selectDistanceTolerance`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `selectDistanceTolerance` | `number` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+LonganViewer.selectDistanceTolerance
+
+___
+
 ### selectionManager
 
 • `get` **selectionManager**(): [`SelectionManager`](SelectionManager.md)

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

@@ -1,35 +1,45 @@
-# 快速上手
+# 加载显示模型
 
-## 安装
+要显示一个模型首先需要先加载 BimAir 的全部依赖，调用 `BimAir.Loader()` 加载 Longan 内核的和其他必要的文件，在 `BimAir.Loader()` 返回的 Promise 内创建一个 `BimAir.Viewer` 来作为承载模型的容器，最后执行 `viewer.loadModels()` 请求加载模型
 
-### NPM
+## 加载依赖
 
+```js
+BimAir.Loader({
+  isShareArrayBuffer: false, // 配置是否开启SharedArrayBuffer，若关闭，viewer.isUpdateTt 需要同步设 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
+});
 ```
-# 最新稳定版
-$ npm install gs-bim-air
+
+完整配置可查看[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)
+
+## 加载模型
 
-从 gs-bim-air 安装包里的 public 文件夹复制 js 文件夹到 Vue 项目的静态资源目录（通常为 public 目录），复制后路径为：
+创建完 viewer 后需要通过 loadModels 加载模型，需要传入模型 id 和模型版本，版本可不传，默认为当前版本
 
-> public\js\fonts\微软雅黑.ttf
->
-> public\js\longan\longan.js
-> public\js\longan\longan.wasm
-> public\js\longan\longan.worker.js
->
-> public\js\longanWithoutShareArrayBuffer\longan.js
-> public\js\longanWithoutShareArrayBuffer\longan.wasm
->
-> public\js\lzma\lzma.js
-> public\js\lzma\lzma.shim.js
-> public\js\lzma\lzmap.js
-> public\js\lzma\pwlzma.js
-> public\js\lzma\wlzma.js
-> public\js\lzma\wlzma.wrk.js
+```js
+viewer.loadModels([{ id: "6253e9d6b0545a0a6e49bf85", version: 0 }], true, true);
+```
 
-#### vue 用法
+完整接口可查看[Viewer.loadModels](./classes/Viewer.md#loadmodels)
+
+#### 完整例子
 
 ```html
 <template>
@@ -81,59 +91,3 @@ $ npm install gs-bim-air
   }
 </style>
 ```
-
-### 直接用 &lt;script&gt; 引入
-
-```html
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="UTF-8" />
-    <title>引入BimAir</title>
-    <link
-      rel="stylesheet"
-      href="https://static.graphicstone.com/bimAir/BimAir.css"
-    />
-    <script src="https://static.graphicstone.com/vue.min.js"></script>
-    <script src="https://static.graphicstone.com/bimAir/BimAir.umd.min.js"></script>
-  </head>
-
-  <body>
-    <style>
-      body {
-        margin: 0;
-        padding: 0;
-        height: 100vh;
-      }
-
-      #app {
-        height: 100vh;
-        position: relative;
-      }
-    </style>
-    <div id="app">
-      <viewer-wrapper elementId="viewer" style="height: 100%; width: 100%" />
-    </div>
-
-    <script type="text/javascript">
-      new Vue({
-        el: "#app",
-      });
-
-      let options = {
-        elementId: "viewer",
-        modelService: "https://static.graphicstone.com/modelApi",
-        fileService: "https://static.graphicstone.com/fileApi",
-      };
-      BimAir.Loader({ url: "https://static.graphicstone.com/bimAir" }).then(
-        () => {
-          let viewer = new BimAir.Viewer(options);
-          let modelId = "624fff10aba44c07ef4b184e";
-          viewer.loadModels(["624fff10aba44c07ef4b184e"]);
-          viewer.fitWorld();
-        }
-      );
-    </script>
-  </body>
-</html>
-```

package/docs//345/277/253/351/200/237/344/270/212/346/211/213.md

@@ -3,121 +3,137 @@
 ## 安装
 
 ### NPM
+
 ```
 # 最新稳定版
 $ npm install gs-bim-air
 ```
 
 #### 添加静态资源
-从gs-bim-air安装包里复的public文件夹复制js文件夹到Vue项目的静态资源目录（通常为public目录），复制后路径为：
 
-> public\js\lzma\lzma.js
+从 gs-bim-air 安装包里复的 public 文件夹复制 js 文件夹到 Vue 项目的静态资源目录（通常为 public 目录），复制后路径为：
 
+> public\js\fonts\微软雅黑.ttf
+>
+> public\js\longan\longan.js
+> public\js\longan\longan.wasm
+> public\js\longan\longan.worker.js
+>
 > public\js\longanWithoutShareArrayBuffer\longan.js
 > public\js\longanWithoutShareArrayBuffer\longan.wasm
+>
+> public\js\lzma\lzma.js
+> public\js\lzma\lzma.shim.js
+> public\js\lzma\lzmap.js
+> public\js\lzma\pwlzma.js
+> public\js\lzma\wlzma.js
+> public\js\lzma\wlzma.wrk.js
+
+#### vue 用法
 
-#### vue用法
 ```html
 <template>
-<div id="app">
+  <div id="app">
     <div id="viewerWrapper">
-      <viewer-wrapper elementId="viewer" ></viewer-wrapper>
+      <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();
+  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;
-}
+  #app {
+    margin: 0;
+    padding: 0;
+    height: 100vh;
+  }
+
+  #viewerWrapper {
+    height: 100vh;
+  }
 </style>
 ```
 
 ### 直接用 &lt;script&gt; 引入
+
 ```html
 <!DOCTYPE html>
 <html>
-<head>
-    <meta charset="UTF-8">
+  <head>
+    <meta charset="UTF-8" />
     <title>引入BimAir</title>
-    <link rel="stylesheet" href="https://static.graphicstone.com/bimAir/BimAir.css">
+    <link
+      rel="stylesheet"
+      href="https://static.graphicstone.com/bimAir/BimAir.css"
+    />
     <script src="https://static.graphicstone.com/vue.min.js"></script>
     <script src="https://static.graphicstone.com/bimAir/BimAir.umd.min.js"></script>
-</head>
+  </head>
 
-<body>
+  <body>
     <style>
-        body {
-            margin: 0;
-            padding: 0;
-            height: 100vh;
-        }
-
-        #app {
-            height: 100vh;
-            position: relative;
-        }
+      body {
+        margin: 0;
+        padding: 0;
+        height: 100vh;
+      }
+
+      #app {
+        height: 100vh;
+        position: relative;
+      }
     </style>
     <div id="app">
-        <viewer-wrapper elementId="viewer" style="height: 100%; width: 100%" />
+      <viewer-wrapper elementId="viewer" style="height: 100%; width: 100%" />
     </div>
 
     <script type="text/javascript">
-        new Vue({
-            el: '#app',
-        });
+      new Vue({
+        el: "#app",
+      });
 
-        let options = {
-            elementId: "viewer",
-            modelService: "https://static.graphicstone.com/modelApi",
-            fileService: "https://static.graphicstone.com/fileApi",
+      let options = {
+        elementId: "viewer",
+        modelService: "https://static.graphicstone.com/modelApi",
+        fileService: "https://static.graphicstone.com/fileApi",
+      };
+      BimAir.Loader({ url: "https://static.graphicstone.com/bimAir" }).then(
+        () => {
+          let viewer = new BimAir.Viewer(options);
+          let modelId = "624fff10aba44c07ef4b184e";
+          viewer.loadModels(["624fff10aba44c07ef4b184e"]);
+          viewer.fitWorld();
         }
-        BimAir.Loader({ url: "https://static.graphicstone.com/bimAir" }).then(() => {
-            let viewer = new BimAir.Viewer(options)
-            let modelId = "624fff10aba44c07ef4b184e";
-            viewer.loadModels(["624fff10aba44c07ef4b184e"])
-            viewer.fitWorld();
-        })
+      );
     </script>
-</body>
+  </body>
 </html>
 ```
-
-
-