Class: Decal

Extends

• BaseObject

Methods

---

add(data, fn)

添加一个或多个Decal对象

Parameters:

Name	Type	Description
data	object | array	数据结构，支持对象或数组，对于每一个对象支持以下属性： id (string) 字符串类型的ID groupId (string) 可选，Group分组 userData (string) 可选，用户自定义数据 decalBlendMode (number) 贴花类型，取值范围：[0,1]；取值说明：0背景混合，1仅贴花；默认值：0 order (number) 层级 ：高层级会覆盖掉低层级，即值越大显示越靠上，取值范围：[任意正整数] texturePath (string) 贴图路径，资源引入说明 location (array) 位置坐标：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]，设置bbox后参数失效 rotation (array) 旋转：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值] scale (array) 缩放：[X,Y,Z]，数组元素类型：(number)，取值范围：[任意正整数]，设置bbox后参数失效 bbox (array) 可选，贴花覆盖的包围盒范围，数组格式：[minX,minY,minZ,maxX,maxY,maxZ]，数组元素：[任意浮点数]，注意：设置bbox参数后location、scale参数会失效，
fn	function	可选的回调函数，请参考二次开发：异步接口调用方式

---

clear(fn)

删除场景中所有的Decal

Parameters:

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

---

delete(ids, fn)

删除一个或多个Decal对象

Parameters:

Name	Type	Description
ids	string | array	要删除的Decal对象的ID或者ID数组（可以删除一个或者多个）
fn	function	可选的回调函数，请参考二次开发：异步接口调用方式

---

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

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

Parameters:

Name	Type	Description
ids	string | array	Decal对象的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	可选的回调函数，请参考二次开发：异步接口调用方式

---

focusAll(distance, flyTime, rotation, fn)

自动定位到能观察所有Decal对象的合适距离

Parameters:

Name	Type	Description
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获取Decal的详细信息

Parameters:

Name	Type	Description
ids	string | array	要获取的Decal对象ID或者ID数组（可以获取一个或者多个）
fn	function	可选的回调函数，请参考二次开发：异步接口调用方式

Example

Decal的详细信息
[{
            "id":	"d1",
            "groupId":	"",
            "userData":	"",
            "location":	[494219.312500, 2490657.000000, -0.001055],
            "rotation":	[-90.000000, -0.000005, -179.999969],
            "scale":	[1.000000, 1.000000, 1.000000],
            "texturePath":	"C:\\Users\\Administrator\\AppData\\Roaming\\Cloud\\SDK/media/image/decal1.png",
            "order":	1
        }]

---

update(data, fn)

修改一个或多个Decal对象

Parameters:

Name	Type	Description
data	object | array	数据结构，请参考add方法
fn	function	可选的回调函数，请参考二次开发：异步接口调用方式

---

updateBegin()

用于批量多次修改对象的属性

在开始修改之前调用updateBegin，然后可以多次调用setXXX方法，最后调用updateEnd提交修改更新数据
注意：
updateBegin不是异步调用，不需要await，也没有回调函数参数

Inherited From:

• BaseObject#updateBegin

Overrides:

• BaseObject#updateBegin

Example

__g.xxx.updateBegin();
for (let i = 0; i < 1000; i++) {
     __g.xxx.setColor(i, Color.Yellow);
} 
__g.xxx.updateEnd(function () {
     log('update finished!');
});

---

updateEnd(fn)

用于批量多次修改对象的属性，与updateBegin配套使用
注意：
updateEnd是异步调用，可以用回调函数也可以await

Parameters:

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

Inherited From:

• BaseObject#updateEnd

Overrides:

• BaseObject#updateEnd