@nnepoch/dtc-sdk 3.0.0

package/docs/api/api/classes/Layer.md

@@ -0,0 +1,444 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / Layer
+
+# Class: Layer
+
+场景图层对象管理 API。
+
+## Agent Title
+
+图层管理
+
+## Agent Capabilities
+
+图层添加, 图层删除, 图层存在性查询, 模型图层切换, 图层气泡显隐, 图层模型添加, 图层模型删除, 图层子对象查询
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### addLayer()
+
+> **addLayer**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+添加对象图层组。
+默认值：`show=true`、`poiEnabled=true`、`isSystem=false`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`LayerAddRequest`](../../types/interfaces/LayerAddRequest.md) | 图层创建参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Layer.addLayer(
+   {
+     parentId: 'CameraGroup',
+     id: 'CameraLayerModel',
+     layerName: '摄像机图层',
+     type: dtcEngine.Enums.LayerEnum.Model,
+     show: true,
+   },
+   (result) => { console.log(result); }
+ );
+```
+
+***
+
+### removeLayer()
+
+> **removeLayer**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+删除对象图层组，并清空其下所有对象。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`LayerSelectorRequest`](../../types/interfaces/LayerSelectorRequest.md) | 图层删除参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Layer.removeLayer({ parentId: 'CameraGroup', id: 'CameraLayerModel' });
+```
+
+***
+
+### isLayerOrGroupExit()
+
+> **isLayerOrGroupExit**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+判断图层或组对象是否存在。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`LayerSelectorRequest`](../../types/interfaces/LayerSelectorRequest.md) | 图层或分组选择参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+read
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Layer.isLayerOrGroupExit({ id: 'cameraGroup' }, (result) => {
+   console.log(result);
+ });
+```
+
+***
+
+### switchModelLayer()
+
+> **switchModelLayer**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+切换模型的图层组。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`LayerSwitchModelRequest`](../../types/interfaces/LayerSwitchModelRequest.md) | 模型图层切换参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Layer.switchModelLayer(
+   { parentId: 'cameraLayer', ids: ['camera01'], toParentId: 'destLayer' },
+   (result) => { console.log(result); }
+ );
+```
+
+***
+
+### showUIPop()
+
+> **showUIPop**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+显示或隐藏指定图层下的 UI Pop。
+默认值：`visible=true`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`LayerShowUIPopRequest`](../../types/interfaces/LayerShowUIPopRequest.md) | 图层 UI Pop 显隐参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Layer.showUIPop({ id: 'CameraLayerModel', visible: true },result => {
+   console.log(result);
+ });
+```
+
+***
+
+### addModel()
+
+> **addModel**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+在指定图层下添加模型资源。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`LayerModelAddRequest`](../../types/interfaces/LayerModelAddRequest.md) | 模型创建参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Layer.addModel({
+  parentId: 'CameraLayerModel',
+   id: 'camera01', 
+   assetsPath: '/Game/XiAnDongZhan/Resources/Models/BluePrints/BP_Test.uasset',
+   position: {x: 109.06024323031656, y: 34.21576501858481, z: -3.476555113942576, ePSGType: '4326'},
+   scale: {x: 1, y: 1, z: 1, ePSGType: '0000'},
+   rotation: {x: 0, y: 0, z: 0, ePSGType: '0000'}},
+   (result) => { console.log(result); }
+   );
+```
+
+***
+
+### addPOI()
+
+> **addPOI**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+在指定图层下添加模型资源。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`LayerPOIAddRequest`](../../types/interfaces/LayerPOIAddRequest.md) | 模型创建参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+
+ 示例1： 根据坐标添加气泡模型
+ dtcEngine.Layer.addPOI({
+  parentId: 'CameraLayerModel',
+   id: 'camera01', 
+   assetsPath: '/Game/Resources/POIS/BluePrints/BP_POI.uasset',
+   position: {x: 109.06024323031656, y: 34.21576501858481, z: -3.476555113942576, ePSGType: '4326'},
+   scale: {x: 1, y: 1, z: 1, ePSGType: '0000'},
+   rotation: {x: 0, y: 0, z: 0, ePSGType: '0000'},
+   text: '一体化球击摄像机',
+   fontSize: 16,
+   isSystem:true,   
+   },
+   (result) => { console.log(result); }
+   );
+
+   示例2： 根据目标模型，添加气泡模型
+ dtcEngine.Layer.addPOI({
+  parentId: 'CameraLayerModel',
+   id: 'camera01', 
+   assetsPath: '/Game/Resources/POIS/BluePrints/BP_POI.uasset',
+   targetParentId: 'CameraLayerModel',
+   targetId: 'camera01',
+   scale: {x: 1, y: 1, z: 1, ePSGType: '0000'},
+   rotation: {x: 0, y: 0, z: 0, ePSGType: '0000'},
+   text: '一体化球击摄像机',
+   fontSize: 16,
+   isSystem:true,   
+   },
+   (result) => { console.log(result); }
+   );
+```
+
+***
+
+### removeModel()
+
+> **removeModel**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+删除图层下指定模型资源。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`LayerModelRemoveRequest`](../../types/interfaces/LayerModelRemoveRequest.md) | 模型删除参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Layer.removeModel({ parentId: 'cameraLayer', ids: ['camera01'] }, (result) => { console.log(result); });
+```
+
+***
+
+### getLayerChildElement()
+
+> **getLayerChildElement**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+获取图层下所有一级子对象。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`LayerChildElementRequest`](../../types/interfaces/LayerChildElementRequest.md) | 图层选择参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+read
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Layer.getLayerChildElement({parentId:"XiAnDongZhan_1", id: 'SM_Building' }, (result) => {
+   console.log(result);
+ });
+```

package/docs/api/api/classes/Model.md

@@ -0,0 +1,193 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / Model
+
+# Class: Model
+
+模型对象管理 API。
+
+## Agent Title
+
+模型管理
+
+## Agent Capabilities
+
+模型显隐控制, 模型添加, 模型删除, 模型树查询, 模型信息查询, 模型包围盒查询
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### setVisible()
+
+> **setVisible**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置模型对象显隐状态。
+默认值：`visible=true`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelSetVisibleRequest`](../../types/interfaces/ModelSetVisibleRequest.md) | 模型显隐参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Model.setVisible(
+   { parentId: 'cameraGroup', id: ['camera01', 'camera02'], visible: false },
+   (result) => { console.log(result); }
+ );
+```
+
+***
+
+### setVisibleByTags()
+
+> **setVisibleByTags**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+按标签批量设置模型对象显隐状态。
+默认值：`visible=true`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelSetVisibleByTagsRequest`](../../types/interfaces/ModelSetVisibleByTagsRequest.md) | 标签显隐参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Model.setVisibleByTags(
+   { tags: ['camera', 'sensor'], visible: false },
+   (result) => { console.log(result); }
+ );
+```
+
+***
+
+### getElementTree()
+
+> **getElementTree**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+获取指定节点的一层子对象树。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelSelectorRequest`](../../types/interfaces/ModelSelectorRequest.md) | 节点标识参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+read
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.Model.getElementTree({ parentId: 'test', id: 'Root' }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### getModelInfo()
+
+> **getModelInfo**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+获取指定模型对象信息。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelSelectorRequest`](../../types/interfaces/ModelSelectorRequest.md) | 节点标识参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+read
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Model.getModelInfo({ parentId: 'test', id: 'Sphere' }, (result) => {
+   console.log(result);
+ });
+```