turf/io.github.elcolto.geokjson.turf.booleans

Package-level declarations

Functions

fun pointInPolygon(point: Point, polygon: MultiPolygon, ignoreBoundary: Boolean = false): Boolean

Takes a Point and a MultiPolygon and determines if the point resides inside the polygon. The polygon can be convex or concave. The function accounts for holes.

@JvmOverloads

fun pointInPolygon(point: Point, polygon: Polygon, ignoreBoundary: Boolean = false): Boolean

Takes a Point and a Polygon and determines if the point resides inside the polygon. The polygon can be convex or concave. The function accounts for holes.

@JvmOverloads

fun pointInPolygon(position: Position, polygon: MultiPolygon, ignoreBoundary: Boolean = false): Boolean

Takes a Position and a MultiPolygon and determines if the point resides inside the polygon. The polygon can be convex or concave. The function accounts for holes.

@JvmOverloads

fun pointInPolygon(position: Position, polygon: Polygon, ignoreBoundary: Boolean = false): Boolean

Takes a Position and a Polygon and determines if the point resides inside the polygon. The polygon can be convex or concave. The function accounts for holes.

pointOnLine

fun pointOnLine(point: Point, line: LineString, ignoreEndVertices: Boolean = false, epsilon: Double? = null): Boolean

Returns true if a point is on a line. Accepts a optional parameter to ignore the start and end vertices of the linestring.

fun pointOnLine(position: Position, line: LineString, ignoreEndVertices: Boolean = false, epsilon: Double? = null): Boolean

Returns true if a position is on a line. Accepts a optional parameter to ignore the start and end vertices of the linestring.

touches

fun touches(geometry1: Geometry, geometry2: Geometry): Boolean

within

fun within(geometry1: Geometry, geometry2: Geometry): Boolean

within returns true if geometry1 is completely within geometry2. The interiors of both geometries must intersect and, the interior and boundary of the primary (geometry a) must not intersect the exterior of the secondary (geometry b). within returns the exact opposite result of contains.