Name | Type | Description |
---|---|---|
options
|
BillboardGraphics.ConstructorOptions | 描述初始化选项的 可选 对象 |
Members
alignedAxis : Property |undefined
获取或设置
Cartesian3
属性,指定固定框架中的单位矢量旋转轴。当设置为 Cartesian3.ZERO 时,旋转从屏幕顶部开始。
-
Default Value:
Cartesian3.ZERO
color : Property |undefined
获取或设置指定与
image
相乘的
Color
的属性。这有两个常见的用例。首先,许多不同的广告牌可以使用相同的白色纹理,每个广告牌都有不同的颜色,以创建彩色广告牌。其次,颜色的 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
的 Property。
-
Default Value:
HeightReference.NONE
horizontalOrigin : Property |undefined
获取或设置指定
HorizontalOrigin
的属性。
-
Default Value:
HorizontalOrigin.CENTER
image : Property |undefined
获取或设置指定要用于广告牌的图像、URI 或画布的属性。
imageSubRegion : Property |undefined
获取或设置指定
BoundingRectangle
的属性,该 BoundingRectangle 定义要用于广告牌的
image
子区域,而不是整个图像,以左下角的像素为单位。
pixelOffset : Property |undefined
获取或设置
广告牌的原点由黄点指示。
Cartesian2
属性,指定广告牌在屏幕空间中距此广告牌原点的像素偏移量。这通常用于在同一位置对齐多个广告牌和标签,例如图像和文本。屏幕空间原点是画布的左上角;
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
获取或设置数字属性,指定要应用于图像的统一比例。大于
上图中从左到右,比例分别为
1.0
的比例会放大广告牌,而小于
1.0
的比例会缩小广告牌。
上图中从左到右,比例分别为
0.5
、
1.0
和
2.0
。
-
Default Value:
1.0
scaleByDistance : Property |undefined
获取或设置
NearFarScalar
属性,根据与相机的距离指定广告牌的比例。当相机距离落在指定的
NearFarScalar#near
和
NearFarScalar#far
的上下限内时,广告牌的比例将在
NearFarScalar#nearValue
和
NearFarScalar#farValue
之间进行插值。在这些范围之外,广告牌的比例保持在最近的范围内。
show : Property |undefined
获取或设置指定广告牌可见性的布尔属性。
-
Default Value:
true
sizeInMeters : Property |undefined
获取或设置布尔属性,指定此广告牌的大小是否以米为单位。
-
Default Value:
false
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
复制此实例。
Name | Type | Description |
---|---|---|
result
|
BillboardGraphics | 可选 存储结果的对象。 |
Returns:
修改后的结果参数或新实例(如果未提供)。
将此对象上的每个未分配属性分配给提供的源对象上相同属性的值。
Name | Type | Description |
---|---|---|
source
|
BillboardGraphics | 要合并到此对象的对象。 |
Type Definitions
BillboardGraphics 构造函数的初始化选项
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
show
|
Property | boolean |
<optional>
|
true | 一个布尔属性,指定广告牌的可见性。 |
image
|
Property | string | HTMLCanvasElement |
<optional>
|
一个属性,指定用于广告牌的图像、URI 或画布。 | |
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
|
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>
|
一个属性,指定从相机到禁用深度测试的距离。 |