BillboardGraphics

new Cesium.BillboardGraphics(options)

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


示例广告牌

Name Type Description
options BillboardGraphics.ConstructorOptions optional 描述初始化选项的对象
Demo:

Members

获取或设置指定固定帧中旋转轴单位向量的 Cartesian3 属性。 当设置为 Cartesian3.ZERO 时,旋转来自屏幕顶部。
Default Value: Cartesian3.ZERO
获取或设置指定与 image 相乘的 Color 的属性。 这有两个常见用途。首先,许多不同的广告牌可以使用相同的白色纹理,每个广告牌具有不同的颜色,以创建彩色广告牌。 其次,颜色的 alpha 分量可以使广告牌半透明,如下所示。Alpha 为 0.0 使广告牌透明, 1.0 使广告牌不透明。

default
alpha : 0.5

Default Value: Color.WHITE
获取每当属性或子属性更改或修改时触发的事件。

disableDepthTestDistance : Property|undefined

获取或设置禁用深度测试的距相机距离,例如,防止与地形裁剪。 设置为零时,始终应用深度测试。设置为 Number.POSITIVE_INFINITY 时,从不应用深度测试。

distanceDisplayCondition : Property|undefined

获取或设置指定在距相机多远处显示此广告牌的 DistanceDisplayCondition 属性。
获取或设置指定广告牌在眼坐标中偏移的 Cartesian3 属性。 眼坐标系是一个左手坐标系,其中 x 指向观察者的右侧,y 指向上方,z 指向屏幕内。

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

如下所示,广告牌位于地球中心,但眼偏移使其始终出现在地球上方,而不受观察者或地球方向的影响。

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

Default Value: Cartesian3.ZERO
获取或设置指定广告牌高度(像素)的数值属性。 未定义时,使用原生高度。
获取或设置指定 HeightReference 的属性。
Default Value: HeightReference.NONE
获取或设置指定 HorizontalOrigin 的属性。
Default Value: HorizontalOrigin.CENTER
获取或设置指定用于广告牌的图像、URI 或 Canvas 的属性。
获取或设置指定 BoundingRectangle 的属性,该属性定义用于广告牌的 image 子区域, 而非整个图像,从左下角以像素为单位测量。
获取或设置指定广告牌在屏幕空间中从此广告牌原点偏移的 Cartesian2 属性。 这通常用于将多个广告牌和标签对齐在同一位置,例如图像和文本。屏幕空间原点为画布的左上角; x 从左到右增大,y 从上到下增大。

default
b.pixeloffset = new Cartesian2(50, 25);
广告牌的起源由黄点指示。

Default Value: Cartesian2.ZERO

pixelOffsetScaleByDistance : Property|undefined

获取或设置指定广告牌根据距相机距离的像素偏移的 NearFarScalar 属性。 当相机距离落在指定的 NearFarScalar#nearNearFarScalar#far 的上下限范围内时, 广告牌的像素偏移将在 NearFarScalar#nearValueNearFarScalar#farValue 之间插值。 超出这些范围时,广告牌的像素偏移将保持在最近的边界。
获取或设置指定图像从 alignedAxis 逆时针旋转的数值属性。
Default Value: 0
获取或设置指定应用于图像的统一缩放的数值属性。 大于 1.0 的缩放会放大广告牌,而小于 1.0 的缩放会缩小它。


从上图中从左到右,缩放分别为 0.51.02.0

Default Value: 1.0
获取或设置指定广告牌根据距相机距离的缩放的 NearFarScalar 属性。 当相机距离落在指定的 NearFarScalar#nearNearFarScalar#far 的上下限范围内时, 广告牌的缩放将在 NearFarScalar#nearValueNearFarScalar#farValue 之间插值。 超出这些范围时,广告牌的缩放将保持在最近的边界。
获取或设置指定广告牌可见性的布尔属性。
Default Value: true
获取或设置指定此广告牌尺寸是否以米为单位测量的布尔属性。
Default Value: false
获取或设置指定此广告牌 SplitDirection 的属性。
Default Value: SplitDirection.NONE
获取或设置指定广告牌根据距相机距离的透明度的 NearFarScalar 属性。 当相机距离落在指定的 NearFarScalar#nearNearFarScalar#far 的上下限范围内时, 广告牌的透明度将在 NearFarScalar#nearValueNearFarScalar#farValue 之间插值。 超出这些范围时,广告牌的透明度将保持在最近的边界。
获取或设置指定 VerticalOrigin 的属性。
Default Value: VerticalOrigin.CENTER
获取或设置指定广告牌宽度(像素)的数值属性。 未定义时,使用原生宽度。

Methods

复制此实例。
Name Type Description
result BillboardGraphics optional 存储结果的对象。
Returns:
修改后的结果参数,如果未提供则为新实例。
将此对象上每个未分配的属性赋值为提供的源对象上相同属性的值。
Name Type Description
source BillboardGraphics 要合并到此对象中的对象。

Type Definitions

Cesium.BillboardGraphics.ConstructorOptions

BillboardGraphics 构造函数的初始化选项
Properties:
Name Type Attributes Default Description
show Property | boolean <optional>
true 指定广告牌可见性的布尔属性。
image Property | string | HTMLImageElement | HTMLCanvasElement <optional>
指定用于广告牌的图像、URI 或 Canvas 的属性。
scale Property | number <optional>
1.0 指定应用于图像尺寸的缩放的数值属性。
pixelOffset Property | Cartesian2 <optional>
Cartesian2.ZERO 指定像素偏移的 Cartesian2 属性。
eyeOffset Property | Cartesian3 <optional>
Cartesian3.ZERO 指定视点偏移的 Cartesian3 属性。
horizontalOrigin Property | HorizontalOrigin <optional>
HorizontalOrigin.CENTER 指定 HorizontalOrigin 的属性。
verticalOrigin Property | VerticalOrigin <optional>
VerticalOrigin.CENTER 指定 VerticalOrigin 的属性。
heightReference Property | HeightReference <optional>
HeightReference.NONE 指定高度相对于什么的属性。
color Property | Color <optional>
Color.WHITE 指定图像色调 Color 的属性。
rotation Property | number <optional>
0 指定绕 alignedAxis 旋转的数值属性。
alignedAxis Property | Cartesian3 <optional>
Cartesian3.ZERO 指定旋转轴单位向量的 Cartesian3 属性。
sizeInMeters Property | boolean <optional>
指定此广告牌尺寸是否以米为单位的布尔属性。
width Property | number <optional>
指定广告牌宽度(像素)的数值属性,覆盖原生尺寸。
height Property | number <optional>
指定广告牌高度(像素)的数值属性,覆盖原生尺寸。
scaleByDistance Property | NearFarScalar <optional>
用于根据距相机距离缩放点的 NearFarScalar 属性。
translucencyByDistance Property | NearFarScalar <optional>
用于根据距相机距离设置透明度的 NearFarScalar 属性。
pixelOffsetScaleByDistance Property | NearFarScalar <optional>
用于根据距相机距离设置像素偏移的 NearFarScalar 属性。
imageSubRegion Property | BoundingRectangle <optional>
指定 BoundingRectangle 的属性,用于定义图像的子区域而非整个图像,从左下角以像素为单位测量。
distanceDisplayCondition Property | DistanceDisplayCondition <optional>
指定在距相机多远处显示此广告牌的属性。
disableDepthTestDistance Property | number <optional>
指定在距相机多远处禁用深度测试的属性。
splitDirection Property | SplitDirection <optional>
指定广告牌 SplitDirection 的属性。
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.