LabelCollection

标签的可渲染集合。标签是定位在三维场景中的视区对齐文本。每个标签可以有不同的字体、颜色、比例等。


示例标签


使用LabelCollection#add和LabelCollection#remove从集合中添加和删除标签。
new LabelCollection(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 label collection with two labels
var labels = scene.primitives.add(new bmgl.LabelCollection());
labels.add({
  position : new bmgl.Cartesian3(1.0, 2.0, 3.0),
  text : 'A label'
});
labels.add({
  position : new bmgl.Cartesian3(4.0, 5.0, 6.0),
  text : 'Another label'
});
See:

Members

blendOption : BlendOption

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

debugShowBoundingVolume : Boolean

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

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

Default Value: false

length : Number

返回此集合中的标签数。这通常与LabelCollection#get一起用于迭代集合中的所有标签。

modelMatrix : Matrix4

将此集合中的每个标签从模型坐标转换为世界坐标的4x4转换矩阵。当这是单位矩阵时，标签以世界坐标绘制，即地球的wgs84坐标。本地参考帧可以通过提供不同的转换矩阵来使用，如Transforms.eastNorthUpToFixedFrame返回的转换矩阵。
Default Value: Matrix4.IDENTITY
Example:
var center = bmgl.Cartesian3.fromDegrees(-75.59777, 40.03883);
labels.modelMatrix = bmgl.Transforms.eastNorthUpToFixedFrame(center);
labels.add({
  position : new bmgl.Cartesian3(0.0, 0.0, 0.0),
  text     : 'Center'
});
labels.add({
  position : new bmgl.Cartesian3(1000000.0, 0.0, 0.0),
  text     : 'East'
});
labels.add({
  position : new bmgl.Cartesian3(0.0, 1000000.0, 0.0),
  text     : 'North'
});
labels.add({
  position : new bmgl.Cartesian3(0.0, 0.0, 1000000.0),
  text     : 'Up'
});

Methods

add(options) → {Label}
创建具有指定初始属性的标签并将其添加到集合中。将返回添加的标签，以便以后可以修改或从集合中删除它。
Parameters:
options (Object) 描述标签属性的模板，如示例1所示。
Examples
// Example 1:  Add a label, specifying all the default values.
var l = labels.add({
  show : true,
  position : bmgl.Cartesian3.ZERO,
  text : '',
  font : '30px sans-serif',
  fillColor : bmgl.Color.WHITE,
  outlineColor : bmgl.Color.BLACK,
  outlineWidth : 1.0,
  showBackground : false,
  backgroundColor : new bmgl.Color(0.165, 0.165, 0.165, 0.8),
  backgroundPadding : new bmgl.Cartesian2(7, 5),
  style : bmgl.LabelStyle.FILL,
  pixelOffset : bmgl.Cartesian2.ZERO,
  eyeOffset : bmgl.Cartesian3.ZERO,
  horizontalOrigin : bmgl.HorizontalOrigin.LEFT,
  verticalOrigin : bmgl.VerticalOrigin.BASELINE,
  scale : 1.0,
  translucencyByDistance : undefined,
  pixelOffsetScaleByDistance : undefined,
  heightReference : HeightReference.NONE,
  distanceDisplayCondition : undefined
});
// Example 2:  Specify only the label's cartographic position,
// text, and font.
var l = labels.add({
  position : bmgl.Cartesian3.fromRadians(longitude, latitude, height),
  text : 'Hello World',
  font : '24px Helvetica',
});
Throws
See:
contains(label) → {Boolean}
检查此集合是否包含给定标签。
Parameters:
label (Label) 要检查的标签。
See:
destroy()
销毁此对象持有的WebGL资源。销毁对象允许确定地释放WebGL资源，而不是依赖垃圾收集器来销毁此对象。

一旦对象被破坏，就不应使用它；调用除isDestroyed以外的任何函数都将导致DeveloperError异常。因此，将返回值（undefined）赋给对象，如示例中所述。
Example
labels = labels && labels.destroy();
Throws
See:
get(index) → {Label}
返回集合中指定索引处的标签。索引以零为基础，并随着标签的添加而增加。删除标签后，所有标签都会向左移动，从而更改其索引。此函数通常与LabelCollection#length一起使用，用于迭代集合中的所有标签。
Parameters:
index (Number) 广告牌的零基索引。
Example
// Toggle the show property of every label in the collection
var len = labels.length;
for (var i = 0; i < len; ++i) {
  var l = billboards.get(i);
  l.show = !l.show;
}
Throws
See:
isDestroyed() → {Boolean}
如果此对象被破坏，则返回true；否则返回false。

如果此对象被破坏，则不应使用它；调用除isDestroyed以外的任何函数将导致DeveloperError异常。
See:
remove(label) → {Boolean}
从集合中删除标签。一旦移除，标签就不再可用。
Parameters:
label (Label) 要删除的标签。
Example
var l = labels.add(...);
labels.remove(l);  // Returns true
Throws
See:
removeAll()
从集合中删除所有标签。
Example
labels.add(...);
labels.add(...);
labels.removeAll();
Throws
See: