core/org.gnit.lucenekmp.geo/Polygon

Polygon

class Polygon(polyLats: DoubleArray, polyLons: DoubleArray, holes: Polygon) : LatLonGeometry

Represents a closed polygon on the earth's surface. You can either construct the Polygon directly yourself with double[] coordinates, or use Polygon.fromGeoJSON if you have a polygon already encoded as a GeoJSON string.

NOTES:

Coordinates must be in clockwise order, except for holes. Holes must be in counter-clockwise order.
The polygon must be closed: the first and last coordinates need to have the same values.
The polygon must not be self-crossing, otherwise may result in unexpected behavior.
All latitude/longitude values must be in decimal degrees.
Polygons cannot cross the 180th meridian. Instead, use two polygons: one on each side.
For more advanced GeoSpatial indexing and query operations see the spatial-extras module

Constructors

constructor(polyLats: DoubleArray, polyLons: DoubleArray, vararg holes: Polygon)

Types

object Companion

Properties

val maxLat: Double

maximum latitude of this polygon's bounding box area

val maxLon: Double

maximum longitude of this polygon's bounding box area

val minLat: Double

minimum latitude of this polygon's bounding box area

val minLon: Double

minimum longitude of this polygon's bounding box area

Functions

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

fun getHole(i: Int): Polygon

fun getHoles(): Array<Polygon>

Returns a copy of the internal holes array

fun getPolyLat(vertex: Int): Double

Returns latitude value at given index

fun getPolyLats(): DoubleArray

Returns a copy of the internal latitude array

fun getPolyLon(vertex: Int): Double

Returns longitude value at given index

fun getPolyLons(): DoubleArray

Returns a copy of the internal longitude array

getWindingOrder

fun getWindingOrder(): GeoUtils.WindingOrder

Returns the winding order (CW, COLINEAR, CCW) for the polygon shell

open override fun hashCode(): Int

fun numHoles(): Int

returns the number of holes for the polygon

fun numPoints(): Int

returns the number of vertex points

fun toGeoJSON(): String

prints polygons as geojson

open override fun toString(): String