@nnepoch/dtc-sdk 3.0.0

package/docs/api/api/classes/PathPatrol.md

@@ -0,0 +1,337 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / PathPatrol
+
+# Class: PathPatrol
+
+路径巡逻 API，支持巡逻路线添加、样式修改、时间节点设置与巡逻控制。
+
+## Agent Title
+
+路径巡逻
+
+## Agent Capabilities
+
+添加巡逻路线, 修改巡逻样式, 设置巡逻时间节点, 清除巡逻路径, 暂停巡逻, 继续巡逻, 停止巡逻
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### add()
+
+> **add**(`payload`, `callback?`): `StreamRequestPromise`\<`unknown`\>
+
+添加巡逻路线。
+默认值：`showPath=true`、`afterRender=false`、`passedColor=#ffffff`、`lineColor=#00ff00`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PathPatrolAddRequest`](../../types/interfaces/PathPatrolAddRequest.md) | 巡逻路线参数。 |
+| `callback?` | `StreamRequestCallback`\<`unknown`\> | 可选回调函数。 |
+
+#### Returns
+
+`StreamRequestPromise`\<`unknown`\>
+
+支持 data/done/error/cancel 事件的流式 Promise。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.PathPatrol.add(
+  {
+    parentId: 'patrolLayer',
+    id: 'patrolMan',
+    assetPath: '/Game/XiAnDongZhan/Resources/Models/BluePrints/BP_Test.uasset', // 资产路径,
+    scale: new dtcEngine.Type.Vector3(2, 2, 2),
+    showPath: true,
+    passedColor: '#ff0013',
+    lineColor: '#0040ef',
+    lineWidth: 2,
+    nodes: [
+      new dtcEngine.Type.Vector3(114.79234244388735, 34.8353249473732, 67.76611328125),
+      new dtcEngine.Type.Vector3(114.78552975378634, 34.84532722646887, 67.76627349853516),
+      new dtcEngine.Type.Vector3(114.80288724169422, 34.83953942217231, 67.76618194580078),
+      new dtcEngine.Type.Vector3(114.8026897995721, 34.843259827346145, 68.76814270019531)
+    ],
+    duration: 10
+  },
+  (result) => { console.log(result); }
+);
+```
+
+***
+
+### update()
+
+> **update**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+修改巡逻路径的样式。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PathPatrolUpdateRequest`](../../types/interfaces/PathPatrolUpdateRequest.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.PathPatrol.update(
+  { parentId: 'patrolLayer', id: 'patrolMan', lineColor: '#ff00ff', lineWidth: 3.5 },
+  (result) => { console.log(result); }
+);
+```
+
+***
+
+### setTimeNode()
+
+> **setTimeNode**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置巡逻开始的时间节点或是节点索引。
+`timeStart` 与 `startNodeIndex` 只能有一个不为空。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PathPatrolSetTimeNodeRequest`](../../types/interfaces/PathPatrolSetTimeNodeRequest.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.PathPatrol.setTimeNode(
+  { parentId: 'patrolLayer', id: 'patrolMan', timeStart: '2025-09-10 00:05:00' },
+  (result) => { console.log(result); }
+);
+
+// 示例2: 开始节点索引
+dtcEngine.PathPatrol.setTimeNode(
+  { parentId: 'patrolLayer', id: 'patrolMan', startNodeIndex: 3 },
+  (result) => { console.log(result); }
+);
+```
+
+***
+
+### clear()
+
+> **clear**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+清除巡逻路径。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `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.PathPatrol.clear((result) => { console.log(result); });
+```
+
+***
+
+### pause()
+
+> **pause**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+暂停巡逻。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PathPatrolNodeRequest`](../../types/interfaces/PathPatrolNodeRequest.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.PathPatrol.pause({ id: 'patrolMan' }, (result) => { console.log(result, '暂停'); });
+```
+
+***
+
+### resume()
+
+> **resume**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+继续巡逻。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PathPatrolNodeRequest`](../../types/interfaces/PathPatrolNodeRequest.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.PathPatrol.resume({ id: 'patrolMan' }, (result) => { console.log(result); });
+```
+
+***
+
+### stop()
+
+> **stop**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+停止巡逻。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PathPatrolNodeRequest`](../../types/interfaces/PathPatrolNodeRequest.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.PathPatrol.stop({ id: 'patrolMan' }, (result) => { console.log(result); });
+```

package/docs/api/api/classes/Popup.md

@@ -0,0 +1,323 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / Popup
+
+# Class: Popup
+
+前端 Popup 管理 API。
+
+  的 Popup：气泡由 PopupManager 在前端宿主 DOM 中管理，
+addPop/removePop/removeAll/show/showAll 五个变更方法均通过 SynPopsInfo
+把"需同步的气泡列表"发往引擎，气泡定位由引擎 SyncPops 推送驱动。
+
+## Agent Title
+
+前端 Popup
+
+## Agent Capabilities
+
+Popup 添加, Popup 删除, Popup 清除, Popup 显隐控制, Popup 全部显隐控制, Popup 延迟帧控制, Popup 显示距离控制
+
+## Extends
+
+- `BaseApi`
+
+## Properties
+
+### popupManager
+
+> `readonly` **popupManager**: `PopupManager`
+
+## Methods
+
+### addPop()
+
+> **addPop**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+创建前端弹出气泡。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PopupAddRequest`](../../types/interfaces/PopupAddRequest.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.Popup.addPop(
+  { groupName: 'CameraPopGroup', popInfo: [{ id: 'Camera1', visible: true }] },
+  (result) => { console.log(result); }
+);
+```
+
+***
+
+### removePop()
+
+> **removePop**(`payload?`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+删除前端气泡。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PopupRemoveRequest`](../../types/interfaces/PopupRemoveRequest.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.Popup.removePop({ groupName: 'cameraLayer', ids: ['camera01'] });
+dtcEngine.Popup.removePop(); // 清除默认组下所有气泡
+```
+
+***
+
+### removeAll()
+
+> **removeAll**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+清除所有前端气泡。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `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
+
+undefined
+
+#### Example
+
+```ts
+dtcEngine.Popup.removeAll((result) => console.log(result));
+```
+
+***
+
+### show()
+
+> **show**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+显示或隐藏气泡。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PopupShowRequest`](../../types/interfaces/PopupShowRequest.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.Popup.show({ groupName: 'CameraPopGroup', ids: ['Camera2'], show: false });
+dtcEngine.Popup.show({ show: true }); // 显示默认组下所有气泡
+```
+
+***
+
+### showAll()
+
+> **showAll**(`show?`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+显示或隐藏所有组下的所有气泡。
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `show` | `boolean` | `true` | 气泡显示与否，true 显示，false 隐藏，默认 true。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | `undefined` | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+true
+
+#### Example
+
+```ts
+dtcEngine.Popup.showAll((result) => console.log(result));
+```
+
+***
+
+### setPopDelayFrame()
+
+> **setPopDelayFrame**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置前端气泡同步的延迟时间。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`PopupDelayRequest`](../../types/interfaces/PopupDelayRequest.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.Popup.setPopDelayFrame({ time: 0.3 }, (result) => console.log(result));
+```
+
+***
+
+### setPopShowDistance()
+
+> **setPopShowDistance**(`distance`): `void`
+
+设置前端页面气泡最远的显示距离（仅本地生效，不发送请求）。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `distance` | `number` | 值范围：>= 0。 |
+
+#### Returns
+
+`void`
+
+void
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+2000
+
+#### Example
+
+```ts
+dtcEngine.Popup.setPopShowDistance(2000);
+```