BillboardGraphics

new SuperMap3D.BillboardGraphics(options)

描述位于包含 Entity 的位置的二维图标。


Example billboards

Name Type Description
options Object optional 具有以下属性的对象:
Name Type Default Description
image Property optional 属性,指定布告板要使用的影像、URI 或 Canvas。
show Property true optional 布尔属性,指定布告板的可见性。
scale Property 1.0 optional 数值属性,指定应用于影像尺寸的缩放比例。
horizontalOrigin Property HorizontalOrigin.CENTER optional 指定 HorizontalOrigin 的属性。
verticalOrigin Property VerticalOrigin.CENTER optional 指定 VerticalOrigin 的属性。
eyeOffset Property Cartesian3.ZERO optional 指定视点偏移量的Cartesian3属性。
pixelOffset Property Cartesian2.ZERO optional 指定像素偏移的Cartesian2属性。
rotation Property 0 optional 数值属性,指定围绕对齐轴的旋转。
alignedAxis Property Cartesian3.ZERO optional Cartesian3指定旋转单位矢量轴的属性。
width Property optional 数值属性,指定布告板的宽度(以像素为单位),覆盖原生尺寸。
height Property optional 数值属性,指定布告板的高度(以像素为单位),覆盖原生尺寸。
color Property Color.WHITE optional 指定影像色调颜色的属性。
scaleByDistance Property optional NearFarScalar用于根据与相机的距离缩放点的属性。
translucencyByDistance Property optional NearFarScalar用于根据与相机的距离设置半透明度的属性。
pixelOffsetScaleByDistance Property optional NearFarScalar用于根据与相机的距离设置像素偏移的属性。
imageSubRegion Property optional 指定BoundingRectangle该属性定义了用于布告板的影像子区域,而不是整个影像,以左下角起的像素为单位。
sizeInMeters Property optional 布尔属性,用于指定该布告板的尺寸是否以米为单位。
heightReference Property HeightReference.NONE optional 指定高度相对于的位置的属性。
distanceDisplayCondition Property optional 指定布告板与相机的距离的属性。

Members

alignedAxis : Property

获取或设置 Cartesian3 属性。指定固定框架中的单位向量旋转轴。当设置为 Cartesian3.ZERO 时,旋转将从屏幕顶部开始。
Default Value: Cartesian3.ZERO

color : Property

获取或设置指定与影像相乘的颜色的属性。 首先,许多不同的布告板可以使用相同的白色纹理(每种纹理的颜色各不相同)来创建彩色布告板。 其次,颜色的alpha分量可用于使布告板半透明,如下图所示。Alpha 值为0.0时,布告板为透明;Alpha 值为 1.0 时,布告板为不透明。

default
alpha : 0.5

Default Value: Color.WHITE

readonlydefinitionChanged : Event

获取属性或子属性更改或修改时引发的事件。

disableDepthTestDistance : Property

获取或设置与相机的距离,在该距离上要禁用深度检测,以防止对地形的剪切。 当设置为0时,始终应用深度检测。当设置为Number时,POSITIVE_INFINITY,深度检测从未应用。

distanceDisplayCondition : Property

获取或设置DistanceDisplayCondition属性,该属性指定将在距离相机的距离处显示此布告板。

distanceDisplayCondition : Property

获取或设置DistanceDisplayCondition属性,用于指定显示此多边形的相机距离。

eyeOffset : Property

获取或设置指定布告板在视点坐标中的偏移量的Cartesian3属性。 视点坐标是一个左手坐标系,其中x指向观察者的右侧,y指向上方,z指向屏幕内部。

视点偏移通常用于将多个布告板或物体安排在同一位置,例如,将布告板安排在其相应三维模型的上方。

下图中,布告板位于地球中心,但由于视点的偏移,无论观众或地球的方位如何,布告板始终显示在地球的顶部。

b.eyeOffset = new Cartesian3(0.0, 8000000.0, 0.0);

Default Value: Cartesian3.ZERO

height : Property

获取或设置指定布告板高度的数字属性,单位为像素。 未定义时,使用本地高度。

heightReference : Property

获取或设置指定 HeightReference 的属性。
Default Value: HeightReference.NONE

horizontalOrigin : Property

获取或设置指定 HorizontalOrigin的属性。
Default Value: HorizontalOrigin.CENTER

image : Property

获取或设置属性,指定布告板要使用的图片、URI 或 Canvas。

imageSubRegion : Property

指定BoundingRectangle该属性定义了用于布告板的影像子区域,而不是整个影像,以左下角起的像素为单位。

pixelOffset : Property

获取或设置 Cartesian2 属性。指定布告板在屏幕空间中从该布告板原点出发的像素偏移量。 这通常用于将多个布告板和标签(如影像和文本)对齐到同一位置。 屏幕空间的原点是画布的左上角;x 值从左到右递增,y 值从上到下递增。

default
b.pixeloffset = new Cartesian2(50, 25);
布告板的原点由黄色的点表示。

Default Value: Cartesian2.ZERO

pixelOffsetScaleByDistance : Property

获取或设置NearFarScalar属性,该属性根据与相机的距离指定布告板的像素偏移量。 布告板的像素偏移量将在NearFarScalar#nearValueNearFarScalar#farValue之间插值,而相机距离落在指定的NearFarScalar#nearNearFarScalar#far的上下边界内。 在这些范围之外,布告板的像素偏移仍然被限制在最近的范围内。

rotation : Property

获取或设置数字属性,该属性指定影像从对齐轴逆时针旋转。
Default Value: 0

scale : Property

获取或设置指定应用于影像的统一缩放比例的数值属性。比例大于 1.0 会放大布告板,而比例小于 1.0 则会缩小布告板。


上图从左到右依次为0.51.02.0

Default Value: 1.0

scaleByDistance : Property

获取或设置 NearFarScalar的值。该属性根据与相机的距离来指定布告板的缩放比例。 布告板的缩放比例将在NearFarScalar#nearValueNearFarScalar#farValue 之间插值。 布告板的比例将在指定的 NearFarScalar#nearValueNearFarScalar#farValue 之间插值,而相机距离则在指定的 NearFarScalar#nearNearFarScalar#far 的上下限范围内。 在这些范围之外,布告板的缩放比例将保持在最近的范围内。

show : Property

获取或设置布尔属性,指定布告板的可见性。
Default Value: true

sizeInMeters : Property

获取或设置布尔属性,该属性指定是否以米为单位测量此布告板的大小。
Default Value: false

translucencyByDistance : Property

获取或设置NearFarScalar属性,该属性根据与相机的距离指定布告板的半透明度。 布告板的半透明将在NearFarScalar#nearValueNearFarScalar#farValue之间插值,而相机距离落在指定的NearFarScalar#nearNearFarScalar#far的上下边界内。 在这些范围之外,布告板的半透明仍然被限制在最近的范围内。

verticalOrigin : Property

获取或设置指定 VerticalOrigin 的属性。
Default Value: VerticalOrigin.CENTER

width : Property

获取或设置指定布告板宽度(以像素为单位)的数字属性。 When undefined, the native width is used.

Methods

clone(result)BillboardGraphics

复制此实例。
Name Type Description
result BillboardGraphics optional 存储结果的对象。
Returns:
修改后的结果参数,或一个新实例(如果没有提供)。

merge(source)

将此对象上每个未指定的属性赋值给所提供源对象上相同属性的值。
Name Type Description
source BillboardGraphics 要合并到此对象中的对象。