DTS二次开发文档

Class: SignalWave

SignalWave

信号波束SignalWave对象相关的操作
一般通过api.signalWave调用其方法

<protected> new SignalWave()

See:

Extends

Methods

add(data, fn)

添加一个或多个SignalWave波束对象

Parameters:
Name Type Description
data object | array

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

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

  • groupId (string) 可选，Group分组

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

  • alpha (number) 波束的透明度，取值范围：[0~1]

  • range (array) 距离波束发射点A的衰减范围，[min,max]，在min和max之间显示透明度渐变，大于max则波束消失。

  • valA (array) 构造波束的位置坐标A: [x, y, z]，取值示例

  • valB (array) 构造波束的位置坐标B: [x, y, z]，取值示例

  • valC (array) 构造波束的位置坐标C: [x, y, z]，取值示例

  • valD (array) 构造波束的位置坐标D: [x, y, z]，取值示例

  • valE (array) 构造波束的位置坐标E: [x, y, z]，取值示例

  • valF (array) 构造波束的位置坐标F: [x, y, z]，取值示例

  • valG (array) 构造波束的位置坐标G: [x, y, z]，取值示例
fn function

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

clear(fn)

删除场景中所有的SignalWave

Parameters:
Name Type Description
fn function

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

delete(ids, fn)

删除一个或多个SignalWave对象

Parameters:
Name Type Description
ids string | array

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

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

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

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

Parameters:
Name Type Description
ids string | array

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

Parameters:
Name Type Description
ids string | array

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

可选的回调函数，请参考二次开发：异步接口调用方式
Example
结构示例
[
        {
            "id": "signalWave",
            "groupId": "group1",
            "userData": "波束",
            "valA": [
                -20,
                0,
                0
            ],
            "valB": [
                0,
                -10,
                0
            ],
            "valC": [
                0,
                0,
                0
            ],
            "valD": [
                0,
                10,
                0
            ],
            "valE": [
                -10,
                0,
                0
            ],
            "valF": [
                100,
                0,
                0
            ],
            "valG": [
                -20,
                0,
                30
            ]
        }
    ]

hide(ids, fn)

隐藏SignalWave

Parameters:
Name Type Description
ids string | array

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

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

show(ids, fn)

显示SignalWave

Parameters:
Name Type Description
ids string | array

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

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

update(data, fn)

修改一个或多个SignalWave对象

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: