ComponentApi

构件相关API

Deprecated:
  • - 即将废弃
See:

Members

static ECompType :string

构件类型

Properties:
Name Type Description
type_cluster string

CLUSTER Mod类型

type_terrain string

地形

type_qxsy string

倾斜摄影

type_fbx string

FBX模板类型

Methods

static cancelHighlightComp(componentIds) → {void}

取消构件高亮

Parameters:
Name Type Description
componentIds Array.<string>

构件ID

Returns:
void

static clearComponentForceColor(componentIds, funcRet) → {void}

批量清除构件颜色

Parameters:
Name Type Description
componentIds Array.<string>

构件Id列表

funcRet clearComponentForceColorCallback
Returns:
void

static clearForceColorForProj(projId, funcRet) → {void}

清除工程下构件颜色

Parameters:
Name Type Description
projId string

工程Id

funcRet clearForceColorForProjCallback
Returns:
void

static createBillboard(relComponentId, sType, funcRet) → {void}

创建billboard

Parameters:
Name Type Description
relComponentId string

需要关联的构件Id

sType string

billboard类型

funcRet createBillboardCallback
Returns:
void

static enablePointCheckMode(bEnable) → {void}

开启点选模式

Parameters:
Name Type Description
bEnable Boolean
Returns:
void

static getBillboardByCompId(componentId, funcRet) → {void}

根据关联构件获取billboard列表

Parameters:
Name Type Description
componentId string

关联了billboard的构件id

funcRet getBillBoardByCompIdCallback
Returns:
void

static getBillboardByType(sType, funcRet) → {void}

根据类型获取billboard列表

Parameters:
Name Type Description
sType string

billboard类型

funcRet getBillboardByTypeCallback
Returns:
void

static getCimProjectComponents(projId, funcRet) → {void}

根据工程Id获取其工程下所有构件列表

Parameters:
Name Type Description
projId string

工程Id

funcRet getCimProjectComponentsCallback
Returns:
void

static getCompBimInfo(componentId, funcRet) → {void}

获取构件bim信息

Parameters:
Name Type Description
componentId string

构件ID

funcRet getCompBimInfoCallback
Returns:
void

static getCompBimInfoBatch(componentIds, funcRet) → {void}

批量获取构件bim信息

Parameters:
Name Type Description
componentIds Array.<string>

构件ID

funcRet getCompBimInfoBatchCallback
Returns:
void

static getComponentBoundingBox(componentId, funcRet) → {void}

获取构件包围盒(AABB)

Parameters:
Name Type Description
componentId string

构件ID

funcRet getComponentBoundingBoxCallback
Returns:
void

static getComponentInfo(componentId, funcRet) → {void}

获取构件信息

Parameters:
Name Type Description
componentId string

构件Id

funcRet getComponentInfoCallback
Returns:
void

static getComponentPosition(componentId, funcRet) → {void}

获取构件坐标

Parameters:
Name Type Description
componentId string

构件Id

funcRet getComponentPositionCallback
Returns:
void

static getCompTempDesInfo(componentId, funcRet) → {void}

获取构件描述

Parameters:
Name Type Description
componentId string

构件ID

funcRet getCompTempDesInfoCallback
Returns:
void

static getCompTransf(componentId, funcRet) → {void}

获取构件的变换矩阵

Parameters:
Name Type Description
componentId string

构件ID

funcRet getCompTransfCallback
Returns:
void

static getLinkedBimProjList(componentId, funcRet) → {void}

获取构件关联的BIM工程列表

Parameters:
Name Type Description
componentId string

构件id

funcRet getLinkedBimProjListCallback
Returns:
void

static getLinkedProjID(componentId, funcRet) → {void}

获取构件关联的子CIM工程

Parameters:
Name Type Description
componentId string

构件id

funcRet getLinkedProjIDCallback
Returns:
void

static getProjComponentInfosByType(projId, type, funcRet) → {void}

根据类型获取构件

Parameters:
Name Type Description
projId string

工程id

type string

构件类型

funcRet getProjComponentInfosByTypeCallback
Returns:
void

static getRelComponentInBillboard(billboardId, funcRet) → {void}

获取关联的构件

Parameters:
Name Type Description
billboardId string

billboardId

funcRet getRelComponentInBillboardCallback
Returns:
void

static getSortedProjComponentInfosByType(projId, type, bAsc, funcRet) → {void}

根据排序后的类型获取构件

Parameters:
Name Type Description
projId string

工程id

type string

构件类型

bAsc Boolean

= 是否升序排列

funcRet getSortedProjComponentInfosByTypeCallback
Returns:
void

static highlightComp(componentIds) → {void}

构件高亮

Parameters:
Name Type Description
componentIds Array.<string>

构件ID

Returns:
void

static removeBillboard(billboardIds) → {void}

移除billboard

Parameters:
Name Type Description
billboardIds Array.<string>

billboardId列表

Returns:
void

static removeBillboardByType(sType) → {void}

根据类型移除billboard

Parameters:
Name Type Description
sType string

billboard类型

Returns:
void

static researchComp(componentIds, dbScale) → {void}

反查构件

Parameters:
Name Type Description
componentIds Array.<string>

构件ID

dbScale Number

镜头缩放系数, 默认取值2.0

Returns:
void

static setBillboardImgByLocal(billboardId, sPath, scalingPicTimes, scalingPoint, scalingLine) → {void}

根据路径设置billboard展示内容

Parameters:
Name Type Description
billboardId string

billboardId

sPath string

图片路径(应用程序根目录的相对路径)

scalingPicTimes number

图片缩放比例

scalingPoint double

标注点缩放比例

scalingLine double

连线缩放比例

Returns:
void

static setBillboardImgByUrl(billboardId-, sUrl, scalingPicTimes, scalingPoint, scalingLine) → {void}

根据url设置billboard展示内容

Parameters:
Name Type Description
billboardId- string

billboardId

sUrl string

图片路径(网络url)

scalingPicTimes number

图片缩放比例

scalingPoint double

标注点缩放比例

scalingLine double

连线缩放比例

Returns:
void

static setBillboardVisible(billboardIds, bShow) → {void}

显示/隐藏billboard

Parameters:
Name Type Description
billboardIds Array.<string>

billboardId列表

bShow Boolean

是否显示

Returns:
void

static setBillboardVisibleByType(sType, bShow) → {void}

根据类型显示/隐藏billboard

Parameters:
Name Type Description
sType string

billboard类型

bShow Boolean

是否显示

Returns:
void

static setComponentForceColor(componentIds, color, funcRet) → {void}

批量设置构件颜色

Parameters:
Name Type Description
componentIds Array.<string>

构件Id列表

color string

颜色十六进制字符串,如"#ff0000"

funcRet setComponentForceColorCallback
Returns:
void

static setComponentVisible(componentId, bShow, funcRet) → {void}

设置工程下构件是否可见

Parameters:
Name Type Description
componentId string

构件Id

bShow Boolean

是否显示

funcRet setComponentVisibleCallback
Returns:
void

static setCompTransf(componentId, transf) → {void}

设置构件的变换矩阵

Parameters:
Name Type Description
componentId string

构件ID

transf JSON

变换矩阵
转换CAD矩阵 4*4,含平移,旋转,镜像,缩放
x1 x2 x3 t1
y1 y2 y3 t2
z1 z2 z3 t3
0 0 0 1
格式如下:
{
line1:{col1:double, col2:double, col3:double, col4:double},
line2:{col1:double, col2:double, col3:double, col4:double},
line3:{col1:double, col2:double, col3:double, col4:double},
line4:{col1:double, col2:double, col3:double, col4:double},
}

Returns:
void

static setForceColorForProj(projId, color, funcRet) → {void}

设置工程下构件颜色

Parameters:
Name Type Description
projId string

工程Id

color string

颜色十六进制字符串,如"#ff0000"

funcRet setForceColorForProjCallback
Returns:
void

static setSelectID(componentIds) → {void}

设置选中构件

Parameters:
Name Type Description
componentIds Array.<string>

构件Id列表

Returns:
void

static setVisibleForProj(projId, bShow, funcRet) → {void}

设置工程下构件是否可见

Parameters:
Name Type Description
projId string

工程Id

bShow Boolean

是否显示

funcRet setVisibleForProjCallback
Returns:
void

Type Definitions

clearComponentForceColorCallback(returnValue)

clearComponentForceColor

Parameters:
Name Type Description
returnValue Boolean

操作结果

clearForceColorForProjCallback(returnValue)

clearForceColorForProj

Parameters:
Name Type Description
returnValue Boolean

操作结果

createBillboardCallback(returnValue)

createBillboard回调函数

Parameters:
Name Type Description
returnValue string

billboardId

getBillboardByCompIdCallback(returnValue)

getBillboardByCompId回调函数

Parameters:
Name Type Description
returnValue Array.<string>

billboardId列表

getBillboardByTypeCallback(returnValue)

getBillboardByType回调函数

Parameters:
Name Type Description
returnValue Array.<string>

billboardId列表

getCimProjectComponentsCallback(returnValue)

GetComponentsByProjId

Parameters:
Name Type Description
returnValue Array.<JSON>

构件信息的json数组
格式如下:
[{
componentId:string,
componentType:string,
componentName:string,
}]

getCompBimInfoBatchCallback(returnValue)

getCompBimInfoBatch回调函数

Parameters:
Name Type Description
returnValue Array.<JSON>

构件的bim信息
格式如下:
[{
guid:string, //构件Guid
cimProjGuid:string//cim工程id
bimGuid:string, //构件的bim句柄
mainCompGuid:string, //主构件bim句柄
projGuid: string, //构件所属工程Guid
zhuanye:string, //构件专业
floor:string, //构件所在的bim楼层
cimFloor:string, //cim对应楼层
dalei:string, //构件大类
xiaolei:string, //构件小类
name:string //构件名称
props:[
{
name:string, //属性名称
value:string, //属性值
unit:string, //属性单位
group:string, //属性分组
}
]
}]

getCompBimInfoCallback(returnValue)

getCompBimInfo回调函数

Parameters:
Name Type Description
returnValue JSON

构件的bim信息
格式如下:
{
guid:string, //构件Guid
cimProjGuid:string//cim工程id
bimGuid:string, //构件的bim句柄
mainCompGuid:string, //主构件bim句柄
projGuid: string, //构件所属工程Guid
zhuanye:string, //构件专业
floor:string, //构件所在的bim楼层
cimFloor:string, //cim对应楼层
dalei:string, //构件大类
xiaolei:string, //构件小类
name:string //构件名称
props:[
{
name:string, //属性名称
value:string, //属性值
unit:string, //属性单位
group:string, //属性分组
}
]
}

getComponentBoundingBoxCallback(returnValue)

getComponentBoundingBox回调函数

Parameters:
Name Type Description
returnValue JSON

包围盒的点描述
格式如下:
{
lowPt:{x:double, y:double, z:double} //左下角
highPt:{x:double, y:double, z:double} //右上角
midPt:{x:double, y:double, z:double} //中心点
}

getComponentInfoCallback(returnValue)

getComponentInfo回调函数

Parameters:
Name Type Description
returnValue JSON

构件信息的json对象
格式如下:
{
componentId:string,
componentType:string,
componentName:string,
}

getComponentPositionCallback(returnValue)

getComponentPosition回调函数

Parameters:
Name Type Description
returnValue JSON

构件坐标的json对象
格式如下:
{x:double, y: double, z:double}

getCompTempDesInfoCallback(returnValue)

getCompTempDesInfo回调函数

Parameters:
Name Type Description
returnValue JSON

构件的bim信息
格式如下:
{
props:[
{
prop:{key:string, value:string} //属性键值对
}
]
}

getCompTransfCallback(returnValue)

getCompTransf回调函数

Parameters:
Name Type Description
returnValue JSON

构件的变换矩阵

See:
  • setCompTransf

getLinkedBimProjListCallback(returnValue)

getLinkedBimProjList 回调函数

Parameters:
Name Type Description
returnValue Array.<string>

工程ID列表

getLinkedProjIDCallback(returnValue)

getLinkedProjID回调函数

Parameters:
Name Type Description
returnValue string

工程ID

getRelComponentInBillboardCallback(returnValue)

getRelComponentInBillboard回调函数

Parameters:
Name Type Description
returnValue string

构件Id

getSortedProjComponentInfosByTypeCallback(returnValue)

GetSortedProjComponentInfosByType

Parameters:
Name Type Description
returnValue Array.<JSON>

构件信息的json数组
格式如下:
[{
componentId:string,
componentType:string,
componentName:string
}]

setComponentForceColorCallback(returnValue)

setComponentForceColor回调函数

Parameters:
Name Type Description
returnValue Boolean

操作结果

setComponentVisibleCallback(returnValue)

setComponentVisible回调函数

Parameters:
Name Type Description
returnValue Boolean

操作结果

setForceColorForProjCallback(returnValue)

setForceColorForProj

Parameters:
Name Type Description
returnValue Boolean

操作结果

setVisibleForProjCallback(returnValue)

setComponentVisible回调函数

Parameters:
Name Type Description
returnValue Boolean

操作结果