DTS二次开发文档

Class: DynamicWater

DynamicWater

DynamicWater类，提供动态水面相关的操作
一般通过api.dynamicWater调用其方法

<protected> new DynamicWater()

Extends

Methods

add(data, fn)

添加一个或多个DynamicWater对象

Parameters:
Name Type Description
data object | array

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

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

  • groupId (string) 可选，Group分组

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

  • coordinates (array) 坐标数组，取值示例

  • style (number) 动态水的样式，取值：0（深蓝）、1（蓝）、2（湖水）
fn function

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

clear(fn)

删除场景中所有的DynamicWater

Parameters:
Name Type Description
fn function

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

delete(ids, fn)

删除一个或多个DynamicWater对象

Parameters:
Name Type Description
ids string | array

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

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

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

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

Parameters:
Name Type Description
ids string | array

DynamicWater对象的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

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

focusAll(distance, flyTime, rotation, fn)

自动定位到能观察所有DynamicWater对象的合适距离

Parameters:
Name Type Description
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获取DynamicWater的详细信息

Parameters:
Name Type Description
ids string | array

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

可选的回调函数，请参考二次开发：异步接口调用方式
Example
DynamicWater的详细信息
[{
            "id":	"dy1",
            "groupId":	"",
            "userData":	"",
            "style":	0
        }]

setCoordinates(id, newVal, fn)

设置DynamicWater的坐标信息

Parameters:
Name Type Description
id string

DynamicWater对象ID
newVal array

坐标数组，取值示例
fn function

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

setStyle(id, newVal, fn)

设置动态水的样式

Parameters:
Name Type Description
id string

DynamicWater对象ID
newVal number

动态水的样式，取值：0（深蓝）、1（蓝）、2（湖水）
fn function

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

update(data, fn)

修改一个或多个DynamicWater对象

Parameters:
Name Type Description
data object | array

数据结构，请参考add方法
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: