agi.foundation.terrain

(agi.foundation.terrainreaders-2025r1.jar)

Class AGIWorldTerrain

java.lang.Object

agi.foundation.terrain.TerrainProvider

agi.foundation.terrain.RasterTerrainProvider

agi.foundation.terrain.AGIWorldTerrain

public class AGIWorldTerrain
extends RasterTerrainProvider

A terrain provider for reading terrain from AGI World Terrain (HDR) files.

Constructor Summary

Constructors

Constructor and Description
AGIWorldTerrain(FileStreamFactory fileStreamFactory) Initializes a new instance using specified FileStreamFactory.
AGIWorldTerrain(FileStreamFactory fileStreamFactory, TerrainCacheGroup cacheGroup) Initializes a new instance using specified FileStreamFactory and TerrainCacheGroup.
AGIWorldTerrain(String fileName) Initializes a new instance using the specified filename.
AGIWorldTerrain(String fileName, TerrainCacheGroup cacheGroup) Initializes a new instance using specified filename.

Method Summary

Modifier and Type	Method and Description
TerrainPosts	getPosts(RasterTerrainIndexExtent extent) Gets the posts over a specified area by reading them from the terrain data source.
protected void	processCoordinates(double[] longitude, double[] latitude) Performs any additional processing of coordinate values prior to using them to load sets of posts or for interpolating heights.

Methods inherited from class agi.foundation.terrain.RasterTerrainProvider

cartographicExtentToIndexExtent, getCache, getDefaultInterpolator, getDeltaLatitude, getDeltaLatitudeNativeUnits, getDeltaLongitude, getDeltaLongitudeNativeUnits, getEasternPostOffsetNativeUnits, getFirstPartials, getFirstPartials, getHeight, getHeight, getHeightNativeUnits, getHeightNativeUnits, getHeightRelativeToShape, getLatitudePosts, getLongitudePosts, getMinimumSampleSpacing, getNeedsSpecialCoordinateProcessing, getNorthernPostOffsetNativeUnits, getSecondPartials, getSecondPartials, getSouthernPostOffsetNativeUnits, getWesternPostOffsetNativeUnits, indexToLatitude, indexToLongitude, latitudeToIndex, longitudeToIndex, preloadExtent, setDefaultInterpolator, setDeltaLatitude, setDeltaLatitudeNativeUnits, setDeltaLongitude, setDeltaLongitudeNativeUnits, setEasternPostOffsetNativeUnits, setLatitudePosts, setLongitudePosts, setNeedsSpecialCoordinateProcessing, setNorthernPostOffsetNativeUnits, setSouthernPostOffsetNativeUnits, setWesternPostOffsetNativeUnits, unloadExtent

Methods inherited from class agi.foundation.terrain.TerrainProvider

getBoundingExtent, getBoundingExtentNativeUnits, getGradient, getHeightReference, getHeightRelativeToShape, getHessian, getLocalMinimumSampleSpacing, 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

AGIWorldTerrain

public AGIWorldTerrain(@Nonnull
                       String fileName)

Initializes a new instance using the specified filename.

Parameters:

fileName - The full path and filename of HDR file

Throws:

IllegalStateException - Thrown when the Earth (get) instance in the CalculationContext is not configured with a mean sea level (MSL).

ArgumentNullException - Thrown when fileName is null.

AGIWorldTerrain

public AGIWorldTerrain(@Nonnull
                       String fileName,
                       @Nonnull
                       TerrainCacheGroup cacheGroup)

Initializes a new instance using specified filename.

Parameters:

fileName - The full path and filename of the header file

cacheGroup - The cache group with which to associate this terrain provider.

Throws:

IllegalStateException - Thrown when the Earth (get) instance in the CalculationContext is not configured with a mean sea level (MSL).

ArgumentNullException - Thrown when fileName or cacheGroup is null.

AGIWorldTerrain

public AGIWorldTerrain(@Nonnull
                       FileStreamFactory fileStreamFactory)

Initializes a new instance using specified FileStreamFactory.

Parameters:

fileStreamFactory - The factory to use to create streams to read the terrain data.

Throws:

IllegalStateException - Thrown when the Earth (get) instance in the CalculationContext is not configured with a mean sea level (MSL).

ArgumentNullException - Thrown when fileStreamFactory is null.

AGIWorldTerrain

public AGIWorldTerrain(@Nonnull
                       FileStreamFactory fileStreamFactory,
                       @Nonnull
                       TerrainCacheGroup cacheGroup)

Initializes a new instance using specified FileStreamFactory and TerrainCacheGroup.

Parameters:

fileStreamFactory - The factory to use to create streams to read the terrain data.

cacheGroup - The cache group with which to associate this terrain provider.

Throws:

IllegalStateException - Thrown when the Earth (get) instance in the CalculationContext is not configured with a mean sea level (MSL).

ArgumentNullException - Thrown when fileStreamFactory or cacheGroup is null.

Method Detail

processCoordinates

protected void processCoordinates(@Nonnull
                                  double[] longitude,
                                  @Nonnull
                                  double[] latitude)

Performs any additional processing of coordinate values prior to using them to load sets of posts or for interpolating heights. This method is only called if RasterTerrainProvider.NeedsSpecialCoordinateProcessing is true.

Overrides:

processCoordinates in class RasterTerrainProvider

Parameters:

longitude - The longitude in the native units of the terrain provider.

latitude - The latitude in the native units of the terrain provider.

getPosts

public TerrainPosts getPosts(@Nonnull
                             RasterTerrainIndexExtent extent)

Gets the posts over a specified area by reading them from the terrain data source. This method is not expected to do any caching.

Specified by:

getPosts in class RasterTerrainProvider

Parameters:

extent - The extent of the posts to read.

Returns:

The requested posts.