DTS二次开发文档

Class: InfoTree

InfoTree

Layers, 图层树相关的操作
一般通过api.infoTree调用其方法

<protected> new InfoTree()

See:

Methods

callBPFunction(data, fn)

调用图层树上对象包含的多个蓝图函数，注意：可以根据图层树上的对象id查询包含的所有蓝图函数 fdapi.misc.getBPFunction(id);

Parameters:
Name Type Description
data object | array

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

  • id (string) 图层树上对象的ID

  • functionName (string) 蓝图函数名

  • parameters (array) 蓝图函数包含的多个参数，可选参数，数组类型，注意：传入多参数的顺序与类型务必与蓝图函数的参数顺序及其参数类型一致以保证执行结果符合预期。多个参数结构示例：[{"paramType":BPFuncParamType.String,"paramValue":"示例值"},{"paramType":BPFuncParamType.Bool,"paramValue":false},{"paramType":BPFuncParamType.Float,"paramValue":100.8}]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
蓝图函数调用示例代码 注意：被调用函数传入的参数类型、参数顺序都必须和蓝图函数的参数类型、顺序完全保持一致！
     fdapi.infoTree.callBPFunction([
            {
                id: '2BC267114D436EA43BF695AC98DA4E08',
                functionName: '颜色',
                parameters: [
                    { "paramType": 16, "paramValue": "红色" }
                ]
            },
            {
                id: '2BC267114D436EA43BF695AC98DA4E08',
                functionName: '状态',
                parameters: [
                    { "paramType": 5, "paramValue": "载货" }
                ]
            }
        ]);

deleteByGroupId(groupId, fn)

通过GroupId删除各类API创建的对象

Parameters:
Name Type Description
groupId string

创建对象时指定的groupId
fn function

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

disableXRay(ids, fn)

禁用X光

Parameters:
Name Type Description
ids string | array

待禁用X光的图层ID（支持单个ID或ID数组）
fn function

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

enableXRay(ids, color, fn)

启用X光

Parameters:
Name Type Description
ids string | array

待启用X光的图层ID（支持单个ID或ID数组）
color Color

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

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

focus(ids, fn)

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

Parameters:
Name Type Description
ids string | array

图层树对象的ID或者ID数组
fn function

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

get(fn)

获取图层树信息

Parameters:
Name Type Description
fn function

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

图层树数据结构

[{
		"iD":	"ProjectTree_Root",
		"index":	0,
		"parentIndex":	-1,
		"name":	"世界",
		"visiblity":	true,
		"type":	"EPT_Folder"
}]

图层返回type字段说明：

  文件夹：EPT_Folder
  场景：EPT_Scene
  场景模型：EPT_ModelActor
  测量：EPT_Measurement
  剖切体：EPT_Cut
  动态水：EPT_DynamicWater
  车辆：EPT_Vehicle
  标签：EPT_Tag
  灯光：EPT_Light
  贴花：EPT_Decal
  光流：EPT_LightBeam
  辐射圈：EPT_RadiationPoint
  面：EPT_Surface
  点Shape：EPT_ShpPoint
  折线Shape：EPT_ShpPolyline
  多边形Shape：EPT_ShpPolygon
  折线：EPT_Polyline
  视频投影：EPT_VideoProjector
  全景图：EPT_Panoramic
  压平：EPT_FlattenModifier
  Cesium3DTileset：EPT_Cesium
  挖洞：EPT_CutPolygonModifier
  动态标记：EPT_EffectPoint
  S3M Layer：EPT_S3MLayer
  粒子：EPT_ParticleActor
  角色：EPT_RoleActor

getBPFunction(ids, fn)

根据图层树对象ID查询其包含的蓝图函数信息，注意：支持批量查询

Parameters:
Name Type Description
ids string | array

图层树上对象的ID或者ID数组
fn function

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

hide(ids, fn)

隐藏图层

Parameters:
Name Type Description
ids string | array

要隐藏的图层ID（支持单个ID或ID数组）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
fdapi.infoTree.hide(['6C0888EC46B4C3D68635BF9E98628819', 'B0D8D4AF42F9EFB9BA4B258F3A9BC410']);

hideByGroupId(groupId, fn)

通过GroupId隐藏各类API创建的对象

Parameters:
Name Type Description
groupId string

创建对象时指定的groupId
fn function

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

highlightByGroupId(groupId, fn)

通过GroupId高亮各类API创建的对象

Parameters:
Name Type Description
groupId string

创建对象时指定的groupId
fn function

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

setVisibility(data, fn)

设置图层的可见性

Parameters:
Name Type Description
data object | array

图层可见性对象或数组，每个对象有以下属性：

  • id (string) 图层id
  • visible (boolean) 可见性
fn function

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

show(ids, fn)

显示图层

Parameters:
Name Type Description
ids string | array

要显示的图层ID（支持单个ID或ID数组）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
fdapi.infoTree.show(['6C0888EC46B4C3D68635BF9E98628819', 'B0D8D4AF42F9EFB9BA4B258F3A9BC410']);

showByGroupId(groupId, fn)

通过GroupId显示各类API创建的对象

Parameters:
Name Type Description
groupId string

创建对象时指定的groupId
fn function

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