DTS二次开发文档

Class: CustomMesh

CustomMesh

CustomMesh类
一般通过api.customMesh调用其方法

<protected> new CustomMesh()

See:

Methods

add(data, fn)

添加一个或多个CustomMesh对象

Parameters:
Name Type Description
data object | array

CustomMesh数据，可以是Object类型或者Array类型，对于每一个CustomMesh，支持以下属性：

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

  • groupId (string) 可选，Group分组

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

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

  • coordinates (array) 顶点坐标，取值示例

  • colors (array) 顶点颜色数组，数组长度要和coordinates一致。支持四种格式，取值示例

  • createCollision (boolean) 是否创建碰撞体，默认值：false

  • indices (array) 顶点坐标的索引，用来绘制三角网格；数组元素类型：(number)；数组元素顺序：顶点索引顺序需构成三角网格且同为顺时针或逆时针方向；数组元素取值范围：[0~coordinates.length-1]，取值示例：[2, 0, 3, 0, 2, 1]

  • color (Color) 颜色值，支持四种格式，取值示例

  • material (string) 可选参数，替换材质的文件路径，UE工程里材质文件对应资源的相对路径，用于控制材质的不透明度和颜色等效果

  • scalarParameters (array) 可选参数，替换材质包含的数值参数，一般用来控制材质不透明度，包含name/value键值对的数组，其中name是字符串，value为数值

  • vectorParameters (array) 可选参数，替换材质包含的数组参数，一般用来控制材质颜色，包含name/value键值对的数组，其中name是字符串，value为数组
fn function

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

clear(fn)

删除场景中所有的CustomMesh

Parameters:
Name Type Description
fn function

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

delete(ids, fn)

删除一个或多个CustomMesh对象

Parameters:
Name Type Description
ids string | array

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

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

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

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

Parameters:
Name Type Description
ids string | array

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

Parameters:
Name Type Description
ids string | array

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

可选的回调函数，请参考二次开发：异步接口调用方式
Example
CustomMesh的详细信息
{
            "id":	"sm1",
            "groupId":	"",
            "userData":	""
        }

hide(ids, fn)

隐藏CustomMesh

Parameters:
Name Type Description
ids string | array

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

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

setColor(id, newVal, fn)

设置颜色

Parameters:
Name Type Description
id string

唯一标识符
newVal Color

新颜色值，支持四种格式，取值示例
fn function

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

setCoordinates(id, newVal, fn)

设置顶点坐标

Parameters:
Name Type Description
id string

唯一标识符
newVal array

新的顶点坐标，取值示例
fn function

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

setIndices(id, newVal, fn)

设置顶点索引

Parameters:
Name Type Description
id string

唯一标识符
newVal array

新顶点坐标的索引，数组元素类型：(number)，数组元素取值范围：[0~coordinates.length-1]，取值示例：[2, 0, 3, 0, 2, 1]
fn function

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

show(ids, fn)

显示CustomMesh

Parameters:
Name Type Description
ids string | array

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

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

update(data, fn)

修改一个或多个CustomMesh对象

Parameters:
Name Type Description
data object | array

CustomMesh数据，参考add方法
fn function

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