@nnepoch/dtc-sdk 3.0.11 → 3.0.13

package/docs/api/api/classes/Navigation.md

@@ -0,0 +1,618 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / Navigation
+
+# Class: Navigation
+
+场景对象导航 API，支持两种导航模式：
+1. 在导航网格上寻路，产生导航路径；
+2. 根据设置好的路径节点，进行直线导航。
+
+## Agent Title
+
+对象导航
+
+## Agent Capabilities
+
+网格导航寻路, 导航距离查询, 网格导航暂停, 网格导航继续, 网格导航停止, 网格导航属性修改, 路径导航开始, 路径导航暂停, 路径导航继续, 路径导航停止, 路径导航属性修改
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### startNav()
+
+> **startNav**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+网格导航寻路：模型对象根据路过的节点进行导航。
+`nodes` 与 `targetIds` 两者必须有一个不为空。
+默认值：`isCache=true`、`speed=1`、`frontWidth=1`、`backWidth=1`、`isAutoPlay=true`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`NavigationMeshNavRequest`](../../types/interfaces/NavigationMeshNavRequest.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.Navigation.startNav({
+   parentId: 'Players',
+   id: 'Player1',
+   nodes: [
+     new dtcEngine.Type.Vector3(114.7985155712282, 34.842421780635625, 2),
+     new dtcEngine.Type.Vector3(114.79789723105696, 34.84218433379876, 1.5),
+     new dtcEngine.Type.Vector3(114.79790138598447, 34.842529820659664, 2),
+     new dtcEngine.Type.Vector3(114.79799880513536, 34.84259530893161, 1.5),
+     new dtcEngine.Type.Vector3(114.79814201498125, 34.842669768891525, 2),
+     new dtcEngine.Type.Vector3(114.79808229900121, 34.842686310921465, 2)
+   ],
+   isCache: false,
+   planColor: '#00ff00',
+   passColor: '#e1e1e1',
+   offSetZ: 0.5,
+ }, (result) => { console.log(result); });
+ * 示例2：模型对象根据目标编码进行导航
+ dtcEngine.Navigation.startNav({
+   parentId: 'Players',
+   id: 'Player1',
+   targetCodes: ['1d370e56f4684f07963fed87e91e2164','070b49c4a6c24e0bae3aa8dcd4563556','d7d92d67093f47b881d11e3b59107d0f', 'd5eab05cbf8543aaacd218db300c61cd','a2e0eb51ee8f438088a48a392ffe02d3', '2459436d256847db9084e04e5ef9115c','5317033054e44835a14a6b7a9f5eed74'],
+   isCache: false,
+   planColor: '#00ff00',
+   passColor: '#e1e1e1',
+   offSetZ: 0.5,
+ }, (result) => { console.log(result); });
+
+ ** 示例3：模型对象根据目标坐标进行导航
+    dtcEngine.Navigation.startNav({
+                 parentId: 'patrolLayer',
+                 id: 'TestNav',
+                 targetIds: [
+                     "14b5770c062c47e1b359c09026221adc",
+                     "56ce729e6ab74858a830b85b638fbe32",
+                     "738f6f36bf704969955872c63fab0bd1",
+                     "534500c3a1c84defab8a9a3d0c0e60a0",
+                     "74b694f0216d4aaf9b059bba22228c21",
+                     "2a025d1b1d6641a2b2a2e76f82abbb8c",
+                     "bc60c0fd9e6247989e2fda0e57756188",
+                     "42dd7766abc94cce97cb36244c348937",
+                     "ad594980d6d54752baf63b2f26a29493",
+                 ],
+                 isCache: false,
+                 planColor: '#ff820b',
+                 passColor: '#e1e1e1',
+                 speed: 3,
+                 offSetZ: 0.5,
+                 isAutoClear: false,//是否自动清除，默认 `true`。
+                 scale: new dtcEngine.Type.Vector3(3, 3, 3),
+             }, (result) => {
+                 console.log(result);
+                 let param = JSON.parse(result.param);
+                 if (param.status == 'start') {
+                     // dtcEngine.Camera.startCameraObjFollow({
+                     //     parentId: "patrolLayer",
+                     //     id: 'TestNav',
+                     //     offSet: new dtcEngine.Type.Vector3(-10, 0, 3),
+                     // });
+                 } else if (param.status == 'finished') {
+                     dtcEngine.Camera.endCameraObjFollow();
+                 }
+             });
+```
+
+***
+
+### getMeshNavDistance()
+
+> **getMeshNavDistance**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+网格导航距离查询：模型对象根据路过的节点进行导航，并返回导航距离信息。
+`nodes` 与 `targetIds` 两者必须有一个不为空。
+默认值：`isCache=false`、`speed=1`、`frontWidth=1`、`backWidth=1`、`isAutoPlay=false`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`NavigationMeshNavRequest`](../../types/interfaces/NavigationMeshNavRequest.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.Navigation.getMeshNavDistance({
+  parentId: 'Players',
+  id: ['Player1', 'MyRobut'],
+  nodes: [
+    new dtcEngine.Type.Vector3(114.7985155712282, 34.842421780635625, 2),
+    new dtcEngine.Type.Vector3(114.79789723105696, 34.84218433379876, 1.5)
+  ],
+  isCache: false,
+  planColor: '#00ff00',
+  passColor: '#e1e1e1'
+}, (result) => { console.log(result); });
+```
+
+***
+
+### pauseNav()
+
+> **pauseNav**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+暂停模型对象网格导航。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`NavigationNodeRequest`](../../types/interfaces/NavigationNodeRequest.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.Navigation.pauseNav({ parentId: 'Players', id: 'Player1' }, (result) => { console.log(result); });
+```
+
+***
+
+### resumeNav()
+
+> **resumeNav**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+继续模型对象网格导航。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`NavigationNodeRequest`](../../types/interfaces/NavigationNodeRequest.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.Navigation.resumeNav({ parentId: 'Players', id: ['Player1', 'MyRobut'] }, (result) => { console.log(result); });
+```
+
+***
+
+### stopNav()
+
+> **stopNav**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+停止模型对象网格导航。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`NavigationNodeRequest`](../../types/interfaces/NavigationNodeRequest.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.Navigation.stopNav({ parentId: 'Players', id: ['Player1'] }, (result) => { console.log(result); });
+```
+
+***
+
+### updateNav()
+
+> **updateNav**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置网格导航路径属性。
+默认值：`speed=-1`（不改变速度）。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`NavigationUpdateMeshNavRequest`](../../types/interfaces/NavigationUpdateMeshNavRequest.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.Navigation.updateNav({
+  parentId: 'Players',
+  id: 'Player1', 
+  planColor: '#00ff00',
+  passColor: '#e1e1e1',
+  speed: 4
+}, (result) => { console.log(result); });
+```
+
+***
+
+### updateSpeed()
+
+> **updateSpeed**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置网格导航路径属性。
+默认值：`speed=-1`（不改变速度）。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`NavigationUpdateSpeedRequest`](../../types/interfaces/NavigationUpdateSpeedRequest.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.Navigation.updateSpeed({
+   parentId: 'Players',
+   id: 'Player1',
+   speed: 4
+ }, (result) => { console.log(result); });
+```
+
+***
+
+### startNavByPath()
+
+> **startNavByPath**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+路径导航开始：根据指定的轨迹节点进行直线导航行走。
+默认值：`isCache=true`、`duration=10`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`NavigationNavByPathRequest`](../../types/interfaces/NavigationNavByPathRequest.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.Navigation.startNavByPath({
+  parentId: 'Players',
+  id: ['Player1', 'MyRobut'],
+  nodes: [
+    new dtcEngine.Type.Vector3(114.7985155712282, 34.842421780635625, 2),
+    new dtcEngine.Type.Vector3(114.79789723105696, 34.84218433379876, 1.5),
+    new dtcEngine.Type.Vector3(114.79790138598447, 34.842529820659664, 2)
+  ],
+  isCache: false,
+  duration: 10
+}, (result) => { console.log(result); });
+```
+
+***
+
+### pauseNavPath()
+
+> **pauseNavPath**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+暂停模型对象路径导航。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`NavigationNodeRequest`](../../types/interfaces/NavigationNodeRequest.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.Navigation.pauseNavPath({ parentId: 'Players', id: ['Player1', 'MyRobut'] }, (result) => { console.log(result); });
+```
+
+***
+
+### resumeNavPath()
+
+> **resumeNavPath**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+继续模型对象路径导航。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`NavigationNodeRequest`](../../types/interfaces/NavigationNodeRequest.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.Navigation.resumeNavPath({ parentId: 'Players', id: ['Player1', 'MyRobut'] }, (result) => { console.log(result); });
+```
+
+***
+
+### stopNavPath()
+
+> **stopNavPath**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+停止模型对象路径导航。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`NavigationNodeRequest`](../../types/interfaces/NavigationNodeRequest.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.Navigation.stopNavPath({ parentId: 'Players', id: ['Player1'] }, (result) => { console.log(result); });
+```
+
+***
+
+### updateNavPath()
+
+> **updateNavPath**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置路径导航属性。
+默认值：`duration=-1`（不改变时长）。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`NavigationUpdateNavPathRequest`](../../types/interfaces/NavigationUpdateNavPathRequest.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.Navigation.updateNavPath({
+  parentId: 'Players',
+  id: ['Player1', 'MyRobut'],
+  planColor: '#00ff00',
+  passColor: '#e1e1e1',
+  duration: 5
+}, (result) => { console.log(result); });
+```

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

@@ -50,6 +50,10 @@ DTCEngine 已完成鉴权并建立 WebRTC 连接
 
 low
 
+#### Agent Response Mode
+
+stream
+
 #### Agent Example
 
 #### Example
@@ -115,10 +119,10 @@ low
 #### Example
 
 ```ts
-dtcEngine.PathPatrol.update(
-  { parentId: 'patrolLayer', id: 'patrolMan', lineColor: '#ff00ff', lineWidth: 3.5 },
-  (result) => { console.log(result); }
-);
+ dtcEngine.PathPatrol.update(
+   { parentId: 'patrolLayer', id: 'patrolMan', lineColor: '#ff00ff', lineWidth: 3.5 },
+   (result) => { console.log(result); }
+ );
 ```
 
 ***