@nnepoch/dtc-sdk 3.0.16 → 3.0.17
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.17.js +2 -0
- package/dist/cjs/index.cjs +4 -4
- package/dist/cjs/index.d.cts +38 -3
- package/dist/esm/index.d.ts +38 -3
- package/dist/esm/index.js +4 -4
- package/docs/api/api/classes/GizmosTool.md +86 -2
- package/docs/api/api/classes/Layer.md +50 -1
- package/docs/api/api/classes/Model.md +7 -7
- package/docs/api/api/classes/Scene.md +6 -134
- package/docs/api/api/classes/UIPOI.md +4 -4
- package/docs/api/application/DTCEngine/classes/DTCEngine.md +4 -0
- package/docs/api/index.md +1 -1
- package/docs/api/typedoc-sidebar.json +36 -0
- package/docs/api/types/enumerations/FilterMode.md +1 -1
- package/docs/api/types/enumerations/UIPopState.md +29 -0
- package/docs/api/types/index.md +9 -0
- package/docs/api/types/interfaces/BuildingFloorItem.md +16 -0
- package/docs/api/types/interfaces/BuildingFloorOverview.md +16 -0
- package/docs/api/types/interfaces/GizmosModelSnapRequest.md +21 -0
- package/docs/api/types/interfaces/GizmosModelSnapResult.md +37 -0
- package/docs/api/types/interfaces/GizmosPolygonSelectRequest.md +21 -0
- package/docs/api/types/interfaces/GizmosPolygonSelectResult.md +11 -0
- package/docs/api/types/interfaces/GizmosStartBatchRequest.md +11 -0
- package/docs/api/types/interfaces/LayerPoiStateRequest.md +21 -0
- package/docs/api/types/interfaces/LayerUpdatePoiStatesRequest.md +21 -0
- package/docs/api/types/interfaces/ModelSetVisibleByAttributeRequest.md +1 -1
- package/docs/api/types/interfaces/UIPOIUpdateStateRequest.md +5 -5
- package/docs/api/types/type-aliases/GizmosModelTarget.md +7 -0
- package/package.json +1 -1
- package/dist/browser/dtc-sdk-3.0.16.js +0 -2
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
|
|
11
11
|
## Agent Capabilities
|
|
12
12
|
|
|
13
|
-
开启模型编辑, 切换编辑目标,
|
|
13
|
+
开启模型编辑, 切换编辑目标, 退出模型编辑, 模型表面吸附, 框选模型, 批量变换模型
|
|
14
14
|
|
|
15
15
|
## Extends
|
|
16
16
|
|
|
@@ -25,12 +25,13 @@
|
|
|
25
25
|
开启或切换模型编辑目标,同时显示平移、旋转和缩放手柄,无需指定编辑模式。
|
|
26
26
|
拖动过程中 UE 持续推送 ModelUpdate,SDK 不做时间防抖;业务端自行防抖保存。
|
|
27
27
|
取消拖动时会回传恢复后的变换,不能把任意一次事件视为后端已保存。
|
|
28
|
+
传 targets 可跨分组批量编辑,共用一个中心手柄;批量 ModelUpdate 包含整组选中模型。
|
|
28
29
|
|
|
29
30
|
#### Parameters
|
|
30
31
|
|
|
31
32
|
| Parameter | Type | Description |
|
|
32
33
|
| ------ | ------ | ------ |
|
|
33
|
-
| `payload` | [`GizmosStartSimpleRequest`](../../types/interfaces/GizmosStartSimpleRequest.md) | 网页 MODEL 的分组和点位标识。 |
|
|
34
|
+
| `payload` | [`GizmosStartSimpleRequest`](../../types/interfaces/GizmosStartSimpleRequest.md) \| [`GizmosStartBatchRequest`](../../types/interfaces/GizmosStartBatchRequest.md) | 网页 MODEL 的分组和点位标识。 |
|
|
34
35
|
| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选结果回调。 |
|
|
35
36
|
|
|
36
37
|
#### Returns
|
|
@@ -92,3 +93,86 @@ low
|
|
|
92
93
|
```ts
|
|
93
94
|
await dtcEngine.GizmosTool.endSimpleGizmoMode();
|
|
94
95
|
```
|
|
96
|
+
|
|
97
|
+
***
|
|
98
|
+
|
|
99
|
+
### selectModelsByPolygon()
|
|
100
|
+
|
|
101
|
+
> **selectModelsByPolygon**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<[`GizmosPolygonSelectResult`](../../types/interfaces/GizmosPolygonSelectResult.md)\>\>
|
|
102
|
+
|
|
103
|
+
在指定网页分组及子分组中框选可见模型;不传 polygon 时左键拖框,Escape/右键取消。
|
|
104
|
+
返回各模型的 parentId/id,不自动开启编辑;业务端取得全部分组锁后将 targets 传给 startSimpleGizmoMode。
|
|
105
|
+
显式 polygon 使用视频图像归一化坐标,不含 contain 黑边;交互等待期间不占用 UE 请求超时。
|
|
106
|
+
|
|
107
|
+
#### Parameters
|
|
108
|
+
|
|
109
|
+
| Parameter | Type | Description |
|
|
110
|
+
| ------ | ------ | ------ |
|
|
111
|
+
| `payload` | [`GizmosPolygonSelectRequest`](../../types/interfaces/GizmosPolygonSelectRequest.md) | 分组范围及可选多边形顶点。 |
|
|
112
|
+
| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<[`GizmosPolygonSelectResult`](../../types/interfaces/GizmosPolygonSelectResult.md)\>\> | 选择完成回调;取消或失败时收到 Error。 |
|
|
113
|
+
|
|
114
|
+
#### Returns
|
|
115
|
+
|
|
116
|
+
`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<[`GizmosPolygonSelectResult`](../../types/interfaces/GizmosPolygonSelectResult.md)\>\>
|
|
117
|
+
|
|
118
|
+
选中模型身份列表,空区域返回空 targets。
|
|
119
|
+
|
|
120
|
+
#### Agent Side Effects
|
|
121
|
+
|
|
122
|
+
read
|
|
123
|
+
|
|
124
|
+
#### Agent Preconditions
|
|
125
|
+
|
|
126
|
+
WebRTC 已连接,UE 已编译框选服务
|
|
127
|
+
|
|
128
|
+
#### Agent Risk Level
|
|
129
|
+
|
|
130
|
+
low
|
|
131
|
+
|
|
132
|
+
#### Agent Example
|
|
133
|
+
|
|
134
|
+
***
|
|
135
|
+
|
|
136
|
+
### modelSnapById()
|
|
137
|
+
|
|
138
|
+
> **modelSnapById**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<[`GizmosModelSnapResult`](../../types/interfaces/GizmosModelSnapResult.md)\>\>
|
|
139
|
+
|
|
140
|
+
将指定模型或整个分组吸附到允许的最近表面,安装类型沿用 UE 资源绑定及点位安装属性。
|
|
141
|
+
同步模型 POI,保留简易编辑手柄;整批成功点位通过一次 ModelUpdate 回传,由业务端防抖保存。
|
|
142
|
+
未命中表面的模型保持原位;部分失败不会撤销其它成功模型,请检查 params.failedIds/errors。
|
|
143
|
+
|
|
144
|
+
#### Parameters
|
|
145
|
+
|
|
146
|
+
| Parameter | Type | Description |
|
|
147
|
+
| ------ | ------ | ------ |
|
|
148
|
+
| `payload` | [`GizmosModelSnapRequest`](../../types/interfaces/GizmosModelSnapRequest.md) | 搜索分组及可选模型 ID,支持子分组;省略 ids 表示整个分组。 |
|
|
149
|
+
| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<[`GizmosModelSnapResult`](../../types/interfaces/GizmosModelSnapResult.md)\>\> | 可选结果回调。 |
|
|
150
|
+
|
|
151
|
+
#### Returns
|
|
152
|
+
|
|
153
|
+
`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<[`GizmosModelSnapResult`](../../types/interfaces/GizmosModelSnapResult.md)\>\>
|
|
154
|
+
|
|
155
|
+
吸附明细,不代表平台已保存;请求无效或服务失败时 Promise 拒绝。
|
|
156
|
+
|
|
157
|
+
#### Agent Side Effects
|
|
158
|
+
|
|
159
|
+
write
|
|
160
|
+
|
|
161
|
+
#### Agent Preconditions
|
|
162
|
+
|
|
163
|
+
WebRTC 已连接;UE 已编译表面吸附服务;本地工作台未占用输入
|
|
164
|
+
|
|
165
|
+
#### Agent Risk Level
|
|
166
|
+
|
|
167
|
+
medium
|
|
168
|
+
|
|
169
|
+
#### Agent Example
|
|
170
|
+
|
|
171
|
+
#### Example
|
|
172
|
+
|
|
173
|
+
```ts
|
|
174
|
+
const result = await dtcEngine.GizmosTool.modelSnapById({ parentId: point.parentId, ids: [point.id] });
|
|
175
|
+
console.log(result.params.snappedIds, result.params.failedIds);
|
|
176
|
+
// 整组吸附(包括子分组):
|
|
177
|
+
await dtcEngine.GizmosTool.modelSnapById({ parentId: 'sdk3-point-editor-test' });
|
|
178
|
+
```
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
|
|
11
11
|
## Agent Capabilities
|
|
12
12
|
|
|
13
|
-
图层添加, 图层删除, 图层存在性查询, 模型图层切换, 图层气泡显隐, 图层模型添加, 图层模型删除, 图层子对象查询, POI名称更新, POI
|
|
13
|
+
图层添加, 图层删除, 图层存在性查询, 模型图层切换, 图层气泡显隐, 图层模型添加, 图层模型删除, 图层子对象查询, POI名称更新, POI名称重置, 气泡状态更新
|
|
14
14
|
|
|
15
15
|
## Extends
|
|
16
16
|
|
|
@@ -463,6 +463,55 @@ low
|
|
|
463
463
|
|
|
464
464
|
***
|
|
465
465
|
|
|
466
|
+
### updatePoiStates()
|
|
467
|
+
|
|
468
|
+
> **updatePoiStates**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
|
|
469
|
+
|
|
470
|
+
更新分组下气泡的状态。
|
|
471
|
+
`popStates` 为气泡状态列表,至少一个;`state` 支持 `normal` 正常、`alert` 警告、`offline` 离线。
|
|
472
|
+
|
|
473
|
+
#### Parameters
|
|
474
|
+
|
|
475
|
+
| Parameter | Type | Description |
|
|
476
|
+
| ------ | ------ | ------ |
|
|
477
|
+
| `payload` | [`LayerUpdatePoiStatesRequest`](../../types/interfaces/LayerUpdatePoiStatesRequest.md) | 气泡状态更新参数。 |
|
|
478
|
+
| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
|
|
479
|
+
|
|
480
|
+
#### Returns
|
|
481
|
+
|
|
482
|
+
`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
|
|
483
|
+
|
|
484
|
+
Promise 形式的接口响应。
|
|
485
|
+
|
|
486
|
+
#### Agent Side Effects
|
|
487
|
+
|
|
488
|
+
write
|
|
489
|
+
|
|
490
|
+
#### Agent Preconditions
|
|
491
|
+
|
|
492
|
+
DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
493
|
+
|
|
494
|
+
#### Agent Risk Level
|
|
495
|
+
|
|
496
|
+
low
|
|
497
|
+
|
|
498
|
+
#### Agent Example
|
|
499
|
+
|
|
500
|
+
#### Example
|
|
501
|
+
|
|
502
|
+
```ts
|
|
503
|
+
let poiStates = [
|
|
504
|
+
{ id: '1', state: 'normal' }, // normal 正常; alert 警告状态; offline 离线状态
|
|
505
|
+
{ id: '2', state: 'alert' }
|
|
506
|
+
];
|
|
507
|
+
dtcEngine.Layer.updatePoiStates(
|
|
508
|
+
{ parentId: 'LCD80CunXianShiPingPop', poiStates: poiStates },
|
|
509
|
+
(result) => { console.log(result); }
|
|
510
|
+
);
|
|
511
|
+
```
|
|
512
|
+
|
|
513
|
+
***
|
|
514
|
+
|
|
466
515
|
### removeModel()
|
|
467
516
|
|
|
468
517
|
> **removeModel**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
|
|
@@ -108,9 +108,9 @@ low
|
|
|
108
108
|
|
|
109
109
|
***
|
|
110
110
|
|
|
111
|
-
###
|
|
111
|
+
### setVisibleByAttribute()
|
|
112
112
|
|
|
113
|
-
> **
|
|
113
|
+
> **setVisibleByAttribute**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
|
|
114
114
|
|
|
115
115
|
按对象属性过滤设置模型对象显隐状态。
|
|
116
116
|
默认值:`filterMode=FilterMode.Loose`、`visible=true`、`otherVisible=false`。
|
|
@@ -148,20 +148,20 @@ low
|
|
|
148
148
|
|
|
149
149
|
```ts
|
|
150
150
|
// 隐藏 floor='B2' 的对象
|
|
151
|
-
dtcEngine.Model.
|
|
151
|
+
dtcEngine.Model.setVisibleByAttribute({ attributes: { floor: 'B2' }, filterMode: dtcEngine.Enums.FilterMode.Loose, visible: false }, (result) => { console.log(result); });
|
|
152
152
|
// 显示 floor='B2' 的对象
|
|
153
|
-
dtcEngine.Model.
|
|
153
|
+
dtcEngine.Model.setVisibleByAttribute({ attributes: { floor: 'B2' }, filterMode: dtcEngine.Enums.FilterMode.Loose, visible: true }, (result) => { console.log(result); });
|
|
154
154
|
```
|
|
155
155
|
|
|
156
156
|
**严格过滤 Strict:floor='B1' 的对象按 visible 控制,其它楼层对象按 otherVisible 控制**
|
|
157
157
|
|
|
158
158
|
```ts
|
|
159
159
|
// 隐藏 floor='B1' 的对象,其它楼层对象也隐藏
|
|
160
|
-
dtcEngine.Model.
|
|
160
|
+
dtcEngine.Model.setVisibleByAttribute({ attributes: { floor: 'B1' }, filterMode: dtcEngine.Enums.FilterMode.Strict, visible: false, otherVisible: false }, (result) => { console.log(result); });
|
|
161
161
|
// 隐藏 floor='B1' 的对象,其它楼层对象显示
|
|
162
|
-
dtcEngine.Model.
|
|
162
|
+
dtcEngine.Model.setVisibleByAttribute({ attributes: { floor: 'B1' }, filterMode: dtcEngine.Enums.FilterMode.Strict, visible: false, otherVisible: true }, (result) => { console.log(result); });
|
|
163
163
|
// 显示 floor='B1' 的对象,其它楼层对象隐藏
|
|
164
|
-
dtcEngine.Model.
|
|
164
|
+
dtcEngine.Model.setVisibleByAttribute({ attributes: { floor: 'B1' }, filterMode: dtcEngine.Enums.FilterMode.Strict, visible: true, otherVisible: false }, (result) => { console.log(result); });
|
|
165
165
|
```
|
|
166
166
|
|
|
167
167
|
***
|
|
@@ -53,9 +53,9 @@ low
|
|
|
53
53
|
#### Example
|
|
54
54
|
|
|
55
55
|
```ts
|
|
56
|
-
dtcEngine.Scene.getAllSceneName((data) => {
|
|
57
|
-
|
|
58
|
-
});
|
|
56
|
+
dtcEngine.Scene.getAllSceneName((data) => {
|
|
57
|
+
console.log(data);
|
|
58
|
+
});
|
|
59
59
|
```
|
|
60
60
|
|
|
61
61
|
***
|
|
@@ -96,9 +96,9 @@ low
|
|
|
96
96
|
#### Example
|
|
97
97
|
|
|
98
98
|
```ts
|
|
99
|
-
dtcEngine.Scene.switchSceneByName({ sceneName: 'TestScene' }, (result) => {
|
|
100
|
-
|
|
101
|
-
});
|
|
99
|
+
dtcEngine.Scene.switchSceneByName({ sceneName: 'TestScene' }, (result) => {
|
|
100
|
+
console.log(result);
|
|
101
|
+
});
|
|
102
102
|
```
|
|
103
103
|
|
|
104
104
|
***
|
|
@@ -142,131 +142,3 @@ dtcEngine.Scene.getCurrentSceneName((result) => {
|
|
|
142
142
|
console.log(result);
|
|
143
143
|
});
|
|
144
144
|
```
|
|
145
|
-
|
|
146
|
-
***
|
|
147
|
-
|
|
148
|
-
### listenMapCompass()
|
|
149
|
-
|
|
150
|
-
> **listenMapCompass**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
|
|
151
|
-
|
|
152
|
-
监听地图指北针角度变化。
|
|
153
|
-
|
|
154
|
-
#### Parameters
|
|
155
|
-
|
|
156
|
-
| Parameter | Type | Description |
|
|
157
|
-
| ------ | ------ | ------ |
|
|
158
|
-
| `payload` | [`SceneListenCompassRequest`](../../types/interfaces/SceneListenCompassRequest.md) | 开关参数。 |
|
|
159
|
-
| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
|
|
160
|
-
|
|
161
|
-
#### Returns
|
|
162
|
-
|
|
163
|
-
`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
|
|
164
|
-
|
|
165
|
-
Promise 形式的接口响应。
|
|
166
|
-
|
|
167
|
-
#### Agent Side Effects
|
|
168
|
-
|
|
169
|
-
write
|
|
170
|
-
|
|
171
|
-
#### Agent Preconditions
|
|
172
|
-
|
|
173
|
-
DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
174
|
-
|
|
175
|
-
#### Agent Risk Level
|
|
176
|
-
|
|
177
|
-
low
|
|
178
|
-
|
|
179
|
-
#### Agent Example
|
|
180
|
-
|
|
181
|
-
#### Example
|
|
182
|
-
|
|
183
|
-
```ts
|
|
184
|
-
dtcEngine.Scene.listenMapCompass({ enable: true }, (result) => {
|
|
185
|
-
console.log(result);
|
|
186
|
-
});
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
***
|
|
190
|
-
|
|
191
|
-
### setFeatureToggle()
|
|
192
|
-
|
|
193
|
-
> **setFeatureToggle**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
|
|
194
|
-
|
|
195
|
-
设置场景特性开关。
|
|
196
|
-
|
|
197
|
-
#### Parameters
|
|
198
|
-
|
|
199
|
-
| Parameter | Type | Description |
|
|
200
|
-
| ------ | ------ | ------ |
|
|
201
|
-
| `payload` | [`FeatureToggleRequest`](../../types/interfaces/FeatureToggleRequest.md) | 特性键值。 |
|
|
202
|
-
| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
|
|
203
|
-
|
|
204
|
-
#### Returns
|
|
205
|
-
|
|
206
|
-
`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
|
|
207
|
-
|
|
208
|
-
Promise 形式的接口响应。
|
|
209
|
-
|
|
210
|
-
#### Agent Side Effects
|
|
211
|
-
|
|
212
|
-
write
|
|
213
|
-
|
|
214
|
-
#### Agent Preconditions
|
|
215
|
-
|
|
216
|
-
DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
217
|
-
|
|
218
|
-
#### Agent Risk Level
|
|
219
|
-
|
|
220
|
-
low
|
|
221
|
-
|
|
222
|
-
#### Agent Example
|
|
223
|
-
|
|
224
|
-
#### Example
|
|
225
|
-
|
|
226
|
-
```ts
|
|
227
|
-
dtcEngine.Scene.setFeatureToggle({ key: 'minimap', enabled: true }, (result) => {
|
|
228
|
-
console.log(result);
|
|
229
|
-
});
|
|
230
|
-
```
|
|
231
|
-
|
|
232
|
-
***
|
|
233
|
-
|
|
234
|
-
### getSceneMeta()
|
|
235
|
-
|
|
236
|
-
> **getSceneMeta**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
|
|
237
|
-
|
|
238
|
-
获取当前场景扩展元信息。
|
|
239
|
-
|
|
240
|
-
#### Parameters
|
|
241
|
-
|
|
242
|
-
| Parameter | Type | Description |
|
|
243
|
-
| ------ | ------ | ------ |
|
|
244
|
-
| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
|
|
245
|
-
|
|
246
|
-
#### Returns
|
|
247
|
-
|
|
248
|
-
`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
|
|
249
|
-
|
|
250
|
-
Promise 形式的接口响应。
|
|
251
|
-
|
|
252
|
-
#### Agent Side Effects
|
|
253
|
-
|
|
254
|
-
read
|
|
255
|
-
|
|
256
|
-
#### Agent Preconditions
|
|
257
|
-
|
|
258
|
-
DTCEngine 已完成鉴权并建立 WebRTC 连接
|
|
259
|
-
|
|
260
|
-
#### Agent Risk Level
|
|
261
|
-
|
|
262
|
-
low
|
|
263
|
-
|
|
264
|
-
#### Agent Example
|
|
265
|
-
|
|
266
|
-
#### Example
|
|
267
|
-
|
|
268
|
-
```ts
|
|
269
|
-
dtcEngine.Scene.getSceneMeta((result) => {
|
|
270
|
-
console.log(result);
|
|
271
|
-
});
|
|
272
|
-
```
|
|
@@ -192,9 +192,9 @@ dtcEngine.UIPOI.update(
|
|
|
192
192
|
|
|
193
193
|
***
|
|
194
194
|
|
|
195
|
-
###
|
|
195
|
+
### updatePoiStates()
|
|
196
196
|
|
|
197
|
-
> **
|
|
197
|
+
> **updatePoiStates**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
|
|
198
198
|
|
|
199
199
|
批量更新 UIPOI 状态。
|
|
200
200
|
|
|
@@ -228,8 +228,8 @@ low
|
|
|
228
228
|
#### Example
|
|
229
229
|
|
|
230
230
|
```ts
|
|
231
|
-
dtcEngine.UIPOI.
|
|
232
|
-
{
|
|
231
|
+
dtcEngine.UIPOI.updatePoiStates(
|
|
232
|
+
{ parentId: 'LCD80CunXianShiPingPop', poiStates: [{ id: '1', state: 'normal' }] },
|
|
233
233
|
(result) => { console.log(result); }
|
|
234
234
|
);
|
|
235
235
|
```
|
|
@@ -467,6 +467,10 @@ Auto 模式会根据系统性能自动选择最合适的 DLSS 质量档位,提
|
|
|
467
467
|
|
|
468
468
|
> **TrainBehavior**: *typeof* [`TrainBehavior`](../../../types/enumerations/TrainBehavior.md)
|
|
469
469
|
|
|
470
|
+
#### UIPopState
|
|
471
|
+
|
|
472
|
+
> **UIPopState**: *typeof* [`UIPopState`](../../../types/enumerations/UIPopState.md)
|
|
473
|
+
|
|
470
474
|
#### VideoCodeType
|
|
471
475
|
|
|
472
476
|
> **VideoCodeType**: *typeof* [`VideoCodeType`](../../../types/enumerations/VideoCodeType.md)
|
package/docs/api/index.md
CHANGED
|
@@ -250,6 +250,10 @@
|
|
|
250
250
|
"text": "TrainBehavior",
|
|
251
251
|
"link": "/api/types/enumerations/TrainBehavior.md"
|
|
252
252
|
},
|
|
253
|
+
{
|
|
254
|
+
"text": "UIPopState",
|
|
255
|
+
"link": "/api/types/enumerations/UIPopState.md"
|
|
256
|
+
},
|
|
253
257
|
{
|
|
254
258
|
"text": "GizmoType",
|
|
255
259
|
"link": "/api/types/enumerations/GizmoType.md"
|
|
@@ -380,6 +384,18 @@
|
|
|
380
384
|
"text": "GizmosStartSimpleRequest",
|
|
381
385
|
"link": "/api/types/interfaces/GizmosStartSimpleRequest.md"
|
|
382
386
|
},
|
|
387
|
+
{
|
|
388
|
+
"text": "GizmosStartBatchRequest",
|
|
389
|
+
"link": "/api/types/interfaces/GizmosStartBatchRequest.md"
|
|
390
|
+
},
|
|
391
|
+
{
|
|
392
|
+
"text": "GizmosPolygonSelectRequest",
|
|
393
|
+
"link": "/api/types/interfaces/GizmosPolygonSelectRequest.md"
|
|
394
|
+
},
|
|
395
|
+
{
|
|
396
|
+
"text": "GizmosPolygonSelectResult",
|
|
397
|
+
"link": "/api/types/interfaces/GizmosPolygonSelectResult.md"
|
|
398
|
+
},
|
|
383
399
|
{
|
|
384
400
|
"text": "PointEditorVector",
|
|
385
401
|
"link": "/api/types/interfaces/PointEditorVector.md"
|
|
@@ -412,6 +428,14 @@
|
|
|
412
428
|
"text": "PointEditorDeleteResult",
|
|
413
429
|
"link": "/api/types/interfaces/PointEditorDeleteResult.md"
|
|
414
430
|
},
|
|
431
|
+
{
|
|
432
|
+
"text": "GizmosModelSnapRequest",
|
|
433
|
+
"link": "/api/types/interfaces/GizmosModelSnapRequest.md"
|
|
434
|
+
},
|
|
435
|
+
{
|
|
436
|
+
"text": "GizmosModelSnapResult",
|
|
437
|
+
"link": "/api/types/interfaces/GizmosModelSnapResult.md"
|
|
438
|
+
},
|
|
415
439
|
{
|
|
416
440
|
"text": "QosSessionContext",
|
|
417
441
|
"link": "/api/types/interfaces/QosSessionContext.md"
|
|
@@ -540,6 +564,14 @@
|
|
|
540
564
|
"text": "LayerResetPOINameRequest",
|
|
541
565
|
"link": "/api/types/interfaces/LayerResetPOINameRequest.md"
|
|
542
566
|
},
|
|
567
|
+
{
|
|
568
|
+
"text": "LayerPoiStateRequest",
|
|
569
|
+
"link": "/api/types/interfaces/LayerPoiStateRequest.md"
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
"text": "LayerUpdatePoiStatesRequest",
|
|
573
|
+
"link": "/api/types/interfaces/LayerUpdatePoiStatesRequest.md"
|
|
574
|
+
},
|
|
543
575
|
{
|
|
544
576
|
"text": "LayerModelAddRequest",
|
|
545
577
|
"link": "/api/types/interfaces/LayerModelAddRequest.md"
|
|
@@ -918,6 +950,10 @@
|
|
|
918
950
|
"text": "NetworkAdaptationActionType",
|
|
919
951
|
"link": "/api/types/type-aliases/NetworkAdaptationActionType.md"
|
|
920
952
|
},
|
|
953
|
+
{
|
|
954
|
+
"text": "GizmosModelTarget",
|
|
955
|
+
"link": "/api/types/type-aliases/GizmosModelTarget.md"
|
|
956
|
+
},
|
|
921
957
|
{
|
|
922
958
|
"text": "PointEditorUpdateRequest",
|
|
923
959
|
"link": "/api/types/type-aliases/PointEditorUpdateRequest.md"
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / UIPopState
|
|
2
|
+
|
|
3
|
+
# Enumeration: UIPopState
|
|
4
|
+
|
|
5
|
+
Layer.updatePoiStates 气泡状态。
|
|
6
|
+
|
|
7
|
+
## Enumeration Members
|
|
8
|
+
|
|
9
|
+
### Normal
|
|
10
|
+
|
|
11
|
+
> **Normal**: `"normal"`
|
|
12
|
+
|
|
13
|
+
正常状态。
|
|
14
|
+
|
|
15
|
+
***
|
|
16
|
+
|
|
17
|
+
### Alert
|
|
18
|
+
|
|
19
|
+
> **Alert**: `"alert"`
|
|
20
|
+
|
|
21
|
+
警告状态。
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### Offline
|
|
26
|
+
|
|
27
|
+
> **Offline**: `"offline"`
|
|
28
|
+
|
|
29
|
+
离线状态。
|
package/docs/api/types/index.md
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
- [ModelTransformType](enumerations/ModelTransformType.md)
|
|
10
10
|
- [FilterMode](enumerations/FilterMode.md)
|
|
11
11
|
- [TrainBehavior](enumerations/TrainBehavior.md)
|
|
12
|
+
- [UIPopState](enumerations/UIPopState.md)
|
|
12
13
|
- [GizmoType](enumerations/GizmoType.md)
|
|
13
14
|
|
|
14
15
|
## Interfaces
|
|
@@ -43,6 +44,9 @@
|
|
|
43
44
|
- [NetworkDecisionTrace](interfaces/NetworkDecisionTrace.md)
|
|
44
45
|
- [NetworkDiagnosticsSnapshot](interfaces/NetworkDiagnosticsSnapshot.md)
|
|
45
46
|
- [GizmosStartSimpleRequest](interfaces/GizmosStartSimpleRequest.md)
|
|
47
|
+
- [GizmosStartBatchRequest](interfaces/GizmosStartBatchRequest.md)
|
|
48
|
+
- [GizmosPolygonSelectRequest](interfaces/GizmosPolygonSelectRequest.md)
|
|
49
|
+
- [GizmosPolygonSelectResult](interfaces/GizmosPolygonSelectResult.md)
|
|
46
50
|
- [PointEditorVector](interfaces/PointEditorVector.md)
|
|
47
51
|
- [PointEditorResource](interfaces/PointEditorResource.md)
|
|
48
52
|
- [PointEditorCategory](interfaces/PointEditorCategory.md)
|
|
@@ -51,6 +55,8 @@
|
|
|
51
55
|
- [PointEditorAddRequest](interfaces/PointEditorAddRequest.md)
|
|
52
56
|
- [PointEditorDeleteRequest](interfaces/PointEditorDeleteRequest.md)
|
|
53
57
|
- [PointEditorDeleteResult](interfaces/PointEditorDeleteResult.md)
|
|
58
|
+
- [GizmosModelSnapRequest](interfaces/GizmosModelSnapRequest.md)
|
|
59
|
+
- [GizmosModelSnapResult](interfaces/GizmosModelSnapResult.md)
|
|
54
60
|
- [QosSessionContext](interfaces/QosSessionContext.md)
|
|
55
61
|
- [QosRuntimeContext](interfaces/QosRuntimeContext.md)
|
|
56
62
|
- [QosWarnErrorSummary](interfaces/QosWarnErrorSummary.md)
|
|
@@ -83,6 +89,8 @@
|
|
|
83
89
|
- [LayerPOIAddRequest](interfaces/LayerPOIAddRequest.md)
|
|
84
90
|
- [LayerUpdatePOINameRequest](interfaces/LayerUpdatePOINameRequest.md)
|
|
85
91
|
- [LayerResetPOINameRequest](interfaces/LayerResetPOINameRequest.md)
|
|
92
|
+
- [LayerPoiStateRequest](interfaces/LayerPoiStateRequest.md)
|
|
93
|
+
- [LayerUpdatePoiStatesRequest](interfaces/LayerUpdatePoiStatesRequest.md)
|
|
86
94
|
- [LayerModelAddRequest](interfaces/LayerModelAddRequest.md)
|
|
87
95
|
- [LayerModelRemoveRequest](interfaces/LayerModelRemoveRequest.md)
|
|
88
96
|
- [LayerChildElementRequest](interfaces/LayerChildElementRequest.md)
|
|
@@ -179,6 +187,7 @@
|
|
|
179
187
|
- [NetworkAdaptationLevel](type-aliases/NetworkAdaptationLevel.md)
|
|
180
188
|
- [NetworkAdaptationMode](type-aliases/NetworkAdaptationMode.md)
|
|
181
189
|
- [NetworkAdaptationActionType](type-aliases/NetworkAdaptationActionType.md)
|
|
190
|
+
- [GizmosModelTarget](type-aliases/GizmosModelTarget.md)
|
|
182
191
|
- [PointEditorUpdateRequest](type-aliases/PointEditorUpdateRequest.md)
|
|
183
192
|
- [PointEditorPoint](type-aliases/PointEditorPoint.md)
|
|
184
193
|
- [PointEditorCreateCallback](type-aliases/PointEditorCreateCallback.md)
|
|
@@ -27,3 +27,19 @@ UE 楼层节点 ID。
|
|
|
27
27
|
> `optional` **objects?**: `string`[]
|
|
28
28
|
|
|
29
29
|
切换到该楼层后显示的附属对象。
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### showLayers?
|
|
34
|
+
|
|
35
|
+
> `optional` **showLayers?**: `string`[]
|
|
36
|
+
|
|
37
|
+
切层动画开始前显示的对象 ID;不限定于楼层父节点。
|
|
38
|
+
|
|
39
|
+
***
|
|
40
|
+
|
|
41
|
+
### hideLayers?
|
|
42
|
+
|
|
43
|
+
> `optional` **hideLayers?**: `string`[]
|
|
44
|
+
|
|
45
|
+
切层动画开始前隐藏的对象 ID;与 objects/showLayers 重复时隐藏优先。
|
|
@@ -14,6 +14,22 @@
|
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
17
|
+
### showLayers?
|
|
18
|
+
|
|
19
|
+
> `optional` **showLayers?**: `string`[]
|
|
20
|
+
|
|
21
|
+
恢复整栋视图时,在动画开始前显示的对象 ID。
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### hideLayers?
|
|
26
|
+
|
|
27
|
+
> `optional` **hideLayers?**: `string`[]
|
|
28
|
+
|
|
29
|
+
恢复整栋视图时,在动画开始前隐藏的对象 ID;隐藏优先。
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
17
33
|
### viewPoint?
|
|
18
34
|
|
|
19
35
|
> `optional` **viewPoint?**: [`BuildingFloorViewPoint`](BuildingFloorViewPoint.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / GizmosModelSnapRequest
|
|
2
|
+
|
|
3
|
+
# Interface: GizmosModelSnapRequest
|
|
4
|
+
|
|
5
|
+
在网页模型分组(含子分组)中执行表面吸附。
|
|
6
|
+
|
|
7
|
+
## Properties
|
|
8
|
+
|
|
9
|
+
### parentId
|
|
10
|
+
|
|
11
|
+
> **parentId**: `string`
|
|
12
|
+
|
|
13
|
+
搜索范围对应的分组 ID;跨组选择时可使用 EditorLayerGroup。
|
|
14
|
+
|
|
15
|
+
***
|
|
16
|
+
|
|
17
|
+
### ids?
|
|
18
|
+
|
|
19
|
+
> `optional` **ids?**: `string`[]
|
|
20
|
+
|
|
21
|
+
指定点位全局 ID;省略时吸附整个分组,不允许空数组或重复 ID。
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / GizmosModelSnapResult
|
|
2
|
+
|
|
3
|
+
# Interface: GizmosModelSnapResult
|
|
4
|
+
|
|
5
|
+
吸附允许部分成功;只对成功点位触发 ModelUpdate,不代表平台已保存。
|
|
6
|
+
|
|
7
|
+
## Properties
|
|
8
|
+
|
|
9
|
+
### snappedIds
|
|
10
|
+
|
|
11
|
+
> **snappedIds**: `string`[]
|
|
12
|
+
|
|
13
|
+
成功吸附的模型 ID。
|
|
14
|
+
|
|
15
|
+
***
|
|
16
|
+
|
|
17
|
+
### failedIds
|
|
18
|
+
|
|
19
|
+
> **failedIds**: `string`[]
|
|
20
|
+
|
|
21
|
+
未命中允许表面、坐标转换失败等原因导致未吸附的模型 ID。
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### errors
|
|
26
|
+
|
|
27
|
+
> **errors**: `object`[]
|
|
28
|
+
|
|
29
|
+
对应失败点位的具体原因。
|
|
30
|
+
|
|
31
|
+
#### id
|
|
32
|
+
|
|
33
|
+
> **id**: `string`
|
|
34
|
+
|
|
35
|
+
#### message
|
|
36
|
+
|
|
37
|
+
> **message**: `string`
|