Skip to content

Rockburst ​

SDK 7.0.0903.22571文档日期 2026-09-03API 导航

Rockburst

Rockburst相关的操作
一般通过api.rockburst调用其方法


<protected> new Rockburst()

See:
  • DigitalTwinAPI#Rockburst

Extends

Methods


add(data, fn)

添加一个或多个Rockburst对象

Parameters:
Name Type Description
data object | array

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

  • id (string) 岩爆对象唯一字符串ID

  • groupId (string) 可选,Group分组d

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

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

  • coordinate (array) 岩暴对象放置坐标位置 [x,y,z],坐标系由 coordinateType 决定

  • assetPath (string) 岩体模型资源路径(pak 内资源路径),注意:是资源引用的相对路径

  • rotation (array) 欧拉角旋转朝向:[Pitch,Yaw,Roll],数组元素类型:(number),取值范围:[任意数值]

  • scale (array) 模型缩放:[X,Y,Z],数组元素类型:(number),取值范围:[任意正整数]

fn function

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


burst(data, fn)

触发岩爆效果,在指定位置产生爆裂 / 岩块抛掷。作用于已创建的岩爆对象。

Parameters:
Name Type Description
data object | array

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

  • id (string) 目标岩爆对象 ID

  • coordinate (array) 岩爆中心(震源)坐标 [x,y,z]

  • damageRadius (number) 破坏半径,此半径内岩体发生破裂,单位:米,默认值:3米

  • impulseStrength (number) 冲击强度(冲量),值越大岩块抛掷越剧烈,默认值:1000

fn function

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


clear(fn)

清除场景中所有的Rockburst对象

Parameters:
Name Type Description
fn function

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


delete(ids, fn)

删除一个或多个Rockburst对象

Parameters:
Name Type Description
ids string | array

要删除的Rockburst对象的ID或者ID数组(可以删除一个或者多个)

fn function

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


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

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

Parameters:
Name Type Description
ids string | array

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

Parameters:
Name Type Description
ids string | array

要获取的Rockburst对象ID或者ID数组(可以获取一个或者多个)

fn function

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

Example
Rockburst对象的详细信息

hide(ids, fn)

隐藏指定的一组Rockburst对象

Parameters:
Name Type Description
ids string | array

Rockburst对象的ID或者ID数组

fn function

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


show(ids, fn)

显示指定的一组Rockburst对象

Parameters:
Name Type Description
ids string | array

Rockburst对象的ID或者ID数组

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: