Class: BillboardGraphics

BillboardGraphics

new BillboardGraphics(options)

表示一个二维图标,位置由Entity的position属性指定。


Example billboards

Name Type Description
options Object 可选

Object 参数对象有如下属性:

Name Type Default Description
show Property true 可选

布尔属性,指定布告板的可见性。

image Property 可选

指定布告板要使用的图片资源,比如Image、URI 或 Canvas。

scale Property 1.0 可选

数值属性,指定图片尺寸的缩放比例。

pixelOffset Property Cartesian2.ZERO 可选

A Cartesian2 指定像素偏移的Cartesian2属性。

eyeOffset Property Cartesian3.ZERO 可选

A Cartesian3 指定视点偏移量的Cartesian3属性。

horizontalOrigin Property HorizontalOrigin.CENTER 可选

指定 HorizontalOrigin 的属性

verticalOrigin Property VerticalOrigin.CENTER 可选

指定 VerticalOrigin 的属性.

heightReference Property HeightReference.NONE 可选

指定高度相对于的位置的属性。

color Property Color.WHITE 可选

指定布告板色调颜色的属性。

rotation Property 0 可选

数值属性,指定围绕对齐轴的旋转。

alignedAxis Property Cartesian3.ZERO 可选

Cartesian3指定旋转轴,必须是单位向量。

sizeInMeters Property 可选

布尔属性,用于指定该布告板的尺寸是否以米为单位。

width Property 可选

数值属性,指定布告板的宽度(以像素为单位),覆盖原生尺寸。

height Property 可选

数值属性,指定布告板的高度(以像素为单位),覆盖原生尺寸。

scaleByDistance Property 可选

用于根据与相机的距离缩放点的属性。

translucencyByDistance Property 可选

NearFarScalar用于根据与相机的距离设置半透明度的属性。

pixelOffsetScaleByDistance Property 可选

NearFarScalar用于根据与相机的距离设置像素偏移的属性。

imageSubRegion Property 可选

指定BoundingRectangle该属性定义使用图片子区域,而不是整个图片去填充布告板,以左下角为原点,单位为像素。

distanceDisplayCondition Property 可选

指定一个距离,当布告板与相机的距离小于该距离时布告板显示。

disableDepthTestDistance Property 可选

指定一个距离,当布告板与相机的距离小于该距离时关闭布告板的深度测试。

Members

alignedAxisProperty

获取或设置 Cartesian3 属性。该属性指定旋转轴。当设置为 Cartesian3.ZERO 时,旋转将从屏幕顶部开始。

Default Value:
Cartesian3.ZERO

colorColor

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

default
alpha : 0.5

Default Value:
Color.WHITE

readonly definitionChangedEvent

获取事件。该事件在属性或者子属性的值被修改,或者定义被修改时被抛出。

disableDepthTestDistanceProperty

获取或设置布告板与相机的距离,当布告板到相机距离小于该距离时,要关闭深度检测。比如以次来防止被地形遮挡而裁掉。 当值为0时,始终开启深度检测。当值为Number.POSITIVE_INFINITY,始终关闭深度检测。

distanceDisplayConditionProperty

获取或设置布告板与相机的距离,当布告板到相机距离小于该距离时,显示该布告板。

eyeOffsetProperty

获取或设置一个Cartesian3属性,该属性指定布告板在相机空间的偏移量。 该相机空间是一个左手坐标系的空间。x轴指向观察者的右边,y轴指向观察者的上边,z指向屏幕内。

eyeOffset通常用于安排在同一个位置的多个布告板,比如把一个布告板放置到它对应模型的上边

下图显示,布告板被放置地球的中心。但是eyeOffset可以让布告板始终出现在地球的上方,无论观察者或这地球的姿态如何

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

Default Value:
Cartesian3.ZERO

heightProperty

获取或设置布告板高度。类型为number,单位为像素。 未定义时,使用本地高度。

heightReferenceProperty

获取或设置指定 HeightReference 的属性。

Default Value:
HeightReference.NONE

horizontalOriginProperty

获取或设置指定 HorizontalOrigin的属性。

Default Value:
HorizontalOrigin.CENTER

imageProperty

获取或设置布告板要使用的图片资源,类型可为Image、URI 或 Canvas。

imageSubRegionProperty

获取或设置一个BoundingRectangle属性,该属性定义了使用图片子区域,而不是整个图片去填充布告板,以左下角为原点,单位为像素。

pixelOffsetProperty

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

default
b.pixeloffset = new Cartesian2(50, 25);
The billboard's origin is indicated by the yellow point.

Default Value:
Cartesian2.ZERO

pixelOffsetScaleByDistanceProperty

获取或设置 NearFarScalar的值。该属性根据布告板与相机的距离来指定布告板的像素偏移。 当相机到布告板的距离NearFarScalar#nearNearFarScalar#far之间时,布告板的像素偏移将在NearFarScalar#nearValueNearFarScalar#farValue 之间插值 当相机到布告板的距离NearFarScalar#nearNearFarScalar#far之外,布告板的像素偏移将为最近的那个值。

rotationProperty

获取或者设置图片绕旋转轴BillboardGraphic.alignedAxis逆时针旋转的角度,类型为number。 获取或设置数字属性,该属性指定影像从对齐轴逆时针旋转。

Default Value:
0

scaleProperty

获取或者设置一个统一缩放比例,该缩放比用于缩放图片尺寸。比例大于 1.0 会放大布告板,而比例小于 1.0 则会缩小布告板。


From left to right in the above image, the scales are 0.5, 1.0, and 2.0.

Default Value:
1.0

scaleByDistanceProperty

获取或设置 NearFarScalar的值。该属性根据布告板与相机的距离来指定布告板的缩放比例。 当相机到布告板的距离NearFarScalar#nearNearFarScalar#far之间时,布告板的缩放比例将在NearFarScalar#nearValueNearFarScalar#farValue 之间插值 当相机到布告板的距离NearFarScalar#nearNearFarScalar#far之外,布告板的缩放比例将为最近的那个值。

showProperty

获取设置布告板的可见性,类型为boolean。

Default Value:
true

sizeInMetersProperty

获取或设置布告板尺寸是否以米为单位,类型为boolean。

Default Value:
false

translucencyByDistanceProperty

获取或设置 NearFarScalar的值。该属性根据布告板与相机的距离来指定布告板的透明度。 当相机到布告板的距离NearFarScalar#nearNearFarScalar#far之间时,布告板的透明度将在NearFarScalar#nearValueNearFarScalar#farValue 之间插值 当相机到布告板的距离NearFarScalar#nearNearFarScalar#far之外,布告板的透明度将为最近的那个值。

verticalOriginProperty

获取或设置指定 VerticalOrigin 的属性。

Default Value:
VerticalOrigin.CENTER

widthProperty

获取或设置布告板的宽度。类型为number,单位为像素 未定义时,使用本地高度。

Methods

clone(result){BillboardGraphics}

拷贝该实例

Name Type Description
result BillboardGraphics 可选

存储拷贝结果的对象.

Returns:
Type Description
BillboardGraphics 如果提供了输入参数,返回修改后的输入参数对象。如果没提供入参,返回一个新的实例。

merge(source)

为本实例所有未指定值的属性赋上source对象对应的属性值

Name Type Description
source BillboardGraphics

提供属性值的对象