BillboardCollection

可渲染的广告牌集合。公告牌是在3D场景中定位的视区对齐的图像。


示例广告牌


广告牌使用BillboardCollection#add和BillboardCollection#remove从集合中添加和删除。集合中的公告牌自动共享具有相同标识符的图像的纹理。
new BillboardCollection(options)
Parameters:
options (Object)
Name Description
options.modelMatrix
Matrix4
default Matrix4.IDENTITY 		4x4转换矩阵，将每个广告牌从模型转换为世界坐标。
options.debugShowBoundingVolume
Boolean
default false 		仅用于调试。确定是否显示此基元的命令的边界球。
options.scene
Scene
必须通过使用高度参考属性的广告牌，或将对地球仪进行深度测试。
options.blendOption
BlendOption
default BlendOption.OPAQUE_AND_TRANSLUCENT 		广告牌混合选项。默认设置用于渲染不透明和半透明的广告牌。但是，如果所有的广告牌都是完全不透明的或者都是完全半透明的，那么将该技术设置为blendoption.opaque或blendoption.transparent可以将性能提高2倍。
Example
// Create a billboard collection with two billboards
var billboards = scene.primitives.add(new bmgl.BillboardCollection());
billboards.add({
  position : new bmgl.Cartesian3(1.0, 2.0, 3.0),
  image : 'url/to/image'
});
billboards.add({
  position : new bmgl.Cartesian3(4.0, 5.0, 6.0),
  image : 'url/to/another/image'
});
See:

Members

blendOption : BlendOption

广告牌混合选项。默认设置用于渲染不透明和半透明的广告牌。但是，如果所有的广告牌都是完全不透明的或者都是完全半透明的，那么将该技术设置为blendoption.opaque或blendoption.transparent可以将性能提高2倍。
Default Value: BlendOption.OPAQUE_AND_TRANSLUCENT

debugShowBoundingVolume : Boolean

此属性仅用于调试；它既不用于生产，也不进行优化。

为基本体中的每个draw命令绘制边界球体。

Default Value: false

debugShowTextureAtlas : Boolean

此属性仅用于调试；它既不用于生产，也不进行优化。

将此布告栏集合的纹理图集绘制为全屏四边形。

Default Value: false

length : Number

返回此集合中公告牌的数目。这通常与BillboardCollection#get一起用于遍历集合中的所有公告牌。

modelMatrix : Matrix4

4x4转换矩阵，将此集合中的每个公告牌从模型坐标转换为世界坐标。当这是标识矩阵时，广告牌以世界坐标绘制，即地球的wgs84坐标。本地参考帧可以通过提供不同的转换矩阵来使用，如Transforms.eastNorthUpToFixedFrame返回的转换矩阵。
Default Value: Matrix4.IDENTITY
See:
Example:
var center = bmgl.Cartesian3.fromDegrees(-75.59777, 40.03883);
billboards.modelMatrix = bmgl.Transforms.eastNorthUpToFixedFrame(center);
billboards.add({
  image : 'url/to/image',
  position : new bmgl.Cartesian3(0.0, 0.0, 0.0) // center
});
billboards.add({
  image : 'url/to/image',
  position : new bmgl.Cartesian3(1000000.0, 0.0, 0.0) // east
});
billboards.add({
  image : 'url/to/image',
  position : new bmgl.Cartesian3(0.0, 1000000.0, 0.0) // north
});
billboards.add({
  image : 'url/to/image',
  position : new bmgl.Cartesian3(0.0, 0.0, 1000000.0) // up
});

Methods

add(options) → {Billboard}
创建具有指定初始属性的公告牌并将其添加到集合中。将返回添加的公告牌，以便以后可以对其进行修改或从集合中删除。
Parameters:
options (Object) 描述公告牌属性的模板，如示例1所示。
Examples
// Example 1:  Add a billboard, specifying all the default values.
var b = billboards.add({
  show : true,
  position : bmgl.Cartesian3.ZERO,
  pixelOffset : bmgl.Cartesian2.ZERO,
  eyeOffset : bmgl.Cartesian3.ZERO,
  heightReference : bmgl.HeightReference.NONE,
  horizontalOrigin : bmgl.HorizontalOrigin.CENTER,
  verticalOrigin : bmgl.VerticalOrigin.CENTER,
  scale : 1.0,
  image : 'url/to/image',
  imageSubRegion : undefined,
  color : bmgl.Color.WHITE,
  id : undefined,
  rotation : 0.0,
  alignedAxis : bmgl.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 : bmgl.Cartesian3.fromDegrees(longitude, latitude, height)
});
Throws
See:
contains(billboard) → {Boolean}
检查此集合是否包含给定的公告牌。
Parameters:
billboard (Billboard) 要检查的广告牌。
See:
destroy()
销毁此对象持有的WebGL资源。销毁对象允许确定地释放WebGL资源，而不是依赖垃圾收集器来销毁此对象。

一旦对象被破坏，就不应使用它；调用除isDestroyed以外的任何函数都将导致DeveloperError异常。因此，将返回值（undefined）赋给对象，如示例中所述。
Example
billboards = billboards && billboards.destroy();
Throws
See:
get(index) → {Billboard}
返回集合中指定索引处的公告牌。指数以零为基础，随着广告牌的增加而增加。移除一个广告牌后，所有的广告牌都会向左移动，从而改变它们的索引。此函数通常与BillboardCollection#length一起用于迭代集合中的所有公告牌。
Parameters:
index (Number) 广告牌的零基索引。
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;
}
Throws
See:
isDestroyed() → {Boolean}
如果此对象被破坏，则返回true；否则返回false。

如果此对象被破坏，则不应使用它；调用除isDestroyed以外的任何函数将导致DeveloperError异常。
See:
remove(billboard) → {Boolean}
从集合中删除公告牌。
Parameters:
billboard (Billboard) 要移除的广告牌。
Example
var b = billboards.add(...);
billboards.remove(b);  // Returns true
Throws
See:
removeAll()
从集合中删除所有公告牌。
Example
billboards.add(...);
billboards.add(...);
billboards.removeAll();
Throws
See:
update()
当Viewer或BMWidget渲染场景以获取渲染此原语所需的绘制命令时调用。

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

Throws