流程示意图

提示

• 矩形为 BIM API 接口
• 菱形为 浏览器 标准事件
• 上传文件 参考文档
• 监听文件转换状态 参考文档

模型下载

把模型从转换机下载到场景底板

let jsonData = {
    "FileKey": "e1eeb4dd-0f63-4e2b-91ae-a391b82362d8",
    "FileName": "df22b628484c4592b2d799b6fd49da5e.zip",
    "ShowName": "house"
}

cloudRender.SuperAPI("BIM51API_SimpleDownloadModel", jsonData)

参数说明

参数内容可通过调用 检测转换状态 接口来获取 查看文档

1. FileKey：文件上传标识UUID
2. FileName：压缩包名字，包括.zip但不包括路径
3. ShowName：解压后BIM文件的重命名

回调监听

{
  "command": "event",
  "func_name": "SimpleDownloadModel",
  "args": {
    "SimpleDownloadModel": "返回结果"
  }
}

返回参数说明

SimpleDownloadModel: 文件下载状态

1. 字符 1 表示下载成功
2. 字符 0 表示下载失败
3. 直接显示错误原因 V2.3+

获取文件列表

获取场景底板中已经存在的模型文件，包含已加载、未加载的文件。

参数说明 V2.7+

1. bOnlyParent(可选参数)：仅返回所有母本文件信息，值只能为"1"
2. bOnlyDuplicate(可选参数)：仅返回所有副本文件信息，值只能为"1"

注意

以上参数每次仅允许传其中一个，或者一个都不传

let jsonData = {
    "bOnlyParent":"1",
    "bOnlyDuplicate":"1"
}
cloudRender.SuperAPI("BIM51API_GetFileInfos", jsonData)

回调监听

{
    "command": "event",
    "func_name": "GetFileInfos",
    "args":{
        "FileInfos": ["文本JSON串"]
    }
}

文本JSON串

{
  "FileName": "666",
  "AssetID": "",
  "IsDuplicate":"0",
  "IsLoadComplete": "0",
  "IsActive": "0",
  "IsEnable": "1",
  "IsNeedLoad": "0",
  "IsVisible":"-1,1,0",
  "GisCoord":"Lon,Lat,Height"
}

参数说明

字段名	字段说明	备注
FileName	模型名称	同上传文件的名称
AssetID	模型标识ID	V2.3+只有购买 批注 功能才有该字段
IsDuplicate	是否为模型副本	V2.7+1: 是，0: 否
IsLoadComplete	是否加载完成	1: 是，0: 否
IsActive	是否激活	1: 是，0: 否
IsEnable	是否允许加载	1: 是，0: 否
IsNeedLoad	是否需要加载	通常用于保存；1: 是，0: 否
IsVisible	是否可见	V2.3.1+1: 显示，0: 隐藏，-1: 模型未加载
GisCoord	模型GIS点	经度、纬度、高度

模型ID搜索

警告

需要先购买 批注 功能

通过模型ID精准匹配模型，查找范围为文件列表中存在的模型

let jsonData = {
    "AssetID": "xxx"
}

cloudRender.SuperAPI("BIM51API_GetFileInfoByID", jsonData)

回调监听

{
    "command": "event",
    "func_name": "GetFileInfoByID",
    "args":{
        "FileInfo": "文本JSON串"
    }
}

注意

1. 仅支持精准搜索
2. 仅返回一个，不是数组

母本与副本 V2.7+

使用副本名称获取母本模型信息

let jsonData = {
    "ModelName": "ModelName",
}
cloudRender.SuperAPI("BIM51API_GetParentModel", jsonData)

回调监听

{
  "command": "event",
  "func_name": "GetParentModel",
  "args":{
    "FileInfo": ["文件json串"]
  }
}

文本JSON串

{
  "FileName": "666",
  "AssetID":"",
  "IsDuplicate":"0",
  "IsLoadComplete": "0",
  "IsActive": "0",
  "IsEnable": "1",
  "IsNeedLoad": "0",
  "IsVisible":"-1,1,0",
  "GisCoord":"Lon,Lat,Height"
}

参数说明

字段名	字段说明	备注
FileName	模型名称	同上传文件的名称
AssetID	模型标识ID	V2.3+只有购买 批注 功能才有该字段
IsDuplicate	是否为模型副本	V2.7+1: 是，0: 否
IsLoadComplete	是否加载完成	1: 是，0: 否
IsActive	是否激活	1: 是，0: 否
IsEnable	是否允许加载	1: 是，0: 否
IsNeedLoad	是否需要加载	通常用于保存；1: 是，0: 否
IsVisible	是否可见	V2.3.1+1: 显示，0: 隐藏，-1: 模型未加载
GisCoord	模型GIS点	经度、纬度、高度

使用母本名称获取所有副本模型信息

let jsonData = {
    "ModelName": "ModelName",
}
cloudRender.SuperAPI("BIM51API_GetDuplicateModels", jsonData)

回调监听

{
  "command": "event",
  "func_name": "GetDuplicateModels",
  "args":{
    "FileInfos": ["文件json串"]
  }
}

文本JSON串

{
  "FileName": "666",
  "AssetID":"",
  "IsDuplicate":"0",
  "IsLoadComplete": "0",
  "IsActive": "0",
  "IsEnable": "1",
  "IsNeedLoad": "0",
  "IsVisible":"-1,1,0",
  "GisCoord":"Lon,Lat,Height"
}

参数说明

字段名	字段说明	备注
FileName	模型名称	同上传文件的名称
AssetID	模型标识ID	V2.3+只有购买 批注 功能才有该字段
IsDuplicate	是否为模型副本	V2.7+1: 是，0: 否
IsLoadComplete	是否加载完成	1: 是，0: 否
IsActive	是否激活	1: 是，0: 否
IsEnable	是否允许加载	1: 是，0: 否
IsNeedLoad	是否需要加载	通常用于保存；1: 是，0: 否
IsVisible	是否可见	V2.3.1+1: 显示，0: 隐藏，-1: 模型未加载
GisCoord	模型GIS点	经度、纬度、高度