标签的可渲染集合。标签是位于3D场景中与视口对齐的文本。每个标签可以具有不同的字体,颜色,比例等。
标签示例
使用
标签示例
使用
LabelCollection#add
从集合中添加和删除标签和
LabelCollection#remove
。
Performance:
为获得最佳性能,建议您选择一些集合,每个集合带有多个标签,许多馆藏,每个馆藏只有几个标签。避免在某些地方收藏标签每帧都会改变,而其他帧则不会改变。而是创建一个或多个集合用于静态标签,一个或多个集合用于动态标签。
Name | Type | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
Object |
可选
具有以下属性的对象:
|
Example:
// Create a label collection with two labels
var labels = scene.primitives.add(new LSGlobe.LabelCollection());
labels.add({
position : new LSGlobe.Cartesian3(1.0, 2.0, 3.0),
text : 'A label'
});
labels.add({
position : new LSGlobe.Cartesian3(4.0, 5.0, 6.0),
text : 'Another label'
});
Demo:
See:
Members
blendOption : BlendOption
标签混合选项。默认值用于呈现不透明和半透明标签。但是,如果所有标签都是完全不透明的或全部都是半透明的,将技术设置为BlendOption.OPAQUE或BlendOption.TRANSLUCENT可以改善性能提高了2倍。
-
Default Value:
BlendOption.OPAQUE_AND_TRANSLUCENT
此属性仅用于调试。它不是用于生产用途,也不是经过优化的。
为图元中的每个绘制命令绘制边界球。
-
Default Value:
false
返回此集合中的标签数。这通常与
LabelCollection#get
遍历所有标签在集合中。
modelMatrix : Matrix4
4x4转换矩阵,用于将该集合中的每个标签从模型转换为世界坐标。如果这是单位矩阵,则会以世界坐标(即地球的WGS84坐标)绘制标签。可以通过提供不同的转换矩阵(如返回的矩阵)来使用局部参考系通过
Transforms.eastNorthUpToFixedFrame
。
-
Default Value:
Matrix4.IDENTITY
Example:
var center = LSGlobe.Cartesian3.fromDegrees(-75.59777, 40.03883);
labels.modelMatrix = LSGlobe.Transforms.eastNorthUpToFixedFrame(center);
labels.add({
position : new LSGlobe.Cartesian3(0.0, 0.0, 0.0),
text : 'Center'
});
labels.add({
position : new LSGlobe.Cartesian3(1000000.0, 0.0, 0.0),
text : 'East'
});
labels.add({
position : new LSGlobe.Cartesian3(0.0, 1000000.0, 0.0),
text : 'North'
});
labels.add({
position : new LSGlobe.Cartesian3(0.0, 0.0, 1000000.0),
text : 'Up'
});
Methods
add ( options ) → Label
创建具有指定初始属性的标签并将其添加到集合中。返回添加的标签,以便以后可以修改或从集合中删除它。
Performance:
调用
add
是预期的恒定时间。但是,集合的顶点缓冲区被重写;此操作是
O(n)
,并且还会产生CPU到GPU的开销。为了获得最佳效果,请在添加尽可能多的广告牌之前调用
update
。
Name | Type | Description |
---|---|---|
options
|
Object | 可选 描述标签属性的模板,如示例1所示。 |
Returns:
添加到集合的标签。
Throws:
-
DeveloperError :此对象已销毁,即调用destroy()。
Examples:
// Example 1: Add a label, specifying all the default values.
var l = labels.add({
show : true,
position : LSGlobe.Cartesian3.ZERO,
text : '',
font : '30px sans-serif',
fillColor : LSGlobe.Color.WHITE,
outlineColor : LSGlobe.Color.BLACK,
outlineWidth : 1.0,
showBackground : false,
backgroundColor : new LSGlobe.Color(0.165, 0.165, 0.165, 0.8),
backgroundPadding : new LSGlobe.Cartesian2(7, 5),
style : LSGlobe.LabelStyle.FILL,
pixelOffset : LSGlobe.Cartesian2.ZERO,
eyeOffset : LSGlobe.Cartesian3.ZERO,
horizontalOrigin : LSGlobe.HorizontalOrigin.LEFT,
verticalOrigin : LSGlobe.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 : LSGlobe.Cartesian3.fromRadians(longitude, latitude, height),
text : 'Hello World',
font : '24px Helvetica',
});
See:
检查此集合是否包含给定标签。
Name | Type | Description |
---|---|---|
label
|
Label | 要检查的标签。 |
Returns:
如果此集合包含标签,则为true,否则为false。
See:
销毁此对象拥有的WebGL资源。销毁对象可以确定性释放WebGL资源,而不是依赖垃圾回收器破坏此对象。
一旦物体被破坏,就不应使用。调用除
一旦物体被破坏,就不应使用。调用除
isDestroyed
将导致
DeveloperError
异常。因此,如示例中所述,将返回值(
undefined
)分配给对象。
Throws:
-
DeveloperError :此对象已销毁,即调用destroy()。
Example:
labels = labels && labels.destroy();
See:
get (index) → Label
返回指定索引处集合中的标签。指标从零开始并随着标签的添加而增加。移除标签后,所有标签都会移动它在左侧,更改了索引。此功能通常用于
LabelCollection#length
遍历所有标签在集合中。
Performance:
预计的固定时间。如果标签已从收藏夹中删除,并且没有调用
Scene#render
,这是一个隐式
O(n)
操作已执行。
Name | Type | Description |
---|---|---|
index
|
Number | 广告牌的从零开始的索引。 |
Returns:
指定索引处的标签。
Throws:
-
DeveloperError :此对象已销毁,即调用destroy()。
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;
}
See:
Returns:
如果该对象被破坏,则为true;否则为false。否则为假。
从集合中删除标签。移除后,标签将不再可用。
Performance:
调用
删除
是预期的固定时间。但是,集合的顶点缓冲区被重写-
O(n)
操作也会导致CPU到GPU的开销。对于为获得最佳性能,请在调用
update
之前删除尽可能多的标签。如果您打算暂时隐藏标签,通常可以更有效地调用
Label#show
而不是删除并重新添加标签。
Name | Type | Description |
---|---|---|
label
|
Label | 要删除的标签。 |
Returns:
真正
标签是否被移除;
假
如果在集合中找不到标签。
Throws:
-
DeveloperError :此对象已销毁,即调用destroy()。
Example:
var l = labels.add(...);
labels.remove(l); // Returns true
See:
从集合中删除所有标签。
Performance:
O(n)
。删除所有标签更有效从集合中添加新集合,而不是完全创建一个新集合。
Throws:
-
DeveloperError :此对象已销毁,即调用destroy()。
Example:
labels.add(...);
labels.add(...);
labels.removeAll();