@nnepoch/dtc-sdk 3.0.8 → 3.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/dtc-sdk-3.0.9.js +2 -0
- package/dist/cjs/index.cjs +4 -4
- package/dist/cjs/index.d.cts +130 -99
- package/dist/esm/index.d.ts +130 -99
- package/dist/esm/index.js +4 -4
- package/package.json +1 -1
- package/dist/browser/dtc-sdk-3.0.8.js +0 -2
package/dist/cjs/index.d.cts
CHANGED
|
@@ -2264,8 +2264,8 @@ interface TrainSimulateSetTrainVolumeRequest {
|
|
|
2264
2264
|
parentId?: string;
|
|
2265
2265
|
/** 唯一编号,必填。 */
|
|
2266
2266
|
id: string;
|
|
2267
|
-
/**
|
|
2268
|
-
|
|
2267
|
+
/** 声音是否开启,默认 true。 */
|
|
2268
|
+
volumeOn?: boolean;
|
|
2269
2269
|
}
|
|
2270
2270
|
//#endregion
|
|
2271
2271
|
//#region src/types/buildingFloor.d.ts
|
|
@@ -3430,22 +3430,22 @@ declare class Camera extends BaseApi {
|
|
|
3430
3430
|
*/
|
|
3431
3431
|
reset(callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
|
|
3432
3432
|
/**
|
|
3433
|
-
|
|
3434
|
-
|
|
3435
|
-
|
|
3436
|
-
|
|
3437
|
-
|
|
3438
|
-
|
|
3439
|
-
|
|
3440
|
-
|
|
3441
|
-
|
|
3442
|
-
|
|
3443
|
-
|
|
3444
|
-
|
|
3445
|
-
|
|
3446
|
-
|
|
3447
|
-
|
|
3448
|
-
|
|
3433
|
+
* 相机跟随场景中运动的对象。
|
|
3434
|
+
* 默认值:`smooth=0.85`。
|
|
3435
|
+
* @param payload - 跟随参数。
|
|
3436
|
+
* @param callback - 可选回调函数。
|
|
3437
|
+
* @returns Promise 形式的接口响应。
|
|
3438
|
+
* @agentSideEffects write
|
|
3439
|
+
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
3440
|
+
* @agentRiskLevel low
|
|
3441
|
+
* @agentExample { id: 'myCar', offSet: { x: 0, y: 3, z: 5, ePSGType: '0000' }, smooth: 0.85 }
|
|
3442
|
+
* @example
|
|
3443
|
+
* ```ts
|
|
3444
|
+
dtcEngine.Camera.startCameraObjFollow({ id: 'myCar', offSet: new dtcEngine.Type.Vector3(0, 3, 5), smooth: 0.85 }, (result) => {
|
|
3445
|
+
console.log(result);
|
|
3446
|
+
});
|
|
3447
|
+
* ```
|
|
3448
|
+
*/
|
|
3449
3449
|
startCameraObjFollow(payload: CameraObjFollowRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
|
|
3450
3450
|
/**
|
|
3451
3451
|
* 停止相机跟随。
|
|
@@ -4826,17 +4826,24 @@ declare class PathPatrol extends BaseApi {
|
|
|
4826
4826
|
interface PointIconVisibilityResult {
|
|
4827
4827
|
requestedCount: number;
|
|
4828
4828
|
affectedCount: number;
|
|
4829
|
-
|
|
4829
|
+
/** 按 ids 调用(show/hide/showByGroup/hideByGroup)时返回;按 codes 调用时该字段缺失。 */
|
|
4830
|
+
notFoundIds?: string[];
|
|
4831
|
+
/** 按 codes 调用(showByCode/hideByCode)时返回;按 ids 调用时该字段缺失。 */
|
|
4832
|
+
notFoundCodes?: string[];
|
|
4830
4833
|
}
|
|
4831
4834
|
interface PointIconIdsRequest {
|
|
4832
4835
|
ids: string[];
|
|
4833
4836
|
}
|
|
4834
4837
|
type PointIconIdsInput = string[] | PointIconIdsRequest;
|
|
4838
|
+
interface PointIconCodesRequest {
|
|
4839
|
+
codes: string[];
|
|
4840
|
+
}
|
|
4841
|
+
type PointIconCodesInput = string[] | PointIconCodesRequest;
|
|
4835
4842
|
type PointIconResponse = ApiResponseEnvelope<PointIconVisibilityResult>;
|
|
4836
4843
|
/**
|
|
4837
4844
|
* 设备点位图标显隐控制 API。
|
|
4838
4845
|
* @agentTitle 设备点位图标
|
|
4839
|
-
* @agentCapabilities 指定点位显隐, 分组点位显隐, 全部点位显隐
|
|
4846
|
+
* @agentCapabilities 指定点位显隐, 按编码点位显隐, 分组点位显隐, 全部点位显隐
|
|
4840
4847
|
* @hideconstructor
|
|
4841
4848
|
*/
|
|
4842
4849
|
declare class PointIcon extends BaseApi {
|
|
@@ -4857,6 +4864,22 @@ declare class PointIcon extends BaseApi {
|
|
|
4857
4864
|
* @agentExample { ids: ['point-001', 'point-002'] }
|
|
4858
4865
|
*/
|
|
4859
4866
|
hide(payload: PointIconIdsInput, callback?: ApiCallback<PointIconResponse>): Promise<PointIconResponse>;
|
|
4867
|
+
/**
|
|
4868
|
+
* 显示指定编码(code)的全部设备点位图标,编码精确匹配且不要求唯一。
|
|
4869
|
+
* @agentSideEffects write
|
|
4870
|
+
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
4871
|
+
* @agentRiskLevel low
|
|
4872
|
+
* @agentExample { codes: ['CAM-001', 'CAM-002'] }
|
|
4873
|
+
*/
|
|
4874
|
+
showByCode(payload: PointIconCodesInput, callback?: ApiCallback<PointIconResponse>): Promise<PointIconResponse>;
|
|
4875
|
+
/**
|
|
4876
|
+
* 隐藏指定编码(code)的全部设备点位图标,编码精确匹配且不要求唯一。
|
|
4877
|
+
* @agentSideEffects write
|
|
4878
|
+
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
4879
|
+
* @agentRiskLevel low
|
|
4880
|
+
* @agentExample { codes: ['CAM-001', 'CAM-002'] }
|
|
4881
|
+
*/
|
|
4882
|
+
hideByCode(payload: PointIconCodesInput, callback?: ApiCallback<PointIconResponse>): Promise<PointIconResponse>;
|
|
4860
4883
|
/**
|
|
4861
4884
|
* 显示指定分组及其子分组内的设备点位图标。
|
|
4862
4885
|
* @agentSideEffects write
|
|
@@ -5810,93 +5833,98 @@ declare class SpatialQuery extends BaseApi {
|
|
|
5810
5833
|
* @hideconstructor
|
|
5811
5834
|
*/
|
|
5812
5835
|
declare class TrainSimulate extends BaseApi {
|
|
5813
|
-
constructor(bridge: ApiBridge, runtimeOptions?: BaseApiRuntimeOptions);
|
|
5814
5836
|
/**
|
|
5815
|
-
*
|
|
5816
|
-
* 默认值:`direction='0'`、`action='1'`、`stopTime=180`、`moveType=StopAtTheEnd`。
|
|
5817
|
-
* `id` 为必填的唯一编号;`parentId` 用于避免重名,可不填。
|
|
5818
|
-
* @param payload - 列车启动参数。
|
|
5819
|
-
* @param callback - 可选回调函数。
|
|
5820
|
-
* @returns Promise 形式的接口响应。
|
|
5821
|
-
* @agentSideEffects write
|
|
5822
|
-
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
5823
|
-
* @agentRiskLevel low
|
|
5824
|
-
* @agentExample { parentId: 'RailTrains', id: 'DTrain1', trainCode: 'G501', startStationName: '北京', endStationName: '上海', direction: '0', action: '1', stopTime: 180, moveType: 'StopAtTheEnd' }
|
|
5825
|
-
* @example
|
|
5826
|
-
* ```ts
|
|
5827
|
-
* dtcEngine.TrainSimulate.startTrain(
|
|
5828
|
-
* {
|
|
5829
|
-
* parentId: 'RailTrains',
|
|
5830
|
-
* id: 'DTrain1',
|
|
5831
|
-
* trainCode: 'G501',
|
|
5832
|
-
* startStationName: '北京',
|
|
5833
|
-
* endStationName: '上海',
|
|
5834
|
-
* direction: '0',
|
|
5835
|
-
* action: '1',
|
|
5836
|
-
* stopTime: 180,
|
|
5837
|
-
* moveType: dtcEngine.Enums.TrainBehavior.StopAtTheEnd
|
|
5838
|
-
* },
|
|
5839
|
-
* (result) => { console.log(result); }
|
|
5840
|
-
* );
|
|
5841
|
-
* ```
|
|
5837
|
+
* 相机模块实例,`setCameraFollowTrain` 复用其 `startCameraObjFollow` 接口。
|
|
5842
5838
|
*/
|
|
5839
|
+
private readonly camera;
|
|
5840
|
+
constructor(bridge: ApiBridge, runtimeOptions?: BaseApiRuntimeOptions);
|
|
5841
|
+
/**
|
|
5842
|
+
* 设置火车的动态并启动列车。
|
|
5843
|
+
* 默认值:`direction='0'`、`action='1'`、`stopTime=180`、`moveType=StopAtTheEnd`。
|
|
5844
|
+
* `id` 为必填的唯一编号;`parentId` 用于避免重名,可不填。
|
|
5845
|
+
* @param payload - 列车启动参数。
|
|
5846
|
+
* @param callback - 可选回调函数。
|
|
5847
|
+
* @returns Promise 形式的接口响应。
|
|
5848
|
+
* @agentSideEffects write
|
|
5849
|
+
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
5850
|
+
* @agentRiskLevel low
|
|
5851
|
+
* @agentExample { parentId: 'RailTrains', id: 'DTrain1', trainCode: 'G501', startStationName: '北京', endStationName: '上海', direction: '0', action: '1', stopTime: 180, moveType: 'StopAtTheEnd' }
|
|
5852
|
+
* @example
|
|
5853
|
+
* ```ts
|
|
5854
|
+
dtcEngine.TrainSimulate.startTrain(
|
|
5855
|
+
{
|
|
5856
|
+
parentId: 'RailTrains',
|
|
5857
|
+
id: 'DTrain1',
|
|
5858
|
+
trainCode: 'G501',
|
|
5859
|
+
startStationName: '北京',
|
|
5860
|
+
endStationName: '上海',
|
|
5861
|
+
direction: '0',
|
|
5862
|
+
action: '1',
|
|
5863
|
+
stopTime: 180,
|
|
5864
|
+
moveType: dtcEngine.Enums.TrainBehavior.StopAtTheEnd
|
|
5865
|
+
},
|
|
5866
|
+
(result) => { console.log(result); }
|
|
5867
|
+
);
|
|
5868
|
+
* ```
|
|
5869
|
+
*/
|
|
5843
5870
|
startTrain(payload: TrainSimulateStartTrainRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
|
|
5844
5871
|
/**
|
|
5845
|
-
|
|
5846
|
-
|
|
5847
|
-
|
|
5848
|
-
|
|
5849
|
-
|
|
5850
|
-
|
|
5851
|
-
|
|
5852
|
-
|
|
5853
|
-
|
|
5854
|
-
|
|
5855
|
-
|
|
5856
|
-
|
|
5857
|
-
|
|
5858
|
-
|
|
5859
|
-
|
|
5860
|
-
|
|
5861
|
-
|
|
5872
|
+
* 设置火车的运动方式。
|
|
5873
|
+
* 默认值:`moveType=StopAtTheEnd`。
|
|
5874
|
+
* @param payload - 列车运动方式参数。
|
|
5875
|
+
* @param callback - 可选回调函数。
|
|
5876
|
+
* @returns Promise 形式的接口响应。
|
|
5877
|
+
* @agentSideEffects write
|
|
5878
|
+
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
5879
|
+
* @agentRiskLevel low
|
|
5880
|
+
* @agentExample { parentId: 'RailTrains', id: 'DTrain1', moveType: 'Loop' }
|
|
5881
|
+
* @example
|
|
5882
|
+
* ```ts
|
|
5883
|
+
dtcEngine.TrainSimulate.setTrainBehavior(
|
|
5884
|
+
{ parentId: 'RailTrains', id: 'DTrain1', moveType: dtcEngine.Enums.TrainBehavior.Loop },
|
|
5885
|
+
(result) => { console.log(result); }
|
|
5886
|
+
);
|
|
5887
|
+
* ```
|
|
5888
|
+
*/
|
|
5862
5889
|
setTrainBehavior(payload: TrainSimulateSetTrainBehaviorRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
|
|
5863
5890
|
/**
|
|
5864
|
-
|
|
5865
|
-
|
|
5866
|
-
|
|
5867
|
-
|
|
5868
|
-
|
|
5869
|
-
|
|
5870
|
-
|
|
5871
|
-
|
|
5872
|
-
|
|
5873
|
-
|
|
5874
|
-
|
|
5875
|
-
|
|
5876
|
-
|
|
5877
|
-
|
|
5878
|
-
|
|
5879
|
-
|
|
5880
|
-
|
|
5891
|
+
* 设置相机跟随火车。
|
|
5892
|
+
* 内部调用相机模块的 `Camera.startCameraObjFollow` 接口实现。
|
|
5893
|
+
* 默认偏移量 `offSet=(-100, 0, 30)`,坐标类型固定为 `'0000'`。
|
|
5894
|
+
* @param payload - 相机跟随参数。
|
|
5895
|
+
* @param callback - 可选回调函数。
|
|
5896
|
+
* @returns Promise 形式的接口响应。
|
|
5897
|
+
* @agentSideEffects write
|
|
5898
|
+
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
5899
|
+
* @agentRiskLevel low
|
|
5900
|
+
* @agentExample { parentId: 'RailTrains', id: 'DTrain1', offSet: { x: 26, y: 18, z: 15, ePSGType: '0000' } }
|
|
5901
|
+
* @example
|
|
5902
|
+
* ```ts
|
|
5903
|
+
dtcEngine.TrainSimulate.setCameraFollowTrain(
|
|
5904
|
+
{ parentId: 'RailTrains', id: 'DTrain1', offSet: new dtcEngine.Type.Vector3(26, 18, 15) },
|
|
5905
|
+
(result) => { console.log(result); }
|
|
5906
|
+
);
|
|
5907
|
+
* ```
|
|
5908
|
+
*/
|
|
5881
5909
|
setCameraFollowTrain(payload: TrainSimulateSetCameraFollowTrainRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
|
|
5882
5910
|
/**
|
|
5883
|
-
|
|
5884
|
-
|
|
5885
|
-
|
|
5886
|
-
|
|
5887
|
-
|
|
5888
|
-
|
|
5889
|
-
|
|
5890
|
-
|
|
5891
|
-
|
|
5892
|
-
|
|
5893
|
-
|
|
5894
|
-
|
|
5895
|
-
|
|
5896
|
-
|
|
5897
|
-
|
|
5898
|
-
|
|
5899
|
-
|
|
5911
|
+
* 设置火车的声音的开关。
|
|
5912
|
+
* 默认值:`volumeOn=true`。
|
|
5913
|
+
* @param payload - 列车声音参数。
|
|
5914
|
+
* @param callback - 可选回调函数。
|
|
5915
|
+
* @returns Promise 形式的接口响应。
|
|
5916
|
+
* @agentSideEffects write
|
|
5917
|
+
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
5918
|
+
* @agentRiskLevel low
|
|
5919
|
+
* @agentExample { parentId: 'RailTrains', id: 'DTrain1', volumeOn: false } => { code: 0, message: 'success', data: null }
|
|
5920
|
+
* @example
|
|
5921
|
+
* ```ts
|
|
5922
|
+
dtcEngine.TrainSimulate.setTrainVolume(
|
|
5923
|
+
{ parentId: '', id: 'Train1', volumeOn: false },
|
|
5924
|
+
(result) => { console.log(result); }
|
|
5925
|
+
);
|
|
5926
|
+
* ```
|
|
5927
|
+
*/
|
|
5900
5928
|
setTrainVolume(payload: TrainSimulateSetTrainVolumeRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
|
|
5901
5929
|
/**
|
|
5902
5930
|
* 取消相机跟随火车,无需传参。
|
|
@@ -6739,6 +6767,9 @@ declare class DTCEngine {
|
|
|
6739
6767
|
readonly LoadMQTTDataFinished: "LoadMQTTDataFinished";
|
|
6740
6768
|
/** 设备数据加载进度事件 */
|
|
6741
6769
|
readonly LoadMQTTDataProgress: "LoadMQTTDataProgress";
|
|
6770
|
+
/** 列车可见性变化事件 */
|
|
6771
|
+
readonly TrainsVisible: "TrainsVisible";
|
|
6772
|
+
readonly TrainsInfo: "TrainsInfo";
|
|
6742
6773
|
};
|
|
6743
6774
|
readonly Enums: {
|
|
6744
6775
|
DlssQuality: {
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -2264,8 +2264,8 @@ interface TrainSimulateSetTrainVolumeRequest {
|
|
|
2264
2264
|
parentId?: string;
|
|
2265
2265
|
/** 唯一编号,必填。 */
|
|
2266
2266
|
id: string;
|
|
2267
|
-
/**
|
|
2268
|
-
|
|
2267
|
+
/** 声音是否开启,默认 true。 */
|
|
2268
|
+
volumeOn?: boolean;
|
|
2269
2269
|
}
|
|
2270
2270
|
//#endregion
|
|
2271
2271
|
//#region src/types/buildingFloor.d.ts
|
|
@@ -3430,22 +3430,22 @@ declare class Camera extends BaseApi {
|
|
|
3430
3430
|
*/
|
|
3431
3431
|
reset(callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
|
|
3432
3432
|
/**
|
|
3433
|
-
|
|
3434
|
-
|
|
3435
|
-
|
|
3436
|
-
|
|
3437
|
-
|
|
3438
|
-
|
|
3439
|
-
|
|
3440
|
-
|
|
3441
|
-
|
|
3442
|
-
|
|
3443
|
-
|
|
3444
|
-
|
|
3445
|
-
|
|
3446
|
-
|
|
3447
|
-
|
|
3448
|
-
|
|
3433
|
+
* 相机跟随场景中运动的对象。
|
|
3434
|
+
* 默认值:`smooth=0.85`。
|
|
3435
|
+
* @param payload - 跟随参数。
|
|
3436
|
+
* @param callback - 可选回调函数。
|
|
3437
|
+
* @returns Promise 形式的接口响应。
|
|
3438
|
+
* @agentSideEffects write
|
|
3439
|
+
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
3440
|
+
* @agentRiskLevel low
|
|
3441
|
+
* @agentExample { id: 'myCar', offSet: { x: 0, y: 3, z: 5, ePSGType: '0000' }, smooth: 0.85 }
|
|
3442
|
+
* @example
|
|
3443
|
+
* ```ts
|
|
3444
|
+
dtcEngine.Camera.startCameraObjFollow({ id: 'myCar', offSet: new dtcEngine.Type.Vector3(0, 3, 5), smooth: 0.85 }, (result) => {
|
|
3445
|
+
console.log(result);
|
|
3446
|
+
});
|
|
3447
|
+
* ```
|
|
3448
|
+
*/
|
|
3449
3449
|
startCameraObjFollow(payload: CameraObjFollowRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
|
|
3450
3450
|
/**
|
|
3451
3451
|
* 停止相机跟随。
|
|
@@ -4826,17 +4826,24 @@ declare class PathPatrol extends BaseApi {
|
|
|
4826
4826
|
interface PointIconVisibilityResult {
|
|
4827
4827
|
requestedCount: number;
|
|
4828
4828
|
affectedCount: number;
|
|
4829
|
-
|
|
4829
|
+
/** 按 ids 调用(show/hide/showByGroup/hideByGroup)时返回;按 codes 调用时该字段缺失。 */
|
|
4830
|
+
notFoundIds?: string[];
|
|
4831
|
+
/** 按 codes 调用(showByCode/hideByCode)时返回;按 ids 调用时该字段缺失。 */
|
|
4832
|
+
notFoundCodes?: string[];
|
|
4830
4833
|
}
|
|
4831
4834
|
interface PointIconIdsRequest {
|
|
4832
4835
|
ids: string[];
|
|
4833
4836
|
}
|
|
4834
4837
|
type PointIconIdsInput = string[] | PointIconIdsRequest;
|
|
4838
|
+
interface PointIconCodesRequest {
|
|
4839
|
+
codes: string[];
|
|
4840
|
+
}
|
|
4841
|
+
type PointIconCodesInput = string[] | PointIconCodesRequest;
|
|
4835
4842
|
type PointIconResponse = ApiResponseEnvelope<PointIconVisibilityResult>;
|
|
4836
4843
|
/**
|
|
4837
4844
|
* 设备点位图标显隐控制 API。
|
|
4838
4845
|
* @agentTitle 设备点位图标
|
|
4839
|
-
* @agentCapabilities 指定点位显隐, 分组点位显隐, 全部点位显隐
|
|
4846
|
+
* @agentCapabilities 指定点位显隐, 按编码点位显隐, 分组点位显隐, 全部点位显隐
|
|
4840
4847
|
* @hideconstructor
|
|
4841
4848
|
*/
|
|
4842
4849
|
declare class PointIcon extends BaseApi {
|
|
@@ -4857,6 +4864,22 @@ declare class PointIcon extends BaseApi {
|
|
|
4857
4864
|
* @agentExample { ids: ['point-001', 'point-002'] }
|
|
4858
4865
|
*/
|
|
4859
4866
|
hide(payload: PointIconIdsInput, callback?: ApiCallback<PointIconResponse>): Promise<PointIconResponse>;
|
|
4867
|
+
/**
|
|
4868
|
+
* 显示指定编码(code)的全部设备点位图标,编码精确匹配且不要求唯一。
|
|
4869
|
+
* @agentSideEffects write
|
|
4870
|
+
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
4871
|
+
* @agentRiskLevel low
|
|
4872
|
+
* @agentExample { codes: ['CAM-001', 'CAM-002'] }
|
|
4873
|
+
*/
|
|
4874
|
+
showByCode(payload: PointIconCodesInput, callback?: ApiCallback<PointIconResponse>): Promise<PointIconResponse>;
|
|
4875
|
+
/**
|
|
4876
|
+
* 隐藏指定编码(code)的全部设备点位图标,编码精确匹配且不要求唯一。
|
|
4877
|
+
* @agentSideEffects write
|
|
4878
|
+
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
4879
|
+
* @agentRiskLevel low
|
|
4880
|
+
* @agentExample { codes: ['CAM-001', 'CAM-002'] }
|
|
4881
|
+
*/
|
|
4882
|
+
hideByCode(payload: PointIconCodesInput, callback?: ApiCallback<PointIconResponse>): Promise<PointIconResponse>;
|
|
4860
4883
|
/**
|
|
4861
4884
|
* 显示指定分组及其子分组内的设备点位图标。
|
|
4862
4885
|
* @agentSideEffects write
|
|
@@ -5810,93 +5833,98 @@ declare class SpatialQuery extends BaseApi {
|
|
|
5810
5833
|
* @hideconstructor
|
|
5811
5834
|
*/
|
|
5812
5835
|
declare class TrainSimulate extends BaseApi {
|
|
5813
|
-
constructor(bridge: ApiBridge, runtimeOptions?: BaseApiRuntimeOptions);
|
|
5814
5836
|
/**
|
|
5815
|
-
*
|
|
5816
|
-
* 默认值:`direction='0'`、`action='1'`、`stopTime=180`、`moveType=StopAtTheEnd`。
|
|
5817
|
-
* `id` 为必填的唯一编号;`parentId` 用于避免重名,可不填。
|
|
5818
|
-
* @param payload - 列车启动参数。
|
|
5819
|
-
* @param callback - 可选回调函数。
|
|
5820
|
-
* @returns Promise 形式的接口响应。
|
|
5821
|
-
* @agentSideEffects write
|
|
5822
|
-
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
5823
|
-
* @agentRiskLevel low
|
|
5824
|
-
* @agentExample { parentId: 'RailTrains', id: 'DTrain1', trainCode: 'G501', startStationName: '北京', endStationName: '上海', direction: '0', action: '1', stopTime: 180, moveType: 'StopAtTheEnd' }
|
|
5825
|
-
* @example
|
|
5826
|
-
* ```ts
|
|
5827
|
-
* dtcEngine.TrainSimulate.startTrain(
|
|
5828
|
-
* {
|
|
5829
|
-
* parentId: 'RailTrains',
|
|
5830
|
-
* id: 'DTrain1',
|
|
5831
|
-
* trainCode: 'G501',
|
|
5832
|
-
* startStationName: '北京',
|
|
5833
|
-
* endStationName: '上海',
|
|
5834
|
-
* direction: '0',
|
|
5835
|
-
* action: '1',
|
|
5836
|
-
* stopTime: 180,
|
|
5837
|
-
* moveType: dtcEngine.Enums.TrainBehavior.StopAtTheEnd
|
|
5838
|
-
* },
|
|
5839
|
-
* (result) => { console.log(result); }
|
|
5840
|
-
* );
|
|
5841
|
-
* ```
|
|
5837
|
+
* 相机模块实例,`setCameraFollowTrain` 复用其 `startCameraObjFollow` 接口。
|
|
5842
5838
|
*/
|
|
5839
|
+
private readonly camera;
|
|
5840
|
+
constructor(bridge: ApiBridge, runtimeOptions?: BaseApiRuntimeOptions);
|
|
5841
|
+
/**
|
|
5842
|
+
* 设置火车的动态并启动列车。
|
|
5843
|
+
* 默认值:`direction='0'`、`action='1'`、`stopTime=180`、`moveType=StopAtTheEnd`。
|
|
5844
|
+
* `id` 为必填的唯一编号;`parentId` 用于避免重名,可不填。
|
|
5845
|
+
* @param payload - 列车启动参数。
|
|
5846
|
+
* @param callback - 可选回调函数。
|
|
5847
|
+
* @returns Promise 形式的接口响应。
|
|
5848
|
+
* @agentSideEffects write
|
|
5849
|
+
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
5850
|
+
* @agentRiskLevel low
|
|
5851
|
+
* @agentExample { parentId: 'RailTrains', id: 'DTrain1', trainCode: 'G501', startStationName: '北京', endStationName: '上海', direction: '0', action: '1', stopTime: 180, moveType: 'StopAtTheEnd' }
|
|
5852
|
+
* @example
|
|
5853
|
+
* ```ts
|
|
5854
|
+
dtcEngine.TrainSimulate.startTrain(
|
|
5855
|
+
{
|
|
5856
|
+
parentId: 'RailTrains',
|
|
5857
|
+
id: 'DTrain1',
|
|
5858
|
+
trainCode: 'G501',
|
|
5859
|
+
startStationName: '北京',
|
|
5860
|
+
endStationName: '上海',
|
|
5861
|
+
direction: '0',
|
|
5862
|
+
action: '1',
|
|
5863
|
+
stopTime: 180,
|
|
5864
|
+
moveType: dtcEngine.Enums.TrainBehavior.StopAtTheEnd
|
|
5865
|
+
},
|
|
5866
|
+
(result) => { console.log(result); }
|
|
5867
|
+
);
|
|
5868
|
+
* ```
|
|
5869
|
+
*/
|
|
5843
5870
|
startTrain(payload: TrainSimulateStartTrainRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
|
|
5844
5871
|
/**
|
|
5845
|
-
|
|
5846
|
-
|
|
5847
|
-
|
|
5848
|
-
|
|
5849
|
-
|
|
5850
|
-
|
|
5851
|
-
|
|
5852
|
-
|
|
5853
|
-
|
|
5854
|
-
|
|
5855
|
-
|
|
5856
|
-
|
|
5857
|
-
|
|
5858
|
-
|
|
5859
|
-
|
|
5860
|
-
|
|
5861
|
-
|
|
5872
|
+
* 设置火车的运动方式。
|
|
5873
|
+
* 默认值:`moveType=StopAtTheEnd`。
|
|
5874
|
+
* @param payload - 列车运动方式参数。
|
|
5875
|
+
* @param callback - 可选回调函数。
|
|
5876
|
+
* @returns Promise 形式的接口响应。
|
|
5877
|
+
* @agentSideEffects write
|
|
5878
|
+
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
5879
|
+
* @agentRiskLevel low
|
|
5880
|
+
* @agentExample { parentId: 'RailTrains', id: 'DTrain1', moveType: 'Loop' }
|
|
5881
|
+
* @example
|
|
5882
|
+
* ```ts
|
|
5883
|
+
dtcEngine.TrainSimulate.setTrainBehavior(
|
|
5884
|
+
{ parentId: 'RailTrains', id: 'DTrain1', moveType: dtcEngine.Enums.TrainBehavior.Loop },
|
|
5885
|
+
(result) => { console.log(result); }
|
|
5886
|
+
);
|
|
5887
|
+
* ```
|
|
5888
|
+
*/
|
|
5862
5889
|
setTrainBehavior(payload: TrainSimulateSetTrainBehaviorRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
|
|
5863
5890
|
/**
|
|
5864
|
-
|
|
5865
|
-
|
|
5866
|
-
|
|
5867
|
-
|
|
5868
|
-
|
|
5869
|
-
|
|
5870
|
-
|
|
5871
|
-
|
|
5872
|
-
|
|
5873
|
-
|
|
5874
|
-
|
|
5875
|
-
|
|
5876
|
-
|
|
5877
|
-
|
|
5878
|
-
|
|
5879
|
-
|
|
5880
|
-
|
|
5891
|
+
* 设置相机跟随火车。
|
|
5892
|
+
* 内部调用相机模块的 `Camera.startCameraObjFollow` 接口实现。
|
|
5893
|
+
* 默认偏移量 `offSet=(-100, 0, 30)`,坐标类型固定为 `'0000'`。
|
|
5894
|
+
* @param payload - 相机跟随参数。
|
|
5895
|
+
* @param callback - 可选回调函数。
|
|
5896
|
+
* @returns Promise 形式的接口响应。
|
|
5897
|
+
* @agentSideEffects write
|
|
5898
|
+
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
5899
|
+
* @agentRiskLevel low
|
|
5900
|
+
* @agentExample { parentId: 'RailTrains', id: 'DTrain1', offSet: { x: 26, y: 18, z: 15, ePSGType: '0000' } }
|
|
5901
|
+
* @example
|
|
5902
|
+
* ```ts
|
|
5903
|
+
dtcEngine.TrainSimulate.setCameraFollowTrain(
|
|
5904
|
+
{ parentId: 'RailTrains', id: 'DTrain1', offSet: new dtcEngine.Type.Vector3(26, 18, 15) },
|
|
5905
|
+
(result) => { console.log(result); }
|
|
5906
|
+
);
|
|
5907
|
+
* ```
|
|
5908
|
+
*/
|
|
5881
5909
|
setCameraFollowTrain(payload: TrainSimulateSetCameraFollowTrainRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
|
|
5882
5910
|
/**
|
|
5883
|
-
|
|
5884
|
-
|
|
5885
|
-
|
|
5886
|
-
|
|
5887
|
-
|
|
5888
|
-
|
|
5889
|
-
|
|
5890
|
-
|
|
5891
|
-
|
|
5892
|
-
|
|
5893
|
-
|
|
5894
|
-
|
|
5895
|
-
|
|
5896
|
-
|
|
5897
|
-
|
|
5898
|
-
|
|
5899
|
-
|
|
5911
|
+
* 设置火车的声音的开关。
|
|
5912
|
+
* 默认值:`volumeOn=true`。
|
|
5913
|
+
* @param payload - 列车声音参数。
|
|
5914
|
+
* @param callback - 可选回调函数。
|
|
5915
|
+
* @returns Promise 形式的接口响应。
|
|
5916
|
+
* @agentSideEffects write
|
|
5917
|
+
* @agentPreconditions DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
5918
|
+
* @agentRiskLevel low
|
|
5919
|
+
* @agentExample { parentId: 'RailTrains', id: 'DTrain1', volumeOn: false } => { code: 0, message: 'success', data: null }
|
|
5920
|
+
* @example
|
|
5921
|
+
* ```ts
|
|
5922
|
+
dtcEngine.TrainSimulate.setTrainVolume(
|
|
5923
|
+
{ parentId: '', id: 'Train1', volumeOn: false },
|
|
5924
|
+
(result) => { console.log(result); }
|
|
5925
|
+
);
|
|
5926
|
+
* ```
|
|
5927
|
+
*/
|
|
5900
5928
|
setTrainVolume(payload: TrainSimulateSetTrainVolumeRequest, callback?: ApiCallback<ApiResponseEnvelope<unknown>>): Promise<ApiResponseEnvelope<unknown>>;
|
|
5901
5929
|
/**
|
|
5902
5930
|
* 取消相机跟随火车,无需传参。
|
|
@@ -6739,6 +6767,9 @@ declare class DTCEngine {
|
|
|
6739
6767
|
readonly LoadMQTTDataFinished: "LoadMQTTDataFinished";
|
|
6740
6768
|
/** 设备数据加载进度事件 */
|
|
6741
6769
|
readonly LoadMQTTDataProgress: "LoadMQTTDataProgress";
|
|
6770
|
+
/** 列车可见性变化事件 */
|
|
6771
|
+
readonly TrainsVisible: "TrainsVisible";
|
|
6772
|
+
readonly TrainsInfo: "TrainsInfo";
|
|
6742
6773
|
};
|
|
6743
6774
|
readonly Enums: {
|
|
6744
6775
|
DlssQuality: {
|