@nnepoch/dtc-sdk 3.0.11 → 3.0.13

package/docs/api/api/classes/ApiRegistryError.md

@@ -51,10 +51,10 @@ API 注册表运行时校验错误。
 
 ### moduleName?
 
-> `readonly` `optional` **moduleName**: `string`
+> `readonly` `optional` **moduleName?**: `string`
 
 ***
 
 ### dependencyName?
 
-> `readonly` `optional` **dependencyName**: `string`
+> `readonly` `optional` **dependencyName?**: `string`

package/docs/api/api/classes/Camera.md

@@ -555,9 +555,9 @@ low
 #### Example
 
 ```ts
-dtcEngine.Camera.startCameraObjFollow({ id: 'myCar', offSet: new dtcEngine.Type.Vector3(0, 3, 5), smooth: 0.85 }, (result) => {
-  console.log(result);
-});
+ dtcEngine.Camera.startCameraObjFollow({ id: 'myCar', offSet: new dtcEngine.Type.Vector3(0, 3, 5), smooth: 0.85 }, (result) => {
+   console.log(result);
+ });
 ```
 
 ***

package/docs/api/api/classes/GizmosTool.md

@@ -0,0 +1,94 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / GizmosTool
+
+# Class: GizmosTool
+
+网页 MODEL 运行时编辑，不开启本地工作台，不保存 PointTool 文件。
+
+## Agent Title
+
+模型交互编辑
+
+## Agent Capabilities
+
+开启模型编辑, 切换编辑目标, 退出模型编辑
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### startSimpleGizmoMode()
+
+> **startSimpleGizmoMode**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+开启或切换模型编辑目标，同时显示平移、旋转和缩放手柄，无需指定编辑模式。
+拖动过程中 UE 持续推送 ModelUpdate，SDK 不做时间防抖；业务端自行防抖保存。
+取消拖动时会回传恢复后的变换，不能把任意一次事件视为后端已保存。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`GizmosStartSimpleRequest`](../../types/interfaces/GizmosStartSimpleRequest.md) | 网页 MODEL 的分组和点位标识。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选结果回调。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+开启结果，不代表后端已保存。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+WebRTC 已连接；PointTool 本地工作台未占用输入
+
+#### Agent Risk Level
+
+medium
+
+#### Agent Example
+
+#### Example
+
+```ts
+await dtcEngine.GizmosTool.startSimpleGizmoMode({ parentId: point.parentId, id: point.id });
+```
+
+***
+
+### endSimpleGizmoMode()
+
+> **endSimpleGizmoMode**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+退出简易编辑并恢复进入前的鼠标转发配置，不保存本地点位文件。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选结果回调。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+退出结果。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Risk Level
+
+low
+
+#### Example
+
+```ts
+await dtcEngine.GizmosTool.endSimpleGizmoMode();
+```

package/docs/api/api/classes/HeatMap.md

@@ -0,0 +1,217 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / HeatMap
+
+# Class: HeatMap
+
+热力图 API，支持热力图创建（地理热力点数据）、移除、清空与参数设置。
+
+## Agent Title
+
+热力图
+
+## Agent Capabilities
+
+创建热力图, 移除热力图, 清除热力图, 修改热力图参数
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### create()
+
+> **create**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+创建热力图。
+按 `id` 查找已存在的热力图，存在则更新数据，不存在则新建；支持多个热力图并存。
+默认值：`textureSize={x:256,y:256}`、`mapSize={x:1000,y:1000}`、`influenceSize=50`、热力点 `value=1`。
+`points` 支持 `{ position, value }` 对象数组，或直接传 `Vector3Input[]` 位置数组（热度值默认 1）。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`HeatMapCreateRequest`](../../types/interfaces/HeatMapCreateRequest.md) | 热力图创建参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+示例 1：创建热力图，支持 `{ position, value }` 对象数组
+
+dtcEngine.HeatMap.create(
+   {
+     id: 'heatMap1',
+     textureSize: new dtcEngine.Type.Vector2(256, 256),
+     mapSize: new dtcEngine.Type.Vector2(1000, 1000),
+     influenceSize: 50,
+     points: [
+      { position: new dtcEngine.Type.Vector3(120.15, 30.28, 10), value: 0.8 },
+       { position: new dtcEngine.Type.Vector3(120.16, 30.29, 10), value: 0.5 }
+     ]
+   },
+   (result) => { console.log(result); }
+ );
+示例 2：创建热力图，支持直接传 Vector3Input[] 位置数组
+dtcEngine.HeatMap.create(
+  {
+    id: 'heatMap1',
+    textureSize: new dtcEngine.Type.Vector2(256, 256),
+    mapSize: new dtcEngine.Type.Vector2(1000, 1000),
+    influenceSize: 50,
+    points: [
+      new dtcEngine.Type.Vector3(120.15, 30.28, 10),
+      new dtcEngine.Type.Vector3(120.16, 30.29, 10)
+    ]
+  },
+  (result) => { console.log(result); }
+);
+```
+
+***
+
+### remove()
+
+> **remove**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+移除热力图。
+传 `id` 只移除指定热力图，未传则清空全部。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`HeatMapRemoveRequest`](../../types/interfaces/HeatMapRemoveRequest.md) | 热力图对象参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.HeatMap.remove({ id: 'heatMap1' }, (result) => { console.log(result); });
+```
+
+***
+
+### clear()
+
+> **clear**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+清空全部热力图，无需传参。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.HeatMap.clear((result) => { console.log(result); });
+```
+
+***
+
+### setConfig()
+
+> **setConfig**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置热力图参数（透明度/高度缩放/颜色过渡）。
+`id` 非空时作用于该 id 的热力图，否则作用于最近创建的热力图。
+默认值：`opacity=0.7`、`heightScale=2500`、`lerpScale=2.5`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`HeatMapConfigRequest`](../../types/interfaces/HeatMapConfigRequest.md) | 热力图参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.HeatMap.setConfig(
+   { id: 'heatMap1', opacity: 0.5, heightScale: 3000, lerpScale: 3 },
+   (result) => { console.log(result); }
+ );
+```

package/docs/api/api/classes/HighLighterEffect.md

@@ -93,6 +93,8 @@ low
 
 #### Example
 
+**给图层组为cameraGroup，下面编号为  camera01，camera02的模型对象添加高亮效果**
+
 ```
  dtcEngine.HighlighterEffect.setHighLightModel({parentId:'test',ids: ["Sphere", "Sphere1"]} ,result =>console.log(result));
 ```
@@ -132,6 +134,8 @@ low
 
 #### Example
 
+**清除图层组为cameraGroup，下面编号为  camera01，camera02的模型对象的高亮效果**
+
 ```
  dtcEngine.HighlighterEffect.removeHighLightModel({parentId:'test',ids: ["Sphere", "Sphere1"] },result=>console.log(result));
 ```
@@ -168,6 +172,8 @@ low
 
 #### Example
 
+**移除场景模型  高亮效果**
+
 ```
    dtcEngine.HighlighterEffect.clear(result=>console.log(result));
 ```

package/docs/api/api/classes/Layer.md

@@ -10,7 +10,7 @@
 
 ## Agent Capabilities
 
-图层添加, 图层删除, 图层存在性查询, 模型图层切换, 图层气泡显隐, 图层模型添加, 图层模型删除, 图层子对象查询
+图层添加, 图层删除, 图层存在性查询, 模型图层切换, 图层气泡显隐, 图层模型添加, 图层模型删除, 图层子对象查询, POI名称更新, POI名称重置
 
 ## Extends
 
@@ -361,6 +361,108 @@ low
 
 ***
 
+### updatePOIName()
+
+> **updatePOIName**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+更新 POI 气泡的显示文本。
+默认值：`updateType='update'`。`updateType` 支持 `update` 更新、`append` 追加、`remove` 移除。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`LayerUpdatePOINameRequest`](../../types/interfaces/LayerUpdatePOINameRequest.md) | POI 文本更新参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+示例1： 追加文本
+ dtcEngine.Layer.updatePOIName(
+   { parentId: 'CameraLayerModel', id: 'camera01', name: '一体化球击摄像机', updateType: "append" },
+   (result) => { console.log(result); }
+ );
+
+示例2： 移除文本
+ dtcEngine.Layer.updatePOIName(
+   { parentId: 'CameraLayerModel', id: 'camera01', name: '一体化球击摄像机', updateType: "remove" },
+   (result) => { console.log(result); }
+ );
+ * 示例3： 更新文本
+ dtcEngine.Layer.updatePOIName(
+   { parentId: 'CameraLayerModel', id: 'camera01', name: '一体化球击摄像机', updateType: "update" },
+   (result) => { console.log(result); }
+ );
+```
+
+***
+
+### resetPOIName()
+
+> **resetPOIName**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+重置 POI 气泡的显示文本。
+`ids` 为 POI 对象编号集合，至少一个。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`LayerResetPOINameRequest`](../../types/interfaces/LayerResetPOINameRequest.md) | POI 文本重置参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Layer.resetPOIName(
+   { parentId: 'CameraLayerModel', ids: ['camera01', 'camera02'] },
+   (result) => { console.log(result); }
+ );
+```
+
+***
+
 ### removeModel()
 
 > **removeModel**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>

package/docs/api/api/classes/Model.md

@@ -108,6 +108,64 @@ low
 
 ***
 
+### setVisibleByAttibute()
+
+> **setVisibleByAttibute**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+按对象属性过滤设置模型对象显隐状态。
+默认值：`filterMode=FilterMode.Loose`、`visible=true`、`otherVisible=false`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelSetVisibleByAttributeRequest`](../../types/interfaces/ModelSetVisibleByAttributeRequest.md) | 属性过滤显隐参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Examples
+
+**宽松过滤 Loose：只影响属性匹配 floor='B2' 的对象，其它对象不受影响**
+
+```ts
+// 隐藏 floor='B2' 的对象
+dtcEngine.Model.setVisibleByAttibute({ attributes: { floor: 'B2' }, filterMode: dtcEngine.Enums.FilterMode.Loose, visible: false }, (result) => { console.log(result); });
+// 显示 floor='B2' 的对象
+dtcEngine.Model.setVisibleByAttibute({ attributes: { floor: 'B2' }, filterMode: dtcEngine.Enums.FilterMode.Loose, visible: true }, (result) => { console.log(result); });
+```
+
+**严格过滤 Strict：floor='B1' 的对象按 visible 控制，其它楼层对象按 otherVisible 控制**
+
+```ts
+// 隐藏 floor='B1' 的对象，其它楼层对象也隐藏
+dtcEngine.Model.setVisibleByAttibute({ attributes: { floor: 'B1' }, filterMode: dtcEngine.Enums.FilterMode.Strict, visible: false, otherVisible: false }, (result) => { console.log(result); });
+// 隐藏 floor='B1' 的对象，其它楼层对象显示
+dtcEngine.Model.setVisibleByAttibute({ attributes: { floor: 'B1' }, filterMode: dtcEngine.Enums.FilterMode.Strict, visible: false, otherVisible: true }, (result) => { console.log(result); });
+// 显示 floor='B1' 的对象，其它楼层对象隐藏
+dtcEngine.Model.setVisibleByAttibute({ attributes: { floor: 'B1' }, filterMode: dtcEngine.Enums.FilterMode.Strict, visible: true, otherVisible: false }, (result) => { console.log(result); });
+```
+
+***
+
 ### getElementTree()
 
 > **getElementTree**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>