DTS二次开发文档

Class: FloodFill

FloodFill

FloodFill 水淹分析相关的操作
一般通过api.floodFill调用其方法

new FloodFill()

protected

See:

Extends

Methods

add(data, fn)

添加一个或多个FloodFill对象，

Parameters:
Name Type Description
data object | array

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

  • id (string) 字符串类型的ID

  • groupId (string) 可选，Group分组

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

  • min (array) 水淹分析范围Min：[x,y]，数组元素取值：[任意数值]

  • max (array) 水淹分析范围Max：[x,y]，数组元素取值：[任意数值]

  • seed (array) 出水点，水淹分析范围[min~max]内的任意[x,y]，数组元素取值：[任意数值] 注意：出水点必须在水淹分析范围内，且不能被物体遮挡，否则会无效

  • elevation (number) 水位高度，取值范围：[任意正数]，单位：米

  • color (Color) 水颜色，支持四种格式，取值示例

  • precision (number) 水淹模拟精度，取值范围：[0~1] 精度越高效率会降低
fn function

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

clear(fn)

删除场景中所有的FloodFill

Parameters:
Name Type Description
fn function

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

delete(ids, fn)

删除一个或多个FloodFill对象

Parameters:
Name Type Description
ids string | array

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

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

focus(ids, distance, flyTime, rotation, fn)

自动定位到合适的观察距离

Parameters:
Name Type Description
ids string | array

FloodFill对象的ID或者ID数组
distance number

可选参数，观察点距离目标点（被拍摄物体）的距离，取值范围：[0.01~任意正数]，如果设置为0或者不设置，系统自动计算
flyTime number

可选参数，相机飞行的时间，取值范围：[0~任意正数]，单位：秒，默认值2秒
rotation array

可选参数，相机旋转的欧拉角：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：Pitch[-90~90] Yaw[-180~180] Roll[0]
fn function

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

get(ids, fn)

根据ID获取FloodFill的详细信息

Parameters:
Name Type Description
ids string | array

要获取的FloodFill对象ID或者ID数组（可以获取一个或者多个）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
FloodFill的详细信息
{
        "id": "fd1",
        "min": [495119.875, 2491031.25],//水淹分析范围min
        "max": [495386.625, 2491245.5],//水淹分析范围max
        "seed": [495304.9, 2491041],//出水点 注意：出水点[x,y]一定要在水淹分析范围[min~max]内，否则接口会报错
        "elevation": 3.5,//水位高度
        "color": [0,1,0,1],//水颜色
        "precision": 0.5 //水淹模拟精度
        }

hide(ids, fn)

隐藏FloodFill

Parameters:
Name Type Description
ids string | array

FloodFill对象的ID或者ID数组
fn function

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

hideAll(fn)

隐藏所有FloodFill

Parameters:
Name Type Description
fn function

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

setColor(id, newVal, fn)

设置水颜色

Parameters:
Name Type Description
id string

字符串类型的ID
newVal Color

新颜色值，支持四种格式，取值示例
fn function

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

setElevation(id, newVal, fn)

设置水位高度

Parameters:
Name Type Description
id string

字符串类型的ID
newVal number

新值
fn function

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

setPrecision(id, newVal, fn)

设置水淹模拟精度

Parameters:
Name Type Description
id string

字符串类型的ID
newVal number

新值
fn function

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

setRange(id, minArr, maxArr, fn)

设置水淹分析范围 注意：出水点[x,y]一定要在新设置的水淹分析范围[min~max]内

Parameters:
Name Type Description
id string

水淹分析范围唯一标识，字符串类型的ID
minArr array

水淹分析范围Min：[x,y]，数组元素取值：[任意数值]
maxArr array

水淹分析范围Max：[x,y]，数组元素取值：[任意数值]
fn function

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

setSeed(id, newVal, fn)

设置出水点

Parameters:
Name Type Description
id string

字符串类型的ID
newVal array

新值
fn function

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

show(ids, fn)

显示FloodFill

Parameters:
Name Type Description
ids string | array

FloodFill对象的ID或者ID数组
fn function

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

showAll(fn)

显示所有FloodFill

Parameters:
Name Type Description
fn function

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

update(data, fn)

修改一个或多个FloodFill对象

Parameters:
Name Type Description
data object | array

数据结构，请参考add方法
fn function

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

updateBegin()

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

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

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

updateEnd(fn)

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

Parameters:
Name Type Description
fn function

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