BillboardGraphics

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


广告牌示例

new BillboardGraphics(options)
Parameters:
options (Object)
Name Description
options.show
Property
default true
指定公告牌可见性的布尔属性。
options.image
Property
指定要用于公告牌的图像、URI或画布的属性。
options.scale
Property
default 1.0
指定要应用于图像大小的比例的数值属性。
options.pixelOffset
Property
default Cartesian2.ZERO
指定像素偏移的Cartesian2属性。
options.eyeOffset
Property
default Cartesian3.ZERO
指定眼偏移的Cartesian3属性。
options.horizontalOrigin
Property
default HorizontalOrigin.CENTER
指定HorizontalOrigin的属性。
options.verticalOrigin
Property
default VerticalOrigin.CENTER
指定VerticalOrigin的属性。
options.heightReference
Property
default HeightReference.NONE
指定高度相对高度的属性。
options.color
Property
default Color.WHITE
指定图像色调的属性。
options.rotation
Property
default 0
指定围绕Alignedaxis旋转的数值属性。
options.alignedAxis
Property
default Cartesian3.ZERO
ACartesian3属性,指定旋转的单位矢量轴。
options.sizeInMeters
Property
一个布尔属性,指定是否应以米为单位测量此公告牌的大小。
options.width
Property
以像素为单位指定公告牌宽度的数值属性,覆盖本机大小。
options.height
Property
以像素为单位指定公告牌高度的数值属性,覆盖本机大小。
options.scaleByDistance
Property
ANearFarScalar属性,用于根据与相机的距离缩放点。
options.translucencyByDistance
Property
一个NearFarScalar属性,用于根据与相机的距离设置半透明。
options.pixelOffsetScaleByDistance
Property
一个NearFarScalar属性,用于根据与相机的距离设置PixeLoffset。
options.imageSubRegion
Property
指定BoundingRectangle的属性,该属性定义用于公告牌的图像的子区域,而不是整个图像,从左下角开始以像素度量。
options.distanceDisplayCondition
Property
一个属性,指定此公告牌将显示在与相机的距离。
options.disableDepthTestDistance
Property
一个属性,指定从要禁用深度测试的相机到的距离。

Members

alignedAxis : Property

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

color : Property

获取或设置指定与image相乘的Color的属性。这有两个常见的用例。首先,许多不同的广告牌可以使用相同的白色纹理,每个颜色都不同,以创建彩色广告牌。其次,颜色的alpha组件可以用来使广告牌半透明,如下所示。字母0.0使广告牌透明,字母1.0使广告牌不透明。

default
alpha : 0.5

Default Value: Color.WHITE

(readonly) definitionChanged : Event

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

disableDepthTestDistance : Property

获取或设置与要禁用深度测试的照相机之间的距离,例如,防止对地形进行剪切。当设置为零时,始终应用深度测试。当设置为数字正无穷大时,深度测试永远不会应用。

distanceDisplayCondition : Property

获取或设置DistanceDisplayCondition属性,指定此公告牌将显示在距相机的距离。

eyeOffset : Property

获取或设置Cartesian3属性,该属性指定公告牌在眼睛坐标中的偏移量。眼睛坐标是一个左手坐标系,其中x指向观看者的右侧,y指向上方,z指向屏幕。

眼睛偏移通常用于在同一位置安排多个广告牌或对象,例如,在其相应的3D模型上方安排一个广告牌。

下面,广告牌位于地球的中心,但是眼睛的偏移使它总是出现在地球的顶部,而不管观众或地球的方向如何。

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或画布的属性。

imageSubRegion : Property

获取或设置指定BoundingRectangle的属性,该属性定义image的子区域以左下角的像素度量,用于公告牌,而不是整个图像。

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

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

scale : Property

获取或设置指定要应用于图像的统一比例的数值属性。大于1.0的比例放大广告牌,而小于1.0的比例缩小广告牌。


从左到右在上图中,比例分别为0.51.02.0

Default Value: 1.0

scaleByDistance : Property

获取或设置NearFarScalar属性,该属性基于与相机的距离指定公告牌的比例。广告牌的比例将在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

获取或设置以像素为单位指定公告牌宽度的数字属性。如果未定义,则使用本机宽度。

Methods

clone(result) → {BillboardGraphics}
复制此实例。
Parameters:
result (BillboardGraphics) 存储结果的对象。
merge(source)
将此对象上的每个未分配属性分配给所提供源对象上相同属性的值。
Parameters:
source (BillboardGraphics) 要合并到此对象中的对象。