agi.foundation.terrain

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

Class QuantizedMeshTileCoordinateExtent

java.lang.Object

agi.foundation.terrain.QuantizedMeshTileCoordinateExtent

All Implemented Interfaces:

IEquatable<QuantizedMeshTileCoordinateExtent>, ImmutableValueType, ValueType

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

Specifies a range of coordinate positions that define a rectangular region in a tile-based terrain provider. The extent may be a single tile.

The X coordinate increases from west to east, and the Y coordinate increases from south to north. That is, the origin is in the south-west.

Constructor Summary

Constructors

Constructor and Description
QuantizedMeshTileCoordinateExtent(int level, int west, int south, int east, int north) Initializes a new instance from the specified coordinates.

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(QuantizedMeshTileCoordinateExtent left, QuantizedMeshTileCoordinateExtent right) Returns true if the two instances are exactly equal.
boolean	equalsType(QuantizedMeshTileCoordinateExtent other) Indicates whether another instance of this type is exactly equal to this instance.
int	getEast() Gets the easternmost X coordinate.
int	getLevel() Gets the zoom level.
int	getNorth() Gets the northernmost Y coordinate.
static QuantizedMeshTileCoordinateExtent	getOutsideExtent() Gets a static instance representing extents that are completely outside the bounding extent of the provider.
int	getSouth() Gets the southernmost Y coordinate.
int	getWest() Gets the westernmost X coordinate.
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(QuantizedMeshTileCoordinateExtent left, QuantizedMeshTileCoordinateExtent right) Returns true if the two instances are not exactly equal.
String	toString() Returns the string representation of the value of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

QuantizedMeshTileCoordinateExtent

public QuantizedMeshTileCoordinateExtent(int level,
                                         int west,
                                         int south,
                                         int east,
                                         int north)

Initializes a new instance from the specified coordinates.

Parameters:

level - The zoom level.

west - The westernmost X coordinate.

south - The southernmost Y coordinate.

east - The easternmost X coordinate.

north - The northernmost Y coordinate.

Throws:

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

Method Detail

getLevel

public final int getLevel()

Gets the zoom level.

getWest

public final int getWest()

Gets the westernmost X coordinate.

getSouth

public final int getSouth()

Gets the southernmost Y coordinate.

getEast

public final int getEast()

Gets the easternmost X coordinate.

getNorth

public final int getNorth()

Gets the northernmost Y coordinate.

getOutsideExtent

@Nonnull
public static QuantizedMeshTileCoordinateExtent getOutsideExtent()

Gets a static instance representing extents that are completely outside the bounding extent of the provider.

equalsType

public final boolean equalsType(@Nonnull
                                QuantizedMeshTileCoordinateExtent other)

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

Specified by:

equalsType in interface IEquatable<QuantizedMeshTileCoordinateExtent>

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
                             QuantizedMeshTileCoordinateExtent left,
                             @Nonnull
                             QuantizedMeshTileCoordinateExtent 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
                                QuantizedMeshTileCoordinateExtent left,
                                @Nonnull
                                QuantizedMeshTileCoordinateExtent 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 West, South, East, North.