@nnepoch/dtc-sdk 3.0.11 → 3.0.12

package/docs/api/api/classes/PointEditor.md

@@ -0,0 +1,265 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / PointEditor
+
+# Class: PointEditor
+
+MODEL 打点 API，复用既有场景对象；不读写平台 JSON、PointTool 文件或修改 MQTT 流程。
+PointTool 本地工作台对象仍由其自身管理；本期不支持独立 POI。
+
+## Agent Title
+
+模型点位编辑
+
+## Agent Capabilities
+
+按坐标创建点位, 点击创建点位, 拖放创建点位, 落点坐标换算, 取消点位放置, 局部更新点位, 批量删除点位
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### addPoint()
+
+> **addPoint**(`payload`, `callback?`): `Promise`\<[`PointEditorPoint`](../../types/type-aliases/PointEditorPoint.md)\>
+
+创建模型点位；未传 position/screenPosition 时等待视频区域的一次有效点击，可按 Escape/右键取消。
+默认显示模型和附属 POI，缩放为 (1,1,1)，旋转为 (0,0,0)。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PointEditorAddRequest`](../../types/interfaces/PointEditorAddRequest.md) | 网页分组、全局 ID、坐标及 UE 资源。 |
+| `callback?` | [`PointEditorCreateCallback`](../../types/type-aliases/PointEditorCreateCallback.md) | 成功收到实际点位；失败收到 Error。 |
+
+#### Returns
+
+`Promise`\<[`PointEditorPoint`](../../types/type-aliases/PointEditorPoint.md)\>
+
+UE 实际创建的点位，不是通用响应信封。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+已建立 WebRTC 连接，UE CoreModules 支持 sdk3 点位编辑
+
+#### Agent Risk Level
+
+medium
+
+#### Agent Example
+
+#### Example
+
+```ts
+const point = await dtcEngine.PointEditor.addPoint({
+  parentId: 'sdk3-point-editor-test', id: 'G-test-1', type: 'MODEL',
+  position: { x: 120, y: 30, z: 5 },
+  resource: { path: '/Game/Devices/BP_Camera.BP_Camera_C' }
+});
+console.log(point.position);
+```
+
+***
+
+### addPointByDrag()
+
+> **addPointByDrag**(`payload`, `callback?`): `Promise`\<[`PointEditorPoint`](../../types/type-aliases/PointEditorPoint.md)\>
+
+拖放创建；使用 drop 当时保存的 screenPosition 或显式经纬高，不读取当前或上一次鼠标位置。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PointEditorAddRequest`](../../types/interfaces/PointEditorAddRequest.md) | 点位参数及 position 或 screenPosition（二选一）。 |
+| `callback?` | [`PointEditorCreateCallback`](../../types/type-aliases/PointEditorCreateCallback.md) | 成功收到实际点位；失败收到 Error。 |
+
+#### Returns
+
+`Promise`\<[`PointEditorPoint`](../../types/type-aliases/PointEditorPoint.md)\>
+
+UE 实际创建的点位。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+已建立 WebRTC 连接；必须提供 position 或 drop 时记录的 screenPosition
+
+#### Agent Risk Level
+
+medium
+
+#### Agent Example
+
+#### Example
+
+```ts
+await dtcEngine.PointEditor.addPointByDrag({ ...point, id: 'G-copy-1' }, (result) => {
+  if (result instanceof Error) return console.error(result);
+  console.log(result.position);
+});
+```
+
+***
+
+### getScreenPosition()
+
+> **getScreenPosition**(`payload`): [`PointEditorScreenPosition`](../../types/interfaces/PointEditorScreenPosition.md)
+
+在实际 drop 事件中同步换算位置，随后可等待后端保存；不在等待结束后重新读取鼠标。
+校验有效视频区域并排除 contain 黑边，支持页面偏移、滚动及轴对齐 CSS 缩放。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PointEditorClientPosition`](../../types/interfaces/PointEditorClientPosition.md) | 事件的 clientX/clientY，不是 pageX/pageY。 |
+
+#### Returns
+
+[`PointEditorScreenPosition`](../../types/interfaces/PointEditorScreenPosition.md)
+
+视频完整图像中的归一化坐标。
+
+#### Agent Side Effects
+
+read
+
+#### Agent Preconditions
+
+视频已就绪，必须使用真实 drop 事件坐标
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+const screenPosition = dtcEngine.PointEditor.getScreenPosition({ clientX: event.clientX, clientY: event.clientY });
+await savePointToBackend();
+await dtcEngine.PointEditor.addPointByDrag({ ...payload, screenPosition });
+```
+
+***
+
+### cancelPlacement()
+
+> **cancelPlacement**(): `Promise`\<`void`\>
+
+取消正在等待网页点击的放置操作并恢复输入；不撤销已经发送到 UE 的创建请求。
+
+#### Returns
+
+`Promise`\<`void`\>
+
+取消完成；原 addPoint Promise 将以取消错误拒绝。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Risk Level
+
+low
+
+#### Example
+
+```ts
+await dtcEngine.PointEditor.cancelPlacement();
+```
+
+***
+
+### updatePoint()
+
+> **updatePoint**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+局部更新 MODEL 及附属 POI；不传的字段保持原值，false、0 和空名称有效。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PointEditorUpdateRequest`](../../types/type-aliases/PointEditorUpdateRequest.md) | 点位定位条件及需要修改的属性；extraProps 整体替换。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选响应回调。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+通用响应信封。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+目标是既有场景加载或 API 创建的 MODEL；PointTool 本地工作台对象除外
+
+#### Agent Risk Level
+
+medium
+
+#### Agent Example
+
+#### Example
+
+```ts
+await dtcEngine.PointEditor.updatePoint({
+  parentId: 'sdk3-point-editor-test', id: 'G-test-1', type: 'MODEL',
+  name: '摄像机', poiOffsetY: 0, poiEnabled: false
+});
+```
+
+***
+
+### deletePoints()
+
+> **deletePoints**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<[`PointEditorDeleteResult`](../../types/interfaces/PointEditorDeleteResult.md)\>\>
+
+批量删除网页模型点位及附属 POI；混入其他来源或纯 POI 目标时整批拒绝。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PointEditorDeleteRequest`](../../types/interfaces/PointEditorDeleteRequest.md) | 分组与点位全局 ID。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<[`PointEditorDeleteResult`](../../types/interfaces/PointEditorDeleteResult.md)\>\> | 可选响应回调；params 中含 deletedIds 和 failedIds。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<[`PointEditorDeleteResult`](../../types/interfaces/PointEditorDeleteResult.md)\>\>
+
+通用响应信封，保留部分删除结果。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+目标属于场景 MODEL 点位管理范围，按 parentId/id 准确定位
+
+#### Agent Risk Level
+
+high
+
+#### Agent Example
+
+#### Example
+
+```ts
+await dtcEngine.PointEditor.deletePoints({ parentId: 'sdk3-point-editor-test', ids: ['G-test-1'] });
+```

package/docs/api/api/classes/PointIcon.md

@@ -0,0 +1,275 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / PointIcon
+
+# Class: PointIcon
+
+设备点位图标显隐控制 API。
+
+## Agent Title
+
+设备点位图标
+
+## Agent Capabilities
+
+指定点位显隐, 按编码点位显隐, 分组点位显隐, 全部点位显隐
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### show()
+
+> **show**(`payload`, `callback?`): `Promise`\<`PointIconResponse`\>
+
+显示指定设备点位的图标。
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `payload` | [`PointIconIdsInput`](../type-aliases/PointIconIdsInput.md) |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<`PointIconResponse`\> |
+
+#### Returns
+
+`Promise`\<`PointIconResponse`\>
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+***
+
+### hide()
+
+> **hide**(`payload`, `callback?`): `Promise`\<`PointIconResponse`\>
+
+隐藏指定设备点位的图标。
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `payload` | [`PointIconIdsInput`](../type-aliases/PointIconIdsInput.md) |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<`PointIconResponse`\> |
+
+#### Returns
+
+`Promise`\<`PointIconResponse`\>
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+***
+
+### showByCode()
+
+> **showByCode**(`payload`, `callback?`): `Promise`\<`PointIconResponse`\>
+
+显示指定编码（code）的全部设备点位图标，编码精确匹配且不要求唯一。
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `payload` | `PointIconCodesInput` |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<`PointIconResponse`\> |
+
+#### Returns
+
+`Promise`\<`PointIconResponse`\>
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+***
+
+### hideByCode()
+
+> **hideByCode**(`payload`, `callback?`): `Promise`\<`PointIconResponse`\>
+
+隐藏指定编码（code）的全部设备点位图标，编码精确匹配且不要求唯一。
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `payload` | `PointIconCodesInput` |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<`PointIconResponse`\> |
+
+#### Returns
+
+`Promise`\<`PointIconResponse`\>
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+***
+
+### showByGroup()
+
+> **showByGroup**(`payload`, `callback?`): `Promise`\<`PointIconResponse`\>
+
+显示指定分组及其子分组内的设备点位图标。
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `payload` | [`PointIconIdsInput`](../type-aliases/PointIconIdsInput.md) |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<`PointIconResponse`\> |
+
+#### Returns
+
+`Promise`\<`PointIconResponse`\>
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+***
+
+### hideByGroup()
+
+> **hideByGroup**(`payload`, `callback?`): `Promise`\<`PointIconResponse`\>
+
+隐藏指定分组及其子分组内的设备点位图标。
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `payload` | [`PointIconIdsInput`](../type-aliases/PointIconIdsInput.md) |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<`PointIconResponse`\> |
+
+#### Returns
+
+`Promise`\<`PointIconResponse`\>
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+***
+
+### showAll()
+
+> **showAll**(`callback?`): `Promise`\<`PointIconResponse`\>
+
+显示全部设备点位图标。
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<`PointIconResponse`\> |
+
+#### Returns
+
+`Promise`\<`PointIconResponse`\>
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+***
+
+### hideAll()
+
+> **hideAll**(`callback?`): `Promise`\<`PointIconResponse`\>
+
+隐藏全部设备点位图标。
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<`PointIconResponse`\> |
+
+#### Returns
+
+`Promise`\<`PointIconResponse`\>
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low

package/docs/api/api/classes/SpatialQuery.md

@@ -0,0 +1,175 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / SpatialQuery
+
+# Class: SpatialQuery
+
+场景缓冲空间查询 API，支持三种查询方式：
+1. 根据场景模型当前的位置进行空间查询；
+2. 根据场景坐标位置进行空间查询；
+3. 根据场景模型的边界框进行空间查询。
+
+## Agent Title
+
+空间查询
+
+## Agent Capabilities
+
+模型空间查询, 坐标空间查询, 模型包围盒空间查询
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### layerQueryByModel()
+
+> **layerQueryByModel**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+模型空间查询：根据场景模型当前的位置进行空间查询。
+默认值：`queryRadius=50`、`queryMinHeight=0`、`queryMaxHeight=20`。
+`queryParentIds` 不能为空，至少指定一个查询的图层组编号。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`SpatialQueryLayerByModelRequest`](../../types/interfaces/SpatialQueryLayerByModelRequest.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.SpatialQuery.layerQueryByModel(
+   {
+     parentId: '',
+     id: 'LayerSearchCore',
+     queryRadius: 10,
+     queryMinHeight: 0,
+     queryMaxHeight: 50,
+     queryParentIds: ['SM_B8_XueShenSuShe', 'daoZha']
+   },
+   (result) => { console.log(result); }
+ );
+```
+
+***
+
+### layerQueryByPosition()
+
+> **layerQueryByPosition**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+坐标空间查询：根据场景坐标位置进行空间查询。
+默认值：`queryRadius=50`、`queryMinHeight=0`、`queryMaxHeight=20`。
+`queryParentIds` 不能为空，至少指定一个查询的图层组编号。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`SpatialQueryLayerByPositionRequest`](../../types/interfaces/SpatialQueryLayerByPositionRequest.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.SpatialQuery.layerQueryByPosition(
+   {
+     queryPosition: new dtcEngine.Type.Vector3(120.2076273621342, 30.372304875047895, 16.01983620418444),
+     queryRadius: 20,
+     queryMinHeight: 0,
+     queryMaxHeight: 50,
+     queryParentIds: ['SM_B8_XueShenSuShe', 'daoZha']
+   }, (res) => {
+     console.log(res);
+   }
+ );
+```
+
+***
+
+### layerQueryByModelBox()
+
+> **layerQueryByModelBox**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+模型包围盒空间查询：根据场景模型的边界框进行空间查询。
+`queryParentIds` 不能为空，至少指定一个查询的图层组编号。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`SpatialQueryLayerByModelBoxRequest`](../../types/interfaces/SpatialQueryLayerByModelBoxRequest.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.SpatialQuery.layerQueryByModelBox(
+   {
+     parentId: '',
+     id: 'LayerSearchCore',
+     queryParentIds: ['JianKong_QiangJiTest', 'daoZha']
+   },
+   (result) => { console.log(result); }
+ );
+```

package/docs/api/api/classes/TimeLine.md

@@ -50,6 +50,10 @@ DTCEngine 已完成鉴权并建立 WebRTC 连接
 
 low
 
+#### Agent Response Mode
+
+stream
+
 #### Agent Example
 
 #### Example