agi.foundation.terrain

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

Class RasterTerrainIndexExtent

java.lang.Object

agi.foundation.terrain.RasterTerrainIndexExtent

All Implemented Interfaces:

IEquatable<RasterTerrainIndexExtent>, ImmutableValueType, ValueType

public final class RasterTerrainIndexExtent
extends Object
implements IEquatable<RasterTerrainIndexExtent>, ImmutableValueType

Specifies a range of post indices defining a rectangular region in a RasterTerrainProvider. The extent always contains at least two posts in each direction.

Constructor Summary

Constructors

Constructor and Description
RasterTerrainIndexExtent() Initializes a new instance.
RasterTerrainIndexExtent(int west, int south, int east, int north) Initializes a new instance from the specified indices.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
static boolean	equals(RasterTerrainIndexExtent left, RasterTerrainIndexExtent right) Returns true if the two instances are exactly equal.
boolean	equalsType(RasterTerrainIndexExtent other) Indicates whether another instance of this type is exactly equal to this instance.
int	getEast() Gets the index of the easternmost post.
int	getLatitudePosts() Gets the total number of posts in the latitude direction.
int	getLongitudePosts() Gets the total number of posts in the longitude direction.
int	getNorth() Gets the index of the northernmost post.
int	getSouth() Gets the index of the southernmost post.
int	getWest() Gets the index of the westernmost post.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	notEquals(RasterTerrainIndexExtent left, RasterTerrainIndexExtent right) Returns true if the two instances are not exactly equal.

Methods inherited from class java.lang.Object

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

Constructor Detail

RasterTerrainIndexExtent

public RasterTerrainIndexExtent()

Initializes a new instance.

RasterTerrainIndexExtent

public RasterTerrainIndexExtent(int west,
                                int south,
                                int east,
                                int north)

Initializes a new instance from the specified indices.

Parameters:

west - The index of the westernmost post.

south - The index of the southernmost post.

east - The index of the easternmost post.

north - The index of the northernmost post.

Throws:

ArgumentException - Thrown when the west is greater than or equal to the east, or when the south is greater than or equal to the north.

Method Detail

getWest

public final int getWest()

Gets the index of the westernmost post.

getSouth

public final int getSouth()

Gets the index of the southernmost post.

getEast

public final int getEast()

Gets the index of the easternmost post.

getNorth

public final int getNorth()

Gets the index of the northernmost post.

getLongitudePosts

public final int getLongitudePosts()

Gets the total number of posts in the longitude direction.

getLatitudePosts

public final int getLatitudePosts()

Gets the total number of posts in the latitude direction.

equalsType

public final boolean equalsType(@Nonnull
                                RasterTerrainIndexExtent other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<RasterTerrainIndexExtent>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equals

public static boolean equals(@Nonnull
                             RasterTerrainIndexExtent left,
                             @Nonnull
                             RasterTerrainIndexExtent right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(@Nonnull
                                RasterTerrainIndexExtent left,
                                @Nonnull
                                RasterTerrainIndexExtent right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.