DTS二次开发文档

Class: Plot

Plot

军事态势标绘对象，提供绘制作战态势图标的相关操作
一般通过api.plot调用其方法

<protected> new Plot()

See:
  • DigitalTwinAPI#plot调用其方法

Extends

Methods

add(data, fn)

添加一个Plot对象

Parameters:
Name Type Description
data object | array

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

  • id (string) Plot对象唯一标识符ID

  • groupId (string) 可选，Group分组

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

  • style (PlotStyle) 军事态势标绘的图形类型，取值范围：[0~15]，详情参考 PlotStyle

  • range (array) 可视范围: [近裁距离, 远裁距离]，取值范围: [任意负值, 任意正值]

  • coordinates (array) 标绘区域包含锚点对应的坐标点数组，取值示例

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

  • lineColor (Color) 边框线的颜色，默认值：白色，支持四种格式，取值示例

  • fillColor (Color) 填充区域颜色，默认值：红色，支持四种格式，取值示例

  • thickness (number) 线宽，默认值：3px，单位：像素，注意：仅部分样式下生效

  • onTerrain (boolean) 可选，绘制后是否贴地，默认值：true

  • depthTest (boolean) 可选，是否做深度检测，默认值：true，true会被遮挡，false不会被遮挡
fn function

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

clear(fn)

删除场景中所有的Plot

Parameters:
Name Type Description
fn function

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

delete(ids, fn)

删除一个或多个Plot对象

Parameters:
Name Type Description
ids string | array

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

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

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

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

Parameters:
Name Type Description
ids string | array

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

Parameters:
Name Type Description
ids string | array

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

可选的回调函数，请参考二次开发：异步接口调用方式
Example
Plot的详细信息
[{
            "id":	"ea1",
            "groupId":	"",
            "userData":	"",
            "filePath":	"D:\\test.ply",
            "customObjectId":	"test1,
            "pointSize":	0.01
        }]

hide(ids, fn)

隐藏Plot对象

Parameters:
Name Type Description
ids string | array

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

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

hideAll(fn)

隐藏所有Plot对象

Parameters:
Name Type Description
fn function

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

show(ids, fn)

显示Plot对象

Parameters:
Name Type Description
ids string | array

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

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

showAll(fn)

显示所有Plot对象

Parameters:
Name Type Description
fn function

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

update(data, fn)

修改一个Plot对象

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: