DTS二次开发文档

Class: Antenna

Antenna

天线方向图对象，提供Antenna对象的操作方法
一般通过api.antenna调用

new Antenna()

See:

Extends

Methods

add(data, fn)

添加一个或多个天线方向图对象

Parameters:
Name Type Description
data object | array

天线方向图包含的数据对象，可以是Object类型或者Array类型，对于每一个Antenna对象，支持以下属性：

  • id (string) 天线方向图的唯一标识符ID

  • groupId (string) 可选，Group分组

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

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

  • coordinate (array) 位置坐标：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]

  • rotation (array) 坐标系旋转：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]

  • radius (number) 天线方向图半径

  • radiationRange (array) 可选，辐射取值范围

  • radiationOffset (array) 溢出位置偏移，[X,Y]

  • grid (object) 网格对象，包含以下属性

    values (array) 网格热力值数组，二维数组，注意两个数组元素的长度相乘应该等于信号增益（gain）的长度，取值示例：[[val1,val2],[val3,val4,val5]] 即gain.length = 2*3

  • colors (object) 配色卡信息，包含以下属性

    gradient (boolean) 颜色是否渐变

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

    colorStops (array) 色卡数组，包含热力值和对应颜色值，结构示例：[{"value":0, "color":[0,0,1,1]}]

fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
请求代码示例

{
            "id": "radiationPattern",
            "coordinate": [
                494479.71875,
                2491462.25,
                2.11
            ],
            "rotation": [
                0,
                0,
                0
            ],
            "radius": 5,
            "radiationRange": [
                0,
                100
            ],
            "radiationOffset": [
                -5,
                5
            ],
            "grid": {
                "values": [
                    1,
                    2,
                    3,
                    4,
                    5,
                    6
                ]
            },
            "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)

清空场景中所有的天线方向图对象

Parameters:
Name Type Description
fn function

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

delete(ids, fn)

删除一个或多个天线方向图对象

Parameters:
Name Type Description
ids string | array

要删除的天线方向图对象ID或者ID数组（可以删除一个或者多个）
fn function

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

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

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

Parameters:
Name Type Description
ids string | array

天线方向图对象的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获取天线方向图的详细信息

Parameters:
Name Type Description
ids string | array

要获取的天线方向图对象ID或者ID数组（可以获取一个或者多个）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
返回天线方向图的详细信息 属性详情参见add方法参数
{
            "id":	"Antenna_1",
            "groupId":	"",
            "userData":	"",
            "coordinateType": 0,
            "coordinate":	[1000,1000,1000],
            "radius": 100,
            "radiationRange": [1, 300],
            "radiationOffset": [-5,5]
            ...
        }

hide(ids, fn)

隐藏天线方向图

Parameters:
Name Type Description
ids string | array

天线方向图对象的ID或者ID数组
fn function

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

show(ids, fn)

显示天线方向图

Parameters:
Name Type Description
ids string | array

天线方向图对象的ID或者ID数组
fn function

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

update(data, fn)

修改一个或多个天线方向图对象

Parameters:
Name Type Description
data data | 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: