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>
用于根据与相机的距离设置 pixelOffset 的 NearFarScalar 属性。
imageSubRegion Property | BoundingRectangle <optional>
指定 BoundingRectangle 的属性,该矩形定义用于广告牌的图像子区域,而不是整个图像,从左下角以像素为单位测量。
distanceDisplayCondition Property | DistanceDisplayCondition <optional>
指定此广告牌在距离相机多远时显示的属性。
disableDepthTestDistance Property | number <optional>
指定从相机处禁用深度测试的距离的属性。
splitDirection Property | SplitDirection <optional>
指定广告牌的 SplitDirection 的属性。
需要帮助?获取答案的最快方式是在 Cesium 论坛 上向社区和团队提问。