mapbox-maps-android/com.mapbox.maps/CoordinateBounds

CoordinateBounds

open class CoordinateBounds : Serializable

A rectangular area as measured on a two-dimensional map projection.

Constructors

CoordinateBounds

open fun CoordinateBounds(@NonNull southwest: Point, @NonNull northeast: Point, infiniteBounds: Boolean)

CoordinateBounds

open fun CoordinateBounds(@NonNull southwest: Point, @NonNull northeast: Point)

Functions

center

@NonNull

@MainThread

open fun center(): Point

Returns the center coordinate of the bounds.

constrain

@NonNull

@MainThread

open fun constrain(@NonNull point: Point): Point

Constrains `point` against the bounds.

contains

@MainThread

open fun contains(@NonNull point: Point, wrappedCoordinates: Boolean): Boolean

Returns whether the bounds contains `point` or not.

@MainThread

open fun contains(@NonNull area: CoordinateBounds, wrappedCoordinates: Boolean): Boolean

Returns whether the bounds contains `area` or not.

containsLatitude

@MainThread

open fun containsLatitude(latitude: Double): Boolean

Returns whether the bounds contains `latitude` or not.

containsLongitude

@MainThread

open fun containsLongitude(longitude: Double): Boolean

Returns whether the bounds contains `longitude` or not.

crossesAntimeridian

@MainThread

open fun crossesAntimeridian(): Boolean

Returns whether the bounds cross the date line or not.

east

@MainThread

open fun east(): Double

Returns the eastern longitude of the bounds.

equals

open fun equals(object: Any): Boolean

extend

@NonNull

@MainThread

open fun extend(@NonNull point: Point): CoordinateBounds

Extends these bounds to include `point`.

@NonNull

@MainThread

open fun extend(@NonNull area: CoordinateBounds): CoordinateBounds

Extends these bounds to include `area`.

hashCode

open fun hashCode(): Int

hull

@NonNull

@MainThread

open fun hull(@NonNull a: Point, @NonNull b: Point): CoordinateBounds

Returns the convex hull of two points; the smallest bounds that contains both.

intersects

@MainThread

open fun intersects(@NonNull area: CoordinateBounds, wrappedCoordinates: Boolean): Boolean

Returns whether the bounds intersects `area` or not.

isBounded

@MainThread

open fun isBounded(): Boolean

Returns whether the bounds are infinite or bounded.

isEmpty

@MainThread

open fun isEmpty(): Boolean

Returns whether the bounds are empty or not.

isValid

@MainThread

open fun isValid(): Boolean

Returns whether the bounds are valid or not.

latitudeSpan

@MainThread

open fun latitudeSpan(): Double

Returns the absolute distance, in degrees, between the north and south boundaries of these bounds.

longitudeSpan

@MainThread

open fun longitudeSpan(): Double

Returns the absolute distance, in degrees, between the west and east boundaries of these bounds.

north

@MainThread

open fun north(): Double

Returns the northern latitude of the bounds.

northwest

@NonNull

@MainThread

open fun northwest(): Point

Returns the northwest coordinate of the bounds.

singleton

@NonNull

@MainThread

open fun singleton(@NonNull point: Point): CoordinateBounds

Returns the bounds consisting of the single point.

south

@MainThread

open fun south(): Double

Returns the southern latitude of the bounds.

southeast

@NonNull

@MainThread

open fun southeast(): Point

Returns the southeast coordinate of the bounds.

toString

open fun toString(): String

west

@MainThread

open fun west(): Double

Returns the western longitude of the bounds.

world

@NonNull

@MainThread

open fun world(): CoordinateBounds

Returns a bounds covering the entire (unwrapped) world.

Properties

infiniteBounds

val infiniteBounds: Boolean

northeast

@NonNull

@get:NonNull

val northeast: Point

southwest

@NonNull

@get:NonNull

val southwest: Point