BillboardCollection

new Cesium.BillboardCollection ( options )

广告牌的可渲染集合。广告牌与视口对齐图像放置在3D场景中。


示例广告牌


使用 BillboardCollection#add 从集合中添加和删除广告牌和 BillboardCollection#remove 。集合中的广告牌自动共享纹理对于具有相同标识符的图像。
Performance:

为获得最佳性能,请选择一些集合,每个集合包含许多广告牌,许多馆藏,每个馆藏只有几个广告牌。组织收藏,以便广告牌具有相同更新频率的广告集位于同一集合中,即没有更改应集中在一个集合中;更改每个框架的广告牌应放在另一个框架中采集;等等。

Name Type Description
options Object 可选 具有以下属性的对象:
名称 类型 默认 说明
modelMatrix Matrix4 Matrix4.IDENTITY 可选 4x4转换矩阵,可将每个广告牌从模型转换为世界坐标。
debugShowBoundingVolume 布尔值 错误 可选 仅用于调试。确定是否显示该图元的命令的边界球。
场景 场景 可选 必须将使用高度参考属性的广告牌传递进去,否则将针对地球仪进行深度测试。
blendOption BlendOption BlendOption.OPAQUE_AND_TRANSLUCENT 可选 广告牌混合选项。默认值用于渲染不透明和半透明的广告牌。但是,如果所有广告牌都是完全不透明的或全部都是半透明的,将技术设置为BlendOption.OPAQUE或BlendOption.TRANSLUCENT最多可以将性能提高2倍。
Example:
// Create a billboard collection with two billboards
var billboards = scene.primitives.add(new Cesium.BillboardCollection());
billboards.add({
  position : new Cesium.Cartesian3(1.0, 2.0, 3.0),
  image : 'url/to/image'
});
billboards.add({
  position : new Cesium.Cartesian3(4.0, 5.0, 6.0),
  image : 'url/to/another/image'
});
Demo:
See:

Members

广告牌混合选项。默认值用于渲染不透明和半透明的广告牌。但是,如果所有广告牌都是完全不透明的或全部都是半透明的,将技术设置为BlendOption.OPAQUE或BlendOption.TRANSLUCENT可以改善性能提高了2倍。
Default Value: BlendOption.OPAQUE_AND_TRANSLUCENT

debugShowBoundingVolume : Boolean

此属性仅用于调试。它不是用于生产用途,也不是经过优化的。

为图元中的每个绘制命令绘制边界球。

Default Value: false

debugShowTextureAtlas : Boolean

此属性仅用于调试。它不是用于生产用途,也不是经过优化的。

将此BillboardCollection的纹理图集绘制为全屏方形。

Default Value: false
返回此集合中的广告牌数量。这通常与 BillboardCollection#get 遍历所有广告牌在集合中。
4x4转换矩阵,用于将该集合中的每个广告牌从模型坐标转换为世界坐标。如果这是单位矩阵,则以世界坐标(即地球的WGS84坐标)绘制广告牌。可以通过提供不同的转换矩阵(如返回的矩阵)来使用局部参考系通过 Transforms.eastNorthUpToFixedFrame
Default Value: Matrix4.IDENTITY
Example:
var center = Cesium.Cartesian3.fromDegrees(-75.59777, 40.03883);
billboards.modelMatrix = Cesium.Transforms.eastNorthUpToFixedFrame(center);
billboards.add({
  image : 'url/to/image',
  position : new Cesium.Cartesian3(0.0, 0.0, 0.0) // center
});
billboards.add({
  image : 'url/to/image',
  position : new Cesium.Cartesian3(1000000.0, 0.0, 0.0) // east
});
billboards.add({
  image : 'url/to/image',
  position : new Cesium.Cartesian3(0.0, 1000000.0, 0.0) // north
});
billboards.add({
  image : 'url/to/image',
  position : new Cesium.Cartesian3(0.0, 0.0, 1000000.0) // up
});
See:

Methods

创建具有指定初始属性的广告牌并将其添加到集合中。返回添加的广告牌,以便以后可以对其进行修改或从集合中删除它。
Performance:

调用 add 是预期的恒定时间。但是,集合的顶点缓冲区被重写- O(n) 操作也会导致CPU到GPU的开销。对于最佳性能,请在调用 update 之前添加尽可能多的广告牌。

Name Type Description
options Object 可选 描述广告牌属性的模板,如示例1所示。
Returns:
添加到集合中的广告牌。
Throws:
Examples:
// Example 1:  Add a billboard, specifying all the default values.
var b = billboards.add({
  show : true,
  position : Cesium.Cartesian3.ZERO,
  pixelOffset : Cesium.Cartesian2.ZERO,
  eyeOffset : Cesium.Cartesian3.ZERO,
  heightReference : Cesium.HeightReference.NONE,
  horizontalOrigin : Cesium.HorizontalOrigin.CENTER,
  verticalOrigin : Cesium.VerticalOrigin.CENTER,
  scale : 1.0,
  image : 'url/to/image',
  imageSubRegion : undefined,
  color : Cesium.Color.WHITE,
  id : undefined,
  rotation : 0.0,
  alignedAxis : Cesium.Cartesian3.ZERO,
  width : undefined,
  height : undefined,
  scaleByDistance : undefined,
  translucencyByDistance : undefined,
  pixelOffsetScaleByDistance : undefined,
  sizeInMeters : false,
  distanceDisplayCondition : undefined
});
// Example 2:  Specify only the billboard's cartographic position.
var b = billboards.add({
  position : Cesium.Cartesian3.fromDegrees(longitude, latitude, height)
});
See:

contains ( billboard ) Boolean

检查此集合是否包含给定的广告牌。
Name Type Description
billboard Billboard 可选 要检查的广告牌。
Returns:
如果此集合包含广告牌,则为true,否则为false。
See:
销毁此对象拥有的WebGL资源。销毁对象可以确定性释放WebGL资源,而不是依赖垃圾回收器破坏此对象。

一旦物体被破坏,就不应使用。调用除 isDestroyed 将导致 DeveloperError 异常。因此,如示例中所述,将返回值( undefined )分配给对象。
Throws:
Example:
billboards = billboards && billboards.destroy();
See:
以指定的索引返回集合中的广告牌。指标从零开始并随着广告牌的增加而增加。卸下广告牌后,所有广告牌都会移动它在左侧,更改了索引。此功能通常用于 BillboardCollection#length 遍历所有广告牌在集合中。
Performance:

预计的固定时间。如果广告牌已从集合中移除,并且没有调用 BillboardCollection#update ,这是一个隐式 O(n) 操作已执行。

Name Type Description
index Number 广告牌的从零开始的索引。
Returns:
指定索引处的广告牌。
Throws:
Example:
// Toggle the show property of every billboard in the collection
var len = billboards.length;
for (var i = 0; i < len; ++i) {
  var b = billboards.get(i);
  b.show = !b.show;
}
See:

isDestroyed () Boolean

如果此对象已销毁,则返回true;否则返回false。否则为假。

如果该对象被破坏,则不应使用。调用除 isDestroyed 将导致 DeveloperError 异常。
Returns:
真正 该物体是否被破坏;除此以外,
See:

remove (billboard) Boolean

从集合中移除广告牌。
Performance:

调用 删除 是预期的固定时间。但是,集合的顶点缓冲区被重写- O(n) 操作也会导致CPU到GPU的开销。对于为获得最佳性能,请在调用 update 之前删除尽可能多的广告牌。如果您打算暂时隐藏广告牌,通常可以更有效地致电 Billboard#show 而不是删除并重新添加广告牌。

Name Type Description
billboard Billboard 要删除的广告牌。
Returns:
真正 广告牌是否被移除; 如果在集合中未找到广告牌。
Throws:
Example:
var b = billboards.add(...);
billboards.remove(b);  // Returns true
See:
从集合中删除所有广告牌。
Performance:

O(n) 。删除所有广告牌效率更高从集合中添加新集合,而不是完全创建一个新集合。

Throws:
Example:
billboards.add(...);
billboards.add(...);
billboards.removeAll();
See:
Viewer CesiumWidget 渲染场景时调用至获取渲染该图元所需的绘制命令。

不要直接调用此函数。这只是为了列出渲染场景时可能传播的异常:

Throws: