Class PanoramaTilePrimitiveCollection

contains

• contains(primitive?): boolean

• Determines if this collection contains a primitive.

  Parameters

  • Optionalprimitive: any

    The primitive to check for.

  Returns boolean

  true if the primitive is in the collection; false if the primitive is undefined or was not found in the collection.

destroy

• destroy(): void

• Destroys the WebGL resources held by each primitive in this collection. Explicitly destroying this collection allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this collection.
  
  Since destroying a collection destroys all the contained primitives, only destroy a collection when you are sure no other code is still using any of the contained primitives.
  
  Once this collection is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

  Returns void

  Example

  primitives = primitives && primitives.destroy();
  Copy

get

• get(index): any

• Returns the primitive in the collection at the specified index.

  Parameters

  • index: number

    The zero-based index of the primitive to return.

  Returns any

  The primitive at the index.

  Example

  // Toggle the show property of every primitive in the collection.
  const primitives = scene.primitives;
  const length = primitives.length;
  for (let i = 0; i < length; ++i) {
    const p = primitives.get(i);
    p.show = !p.show;
  }
  Copy

isDestroyed

• isDestroyed(): boolean

• Returns true if this object was destroyed; otherwise, false.
  
  If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

  Returns boolean

  True if this object was destroyed; otherwise, false.

lower

• lower(primitive?): void

• Lowers a primitive "down one" in the collection. If all primitives in the collection are drawn on the globe surface, this visually moves the primitive down one.

  Parameters

  • Optionalprimitive: any

    The primitive to lower.

  Returns void

lowerToBottom

• lowerToBottom(primitive?): void

• Lowers a primitive to the "bottom" of the collection. If all primitives in the collection are drawn on the globe surface, this visually moves the primitive to the bottom.

  Parameters

  • Optionalprimitive: any

    The primitive to lower to the bottom.

  Returns void

raise

• raise(primitive?): void

• Raises a primitive "up one" in the collection. If all primitives in the collection are drawn on the globe surface, this visually moves the primitive up one.

  Parameters

  • Optionalprimitive: any

    The primitive to raise.

  Returns void

raiseToTop

• raiseToTop(primitive?): void

• Raises a primitive to the "top" of the collection. If all primitives in the collection are drawn on the globe surface, this visually moves the primitive to the top.

  Parameters

  • Optionalprimitive: any

    The primitive to raise the top.

  Returns void

remove

• remove(primitive?): boolean

• Removes a primitive from the collection.

  Parameters

  • Optionalprimitive: any

    The primitive to remove.

  Returns boolean

  true if the primitive was removed; false if the primitive is undefined or was not found in the collection.

  Example

  const billboards = scene.primitives.add(new Cesium.BillboardCollection());
  scene.primitives.remove(billboards);  // Returns true
  Copy

removeAll

• removeAll(): void

• Removes all primitives in the collection.

  Returns void

destroyPrimitives

// Example 1. Primitives are destroyed by default.
const primitives = new Cesium.PrimitiveCollection();
const labels = primitives.add(new Cesium.LabelCollection());
primitives = primitives.destroy();
const b = labels.isDestroyed(); // true
Copy

// Example 2. Do not destroy primitives in a collection.
const primitives = new Cesium.PrimitiveCollection();
primitives.destroyPrimitives = false;
const labels = primitives.add(new Cesium.LabelCollection());
primitives = primitives.destroy();
const b = labels.isDestroyed(); // false
labels = labels.destroy();    // explicitly destroy
Copy

Readonlylength

ReadonlyprimitiveAdded

ReadonlyprimitiveRemoved

show