MarkAPI
标签及三维装饰体接口。
# 接口
| 接口 | 说明 |
|---|---|
| addLinkPoint | 添加关联点。通过指定三维空间点,获取该三维点对应在视口中的坐标,当三维点在视口中的显示位置发生改变的时候, 三维图形场景将向页面发送消息,更新对应的二维视口坐标。可用于将页面要素与三维点进行绑定,使得页面要素随三维空间点移动而移动。 |
| removeLinkPoint | 移除关联点。 |
| addSimpleMark | 添加简单的图文标签。 |
| removeSimpleMark | 移除一个图文标签。 |
| addRgn | 添加一个空间多边形面。 |
| removeRgn | 移除一个多边形面。 |
| addLine | 添加空间折线。 |
| removeLine | 移除一条线。 |
| addSimpleMarkByElemnet | 添加图文标签并绑定到构件。 |
| addLinkPointByElement | 添加构件关联点。 |
| updateSimpleMarkPosition | 更新图文标签的位置。 |
| addAttributeMark | 添加属性标签 |
| addAttributeMark2 | 添加属性标签 |
| updateAttributeMarkPosition | 更新属性标签绑定的空间点位置。 |
| updateAttributeMarkNVs | 更新属性标签的属性数据。 |
| removeAttributeMark | 移除属性标签。 |
# 1. addLinkPoint
添加关联点。通过指定三维空间点,获取该三维点对应在视口中的坐标,当三维点在视口中的显示位置发生改变的时候,三维图形场景将向页面发送消息,更新对应的二维视口坐标。可用于将页面要素与三维点进行绑定,使得页面要素随三维空间点移动而移动。
addLinkPoint(id, x, y, z)
参数:
id 唯一标识。
x/y/z 关联的三维点的坐标值。
# 2. removeLinkPoint
移除关联点。
removeLinkPoint(id)
参数:
id 要移除的关联的标识。
# 3. addSimpleMark
添加简单的图文标签。
addSimpleMark(id, pos, size, imgProps, txtProps)
参数:
id 标签的唯一标识。
pos {x, y, z} 标签绑定的空间点的坐标。
x/y/z 标签绑定的空间点的X/Y/Z 坐标值。
size {x,y} 标签的屏幕像素大小,以绑定点为中心。
x/y 标签的长宽。
imgProps { url,size,offset } 标签图形信息。
url 标签对应的图形资源。为空则标识该标签不使用图形。
size {x,y} 标签图形显示的大小。x/y 对应显示的图形的长宽。
Offset {x,y} 图形相对绑定点的偏移。以图形的中心为基准。
txtProps { txt } 标签的文字信息。
txt 标签显示的文字字符串。
返回:
鼠标点击标签的时候返回对应的鼠标事件。
通过消息 onBWApiMessage/MarkApi/onMarkLeftButtonDown 返回鼠标左键点击事件。
通过消息 onBWApiMessage/MarkApi/onMarkRightButtonDown 返回鼠标右键点击事件。
# 4. removeSimpleMark
移除一个图文标签。
removeSimpleMark(id)
参数:
id 标签的唯一标识。
# 5. addRgn
添加一个空间多边形区域面。
addRgn(id, pts, rgba)
参数:
id 多边形区域面的唯一标识。
pts 构成多变形的三维点的数组,{x,y,z}数组。
rgba 区域面的颜色和透明度。{r,g,b,a}
r/g/b/a 颜色值的RGB分量以及透明度的值。0--255。
# 6. removeRgn
移除一个多边形区域面。
removeRgn(id)
参数:
id 要移除的面的唯一标识。
# 7. addLine
三维场景中添加一个多点折线。
addLine(id, pts, rgba)
参数:
id 线的唯一标识。
pts 构成折点的点的三维坐标的数组。{x,y,z}。
rgba 线的颜色和透明度。{r,g,b,a}
r/g/b/a 颜色值的RGB分量以及透明度的值。0--255。
# 8. removeLine
从三维场景中移除一条线。
removeLine(id)
参数:
id 要移除的线的唯一标识。
# 9. addSimpleMarkByElemnet
添加简单的图文标签并绑定构件。
AddSimpleMarkByElemnet( id, elementId, size, imgProps, txtProps, type )
参数:
id 标签的唯一标识。
size {x,y} 标签的屏幕像素大小,以绑定点为中心。
x/y 标签的长宽。
imgProps { url,size,offset } 标签图形信息。
url 标签对应的图形资源。为空则标识该标签不使用图形。
size {x,y} 标签图形显示的大小。x/y 对应显示的图形的长宽。
Offset {x,y} 图形相对绑定点的偏移。以图形的中心为基准。
txtProps { txt } 标签的文字信息。
txt 标签显示的文字字符串。
elementId 构件的ID
type 绑定位置。“TopCenter”构件包围盒上表面中心。“Center”构件包围盒中心”。
返回:
鼠标点击标签的时候返回对应的鼠标事件。
通过消息 onBWApiMessage/MarkApi/onMarkLeftButtonDown 返回鼠标左键点击事件。
通过消息 onBWApiMessage/MarkApi/onMarkRightButtonDown 返回鼠标右键点击事件。
# 10. addLinkPointByElement
通过构件添加关联点。
addLinkPointByElement( id, elementId, type )
参数:
id 唯一标识。
element 构件ID。
type 绑定位置。“TopCenter”构件包围盒上表面中心。“Center”构件包围盒中心”。
# 11. updateSimpleMarkPosition
变更已存在的简单图文标签的位置。
updateSimpleMarkPosition( id, pos )
参数:
id 唯一标识。
pos {x, y, z} 标签绑定的空间点的坐标。
# 12. addAttributeMark
添加简单文字属性标签。
addAttributeMark( id, pos, size, nvs, lineColor, txtColor, txtHeight, nameWidth, valueWidth )
参数:
id 标签的唯一标识。
pos {x, y, z} 标签绑定的空间点的坐标。
x/y/z 标签绑定的空间点的X/Y/Z 坐标值。
size {x,y} 标签的屏幕像素大小,以绑定点为中心。
x/y 标签的长宽,鼠标响应点的长宽,以绑定点为中心。
nvs [{name, value}]属性信息。
name 属性名。
value 属性值。
lineColor 标签线颜色。
txtColor 标签文字颜色。
txtHeight 标签文字行高。
nameWidth 标签属性名称的宽度。
valueWidth 标签属性值的宽度。
# 13. addAttributeMark****2
添加简单文字属性标签。
addAttributeMark( id, pos, size, nvs, lineColor, txtColor, txtHeight, nameWidth, valueWidth, txtLeft, txtTop )
参数:
id 标签的唯一标识。
pos {x, y, z} 标签绑定的空间点的坐标。
x/y/z 标签绑定的空间点的X/Y/Z 坐标值。
size {x,y} 标签的屏幕像素大小,以绑定点为中心。
x/y 标签的长宽,鼠标响应点的长宽,以绑定点为中心。
nvs [{name, value}]属性信息。
name 属性名。
value 属性值。
lineColor 标签线颜色。
txtColor 标签文字颜色。
txtHeight 标签文字行高。
nameWidth 标签属性名称的宽度。
valueWidth 标签属性值的宽度。
txtLeft 标签文字左上角相对绑定点的X轴偏移。
txtTop 标签文字左上角相对绑定点的Y轴偏移。
# 14. updateAttributeMarkPosition
变更已存在的简单图文标签的位置。
updateAttributeMarkPosition( id, pos )
参数:
id 唯一标识。
pos {x, y, z} 标签绑定的空间点的坐标。
# 15. updateAttributeMarkNVs
更新属性标签的属性值。
updateAttributeMarkNVs( id, nvs)
参数:
id 唯一标识。
nvs [{name,valeu}] 属性项及属性值的数组。
# 16. removeAttributeMark
删除一个属性标签。
removeAttributeMark( id)
参数:
id 属性标签的唯一标识。