agi.foundation.graphics

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

Class OpenStreetMapImageGlobeOverlay

java.lang.Object

agi.foundation.graphics.advanced.GlobeOverlay

agi.foundation.graphics.GlobeImageOverlay

agi.foundation.graphics.advanced.CustomImageGlobeOverlay

agi.foundation.graphics.OpenStreetMapImageGlobeOverlay

All Implemented Interfaces:

IDisposable, AutoCloseable

public final class OpenStreetMapImageGlobeOverlay
extends CustomImageGlobeOverlay

A CustomImageGlobeOverlay that uses data from an OpenStreetMap server.

See Also:

Web Imagery Overlays topic

Constructor Summary

Constructors

Constructor and Description
OpenStreetMapImageGlobeOverlay() Initializes a new instance, using the default server and the entire Earth's extent.
OpenStreetMapImageGlobeOverlay(CartographicExtent extent) Initializes an OpenStreetMapImageGlobeOverlay with the provided values.
OpenStreetMapImageGlobeOverlay(CartographicExtent extent, Proxy proxy) Initializes an OpenStreetMapImageGlobeOverlay with the provided values.
OpenStreetMapImageGlobeOverlay(Proxy proxy) Initializes a new instance, using the default server and the entire Earth's extent using the specified proxy.
OpenStreetMapImageGlobeOverlay(String server) Initializes an OpenStreetMapImageGlobeOverlay with the provided values.
OpenStreetMapImageGlobeOverlay(String server, CartographicExtent extent) Initializes an OpenStreetMapImageGlobeOverlay with the provided values.
OpenStreetMapImageGlobeOverlay(String server, CartographicExtent extent, Proxy proxy) Initializes an OpenStreetMapImageGlobeOverlay with the provided values.
OpenStreetMapImageGlobeOverlay(String server, Proxy proxy) Initializes an OpenStreetMapImageGlobeOverlay with the provided values.

Method Summary

Modifier and Type	Method and Description
Proxy	getProxy() Gets the proxy used for web requests.
URI	getUri() Gets the URI of the OpenStreetMap server.
boolean	read(CartographicExtent extent, Object userTileData, BufferedImage image) Reads a tile from the specified extent, scales it to and stores the result in image.

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

clearCache, dispose, getExtent, getIsTranslucent, getMaximumMetersPerPixel, getProjection, getTiler, reload, setExtent, setIsTranslucent, setMaximumMetersPerPixel, setProjection, setTiler, shutDown, shuttingDown, startingUp, startUp

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

OpenStreetMapImageGlobeOverlay

public OpenStreetMapImageGlobeOverlay()

Initializes a new instance, using the default server and the entire Earth's extent.

OpenStreetMapImageGlobeOverlay

public OpenStreetMapImageGlobeOverlay(Proxy proxy)

Initializes a new instance, using the default server and the entire Earth's extent using the specified proxy.

Parameters:

proxy - The proxy to use.

OpenStreetMapImageGlobeOverlay

public OpenStreetMapImageGlobeOverlay(CartographicExtent extent)

Initializes an OpenStreetMapImageGlobeOverlay with the provided values.

Parameters:

extent - The extent of the overlay.

OpenStreetMapImageGlobeOverlay

public OpenStreetMapImageGlobeOverlay(CartographicExtent extent,
                                      Proxy proxy)

Initializes an OpenStreetMapImageGlobeOverlay with the provided values.

Parameters:

extent - The CartographicExtent of the overlay.

proxy - The proxy to use.

OpenStreetMapImageGlobeOverlay

public OpenStreetMapImageGlobeOverlay(String server)

Initializes an OpenStreetMapImageGlobeOverlay with the provided values.

Parameters:

server - The server to use.

OpenStreetMapImageGlobeOverlay

public OpenStreetMapImageGlobeOverlay(String server,
                                      Proxy proxy)

Initializes an OpenStreetMapImageGlobeOverlay with the provided values.

Parameters:

server - The server to use.

proxy - The proxy to use.

OpenStreetMapImageGlobeOverlay

public OpenStreetMapImageGlobeOverlay(String server,
                                      CartographicExtent extent)

Initializes an OpenStreetMapImageGlobeOverlay with the provided values.

Parameters:

server - The server to use.

extent - The CartographicExtent of the overlay.

OpenStreetMapImageGlobeOverlay

public OpenStreetMapImageGlobeOverlay(String server,
                                      CartographicExtent extent,
                                      Proxy proxy)

Initializes an OpenStreetMapImageGlobeOverlay with the provided values.

Parameters:

server - The server to use.

extent - The CartographicExtent of the overlay.

proxy - The proxy to use.

Method Detail

read

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

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

Specified by:

read in class CustomImageGlobeOverlay

Parameters:

extent - The extent of the tile.

userTileData - User specified tile data for the tile. This will only be provided if Tiler (get / set) 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, false otherwise.

getProxy

public final Proxy getProxy()

Gets the proxy used for web requests.

getUri

public URI getUri()

Gets the URI of the OpenStreetMap server.

Overrides:

getUri in class CustomImageGlobeOverlay