geojson/org.maplibre.spatialk.geojson/MultiPolygon

MultiPolygon

@Serializable(with = MultiPolygonSerializer::class)

data class MultiPolygon @JvmOverloads constructor(val coordinates: List<List<List<Position>>>, val bbox: BoundingBox? = null, val foreignMembers: JsonObject = EmptyForeignMembers) : MultiGeometry, PolygonGeometry, Collection<Polygon> (source)

A MultiPolygon geometry represents multiple surfaces in coordinate space.

See RFC 7946 Section 3.1.7 for the full specification.

Throws

IllegalArgumentException

if any of the lists does not represent a valid Polygon

Constructors

MultiPolygon

@JvmOverloads

constructor(coordinates: List<List<List<Position>>>, bbox: BoundingBox? = null, foreignMembers: JsonObject = EmptyForeignMembers)

@JvmOverloads

constructor(vararg coordinates: List<List<Position>>, bbox: BoundingBox? = null, foreignMembers: JsonObject = EmptyForeignMembers)

Create a MultiPolygon by a number of lists (= polygon rings) of lists (= Position objects).

@JvmOverloads

constructor(vararg polygons: Polygon, bbox: BoundingBox? = null, foreignMembers: JsonObject = EmptyForeignMembers)

Create a MultiPolygon by a number of Polygon objects.

@JvmOverloads

constructor(coordinates: Array<Array<Array<DoubleArray>>>, bbox: BoundingBox? = null, foreignMembers: JsonObject = EmptyForeignMembers)

Create a MultiPolygon by an array (= Polygon objects) of arrays (= polygon rings) of arrays (= Position objects) where each Position is represented by a DoubleArray.

Types

Companion

object Companion

Factory methods for creating and serializing MultiPolygon objects.

Properties

bbox

open override val bbox: BoundingBox?

The bounding box of this geometry.

coordinates

val coordinates: List<List<List<Position>>>

The coordinates of this geometry.

foreignMembers

open override val foreignMembers: JsonObject

Members not defined by RFC 7946.

size

open override val size: Int

Functions

contains

open operator override fun contains(element: Polygon): Boolean

containsAll

open override fun containsAll(elements: Collection<Polygon>): Boolean

decodeForeignMembers

@HiddenFromObjC

inline fun <T : Any> GeoJsonObject.decodeForeignMembers(json: Json = GeoJson.jsonFormat): T

Decodes GeoJsonObject.foreignMembers as T.

get

operator fun get(index: Int): Polygon

Get the polygon at the specified index.

getForeignMember

@JvmStatic

fun GeoJsonObject.getForeignMember(key: String): JsonElement?

Returns the foreign member with the given key, or null if it is not present.

isEmpty

open override fun isEmpty(): Boolean

iterator

open operator override fun iterator(): Iterator<Polygon>

MultiPolygon

See also

Throws

Constructors

Types

Properties

Functions