Class: ElevationModel

ElevationModel()

Represents the elevations for an area, often but not necessarily the whole globe.

Constructor

new ElevationModel()

Constructs an elevation model.
Source:

Members

coverages :Array

The list of all elevation coverages usable by this model.
Type:
  • Array
Source:

Methods

addCoverage(coverage) → {Boolean}

Adds an elevation coverage to this elevation model and sorts the list. Duplicate coverages will be ignored.
Parameters:
Name Type Description
coverage The elevation coverage to add.
Source:
Throws:
ArgumentError if the specified elevation coverage is null.
Returns:
true if the ElevationCoverage as added; false if the coverage was a duplicate.
Type
Boolean

containsCoverage(coverage) → {Boolean}

Returns true if this ElevationModel contains the specified ElevationCoverage, and false otherwise.
Parameters:
Name Type Description
coverage the ElevationCoverage to test.
Source:
Throws:
ArgumentError if the ElevationCoverage is null.
Returns:
true if the ElevationCoverage is in this ElevationModel; false otherwise.
Type
Boolean

elevationAtLocation(latitude, longitude) → {Number}

Returns the elevation at a specified location.
Parameters:
Name Type Description
latitude Number The location's latitude in degrees.
longitude Number The location's longitude in degrees.
Source:
Returns:
The elevation at the specified location, in meters. Returns zero if the location is outside the coverage area of this model.
Type
Number

elevationsForGrid(sector, numLat, numLon, targetResolution, result) → {Number}

Returns the elevations at locations within a specified sector.
Parameters:
Name Type Description
sector Sector The sector for which to determine the elevations.
numLat Number The number of latitudinal sample locations within the sector.
numLon Number The number of longitudinal sample locations within the sector.
targetResolution Number The desired elevation resolution, in degrees. (To compute degrees from meters, divide the number of meters by the globe's radius to obtain radians and convert the result to degrees.)
result Array.<Number> An array in which to return the requested elevations.
Source:
Throws:
If the specified sector, targetResolution, or result array is null or undefined, or if either of the specified numLat or numLon values is less than one.
Type
ArgumentError
Returns:
The resolution actually achieved, which may be greater than that requested if the elevation data for the requested resolution is not currently available.
Type
Number

minAndMaxElevationsForSector(sector) → {Array.<Number>}

Returns the minimum and maximum elevations within a specified sector.
Parameters:
Name Type Description
sector Sector The sector for which to determine extreme elevations.
Source:
Throws:
If the specified sector is null or undefined.
Type
ArgumentError
Returns:
An array containing the minimum and maximum elevations within the specified sector. If no coverage can satisfy the request, a min and max of zero is returned.
Type
Array.<Number>

removeAllCoverages()

Removes all elevation coverages from this elevation model.
Source:

removeCoverage(coverage)

Removes a specific elevation coverage from this elevation model.
Parameters:
Name Type Description
coverage The elevation model to remove.
Source:
Throws:
ArgumentError if the specified elevation coverage is null.