com.luciad.maps

Class Map.HeightProvider

java.lang.Object

com.luciad.maps.Map.HeightProvider

All Implemented Interfaces:

AutoCloseable

Enclosing class:

Map

public static final class Map.HeightProvider
extends Object
implements AutoCloseable

A height provider based on the map layers order and visibility.

This class is thread safe. Related article: Retrieving height data. Related article: Retrieving height data.

Since:

2023.0

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	finalize()
Double	retrieveHeightAt(Coordinate pixelCoordinate, boolean interpolate) Return an elevation value at a specified pixel that corresponds with what is visible on the map.

Methods inherited from class java.lang.Object

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

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

retrieveHeightAt

@Nullable
public Double retrieveHeightAt(@NotNull
                                         Coordinate pixelCoordinate,
                                         boolean interpolate)

Return an elevation value at a specified pixel that corresponds with what is visible on the map.

The ´Map::HeightProvider´ loops over all the visible elevation raster model loaded on the map in a top to bottom fashion in search for elevation data. It Looks for the first model with a tile in the underlying raster data covering the specified pixel point. The pixel density used for the retrieveHeightAt call is based on the camera position and pixel queried. if elevation data is found it will be returned in the map reference unit of measure, null otherwise.

Using interpolation makes sure that neighbouring height values form a smoother curve.

Remarks

this method is thread safe, you can call it from any thread.

Parameters:

pixelCoordinate - The pixel for which the height is requested. in device independent pixels coordinate.

interpolate - bilinear interpolation is used if true, nearest neighbour if false. Enabling bilinear interpolation results in a smoother curve for neighboring samples, at the cost of a minor performance decrease.

Returns:

the height expressed in the map reference unit of measure, or null if no data is available for this pixel coordinate.