LabelCollection

new Cesium.LabelCollection(options)

engine/Source/Scene/LabelCollection.js 584

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

示例标签

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

Performance:

为了获得最佳性能，请首选几个集合(每个集合都有许多标签)到 许多集合，每个集合只有几个标签。 避免使用某些 标签每帧都会更改，而其他标签则不会;相反，请创建一个或多个集合 表示静态标签，一个或多个集合表示动态标签。

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 倍。 show boolean true optional 确定是否显示集合中的标签。

Example:

// Create a label collection with two labels
const 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

See:

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

Members

Default Value: BlendOption.OPAQUE_AND_TRANSLUCENT

Default Value: false

Default Value: Matrix4.IDENTITY

Example:

const 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'
});

Default Value: true

Methods

Performance:

调用 add 是预期的常数时间。 但是，集合的顶点缓冲区 被重写;此操作为 O(n) 并且还会 CPU 到 GPU 的开销。 为了获得最佳性能，请在之前添加尽可能多的广告牌 调用 Update。

Returns:

Throws:

• DeveloperError : 这个物体被摧毁了,destroy().

Examples:

// Example 1:  Add a label, specifying all the default values.
const 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
});

// Example 2:  Specify only the label's cartographic position,
// text, and font.
const l = labels.add({
  position : Cesium.Cartesian3.fromRadians(longitude, latitude, height),
  text : 'Hello World',
  font : '24px Helvetica',
});

See:

• LabelCollection#remove
• LabelCollection#removeAll

Returns:

See:

• LabelCollection#get

Throws:

• DeveloperError : 这个物体被摧毁了,destroy().

Example:

labels = labels && labels.destroy();

See:

• LabelCollection#isDestroyed

Performance:

预期恒定时间。 如果从集合中删除了标签，并且 Scene#render 未调用，则隐式 O(n) 执行操作。

Returns:

Throws:

• DeveloperError : 这个物体被摧毁了,destroy().

Example:

// Toggle the show property of every label in the collection
const len = labels.length;
for (let i = 0; i < len; ++i) {
  const l = billboards.get(i);
  l.show = !l.show;
}

See:

• LabelCollection#length

Returns:

See:

• LabelCollection#destroy

Performance:

调用 remove 是预期的常数时间。 但是，集合的顶点缓冲区 被重写 - 一个O(n) 操作，也会产生 CPU 到 GPU 的开销。 为 最佳性能，在调用 update 之前删除尽可能多的标签。 如果您打算暂时隐藏标签，通常调用 Label#show 而不是删除并重新添加标签。

Returns:

Throws:

• DeveloperError : 这个物体被摧毁了,destroy().

Example:

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

See:

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

Performance:

O(n) 删除所有标签更有效 从集合中，然后添加新的集合，而不是完全创建一个新集合。

Throws:

• DeveloperError : 这个物体被摧毁了,destroy().

Example:

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

See:

• LabelCollection#add
• LabelCollection#remove