ImageCollection#

class ansys.stk.core.graphics.ImageCollection#: A collection of globe image overlay objects.

Overview#

Methods

`item`	Get the globe image overlay at the specified index.
`contains`	Check the presence of a globe image overlay in the collection.
`contains_uri_string`	Check the presence of a globe image overlay with the specified Uri in the collection.
`remove`	Remove a globe image overlay from the collection.
`clear`	Remove all globe image overlay objects from the collection.
`add`	Add imageryOverlay to the collection.
`add_async`	Add imageryOverlay to the collection asynchronously.
`index_of`	Get the index of the specified globe image overlay.
`index_of_uri_string`	Get the index of the globe image overlay with the specified Uri.
`add_uri_string`	Create a globe overlay from the uri, which represents a uri, and adds it to the collection.
`add_async_uri_string`	Create a globe image overlay from the uri, which represents a uri, and adds it to the collection asynchronously.
`swap`	Swap the position of two globe image overlay objects.
`swap_by_index`	Swap the position of two globe image overlay objects at the specified indices.
`move`	Move the globe image overlay to the specified position.
`move_by_index`	Move the globe image overlay at the specified index to the specified position.
`bring_to_front`	Brings the globe image overlay to the front of the collection so it is rendered first or on the bottom.
`send_to_back`	Send the globe image overlay to the back of the collection so it is rendered last or on the top.
`subscribe`	“””Return an IImageCollectionEventHandler that is subscribed to handle events associated with this instance of ImageCollection.”””

Properties

`count`	Get the number of globe overlay objects in the collection.
`is_read_only`	Get whether or not the collection is read only.
`_new_enum`	Construct an iterator that can be used to iterate the collection.

Import detail#

from ansys.stk.core.graphics import ImageCollection

Property detail#

property ImageCollection.count: int#: Get the number of globe overlay objects in the collection.

property ImageCollection.is_read_only: bool#: Get whether or not the collection is read only.

property ImageCollection._new_enum: EnumeratorProxy#: Construct an iterator that can be used to iterate the collection.

Method detail#

ImageCollection.item(self, index: int) → IGlobeImageOverlay#

Get the globe image overlay at the specified index.

Parameters:: index : int
Returns:: IGlobeImageOverlay

ImageCollection.contains(self, imagery_overlay: IGlobeImageOverlay) → bool#

Check the presence of a globe image overlay in the collection.

Parameters:: imagery_overlay : IGlobeImageOverlay
Returns:: bool

ImageCollection.contains_uri_string(self, string_uri: str) → bool#

Check the presence of a globe image overlay with the specified Uri in the collection.

Parameters:: string_uri : str
Returns:: bool

ImageCollection.remove(self, globe_overlay: IGlobeImageOverlay) → bool#

Remove a globe image overlay from the collection.

Parameters:: globe_overlay : IGlobeImageOverlay
Returns:: bool

ImageCollection.clear(self) → None#

Remove all globe image overlay objects from the collection.

Returns:: None

ImageCollection.add(self, imagery_overlay: IGlobeImageOverlay) → None#

Add imageryOverlay to the collection.

Parameters:: imagery_overlay : IGlobeImageOverlay
Returns:: None

ImageCollection.add_async(self, imagery_overlay: IGlobeImageOverlay) → None#

Add imageryOverlay to the collection asynchronously.

Parameters:: imagery_overlay : IGlobeImageOverlay
Returns:: None

ImageCollection.index_of(self, imagery_overlay: IGlobeImageOverlay) → int#

Get the index of the specified globe image overlay.

Parameters:: imagery_overlay : IGlobeImageOverlay
Returns:: int

ImageCollection.index_of_uri_string(self, string_uri: str) → int#

Get the index of the globe image overlay with the specified Uri.

Parameters:: string_uri : str
Returns:: int

ImageCollection.add_uri_string(self, uri: str) → IGlobeImageOverlay#

Create a globe overlay from the uri, which represents a uri, and adds it to the collection.

Parameters:: uri : str
Returns:: IGlobeImageOverlay

ImageCollection.add_async_uri_string(self, uri: str) → IGlobeImageOverlay#

Create a globe image overlay from the uri, which represents a uri, and adds it to the collection asynchronously.

Parameters:: uri : str
Returns:: IGlobeImageOverlay

ImageCollection.swap(self, imagery_overlay1: IGlobeImageOverlay, imagery_overlay2: IGlobeImageOverlay) → None#

Swap the position of two globe image overlay objects.

Parameters:

imagery_overlay1 : IGlobeImageOverlay

imagery_overlay2 : IGlobeImageOverlay

Returns:

None

ImageCollection.swap_by_index(self, index1: int, index2: int) → None#

Swap the position of two globe image overlay objects at the specified indices.

Parameters:

index1 : int

index2 : int

Returns:

None

ImageCollection.move(self, imagery_overlay: IGlobeImageOverlay, new_position: int) → None#

Move the globe image overlay to the specified position.

Parameters:

imagery_overlay : IGlobeImageOverlay

new_position : int

Returns:

None

ImageCollection.move_by_index(self, index: int, new_position: int) → None#

Move the globe image overlay at the specified index to the specified position.

Parameters:

index : int

new_position : int

Returns:

None

ImageCollection.bring_to_front(self, imagery_overlay: IGlobeImageOverlay) → None#

Brings the globe image overlay to the front of the collection so it is rendered first or on the bottom.

Parameters:: imagery_overlay : IGlobeImageOverlay
Returns:: None

ImageCollection.send_to_back(self, imagery_overlay: IGlobeImageOverlay) → None#

Send the globe image overlay to the back of the collection so it is rendered last or on the top.

Parameters:: imagery_overlay : IGlobeImageOverlay
Returns:: None