agi.foundation.coordinates

(agi.foundation.core-2024r3.jar)

Class CartographicExtent

java.lang.Object

agi.foundation.coordinates.CartographicExtent

All Implemented Interfaces:

IEquatable<CartographicExtent>, IEquatableEpsilon<CartographicExtent>

public class CartographicExtent
extends Object
implements IEquatable<CartographicExtent>, IEquatableEpsilon<CartographicExtent>

A two-dimensional region specified by longitude and latitude coordinate bounds.

Constructor Summary

Constructors

Constructor and Description
CartographicExtent(double west, double south, double east, double north) Initializes a new instance with the specified coordinate bounds with the LongitudePiInNativeUnits (get) and LatitudePiInNativeUnits (get) in radians.
CartographicExtent(double west, double south, double east, double north, double piInNativeUnits) Initializes a new instance with the specified coordinate bounds.
CartographicExtent(double west, double south, double east, double north, double longitudePiInNativeUnits, double latitudePiInNativeUnits) Initializes a new instance with the specified coordinate bounds.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(CartographicExtent left, CartographicExtent right) Returns true if the two instances are exactly equal.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsEpsilon(CartographicExtent other, double epsilon) Indicates whether each coordinate value of another instance of this type is within the required tolerance of the corresponding coordinate value of this instance.
boolean	equalsType(CartographicExtent other) Indicates whether another instance of this type is exactly equal to this instance.
Cartographic	getCenter() Gets the center of the extent.
double	getEastLongitude() Gets the easternmost longitude.
double	getLatitudePiInNativeUnits() Gets the value of π in the native units of the latitude coordinate.
double	getLength() Gets the length of the extent.
double	getLongitudePiInNativeUnits() Gets the value of π in the native units of the longitude coordinate.
double	getNorthLatitude() Gets the northernmost latitude.
double	getSouthLatitude() Gets the southernmost latitude.
double	getWestLongitude() Gets the westernmost longitude.
double	getWidth() Gets the width of the extent.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
boolean	isInsideExtent(double longitude, double latitude) Determines if the specified location is inside the extent.
boolean	isInsideExtentEpsilon(double longitude, double latitude, double epsilon) Determines if the specified location is inside the extent.
static boolean	notEquals(CartographicExtent left, CartographicExtent right) Returns true if the two instances are not exactly equal.
String	toString() Returns the string representation of the value of this instance.
CartographicExtent	union(CartographicExtent other) Computes the union of this extent with another extent.

Methods inherited from class java.lang.Object

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

Constructor Detail

CartographicExtent

public CartographicExtent(double west,
                          double south,
                          double east,
                          double north)

Initializes a new instance with the specified coordinate bounds with the LongitudePiInNativeUnits (get) and LatitudePiInNativeUnits (get) in radians.

Parameters:

west - The westernmost longitude.

south - The southernmost latitude.

east - The easternmost longitude.

north - The northernmost latitude.

CartographicExtent

public CartographicExtent(double west,
                          double south,
                          double east,
                          double north,
                          double piInNativeUnits)

Initializes a new instance with the specified coordinate bounds.

Parameters:

west - The westernmost longitude.

south - The southernmost latitude.

east - The easternmost longitude.

north - The northernmost latitude.

piInNativeUnits - The value of π in native units for the longitude and latitude coordinates of the extent.

CartographicExtent

public CartographicExtent(double west,
                          double south,
                          double east,
                          double north,
                          double longitudePiInNativeUnits,
                          double latitudePiInNativeUnits)

Initializes a new instance with the specified coordinate bounds.

Parameters:

west - The westernmost longitude.

south - The southernmost latitude.

east - The easternmost longitude.

north - The northernmost latitude.

longitudePiInNativeUnits - The value of π in native units for the longitude coordinate of the extent.

latitudePiInNativeUnits - The value of π in native units for the latitude coordinate of the extent.

Method Detail

getNorthLatitude

public final double getNorthLatitude()

Gets the northernmost latitude.

getSouthLatitude

public final double getSouthLatitude()

Gets the southernmost latitude.

getEastLongitude

public final double getEastLongitude()

Gets the easternmost longitude.

getWestLongitude

public final double getWestLongitude()

Gets the westernmost longitude.

getLongitudePiInNativeUnits

public final double getLongitudePiInNativeUnits()

Gets the value of π in the native units of the longitude coordinate.

getLatitudePiInNativeUnits

public final double getLatitudePiInNativeUnits()

Gets the value of π in the native units of the latitude coordinate.

getCenter

@Nonnull
public final Cartographic getCenter()

Gets the center of the extent.

Height of the center is set to 0.

getWidth

public final double getWidth()

Gets the width of the extent. The width is the difference between EastLongitude (get) and WestLongitude (get).

getLength

public final double getLength()

Gets the length of the extent. The length is the difference between NorthLatitude (get) and SouthLatitude (get).

isInsideExtentEpsilon

public final boolean isInsideExtentEpsilon(double longitude,
                                           double latitude,
                                           double epsilon)

Determines if the specified location is inside the extent.

Parameters:

longitude - The longitude.

latitude - The latitude.

epsilon - The value from the boundary that determines on-border inclusiveness.

Returns:

true if the specified location is inside the extent, or on the border (within epsilon); otherwise false.

isInsideExtent

public final boolean isInsideExtent(double longitude,
                                    double latitude)

Determines if the specified location is inside the extent.

Parameters:

longitude - The longitude.

latitude - The latitude.

Returns:

true if the specified location is inside the extent, or on the border; otherwise false.

union

@Nonnull
public final CartographicExtent union(@Nonnull
                                                CartographicExtent other)

Computes the union of this extent with another extent. The union of two extents is the smallest extent that includes both.

Parameters:

other - The other extent.

Returns:

The union of the two extents.

Throws:

ArgumentNullException - Thrown when other is null.

IllegalStateException - Thrown when LongitudePiInNativeUnits (get) or LatitudePiInNativeUnits (get) of the two extents are not compatible.

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

equalsType

public final boolean equalsType(CartographicExtent other)

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

Specified by:

equalsType in interface IEquatable<CartographicExtent>

Parameters:

other - The instance to compare to this instance.

Returns:

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

equalsEpsilon

public final boolean equalsEpsilon(@Nullable
                                   CartographicExtent other,
                                   double epsilon)

Indicates whether each coordinate value of another instance of this type is within the required tolerance of the corresponding coordinate value of this instance. A negative tolerance effectively contracts the extent; a positive tolerance effectively expands the extent.

Specified by:

equalsEpsilon in interface IEquatableEpsilon<CartographicExtent>

Parameters:

other - The set of CartographicExtent to compare to this instance.

epsilon - The limit at which the absolute differences between the coordinate values will not be considered equal.

Returns:

true if the absolute differences are less than or equal to epsilon; otherwise false. A negative tolerance effectively contracts the extent; a positive tolerance effectively expands the extent.

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(CartographicExtent left,
                             CartographicExtent 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(CartographicExtent left,
                                CartographicExtent 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.

toString

public String toString()

Returns the string representation of the value of this instance.

Overrides:

toString in class Object

Returns:

A string that represents the value of this instance in the form WestLongitude, SouthLatitude, EastLongitude, NorthLatitude.