agi.foundation.graphics.advanced

(agi.foundation.graphics-2025r1.jar)

Class CustomImageGlobeOverlay

java.lang.Object

agi.foundation.graphics.advanced.GlobeOverlay

agi.foundation.graphics.GlobeImageOverlay

agi.foundation.graphics.advanced.CustomImageGlobeOverlay

All Implemented Interfaces:

IDisposable, AutoCloseable

Direct Known Subclasses:

BingMapsForEnterpriseImageGlobeOverlay, OpenStreetMapImageGlobeOverlay

public abstract class CustomImageGlobeOverlay
extends GlobeImageOverlay
implements IDisposable

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

Constructor Summary

Constructors

Constructor and Description
CustomImageGlobeOverlay() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clears the image data cache associated with this instance.
protected void	dispose(boolean disposing)
CartographicExtent	getExtent() Gets the CartographicExtent that represents the area covered by the GlobeOverlay.
boolean	getIsTranslucent() Gets whether the overlay contains translucent imagery.
double	getMaximumMetersPerPixel() Gets the maximum resolution of the inlay in meters per pixel.
MapProjection	getProjection() Gets the map projection.
Tiler	getTiler() Gets a custom tiler, if the plugin requires it.
URI	getUri() Gets the URI, if applicable.
abstract boolean	read(CartographicExtent extent, Object userTileData, BufferedImage image) Reads a tile from the specified extent, scales it to and stores the result in image.
void	reload() Reloads the image data associated with this instance.
void	setExtent(CartographicExtent value) Gets the CartographicExtent that represents the area covered by the GlobeOverlay.
void	setIsTranslucent(boolean value) Gets whether the overlay contains translucent imagery.
void	setMaximumMetersPerPixel(double value) Gets the maximum resolution of the inlay in meters per pixel.
void	setProjection(MapProjection value) Gets the map projection.
void	setTiler(Tiler value) Sets a custom tiler, if the plugin requires it.
void	shutDown(Scene scene) Called automatically when imagery is being removed from the globe.
void	shuttingDown(Scene scene) Called by the base class when imagery is being removed from the globe.
void	startingUp(Scene scene) Called by the base class when imagery is being added to the globe.
void	startUp(Scene scene) Called automatically when imagery is being added to the globe.

Methods inherited from class agi.foundation.graphics.GlobeImageOverlay

getAltitudeBasedTranslucencyLowerAltitude, getAltitudeBasedTranslucencyLowerTranslucency, getAltitudeBasedTranslucencyUpperAltitude, getAltitudeBasedTranslucencyUpperTranslucency, getMoreThanOneImageGlobeOverlaySupported, getTranslucency, getUseAltitudeBasedTranslucency, setAltitudeBasedTranslucencyLowerAltitude, setAltitudeBasedTranslucencyLowerTranslucency, setAltitudeBasedTranslucencyUpperAltitude, setAltitudeBasedTranslucencyUpperTranslucency, setTranslucency, setUseAltitudeBasedTranslucency

Methods inherited from class agi.foundation.graphics.advanced.GlobeOverlay

dispose, getCentralBody, getDisplayCondition, getIsValid, getRole, getTag, setDisplayCondition, setTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface agi.foundation.compatibility.IDisposable

close, dispose

Constructor Detail

CustomImageGlobeOverlay

public CustomImageGlobeOverlay()

Initializes a new instance.

Method Detail

dispose

protected void dispose(boolean disposing)

Overrides:

dispose in class GlobeImageOverlay

getExtent

public CartographicExtent getExtent()

Gets the CartographicExtent that represents the area covered by the GlobeOverlay.

Overrides:

getExtent in class GlobeOverlay

setExtent

public void setExtent(CartographicExtent value)

Gets the CartographicExtent that represents the area covered by the GlobeOverlay.

Overrides:

setExtent in class GlobeOverlay

getTiler

public final Tiler getTiler()

Gets a custom tiler, if the plugin requires it. The tiler is used to control which extents are requested during a call to Read.

setTiler

public final void setTiler(Tiler value)

Sets a custom tiler, if the plugin requires it. The tiler is used to control which extents are requested during a call to Read.

getIsTranslucent

public final boolean getIsTranslucent()

Gets whether the overlay contains translucent imagery.

setIsTranslucent

public final void setIsTranslucent(boolean value)

Gets whether the overlay contains translucent imagery.

getMaximumMetersPerPixel

public final double getMaximumMetersPerPixel()

Gets the maximum resolution of the inlay in meters per pixel.

setMaximumMetersPerPixel

public final void setMaximumMetersPerPixel(double value)

Gets the maximum resolution of the inlay in meters per pixel.

getProjection

public final MapProjection getProjection()

Gets the map projection. Valid values are MapProjection.Mercator and MapProjection.EquidistantCylindical.

setProjection

public final void setProjection(MapProjection value)

Gets the map projection. Valid values are MapProjection.Mercator and MapProjection.EquidistantCylindical.

getUri

public URI getUri()

Gets the URI, if applicable. If not overridden in the derived class, this method returns GUID that is unique to this instance.

Overrides:

getUri in class GlobeOverlay

startUp

public final void startUp(Scene scene)

Called automatically when imagery is being added to the globe.

Parameters:

scene - The Scene the imagery is being added to.

startingUp

public void startingUp(Scene scene)

Called by the base class when imagery is being added to the globe.

Parameters:

scene - The Scene the imagery is being added to.

shutDown

public final void shutDown(Scene scene)

Called automatically when imagery is being removed from the globe.

Parameters:

scene - The Scene the imagery is being added to.

shuttingDown

public void shuttingDown(Scene scene)

Called by the base class when imagery is being removed from the globe.

Parameters:

scene - The Scene the imagery is being added to.

clearCache

public void clearCache()

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

reload

public void reload()

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

read

public abstract boolean read(CartographicExtent extent,
                             Object userTileData,
                             BufferedImage image)

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

Parameters:

extent - The extent of the tile.

userTileData - User specified tile data for the tile. This will only be provided if Tiler is not null.

image - A preallocated bitmap that the tile should be drawn to. Read should always overwrite the entire contents of the image.

Returns:

true if the read was successful; otherwise false.