DTS二次开发文档

Class: BoxTrigger

BoxTrigger

BoxTrigger类的对象，提供当CustomObject对象或相机Camera对象进入和退出盒子热区范围触发事件相关的操作
一般通过api.BoxTrigger调用其方法

<protected> new BoxTrigger()

See:
  • DigitalTwinAPI#BoxTrigger

Extends

Methods

add(data, fn)

添加一个或多个BoxTrigger对象，当CustomObject对象或相机Camera对象进入和退出盒子热区范围触发事件相关的操作

Parameters:
Name Type Description
data object | array

数据结构，支持对象或数组，对于每一个对象支持以下属性：

  • id (string) BoxTrigger对象的ID

  • groupId (string) 可选，Group分组

  • userData (string) 可选，用户自定义数据

  • coordinateType (number) 可选，坐标系类型，取值范围：0为Projection类型，1为WGS84类型，2为火星坐标系(GCJ02)，3为百度坐标系(BD09)，默认值：0

  • bbox (array) 绘制触发热区的包围盒范围，格式：[minX,minY,minZ,maxX,maxY,maxZ]，数组元素类型：[任意浮点数]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
以下为当CustomObject对象或者Camera相机对象进入或退出创建的盒子热区范围内触发返回的事件对象结构


CustomObject对象进入热区范围触发OnCustomObjectEnterTrigger事件
{
   "triggerId": "TriggerID",  //盒子热区范围对象id
   "eventtype": "OnCustomObjectEnterTrigger", //事件类型
   "objectId": "CustomObjectID" //自定义对象id
}

CustomObject对象退出热区范围触发OnCustomObjectExitTrigger事件
{
   "triggerId": "TriggerID",
   "eventtype": "OnCustomObjectExitTrigger",
   "objectId": "CustomObjectID"
} 


Camera进入热区范围触发OnCameraEnterTrigger事件
{
   "triggerId": "TriggerID",
   "eventtype": "OnCameraEnterTrigger",
}

Camera退出热区范围触发OnCameraExitTrigger事件
{
   "triggerId": "TriggerID",
   "eventtype": "OnCameraExitTrigger",
}

clear(fn)

清空场景中所有的BoxTrigger对象

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

delete(ids, fn)

删除一个或多个BoxTrigger对象，注意：删除对象后热区和对应触发事件均会删除

Parameters:
Name Type Description
ids string | array

要删除的BoxTrigger对象的ID或者ID数组（可以删除一个或者多个）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

updateBegin()

用于批量多次修改对象的属性

在开始修改之前调用updateBegin，然后可以多次调用setXXX方法，最后调用updateEnd提交修改更新数据
注意：
updateBegin不是异步调用，不需要await，也没有回调函数参数

Inherited From:
Overrides:
Example
fdapi.xxx.updateBegin();
for (let i = 0; i < 1000; i++) {
     fdapi.xxx.setColor(i, Color.Yellow);
} 
fdapi.xxx.updateEnd(function () {
     log('update finished!');
});

updateEnd(fn)

用于批量多次修改对象的属性，与updateBegin配套使用
注意：
updateEnd是异步调用，可以用回调函数也可以await

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Inherited From:
Overrides: