BillboardCollection

Elusive 中文API文档

BillboardCollection

new Cesium.BillboardCollection ( options )
Scene/BillboardCollection.js 174

可渲染的广告牌集合。广告牌是视口对齐的位于3D场景中的图像。
示例广告牌
使用 BillboardCollection #add 在集合中添加和删除广告牌和 BillboardCollection #remove 。集合中的广告牌自动共享纹理对于具有相同标识符的图像。
Performance:

为了获得最佳性能，请选择一些集合，每个集合都有许多广告牌许多收藏品，每个只有几个广告牌。组织集合以便广告牌具有相同更新频率的是同一集合，即没有的广告牌改变应该在一个集合中;改变每一帧的广告牌应该在另一帧中采集;等等。

NameTypeDescription
optionsObject可选 具有以下属性的对象:
名称类型默认描述
modelMatrixMatrix4Matrix4.IDENTITY可选 4×4转换矩阵，用于将每个广告牌从模型转换为世界坐标。
debugShowBoundingVolume布尔false可选 仅用于调试。确定是否显示了这个原语的命令’bounding spheres。
scene场景可选 必须传入使用高度参考属性的广告牌或将对全球进行深度测试。
blendOptionBlendOptionBlendOption.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:
翻译by:http://cesium.xin

Members

blendOption : BlendOption
Scene/BillboardCollection.js 292

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

debugShowBoundingVolume : Boolean
Scene/BillboardCollection.js 282

此属性仅用于调试;它不是用于生产用途，也不是优化的。

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

Default Value: false

length : Number
Scene/BillboardCollection.js 349

返回此集合中的广告牌数量。这通常用于 BillboardCollection＃get 迭代所有广告牌在集合中。

modelMatrix : Matrix4
Scene/BillboardCollection.js 269

4×4转换矩阵，用于将此集合中的每个广告牌从模型转换为世界坐标。当这是单位矩阵时，广告牌以世界坐标绘制，即地球的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

add ( billboard ) → Billboard
Scene/BillboardCollection.js 467

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

调用 add 是预期的常量时间。但是，集合的顶点缓冲区被重写 – 一个 O（n） 操作，也会导致CPU到GPU的开销。对于最佳性能，在调用 update 之前添加尽可能多的广告牌。

NameTypeDescription
billboardObject可选 描述广告牌属性的模板，如示例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
Scene/BillboardCollection.js 574

检查此集合是否包含给定的广告牌。
NameTypeDescription
billboardBillboard可选 要检查的广告牌。
Returns:
如果此集合包含广告牌，则为true，否则为false。
See:

destroy ()
Scene/BillboardCollection.js 1896

销毁此对象持有的WebGL资源。销毁对象允许确定性释放WebGL资源，而不是依靠垃圾收集器来销毁这个对象。 一旦物体被摧毁，就不应该使用它;调用除以外的任何函数 isDestroyed 将导致 DeveloperError 异常。因此，将返回值（ undefined ）分配给对象，如示例中所示。
Throws:
Example:
billboards = billboards && billboards.destroy();
See:

get (index) → Billboard
Scene/BillboardCollection.js 605

返回指定索引处的集合中的广告牌。指数从零开始并随着广告牌的增加而增加。删除广告牌后会移动所有广告牌它向左，改变他们的指数。此功能通常用于 BillboardCollection #length 迭代所有广告牌在集合中。
Performance:

预期的恒定时间。如果广告牌从集合中删除了未调用 BillboardCollection＃update ，隐式 O（n） 执行操作。

NameTypeDescription
indexNumber广告牌的从零开始的索引。
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
Scene/BillboardCollection.js 1876

如果此对象被销毁，则返回true;否则，是的。 如果此对象被销毁，则不应使用它;调用除以外的任何函数 isDestroyed 将导致 DeveloperError 异常。
Returns:
返回真,如果这个物体被摧毁;除此以外,返回假      。
See:

remove (billboard) → Boolean
Scene/BillboardCollection.js 500

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

调用 remove 是预期的恒定时间。但是，集合的顶点缓冲区被重写 – 一个 O（n） 操作，也会导致CPU到GPU的开销。对于最佳性能，在调用 update 之前删除尽可能多的广告牌。如果您打算暂时隐藏广告牌，通常可以更有效地打电话 Billboard #show ，而不是删除和重新添加广告牌。

NameTypeDescription
billboardBillboard要删除的广告牌。
Returns:
返回真,如果广告牌被删除;返回假 ,如果在集合中找不到广告牌。
Throws:
Example:
var b = billboards.add(...);
billboards.remove(b);  // Returns true
See:

removeAll ()
Scene/BillboardCollection.js 529

从集合中删除所有广告牌。
Performance:

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

Throws:
Example:
billboards.add(...);
billboards.add(...);
billboards.removeAll();
See:

update ()
Scene/BillboardCollection.js 1435

当 Viewer 或 CesiumWidget 呈现场景时调用至获取渲染此基元所需的绘制命令。

不要直接调用此功能。这是记录到的列出渲染场景时可能传播的异常:

Throws:
Documentation generated by JSDoc 3.5.5 翻译:http://cesium.xin

发表评论