@nnepoch/dtc-sdk 3.0.10 → 3.0.12

package/docs/api/api/classes/TrainSimulate.md

@@ -0,0 +1,250 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / TrainSimulate
+
+# Class: TrainSimulate
+
+列车模拟 API，支持启动列车、设置列车运动方式与音量、相机跟随/取消跟随列车。
+
+## Agent Title
+
+列车模拟
+
+## Agent Capabilities
+
+列车启动, 列车运动方式设置, 列车音量设置, 相机跟随列车, 取消相机跟随列车
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### startTrain()
+
+> **startTrain**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置火车的动态并启动列车。
+默认值：`direction='0'`、`action='1'`、`stopTime=180`、`moveType=StopAtTheEnd`。
+`id` 为必填的唯一编号；`parentId` 用于避免重名，可不填。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`TrainSimulateStartTrainRequest`](../../types/interfaces/TrainSimulateStartTrainRequest.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.TrainSimulate.startTrain(
+   {
+     parentId: 'RailTrains',
+     id: 'DTrain1',
+     trainCode: 'G501',
+     startStationName: '北京',
+     endStationName: '上海',
+     direction: '0',
+     action: '1',
+     stopTime: 180,
+     moveType: dtcEngine.Enums.TrainBehavior.StopAtTheEnd
+   },
+   (result) => { console.log(result); }
+ );
+```
+
+***
+
+### setTrainBehavior()
+
+> **setTrainBehavior**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置火车的运动方式。
+默认值：`moveType=StopAtTheEnd`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`TrainSimulateSetTrainBehaviorRequest`](../../types/interfaces/TrainSimulateSetTrainBehaviorRequest.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.TrainSimulate.setTrainBehavior(
+   { parentId: 'RailTrains', id: 'DTrain1', moveType: dtcEngine.Enums.TrainBehavior.Loop },
+   (result) => { console.log(result); }
+ );
+```
+
+***
+
+### setCameraFollowTrain()
+
+> **setCameraFollowTrain**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置相机跟随火车。
+内部调用相机模块的 `Camera.startCameraObjFollow` 接口实现。
+默认偏移量 `offSet=(-100, 0, 30)`，坐标类型固定为 `'0000'`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`TrainSimulateSetCameraFollowTrainRequest`](../../types/interfaces/TrainSimulateSetCameraFollowTrainRequest.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.TrainSimulate.setCameraFollowTrain(
+   { parentId: 'RailTrains', id: 'DTrain1', offSet: new dtcEngine.Type.Vector3(26, 18, 15) },
+   (result) => { console.log(result); }
+ );
+```
+
+***
+
+### setTrainVolume()
+
+> **setTrainVolume**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置火车的声音的开关。
+默认值：`volumeOn=true`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`TrainSimulateSetTrainVolumeRequest`](../../types/interfaces/TrainSimulateSetTrainVolumeRequest.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.TrainSimulate.setTrainVolume(
+   { parentId: '', id: 'Train1', volumeOn: false },
+   (result) => { console.log(result); }
+ );
+// 响应示例：{ code: 0, message: 'success', data: null }
+```
+
+***
+
+### cancelCameraFollowTrain()
+
+> **cancelCameraFollowTrain**(`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.TrainSimulate.cancelCameraFollowTrain((result) => { console.log(result); });
+```

package/docs/api/api/classes/WeatherSystem.md

@@ -10,7 +10,7 @@
 
 ## Agent Capabilities
 
-天气类型查询, 天气切换, 天气重置, 天气时间重置, 场景时间设置, 时间同步控制, 昼夜动画控制, 昼夜模式设置, 季节切换, 季节重置, 雾效开启, 雾效关闭
+天气类型查询, 天气切换, 天气重置, 天气时间重置, 场景时间设置, 时间同步控制, 昼夜动画控制, 昼夜模式设置, 季节切换, 季节重置, 雾效开启, 雾效关闭, 天气音量控制
 
 ## Extends
 
@@ -54,9 +54,9 @@ low
 #### Example
 
 ```ts
-dtcEngine.WeatherSystem.changeWeatherType({ type: 0, timeDuration: 60 }, (result) => {
-  console.log(result);
-});
+ dtcEngine.WeatherSystem.changeWeatherType({ weatherType: 'Clear_Skies', timeDuration: 6 }, (result) => {
+   console.log(result);
+ });
 ```
 
 ***
@@ -65,7 +65,7 @@ dtcEngine.WeatherSystem.changeWeatherType({ type: 0, timeDuration: 60 }, (result
 
 > **getWeatherTypes**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
 
-得到所有天气类型
+得到所有天气类型。
 备注：（需在配置 提前预制UDS天气系统）
 
 #### Parameters
@@ -100,7 +100,7 @@ low
 #### Example
 
 ```
-dtcEngine.WeatherSystem.getWeatherTypes((result)=>{console.log(result)})
+ dtcEngine.WeatherSystem.getWeatherTypes((result)=>{console.log(result)})
 ```
 
 ***
@@ -497,6 +497,55 @@ dtcEngine.WeatherSystem.setDayAndNight({ dayType: 'night' }, (result) => {
 
 ***
 
+### setWeatherVolume()
+
+> **setWeatherVolume**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置天气声音的开关。
+默认值：`volumeOn=true`。`true` 开启，`false` 关闭。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`WeatherSetVolumeRequest`](../../types/interfaces/WeatherSetVolumeRequest.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.WeatherSystem.setWeatherVolume({ volumeOn: false }, (result) => {
+   console.log(result);
+ });
+示例2： 开启天气声音
+ dtcEngine.WeatherSystem.setWeatherVolume({ volumeOn: true }, (result) => {
+   console.log(result);
+ });
+```
+
+***
+
 ### openCameraFog()
 
 > **openCameraFog**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>

package/docs/api/api/classes/WebView.md

@@ -0,0 +1,61 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / WebView
+
+# Class: WebView
+
+网页视图（WebView）管理 API。
+
+## Agent Title
+
+网页视图
+
+## Agent Capabilities
+
+网页视图更新
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### updateWebView()
+
+> **updateWebView**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+更新网页视图参数。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`WebViewUpdateRequest`](../../types/interfaces/WebViewUpdateRequest.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.WebView.updateWebView(
+   { parentId: 'WebViews', id: 'tv1', url: 'http://www.163.com'},
+   (result) => { console.log(result); }
+ );
+```

package/docs/api/api/index.md

@@ -8,27 +8,38 @@
 - [Camera](classes/Camera.md)
 - [Connect](classes/Connect.md)
 - [Dlss](classes/Dlss.md)
+- [GizmosTool](classes/GizmosTool.md)
+- [HeatMap](classes/HeatMap.md)
 - [HighLighterEffect](classes/HighLighterEffect.md)
 - [Layer](classes/Layer.md)
 - [Model](classes/Model.md)
 - [ModelPOI](classes/ModelPOI.md)
 - [ModelTransform](classes/ModelTransform.md)
+- [Navigation](classes/Navigation.md)
 - [PathPatrol](classes/PathPatrol.md)
+- [PointEditor](classes/PointEditor.md)
+- [PointIcon](classes/PointIcon.md)
 - [Popup](classes/Popup.md)
 - [Scene](classes/Scene.md)
 - [Screen](classes/Screen.md)
+- [SpatialQuery](classes/SpatialQuery.md)
 - [TimeLine](classes/TimeLine.md)
+- [TrainSimulate](classes/TrainSimulate.md)
 - [UIPOI](classes/UIPOI.md)
 - [WeatherSystem](classes/WeatherSystem.md)
+- [WebView](classes/WebView.md)
 - [ApiRegistryError](classes/ApiRegistryError.md)
 
 ## Interfaces
 
+- [PointIconVisibilityResult](interfaces/PointIconVisibilityResult.md)
+- [PointIconIdsRequest](interfaces/PointIconIdsRequest.md)
 - [ApiRegistryContext](interfaces/ApiRegistryContext.md)
 - [ApiInstanceMap](interfaces/ApiInstanceMap.md)
 
 ## Type Aliases
 
+- [PointIconIdsInput](type-aliases/PointIconIdsInput.md)
 - [ApiModuleKey](type-aliases/ApiModuleKey.md)
 - [ApiModuleFactory](type-aliases/ApiModuleFactory.md)
 - [ApiRegistry](type-aliases/ApiRegistry.md)

package/docs/api/api/interfaces/ApiInstanceMap.md

@@ -72,12 +72,46 @@
 
 ***
 
+### Navigation
+
+> **Navigation**: [`Navigation`](../classes/Navigation.md)
+
+***
+
 ### PathPatrol
 
 > **PathPatrol**: [`PathPatrol`](../classes/PathPatrol.md)
 
 ***
 
+### pointIcon
+
+> **pointIcon**: [`PointIcon`](../classes/PointIcon.md)
+
+***
+
+### PointEditor
+
+> **PointEditor**: [`PointEditor`](../classes/PointEditor.md)
+
+网页 MODEL 点位编辑（不支持独立 POI）。
+
+***
+
+### GizmosTool
+
+> **GizmosTool**: [`GizmosTool`](../classes/GizmosTool.md)
+
+网页 MODEL 的运行时 Gizmo。
+
+***
+
+### HeatMap
+
+> **HeatMap**: [`HeatMap`](../classes/HeatMap.md)
+
+***
+
 ### HighlighterEffect
 
 > **HighlighterEffect**: [`HighLighterEffect`](../classes/HighLighterEffect.md)
@@ -105,3 +139,21 @@
 ### WeatherSystem
 
 > **WeatherSystem**: [`WeatherSystem`](../classes/WeatherSystem.md)
+
+***
+
+### WebView
+
+> **WebView**: [`WebView`](../classes/WebView.md)
+
+***
+
+### SpatialQuery
+
+> **SpatialQuery**: [`SpatialQuery`](../classes/SpatialQuery.md)
+
+***
+
+### TrainSimulate
+
+> **TrainSimulate**: [`TrainSimulate`](../classes/TrainSimulate.md)

package/docs/api/api/interfaces/ApiRegistryContext.md

@@ -24,7 +24,7 @@ API 装配上下文，统一承载模块工厂需要的依赖。
 
 ***
 
-### createLogger()
+### createLogger
 
 > **createLogger**: (`moduleName`) => `ModuleLogger`
 
@@ -45,3 +45,23 @@ API 装配上下文，统一承载模块工厂需要的依赖。
 > **popupManager**: `PopupManager`
 
 前端 Popup 管理器。
+
+***
+
+### videoElementParent?
+
+> `optional` **videoElementParent?**: `HTMLElement`
+
+当前实例的视频宿主，用于网页点位落点换算。
+
+***
+
+### beginPointEditorMouseInput?
+
+> `optional` **beginPointEditorMouseInput?**: () => () => `void`
+
+临时启用官方鼠标输入，退出时恢复原配置。
+
+#### Returns
+
+() => `void`

package/docs/api/api/interfaces/PointIconIdsRequest.md

@@ -0,0 +1,9 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / PointIconIdsRequest
+
+# Interface: PointIconIdsRequest
+
+## Properties
+
+### ids
+
+> **ids**: `string`[]

package/docs/api/api/interfaces/PointIconVisibilityResult.md

@@ -0,0 +1,31 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / PointIconVisibilityResult
+
+# Interface: PointIconVisibilityResult
+
+## Properties
+
+### requestedCount
+
+> **requestedCount**: `number`
+
+***
+
+### affectedCount
+
+> **affectedCount**: `number`
+
+***
+
+### notFoundIds?
+
+> `optional` **notFoundIds?**: `string`[]
+
+按 ids 调用（show/hide/showByGroup/hideByGroup）时返回；按 codes 调用时该字段缺失。
+
+***
+
+### notFoundCodes?
+
+> `optional` **notFoundCodes?**: `string`[]
+
+按 codes 调用（showByCode/hideByCode）时返回；按 ids 调用时该字段缺失。

package/docs/api/api/type-aliases/ApiModuleFactory.md

@@ -1,6 +1,6 @@
 [@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / ApiModuleFactory
 
-# Type Alias: ApiModuleFactory()\<TModuleKey\>
+# Type Alias: ApiModuleFactory\<TModuleKey\>
 
 > **ApiModuleFactory**\<`TModuleKey`\> = (`context`) => [`ApiInstanceMap`](../interfaces/ApiInstanceMap.md)\[`TModuleKey`\]
 

package/docs/api/api/type-aliases/PointIconIdsInput.md

@@ -0,0 +1,5 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / PointIconIdsInput
+
+# Type Alias: PointIconIdsInput
+
+> **PointIconIdsInput** = `string`[] \| [`PointIconIdsRequest`](../interfaces/PointIconIdsRequest.md)