DTS二次开发文档

Class: Drone

Drone

Drone类，提供无人机对象相关的操作
一般通过api.Drone调用其方法

<protected> new Drone()

See:
  • DigitalTwinAPI#Drone

Extends

Methods

add(data, fn)

添加一个或多个无人机对象

路径参数assetPath获取方法如下动图：

Parameters:
Name Type Description
data object | array

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

  • id (string) 无人机对象的ID

  • groupId (string) 可选，Group分组

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

  • assetPath (string) 资源库无人机的路径，类似CustomObject对象的assetPath，示例值：'/AirCityPlugin/ArtResources/Drone/Drone'

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

  • coordinateType (number) 可选，坐标系类型，取值：0为Projection类型，1为WGS84类型，默认值：0

  • delay (number) 可选，控制无人机moveTo()接口移动的延迟时间，单位：秒，默认值：0.5，设置0则不延时立刻移动

  • rotation (array) 可选，无人机旋转，世界坐标系旋转：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]，默认值：[0,0,0]

  • localOffset (array) 可选，无人机基于原始位置坐标的偏移量，默认值：[0,0,0]

  • scale (array) 可选，无人机缩放：[X,Y,Z]，数组元素类型：(number)，取值范围：[任意正整数]

  • visible (boolean) 可选，设置无人机对象加载后是否显示，默认：true

  • trailType (DroneTrailStyle) 可选，轨迹线样式枚举，详情参考 DroneTrailStyle，默认值：0

  • trailThickness (number) 可选，像素线宽度，注意：仅设置像素线样式枚举时生效

  • trailColor (Color) 可选，轨迹线颜色，支持四种格式，取值示例

  • trailDuration (number) 可选，轨迹持续时间，单位：秒，默认值：3秒

  • lightColor (Color) 可选，无人机自发光灯颜色亮度，取值示例：[1, 0, 0, 10]，注意：alpha是无人机亮度，支持四种格式，取值示例

  • label (object) 可选，无人机的标牌对象，默认不显示，包含可配置的参数如下：

    visible (boolean) 无人机标牌是否可见，默认值：false

    offset (array) 无人机标牌偏移，默认值：[0, 0, 0]

    cullDistance (number) 无人机标牌剔除距离，相机距离无人机的观察距离大于此阈值则屏幕显示剔除。单位：米

    text (string) 无人机标牌显示的字符串
fn function

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

clear(fn)

清空场景中所有的无人机对象

Parameters:
Name Type Description
fn function

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

delete(ids, fn)

删除一个或多个无人机对象

Parameters:
Name Type Description
ids string | array

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

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

focus(ids, followEnable, distance, flyTime, viewPitch, viewYaw, sensitivity, offset, fn)

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

Parameters:
Name Type Description
ids string | array

无人机对象的ID或者ID数组
followEnable boolean

可选参数，是否开启相机自动跟随(开启后相机交互会被自动托管)，默认值：false
distance number

可选参数，观察点距离目标点（被拍摄物体）的距离，如果设置为负值则会在模型内部，可以用来模拟驾驶员视角
flyTime number

可选参数，相机飞行的时间，取值范围：[0~任意正数]，单位：秒，默认值2秒
viewPitch number

可选参数，观察欧拉角的Pitch，取值范围：[-90~90]
viewYaw number

可选参数，观察欧拉角的Yaw，取值范围： [-180~180]
sensitivity number

可选参数，无人机灵敏度，取值范围： [0~1]
offset array

可选参数，无人机视角的偏移量，单位：米，默认值：[0,0,0]
fn function

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

get(ids, fn)

根据ID获取无人机对象的详细信息

Parameters:
Name Type Description
ids string | array

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

可选的回调函数，请参考二次开发：异步接口调用方式
Example
CustomObject的详细信息
[{
            "id":"vc1",
            "groupId": "car_main_road",
            "userData": "car_info",
            "coordinateType":0,
            "coordinate":[-1499.8984375, -2804.5328125000001,1],
            "assetPath":"/JC_CustomAssets/DroneLibrary/Exhibition/Drone",
            "rotation":[0, -10, 0],
        }]

hide(ids, fn)

隐藏一个或多个无人机对象

Parameters:
Name Type Description
ids string | array

无人机对象的ID或者ID数组
fn function

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

moveTo(data, fn)

设置无人机对象飞行移动

Parameters:
Name Type Description
data object | array

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

  • id (string) 无人机对象的ID

  • coordinate (array) 无人机对象移动目标点坐标：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]

  • rotation (array) 可选，无人机的旋转角度：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]，默认值：[0,0,0]

  • astern (boolean) 可选，是否开启倒档，默认值：false

  • time (number) 可选，无人机对象移动目标点对应的时间戳
fn function

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

show(ids, fn)

显示一个或多个无人机对象

Parameters:
Name Type Description
ids string | array

无人机对象的ID或者ID数组
fn function

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

update(data, fn)

修改一个或多个无人机对象

Parameters:
Name Type Description
data object | array

无人机对象或者数组，以下属性支持更新

  • id (string) 根据无人机对象的ID更新无人机相关属性

  • trailType (number) (DroneTrailStyle) 可选，轨迹线样式枚举，详情参考 DroneTrailStyle，默认值：0

  • trailColor (Color) 可选，轨迹线颜色，支持四种格式，取值示例

  • trailDuration (number) 可选，轨迹持续时间，单位：秒，默认值：3

  • trailThickness (number) 可选，像素线宽度，注意：仅设置像素线样式枚举时生效

  • lightColor (Color) 可选，无人机自发光灯颜色亮度，取值示例：[1, 0, 0, 10]，注意：alpha是无人机亮度，支持四种格式，取值示例，默认：关闭

  • label (object) 可选，无人机的标牌对象，默认不显示，包含可配置的参数如下：

    visible (boolean) 无人机标牌是否可见，默认值：false

    offset (array) 无人机标牌偏移，默认值：[0, 0, 0]

    cullDistance (number) 无人机标牌剔除距离，相机距离无人机的观察距离大于此阈值则屏幕显示剔除。单位：米

    text (string) 无人机标牌显示的字符串
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: