IGlobeOverlay#

class ansys.stk.core.graphics.IGlobeOverlay#

The base class of all terrain overlay and globe image overlay objects.

Overview#

central_body

Get the central body that the globe overlay is displayed on. It will return <see langword=’null’ /> if the globe overlay hasn’t been added to a central body.

extent

Get the cartographic extent that represents the area covered by the globe overlay. The array elements are arranged in the order west longitude, south latitude, east longitude, north latitude.

role

Get the globe overlay role of the globe overlay.

uri_as_string

Get the absolute URI specifying the location of the globe overlay.

is_valid

Get whether or not the overlay is valid. It can be invalid because of a missing file, corrupt file, unlicensed file, or a file on the incorrect central body.

display_condition

Get or set the display condition that controls whether or not the globe overlay is displayed.

Import detail#

from ansys.stk.core.graphics import IGlobeOverlay

Property detail#

property IGlobeOverlay.central_body: str#

Get the central body that the globe overlay is displayed on. It will return <see langword=’null’ /> if the globe overlay hasn’t been added to a central body.

property IGlobeOverlay.extent: list#

Get the cartographic extent that represents the area covered by the globe overlay. The array elements are arranged in the order west longitude, south latitude, east longitude, north latitude.

property IGlobeOverlay.role: OverlayRole#

Get the globe overlay role of the globe overlay.

property IGlobeOverlay.uri_as_string: str#

Get the absolute URI specifying the location of the globe overlay.

property IGlobeOverlay.is_valid: bool#

Get whether or not the overlay is valid. It can be invalid because of a missing file, corrupt file, unlicensed file, or a file on the incorrect central body.

property IGlobeOverlay.display_condition: IDisplayCondition#

Get or set the display condition that controls whether or not the globe overlay is displayed.