DTS二次开发文档

Class: Vehicle2

Vehicle2

高级载具类，提供高级载具的相关的操作
一般通过api.Vehicle2调用其方法

<protected> new Vehicle2()

See:

Extends

Methods

add(data, fn)

添加一个或多个Vehicle2对象

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

Parameters:
Name Type Description
data object | array

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

  • id (string) Vehicle2对象的ID

  • groupId (string) 可选，Group分组

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

  • assetPath (string) 资源库车辆载具路径，类似CustomObject对象的assetPath，示例值：'/JC_CustomAssets/Vehicle2Library/Exhibition/SUV_01'

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

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

  • autoHeight (boolean) 可选，是否自动计算载具行驶高度，默认值：true，注意：当设置为false时会使用载具坐标的高度Z

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

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

  • color (Color) 可选，载具自定义涂装颜色，支持四种格式，取值示例

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

  • enableDecal (boolean) 可选，是否支持贴画贴合，默认值：true

  • visible (number) 可选，设置载具对象加载后是否显示，0：隐藏 1：显示 2：移动显示（先隐藏载具移动后显示） 3：调用显示（先隐藏载具调用moveTo后显示）

  • collision (boolean) 可选，是否开启模型碰撞，默认：false，注意：开启后会影响添加效率

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

    visible (boolean) 载具标牌是否可见

    offset (array) 载具标牌偏移

    text (string) 载具标牌显示的字符串
fn function

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

clear(fn)

清空场景中所有的Vehicle2对象

Parameters:
Name Type Description
fn function

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

delete(ids, fn)

删除一个或多个Vehicle2对象

Parameters:
Name Type Description
ids string | array

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

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

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

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

Parameters:
Name Type Description
ids string | array

Vehicle2对象的ID或者ID数组
distance number

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

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

可选参数，相机旋转的欧拉角：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：Pitch[-90~90] Yaw[-180~180] Roll[0]
offset array

可选参数，定位后载具视角的偏移量，单位：米，默认值：[0,0,0]
fn function

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

get(ids, fn)

根据ID查询Vehicle2对象的详细信息

Parameters:
Name Type Description
ids string | array

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

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

hide(ids, fn)

隐藏一个或多个Vehicle2对象

Parameters:
Name Type Description
ids string | array

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

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

moveTo(data, fn)

设置Vehicle2对象行驶到具体位置（根据实时获取的GPS数据运动）

Parameters:
Name Type Description
data object | array

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

  • id (string) Vehicle2对象的ID

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

  • heading (number) 可选，载具2转向角度，取值范围：[0,360]

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

  • time (number) 可选，载具2移动目标点对应的时间戳
fn function

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

[{"id": "vc1", "coordinate": [-1498, -2804,0], "heading":0, "time": 1, "astern": false}]

setFollow(ids, distance, flyTime, pitch, yaw, sensitivity, watchControl, offset, fn)

设置载具自动跟随相机

Parameters:
Name Type Description
ids string | array

Vehicle2对象的ID或者ID数组
distance number

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

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

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

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

可选参数，载具灵敏度，取值范围： [0~1]
watchControl boolean

可选参数，是否开启驾驶员的左右观察模式，默认：false
offset array

可选参数，跟随后载具视角的偏移量，单位：米，默认值：[0,0,0]
fn function

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

setViewportVisible(id, vp, fn)

多视口状态下，设置Vehicle2对象在各视口的可见性

Parameters:
Name Type Description
id string

Vehicle2对象的ID
vp Viewport

视口掩码（Viewport位运算）
fn function

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

show(ids, fn)

显示一个或多个Vehicle2对象

Parameters:
Name Type Description
ids string | array

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

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

update(data, fn)

修改一个或多个Vehicle2对象

Parameters:
Name Type Description
data object | array

Vehicle2对象或者数组，以下属性支持更新

  • id (string) 根据Vehicle2对象的ID更新载具属性

  • autoHeight (boolean) 可选，是否自动计算载具行驶高度，默认值：true，注意：当设置为false时会使用载具坐标的高度Z

  • color (Color) 可选，载具自定义涂装颜色，支持四种格式，取值示例

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

    visible (boolean) 载具标牌是否可见

    offset (array) 载具标牌偏移

    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: