DTS二次开发文档

Class: Satellite

Satellite

Satellite 卫星仿真对象相关的操作
一般通过api.satellite调用其方法，效果图如下：

new Satellite()

protected

See:

Extends

Methods

add(data, textRange, modelRange, imageVisibleDistance, fn)

添加一个或多个Satellite对象

Parameters:
Name Type Description
data object | array

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

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

  • text (string) 卫星标签显示的文字内容

  • assetPath (string) 蓝图Actor在UE工程的资源引用目录（相对路径），注意：模型必须是蓝图Actor类，即在使用UE打包pak文件时此自定义对象在UE工程内的相对路径

  • coordinate (array) 卫星的坐标位置

  • pointSize (number) 卫星像素点的像素尺寸，单位：像素

  • color (Color) 卫星像素点的显示颜色，支持四种格式，取值示例

  • imagePath (number) 可选，卫星缩略图的文件路径，注意：参数配置的各缩略图的分辨率大小必须相同，资源引入说明

  • imageSize (array) 可选，卫星的缩略图尺寸，宽高取值：[width, height]，默认使用图片尺寸

  • modelRotation (array) 可选，卫星的旋转姿态，世界坐标系旋转：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]，默认值：[0,0,0]
textRange array

卫星文字的可视范围: [近裁距离, 远裁距离]，取值范围: [任意负值, 任意正值]
modelRange array

卫星模型的可视范围: [近裁距离, 远裁距离]，取值范围: [任意负值, 任意正值]
imageVisibleDistance number

卫星缩略图的可见距离，取值范围: [0~200000000]
fn function

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

callBPFunction(data, fn)

调用卫星模型包含的多个蓝图函数，注意：调用前请使用getBPFunction()函数来查询当前卫星模型包含的蓝图函数参数信息

Parameters:
Name Type Description
data object | array

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

  • id (string) 卫星对象的ID

  • functionName (string) 蓝图函数名

  • parameters (array) 蓝图函数包含的多个参数，可选参数，数组类型，注意：传入多参数的顺序与类型务必与蓝图函数的参数顺序及其参数类型一致以保证执行结果符合预期。多个参数结构示例：[{"paramType":BPFuncParamType.String,"paramValue":"示例值"},{"paramType":BPFuncParamType.Bool,"paramValue":false},{"paramType":BPFuncParamType.Float,"paramValue":100.8}]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
蓝图函数调用示例代码 注意：被调用函数传入的参数类型、参数顺序都必须和蓝图函数的参数类型、顺序完全保持一致！
     fdapi.satellite.callBPFunction([
            {
                id: 'satellite_1',
                functionName: '打开太阳能电池板',
                parameters: [
                    { "paramType": 0, "paramValue": 1 }
                ]
            },
            {
                id: 'satellite_2',
                functionName: '关闭太阳能电池板',
                parameters: [
                    { "paramType": 0, "paramValue": 0 }
                ]
            }
        ]);

clear(fn)

删除场景中所有的Satellite

Parameters:
Name Type Description
fn function

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

deleteSatellite(ids, fn)

删除一个或多个卫星模型和其对应的文字标签

Parameters:
Name Type Description
ids string | array

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

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

focus(ids, distance, flyTime, pitch, yaw, sensitivity, offset, fn)

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

Parameters:
Name Type Description
ids string | array

卫星对象的ID或者ID数组
distance number

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

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

可选参数，相机旋转的Pitch，取值范围：[-90~90]
yaw 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

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

getBPFunction(ids, fn)

根据卫星模型ID查询其包含的蓝图函数信息，注意：支持批量查询

Parameters:
Name Type Description
ids string | array

卫星对象的ID或者ID数组
fn function

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

hideModel(ids, fn)

隐藏一个或多个卫星模型

Parameters:
Name Type Description
ids string | array

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

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

hideSatellite(ids, fn)

隐藏一个或多个卫星模型和其对应的文字标签

Parameters:
Name Type Description
ids string | array

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

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

hideText(ids, fn)

隐藏一个或多个卫星的文字标签

Parameters:
Name Type Description
ids string | array

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

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

setFollow(ids, distance, flyTime, pitch, yaw, fn)

设置卫星运动时自动跟随相机

Parameters:
Name Type Description
ids string | array

卫星对象的ID或者ID数组
distance number

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

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

可选参数，相机旋转的Pitch，取值范围：[-90~90]
yaw number

可选参数，相机旋转的Yaw，取值范围： [-180~180]
fn function

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

showModel(ids, fn)

显示一个或多个卫星模型

Parameters:
Name Type Description
ids string | array

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

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

showSatellite(ids, fn)

显示一个或多个卫星模型和其对应的文字标签

Parameters:
Name Type Description
ids string | array

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

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

showText(ids, fn)

显示一个或多个卫星的文字标签

Parameters:
Name Type Description
ids string | array

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

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

update(data, duration, fn)

修改一个或多个Satellite对象

Parameters:
Name Type Description
data object | array

数据结构，请参考add方法
duration number

更新持续时间
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: