原语的集合。最常用于
Scene#primitives
,
但PrimitiveCollection
本身也是原始的,所以收藏可以
添加到构成层次结构的集合中。Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | optional
具有以下属性的对象:
|
Example:
var billboards = new Cesium.BillboardCollection();
var labels = new Cesium.LabelCollection();
var collection = new Cesium.PrimitiveCollection();
collection.add(billboards);
scene.primitives.add(collection); // Add collection
scene.primitives.add(labels); // Add regular primitive
Members
确定集合中的基元在被移除时是否被销毁
PrimitiveCollection#destroy
或PrimitiveCollection#remove
或隐含
通过PrimitiveCollection#removeAll
。-
Default Value:
true
Examples:
// Example 1. Primitives are destroyed by default.
var primitives = new Cesium.PrimitiveCollection();
var labels = primitives.add(new Cesium.LabelCollection());
primitives = primitives.destroy();
var b = labels.isDestroyed(); // true
// Example 2. Do not destroy primitives in a collection.
var primitives = new Cesium.PrimitiveCollection();
primitives.destroyPrimitives = false;
var labels = primitives.add(new Cesium.LabelCollection());
primitives = primitives.destroy();
var b = labels.isDestroyed(); // false
labels = labels.destroy(); // explicitly destroy
获取集合中的基元数。
确定是否显示此集合中的基元。
-
Default Value:
true
Methods
向集合中添加基元。
Name | Type | Description |
---|---|---|
primitive |
Object | 要添加的原语。 |
index |
Number | optional 要在处添加层的索引。如果省略,原语将被添加到所有现有原语的底部。 |
Returns:
添加到集合中的基元。
Throws:
-
DeveloperError :此对象已销毁,即调用destroy()。
Example:
var billboards = scene.primitives.add(new Cesium.BillboardCollection());
确定此集合是否包含基元。
Name | Type | Description |
---|---|---|
primitive |
Object | optional 要检查的原语。 |
Returns:
如果基元在集合中,则为
true
;如果基元为undefined
或未在集合中找到,则为false
。Throws:
-
DeveloperError :此对象已销毁,即调用destroy()。
销毁此集合中每个基元所持有的WebGL资源。明确地销毁这个 集合允许确定地释放WebGL资源,而不是依赖于垃圾 收集器销毁此集合。 由于销毁集合会销毁包含的所有原语,因此只销毁集合 当您确定没有其他代码仍在使用所包含的任何原语时。 一旦此集合被销毁,就不应使用它;调用除
isDestroyed
将导致DeveloperError
异常。因此,
如示例所示,将返回值(undefined
)分配给对象。Throws:
-
DeveloperError :此对象已销毁,即调用destroy()。
Example:
primitives = primitives && primitives.destroy();
See:
返回集合中指定索引处的基元。
Name | Type | Description |
---|---|---|
index |
Number | 要返回的基元的从零开始的索引。 |
Returns:
index
的原始人。Throws:
-
DeveloperError :此对象已销毁,即调用destroy()。
Example:
// Toggle the show property of every primitive in the collection.
var primitives = scene.primitives;
var length = primitives.length;
for (var i = 0; i < length; ++i) {
var p = primitives.get(i);
p.show = !p.show;
}
See:
Returns:
如果此对象被销毁,则为True;否则为false。
在集合中降低一个原始的“向下一个”。如果绘制了集合中的所有基本体
在地球表面上,这在视觉上使原始体向下移动一个。
Name | Type | Description |
---|---|---|
primitive |
Object | optional 降低的原始值。 |
Throws:
-
DeveloperError :基元不在此集合中。
-
DeveloperError :此对象已销毁,即调用destroy()。
将原语降低到集合的“底部”。如果集合中的所有原语都已绘制
在地球表面上,这将视觉地将原始图元移动到底部。
Name | Type | Description |
---|---|---|
primitive |
Object | optional 最底层的原语。 |
Throws:
-
DeveloperError :基元不在此集合中。
-
DeveloperError :此对象已销毁,即调用destroy()。
在集合中引发一个基元“up one”。如果绘制了集合中的所有基本体
在地球表面上,这在视觉上使原始体向上移动一个。
Name | Type | Description |
---|---|---|
primitive |
Object | optional 要抚养的原始人。 |
Throws:
-
DeveloperError :基元不在此集合中。
-
DeveloperError :此对象已销毁,即调用destroy()。
将基元提升到集合的“顶部”。如果绘制了集合中的所有基本体
在地球表面上,这将在视觉上将基本体移动到顶部。
Name | Type | Description |
---|---|---|
primitive |
Object | optional 抬高顶部的原始体。 |
Throws:
-
DeveloperError :基元不在此集合中。
-
DeveloperError :此对象已销毁,即调用destroy()。
从集合中移除基本体。
Name | Type | Description |
---|---|---|
primitive |
Object | optional 要删除的原语。 |
Returns:
如果基元被移除,则为
true
;如果基元为undefined
或未在集合中找到,则为false
。Throws:
-
DeveloperError :此对象已销毁,即调用destroy()。
Example:
var billboards = scene.primitives.add(new Cesium.BillboardCollection());
scene.primitives.remove(billboards); // Returns true
See:
移除集合中的所有基元。
Throws:
-
DeveloperError :此对象已销毁,即调用destroy()。