@nnepoch/dtc-sdk 3.0.7 → 3.0.9

package/dist/cjs/index.d.cts

@@ -2264,8 +2264,8 @@ interface TrainSimulateSetTrainVolumeRequest {
   parentId?: string;
   /** 唯一编号，必填。 */
   id: string;
-  /** 音量大小，取值 0-1，默认 0.5。 */
-  volume?: number;
+  /** 声音是否开启，默认 true。 */
+  volumeOn?: boolean;
 }
 //#endregion
 //#region src/types/buildingFloor.d.ts
@@ -3430,22 +3430,22 @@ declare class Camera extends BaseApi {
    */
   reset(callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
   /**
-   * 相机跟随场景中运动的对象。
-   * 默认值：`smooth=0.85`。
-   * @param payload - 跟随参数。
-   * @param callback - 可选回调函数。
-   * @returns Promise 形式的接口响应。
-   * @agentSideEffects write
-   * @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
-   * @agentRiskLevel low
-   * @agentExample { id: 'myCar', offSet: { x: 0, y: 3, z: 5, ePSGType: '0000' }, smooth: 0.85 }
-   * @example
-   * ```ts
-   * dtcEngine.Camera.startCameraObjFollow({ id: 'myCar', offSet: new dtcEngine.Type.Vector3(0, 3, 5), smooth: 0.85 }, (result) => {
-   *   console.log(result);
-   * });
-   * ```
-   */
+     * 相机跟随场景中运动的对象。
+     * 默认值：`smooth=0.85`。
+     * @param payload - 跟随参数。
+     * @param callback - 可选回调函数。
+     * @returns Promise 形式的接口响应。
+     * @agentSideEffects write
+     * @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
+     * @agentRiskLevel low
+     * @agentExample { id: 'myCar', offSet: { x: 0, y: 3, z: 5, ePSGType: '0000' }, smooth: 0.85 }
+     * @example
+     * ```ts
+      dtcEngine.Camera.startCameraObjFollow({ id: 'myCar', offSet: new dtcEngine.Type.Vector3(0, 3, 5), smooth: 0.85 }, (result) => {
+        console.log(result);
+      });
+     * ```
+     */
   startCameraObjFollow(payload: CameraObjFollowRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
   /**
    * 停止相机跟随。
@@ -4396,6 +4396,8 @@ declare class Navigation extends BaseApi {
      * @agentExample { parentId: 'Players', id: 'Player1', nodes: [{ x: 114.7985155712282, y: 34.842421780635625, z: 2 }, { x: 114.79789723105696, y: 34.84218433379876, z: 1.5 }], isCache: false, planColor: '#00ff00', passColor: '#e1e1e1' }
      * @example
      * ```ts
+     *
+     * 示例1：模型对象根据路过的节点进行导航
       dtcEngine.Navigation.startNav({
         parentId: 'Players',
         id: 'Player1',
@@ -4412,6 +4414,52 @@ declare class Navigation extends BaseApi {
         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();
+                      }
+                  });
      * ```
      */
   startNav(payload: NavigationMeshNavRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
@@ -4778,17 +4826,24 @@ declare class PathPatrol extends BaseApi {
 interface PointIconVisibilityResult {
   requestedCount: number;
   affectedCount: number;
-  notFoundIds: string[];
+  /** 按 ids 调用（show/hide/showByGroup/hideByGroup）时返回；按 codes 调用时该字段缺失。 */
+  notFoundIds?: string[];
+  /** 按 codes 调用（showByCode/hideByCode）时返回；按 ids 调用时该字段缺失。 */
+  notFoundCodes?: string[];
 }
 interface PointIconIdsRequest {
   ids: string[];
 }
 type PointIconIdsInput = string[] | PointIconIdsRequest;
+interface PointIconCodesRequest {
+  codes: string[];
+}
+type PointIconCodesInput = string[] | PointIconCodesRequest;
 type PointIconResponse = ApiResponseEnvelope<PointIconVisibilityResult>;
 /**
  * 设备点位图标显隐控制 API。
  * @agentTitle 设备点位图标
- * @agentCapabilities 指定点位显隐, 分组点位显隐, 全部点位显隐
+ * @agentCapabilities 指定点位显隐, 按编码点位显隐, 分组点位显隐, 全部点位显隐
  * @hideconstructor
  */
 declare class PointIcon extends BaseApi {
@@ -4809,6 +4864,22 @@ declare class PointIcon extends BaseApi {
    * @agentExample { ids: ['point-001', 'point-002'] }
    */
   hide(payload: PointIconIdsInput, callback?: ApiCallback<PointIconResponse>): Promise<PointIconResponse>;
+  /**
+   * 显示指定编码（code）的全部设备点位图标，编码精确匹配且不要求唯一。
+   * @agentSideEffects write
+   * @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
+   * @agentRiskLevel low
+   * @agentExample { codes: ['CAM-001', 'CAM-002'] }
+   */
+  showByCode(payload: PointIconCodesInput, callback?: ApiCallback<PointIconResponse>): Promise<PointIconResponse>;
+  /**
+   * 隐藏指定编码（code）的全部设备点位图标，编码精确匹配且不要求唯一。
+   * @agentSideEffects write
+   * @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
+   * @agentRiskLevel low
+   * @agentExample { codes: ['CAM-001', 'CAM-002'] }
+   */
+  hideByCode(payload: PointIconCodesInput, callback?: ApiCallback<PointIconResponse>): Promise<PointIconResponse>;
   /**
    * 显示指定分组及其子分组内的设备点位图标。
    * @agentSideEffects write
@@ -5762,93 +5833,98 @@ declare class SpatialQuery extends BaseApi {
  * @hideconstructor
  */
 declare class TrainSimulate extends BaseApi {
-  constructor(bridge: ApiBridge, runtimeOptions?: BaseApiRuntimeOptions);
   /**
-   * 设置火车的动态并启动列车。
-   * 默认值：`direction='0'`、`action='1'`、`stopTime=180`、`moveType=StopAtTheEnd`。
-   * `id` 为必填的唯一编号；`parentId` 用于避免重名，可不填。
-   * @param payload - 列车启动参数。
-   * @param callback - 可选回调函数。
-   * @returns Promise 形式的接口响应。
-   * @agentSideEffects write
-   * @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
-   * @agentRiskLevel low
-   * @agentExample { parentId: 'RailTrains', id: 'DTrain1', trainCode: 'G501', startStationName: '北京', endStationName: '上海', direction: '0', action: '1', stopTime: 180, moveType: 'StopAtTheEnd' }
-   * @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); }
-   * );
-   * ```
+   * 相机模块实例，`setCameraFollowTrain` 复用其 `startCameraObjFollow` 接口。
    */
+  private readonly camera;
+  constructor(bridge: ApiBridge, runtimeOptions?: BaseApiRuntimeOptions);
+  /**
+     * 设置火车的动态并启动列车。
+     * 默认值：`direction='0'`、`action='1'`、`stopTime=180`、`moveType=StopAtTheEnd`。
+     * `id` 为必填的唯一编号；`parentId` 用于避免重名，可不填。
+     * @param payload - 列车启动参数。
+     * @param callback - 可选回调函数。
+     * @returns Promise 形式的接口响应。
+     * @agentSideEffects write
+     * @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
+     * @agentRiskLevel low
+     * @agentExample { parentId: 'RailTrains', id: 'DTrain1', trainCode: 'G501', startStationName: '北京', endStationName: '上海', direction: '0', action: '1', stopTime: 180, moveType: 'StopAtTheEnd' }
+     * @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); }
+      );
+     * ```
+     */
   startTrain(payload: TrainSimulateStartTrainRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
   /**
-   * 设置火车的运动方式。
-   * 默认值：`moveType=StopAtTheEnd`。
-   * @param payload - 列车运动方式参数。
-   * @param callback - 可选回调函数。
-   * @returns Promise 形式的接口响应。
-   * @agentSideEffects write
-   * @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
-   * @agentRiskLevel low
-   * @agentExample { parentId: 'RailTrains', id: 'DTrain1', moveType: 'Loop' }
-   * @example
-   * ```ts
-   * dtcEngine.TrainSimulate.setTrainBehavior(
-   *   { parentId: 'RailTrains', id: 'DTrain1', moveType: dtcEngine.Enums.TrainBehavior.Loop },
-   *   (result) => { console.log(result); }
-   * );
-   * ```
-   */
+     * 设置火车的运动方式。
+     * 默认值：`moveType=StopAtTheEnd`。
+     * @param payload - 列车运动方式参数。
+     * @param callback - 可选回调函数。
+     * @returns Promise 形式的接口响应。
+     * @agentSideEffects write
+     * @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
+     * @agentRiskLevel low
+     * @agentExample { parentId: 'RailTrains', id: 'DTrain1', moveType: 'Loop' }
+     * @example
+     * ```ts
+      dtcEngine.TrainSimulate.setTrainBehavior(
+        { parentId: 'RailTrains', id: 'DTrain1', moveType: dtcEngine.Enums.TrainBehavior.Loop },
+        (result) => { console.log(result); }
+      );
+     * ```
+     */
   setTrainBehavior(payload: TrainSimulateSetTrainBehaviorRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
   /**
-   * 设置相机跟随火车。
-   * 默认偏移量 `offSet=(26, 18, 15)`，坐标类型固定为 `'0000'`。
-   * @param payload - 相机跟随参数。
-   * @param callback - 可选回调函数。
-   * @returns Promise 形式的接口响应。
-   * @agentSideEffects write
-   * @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
-   * @agentRiskLevel low
-   * @agentExample { parentId: 'RailTrains', id: 'DTrain1', offSet: { x: 26, y: 18, z: 15, ePSGType: '0000' } }
-   * @example
-   * ```ts
-   * dtcEngine.TrainSimulate.setCameraFollowTrain(
-   *   { parentId: 'RailTrains', id: 'DTrain1', offSet: new dtcEngine.Type.Vector3(26, 18, 15) },
-   *   (result) => { console.log(result); }
-   * );
-   * ```
-   */
+     * 设置相机跟随火车。
+     * 内部调用相机模块的 `Camera.startCameraObjFollow` 接口实现。
+     * 默认偏移量 `offSet=(-100, 0, 30)`，坐标类型固定为 `'0000'`。
+     * @param payload - 相机跟随参数。
+     * @param callback - 可选回调函数。
+     * @returns Promise 形式的接口响应。
+     * @agentSideEffects write
+     * @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
+     * @agentRiskLevel low
+     * @agentExample { parentId: 'RailTrains', id: 'DTrain1', offSet: { x: 26, y: 18, z: 15, ePSGType: '0000' } }
+     * @example
+     * ```ts
+     dtcEngine.TrainSimulate.setCameraFollowTrain(
+        { parentId: 'RailTrains', id: 'DTrain1', offSet: new dtcEngine.Type.Vector3(26, 18, 15) },
+        (result) => { console.log(result); }
+      );
+     * ```
+     */
   setCameraFollowTrain(payload: TrainSimulateSetCameraFollowTrainRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
   /**
-   * 设置火车的音量大小。
-   * 默认值：`volume=0.5`，取值范围 0-1。
-   * @param payload - 列车音量参数。
-   * @param callback - 可选回调函数。
-   * @returns Promise 形式的接口响应。
-   * @agentSideEffects write
-   * @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
-   * @agentRiskLevel low
-   * @agentExample { parentId: 'RailTrains', id: 'DTrain1', volume: 0.5 }
-   * @example
-   * ```ts
-   * dtcEngine.TrainSimulate.setTrainVolume(
-   *   { parentId: 'RailTrains', id: 'DTrain1', volume: 0.5 },
-   *   (result) => { console.log(result); }
-   * );
-   * ```
-   */
+     * 设置火车的声音的开关。
+     * 默认值：`volumeOn=true`。
+     * @param payload - 列车声音参数。
+     * @param callback - 可选回调函数。
+     * @returns Promise 形式的接口响应。
+     * @agentSideEffects write
+     * @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
+     * @agentRiskLevel low
+     * @agentExample { parentId: 'RailTrains', id: 'DTrain1', volumeOn: false } => { code: 0, message: 'success', data: null }
+     * @example
+     * ```ts
+     dtcEngine.TrainSimulate.setTrainVolume(
+        { parentId: '', id: 'Train1', volumeOn: false },
+        (result) => { console.log(result); }
+      );
+     * ```
+     */
   setTrainVolume(payload: TrainSimulateSetTrainVolumeRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
   /**
    * 取消相机跟随火车，无需传参。
@@ -6691,6 +6767,9 @@ declare class DTCEngine {
     readonly LoadMQTTDataFinished: "LoadMQTTDataFinished";
     /** 设备数据加载进度事件 */
     readonly LoadMQTTDataProgress: "LoadMQTTDataProgress";
+    /** 列车可见性变化事件 */
+    readonly TrainsVisible: "TrainsVisible";
+    readonly TrainsInfo: "TrainsInfo";
   };
   readonly Enums: {
     DlssQuality: {