agi.foundation.terrain

(agi.foundation.terrainreaders-2024r2.jar)

Class TerrainPostsUInt16

java.lang.Object

agi.foundation.terrain.TerrainPosts

agi.foundation.terrain.TerrainPostsUInt16

public class TerrainPostsUInt16
extends TerrainPosts

A collection of posts from a RasterTerrainProvider where each post is stored as an ushort.

Constructor Summary

Constructors

Constructor and Description
TerrainPostsUInt16(RasterTerrainProvider provider, RasterTerrainIndexExtent indexExtent, int voidValue) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
int	get(int longitudeIndex, int latitudeIndex) Gets the post height at a particular set of indices.
void	getFourPostHeights(int west, int south, int east, int north, double[] southWest, double[] southEast, double[] northEast, double[] northWest) Gets the heights of four posts, specified by index.
double	getPostHeight(int longitudeIndex, int latitudeIndex) Gets the height at a post.
long	getSize() Gets the size of the post data, in bytes.
int	getVoidValue() Gets the integer value that indicates a void (or post with unknown height).
void	set(int longitudeIndex, int latitudeIndex, int value) Sets the post height at a particular set of indices.

Methods inherited from class agi.foundation.terrain.TerrainPosts

getBoundingExtent, getFourSurroundingPosts, getIndexExtent, getTerrainProvider, indexToLatitude, indexToLongitude, latitudeToIndex, longitudeToIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

TerrainPostsUInt16

public TerrainPostsUInt16(RasterTerrainProvider provider,
                          @Nonnull
                          RasterTerrainIndexExtent indexExtent,
                          int voidValue)

Initializes a new instance.

Parameters:

provider - The terrain provider that provided this collection of posts.

indexExtent - The extent of indices of this instance in the overall terrain provider.

voidValue - The value that indicates a void (or post with unknown height).

Method Detail

getFourPostHeights

public void getFourPostHeights(int west,
                               int south,
                               int east,
                               int north,
                               @Nonnull
                               double[] southWest,
                               @Nonnull
                               double[] southEast,
                               @Nonnull
                               double[] northEast,
                               @Nonnull
                               double[] northWest)

Gets the heights of four posts, specified by index.

Specified by:

getFourPostHeights in class TerrainPosts

Parameters:

west - The index of the two western posts. 0 refers to western-most post stored by this instance.

south - The index of the two southern posts. 0 refers to southern-most post stored by this instance.

east - The index of the two eastern posts. 0 refers to western-most post stored by this instance.

north - The index of the two northern posts. 0 refers to southern-most post stored by this instance.

southWest - On input, an array with one element. On return, the array is populated with the height of the southwest post, in the native units of the terrain provider.

southEast - On input, an array with one element. On return, the array is populated with the height of the southeast post, in the native units of the terrain provider.

northEast - On input, an array with one element. On return, the array is populated with the height of the northeast post, in the native units of the terrain provider.

northWest - On input, an array with one element. On return, the array is populated with the height of the northwest post, in the native units of the terrain provider.

Throws:

IndexOutOfBoundsException - Thrown when an index is outside the extent of this collection of posts.

get

public final int get(int longitudeIndex,
                     int latitudeIndex)

Gets the post height at a particular set of indices.

Parameters:

longitudeIndex - The longitude index of the post. 0 refers to the western-most post stored by this instance.

latitudeIndex - The latitude index of the post. 0 refers to the southern-most post stored by this instance.

Returns:

The height of the post, in the native units of the terrain provider.

set

public final void set(int longitudeIndex,
                      int latitudeIndex,
                      int value)

Sets the post height at a particular set of indices.

Parameters:

longitudeIndex - The longitude index of the post. 0 refers to the western-most post stored by this instance.

latitudeIndex - The latitude index of the post. 0 refers to the southern-most post stored by this instance.

getVoidValue

public final int getVoidValue()

Gets the integer value that indicates a void (or post with unknown height).

getSize

public long getSize()

Gets the size of the post data, in bytes.

Specified by:

getSize in class TerrainPosts

getPostHeight

public double getPostHeight(int longitudeIndex,
                            int latitudeIndex)

Gets the height at a post.

In performance critical code, consider using TerrainPostsUInt16.getFourPostHeights(int, int, int, int, double[], double[], double[], double[]) instead of calling this method four times. Doing so will avoid unnecessary function call overhead.

Specified by:

getPostHeight in class TerrainPosts

Parameters:

longitudeIndex - The longitude index of the post. 0 refers to the western-most post stored by this instance.

latitudeIndex - The latitude index of the post. 0 refers to the southern-most post stored by this instance.

Returns:

The height of the post, in the native units of the terrain provider.

Throws:

IndexOutOfBoundsException - Thrown when longitudeIndex or latitudeIndex is outside the extent of this collection of posts.