Name | Type | Description |
---|---|---|
options |
BillboardGraphics.ConstructorOptions | optional 描述初始化选项的对象 |
Members
alignedAxis : Property|undefined
获取或设置
Cartesian3
指定 单位矢量旋转轴
在固定框架中。当设置为 Cartesian3.ZERO 时,从屏幕顶部开始旋转。
-
Default Value:
Cartesian3.ZERO
color : Property|undefined
获取或设置指定
Color
乘以 image
.
这有两个常见的用例。 首先,相同的白色纹理可能被许多不同的广告牌使用,
每个都有不同的颜色,以创建彩色广告牌。其次,颜色的 alpha 分量可以是
用于使公告牌半透明,如下所示。Alpha 值为 0.0
时,广告牌
透明,1.0
使公告牌不透明。
default ![]() |
alpha : 0.5 ![]() |
-
Default Value:
Color.WHITE
readonly definitionChanged : Event
获取在更改或修改属性或子属性时引发的事件。
disableDepthTestDistance : Property|undefined
获取或设置与摄像机的距离,以禁用深度测试,以防止根据地形进行裁剪。
当设置为零时,始终应用深度测试。设置为 Number.POSITIVE_INFINITY 时,从不应用深度测试。
distanceDisplayCondition : Property|undefined
获取或设置
DistanceDisplayCondition
指定此公告板将在距摄像机多远处显示的属性。
eyeOffset : Property|undefined
获取或设置
Cartesian3
指定广告牌在眼睛坐标中的偏移量的属性。
眼睛坐标是左手坐标系,其中 x
指向查看者的
向右,Y
指向上方,Z
指向屏幕。
眼动偏移通常用于将多个广告牌或对象排列在同一位置,例如,将 在其相应的 3D 模型上方布置广告牌。
在下面,广告牌位于地球的中心,但眼睛偏移使其始终 显示在地球顶部,无论观看者或地球的方向如何。
![]() |
![]() |
b.eyeOffset = new Cartesian3(0.0, 8000000.0, 0.0);
-
Default Value:
Cartesian3.ZERO
height : Property|undefined
获取或设置数值的指定 公告牌的高度(以像素为单位)。
如果未定义,则使用本机高度。
heightReference : Property|undefined
获取或设置指定
HeightReference
.
-
Default Value:
HeightReference.NONE
horizontalOrigin : Property|undefined
获取或设置指定
HorizontalOrigin
.
-
Default Value:
HorizontalOrigin.CENTER
image : Property|undefined
获取或设置指定要用于广告牌的 Image、URI 或 Canvas 的属性。
imageSubRegion : Property|undefined
获取或设置指定
BoundingRectangle
的属性,该属性定义
子区域 image
用于公告牌,而不是整个图像,
以左下角的像素为单位。
pixelOffset : Property|undefined
获取或设置
公告牌的原点由黄点表示。
Cartesian2
指定广告牌在屏幕空间中的像素偏移的属性
来自此广告牌的来源。 这通常用于将多个广告牌和标签对齐
相同的位置,例如,图像和文本。 屏幕空间原点是
canvas; x
从左到右增加,y
从上到下增加。
default ![]() |
b.pixeloffset = new Cartesian2(50, 25); ![]() |
-
Default Value:
Cartesian2.ZERO
pixelOffsetScaleByDistance : Property|undefined
获取或设置
NearFarScalar
根据与摄像机的距离指定公告牌的像素偏移。
公告牌的像素偏移量将在 NearFarScalar#nearValue
和
NearFarScalar#farValue
当摄像机距离落在下限和上限内时
指定的 NearFarScalar#near
和 NearFarScalar#far
的 *。
超出这些范围时,公告板的像素偏移将保持限制在最近的边界上。
rotation : Property|undefined
获取或设置数值的指定 图像的旋转
从
alignedAxis
逆时针方向。
-
Default Value:
0
scale : Property|undefined
获取或设置numeric 指定要应用于图像的统一缩放的属性。
大于

在上图中,比例从左到右分别为
1.0
的比例会放大广告牌,而小于 1.0
的比例会缩小广告牌。

在上图中,比例从左到右分别为
0.5
、1.0
和 2.0
。
-
Default Value:
1.0
scaleByDistance : Property|undefined
获取或设置
NearFarScalar
根据与摄像机的距离指定公告牌的比例。
公告牌的比例将在 NearFarScalar#nearValue
和
NearFarScalar#farValue
当摄像机距离落在下限和上限内时
指定的 NearFarScalar#near
和 NearFarScalar#far
的 *。
在这些范围之外,公告牌的刻度仍会限制在最近的边界上。
show : Property|undefined
获取或设置boolean 指定公告板可见性的属性。
-
Default Value:
true
sizeInMeters : Property|undefined
获取或设置boolean 属性,指定此公告板的大小是否以米为单位。
-
Default Value:
false
splitDirection : Property|undefined
获取或设置指定
SplitDirection
这个广告牌。
-
Default Value:
SplitDirection.NONE
translucencyByDistance : Property|undefined
获取或设置
NearFarScalar
根据与摄像机的距离指定公告牌的半透明性。
公告牌的半透明性将在 NearFarScalar#nearValue
和 之间插值
NearFarScalar#farValue
当摄像机距离落在下限和上限内时
指定的 NearFarScalar#near
和 NearFarScalar#far
的 *。
在这些范围之外,公告牌的半透明性仍然被限制在最近的边界上。
verticalOrigin : Property|undefined
获取或设置指定
VerticalOrigin
.
-
Default Value:
VerticalOrigin.CENTER
width : Property|undefined
获取或设置数值的指定公告板的宽度(以像素为单位)。
如果未定义,则使用本机宽度。
Methods
clone(result) → BillboardGraphics
复制instance.
Name | Type | Description |
---|---|---|
result |
BillboardGraphics | optional 要在其上存储结果的对象。 |
Returns:
修改后的结果参数或者一个新实例(如果未提供)。
将此对象上每个未分配的属性分配给值
的 API 值。
Name | Type | Description |
---|---|---|
source |
BillboardGraphics | 要合并到此对象中的对象。 |
Type Definitions
BillboardGraphics 构造函数的初始化选项
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
show |
Property | boolean |
<optional> |
true | 一个布尔属性,用于指定公告板的可见性。 |
image |
Property | string | HTMLCanvasElement |
<optional> |
一个 Property,指定要用于公告板的 Image、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 的 Property。 |
verticalOrigin |
Property | VerticalOrigin |
<optional> |
VerticalOrigin.CENTER | 指定 VerticalOrigin 的 Property。 |
heightReference |
Property | HeightReference |
<optional> |
HeightReference.NONE | 指定高度相对于什么的 Property。 |
color |
Property | Color |
<optional> |
Color.WHITE | 指定图像的色调 Color 的属性。 |
rotation |
Property | number |
<optional> |
0 | 一个数字 Property,用于指定绕 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 属性,用于根据与摄像机的距离设置 pixelOffset。 |
|
imageSubRegion |
Property | BoundingRectangle |
<optional> |
一个指定 BoundingRectangle 的属性,该属性定义要用于广告牌的图像子区域,而不是整个图像,以从左下角开始的像素为单位。 |
|
distanceDisplayCondition |
Property | DistanceDisplayCondition |
<optional> |
一个属性,用于指定此公告牌将在距离摄像机多远处显示。 | |
disableDepthTestDistance |
Property | number |
<optional> |
一个属性,用于指定要禁用深度测试的相机的距离。 | |
splitDirection |
Property | SplitDirection |
<optional> |
指定公告牌的 SplitDirection 的 Property。 |