CustomImageGlobeOverlay#

class ansys.stk.core.graphics.CustomImageGlobeOverlay#

A globe image overlay that allows for a user defined image to be specified.

Overview#

Methods

`clear_cache`	Clear the image data cache associated with this instance. This is equivalent to deleting and re-adding the overlay.
`read`	Read a tile from the specified extent, scales it to and stores the result in image.
`reload`	Reload the image data associated with this instance. Preserves the current image data until new image data replaces it.
`shut_down`	Initiate shutdown when imagery is being removed from the globe.
`start_up`	Initiate start-up when imagery is being added to the globe.

Properties

`is_translucent`	Get whether the overlay contains translucent imagery.
`maximum_meters_per_pixel`	Get the maximum resolution of the inlay in meters per pixel.
`projection`	Get the map projection. Valid values are mercator and equidistant cylindrical.

from ansys.stk.core.graphics import CustomImageGlobeOverlay

property CustomImageGlobeOverlay.is_translucent: bool#: Get whether the overlay contains translucent imagery.

property CustomImageGlobeOverlay.maximum_meters_per_pixel: float#: Get the maximum resolution of the inlay in meters per pixel.

property CustomImageGlobeOverlay.projection: MapProjection#: Get the map projection. Valid values are mercator and equidistant cylindrical.

CustomImageGlobeOverlay.clear_cache(self) → None#

Clear the image data cache associated with this instance. This is equivalent to deleting and re-adding the overlay.

CustomImageGlobeOverlay.read(self, extent: list, user_tile_data: Any, image: IPictureDisp) → bool#

Read a tile from the specified extent, scales it to and stores the result in image.

Parameters:

extent : list

user_tile_data : Any

image : IPictureDisp

Returns:

bool

CustomImageGlobeOverlay.reload(self) → None#

Reload the image data associated with this instance. Preserves the current image data until new image data replaces it.

CustomImageGlobeOverlay.shut_down(self, scene: Scene) → None#

Initiate shutdown when imagery is being removed from the globe.

CustomImageGlobeOverlay.start_up(self, scene: Scene) → None#

Initiate start-up when imagery is being added to the globe.