@nnepoch/dtc-sdk 3.0.11 → 3.0.12

package/docs/api/types/interfaces/NavigationMeshNavRequest.md

@@ -0,0 +1,121 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / NavigationMeshNavRequest
+
+# Interface: NavigationMeshNavRequest
+
+Navigation.startMeshNav / getMeshNavDistance 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId?**: `string`
+
+对象组的父对象，可以为空。
+
+***
+
+### id
+
+> **id**: `string`
+
+对象名称数组集合。
+
+***
+
+### nodes?
+
+> `optional` **nodes?**: [`Vector3Input`](../type-aliases/Vector3Input.md)[]
+
+路径节点数组集合，与 `targetIds` 二选一。
+
+***
+
+### targetIds?
+
+> `optional` **targetIds?**: `string`[]
+
+路径节点经过的目标对象名称数组集合，与 `nodes` 二选一；需保证场景中各编号对象唯一存在。
+
+***
+
+### targetCodes?
+
+> `optional` **targetCodes?**: `string`[]
+
+***
+
+### speed?
+
+> `optional` **speed?**: `number`
+
+物体移动的速度，默认 1。
+
+***
+
+### isCache?
+
+> `optional` **isCache?**: `boolean`
+
+是否作为导航缓存路径点，默认 `true`；`true` 表示将节点加入缓存路径，下次修改时前置节点仍会经过，`false` 表示按新路径导航。
+
+***
+
+### planColor?
+
+> `optional` **planColor?**: `string`
+
+导航规划路径颜色。
+
+***
+
+### passColor?
+
+> `optional` **passColor?**: `string`
+
+导航已走过的路径颜色。
+
+***
+
+### lineWidth?
+
+> `optional` **lineWidth?**: `number`
+
+导航规划线的宽度，默认 1。
+
+***
+
+### isAutoPlay?
+
+> `optional` **isAutoPlay?**: `boolean`
+
+是否自动播放，默认 `true`。
+
+***
+
+### assetPath?
+
+> `optional` **assetPath?**: `string`
+
+场景的模型路径，可为空；为空时根据 id 到场景中寻找模型对象。
+
+***
+
+### scale?
+
+> `optional` **scale?**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+模型缩放比例，默认 1。
+
+***
+
+### isAutoClear?
+
+> `optional` **isAutoClear?**: `boolean`
+
+是否自动清除，默认 `true`。
+
+***
+
+### offSetZ?
+
+> `optional` **offSetZ?**: `number`

package/docs/api/types/interfaces/NavigationNavByPathRequest.md

@@ -0,0 +1,61 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / NavigationNavByPathRequest
+
+# Interface: NavigationNavByPathRequest
+
+Navigation.startNavByPath 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId?**: `string`
+
+对象组的父对象，可以为空。
+
+***
+
+### id
+
+> **id**: `string`[]
+
+对象名称数组集合。
+
+***
+
+### nodes
+
+> **nodes**: [`Vector3Input`](../type-aliases/Vector3Input.md)[]
+
+路径节点数组集合。
+
+***
+
+### isCache?
+
+> `optional` **isCache?**: `boolean`
+
+是否作为导航缓存路径点，默认 `true`。
+
+***
+
+### duration?
+
+> `optional` **duration?**: `number`
+
+导航轨迹总时间（秒），默认 10。
+
+***
+
+### planColor?
+
+> `optional` **planColor?**: `string`
+
+导航规划路径颜色。
+
+***
+
+### passColor?
+
+> `optional` **passColor?**: `string`
+
+导航已走过的路径颜色。

package/docs/api/types/interfaces/NavigationNodeRequest.md

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / NavigationNodeRequest
+
+# Interface: NavigationNodeRequest
+
+Navigation.pauseMeshNav / resumeMeshNav / stopMeshNav / pauseNavPath / resumeNavPath / stopNavPath 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId?**: `string`
+
+对象组的父对象，可以为空。
+
+***
+
+### id
+
+> **id**: `string`
+
+对象名称数组集合。

package/docs/api/types/interfaces/NavigationUpdateMeshNavRequest.md

@@ -0,0 +1,45 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / NavigationUpdateMeshNavRequest
+
+# Interface: NavigationUpdateMeshNavRequest
+
+Navigation.updateMeshNav 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId?**: `string`
+
+对象组的父对象，可以为空。
+
+***
+
+### id
+
+> **id**: `string`
+
+对象名称数组集合。
+
+***
+
+### speed?
+
+> `optional` **speed?**: `number`
+
+物体移动的速度，默认 -1（不改变速度）。
+
+***
+
+### planColor?
+
+> `optional` **planColor?**: `string`
+
+导航规划路径颜色。
+
+***
+
+### passColor?
+
+> `optional` **passColor?**: `string`
+
+导航已走过的路径颜色。

package/docs/api/types/interfaces/NavigationUpdateNavPathRequest.md

@@ -0,0 +1,45 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / NavigationUpdateNavPathRequest
+
+# Interface: NavigationUpdateNavPathRequest
+
+Navigation.updateNavPath 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId?**: `string`
+
+对象组的父对象，可以为空。
+
+***
+
+### id
+
+> **id**: `string`[]
+
+对象名称数组集合。
+
+***
+
+### duration?
+
+> `optional` **duration?**: `number`
+
+导航轨迹总时间（秒），默认 -1（不改变时长）。
+
+***
+
+### planColor?
+
+> `optional` **planColor?**: `string`
+
+导航规划路径颜色。
+
+***
+
+### passColor?
+
+> `optional` **passColor?**: `string`
+
+导航已走过的路径颜色。

package/docs/api/types/interfaces/NavigationUpdateSpeedRequest.md

@@ -0,0 +1,27 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / NavigationUpdateSpeedRequest
+
+# Interface: NavigationUpdateSpeedRequest
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId?**: `string`
+
+对象组的父对象，可以为空。
+
+***
+
+### id
+
+> **id**: `string`
+
+对象名称数组集合。
+
+***
+
+### speed?
+
+> `optional` **speed?**: `number`
+
+物体移动的速度，默认 -1（不改变速度）。

package/docs/api/types/interfaces/NetworkAdaptationActionStep.md

@@ -26,4 +26,4 @@
 
 ### error?
 
-> `optional` **error**: `string`
+> `optional` **error?**: `string`

package/docs/api/types/interfaces/NetworkAdaptationState.md

@@ -38,4 +38,4 @@
 
 ### metrics?
 
-> `optional` **metrics**: [`NetworkMetricsSnapshot`](NetworkMetricsSnapshot.md)
+> `optional` **metrics?**: [`NetworkMetricsSnapshot`](NetworkMetricsSnapshot.md)

package/docs/api/types/interfaces/NetworkDecisionTrace.md

@@ -32,7 +32,7 @@
 
 ### targetLevel?
 
-> `optional` **targetLevel**: [`NetworkAdaptationLevel`](../type-aliases/NetworkAdaptationLevel.md)
+> `optional` **targetLevel?**: [`NetworkAdaptationLevel`](../type-aliases/NetworkAdaptationLevel.md)
 
 ***
 
@@ -50,4 +50,4 @@
 
 ### metrics?
 
-> `optional` **metrics**: [`NetworkMetricsSnapshot`](NetworkMetricsSnapshot.md)
+> `optional` **metrics?**: [`NetworkMetricsSnapshot`](NetworkMetricsSnapshot.md)

package/docs/api/types/interfaces/NetworkDiagnosticsSnapshot.md

@@ -38,13 +38,13 @@
 
 ### lastMetrics?
 
-> `optional` **lastMetrics**: [`NetworkMetricsSnapshot`](NetworkMetricsSnapshot.md)
+> `optional` **lastMetrics?**: [`NetworkMetricsSnapshot`](NetworkMetricsSnapshot.md)
 
 ***
 
 ### lastAction?
 
-> `optional` **lastAction**: [`NetworkAdaptationActionResult`](NetworkAdaptationActionResult.md)
+> `optional` **lastAction?**: [`NetworkAdaptationActionResult`](NetworkAdaptationActionResult.md)
 
 ***
 

package/docs/api/types/interfaces/NetworkMetricsSnapshot.md

@@ -20,40 +20,40 @@
 
 ### fps?
 
-> `optional` **fps**: `number`
+> `optional` **fps?**: `number`
 
 ***
 
 ### bitrateKbps?
 
-> `optional` **bitrateKbps**: `number`
+> `optional` **bitrateKbps?**: `number`
 
 ***
 
 ### packetLossRate?
 
-> `optional` **packetLossRate**: `number`
+> `optional` **packetLossRate?**: `number`
 
 ***
 
 ### jitterMs?
 
-> `optional` **jitterMs**: `number`
+> `optional` **jitterMs?**: `number`
 
 ***
 
 ### rttMs?
 
-> `optional` **rttMs**: `number`
+> `optional` **rttMs?**: `number`
 
 ***
 
 ### frameWidth?
 
-> `optional` **frameWidth**: `number`
+> `optional` **frameWidth?**: `number`
 
 ***
 
 ### frameHeight?
 
-> `optional` **frameHeight**: `number`
+> `optional` **frameHeight?**: `number`

package/docs/api/types/interfaces/PathPatrolAddRequest.md

@@ -8,7 +8,7 @@ PathPatrol.add 参数。
 
 ### parentId?
 
-> `optional` **parentId**: `string`
+> `optional` **parentId?**: `string`
 
 模型对象父对象编号。
 
@@ -24,7 +24,7 @@ PathPatrol.add 参数。
 
 ### assetPath?
 
-> `optional` **assetPath**: `string`
+> `optional` **assetPath?**: `string`
 
 场景的模型路径，可为空；为空时根据 id 到场景中寻找模型对象。
 
@@ -40,7 +40,7 @@ PathPatrol.add 参数。
 
 ### showPath?
 
-> `optional` **showPath**: `boolean`
+> `optional` **showPath?**: `boolean`
 
 是否显示巡逻轨迹，默认 `true`。
 
@@ -48,7 +48,7 @@ PathPatrol.add 参数。
 
 ### passedColor?
 
-> `optional` **passedColor**: `string`
+> `optional` **passedColor?**: `string`
 
 巡逻过的路径的显示颜色，默认 `#ffffff`。
 
@@ -56,7 +56,7 @@ PathPatrol.add 参数。
 
 ### lineColor?
 
-> `optional` **lineColor**: `string`
+> `optional` **lineColor?**: `string`
 
 未巡逻路径的颜色，默认 `#00ff00`。
 
@@ -72,7 +72,7 @@ PathPatrol.add 参数。
 
 ### duration?
 
-> `optional` **duration**: `number`
+> `optional` **duration?**: `number`
 
 全程所需时间。
 
@@ -80,7 +80,7 @@ PathPatrol.add 参数。
 
 ### nodes?
 
-> `optional` **nodes**: [`Vector3Input`](../type-aliases/Vector3Input.md)[]
+> `optional` **nodes?**: [`Vector3Input`](../type-aliases/Vector3Input.md)[]
 
 路径点的集合，至少需要 2 个节点。
 
@@ -88,7 +88,7 @@ PathPatrol.add 参数。
 
 ### timeNodes?
 
-> `optional` **timeNodes**: [`TimeSerialNode`](TimeSerialNode.md)[]
+> `optional` **timeNodes?**: [`TimeSerialNode`](TimeSerialNode.md)[]
 
 路径点时间序列的集合。
 
@@ -96,7 +96,7 @@ PathPatrol.add 参数。
 
 ### lineLayer?
 
-> `optional` **lineLayer**: `string`
+> `optional` **lineLayer?**: `string`
 
 线的图层，如 TransparentFX。
 
@@ -104,6 +104,14 @@ PathPatrol.add 参数。
 
 ### afterRender?
 
-> `optional` **afterRender**: `boolean`
+> `optional` **afterRender?**: `boolean`
 
 是否后渲染，默认 `false`；`true` 后渲染（渲染不会阻挡），`false` 前渲染。
+
+***
+
+### isAutoClear?
+
+> `optional` **isAutoClear?**: `boolean`
+
+是否自动清除，默认 `true`。

package/docs/api/types/interfaces/PathPatrolNodeRequest.md

@@ -8,7 +8,7 @@ PathPatrol.pause / resume / stop 参数。
 
 ### parentId?
 
-> `optional` **parentId**: `string`
+> `optional` **parentId?**: `string`
 
 模型对象父对象编号。
 

package/docs/api/types/interfaces/PathPatrolSetTimeNodeRequest.md

@@ -8,7 +8,7 @@ PathPatrol.setTimeNode 参数。
 
 ### parentId?
 
-> `optional` **parentId**: `string`
+> `optional` **parentId?**: `string`
 
 模型对象父对象编号。
 
@@ -24,7 +24,7 @@ PathPatrol.setTimeNode 参数。
 
 ### timeStart?
 
-> `optional` **timeStart**: `string`
+> `optional` **timeStart?**: `string`
 
 时间节点，格式为 "2025-09-10 00:05:00"。`timeStart` 与 `startNodeIndex` 只能有一个不为空。
 
@@ -32,6 +32,6 @@ PathPatrol.setTimeNode 参数。
 
 ### startNodeIndex?
 
-> `optional` **startNodeIndex**: `string`
+> `optional` **startNodeIndex?**: `string`
 
 开始节点索引，不能小于 0。`timeStart` 与 `startNodeIndex` 只能有一个不为空。

package/docs/api/types/interfaces/PathPatrolUpdateRequest.md

@@ -8,7 +8,7 @@ PathPatrol.update 参数。
 
 ### parentId?
 
-> `optional` **parentId**: `string`
+> `optional` **parentId?**: `string`
 
 模型对象父对象编号。
 
@@ -24,7 +24,7 @@ PathPatrol.update 参数。
 
 ### lineColor?
 
-> `optional` **lineColor**: `string`
+> `optional` **lineColor?**: `string`
 
 巡逻轨迹的颜色。
 
@@ -32,7 +32,7 @@ PathPatrol.update 参数。
 
 ### lineWidth?
 
-> `optional` **lineWidth**: `number`
+> `optional` **lineWidth?**: `number`
 
 巡逻路线的宽度。
 
@@ -40,7 +40,7 @@ PathPatrol.update 参数。
 
 ### passedColor?
 
-> `optional` **passedColor**: `string`
+> `optional` **passedColor?**: `string`
 
 巡逻过的路径的显示颜色。
 
@@ -48,6 +48,6 @@ PathPatrol.update 参数。
 
 ### speed?
 
-> `optional` **speed**: `number`
+> `optional` **speed?**: `number`
 
 调整速度，不能小于 0。