Click or drag to resize

StkTerrainServer Class

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.

Inheritance Hierarchy

Namespace:  AGI.Foundation.Terrain
Assembly:  AGI.Foundation.TerrainReaders (in AGI.Foundation.TerrainReaders.dll) Version: 19.5.402.0 (19.5.402.0)
Syntax
public class StkTerrainServer : TerrainProvider

The StkTerrainServer type exposes the following members.

Constructors
  NameDescription
Public methodStkTerrainServer
Initializes a new instance with the default values, which will connect to an Analytical Graphics Inc. server for terrain data. This provider is a member of Default, the TilesetName defaults to "world" and the provider will request tiles at the maximum zoom level.
Public methodStkTerrainServer(IWebProxy)
Initializes a new instance, which will connect to an Analytical Graphics Inc. server for terrain data. This provider is a member of Default, the TilesetName defaults to "world", and the provider will request tiles at the maximum zoom level.
Public methodStkTerrainServer(IWebProxy, TerrainCacheGroup)
Initializes a new instance, which will connect to an Analytical Graphics Inc. server for terrain data. The TilesetName defaults to "world" and the provider will request tiles at the maximum zoom level.
Public methodStkTerrainServer(String, String)
Initializes a new instance as a member of the default TerrainCacheGroup, which will request tiles at the maximum available Tile Map Service zoom level.
Public methodStkTerrainServer(String, String, TerrainCacheGroup)
Initializes a new instance which will request tiles at the maximum available zoom level.
Public methodStkTerrainServer(String, String, Int32)
Initializes a new instance as a member of the default TerrainCacheGroup.
Public methodStkTerrainServer(String, String, IWebProxy)
Initializes a new instance as a member of the default TerrainCacheGroup, which will request tiles at the maximum available Tile Map Service zoom level.
Public methodStkTerrainServer(String, String, TerrainCacheGroup, IWebProxy)
Initializes a new instance which will request tiles at the maximum available zoom level.
Public methodStkTerrainServer(String, String, Int32, TerrainCacheGroup)
Initializes a new instance.
Public methodStkTerrainServer(String, String, Int32, IWebProxy)
Initializes a new instance as a member of the default TerrainCacheGroup.
Public methodStkTerrainServer(String, String, Int32, TerrainCacheGroup, IWebProxy)
Initializes a new instance.
Top
Properties
  NameDescription
Public propertyBoundingExtent
Gets or sets the smallest rectangular extent that bounds the terrain provided by this terrain provider. The returned extent's edges are expressed in radians.
(Inherited from TerrainProvider.)
Public propertyBoundingExtentNativeUnits
Gets or sets the smallest rectangular extent that bounds the terrain provided by this terrain provider. The returned extent's edges are expressed in the native units of the terrain provider.
(Inherited from TerrainProvider.)
Public propertyCache
Gets the cache for this terrain provider.
Public propertyDefaultInterpolator
Gets or sets the default interpolator to use to interpolate heights from this terrain when a specific interpolator is not specified in the call to GetHeight(Double, Double) or GetHeightNativeUnits(Double, Double).
Public propertyHeightReference
Gets or sets an enumeration indicating whether the heights returned by the GetHeight(Double, Double) method are relative to the Shape or to the ReferenceSurface.
(Inherited from TerrainProvider.)
Public propertyMaximumLevel
Gets the max Tile Map Service zoom level.
Public propertyMinimumSampleSpacing
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 TerrainProviderMinimumSampleSpacing.)
Public propertyNativeToMeters
Gets or sets the value to multiply a height in the native units of the terrain provider to convert it to meters.
(Inherited from TerrainProvider.)
Public propertyRadiansToNative
Gets or sets the value to multiply an angle in radians by in order to convert it to the internal units of the terrain provider.
(Inherited from TerrainProvider.)
Public propertyReferenceSurface
Gets or sets the reference surface. The GetHeight(Double, Double) method returns heights relative to this reference surface. If this property is null, the heights are relative to the surface of the Shape ellipsoid instead.
(Inherited from TerrainProvider.)
Public propertyShape
Gets or sets the shape on which the longitude and latitude are defined. If ReferenceSurface is null, the heights returned by GetHeight(Double, Double) are relative to this ellipsoid as well.
(Inherited from TerrainProvider.)
Public propertyShapeFixedFrame
Gets or sets the reference frame fixed to the Shape in which the longitude and latitude are defined.
(Inherited from TerrainProvider.)
Public propertyTilesetName
Gets the name of the tileset to read.
Public propertyZoomLevel
Gets or sets the Tile Map Service zoom level to request tiles at. If the tile is unavailable at this level, the highest level available tile will be used instead.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExtentToCoordinateExtent
Gets a TileTerrainCoordinateExtent which contains a given CartographicExtent.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindMostDetailedAvailableTile
Find the most detailed tile that is available and which overlaps the given tile coordinates.
Public methodGetFirstPartials(Double, Double)
Get the partial derivatives of height with respect to the specified longitude and latitude relative to the provider's Shape.
(Overrides TerrainProviderGetFirstPartials(Double, Double).)
Public methodGetFirstPartials(Double, Double, TerrainInterpolatorQuantizedMeshTerrainTile)
Get the interpolated partial derivatives of height with respect to the specified longitude and latitude relative to the provider's Shape.
Public methodGetGradient

Get the interpolated gradient of height with respect to the terrain at the specified longitude and latitude relative to the provider's Shape. This method produces a vector representing the gradient of height in the ShapeFixedFrame.

Note: The direction for the gradient is defined for use as the outward facing surface normal direction. To obtain the directional derivative for the height (rate of change of height with respect to time), take the negative gradient and dot it with a unit vector along the desired azimuth (change in height with respect to distance), times the speed along that direction in meters/second.

The gradient, as defined above, is parallel to the upward facing terrain surface normal, but its magnitude indicates the rate of change in the height at that location.

(Inherited from TerrainProvider.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetHeight(Double, Double)
Gets the interpolated height of the terrain at the specified longitude and latitude using the default interpolator for this terrain provider.
(Overrides TerrainProviderGetHeight(Double, Double).)
Public methodGetHeight(Double, Double, TerrainInterpolatorQuantizedMeshTerrainTile)
Public methodGetHeightNativeUnits
Gets the interpolated height of the terrain at the specified longitude and latitude.
(Overrides TerrainProviderGetHeightNativeUnits(Double, Double).)
Public methodGetHeightRelativeToShape
Gets the interpolated height of the terrain at the specified longitude and latitude relative to the provider's Shape. This method takes into account the heights of any reference surfaces.
(Inherited from TerrainProvider.)
Public methodGetHessian

Get the interpolated hessian matrix based on the function of height with respect to the specified longitude and latitude relative to the provider's Shape. This method produces a matrix representing the mixed second order partial derivatives of height in the ShapeFixedFrame.

Note: The direction for the gradient and hessian is defined for use with the directional derivative on the surface. The gradient is defined to be orthogonal to the terrain surface with its surface projection in the direction of the greatest increase in the height. To obtain the second directional derivative for the height (acceleration of height along a particular azimuth), take the negative of the hessian then pre and post multiply it by the velocity vector along the desired azimuth. Then add the negative gradient dotted with the derivative of the velocity vector along the surface.

(Inherited from TerrainProvider.)
Public methodGetMesh
Gets a mesh for a specified set of coordinates by reading from the terrain server. This method is not expected to do any caching.
Public methodGetNormal
Get the normal vector to the terrain surface at the specified location.
(Inherited from TerrainProvider.)
Public methodStatic memberGetNumberOfXTilesAtLevel
Gets the number of tiles in the X direction at a given zoom level.
Public methodStatic memberGetNumberOfYTilesAtLevel
Gets the number of tiles in the Y direction at a given zoom level.
Public methodGetSecondPartials(Double, Double)
Get the second order (mixed) partial derivatives of height with respect to the specified longitude and latitude relative to the provider's Shape.
(Overrides TerrainProviderGetSecondPartials(Double, Double).)
Public methodGetSecondPartials(Double, Double, TerrainInterpolatorQuantizedMeshTerrainTile)
Get the second order (mixed) partial derivatives of height with respect to the specified longitude and latitude relative to the provider's Shape.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsTileAvailable
Determines whether a tile with the given tile coordinates is available.
Public methodStatic memberLatitudeToYTileCoordinate
Gets the Y tile coordinate for a given latitude.
Public methodStatic memberLongitudeToXTileCoordinate
Gets the X tile coordinate for a given longitude.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPreloadExtent
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'sMaximumSize. Furthermore, the loaded terrain data is locked in memory (meaning it will not be unloaded) until the user calls UnloadExtent(CartographicExtent). This method is safe to call from any thread.
(Overrides TerrainProviderPreloadExtent(CartographicExtent).)
Public methodStatic memberTileCoordinatesToExtent
Gets the bounding extent of a tile with the given tile coordinates.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnloadExtent
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.
(Overrides TerrainProviderUnloadExtent(CartographicExtent).)
Public methodStatic memberValidateTileCoordinates
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 on the server.
Top
See Also