MapLink Terrain API

Detailed Description

This class category contains the Terrain .NET API classes.

Topics
	ViewShed Data Layer

Classes
class	Envitia::MapLink::Terrain::TSLNTerrainContour
class	Envitia::MapLink::Terrain::TSLNTerrainContourCallbacks
class	Envitia::MapLink::Terrain::TSLNTerrainContourVertex
class	Envitia::MapLink::Terrain::TSLNTerrainContourVertexList
class	Envitia::MapLink::Terrain::TSLNTerrainDatabase
class	Envitia::MapLink::Terrain::TSLNTerrainDatabaseLayer
struct	Envitia::MapLink::Terrain::TSLNTerrainDataItem
class	Envitia::MapLink::Terrain::TSLNTerrainTileDataItem
class	Envitia::MapLink::Terrain::TSLNTerrainViewShed
class	Envitia::MapLink::Terrain::TSLNTerrainViewShedData
enum class	Envitia::MapLink::Terrain::TSLNTerrainContourLineType { Envitia::MapLink::Terrain::TSLNTerrainContourLineType::TSLNTerrainContourLineTypeSimple , Envitia::MapLink::Terrain::TSLNTerrainContourLineType::TSLNTerrainContourLineTypeStandard , Envitia::MapLink::Terrain::TSLNTerrainContourLineType::TSLNTerrainContourLineTypeCONREC }
enum class	Envitia::MapLink::Terrain::TSLNTerrainData_LEVEL { Envitia::MapLink::Terrain::TSLNTerrainData_LEVEL::TSLNTerrainData_Min = 1 , Envitia::MapLink::Terrain::TSLNTerrainData_LEVEL::TSLNTerrainData_Nearest = 2 , Envitia::MapLink::Terrain::TSLNTerrainData_LEVEL::TSLNTerrainData_HorizontalRes = 4 , Envitia::MapLink::Terrain::TSLNTerrainData_LEVEL::TSLNTerrainData_All = ( 1 | 2 | 4 ) }
enum class	Envitia::MapLink::Terrain::TSLNTerrainData_SOURCE { Envitia::MapLink::Terrain::TSLNTerrainData_SOURCE::TSLNTerrainSource_DTED , Envitia::MapLink::Terrain::TSLNTerrainData_SOURCE::TSLNTerrainSource_DBDBV }
enum class	{ Envitia::MapLink::Terrain::@201321037116130333263074256311172243022302371022::TSLNTerrainFormat_SHORT , Envitia::MapLink::Terrain::@201321037116130333263074256311172243022302371022::TSLNTerrainFormat_LONG , Envitia::MapLink::Terrain::@201321037116130333263074256311172243022302371022::TSLNTerrainFormat_DOUBLE }
enum class	Envitia::MapLink::Terrain::TSLNTerrainInterpolate { Envitia::MapLink::Terrain::TSLNTerrainInterpolate::TSLNTerrainInterpolate_NONE , Envitia::MapLink::Terrain::TSLNTerrainInterpolate::TSLNTerrainInterpolate_LINEAR , Envitia::MapLink::Terrain::TSLNTerrainInterpolate::TSLNTerrainInterpolate_MIN , Envitia::MapLink::Terrain::TSLNTerrainInterpolate::TSLNTerrainInterpolate_MAX }

---

Class Documentation

Envitia::MapLink::Terrain::TSLNTerrainDataItem

struct Envitia::MapLink::Terrain::TSLNTerrainDataItem

Class Members
int	m_currency	Not currently implemented. Contains information on how up-to-date the source data used to read the height information is.
TSLNTerrainData_SOURCE	m_dataSource	Not currently implemented. Contains the data source that the height information came from.
double	m_horizontalAccuracy	Not currently implemented. Contains information on the horizontal accuracy of the height reading.
bool	m_isNull	Set to true if the height for the position is invalid. The m_z will be set to 0 if true. This data is always valid after a successful call to any of the query functions.
bool	m_nearestIsNull	Allows the caller to determine if the nearest data reading to the requested location is null or not. The nearest data reading is null if this flag is set. This data is only valid after a successful call to any of the query functions if the filter parameter has the TSLTerrainData_Nearest bit set.
double	m_nearestX	Returns the X position of the nearest actual data reading. This data is only valid after a successful call to any of the query functions if the filter parameter has the TSLTerrainData_Nearest bit set.
double	m_nearestY	Returns the Y position of the nearest actual data reading. This data is only valid after a successful call to any of the query functions if the filter parameter has the TSLTerrainData_Nearest bit set.
double	m_nearestZ	Returns the height of the nearest actual data reading. Only valid if m_ nearestIsNull is false. This data is only valid after a successful call to any of the query functions if the filter parameter has the TSLTerrainData_Nearest bit set.
unsigned short	m_status	Not currently implemented. Contains information on the status of the height reading.
double	m_verticalAccuracy	Not currently implemented. Contains information on the vertical accuracy of the height reading.
double	m_verticalResolution	Not currently implemented. Contains information on the vertical resolution of the height reading.
double	m_x	Data Members for Class Attributes. m_x, m_y detail the position the data within the structure pertains to. The units are the Map Units as created in MapLink Studio. This data is always valid after a successful call to any of the query functions.
double	m_xResolution	Contains information on the x resolution of the grid where the data was extracted from. This data is only valid after a successful call to any of the query functions if the filter parameter has the TSLTerrainData_HorizontalRes bit set.
double	m_y	m_x, m_y detail the position the data within the structure pertains to. The units are the Map Units as created in MapLink Studio. This data is always valid after a successful call to any of the query functions.
double	m_yResolution	Contains information on the y resolution of the grid where the data was extracted from. This data is only valid after a successful call to any of the query functions if the filter parameter has the TSLTerrainData_HorizontalRes bit set.
double	m_z	Contains the height information ranging from -32768 to 32767. The units depend upon the data within the terrain database but are generally in meters from mean sea level. This data is always valid after a successful call to any of the query functions.

Enumeration Type Documentation

anonymous enum

anonymous enum

strong

Enumeration that describes the different possible sizes of the data within the terrain database.

Possible values are:

TSLNTerrainFormat_SHORT: Each point in the database uses 2 bytes. TSLNTerrainFormat_LONG: Each point in the database uses 4 bytes. TSLNTerrainFormat_DOUBLE: Each point in the database uses 8 bytes.

Enumerator
TSLNTerrainFormat_SHORT
TSLNTerrainFormat_LONG
TSLNTerrainFormat_DOUBLE

TSLNTerrainContourLineType

enum class Envitia::MapLink::Terrain::TSLNTerrainContourLineType

strong

This enumeration lists the different types of contour algorithms that can be used. It contains the following values:

TSLNTerrainContourLineTypeSimple - Generates contour lines using the TIN algorithm. TSLNTerrainContourLineTypeStandard - As TSLContourTypeSimple but performs optimisation on the resulting lines to remove duplicate points TSLNTerrainContourLineTypeCONREC - Generates contour lines using the CONREC algorithm.

Deprecated

Deprecated as of MapLink 11.1.

Enumerator
TSLNTerrainContourLineTypeSimple
TSLNTerrainContourLineTypeStandard
TSLNTerrainContourLineTypeCONREC

TSLNTerrainData_LEVEL

enum class Envitia::MapLink::Terrain::TSLNTerrainData_LEVEL

strong

For functions that return terrain data, specifies how many fields within the TerrainDataItem structure are filled on return.

Enumerator
TSLNTerrainData_Min
TSLNTerrainData_Nearest
TSLNTerrainData_HorizontalRes
TSLNTerrainData_All

TSLNTerrainData_SOURCE

enum class Envitia::MapLink::Terrain::TSLNTerrainData_SOURCE

strong

Enumerate the different types of data sources that can be contained in the library.

Enumerator
TSLNTerrainSource_DTED
TSLNTerrainSource_DBDBV

TSLNTerrainInterpolate

enum class Envitia::MapLink::Terrain::TSLNTerrainInterpolate

strong

Enumeration that defines the possible types of interpolation that can be used when querying data from a terrain database.

The possible values are:

TSLNTerrainInterpolate_NONE: A nearest neighbour algorithm is used that returns the height of the point nearest the requested point. Very fast but less accurate.

TSLNTerrainInterpolate_LINEAR: Bilinear interpolation is used to calculate height value. More accurate but slightly slower than TSLNTerrainInterpolate_ NONE.

TSLNTerrainInterpolate_MIN: The The lowest neighbouring value is used. Very fast but rarely used due to inaccuracy.

TSLNTerrainInterpolate_MAX: The highest neighbouring value is used. Very fast but rarely used due to inaccuracy.

Enumerator
TSLNTerrainInterpolate_NONE
TSLNTerrainInterpolate_LINEAR
TSLNTerrainInterpolate_MIN
TSLNTerrainInterpolate_MAX