DTS二次开发文档

Class: ExcavationAnalysis

ExcavationAnalysis

超欠挖分析类对象，提供超挖欠挖分析相关操作
一般通过api.excavationAnalysis调用其方法

<protected> new ExcavationAnalysis()

See:
  • DigitalTwinAPI#excavationAnalysis调用其方法

Extends

Methods

add(excavationAnalysis, fn)

添加一个ExcavationAnalysis对象

Parameters:
Name Type Description
excavationAnalysis object

对象数据结构，对象支持以下属性：

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

  • groupId (string) 可选，Group分组

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

  • filePath (string) ply文件路径，资源文件引入方式：*.ply，资源引入说明

  • objectId (string) 自定义对象模型的Id

  • pointSize (number) 点云尺寸，单位：米，默认值：0.01

  • colors (object) 三维热力图对象的自定义调色板对象，包含颜色渐变控制、无效像素颜色和调色板区间数组

    gradient (boolean) 是否渐变

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

    colorStops (array) 调色板对象数组，每一个对象包含热力值和对应颜色值，结构示例：[{"value":0, "color":[0,0,1,1]}]，每一个调色板对象支持以下属性：


    color (Color) 热力值对应的调色板颜色

    value (number) 热力值
fn function

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

clear(fn)

删除场景中所有的ExcavationAnalysis

Parameters:
Name Type Description
fn function

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

delete(ids, fn)

删除一个或多个ExcavationAnalysis对象

Parameters:
Name Type Description
ids string | array

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

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

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

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

Parameters:
Name Type Description
ids string | array

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

Parameters:
Name Type Description
ids string | array

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

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

hide(ids, fn)

隐藏ExcavationAnalysis对象

Parameters:
Name Type Description
ids string | array

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

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

show(ids, fn)

显示ExcavationAnalysis对象

Parameters:
Name Type Description
ids string | array

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

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

update(excavationAnalysis, fn)

修改一个ExcavationAnalysis对象

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