@nnepoch/dtc-sdk 3.0.11 → 3.0.13

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

@@ -0,0 +1,53 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / SpatialQueryLayerByModelRequest
+
+# Interface: SpatialQueryLayerByModelRequest
+
+SpatialQuery.layerQueryByModel 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId?**: `string`
+
+场景查询位置的对象上级编号，可以为空。
+
+***
+
+### id?
+
+> `optional` **id?**: `string`
+
+查询参照的位置对象唯一编号。
+
+***
+
+### queryRadius?
+
+> `optional` **queryRadius?**: `number`
+
+查询的半径，单位米，默认 50。
+
+***
+
+### queryMinHeight?
+
+> `optional` **queryMinHeight?**: `number`
+
+查询的最小高度，默认 0；值不能大于最大高度。
+
+***
+
+### queryMaxHeight?
+
+> `optional` **queryMaxHeight?**: `number`
+
+查询的最大高度，默认 20；值不能小于最小高度。
+
+***
+
+### queryParentIds
+
+> **queryParentIds**: `string`[]
+
+查询的图层组编号集合，至少一个。

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

@@ -0,0 +1,45 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / SpatialQueryLayerByPositionRequest
+
+# Interface: SpatialQueryLayerByPositionRequest
+
+SpatialQuery.layerQueryByPosition 参数。
+
+## Properties
+
+### queryPosition?
+
+> `optional` **queryPosition?**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+查询的中心位置。
+
+***
+
+### queryRadius?
+
+> `optional` **queryRadius?**: `number`
+
+查询的半径，单位米，默认 50。
+
+***
+
+### queryMinHeight?
+
+> `optional` **queryMinHeight?**: `number`
+
+查询的最小高度，默认 0；值不能大于最大高度。
+
+***
+
+### queryMaxHeight?
+
+> `optional` **queryMaxHeight?**: `number`
+
+查询的最大高度，默认 20；值不能小于最小高度。
+
+***
+
+### queryParentIds
+
+> **queryParentIds**: `string`[]
+
+查询的图层组编号集合，至少一个。

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

@@ -30,4 +30,4 @@
 
 ### data?
 
-> `optional` **data**: `T`
+> `optional` **data?**: `T`

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

@@ -8,7 +8,7 @@ TimeLine.pause / resume 参数。
 
 ### parentId?
 
-> `optional` **parentId**: `string`
+> `optional` **parentId?**: `string`
 
 父节点 ID。
 
@@ -16,6 +16,6 @@ TimeLine.pause / resume 参数。
 
 ### id?
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 时间线 ID（兼容字段）。

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

@@ -8,7 +8,7 @@ TimeLine.play 参数。
 
 ### parentId?
 
-> `optional` **parentId**: `string`
+> `optional` **parentId?**: `string`
 
 父节点 ID。
 
@@ -16,7 +16,7 @@ TimeLine.play 参数。
 
 ### id?
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 时间线 ID（兼容字段）。
 
@@ -24,7 +24,7 @@ TimeLine.play 参数。
 
 ### timelineId?
 
-> `optional` **timelineId**: `string`
+> `optional` **timelineId?**: `string`
 
 时间线 ID。
 
@@ -32,7 +32,7 @@ TimeLine.play 参数。
 
 ### initialTime?
 
-> `optional` **initialTime**: `number`
+> `optional` **initialTime?**: `number`
 
 初始时间。
 
@@ -40,7 +40,7 @@ TimeLine.play 参数。
 
 ### speed?
 
-> `optional` **speed**: `number`
+> `optional` **speed?**: `number`
 
 播放速度。
 
@@ -48,6 +48,6 @@ TimeLine.play 参数。
 
 ### keepLastFrame?
 
-> `optional` **keepLastFrame**: `boolean`
+> `optional` **keepLastFrame?**: `boolean`
 
 是否保留最后一帧。

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

@@ -8,7 +8,7 @@ TimeLine.setSpeed 参数。
 
 ### parentId?
 
-> `optional` **parentId**: `string`
+> `optional` **parentId?**: `string`
 
 父节点 ID。
 
@@ -16,7 +16,7 @@ TimeLine.setSpeed 参数。
 
 ### id?
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 时间线 ID（兼容字段）。
 
@@ -24,7 +24,7 @@ TimeLine.setSpeed 参数。
 
 ### timelineId?
 
-> `optional` **timelineId**: `string`
+> `optional` **timelineId?**: `string`
 
 时间线 ID。
 

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

@@ -8,7 +8,7 @@ TimeLine.stop 参数。
 
 ### parentId?
 
-> `optional` **parentId**: `string`
+> `optional` **parentId?**: `string`
 
 父节点 ID。
 
@@ -16,7 +16,7 @@ TimeLine.stop 参数。
 
 ### id?
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 时间线 ID（兼容字段）。
 
@@ -24,7 +24,7 @@ TimeLine.stop 参数。
 
 ### timelineId?
 
-> `optional` **timelineId**: `string`
+> `optional` **timelineId?**: `string`
 
 时间线 ID。
 
@@ -32,7 +32,7 @@ TimeLine.stop 参数。
 
 ### resetTime?
 
-> `optional` **resetTime**: `number`
+> `optional` **resetTime?**: `number`
 
 停止后重置到的时间。
 
@@ -40,6 +40,6 @@ TimeLine.stop 参数。
 
 ### isCameraToStart?
 
-> `optional` **isCameraToStart**: `boolean`
+> `optional` **isCameraToStart?**: `boolean`
 
 停止后相机是否回到起点。

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

@@ -0,0 +1,29 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / TrainSimulateSetCameraFollowTrainRequest
+
+# Interface: TrainSimulateSetCameraFollowTrainRequest
+
+TrainSimulate.setCameraFollowTrain 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId?**: `string`
+
+场景中参照绑定的位置的对象上级编号，可不填，但要保证 id 唯一。
+
+***
+
+### id
+
+> **id**: `string`
+
+唯一编号，必填。
+
+***
+
+### offSet?
+
+> `optional` **offSet?**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+相机相对列车的偏移量，默认 (26, 18, 15)，坐标类型固定为 '0000'。

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

@@ -0,0 +1,29 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / TrainSimulateSetTrainBehaviorRequest
+
+# Interface: TrainSimulateSetTrainBehaviorRequest
+
+TrainSimulate.setTrainBehavior 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId?**: `string`
+
+场景中参照绑定的位置的对象上级编号，可不填，但要保证 id 唯一。
+
+***
+
+### id
+
+> **id**: `string`
+
+唯一编号，必填。
+
+***
+
+### moveType?
+
+> `optional` **moveType?**: [`TrainBehavior`](../enumerations/TrainBehavior.md)
+
+列车运动方式：StopAtTheEnd 到达终点后停止、Loop 循环播放、BackAndForward 反复播放。默认 StopAtTheEnd。

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

@@ -0,0 +1,29 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / TrainSimulateSetTrainVolumeRequest
+
+# Interface: TrainSimulateSetTrainVolumeRequest
+
+TrainSimulate.setTrainVolume 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId?**: `string`
+
+场景中参照绑定的位置的对象上级编号，可不填，但要保证 id 唯一。
+
+***
+
+### id
+
+> **id**: `string`
+
+唯一编号，必填。
+
+***
+
+### volumeOn?
+
+> `optional` **volumeOn?**: `boolean`
+
+声音是否开启，默认 true。

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

@@ -0,0 +1,77 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / TrainSimulateStartTrainRequest
+
+# Interface: TrainSimulateStartTrainRequest
+
+TrainSimulate.startTrain 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId?**: `string`
+
+场景中参照绑定的位置的对象上级编号，可不填，但要保证 id 唯一。
+
+***
+
+### id
+
+> **id**: `string`
+
+区块编号，唯一编号，必填。
+
+***
+
+### trainCode?
+
+> `optional` **trainCode?**: `string`
+
+列车班次编号。
+
+***
+
+### startStationName?
+
+> `optional` **startStationName?**: `string`
+
+起始站名称。
+
+***
+
+### endStationName?
+
+> `optional` **endStationName?**: `string`
+
+终点站名称。
+
+***
+
+### direction?
+
+> `optional` **direction?**: `string`
+
+列车方向：0 从东到西，1 从西到东。默认 '0'。
+
+***
+
+### action?
+
+> `optional` **action?**: `string`
+
+列车动作：1 进站，0 出站。默认 '1'。
+
+***
+
+### stopTime?
+
+> `optional` **stopTime?**: `number`
+
+停车时间，单位秒，默认 180。
+
+***
+
+### moveType?
+
+> `optional` **moveType?**: [`TrainBehavior`](../enumerations/TrainBehavior.md)
+
+列车运动方式：StopAtTheEnd 到达终点后停止、Loop 循环播放、BackAndForward 反复播放。默认 StopAtTheEnd。

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

@@ -8,6 +8,6 @@ UIPOI.enableOverlap 参数。
 
 ### enable?
 
-> `optional` **enable**: `boolean`
+> `optional` **enable?**: `boolean`
 
 是否开启碰撞避让。

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

@@ -0,0 +1,15 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / Vector2JsonInput
+
+# Interface: Vector2JsonInput
+
+## Properties
+
+### x
+
+> **x**: `number`
+
+***
+
+### y
+
+> **y**: `number`

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

@@ -16,6 +16,6 @@ WeatherSystem.changeSeason 参数。
 
 ### duration?
 
-> `optional` **duration**: `number`
+> `optional` **duration?**: `number`
 
 季节切换持续时间。

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

@@ -8,7 +8,7 @@ WeatherSystem.openCameraFog 参数。
 
 ### fogIntensity?
 
-> `optional` **fogIntensity**: `number`
+> `optional` **fogIntensity?**: `number`
 
 雾强度。
 
@@ -16,7 +16,7 @@ WeatherSystem.openCameraFog 参数。
 
 ### fogStartColor?
 
-> `optional` **fogStartColor**: `string`
+> `optional` **fogStartColor?**: `string`
 
 雾近端颜色。
 
@@ -24,7 +24,7 @@ WeatherSystem.openCameraFog 参数。
 
 ### fogEndColor?
 
-> `optional` **fogEndColor**: `string`
+> `optional` **fogEndColor?**: `string`
 
 雾远端颜色。
 
@@ -32,7 +32,7 @@ WeatherSystem.openCameraFog 参数。
 
 ### fogStartDistance?
 
-> `optional` **fogStartDistance**: `number`
+> `optional` **fogStartDistance?**: `number`
 
 雾起始距离。
 
@@ -40,7 +40,7 @@ WeatherSystem.openCameraFog 参数。
 
 ### fogEndDistance?
 
-> `optional` **fogEndDistance**: `number`
+> `optional` **fogEndDistance?**: `number`
 
 雾终止距离。
 
@@ -48,7 +48,7 @@ WeatherSystem.openCameraFog 参数。
 
 ### directionalIntensity?
 
-> `optional` **directionalIntensity**: `number`
+> `optional` **directionalIntensity?**: `number`
 
 方向光强度。
 
@@ -56,7 +56,7 @@ WeatherSystem.openCameraFog 参数。
 
 ### directionalFallOff?
 
-> `optional` **directionalFallOff**: `number`
+> `optional` **directionalFallOff?**: `number`
 
 方向光衰减。
 
@@ -64,6 +64,6 @@ WeatherSystem.openCameraFog 参数。
 
 ### directionalColor?
 
-> `optional` **directionalColor**: `string`
+> `optional` **directionalColor?**: `string`
 
 方向光颜色。

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

@@ -8,7 +8,7 @@ WeatherSystem.setAnimateTimeOfDay 参数。
 
 ### isAnimate?
 
-> `optional` **isAnimate**: `boolean`
+> `optional` **isAnimate?**: `boolean`
 
 是否模拟白天，黑夜时间动画。
 
@@ -16,7 +16,7 @@ WeatherSystem.setAnimateTimeOfDay 参数。
 
 ### dayLength?
 
-> `optional` **dayLength**: `number`
+> `optional` **dayLength?**: `number`
 
 白天持续时间（分）。 默认0.5分钟
 
@@ -24,6 +24,6 @@ WeatherSystem.setAnimateTimeOfDay 参数。
 
 ### nightLength?
 
-> `optional` **nightLength**: `number`
+> `optional` **nightLength?**: `number`
 
 夜晚持续时间（分）。 默认0.5分钟

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

@@ -16,6 +16,6 @@ WeatherSystem.setSceneTime 参数。
 
 ### timeDuration?
 
-> `optional` **timeDuration**: `number`
+> `optional` **timeDuration?**: `number`
 
 时间变化持续的时间（秒）。

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

@@ -8,6 +8,6 @@ WeatherSystem.setTimeSync 参数。
 
 ### syncSystemTime?
 
-> `optional` **syncSystemTime**: `boolean`
+> `optional` **syncSystemTime?**: `boolean`
 
 是否同步系统时间。

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

@@ -0,0 +1,13 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / WeatherSetVolumeRequest
+
+# Interface: WeatherSetVolumeRequest
+
+WeatherSystem.setWeatherVolume 参数。
+
+## Properties
+
+### volumeOn?
+
+> `optional` **volumeOn?**: `boolean`
+
+天气声音是否开启，true 开启，false 关闭。默认 true。

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

@@ -6,9 +6,9 @@ WeatherSystem.changeWeatherType 参数。
 
 ## Properties
 
-### type
+### weatherType
 
-> **type**: `number`
+> **weatherType**: `string`
 
 天气类型名称。
 
@@ -19,9 +19,3 @@ WeatherSystem.changeWeatherType 参数。
 > **timeDuration**: `number`
 
 天气类型持续时间（秒）。
-
-***
-
-### test?
-
-> `optional` **test**: `string`

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

@@ -0,0 +1,29 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / WebViewUpdateRequest
+
+# Interface: WebViewUpdateRequest
+
+WebView.updateWebView 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId?**: `string`
+
+要创建的视频播放器的父对象（需要是 UI，为空时自动创建新的对象）。
+
+***
+
+### id
+
+> **id**: `string`
+
+创建的视频播放器的名称。
+
+***
+
+### url
+
+> **url**: `string`
+
+网页的网址。

package/docs/api/types/type-aliases/ApiCallback.md

@@ -1,6 +1,6 @@
 [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / ApiCallback
 
-# Type Alias: ApiCallback()\<T\>
+# Type Alias: ApiCallback\<T\>
 
 > **ApiCallback**\<`T`\> = (`result`) => `void`
 

package/docs/api/types/type-aliases/BuildingFloorFocusMode.md

@@ -0,0 +1,5 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / BuildingFloorFocusMode
+
+# Type Alias: BuildingFloorFocusMode
+
+> **BuildingFloorFocusMode** = `"none"` \| `"viewPoint"` \| `"bounds"`

package/docs/api/types/type-aliases/BuildingFloorInput.md

@@ -0,0 +1,7 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / BuildingFloorInput
+
+# Type Alias: BuildingFloorInput
+
+> **BuildingFloorInput** = `string` \| [`BuildingFloorItem`](../interfaces/BuildingFloorItem.md)
+
+楼层既可使用节点 ID，也可使用带固定视角的对象。

package/docs/api/types/type-aliases/BuildingFloorRuntimeStatus.md

@@ -0,0 +1,5 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / BuildingFloorRuntimeStatus
+
+# Type Alias: BuildingFloorRuntimeStatus
+
+> **BuildingFloorRuntimeStatus** = `"overview"` \| `"switching"` \| `"floor"` \| `"cancelled"`

package/docs/api/types/type-aliases/BuildingFloorTransitionStatus.md

@@ -0,0 +1,5 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / BuildingFloorTransitionStatus
+
+# Type Alias: BuildingFloorTransitionStatus
+
+> **BuildingFloorTransitionStatus** = `"completed"` \| `"cancelled"`

package/docs/api/types/type-aliases/PointEditorCreateCallback.md

@@ -0,0 +1,7 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PointEditorCreateCallback
+
+# Type Alias: PointEditorCreateCallback
+
+> **PointEditorCreateCallback** = [`ApiCallback`](ApiCallback.md)\<[`PointEditorPoint`](PointEditorPoint.md) \| `Error`\>
+
+创建失败通过 Error 回调，同时 Promise 拒绝。

package/docs/api/types/type-aliases/PointEditorPoint.md

@@ -0,0 +1,7 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PointEditorPoint
+
+# Type Alias: PointEditorPoint
+
+> **PointEditorPoint** = `Omit`\<[`PointEditorAddRequest`](../interfaces/PointEditorAddRequest.md), `"screenPosition"`\> & `Required`\<`Pick`\<[`PointEditorAddRequest`](../interfaces/PointEditorAddRequest.md), `"position"` \| `"rotation"` \| `"scale"` \| `"show"` \| `"poiEnabled"` \| `"poiOffsetY"` \| `"poiScaleFactor"` \| `"poiShowName"` \| `"extraProps"`\>\>
+
+已创建点位，直接供 Promise 和 callback 读取 position 等属性。