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

package/docs/web/347/253/257//345/212/240/350/275/275-/350/247/206/345/233/276/357/274/210Viewer/357/274/211.md

@@ -0,0 +1,2272 @@
+# 视图（Viewer）
+
+## Constructors
+
+------
+
+### • new Viewer(containerId)
+
+**功能描述**：创建视图。
+
+**请求体参数**
+
+| 参数名称    | 参数类型 | 是否必填 | 参数描述 |
+| :---------- | -------- | -------- | -------- |
+| containerId | string   | 是       | 容器id   |
+
+------
+
+## Properties
+
+------
+
+### aysnTaskManager: AysnTaskManager
+
+**功能描述**：异步任务管理器。
+
+------
+
+### canvas: HTMLCanvasElement
+
+**功能描述**：画布。
+
+------
+
+### collisionComputed: List<Function\>
+
+**功能描述**：碰撞计算。
+
+------
+
+### collisionComputing: List<Function\>
+
+**功能描述**：碰撞计算。
+
+------
+
+### container: HTMLElement
+
+**功能描述**：container容器。
+
+------
+
+### documentChanged: List<Function\>
+
+**功能描述**：文档更改。
+
+------
+
+### geometryDrawFinish: List<Function\>
+
+**功能描述**：几何绘制完成。
+
+------
+
+### geometryItem: List<Function\>
+
+**功能描述**：几何项。
+
+------
+
+### geometryItems: List<Function\>
+
+**功能描述**：几何项集合。
+
+------
+
+### getAsynGroupGeoDataAction
+
+**功能描述**：获取异步几何组数据操作。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述   |
+| :------- | -------- | -------- | ---------- |
+| modelId  | string   | 是       | 模型id     |
+| version  | number   | 是       | 模型版本号 |
+
+**返回参数**
+
+`Object `
+
+| 参数名称 | 参数类型 | 参数描述 |
+| :------- | -------- | -------- |
+| httpType | string   | 请求类型 |
+| url      | string   | 请求url  |
+
+------
+
+### getAsynImageAction: Object
+
+**功能描述**：获取异步图像操作。
+
+**类型声明**
+
+| 参数名称 | 参数类型 | 参数描述 |
+| -------- | -------- | -------- |
+| httpType | string   | 请求类型 |
+| url      | string   | 请求url  |
+
+------
+
+### gl: WebGL2RenderingContext
+
+**功能描述**：WebGL2渲染上下文。
+
+------
+
+### imageUrls: Object = {}
+
+**功能描述**：图像url。
+
+------
+
+### instanceModelChanged: List<() => void>
+
+**功能描述**：实例模型更改。
+
+------
+
+### isFixFrameRender: boolean = true
+
+**功能描述**：是否FixFrame（固定帧）渲染。
+
+------
+
+### isGeometryLoading: boolean=true
+
+**功能描述**：是否有几何数据正在通过updateDisplay（刷新图形渲染）进行加载。
+
+------
+
+### keyDown: boolean = false
+
+**功能描述**：键盘按下。
+
+------
+
+### lButtonDown: boolean = false
+
+**功能描述**：鼠标左键点击。
+
+------
+
+### mButtonDown: boolean = false
+
+**功能描述**：鼠标中间点击。
+
+------
+
+### maxMemoryFactor: number = 0.8
+
+**功能描述**：最大内存系数。
+
+------
+
+### modelDebug: boolean = false
+
+**功能描述**：模型调试。
+
+------
+
+### name: string
+
+**功能描述**：名称。
+
+------
+
+### onComputeCollisionFinished: NumberKeyList<(item: []) => void>
+
+**功能描述**：碰撞计算是否完成。
+
+------
+
+### onKeyDown: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：键盘按下。
+
+------
+
+### onKeyPress: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：键盘按住。
+
+------
+
+### onKeyUp: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：键盘松开。
+
+------
+
+### onLButtonDown: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：鼠标左键点击。
+
+------
+
+### onLButtonDownAndMove: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：左键点击并鼠标移动。
+
+------
+
+### onLButtonUp: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：鼠标左键松开。
+
+------
+
+### onMButtonDown: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：鼠标中键点击。
+
+------
+
+### onMButtonDownAndMove: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：右键点击并鼠标移动。
+
+------
+
+### onMButtonUp: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：鼠标中键松开。
+
+------
+
+### onMouseMove: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：鼠标移动。
+
+------
+
+### onMouseWheel: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：鼠标中键滚轮滚动。
+
+------
+
+### onRButtonDown: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：鼠标右键点击。
+
+------
+
+### onRButtonDownAndMove: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：中键点击并鼠标移动
+
+------
+
+### onRButtonUp: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：鼠标右键松开。
+
+------
+
+### onTouchCancel: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：触摸取消。
+
+------
+
+### onTouchEnd: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：触摸结束。
+
+------
+
+### onTouchMove: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：触摸移动。
+
+------
+
+### onTouchStart: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：触摸开始。
+
+------
+
+### onWindowKeyDown: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：全局键盘按下。
+
+------
+
+### onWindowKeyPress: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：全局键盘长按。
+
+------
+
+### onWindowKeyUp: List<(sender: Viewer, event: ViewerEvent) => void>
+
+**功能描述**：全局键盘松开。
+
+------
+
+### operatorManager: OperatorManager
+
+**功能描述**：操作管理器。
+
+------
+
+### process: Process
+
+**功能描述**：进程。
+
+------
+
+### rButtonDown: boolean = false
+
+**功能描述**：右键点击。
+
+------
+
+### renderViewAll: boolean = false
+
+**功能描述**：绘制所有（鼠标操作忙碌时会只绘制一部分图形 ，需要先绘制所有）。
+
+------
+
+### sceneCameraChanged: List<Function\>
+
+**功能描述**：场景摄像机更改完毕。
+
+------
+
+### sceneCameraChanging: List<Function\>
+
+**功能描述**：场景摄像机更改。
+
+------
+
+### synchronManager: SynchronManager
+
+**功能描述**：同步管理器。
+
+------
+
+### touching: boolean = false
+
+**功能描述**：触摸。
+
+------
+
+### zoomLimit: number = 0.000001
+
+**功能描述**：缩放限制。
+
+------
+
+
+
+## Accessors
+
+------
+
+### apectRatio
+
+• `get` **aspectRatio**(): `number` 
+
+**功能描述**：获取屏幕高宽比。
+
+**返回参数**
+
+`number`
+
+------
+
+• `set` **aspectRatio**(`aspectRatio`): `void` 
+
+**功能描述**：设置屏幕高宽比。
+
+**请求体参数**
+
+| 参数名称    | 参数类型 | 是否必填 | 参数描述   |
+| :---------- | -------- | -------- | ---------- |
+| aspectRatio | number   | 是       | 屏幕高宽比 |
+
+**返回参数**
+
+`void`
+
+------
+
+### backgroundColor
+
+• `get` **backgroundColor**(): `ArrayLike`<`number`> 
+
+**功能描述**：获取背景颜色。
+
+**返回参数**
+
+`ArrayLike`<`number`> 
+
+------
+
+• `set` **backgroundColor**(`val`): `void` 
+
+**功能描述**：设置背景颜色。
+
+**请求体参数**
+
+| 参数名称 | 参数类型           | 是否必填 | 参数描述 |
+| :------- | ------------------ | -------- | -------- |
+| val      | ArrayLike<number\> | 是       | rgba值   |
+
+**返回参数**
+
+`void`
+
+------
+
+### backgroundImage
+
+• `set` **backgroundImage**(`imageSrc`): `void` 
+
+**功能描述**：设置背景图片。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| imageSrc | string   | 是       | 图片路径 |
+
+**返回参数**
+
+`void`
+
+------
+
+### cameraOrientationFixed
+
+• `get` **cameraOrientationFixed**(): `boolean` 
+
+**功能描述**：获取相机方向是否固定。
+
+**返回参数**
+
+`boolean `
+
+------
+
+• `set` **cameraOrientationFixed**(`val`): `void` 
+
+**功能描述**：设置相机方向是否固定。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述                  |
+| :------- | -------- | -------- | ------------------------- |
+| val      | boolean  | 是       | true为固定，false为不固定 |
+
+**返回参数**
+
+`void`
+
+------
+
+### collisionTolerance
+
+• `get` **collisionTolerance**(): `number` 
+
+**功能描述**：获取碰撞容差。
+
+**返回参数**
+
+`number `
+
+------
+
+• `set` **collisionTolerance**(`value`): `void` 
+
+**功能描述**：设置碰撞容差。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述   |
+| :------- | -------- | -------- | ---------- |
+| val      | number   | 是       | 碰撞容差值 |
+
+**返回参数**
+
+`void`
+
+------
+
+### dynamicMemory
+
+• `get` **dynamicMemory**(): `DynamicMemoryType`
+
+**功能描述**：获取内存限制。
+
+**返回参数**
+
+`DynamicMemoryType`
+
+------
+
+• `set` **dynamicMemory**(`type`): `void` 
+
+**功能描述**：设置内存限制。
+
+**请求体参数**
+
+| 参数名称 | 参数类型          | 是否必填 | 参数描述     |
+| :------- | ----------------- | -------- | ------------ |
+| type     | DynamicMemoryType | 是       | 内存限制类型 |
+
+**返回参数**
+
+`void`
+
+------
+
+### dynamicMemoryThreshold
+
+• `get` **dynamicMemoryThreshold**(): `number`
+
+**功能描述**：获取内存限制阈值。
+
+**返回参数**
+
+`number`
+
+------
+
+• `set` **dynamicMemoryThreshold**(`value`): `void`
+
+**功能描述**：设置内存限制阈值。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述     |
+| :------- | -------- | -------- | ------------ |
+| value    | number   | 是       | 内存限制阈值 |
+
+**返回参数**
+
+`void`
+
+------
+
+### freeze
+
+• `get` **freeze**(): `boolean`
+
+**功能描述**：获取屏幕是否冻结。
+
+**返回参数**
+
+`boolean`
+
+------
+
+• `set` **freeze**(`value`): `void`
+
+**功能描述**：设置屏幕是否冻结。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述                |
+| :------- | -------- | -------- | ----------------------- |
+| value    | boolean  | 是       | true为冻结，false为解冻 |
+
+**返回参数**
+
+`void`
+
+------
+
+### geoDataIsCompression
+
+• `get` **geoDataIsCompression**(): `boolean`
+
+**功能描述**：获取地理数据是否压缩。
+
+**返回参数**
+
+`boolean`
+
+------
+
+• `set` **geoDataIsCompression**(`value`): `void`
+
+**功能描述**：设置地理数据是否压缩。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述                  |
+| :------- | -------- | -------- | ------------------------- |
+| value    | boolean  | 是       | true为压缩，false为不压缩 |
+
+**返回参数**
+
+`void`
+
+------
+
+### height
+
+• `get` **height**(): `number`
+
+**功能描述**：获取高度。
+
+**返回参数**
+
+`number`
+
+------
+
+• `set` **height**(`value`): `void`
+
+**功能描述**：设置高度。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| value    | number   | 是       | 高度值   |
+
+**返回参数**
+
+`void`
+
+------
+
+### highlightManager
+
+• `get` **highlightManager**(): `HighlightManager`
+
+**功能描述**：获取高亮管理器。
+
+**返回参数**
+
+`HighlightManager`
+
+------
+
+### instanceObject
+
+• `get` **instanceObject**(): `RenderInstanceObject`
+
+**功能描述**：获取实例对象。
+
+**返回参数**
+
+`RenderInstanceObject`
+
+------
+
+• `set` **instanceObject**(`val`): `void`
+
+**功能描述**：设置实例对象。
+
+**请求体参数**
+
+| 参数名称 | 参数类型             | 是否必填 | 参数描述     |
+| :------- | -------------------- | -------- | ------------ |
+| val      | RenderInstanceObject | 是       | 渲染实例对象 |
+
+**返回参数**
+
+`void`
+
+------
+
+### instanceObjectSegment
+
+• `get` **instanceObjectSegment**(): `Segment`
+
+**功能描述**：获取实例对象模型节点。
+
+**返回参数**
+
+`Segment`
+
+------
+
+### invisibleManager
+
+• `get` **invisibleManager**(): `InvisibleManager`
+
+**功能描述**：获取隐藏管理器。
+
+**返回参数**
+
+`InvisibleManager`
+
+------
+
+### isBusy
+
+• `get` **isBusy**(): `boolean`
+
+**功能描述**：获取当前是否忙碌。
+
+**返回参数**
+
+`boolean`
+
+------
+
+• `set` **isBusy**(`value`): `void`
+
+**功能描述**：设置忙碌状态。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述                |
+| :------- | -------- | -------- | ----------------------- |
+| value    | boolean  | 是       | true为忙碌，false为空闲 |
+
+**返回参数**
+
+`void`
+
+------
+
+### isCache
+
+• `get` **isCache**(): `boolean`
+
+**功能描述**：获取当前是否开启缓存。
+
+**返回参数**
+
+`boolean`
+
+------
+
+• `set` **isCache**(`value`): `void`
+
+**功能描述**：设置是否开启缓存。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述                |
+| :------- | -------- | -------- | ----------------------- |
+| value    | boolean  | 是       | true为开启，false为关闭 |
+
+**返回参数**
+
+`void`
+
+------
+
+### isSharedArrayBuffer
+
+• `get` **isSharedArrayBuffer**(): `boolean`
+
+**功能描述**：获取当前是否开启SharedArrayBuffer（共享内存）。
+
+**返回参数**
+
+`boolean`
+
+------
+
+• `set` **isSharedArrayBuffer**(`value`): `void`
+
+**功能描述**：设置SharedArrayBuffer（共享内存）状态。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述                |
+| :------- | -------- | -------- | ----------------------- |
+| value    | boolean  | 是       | true为开启，false为关闭 |
+
+**返回参数**
+
+`void`
+
+------
+
+### isUpdateTt
+
+• `get` **isUpdateTt**(): `boolean`
+
+**功能描述**：获取当前是否使用多线程。
+
+**返回参数**
+
+`boolean`
+
+------
+
+• `set` **isUpdateTt**(`value`): `void`
+
+**功能描述**：设置是否使用多线程。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述                |
+| :------- | -------- | -------- | ----------------------- |
+| value    | boolean  | 是       | true为开启，false为关闭 |
+
+**返回参数**
+
+`void`
+
+------
+
+### isolationManager
+
+• `get` **isolationManager**(): `IsolationManager`
+
+**功能描述**：隔离管理器。
+
+**返回参数**
+
+`IsolationManager`
+
+------
+
+### lightingMode
+
+• `get` **lightingMode**(): `LightingMode`
+
+**功能描述**：获取照明模式。
+
+**返回参数**
+
+`LightingMode`
+
+------
+
+• `set` **lightingMode**(`mode`): `void`
+
+**功能描述**：设置照明模式。
+
+**请求体参数**
+
+| 参数名称 | 参数类型     | 是否必填 | 参数描述 |
+| :------- | ------------ | -------- | -------- |
+| mode     | LightingMode | 是       | 照明模式 |
+
+**返回参数**
+
+`void`
+
+------
+
+### modelKey
+
+• `get` **modelKey**(): `number`
+
+**功能描述**：获取模型的标识。
+
+**返回参数**
+
+`number`
+
+------
+
+### modelSegment
+
+• `get` **modelSegment**(): `Segment`
+
+**功能描述**：获取模型节点。
+
+**返回参数**
+
+`Segment`
+
+------
+
+### renderObject
+
+• `get` **renderObject**(): `RenderObject`
+
+**功能描述**：获取渲染对象。
+
+**返回参数**
+
+`RenderObject`
+
+------
+
+• `set` **renderObject**(`value`): `void`
+
+**功能描述**：设置渲染对象。
+
+**请求体参数**
+
+| 参数名称 | 参数类型     | 是否必填 | 参数描述 |
+| :------- | ------------ | -------- | -------- |
+| value    | RenderObject | 是       | 渲染对象 |
+
+**返回参数**
+
+`void`
+
+------
+
+### renderViewPerGroup
+
+• `get` **renderViewPerGroup**(): `number`
+
+**功能描述**：按组获取渲染视图。
+
+**返回参数**
+
+`number`
+
+------
+
+• `set` **renderViewPerGroup**(`value`): `void`
+
+**功能描述**：按组设置渲染视图。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| value    | number   | 是       | 组数     |
+
+**返回参数**
+
+`void`
+
+------
+
+### sceneKey
+
+• `get` **sceneKey**(): `number`
+
+**功能描述**：获取屏幕的唯一标识。
+
+**返回参数**
+
+`number`
+
+------
+
+### sceneSegment
+
+• `get` **sceneSegment**(): `Segment`
+
+**功能描述**：获取场景模型渲染结构的节点数据。
+
+**返回参数**
+
+`Segment`
+
+------
+
+### screenSegment
+
+• `get` **screenSegment**(): `Segment`
+
+**功能描述**：获取屏幕模型渲染结构的节点数据。
+
+**返回参数**
+
+`Segment`
+
+------
+
+### selectDistanceTolerance
+
+• `get` **selectDistanceTolerance**(): `number`
+
+**功能描述**：获取距离容差。
+
+**返回参数**
+
+`number`
+
+------
+
+• `set` **selectDistanceTolerance**(`selectDistanceTolerance`): `void`
+
+**功能描述**：设置距离容差。
+
+**请求体参数**
+
+| 参数名称                | 参数类型 | 是否必填 | 参数描述 |
+| :---------------------- | -------- | -------- | -------- |
+| selectDistanceTolerance | number   | 是       | 距离容差 |
+
+**返回参数**
+
+`void`
+
+------
+
+### selectionManager
+
+• `get` **selectionManager**(): `SelectionManager`
+
+**功能描述**：选择管理器。
+
+**返回参数**
+
+`SelectionManager`
+
+------
+
+### selectionTolerance
+
+• `get` **selectionTolerance**(): `number`
+
+**功能描述**：获取选择容差。
+
+**返回参数**
+
+`number`
+
+------
+
+• `set` **selectionTolerance**(`value`): `void`
+
+**功能描述**：设置选择容差。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| value    | number   | 是       | 容差值   |
+
+**返回参数**
+
+`void`
+
+------
+
+### smoothTransition
+
+• `get` **smoothTransition**(): `boolean`
+
+**功能描述**：获取当前是否开启平滑过渡模式。
+
+**返回参数**
+
+`boolean`
+
+------
+
+• `set` **smoothTransition**(`val`): `void`
+
+**功能描述**：设置是否开启平滑过渡模式。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述                |
+| :------- | -------- | -------- | ----------------------- |
+| val      | boolean  | 是       | true为开启，false为关闭 |
+
+**返回参数**
+
+`void`
+
+------
+
+### smoothTransitionDuration
+
+• `get` **smoothTransitionDuration**(): `number`
+
+**功能描述**：获取平滑过渡持续时间。
+
+**返回参数**
+
+`number`
+
+------
+
+• `set` **smoothTransitionDuration**(`duration`): `void`
+
+**功能描述**：设置平滑过渡持续时间。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述         |
+| :------- | -------- | -------- | ---------------- |
+| duration | number   | 是       | 平滑过渡持续时间 |
+
+**返回参数**
+
+`void`
+
+------
+
+### softCollisionDistance
+
+• `get` **softCollisionDistance**(): `number`
+
+**功能描述**：获取软碰撞距离。
+
+**返回参数**
+
+`number`
+
+------
+
+• `set` **softCollisionDistance**(`value`): `void`
+
+**功能描述**：设置软碰撞距离。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述   |
+| :------- | -------- | -------- | ---------- |
+| value    | number   | 是       | 软碰撞距离 |
+
+**返回参数**
+
+`void`
+
+------
+
+### streamToSegmentRunningCount
+
+• `get` **streamToSegmentRunningCount**(): `number`
+
+**功能描述**：获取流到模型的节点的运行计数。
+
+**返回参数**
+
+`number`
+
+------
+
+• `set` **streamToSegmentRunningCount**(`value`): `void`
+
+**功能描述**：设置流到模型节点的运行计数。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述                             |
+| :------- | -------- | -------- | ------------------------------------ |
+| value    | number   | 是       | 流到模型渲染结构的节点数据的运行计数 |
+
+**返回参数**
+
+`void`
+
+------
+
+### styleKey
+
+• `get` **styleKey**(): `number`
+
+**功能描述**：获取样式的唯一标识。
+
+**返回参数**
+
+`number`
+
+------
+
+### styleSegment
+
+• `get` **styleSegment**(): `Segment`
+
+**功能描述**：获取样式专用的模型渲染结构的节点数据。
+
+**返回参数**
+
+`Segment`
+
+------
+
+### testGslId
+
+• `get` **testGslId**(): `string`
+
+**功能描述**：获取Gsl的Id。
+
+**返回参数**
+
+`string`
+
+------
+
+• `set` **testGslId**(`value`): `void`
+
+**功能描述**：设置Gsl的Id。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| value    | string   | 是       | Gsl的id  |
+
+**返回参数**
+
+`void`
+
+------
+
+### threadIsRunning
+
+• `get` **threadIsRunning**(): `boolean`
+
+**功能描述**：获取线程是否正在运行。
+
+**返回参数**
+
+`boolean`
+
+------
+
+### unitLength
+
+• `get` **unitLength**(): `number`
+
+**功能描述**：获取初始化长度。
+
+**返回参数**
+
+`number`
+
+------
+
+### updateType
+
+• `get` **updateType**(): `UpdateType`
+
+**功能描述**：获取更新类型。
+
+**返回参数**
+
+`UpdateType`
+
+------
+
+• `set` **updateType**(`value`): `void`
+
+**功能描述**：设置更新类型。
+
+**请求体参数**
+
+| 参数名称 | 参数类型   | 是否必填 | 参数描述 |
+| :------- | ---------- | -------- | -------- |
+| value    | UpdateType | 是       | 更新类型 |
+
+**返回参数**
+
+`void`
+
+------
+
+### utilitySegment
+
+• `get` **utilitySegment**(): `Segment`
+
+**功能描述**：获取通用的模型渲染结构的节点数据。
+
+**返回参数**
+
+`Segment`
+
+------
+
+### viewKey
+
+• `get` **viewKey**(): `number`
+
+**功能描述**：获取视图的唯一标识。
+
+**返回参数**
+
+`number`
+
+------
+
+### viewObjectSegment
+
+• `get` **viewObjectSegment**(): `Segment`
+
+**功能描述**：获取视图对象的模型渲染结构的节点数据。
+
+**返回参数**
+
+`Segment`
+
+------
+
+### viewSegment
+
+• `get` **viewSegment**(): `Segment`
+
+**功能描述**：获取视图模型渲染结构的节点数据。
+
+**返回参数**
+
+`Segment`
+
+------
+
+### width
+
+• `get` **width**(): `number`
+
+**功能描述**：获取宽度。
+
+**返回参数**
+
+`number`
+
+------
+
+• `set` **width**(`value`): `void`
+
+**功能描述**：设置宽度。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| value    | number   | 是       | 宽度     |
+
+**返回参数**
+
+`void`
+
+------
+
+### 
+
+## **Methods**
+
+------
+
+### asynBatchSetSegmentsDataFromCache
+
+**功能描述**：批量添加模型节点的几何数据。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述               |
+| :------- | -------- | -------- | ---------------------- |
+| segKey   | any      | 是       | 单个模型节点的标识     |
+| bytes    | any      | 是       | 单个模型节点的几何数据 |
+| isLast   | boolean  | 是       | 是否是最后一个模型节点 |
+
+**返回参数**
+
+`void`
+
+------
+
+### asynLoadGeometries
+
+**功能描述**：加载几何图形。
+
+**请求体参数**
+
+| 参数名称 | 参数类型   | 是否必填 | 参数描述           |
+| -------- | ---------- | -------- | ------------------ |
+| asynKey  | Int32Array | 是       | 几何图形的唯一标识 |
+
+**返回参数**
+
+`Promise`<`void`> 
+
+------
+
+### asynRemoveGeometry
+
+**功能描述**：移除几何图形。
+
+**请求体参数**：无
+
+**返回参数**
+
+`void`
+
+------
+
+### asynUpdateView
+
+**功能描述**：更新视图。
+
+**请求体参数**：无
+
+**返回参数**
+
+`void`
+
+------
+
+### checkStreamToGeometryDisable
+
+**功能描述**：判断streamToGeometry（流到几何图形）是否可执行。
+
+**请求体参数**：无
+
+**返回参数**
+
+`boolean`
+
+------
+
+### clearCache
+
+**功能描述**：清除缓存的模型数据。
+
+**请求体参数**：无
+
+**返回参数**
+
+`Promise`<`void`\>
+
+------
+
+### computeBoundingBox
+
+**功能描述**：计算模型节点的包围盒。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述               |
+| :------- | -------- | -------- | ---------------------- |
+| segment  | Segment  | 是       | 模型渲染结构的节点数据 |
+
+**返回参数**
+
+`any`
+
+------
+
+### computeBoundingBoxWithVisibility
+
+**功能描述**：可视性地计算模型节点的包围盒。
+
+**请求体参数**
+
+| 参数名称      | 参数类型    | 是否必填 | 参数描述               |
+| :------------ | ----------- | -------- | ---------------------- |
+| segment       | Segment     | 是       | 需要进行计算的模型节点 |
+| element_types | ElementType | 是       | 元素类型               |
+
+**返回参数**
+
+`Float32Array`
+
+------
+
+### computeCollision
+
+**功能描述**：碰撞计算。
+
+**请求体参数**
+
+| 参数名称         | 参数类型      | 是否必填 | 参数描述             |
+| :--------------- | ------------- | -------- | -------------------- |
+| one              | Segment       | 是       | 碰撞的一个模型节点   |
+| two              | Segment       | 是       | 碰撞的另一个模型节点 |
+| type             | CollisionType | 是       | 碰撞类型             |
+| softDiatance     | number        | 否       | 软碰撞距离           |
+| computeInvisible | boolean       | 否       | 计算是否不可见       |
+
+**返回参数**
+
+`Promise`<{ `keyOne`: `number` ; `keyTwo`: `number` ; `pathOne`: `string` ; `pathTwo`: `string` ; `position`: `number`[] ; `type`: `CollisionType` }[]>
+
+------
+
+### computeGeometryRayTest
+
+**功能描述**：几何射线检测。
+
+**请求体参数**
+
+| 参数名称 | 参数类型           | 是否必填 | 参数描述     |
+| :------- | ------------------ | -------- | ------------ |
+| geom     | Geometry           | 是       | 几何图形     |
+| origin   | ArrayLike<number\> | 是       | 射线源点位置 |
+| direct   | ArrayLike<number\> | 是       | 射线方向     |
+
+**返回参数**
+
+`Float32Array`
+
+------
+
+### computeNearPlaneWorldPos
+
+**功能描述**：计算附近平面的三维坐标。
+
+**请求体参数**
+
+| 参数名称 | 参数类型     | 是否必填 | 参数描述 |
+| :------- | ------------ | -------- | -------- |
+| pixel    | Float32Array | 是       | 二维坐标 |
+
+**返回参数**
+
+`Float64Array`
+
+------
+
+### computeRayTest
+
+**功能描述**：射线检测。
+
+**请求体参数**
+
+| 参数名称 | 参数类型           | 是否必填 | 参数描述 |
+| :------- | ------------------ | -------- | -------- |
+| origin   | ArrayLike<number\> | 是       | 射线源点 |
+| direct   | ArrayLike<number\> | 是       | 射线方向 |
+
+**返回参数**
+
+`Float32Array`
+
+------
+
+### computeViewBoundingBox
+
+**功能描述**：视图包围盒计算。
+
+**请求体参数**
+
+| 参数名称 | 参数类型                | 是否必填 | 参数描述               |
+| :------- | ----------------------- | -------- | ---------------------- |
+| segment  | segment\|List<Segment\> | 是       | 模型渲染结构的节点数据 |
+
+**返回参数**
+
+`any`
+
+------
+
+### computeViewBoundingBoxByKey
+
+**功能描述**：通过key进行视图包围盒计算。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| key      | any      | 是       | 唯一标识 |
+
+**返回参数**
+
+`Float32Array`
+
+------
+
+### computeViewBoundingBoxes
+
+**功能描述**：计算多个模型节点的视图包围盒。
+
+**请求体参数**
+
+| 参数名称 | 参数类型  | 是否必填 | 参数描述                   |
+| :------- | --------- | -------- | -------------------------- |
+| segments | Segment[] | 是       | 模型渲染结构的节点数据数组 |
+
+**返回参数**
+
+`any`
+
+------
+
+### convertCoordinate
+
+**功能描述**：转换坐标。
+
+**请求体参数**
+
+| 参数名称   | 参数类型           | 是否必填 | 参数描述     |
+| :--------- | ------------------ | -------- | ------------ |
+| in_coords  | CoordinateSystem   | 是       | 转换前的坐标 |
+| out_coords | CoordinateSystem   | 是       | 转换后的坐标 |
+| in_pos     | ArrayLike<number\> | 是       | 转换前位置   |
+
+**返回参数**
+
+`Float32Array`
+
+------
+
+### deInstantiateRenderObject
+
+**功能描述**：取消实例化渲染对像。
+
+**请求体参数**
+
+| 参数名称     | 参数类型             | 是否必填 | 参数描述         |
+| :----------- | -------------------- | -------- | ---------------- |
+| parent       | RenderInstanceObject | 是       | 父级渲染实例对象 |
+| ro           | RenderObject         | 是       | 渲染对象         |
+| triggerEvent | boolean              | 是       | 触发事件         |
+
+**返回参数**
+
+`void`
+
+------
+
+### debugLog
+
+**功能描述**：调试日志。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述     |
+| :------- | -------- | -------- | ------------ |
+| mes      | string   | 是       | 调试日志信息 |
+
+**返回参数**
+
+`void`
+
+------
+
+### dispose
+
+**功能描述**：销毁视图。
+
+**请求体参数**：无
+
+**返回参数**
+
+`void`
+
+------
+
+### ensureCurrentMemorySize
+
+**功能描述**：确定当前内存大小。
+
+**请求体参数**：无
+
+**返回参数**
+
+`boolean`
+
+------
+
+### ensureMemorySize
+
+**功能描述**：确定内存大小。
+
+**请求体参数**：无
+
+**返回参数**
+
+`boolean`
+
+------
+
+### ensureSegmentAsynGeometry
+
+**功能描述**：递归该模型节点，加载所有未异步加载的几何。
+
+**请求体参数**
+
+| 参数名称 | 参数类型                                 | 是否必填 | 参数描述                                                     |
+| :------- | ---------------------------------------- | -------- | ------------------------------------------------------------ |
+| key      | number                                   | 是       | segmentKey（模型节点的标识）。 注意：不能选择一个跨gsl的模型节点，会导致向上查找的模型id有问题。 |
+| cb       | (total: number, current: number) => void | 否       | 总的几何数量，当前几何数量                                   |
+
+**返回参数**
+
+`Promise`<`void`\>
+
+所有要异步加载几何的segmentKey列表
+
+------
+
+### exeSceneCameraChanged
+
+**功能描述**：场景摄影机更改。
+
+**请求体参数**
+
+| 参数名称 | 参数类型         | 是否必填 | 参数描述 |
+| :------- | ---------------- | -------- | -------- |
+| type     | CameraChangeType | 是       | 类型     |
+
+**返回参数**
+
+`void`
+
+------
+
+### exeSceneCameraChanging
+
+**功能描述**：执行场景摄影机更改。
+
+**请求体参数**
+
+| 参数名称 | 参数类型         | 是否必填 | 参数描述 |
+| :------- | ---------------- | -------- | -------- |
+| type     | CameraChangeType | 是       | 类型     |
+
+**返回参数**
+
+`void`
+
+------
+
+### filterLoadingList
+
+**功能描述**：遍历keys数组，先将loadinglist（加载列表）里的key过滤掉。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| keys     | number[] | 是       | 标识数组 |
+
+**返回参数**
+
+`number`[]
+
+------
+
+### findInstanceObject
+
+**功能描述**：查找实例对象。
+
+**请求体参数**
+
+| 参数名称 | 参数类型     | 是否必填 | 参数描述 |
+| :------- | ------------ | -------- | -------- |
+| ro       | RenderObject | 是       | 实例对象 |
+
+**返回参数**
+
+`RenderInstanceObject`
+
+------
+
+### findInstanceObjectByInsParent
+
+**功能描述**：通过父级查找实例对象。
+
+**请求体参数**
+
+| 参数名称  | 参数类型     | 是否必填 | 参数描述 |
+| :-------- | ------------ | -------- | -------- |
+| insParent | RenderObject | 是       | 父级实例 |
+| ro        | RenderObject | 是       | 实例对象 |
+
+**返回参数**
+
+`any`
+
+------
+
+### findInstanceObjects
+
+**功能描述**：查找实例对象。
+
+**请求体参数**
+
+| 参数名称 | 参数类型     | 是否必填 | 参数描述 |
+| :------- | ------------ | -------- | -------- |
+| ro       | RenderObject | 是       | 实例对象 |
+
+**返回参数**
+
+`NumberKeyList<RenderInstanceObject>`
+
+------
+
+### findInstanceObjectsByInsParent
+
+**功能描述**：通过父级查找实例对象。
+
+**请求体参数**
+
+| 参数名称  | 参数类型     | 是否必填 | 参数描述 |
+| :-------- | ------------ | -------- | -------- |
+| insParent | RenderObject | 是       | 父级实例 |
+| ro        | RenderObject | 是       | 实例对象 |
+
+**返回参数**
+
+`NumberKeyList<any>`
+
+------
+
+### findViewerByKey
+
+**功能描述**：通过视图的标识查找视图。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述     |
+| :------- | -------- | -------- | ------------ |
+| view_key | any      | 是       | 视图唯一标识 |
+
+**返回参数**
+
+`Viewer`
+
+------
+
+### fitWorld
+
+**功能描述**：居中模型。
+
+**请求体参数**
+
+| 参数名称 | 参数类型    | 是否必填 | 参数描述 |
+| :------- | ----------- | -------- | -------- |
+| type     | ElementType | 否       | 元素类型 |
+
+**返回参数**
+
+`void`
+
+------
+
+### getGeometryDataPerLightModel
+
+**功能描述**：获取每个轻量化模型的几何数据。
+
+**请求体参数**
+
+| 参数名称   | 参数类型 | 是否必填 | 参数描述 |
+| :--------- | -------- | -------- | -------- |
+| lightModel | any      | 是       | 模型     |
+| idMapKeys  | Object   | 是       | 地图标识 |
+
+**返回参数**
+
+`Promise`<`void`\>
+
+------
+
+### getGslId
+
+**功能描述**：获取gsl的id。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述      |
+| :------- | -------- | -------- | ------------- |
+| key      | any      | 是       | gsl的唯一标识 |
+
+**返回参数**
+
+`string`
+
+------
+
+### getInstanceObjectByPath
+
+**功能描述**：通过路径获取实例对象。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| path     | any      | 是       | 路径     |
+
+**返回参数**
+
+`RenderInstanceObject`
+
+------
+
+### getModelVersionByModelId
+
+**功能描述**：通过模型id获取模型版本。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| modelId  | string   | 是       | 模型id   |
+
+**返回参数**
+
+`number`
+
+------
+
+### getRenderObjectByPath
+
+**功能描述**：通过路径获取渲染对象。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| path     | any      | 是       | 路径     |
+
+**返回参数**
+
+`RenderObject`
+
+------
+
+### groupingAsynKeysOfEachLightModel
+
+**功能描述**：将key列表按每个轻量化模型进行划分。
+
+**请求体参数**
+
+| 参数名称  | 参数类型   | 是否必填 | 参数描述 |
+| :-------- | ---------- | -------- | -------- |
+| asynKeys  | Int32Array | 是       | 标识列表 |
+| idMapKeys | Object     | 是       | 地图标识 |
+
+**返回参数**
+
+`void`
+
+------
+
+### initManagers
+
+**功能描述**：初始化管理器。
+
+**请求体参数**：无
+
+**返回参数**
+
+`void`
+
+------
+
+### instantiateRenderObject
+
+**功能描述**：实例化渲染对象。
+
+**请求体参数**
+
+| 参数名称     | 参数类型             | 是否必填 | 参数描述 |
+| :----------- | -------------------- | -------- | -------- |
+| insParent    | RenderInstanceObject | 是       | 父级实例 |
+| ro           | RenderObject         | 是       | 渲染对象 |
+| triggerEvent | boolean              | 是       | 触发事件 |
+
+**返回参数**
+
+`void`
+
+------
+
+### locateWorld
+
+**功能描述**：视图定位到某处或某个模型节点。
+
+**请求体参数**
+
+| 参数名称 | 参数类型          | 是否必填 | 参数描述                   |
+| :------- | ----------------- | -------- | -------------------------- |
+| segment  | number \| Segment | 是       | 定位的位置\|定位的模型节点 |
+
+**返回参数**
+
+`void`
+
+------
+
+### pixelPointToWorldPoint
+
+**功能描述**：二维坐标转三维坐标，支持多点转换。
+
+**请求体参数**
+
+| 参数名称 | 参数类型       | 是否必填 | 参数描述     |
+| :------- | -------------- | -------- | ------------ |
+| position | number, number | 是       | 二维坐标列表 |
+
+**返回参数**
+
+`number, number, number`
+
+三维坐标列表
+
+------
+
+### rebind
+
+**功能描述**：重新绑定。
+
+**请求体参数**
+
+| 参数名称    | 参数类型 | 是否必填 | 参数描述 |
+| :---------- | -------- | -------- | -------- |
+| containerId | string   | 是       | 容器id   |
+
+**返回参数**
+
+`void`
+
+------
+
+### removeEnsureGeometries
+
+**功能描述**：删除确保加载了几何模型节点的几何数据。
+
+**请求体参数**：无
+
+**返回参数**
+
+`void`
+
+------
+
+### reset
+
+**功能描述**：重置。
+
+**请求体参数**：无
+
+**返回参数**
+
+`void`
+
+------
+
+### selectByArea
+
+**功能描述**：通过区域选择。
+
+**请求体参数**
+
+| 参数名称 | 参数类型           | 是否必填 | 参数描述 |
+| :------- | ------------------ | -------- | -------- |
+| winArea  | ArrayLike<number\> | 是       | 窗口区域 |
+| type     | AreaSelectionType  | 是       | 类型     |
+
+**返回参数**
+
+`List<SelectionKey>`
+
+------
+
+### selectByPoint
+
+**功能描述**：通过点选择。
+
+**请求体参数**
+
+| 参数名称 | 参数类型           | 是否必填 | 参数描述 |
+| :------- | ------------------ | -------- | -------- |
+| winPos   | ArrayLike<number\> | 是       | 点位置   |
+
+**返回参数**
+
+`List<SelectionKey>`
+
+------
+
+### selectPositionByPoint
+
+**功能描述**：通过点选择位置。
+
+**请求体参数**
+
+| 参数名称 | 参数类型           | 是否必填 | 参数描述 |
+| :------- | ------------------ | -------- | -------- |
+| winPos   | ArrayLike<number\> | 是       | 点位置   |
+
+**返回参数**
+
+`Float32Array`
+
+------
+
+### setSceneCamera
+
+**功能描述**：设置相机。
+
+**请求体参数**
+
+| 参数名称 | 参数类型           | 是否必填 | 参数描述 |
+| :------- | ------------------ | -------- | -------- |
+| positin  | ArrayLike<number\> | 是       | 相机位置 |
+| target   | ArrayLike<number\> | 是       | 镜头朝向 |
+| up       | ArrayLike<number\> | 是       | 镜头高度 |
+| width    | number             | 否       | 宽       |
+| height   | number             | 否       | 高       |
+
+**返回参数**
+
+`void`
+
+------
+
+### setViewMode
+
+**功能描述**：设置视图模式。
+
+**请求体参数**
+
+| 参数名称 | 参数类型     | 是否必填 | 参数描述 |
+| :------- | ------------ | -------- | -------- |
+| mode     | ViewMode     | 是       | 视图模式 |
+| fitWorld | boolean      | 否       | 是否居中 |
+| bb       | Float32Array | 否       | 包围盒   |
+
+**返回参数**
+
+`void`
+
+------
+
+### unBufferAndBufferGeometries
+
+**功能描述**：不缓存/缓存几何图形。
+
+**请求体参数**
+
+| 参数名称           | 参数类型                   | 是否必填 | 参数描述             |
+| :----------------- | -------------------------- | -------- | -------------------- |
+| isStreamToGeometry | boolean                    | 是       | 是否执行流到几何图形 |
+| promise            | ThreadPromise<UpdateInfo\> | 是       | promise对象          |
+| isThread           | boolean                    | 是       | 是否开启线程         |
+
+**返回参数**
+
+`void`
+
+------
+
+### updateBackgroundColor
+
+**功能描述**：更新背景颜色。
+
+**请求体参数**：无
+
+**返回参数**
+
+`void`
+
+------
+
+### updateCameraNearFar
+
+**功能描述**：更新远近相机。
+
+**请求体参数**：无
+
+**返回参数**
+
+`void`
+
+------
+
+### updateDisplay
+
+**功能描述**：刷新图形渲染。
+
+**请求体参数**：无
+
+**返回参数**
+
+`ThreadPromise<UpdateInfo>`
+
+------
+
+### updateDisplaySynced
+
+**功能描述**：同步更新显示。
+
+**请求体参数**：无
+
+**返回参数**
+
+`void`
+
+------
+
+### updateDisplayWithFramerate
+
+**功能描述**：使用帧速率刷新图形渲染。
+
+**请求体参数**
+
+| 参数名称         | 参数类型 | 是否必填 | 参数描述 |
+| :--------------- | -------- | -------- | -------- |
+| framerate        | number   | 是       | 帧速率   |
+| cullingThreshold | number   | 是       | 剔除阈值 |
+
+**返回参数**
+
+`void`
+
+------
+
+### updateDisplayWithTime
+
+**功能描述**：随时间刷新图形渲染。
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| time     | number   | 是       | 时间     |
+
+**返回参数**
+
+`void`
+
+------
+
+### updateDocument
+
+**功能描述**：更新document（载入浏览器的HTML文档 ）。
+
+**请求体参数**：无
+
+**返回参数**
+
+`void`
+
+------
+
+### updateSize
+
+**功能描述**：刷新大小。
+
+**请求体参数**：无
+
+**返回参数**
+
+`void`
+
+------
+
+### worldPointToPixelPoint
+
+**功能描述**：三维坐标转二维坐标，支持多点转换。
+
+**请求体参数**
+
+| 参数名称 | 参数类型                 | 是否必填 | 参数描述     |
+| :------- | ------------------------ | -------- | ------------ |
+| position | Float64Array[] \| number | 是       | 三维坐标列表 |
+
+**返回参数**
+
+`number, number`
+
+returns 二维坐标列表
+
+------
+
+### zUnitLength 
+
+**功能描述**：z轴单位长度
+
+**请求体参数**
+
+| 参数名称 | 参数类型 | 是否必填 | 参数描述 |
+| :------- | -------- | -------- | -------- |
+| z        | number   | 是       | 长度     |
+
+**返回参数**
+
+`number`
+
+------
+
+### 
+