common:core/com.tomtom.sdk.common.location/GeoBoundingBox

GeoBoundingBox

data class GeoBoundingBox(val topLeft: GeoPoint, val bottomRight: GeoPoint)

Represents a bounding box for the map. It's defined in the WGS84 format.

Important: This is a Public Preview API. It may be changed or removed at any time.

Parameters

topLeft

Top left corner of the bounding box.

bottomRight

Bottom right corner of the bounding box.

Constructors

fun GeoBoundingBox(topLeft: GeoPoint, bottomRight: GeoPoint)

Types

object Companion

Functions

fun contains(boundingBox: GeoBoundingBox): Boolean

Check whether this bounding box contains the other GeoBoundingBox described by the given parameter.

fun contains(coordinates: GeoPoint): Boolean

Checks whether this bounding box contains the given GeoPoint.

fun roundUp(precision: Int): GeoBoundingBox

Creates a new bounding box using current bounds, but described with the given precision.

fun toCoordinates(): List<GeoPoint>

Get actual coordinates of the GeoBoundingBox which can be used to show the box on a map. Coordinates describe box coordinates in clockwise direction starting from the top left corner.

Properties

val bottomRight: GeoPoint

val center: GeoPoint

Provides a center point of the defined bounding box.

val topLeft: GeoPoint