cbim-render-webgl-sdk
Version:
渲染SDK-WebGL版本
44 lines (39 loc) • 2.02 kB
Markdown
## 渲染SDK
```shell
npm i cbim-render-webgl-sdk -S
```
```html
<div id="containerId"></div>
```
```javascript
import RenderViewer from 'cbim-render-webgl-sdk'
const renderViewer = new RenderViewer('containerId', {
customLoading: false,
loadingSrc: '/static/image/loading.png',
performanceMethod: 'instancedMesh',
decoderPath: '/static/draco/',
clearColor: '#eeeeee'
}, (e) => {
// 引擎返回数据,例如加载进度、错误消息等
})
// 加载或替换模型
renderViewer.loadModel('/models/sz/main.gltf', {rotation: {x: -Math.PI / 2, y: 0, z: 0}})
```
## 参数说明
### OptionConfig 引擎参数
| 属性 | 说明 | 类型 | 默认值 | 备注 | 必填 |
| :--- | :--- | :---: | :---: | :--- | :---: |
|modelPath|初始化时加载模型|String|-|如果无需调整位置、旋转角度就能正确显示的模型可以使用|否|
|customLoading|自定义加载动画|Boolean|false|-|否|
|loadingSrc|加载动画(图片)地址|String|"/static/image/loading.png"|-|否|
|performanceMethod|优化方式|String|"instancedMesh"|可选:"instancedMesh", "mergedMesh", ""|否|
|clearColor|纯色背景颜色|String|'#C0CECE'|HEX颜色值|否|
|decoderPath|解码器地址|String|-|解码器地址需要将解码器文件放到网络可访问的目录|否(如果需要加载ifc模型则为必传)|
### 解码器压缩包地址
* [解码器压缩包](https://ren3.cbim.org.cn/v2/download/group1/M00/07/84/wKgAHGci7xKAN7-3ABS-tQxPh8w842.zip)
* [~~解码器压缩包~~ (v1.0.37)](https://ren.cbim.org.cn/v2/download/group2/M00/00/B4/rBDJS2bX9YyARtqfABS3uxCuUpY882.zip)
* [~~解码器压缩包~~ (version v1.0.24 - v1.0.37)](https://ren.cbim.org.cn/v2/download/group2/M00/00/E3/rBDJSWbL5EKAW-9VABObDFauM2E297.zip)
* [~~解码器压缩包~~ (sdk 版本小于1.0.24)](https://ren.cbim.org.cn/v2/download/group2/M00/00/8D/rBDJS2YCPjKAGlODAAxySCsqbrk183.zip)
```
将解码器解压到项目静态资源文件夹下,例如/static/draco,并设置decoderPath: '/static/draco/'
```