IScreenOverlayCollectionBase#

class ansys.stk.core.graphics.IScreenOverlayCollectionBase#: The common base class for collections of overlays held by screen overlay and by screen overlay manager.

Overview#

Methods

`item`	Get the overlay at the specified index.
`contains`	Determine whether the collection contains a specific overlay.
`remove`	Remove the first occurrence of a specific overlay from the collection.
`clear`	Remove all overlays from the collection.
`add`	Add an overlay to the collection.

Properties

`count`	Get the number of screen overlays in the collection.
`is_read_only`	Get a value indicating whether the collection is read-only.
`_new_enum`	Return an enumerator that iterates through the collection.

from ansys.stk.core.graphics import IScreenOverlayCollectionBase

property IScreenOverlayCollectionBase.count: int#: Get the number of screen overlays in the collection.

property IScreenOverlayCollectionBase.is_read_only: bool#: Get a value indicating whether the collection is read-only.

property IScreenOverlayCollectionBase._new_enum: EnumeratorProxy#: Return an enumerator that iterates through the collection.

IScreenOverlayCollectionBase.item(self, index: int) → IScreenOverlay#

Get the overlay at the specified index.

IScreenOverlayCollectionBase.contains(self, item: IScreenOverlay) → bool#

Determine whether the collection contains a specific overlay.

IScreenOverlayCollectionBase.remove(self, item: IScreenOverlay) → bool#

Remove the first occurrence of a specific overlay from the collection.

IScreenOverlayCollectionBase.clear(self) → None#

Remove all overlays from the collection.

IScreenOverlayCollectionBase.add(self, item: IScreenOverlay) → None#

Add an overlay to the collection.