Cesium API - LabelCollection 中文文档

new Cesium.LabelCollection(options)

Scene/LabelCollection.js 536

标签的可渲染集合。标签是位于3D场景中与视口对齐的文本。每个标签可以具有不同的字体，颜色，比例等。

标签示例

使用LabelCollection#add和LabelCollection#remove从集合中添加和删除标签。

效率优化说明：

为了获取更好的性能，最好是创建较少的集合，每个集合有较多的标签，而不是较多的集合，每个集合中有较少的标签。 组织集合的时候，将有相同更新频率的标签放在一个集合，不更新的标签放在一个集合。

Name	Type	Description
options	Object	optional 具有下列属性的对象： Name Type Default Description modelMatrix Matrix4 Matrix4.IDENTITY optional 4x4转换矩阵，将每个标签从模型坐标转换为世界坐标。 debugShowBoundingVolume Boolean false optional 仅用于调试。确定是否显示此图元的包围球。 scene Scene optional 对于具有高度参考属性和进行深度测试的标签，必须传入此对象。 blendOption BlendOption BlendOption.OPAQUE_AND_TRANSLUCENT optional 标签混合选项。默认值用于渲染不透明和半透明的标签。但是，如果所有标签都完全不透明或全部完全透明，将技术设置为BlendOption.OPAQUE或BlendOption.TRANSLUCENT最多可以将性能提高2倍。

示例：

// 创建一个标签集合并添加两个标签。
var labels = scene.primitives.add(new Cesium.LabelCollection());
labels.add({
  position : new Cesium.Cartesian3(1.0, 2.0, 3.0),
  text : 'A label'
});
labels.add({
  position : new Cesium.Cartesian3(4.0, 5.0, 6.0),
  text : 'Another label'
});

演示Demo：

• Cesium Sandcastle Labels Demo

参考：

• LabelCollection#add
• LabelCollection#remove
• Label
• BillboardCollection

成员变量

Default Value: BlendOption.OPAQUE_AND_TRANSLUCENT

Default Value: false

Default Value: Matrix4.IDENTITY

示例：

var center = Cesium.Cartesian3.fromDegrees(-75.59777, 40.03883);
labels.modelMatrix = Cesium.Transforms.eastNorthUpToFixedFrame(center);
labels.add({
  position : new Cesium.Cartesian3(0.0, 0.0, 0.0),
  text     : 'Center'
});
labels.add({
  position : new Cesium.Cartesian3(1000000.0, 0.0, 0.0),
  text     : 'East'
});
labels.add({
  position : new Cesium.Cartesian3(0.0, 1000000.0, 0.0),
  text     : 'North'
});
labels.add({
  position : new Cesium.Cartesian3(0.0, 0.0, 1000000.0),
  text     : 'Up'
});

内置方法

调用add是预期的不变时间。 然而，集合的顶点缓冲区被重写；这个操作是O(n)，也会增加CPU到GPU的开销。 为了获得最佳性能，在调用update之前，请尽可能地添加标签。

• DeveloperError : 对象已销毁，即已经调用destroy（）。

示例：

// 例1：添加一个标签，指定所有的默认值。
var l = labels.add({
  show : true,
  position : Cesium.Cartesian3.ZERO,
  text : '',
  font : '30px sans-serif',
  fillColor : Cesium.Color.WHITE,
  outlineColor : Cesium.Color.BLACK,
  outlineWidth : 1.0,
  showBackground : false,
  backgroundColor : new Cesium.Color(0.165, 0.165, 0.165, 0.8),
  backgroundPadding : new Cesium.Cartesian2(7, 5),
  style : Cesium.LabelStyle.FILL,
  pixelOffset : Cesium.Cartesian2.ZERO,
  eyeOffset : Cesium.Cartesian3.ZERO,
  horizontalOrigin : Cesium.HorizontalOrigin.LEFT,
  verticalOrigin : Cesium.VerticalOrigin.BASELINE,
  scale : 1.0,
  translucencyByDistance : undefined,
  pixelOffsetScaleByDistance : undefined,
  heightReference : HeightReference.NONE,
  distanceDisplayCondition : undefined
});

// 例2：只指定标签的绘图位置、文本和字体。
var l = labels.add({
  position : Cesium.Cartesian3.fromRadians(longitude, latitude, height),
  text : 'Hello World',
  font : '24px Helvetica',
});

参考：

• LabelCollection#remove
• LabelCollection#removeAll

参考：

• LabelCollection#get

• DeveloperError : 对象已经被销毁。

示例：

labels = labels && labels.destroy();

参考：

• LabelCollection#isDestroyed

期望的不变时间。如果从集合中删除了标签，并且没有调用Scene#render，则执行隐式O(n)操作。

• DeveloperError : 对象已销毁，即已经调用destroy（）。

示例：

// 切换集合中每个标签的show属性
var len = labels.length;
for (var i = 0; i < len; ++i) {
  var l = billboards.get(i);
  l.show = !l.show;
}

参考：

• LabelCollection#length

参考：

• LabelCollection#destroy

如果您打算暂时隐藏标签，通常可以调用Label#show 而不是删除并重新添加标签。

• DeveloperError : 对象已销毁，即已经调用destroy（）。

示例：

var l = labels.add(...);
labels.remove(l);  // Returns true

参考：

• LabelCollection#add
• LabelCollection#removeAll
• Label#show

从集合中删除所有标签然后添加新标签比完全创建新集合效率更高。

• DeveloperError : 对象已销毁，即已经调用destroy（）。

示例：

labels.add(...);
labels.add(...);
labels.removeAll();

参考：

• LabelCollection#add
• LabelCollection#remove