DTS二次开发文档

Class: HydrodynamicModel2

HydrodynamicModel2

二维水动力模型对象，基于真实数据驱动生成水动力模型（过时版本待移除，推荐使用HydrodynamicModel对象）
一般通过api.HydrodynamicModel2调用其方法

<protected> new HydrodynamicModel2()

Deprecated:
  • 过时版本待移除对象
See:
  • DigitalTwinAPI#HydrodynamicModel2

Methods

add(data, fn)

添加一个或多个HydrodynamicModel2二维水动力模型对象

Parameters:
Name Type Description
data object | array

构造二维水动力模型对象HydrodynamicModel2的数据对象，可以是Object类型或者Array类型，对于每一个HydrodynamicModel2对象，支持以下属性：

  • id (string) HydrodynamicModel2对象ID

  • groupId (string) 可选，Group分组

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

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

  • coordinate (array) 二维水动力模型坐标位置：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]，设置bbox后参数失效

  • rotation (array) 二维水动力模型旋转方向：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]

  • jsonFilePath (string) 必选，二维水动力模型Json数据文件路径

  • displayMode (number) 二维水动力模型有2种显示模式

  • time (number) 二维水动力模型的当前播放时刻

  • playTimes (number) 二维水动力模型播放速度（倍率）

  • valueRange (array) 二维水动力模型颜色插值对应的数值区间

  • colors (object) 二维水动力模型自定义调色板对象，包含颜色渐变控制、无效像素颜色和调色板区间数组

    gradient (boolean) 是否渐变

    invalidColor (Color) 无效像素点的默认颜色，默认白色

    colorStops (array) 调色板对象数组，每一个对象包含热力值和对应颜色值，结构示例：[{"value":0, "color":[0,0,1,1]}]，每一个调色板对象支持以下属性：


    color (Color) 值对应的调色板颜色

    value (number) 值
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
请求数据结构示例 
        [{
            "id": "h1",
            "jsonFilePath": "F:/UnrealProjects/water/out/writeFile.json",
            "coordinate": [
                12984831,
                4800354.5,
                0
            ],
            "rotation": [
                0,
                0,
                0
            ],
            "displayMode": 0,
            "valueRange": [
                0,
                3
            ],
            "time": 1,
            "playTimes": 1,
            "colors":{
                        "gradient":true,
                        "invalidColor": [0,0,0,1],
                        "colorStops":[
                            {
                                "value":0,
                                "color":[0,0,1,1]
                            },
                            {
                                "value":0.25,
                                "color":[0,1,1,1]
                            },
                            {
                                "value":0.5,
                                "color":[0,1,0,1]
                            },
                            {
                                "value":0.75,
                                "color":[1,1,0,1]
                            },
                            {
                                "value":1,
                                "color":[1,0,0,1]
                            }
                        ]
                    }
        }]

clear(fn)

清空场景中所有的HydrodynamicModel2对象

Parameters:
Name Type Description
fn function

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

delete(ids, fn)

删除一个或多个HydrodynamicModel2对象

Parameters:
Name Type Description
ids string | array

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

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

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

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

Parameters:
Name Type Description
ids string | array

HydrodynamicModel2对象的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获取HydrodynamicModel2对象的详细信息

Parameters:
Name Type Description
ids string | array

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

可选的回调函数，请参考二次开发：异步接口调用方式
Example
HydrodynamicModel2的详细信息
[{
            "id": "h1",
            "jsonFilePath": "F:/UnrealProjects/water/out/writeFile.json",
            "coordinate": [
                12984831,
                4800354.5,
                0
            ],
            "rotation": [
                0,
                0,
                0
            ],
            "displayMode": 0,
            "valueRange": [
                0,
                3
            ],
            "time": 1,
            "playTimes": 1,
            "colors":{
                        "gradient":true,
                        "invalidColor": [0,0,0,1],
                        "colorStops":[
                            {
                                "value":0,
                                "color":[0,0,1,1]
                            },
                            {
                                "value":0.25,
                                "color":[0,1,1,1]
                            },
                            {
                                "value":0.5,
                                "color":[0,1,0,1]
                            },
                            {
                                "value":0.75,
                                "color":[1,1,0,1]
                            },
                            {
                                "value":1,
                                "color":[1,0,0,1]
                            }
                        ]
                    }
        }]

hide(ids, fn)

隐藏HydrodynamicModel2对象

Parameters:
Name Type Description
ids string | array

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

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

pause(data, fn)

暂停播放

Parameters:
Name Type Description
data object | array

水动力模型对象ID或ID数组
fn function

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

resume(data, fn)

恢复播放

Parameters:
Name Type Description
data object | array

水动力模型对象ID或ID数组
fn function

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

setTime(data, fn)

设置HydrodynamicModel2对象的当前播放时刻

Parameters:
Name Type Description
data object | array

水动力模型控制对象或数组

id (string) HydrodynamicModel2对象的唯一标识符ID

displayMode (number) HydrodynamicModel2对象的显示模式

time (number) 播放的时刻
fn function

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

show(ids, fn)

显示HydrodynamicModel2对象

Parameters:
Name Type Description
ids string | array

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

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

startPlay(data, fn)

开始从某时刻播放

Parameters:
Name Type Description
data object | array

水动力模型控制对象或数组

id (string) HydrodynamicModel2对象的唯一标识符ID

displayMode (number) HydrodynamicModel2对象的显示模式

time (number) 开始播放的时刻
fn function

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

stopPlay(data, fn)

停止播放

Parameters:
Name Type Description
data object | array

水动力模型对象ID或ID数组
fn function

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

update(data, fn)

修改一个或多个HydrodynamicModel2对象

Parameters:
Name Type Description
data object | array

构造二维水动力模型对象HydrodynamicModel2的数据对象，参考add方法
fn function

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