@nnepoch/dtc-sdk 3.0.0

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

@@ -0,0 +1,59 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / EngineStatusInfo
+
+# Interface: EngineStatusInfo
+
+引擎状态详情结构，与 sdk2 的 EngineStatusInfo 字段语义保持一致。
+
+## Properties
+
+### CameraHeight
+
+> **CameraHeight**: `string`
+
+***
+
+### FPS
+
+> **FPS**: `string`
+
+***
+
+### Width
+
+> **Width**: `string`
+
+***
+
+### Height
+
+> **Height**: `string`
+
+***
+
+### runTime
+
+> **runTime**: `string`
+
+***
+
+### bytePerSecond
+
+> **bytePerSecond**: `string`
+
+***
+
+### lostPacketsRate
+
+> **lostPacketsRate**: `string`
+
+***
+
+### delayTime
+
+> **delayTime**: `string`
+
+***
+
+### Codec
+
+> **Codec**: `string`

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

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / FeatureToggleRequest
+
+# Interface: FeatureToggleRequest
+
+Scene.setFeatureToggle 参数。
+
+## Properties
+
+### key
+
+> **key**: `string`
+
+特性开关键名。
+
+***
+
+### enabled
+
+> **enabled**: `boolean`
+
+是否开启。

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

@@ -0,0 +1,11 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / HighLighterEnableRequest
+
+# Interface: HighLighterEnableRequest
+
+## Properties
+
+### enable
+
+> **enable**: `boolean`
+
+是否启用高亮效果。

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

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / HighLighterRemoveHighLightModelRequest
+
+# Interface: HighLighterRemoveHighLightModelRequest
+
+HighLighterEffect.removeHighLightModel 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+对象组的父对象，可以为空。
+
+***
+
+### ids
+
+> **ids**: `string`[]
+
+需要移除高光的对象名称数组。

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

@@ -0,0 +1,29 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / HighLighterSetHighLightModelRequest
+
+# Interface: HighLighterSetHighLightModelRequest
+
+HighLighterEffect.setHighLightModel 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+对象组的父对象，可以为空。
+
+***
+
+### ids
+
+> **ids**: `string`[]
+
+需要添加高光的对象编号数组。
+
+***
+
+### showBack
+
+> **showBack**: `boolean`
+
+是否高亮模型背面。

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

@@ -0,0 +1,61 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / LayerAddRequest
+
+# Interface: LayerAddRequest
+
+Layer.addLayer 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+父图层或分组 ID。仅传 parentId 时兼容作为 id 使用。
+
+***
+
+### id
+
+> **id**: `string`
+
+图层对象 ID。
+
+***
+
+### layerName?
+
+> `optional` **layerName**: `string`
+
+图层显示名称。
+
+***
+
+### show?
+
+> `optional` **show**: `boolean`
+
+图层默认是否显示。
+
+***
+
+### poiEnabled?
+
+> `optional` **poiEnabled**: `boolean`
+
+图层 POI 是否显示。
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+图层描述。
+
+***
+
+### isSystem?
+
+> `optional` **isSystem**: `boolean`
+
+图层是否为系统图层。true--断开连接不删除，false--断开连接删除。

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

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / LayerChildElementRequest
+
+# Interface: LayerChildElementRequest
+
+Layer.getLayerChildElement 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+父图层或分组 ID。
+
+***
+
+### id
+
+> **id**: `string`
+
+当前图层 ID。

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

@@ -0,0 +1,75 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / LayerModelAddRequest
+
+# Interface: LayerModelAddRequest
+
+Layer.addModel 参数。
+
+## Properties
+
+### parentId
+
+> **parentId**: `string`
+
+模型所属图层组 ID。
+
+***
+
+### id
+
+> **id**: `string`
+
+新模型对象 ID。
+
+***
+
+### assetsPath?
+
+> `optional` **assetsPath**: `string`
+
+资源路径。
+
+***
+
+### position?
+
+> `optional` **position**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+位置。
+
+***
+
+### rotation?
+
+> `optional` **rotation**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+旋转角。
+
+***
+
+### scale?
+
+> `optional` **scale**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+缩放。
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+备注描述。
+
+***
+
+### isSystem?
+
+> `optional` **isSystem**: `boolean`
+
+模型是否为系统模型。true--断开连接不删除，false--断开连接删除。如果图层为非系统的，也会删除
+
+***
+
+### tags?
+
+> `optional` **tags**: `string`[]

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

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / LayerModelRemoveRequest
+
+# Interface: LayerModelRemoveRequest
+
+Layer.removeModel 参数。
+
+## Properties
+
+### parentId
+
+> **parentId**: `string`
+
+模型所属图层组 ID。
+
+***
+
+### ids
+
+> **ids**: `string`[]
+
+要删除的模型 ID 列表。

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

@@ -0,0 +1,117 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / LayerPOIAddRequest
+
+# Interface: LayerPOIAddRequest
+
+Layer.addModel 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+模型所属图层组 ID。
+
+***
+
+### id
+
+> **id**: `string`
+
+新模型对象 ID。
+
+***
+
+### assetsPath
+
+> **assetsPath**: `string`
+
+资源路径。
+
+***
+
+### position?
+
+> `optional` **position**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+位置。
+
+***
+
+### targetParentId?
+
+> `optional` **targetParentId**: `string`
+
+场景中参照绑定的位置的对象上级编号，防止重名，可不填写，但要保证  targetId是唯一的
+
+***
+
+### targetId?
+
+> `optional` **targetId**: `string`
+
+场景中参照绑定的位置的对象编号，与position功能一样，只需要存在一个
+
+***
+
+### rotation?
+
+> `optional` **rotation**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+旋转角。
+
+***
+
+### scale?
+
+> `optional` **scale**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+缩放。
+
+***
+
+### offSet?
+
+> `optional` **offSet**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+poi的偏移量
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+备注描述。
+
+***
+
+### isSystem?
+
+> `optional` **isSystem**: `boolean`
+
+模型是否为系统模型。true--断开连接不删除，false--断开连接删除。如果图层为非系统的，也会删除
+
+***
+
+### text?
+
+> `optional` **text**: `string`
+
+poi的文本
+
+***
+
+### fontSize?
+
+> `optional` **fontSize**: `number`
+
+poi的字体大小,默认为 16
+
+***
+
+### tags?
+
+> `optional` **tags**: `string`[]
+
+模型的标签

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

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / LayerSelectorRequest
+
+# Interface: LayerSelectorRequest
+
+Layer.removeLayer / Layer.isLayerOrGroupExit 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+父图层或分组 ID。仅传 parentId 时兼容作为 id 使用。
+
+***
+
+### id
+
+> **id**: `string`
+
+图层或分组 ID。

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

@@ -0,0 +1,51 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / LayerShowUIPopRequest
+
+# Interface: LayerShowUIPopRequest
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+模型所属图层组 ID。
+
+***
+
+### id
+
+> **id**: `string`
+
+新模型对象 ID。
+
+***
+
+### assetsPath?
+
+> `optional` **assetsPath**: `string`
+
+资源路径。
+
+***
+
+### offSet?
+
+> `optional` **offSet**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+poi的偏移量
+
+***
+
+### visible?
+
+> `optional` **visible**: `boolean`
+
+是否可见
+
+***
+
+### scale?
+
+> `optional` **scale**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+缩放。

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

@@ -0,0 +1,29 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / LayerSwitchModelRequest
+
+# Interface: LayerSwitchModelRequest
+
+Layer.switchModelLayer 参数。
+
+## Properties
+
+### parentId
+
+> **parentId**: `string`
+
+模型当前所属图层组 ID。
+
+***
+
+### ids
+
+> **ids**: `string`[]
+
+需要切换的模型 ID 列表。
+
+***
+
+### toParentId
+
+> **toParentId**: `string`
+
+目标图层组 ID。

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

@@ -0,0 +1,61 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / ModelAddRequest
+
+# Interface: ModelAddRequest
+
+Model.add 参数。
+
+## Properties
+
+### parentId
+
+> **parentId**: `string`
+
+父节点 ID。
+
+***
+
+### id
+
+> **id**: `string`
+
+新模型对象 ID。
+
+***
+
+### assetsPath?
+
+> `optional` **assetsPath**: `string`
+
+资源路径。
+
+***
+
+### position?
+
+> `optional` **position**: `Vector3`
+
+位置。
+
+***
+
+### angle?
+
+> `optional` **angle**: `Vector3`
+
+旋转角。
+
+***
+
+### scale?
+
+> `optional` **scale**: `Vector3`
+
+缩放。
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+备注描述。

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

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / ModelBoundsRequest
+
+# Interface: ModelBoundsRequest
+
+Model.getModelBoundsInfo 参数。
+
+## Properties
+
+### parentId
+
+> **parentId**: `string`
+
+父节点 ID。
+
+***
+
+### id
+
+> **id**: `string` \| `string`[]
+
+目标模型 ID，支持单个或多个。

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

@@ -0,0 +1,53 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / ModelPOIAddRequest
+
+# Interface: ModelPOIAddRequest
+
+ModelPOI.add 参数。
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+模型气泡 ID。
+
+***
+
+### groupName
+
+> **groupName**: `string`
+
+分组名称。
+
+***
+
+### assetPath
+
+> **assetPath**: `string`
+
+资源路径。
+
+***
+
+### targetParentId?
+
+> `optional` **targetParentId**: `string`
+
+目标父节点 ID。
+
+***
+
+### targetId?
+
+> `optional` **targetId**: `string`
+
+目标对象 ID。
+
+***
+
+### visible?
+
+> `optional` **visible**: `boolean`
+
+是否可见。

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

@@ -0,0 +1,13 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / ModelPOIDeleteByGroupRequest
+
+# Interface: ModelPOIDeleteByGroupRequest
+
+ModelPOI.deleteByGroup 参数。
+
+## Properties
+
+### groupName
+
+> **groupName**: `string`
+
+分组名称。