DTS二次开发文档

Class: RadiationPoint

RadiationPoint

RadiationPoint类，提供辐射圈相关的操作
一般通过api.radiationPoint调用其方法

<protected> new RadiationPoint()

See:

Extends

Methods

add(data, fn)

添加一个或多个RadiationPoint对象

Parameters:
Name Type Description
data object | array

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

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

  • groupId (string) 可选，Group分组id

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

  • coordinate (array) 坐标点，取值示例

  • radius (number) 辐射圈的半径，取值范围：[0~500000]，单位：米

  • rippleNumber (number) 波纹数量，取值范围：[0~5]，单位：个

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

  • intensity (number) 亮度，取值范围：[0~1.0]

  • autoHeight (boolean) 自动判断下方是否有物体，设置正确高度，默认值：false
fn function

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

clear(fn)

删除场景中所有的RadiationPoint

Parameters:
Name Type Description
fn function

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

delete(ids, fn)

删除一个或多个RadiationPoint对象

Parameters:
Name Type Description
ids string | array

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

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

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

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

Parameters:
Name Type Description
ids string | array

RadiationPoint对象的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)

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

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获取RadiationPoint的详细信息

Parameters:
Name Type Description
ids string | array

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

可选的回调函数，请参考二次开发：异步接口调用方式
Example
RadiationPoint的详细信息
{
            "id":	"1",
            "groupId":	"",
            "userData":	"",
            "coordinate":	[62.838749, 0.080000, 0.400000],
            "rippleNumber":	5.000000,
            "radius":	300.000000,
            "color":	[1.000000, 0.000000, 1.000000],
            "brightness":	0.800000,
            "autoHeight":	0
        }

hide(ids, fn)

隐藏RadiationPoint

Parameters:
Name Type Description
ids string | array

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

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

hideAll(fn)

隐藏所有RadiationPoint

Parameters:
Name Type Description
fn function

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

setAutoHeight(id, newVal, fn)

设置AutoHeight 自动判断下方是否有物体，设置正确高度

Parameters:
Name Type Description
id string

RadiationPoint对象的ID
newVal boolean

自动判断下方是否有物体，设置正确高度 true/false
fn function

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

setBrightness(id, newVal, fn)

设置新的亮度

Parameters:
Name Type Description
id string

RadiationPoint对象的ID
newVal number

新亮度值，取值范围：[0~1]
fn function

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

setColor(id, newVal, fn)

设置颜色

Parameters:
Name Type Description
id string

RadiationPoint对象的ID
newVal Color

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

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

setCoordinate(id, newVal, fn)

设置坐标

Parameters:
Name Type Description
id string

RadiationPoint对象的ID
newVal array

新的坐标值，取值示例
fn function

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

setRadius(id, newVal, fn)

设置半径

Parameters:
Name Type Description
id string

RadiationPoint对象的ID
newVal number

辐射圈新的半径，取值范围：[0~500000]，单位：米
fn function

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

setRippleNumber(id, newVal, fn)

设置波纹数量

Parameters:
Name Type Description
id string

RadiationPoint对象的ID
newVal number

新波纹数量，取值范围：[0~5]，单位：个
fn function

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

show(ids, fn)

显示RadiationPoint

Parameters:
Name Type Description
ids string | array

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

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

showAll(fn)

显示所有RadiationPoint

Parameters:
Name Type Description
fn function

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

update(data, fn)

修改一个或多个RadiationPoint对象

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: