geojson/io.github.elcolto.geokjson.geojson/BoundingBox

BoundingBox

@Serializable(with = BoundingBoxSerializer::class)

class BoundingBox(val coordinates: DoubleArray)

Represents an area bounded by a northeast and southwest.

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections.

When serialized, a BoundingBox is represented as an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the northeasterly point. The axes order of a BoundingBox follow the axes order of geometries.

For the BoundingBox to be serialized in 3D form, both Positions must have a defined altitude.

See also

https://tools.ietf.org/html/rfc7946#section-5

Constructors

constructor(west: Double, south: Double, east: Double, north: Double)

constructor(coordinates: List<Double>)

constructor(west: Double, south: Double, minAltitude: Double, east: Double, north: Double, maxAltitude: Double)

constructor(southwest: Position, northeast: Position)

constructor(coordinates: DoubleArray)

Properties

val coordinates: DoubleArray

The GeoJSON bounding box coordinate array

val BoundingBox.hasAltitude: Boolean

val northeast: Position

The northeastern corner of the BoundingBox

val southwest: Position

The southwestern corner of the BoundingBox

Functions

operator fun component1(): Position

operator fun component2(): Position

operator fun contains(position: Position): Boolean

open operator override fun equals(other: Any?): Boolean

operator fun get(index: Int): Double

open override fun hashCode(): Int

fun json(): String

open override fun toString(): String