agi.foundation.terrain

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

Class StkTerrainServer

java.lang.Object

agi.foundation.terrain.TerrainProvider

agi.foundation.terrain.QuantizedMeshTerrainProvider

agi.foundation.terrain.StkTerrainServer

public class StkTerrainServer
extends QuantizedMeshTerrainProvider

A terrain provider for reading terrain data from an STK Terrain Server, or any server that provides the STK Terrain Server Public REST API. This can be a server on the internet, your local network, or your local machine.

The terrain data used by this class is tile-based, in quantized-mesh format.

Constructor Summary

Constructors

Constructor and Description
StkTerrainServer() Initializes a new instance with the default values, which will connect to an AGI server for terrain data.
StkTerrainServer(Proxy proxy) Initializes a new instance, which will connect to an AGI server for terrain data.
StkTerrainServer(Proxy proxy, TerrainCacheGroup cacheGroup) Initializes a new instance, which will connect to an AGI server for terrain data.
StkTerrainServer(String baseUri, String tilesetName) Initializes a new instance as a member of the default TerrainCacheGroup, which will request tiles at the maximum available Tile Map Service zoom level.
StkTerrainServer(String baseUri, String tilesetName, int zoomLevel) Initializes a new instance as a member of the default TerrainCacheGroup.
StkTerrainServer(String baseUri, String tilesetName, int zoomLevel, Proxy proxy) Initializes a new instance as a member of the default TerrainCacheGroup.
StkTerrainServer(String baseUri, String tilesetName, int zoomLevel, TerrainCacheGroup cacheGroup) Initializes a new instance.
StkTerrainServer(String baseUri, String tilesetName, int zoomLevel, TerrainCacheGroup cacheGroup, Proxy proxy) Initializes a new instance.
StkTerrainServer(String baseUri, String tilesetName, Proxy proxy) Initializes a new instance as a member of the default TerrainCacheGroup, which will request tiles at the maximum available Tile Map Service zoom level.
StkTerrainServer(String baseUri, String tilesetName, TerrainCacheGroup cacheGroup) Initializes a new instance which will request tiles at the maximum available zoom level.
StkTerrainServer(String baseUri, String tilesetName, TerrainCacheGroup cacheGroup, Proxy proxy) Initializes a new instance which will request tiles at the maximum available zoom level.

Method Summary

Modifier and Type	Method and Description
QuantizedMeshTerrainTile	getMesh(int level, int x, int y) Gets a mesh for a specified set of coordinates.
String	getTilesetName() Gets the name of the tileset to read.

Methods inherited from class agi.foundation.terrain.QuantizedMeshTerrainProvider

extentToCoordinateExtent, findMostDetailedAvailableTile, getCache, getDefaultInterpolator, getFirstPartials, getFirstPartials, getHeight, getHeight, getHeightNativeUnits, getLocalMinimumSampleSpacing, getMaximumLevel, getMetadata, getMinimumSampleSpacing, getNumberOfXTilesAtLevel, getNumberOfYTilesAtLevel, getSecondPartials, getSecondPartials, getZoomLevel, isTileAvailable, latitudeToYTileCoordinate, longitudeToXTileCoordinate, preloadExtent, setDefaultInterpolator, setZoomLevel, tileCoordinatesToExtent, unloadExtent, validateTileCoordinates

Methods inherited from class agi.foundation.terrain.TerrainProvider

getBoundingExtent, getBoundingExtentNativeUnits, getGradient, getHeightReference, getHeightRelativeToShape, getHessian, getNativeToMeters, getNormal, getRadiansToNative, getReferenceSurface, getShape, getShapeFixedFrame, inGlobalBounds, setBoundingExtent, setBoundingExtentNativeUnits, setHeightReference, setNativeToMeters, setRadiansToNative, setReferenceSurface, setShape, setShapeFixedFrame

Methods inherited from class java.lang.Object

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

Constructor Detail

StkTerrainServer

public StkTerrainServer()

Initializes a new instance with the default values, which will connect to an AGI server for terrain data. This provider will be a member of the default TerrainCacheGroup, the TilesetName (get) will default to "world", and the provider will request tiles at the maximum zoom level.

Note that an internet connection is required to use this constructor successfully.

StkTerrainServer

public StkTerrainServer(@Nullable
                        Proxy proxy)

Initializes a new instance, which will connect to an AGI server for terrain data. This provider will be a member of the default TerrainCacheGroup, the TilesetName (get) will default to "world", and the provider will request tiles at the maximum zoom level.

Note that an internet connection is required to use this constructor successfully.

Parameters:

proxy - The proxy to use when connecting. Optional, default is null.

StkTerrainServer

public StkTerrainServer(@Nullable
                        Proxy proxy,
                        @Nonnull
                        TerrainCacheGroup cacheGroup)

Initializes a new instance, which will connect to an AGI server for terrain data. The TilesetName (get) will default to "world", and the provider will request tiles at the maximum zoom level.

Note that an internet connection is required to use this constructor successfully.

Parameters:

proxy - The proxy to use when connecting. Optional, default is null.

cacheGroup - The cache group of which this provider is a member.

Throws:

ArgumentNullException - Thrown when cacheGroup is null.

StkTerrainServer

public StkTerrainServer(@Nonnull
                        String baseUri,
                        @Nonnull
                        String tilesetName)

Initializes a new instance as a member of the default TerrainCacheGroup, which will request tiles at the maximum available Tile Map Service zoom level.

Parameters:

baseUri - The uri of the terrain server.

tilesetName - The name of the tileset to use.

Throws:

ArgumentNullException - Thrown when baseUri or tilesetName is null.

StkTerrainServer

public StkTerrainServer(@Nonnull
                        String baseUri,
                        @Nonnull
                        String tilesetName,
                        @Nullable
                        Proxy proxy)

Initializes a new instance as a member of the default TerrainCacheGroup, which will request tiles at the maximum available Tile Map Service zoom level.

Parameters:

baseUri - The uri of the terrain server.

tilesetName - The name of the tileset to use.

proxy - The proxy to use when connecting. Optional, default is null.

Throws:

ArgumentNullException - Thrown when baseUri or tilesetName is null.

StkTerrainServer

public StkTerrainServer(@Nonnull
                        String baseUri,
                        @Nonnull
                        String tilesetName,
                        int zoomLevel)

Initializes a new instance as a member of the default TerrainCacheGroup.

Parameters:

baseUri - The uri of the terrain server.

tilesetName - The name of the tileset to use.

zoomLevel - The Tile Map Service zoom level to request tiles at.

Throws:

ArgumentNullException - Thrown when baseUri or tilesetName is null.

StkTerrainServer

public StkTerrainServer(@Nonnull
                        String baseUri,
                        @Nonnull
                        String tilesetName,
                        int zoomLevel,
                        @Nullable
                        Proxy proxy)

Initializes a new instance as a member of the default TerrainCacheGroup.

Parameters:

baseUri - The uri of the terrain server.

tilesetName - The name of the tileset to use.

zoomLevel - The Tile Map Service zoom level to request tiles at.

proxy - The proxy to use when connecting. Optional, default is null.

Throws:

ArgumentNullException - Thrown when baseUri or tilesetName is null.

StkTerrainServer

public StkTerrainServer(@Nonnull
                        String baseUri,
                        @Nonnull
                        String tilesetName,
                        @Nonnull
                        TerrainCacheGroup cacheGroup)

Initializes a new instance which will request tiles at the maximum available zoom level.

Parameters:

baseUri - The uri of the terrain server.

tilesetName - The name of the tileset to use.

cacheGroup - The cache group of which this provider is a member.

Throws:

ArgumentNullException - Thrown when baseUri, tilesetName, or cacheGroup is null.

StkTerrainServer

public StkTerrainServer(@Nonnull
                        String baseUri,
                        @Nonnull
                        String tilesetName,
                        @Nonnull
                        TerrainCacheGroup cacheGroup,
                        @Nullable
                        Proxy proxy)

Initializes a new instance which will request tiles at the maximum available zoom level.

Parameters:

baseUri - The uri of the terrain server.

tilesetName - The name of the tileset to use.

cacheGroup - The cache group of which this provider is a member.

proxy - The proxy to use when connecting. Optional, default is null.

Throws:

ArgumentNullException - Thrown when baseUri, tilesetName, or cacheGroup is null.

StkTerrainServer

public StkTerrainServer(@Nonnull
                        String baseUri,
                        @Nonnull
                        String tilesetName,
                        int zoomLevel,
                        @Nonnull
                        TerrainCacheGroup cacheGroup)

Initializes a new instance.

Parameters:

baseUri - The uri of the terrain server.

tilesetName - The name of the tileset to use.

zoomLevel - The Tile Map Service zoom level to request tiles at.

cacheGroup - The cache group of which this provider is a member.

Throws:

ArgumentNullException - Thrown when baseUri, tilesetName, or cacheGroup is null.

StkTerrainServer

public StkTerrainServer(@Nonnull
                        String baseUri,
                        @Nonnull
                        String tilesetName,
                        int zoomLevel,
                        @Nonnull
                        TerrainCacheGroup cacheGroup,
                        @Nullable
                        Proxy proxy)

Initializes a new instance.

Parameters:

baseUri - The uri of the terrain server.

tilesetName - The name of the tileset to use.

zoomLevel - The Tile Map Service zoom level to request tiles at.

cacheGroup - The cache group of which this provider is a member.

proxy - The proxy to use when connecting. Optional, default is null.

Throws:

ArgumentNullException - Thrown when baseUri, tilesetName, or cacheGroup is null.

Method Detail

getMesh

public QuantizedMeshTerrainTile getMesh(int level,
                                        int x,
                                        int y)

Gets a mesh for a specified set of coordinates. This method is not expected to do any caching.

Specified by:

getMesh in class QuantizedMeshTerrainProvider

Parameters:

level - The zoom level.

x - The X tile coordinate.

y - The Y tile coordinate.

Returns:

The requested mesh.

Throws:

DataUnavailableException - Thrown when the requested tile does not exist.

ArgumentOutOfRangeException - Thrown when the tile coordinates are invalid.

getTilesetName

@Nonnull
public final String getTilesetName()

Gets the name of the tileset to read.