QuantizedMeshTerrainProvider

java.lang.Object
- agi.foundation.terrain.TerrainProvider
- - agi.foundation.terrain.QuantizedMeshTerrainProvider

Direct Known Subclasses:

GeospatialContentServerTerrain, StkTerrainServer
```
public abstract class QuantizedMeshTerrainProvider
extends TerrainProvider
```
A TerrainProvider which reads data from a quadtree of quantized-mesh terrain tiles. See the quantized-mesh specification for more details on the quantized-mesh format.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`QuantizedMeshTerrainProvider(QuantizedMeshTilesetMetadata metadata)` Initializes a new instance as a member of the default `TerrainCacheGroup`.
`protected`	`QuantizedMeshTerrainProvider(QuantizedMeshTilesetMetadata metadata, TerrainCacheGroup cacheGroup)` Initializes a new instance.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`QuantizedMeshTileCoordinateExtent`	`extentToCoordinateExtent(int level, CartographicExtent extent)` Gets a `QuantizedMeshTileCoordinateExtent` which contains a given `CartographicExtent`.
`QuantizedMeshTileID`	`findMostDetailedAvailableTile(int level, int x, int y)` Find the most detailed tile that is available and which overlaps the given tile coordinates.
`QuantizedMeshTerrainCache`	`getCache()` Gets the cache for this terrain provider.
`TerrainInterpolator<QuantizedMeshTerrainTile>`	`getDefaultInterpolator()` Gets the default interpolator to use to interpolate heights when a specific interpolator is not specified in the call to `QuantizedMeshTerrainProvider.getHeight(double,double)` or `QuantizedMeshTerrainProvider.getHeightNativeUnits(double,double)`.
`FirstPartialsOfHeight`	`getFirstPartials(double longitude, double latitude)` Get the partial derivatives of height with respect to the specified longitude and latitude relative to the provider's `Shape` (`get` / `set`).
`FirstPartialsOfHeight`	`getFirstPartials(double longitude, double latitude, TerrainInterpolator<QuantizedMeshTerrainTile> interpolator)` Get the interpolated partial derivatives of height with respect to the specified longitude and latitude relative to the provider's `Shape` (`get` / `set`).
`double`	`getHeight(double longitude, double latitude)` Gets the interpolated height of the terrain at the specified longitude and latitude using the default interpolator for this terrain provider.
`double`	`getHeight(double longitude, double latitude, TerrainInterpolator<QuantizedMeshTerrainTile> interpolator)` Gets the interpolated height of the terrain at the specified longitude and latitude using the specified `TerrainInterpolator`.
`double`	`getHeightNativeUnits(double longitude, double latitude)` Gets the interpolated height of the terrain at the specified longitude and latitude.
`double`	`getLocalMinimumSampleSpacing(double longitude, double latitude)` Gets the smallest distance between the successive height samples of the terrain data, in radians, at the specified coordinates.
`int`	`getMaximumLevel()` Gets the maximum zoom level.
`abstract QuantizedMeshTerrainTile`	`getMesh(int level, int x, int y)` Gets a mesh for a specified set of coordinates.
`QuantizedMeshTilesetMetadata`	`getMetadata()` Gets the metadata for this tileset.
`double`	`getMinimumSampleSpacing()` Gets the smallest distance between the successive height samples of the terrain data, in radians.
`static int`	`getNumberOfXTilesAtLevel(int level)` Gets the number of tiles in the X direction at a given zoom level.
`static int`	`getNumberOfYTilesAtLevel(int level)` Gets the number of tiles in the Y direction at a given zoom level.
`SecondPartialsOfHeight`	`getSecondPartials(double longitude, double latitude)` Get the second order (mixed) partial derivatives of height with respect to the specified longitude and latitude relative to the provider's `Shape` (`get` / `set`).
`SecondPartialsOfHeight`	`getSecondPartials(double longitude, double latitude, TerrainInterpolator<QuantizedMeshTerrainTile> interpolator)` Get the second order (mixed) partial derivatives of height with respect to the specified longitude and latitude relative to the provider's `Shape` (`get` / `set`).
`int`	`getZoomLevel()` Gets the zoom level to request tiles at.
`boolean`	`isTileAvailable(int level, int x, int y)` Determines whether a tile with the given tile coordinates is available.
`static int`	`latitudeToYTileCoordinate(int level, double latitude)` Gets the Y tile coordinate for a given latitude.
`static int`	`longitudeToXTileCoordinate(int level, double longitude)` Gets the X tile coordinate for a given longitude.
`void`	`preloadExtent(CartographicExtent extent)` Loads the terrain data in a given `CartographicExtent` into the terrain cache.
`void`	`setDefaultInterpolator(TerrainInterpolator<QuantizedMeshTerrainTile> value)` Sets the default interpolator to use to interpolate heights when a specific interpolator is not specified in the call to `QuantizedMeshTerrainProvider.getHeight(double,double)` or `QuantizedMeshTerrainProvider.getHeightNativeUnits(double,double)`.
`void`	`setZoomLevel(int value)` Sets the zoom level to request tiles at.
`static CartographicExtent`	`tileCoordinatesToExtent(int level, int x, int y)` Gets the bounding extent of a tile with the given tile coordinates.
`void`	`unloadExtent(CartographicExtent extent)` Unloads the cached terrain data for a given `CartographicExtent`.
`static void`	`validateTileCoordinates(int level, int x, int y)` Determines whether the given tile coordinates are valid, that is, whether the coordinates define a tile that could possibly exist, and throws an `ArgumentOutOfRangeException` if one of the coordinates is invalid.

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
  - QuantizedMeshTerrainProvider
```
protected QuantizedMeshTerrainProvider(@Nonnull
                                       QuantizedMeshTilesetMetadata metadata)
```
    Initializes a new instance as a member of the default TerrainCacheGroup.
    
    Parameters:
    
    metadata - The metadata for the tileset.
  - QuantizedMeshTerrainProvider
```
protected QuantizedMeshTerrainProvider(@Nonnull
                                       QuantizedMeshTilesetMetadata metadata,
                                       @Nonnull
                                       TerrainCacheGroup cacheGroup)
```
    Initializes a new instance.
    
    Parameters:
    
    metadata - The metadata for the tileset.
    
    cacheGroup - The cache group of which this provider is a member.
    
    Throws:
    
    ArgumentNullException - Thrown when metadata or cacheGroup is null.
- Method Detail
  - getCache
```
@Nonnull
public final QuantizedMeshTerrainCache getCache()
```
    Gets the cache for this terrain provider.
  - getDefaultInterpolator
```
public final TerrainInterpolator<QuantizedMeshTerrainTile> getDefaultInterpolator()
```
    Gets the default interpolator to use to interpolate heights when a specific interpolator is not specified in the call to QuantizedMeshTerrainProvider.getHeight(double,double) or QuantizedMeshTerrainProvider.getHeightNativeUnits(double,double).
  - setDefaultInterpolator
```
public final void setDefaultInterpolator(TerrainInterpolator<QuantizedMeshTerrainTile> value)
```
    Sets the default interpolator to use to interpolate heights when a specific interpolator is not specified in the call to QuantizedMeshTerrainProvider.getHeight(double,double) or QuantizedMeshTerrainProvider.getHeightNativeUnits(double,double).
  - getMinimumSampleSpacing
```
public double getMinimumSampleSpacing()
```
    Gets the smallest distance between the successive height samples of the terrain data, in radians. If the return value is 0.0, then the minimum sample spacing is unknown.
    
    Overrides:
    
    getMinimumSampleSpacing in class TerrainProvider
  - getLocalMinimumSampleSpacing
```
public double getLocalMinimumSampleSpacing(double longitude,
                                           double latitude)
```
    Gets the smallest distance between the successive height samples of the terrain data, in radians, at the specified coordinates. If the return value is 0.0, then the minimum sample spacing is unknown.
    
    Overrides:
    
    getLocalMinimumSampleSpacing in class TerrainProvider
    
    Parameters:
    
    longitude - The longitude, in radians.
    
    latitude - The latitude, in radians.
    
    Returns:
    
    The smallest distance between the successive height samples of the terrain data, in radians.
  - getHeight
```
public double getHeight(double longitude,
                        double latitude)
```
    Gets the interpolated height of the terrain at the specified longitude and latitude using the default interpolator for this terrain provider.
    
    If HeightReference (get / set) is HeightReference.REFERENCE_SURFACE, the returned height is relative to the surface specified by the ReferenceSurface (get / set) property. If HeightReference (get / set) is HeightReference.SHAPE, the returned height is relative to the ellipsoid specified by the Shape (get / set) property. This method may return Double.NaN if the requested longitude and latitude are outside the terrain region or if the terrain data indicates that the height is unknown.
    
    It is safe to call this method from multiple threads simultaneously.
    
    Specified by:
    
    getHeight in class TerrainProvider
    
    Parameters:
    
    longitude - The longitude, in radians. Requesting a height for a longitude less than -π or greater than π will always return Double.NaN.
    
    latitude - The latitude, in radians. Requesting a height for a latitude less than -π/2 or greater than π/2 will always return Double.NaN.
    
    Returns:
    
    The height, in meters, or Double.NaN if the height is not available at the requested longitude and latitude.
  - getHeight
```
public final double getHeight(double longitude,
                              double latitude,
                              TerrainInterpolator<QuantizedMeshTerrainTile> interpolator)
```
    Gets the interpolated height of the terrain at the specified longitude and latitude using the specified TerrainInterpolator.
    
    The returned height is relative to the ellipsoid specified by the Shape (get / set) property. This method may return Double.NaN if the requested longitude and latitude are outside the terrain region or if the terrain data indicates that the height is unknown.
    
    It is safe to call this method from multiple threads simultaneously.
    
    Parameters:
    
    longitude - The longitude, in radians. Requesting a height for a longitude less than -π or greater than π will always return Double.NaN.
    
    latitude - The latitude, in radians. Requesting a height for a latitude less than -π/2 or greater than π/2 will always return Double.NaN.
    
    interpolator - The TerrainInterpolator to use to interpolate heights.
    
    Returns:
    
    The height, in meters, or Double.NaN if the height is not available at the requested longitude and latitude.
  - getHeightNativeUnits
```
public double getHeightNativeUnits(double longitude,
                                   double latitude)
```
    Gets the interpolated height of the terrain at the specified longitude and latitude.
    
    If HeightReference (get / set) is HeightReference.REFERENCE_SURFACE, the returned height is relative to the surface specified by the ReferenceSurface (get / set) property. If HeightReference (get / set) is HeightReference.SHAPE, the returned height is relative to the ellipsoid specified by the Shape (get / set) property. This method may return Double.NaN if the requested longitude and latitude are outside the terrain region or if the terrain data indicates that the height is unknown.
    
    It is safe to call this method from multiple threads simultaneously.
    
    Specified by:
    
    getHeightNativeUnits in class TerrainProvider
    
    Parameters:
    
    longitude - The longitude, in the native units of the terrain provider.
    
    latitude - The latitude, in the native units of the terrain provider.
    
    Returns:
    
    The height, in the native units of the terrain provider, or Double.NaN if the height is not available at the requested longitude and latitude.
  - getFirstPartials
```
@Nonnull
public FirstPartialsOfHeight getFirstPartials(double longitude,
                                                        double latitude)
```
    Get the partial derivatives of height with respect to the specified longitude and latitude relative to the provider's Shape (get / set).
    
    Specified by:
    
    getFirstPartials in class TerrainProvider
    
    Parameters:
    
    longitude - The longitude, in radians. Requesting derivatives for a longitude less than -π or greater than π will always return Double.NaN.
    
    latitude - The latitude, in radians. Requesting derivatives for a latitude less than -π/2 or greater than π/2 will always return Double.NaN.
    
    Returns:
    
    The FirstPartialsOfHeight with respect to longitude and latitude, in meters of height per radian.
  - getFirstPartials
```
@Nonnull
public final FirstPartialsOfHeight getFirstPartials(double longitude,
                                                              double latitude,
                                                              TerrainInterpolator<QuantizedMeshTerrainTile> interpolator)
```
    Get the interpolated partial derivatives of height with respect to the specified longitude and latitude relative to the provider's Shape (get / set).
    
    Parameters:
    
    longitude - The longitude, in radians. Requesting derivatives for a longitude less than -π or greater than π will always return Double.NaN.
    
    latitude - The latitude, in radians. Requesting derivatives for a latitude less than -π/2 or greater than π/2 will always return Double.NaN.
    
    interpolator - The interpolator to use when computing the value of the partial derivatives inside the boundary.
    
    Returns:
    
    The FirstPartialsOfHeight with respect to longitude and latitude, in meters of height per radian.
  - getSecondPartials
```
@Nonnull
public SecondPartialsOfHeight getSecondPartials(double longitude,
                                                          double latitude)
```
    Get the second order (mixed) partial derivatives of height with respect to the specified longitude and latitude relative to the provider's Shape (get / set).
    
    Specified by:
    
    getSecondPartials in class TerrainProvider
    
    Parameters:
    
    longitude - The longitude, in radians. Requesting derivatives for a longitude less than -π or greater than π will always return Double.NaN.
    
    latitude - The latitude, in radians. Requesting derivatives for a latitude less than -π/2 or greater than π/2 will always return Double.NaN.
    
    Returns:
    
    The SecondPartialsOfHeight with respect to longitude and latitude, in meters of height per radian squared.
  - getSecondPartials
```
@Nonnull
public final SecondPartialsOfHeight getSecondPartials(double longitude,
                                                                double latitude,
                                                                TerrainInterpolator<QuantizedMeshTerrainTile> interpolator)
```
    Get the second order (mixed) partial derivatives of height with respect to the specified longitude and latitude relative to the provider's Shape (get / set).
    
    Parameters:
    
    longitude - The longitude, in radians. Requesting derivatives for a longitude less than -π or greater than π will always return Double.NaN.
    
    latitude - The latitude, in radians. Requesting derivatives for a latitude less than -π/2 or greater than π/2 will always return Double.NaN.
    
    interpolator - The interpolator to use when computing the value of the partial derivatives inside the boundary.
    
    Returns:
    
    The SecondPartialsOfHeight with respect to longitude and latitude, in meters of height per radian squared.
  - getMesh
```
@Nonnull
public abstract 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.
    
    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.
  - findMostDetailedAvailableTile
```
@Nonnull
public final QuantizedMeshTileID findMostDetailedAvailableTile(int level,
                                                                         int x,
                                                                         int y)
```
    Find the most detailed tile that is available and which overlaps the given tile coordinates.
    
    Parameters:
    
    level - The zoom level.
    
    x - The X tile coordinate.
    
    y - The Y tile coordinate.
    
    Returns:
    
    The tile coordinates of the most detailed available tile.
    
    Throws:
    
    ArgumentOutOfRangeException - Thrown when the tile coordinates are invalid.
  - isTileAvailable
```
public final boolean isTileAvailable(int level,
                                     int x,
                                     int y)
```
    Determines whether a tile with the given tile coordinates is available.
    
    Parameters:
    
    level - The zoom level.
    
    x - The X tile coordinate.
    
    y - The Y tile coordinate.
    
    Returns:
    
    true if the given tile exists; otherwise false.
    
    Throws:
    
    ArgumentOutOfRangeException - Thrown when the tile coordinates are invalid.
  - validateTileCoordinates
```
public static void validateTileCoordinates(int level,
                                           int x,
                                           int y)
```
    Determines whether the given tile coordinates are valid, that is, whether the coordinates define a tile that could possibly exist, and throws an ArgumentOutOfRangeException if one of the coordinates is invalid. This method does not determine whether the tile actually exists.
    
    Parameters:
    
    level - The zoom level.
    
    x - The X tile coordinate.
    
    y - The Y tile coordinate.
    
    Throws:
    
    ArgumentOutOfRangeException - Thrown when the tile coordinates are invalid.
  - getNumberOfXTilesAtLevel
```
public static int getNumberOfXTilesAtLevel(int level)
```
    Gets the number of tiles in the X direction at a given zoom level.
    
    Parameters:
    
    level - The zoom level.
    
    Returns:
    
    The number of tiles in the X direction.
  - getNumberOfYTilesAtLevel
```
public static int getNumberOfYTilesAtLevel(int level)
```
    Gets the number of tiles in the Y direction at a given zoom level.
    
    Parameters:
    
    level - The zoom level.
    
    Returns:
    
    The number of tiles in the Y direction.
  - longitudeToXTileCoordinate
```
public static int longitudeToXTileCoordinate(int level,
                                             double longitude)
```
    Gets the X tile coordinate for a given longitude.
    The X coordinate increases from west to east. That is, the origin is in the south-west.
    
    Parameters:
    
    level - The zoom level.
    
    longitude - The longitude.
    
    Returns:
    
    The X tile coordinate of the tile that contains that longitude.
    
    Throws:
    
    ArgumentOutOfRangeException - Thrown when longitude is outside the range -π to π.
  - latitudeToYTileCoordinate
```
public static int latitudeToYTileCoordinate(int level,
                                            double latitude)
```
    Gets the Y tile coordinate for a given latitude.
    The Y coordinate increases from south to north. That is, the origin is in the south-west.
    
    Parameters:
    
    level - The zoom level.
    
    latitude - The latitude.
    
    Returns:
    
    The Y tile coordinate of the tile that contains that latitude.
    
    Throws:
    
    ArgumentOutOfRangeException - Thrown when latitude is outside the range -π/2 to π/2.
  - tileCoordinatesToExtent
```
@Nonnull
public static CartographicExtent tileCoordinatesToExtent(int level,
                                                                   int x,
                                                                   int y)
```
    Gets the bounding extent of a tile with the given tile coordinates.
    The X coordinate increases from west to east, and the Y coordinate increases from south to north. That is, the origin is in the south-west.
    
    Parameters:
    
    level - The zoom level.
    
    x - The X tile coordinate.
    
    y - The Y tile coordinate.
    
    Returns:
    
    The extent that bounds the given tile.
    
    Throws:
    
    ArgumentOutOfRangeException - Thrown when the tile coordinates are invalid.
  - extentToCoordinateExtent
```
@Nonnull
public final QuantizedMeshTileCoordinateExtent extentToCoordinateExtent(int level,
                                                                                  @Nonnull
                                                                                  CartographicExtent extent)
```
    Gets a QuantizedMeshTileCoordinateExtent which contains a given CartographicExtent.
    
    Parameters:
    
    level - The zoom level.
    
    extent - The extent.
    
    Returns:
    
    The QuantizedMeshTileCoordinateExtent of the smallest region within the bounding extent that contains the given CartographicExtent. If the extent is completely outside the bounding extent of the terrain, then OutsideExtent (get) will be returned. If the extent includes some regions outside the bounding extent of the terrain, the coordinates will be clamped to the terrain's edges.
    
    Throws:
    
    ArgumentNullException - Thrown when extent is null.
  - preloadExtent
```
public void preloadExtent(CartographicExtent extent)
```
    Loads the terrain data in a given CartographicExtent into the terrain cache. This method does not return until the terrain data is fully loaded. All terrain data within the extent is loaded into memory, even if doing so would exceed the TerrainCacheGroup's MaximumSize (get / set). Furthermore, the loaded terrain data is locked in memory (meaning it will not be unloaded) until the user calls QuantizedMeshTerrainProvider.unloadExtent(agi.foundation.coordinates.CartographicExtent). This method is safe to call from any thread.
    
    Specified by:
    
    preloadExtent in class TerrainProvider
    
    Parameters:
    
    extent - The extent for which to load terrain data, in radians.
    
    Throws:
    
    ArgumentNullException - Thrown when extent is null.
  - unloadExtent
```
public void unloadExtent(CartographicExtent extent)
```
    Unloads the cached terrain data for a given CartographicExtent. This method unloads all cached regions where any part of the region falls within the extent. It does not return until the regions have been unloaded. However, if a region within the extent is being used in another thread while this method is executing, the region may be reloaded immediately after this method unloads it. This method is safe to call from any thread.
    
    Specified by:
    
    unloadExtent in class TerrainProvider
    
    Parameters:
    
    extent - The CartographicExtent for which to unload terrain, in radians.
    
    Throws:
    
    ArgumentNullException - Thrown when extent is null.
  - getZoomLevel
```
public final int getZoomLevel()
```
    Gets the zoom level to request tiles at. If the tile is unavailable at this level, the highest level available tile will be used instead.
  - setZoomLevel
```
public final void setZoomLevel(int value)
```
    Sets the zoom level to request tiles at. If the tile is unavailable at this level, the highest level available tile will be used instead.
  - getMaximumLevel
```
public final int getMaximumLevel()
```
    Gets the maximum zoom level.
  - getMetadata
```
@Nonnull
public final QuantizedMeshTilesetMetadata getMetadata()
```
    Gets the metadata for this tileset.

Class QuantizedMeshTerrainProvider

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.terrain.TerrainProvider

Methods inherited from class java.lang.Object

Constructor Detail

QuantizedMeshTerrainProvider

Method Detail

getCache

getDefaultInterpolator

setDefaultInterpolator

getMinimumSampleSpacing

getLocalMinimumSampleSpacing

getHeight

getHeight

getHeightNativeUnits

getFirstPartials

getFirstPartials

getSecondPartials

getSecondPartials

getMesh

findMostDetailedAvailableTile

isTileAvailable

validateTileCoordinates

getNumberOfXTilesAtLevel

getNumberOfYTilesAtLevel

longitudeToXTileCoordinate

latitudeToYTileCoordinate

tileCoordinatesToExtent

extentToCoordinateExtent

preloadExtent

unloadExtent

getZoomLevel

setZoomLevel

getMaximumLevel

getMetadata