geos.GEOSGeomFromHEX_buf ⇒ GEOSGeometry ⏏
GEOSGeometry ⏏Deprecated
Kind: global property of geos
Returns: GEOSGeometry - GEOSGeometry*
| Param | Type | Description |
|---|---|---|
| hex | Pointer | - |
| size | number | - |
geos.GEOSGeomFromHEX_buf_r ⇒ GEOSGeometry ⏏
GEOSGeometry ⏏Deprecated
Kind: global property of geos
Returns: GEOSGeometry - GEOSGeometry*
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| hex | Pointer | - |
| size | number | - |
geos.GEOSGeomFromWKB_buf ⇒ GEOSGeometry ⏏
GEOSGeometry ⏏Deprecated
Kind: global property of geos
Returns: GEOSGeometry - GEOSGeometry*
| Param | Type | Description |
|---|---|---|
| wkb | Pointer | - |
| size | number | - |
geos.GEOSGeomFromWKB_buf_r ⇒ GEOSGeometry ⏏
GEOSGeometry ⏏Deprecated
Kind: global property of geos
Returns: GEOSGeometry - GEOSGeometry*
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| wkb | Pointer | - |
| size | number | - |
geos.GEOSGeomFromWKT ⇒ GEOSGeometry ⏏
GEOSGeometry ⏏Deprecated
Kind: global property of geos
Returns: GEOSGeometry - GEOSGeometry*
| Param | Type | Description |
|---|---|---|
| wkt | StringPointer | - |
geos.GEOSGeomFromWKT_r ⇒ GEOSGeometry ⏏
GEOSGeometry ⏏Deprecated
Kind: global property of geos
Returns: GEOSGeometry - GEOSGeometry*
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| wkt | StringPointer | - |
geos.GEOSGeomGetEndPoint ⇒ GEOSGeometry ⏏
Return the last point of a LineString
Kind: global property of geos
Returns: GEOSGeometry - A Point geometry. Caller must free with GEOSGeom_destroy() NULL on exception.
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry, must be a LineString |
geos.GEOSGeomGetEndPoint_r ⇒ GEOSGeometry ⏏
Return the last point of a LineString
Kind: global property of geos
Returns: GEOSGeometry - A Point geometry. Caller must free with GEOSGeom_destroy() NULL on exception.
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry, must be a LineString |
geos.GEOSGeomGetLength ⇒ number ⏏
Calculate the length of a LineString. Only works for LineString inputs, returns exception otherwise.
Kind: global property of geos
Returns: number - 1 on success, 0 on exception.
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
| length | NumberPointer | Pointer to be filled in with length result |
geos.GEOSGeomGetLength_r ⇒ number ⏏
Calculate the length of a LineString. Only works for LineString inputs, returns exception otherwise.
Kind: global property of geos
Returns: number - 1 on success, 0 on exception.
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
| length | NumberPointer | Pointer to be filled in with length result |
geos.GEOSGeomGetM ⇒ number ⏏
Returns the M coordinate, for a Point input, or an exception otherwise.
Kind: global property of geos
Returns: number - 1 on success, 0 on exception
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input Point geometry |
| m | NumberPointer | Pointer to hold return value |
geos.GEOSGeomGetM_r ⇒ number ⏏
Returns the M coordinate, for a Point input, or an exception otherwise.
Kind: global property of geos
Returns: number - 1 on success, 0 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input Point geometry |
| m | NumberPointer | Pointer to hold return value |
geos.GEOSGeomGetNumPoints ⇒ number ⏏
Returns the number of points, for a LineString input, or an exception otherwise.
Kind: global property of geos
Returns: number - Number of points, -1 on exception
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input LineString geometry |
geos.GEOSGeomGetNumPoints_r ⇒ number ⏏
Returns the number of points, for a LineString input, or an exception otherwise.
Kind: global property of geos
Returns: number - Number of points, -1 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input LineString geometry |
geos.GEOSGeomGetPointN ⇒ GEOSGeometry ⏏
Return the N'th point of a LineString
Kind: global property of geos
Returns: GEOSGeometry - A Point geometry. Caller must free with GEOSGeom_destroy() NULL on exception.
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry, must be a LineString |
| n | number | Index of desired point (zero based) |
geos.GEOSGeomGetPointN_r ⇒ GEOSGeometry ⏏
Return the N'th point of a LineString
Kind: global property of geos
Returns: GEOSGeometry - A Point geometry. Caller must free with GEOSGeom_destroy() NULL on exception.
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry, must be a LineString |
| n | number | Index of desired point (zero based) |
geos.GEOSGeomGetStartPoint ⇒ GEOSGeometry ⏏
Return the first point of a LineString
Kind: global property of geos
Returns: GEOSGeometry - A Point geometry. Caller must free with GEOSGeom_destroy() NULL on exception.
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry, must be a LineString |
geos.GEOSGeomGetStartPoint_r ⇒ GEOSGeometry ⏏
Return the first point of a LineString
Kind: global property of geos
Returns: GEOSGeometry - A Point geometry. Caller must free with GEOSGeom_destroy() NULL on exception.
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry, must be a LineString |
geos.GEOSGeomGetX ⇒ number ⏏
Returns the X coordinate, for a Point input, or an exception otherwise.
Kind: global property of geos
Returns: number - 1 on success, 0 on exception
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input Point geometry |
| x | NumberPointer | Pointer to hold return value |
geos.GEOSGeomGetX_r ⇒ number ⏏
Returns the X coordinate, for a Point input, or an exception otherwise.
Kind: global property of geos
Returns: number - 1 on success, 0 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input Point geometry |
| x | NumberPointer | Pointer to hold return value |
geos.GEOSGeomGetY ⇒ number ⏏
Returns the Y coordinate, for a Point input, or an exception otherwise.
Kind: global property of geos
Returns: number - 1 on success, 0 on exception
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input Point geometry |
| y | NumberPointer | Pointer to hold return value |
geos.GEOSGeomGetY_r ⇒ number ⏏
Returns the Y coordinate, for a Point input, or an exception otherwise.
Kind: global property of geos
Returns: number - 1 on success, 0 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input Point geometry |
| y | NumberPointer | Pointer to hold return value |
geos.GEOSGeomGetZ ⇒ number ⏏
Returns the Z coordinate, for a Point input, or an exception otherwise.
Kind: global property of geos
Returns: number - 1 on success, 0 on exception
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input Point geometry |
| z | NumberPointer | Pointer to hold return value |
geos.GEOSGeomGetZ_r ⇒ number ⏏
Returns the Z coordinate, for a Point input, or an exception otherwise.
Kind: global property of geos
Returns: number - 1 on success, 0 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input Point geometry |
| z | NumberPointer | Pointer to hold return value |
geos.GEOSGeomToHEX_buf ⇒ number ⏏
number ⏏Deprecated
Kind: global property of geos
Returns: number - unsigned
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | - |
| size | NumberPointer | - |
geos.GEOSGeomToHEX_buf_r ⇒ number ⏏
number ⏏Deprecated
Kind: global property of geos
Returns: number - unsigned
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | - |
| size | NumberPointer | - |
geos.GEOSGeomToWKB_buf ⇒ number ⏏
number ⏏Deprecated
Kind: global property of geos
Returns: number - unsigned
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | - |
| size | NumberPointer | - |
geos.GEOSGeomToWKB_buf_r ⇒ number ⏏
number ⏏Deprecated
Kind: global property of geos
Returns: number - unsigned
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | - |
| size | NumberPointer | - |
geos.GEOSGeomToWKT ⇒ StringPointer ⏏
StringPointer ⏏Deprecated
Kind: global property of geos
Returns: StringPointer - char*
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | - |
geos.GEOSGeomToWKT_r ⇒ StringPointer ⏏
StringPointer ⏏Deprecated
Kind: global property of geos
Returns: StringPointer - char*
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | - |
geos.GEOSGeomType ⇒ StringPointer ⏏
Returns the geometry type string for this geometry. eg: "GeometryCollection", "LineString"
Kind: global property of geos
Returns: StringPointer - A string with the geometry type. Caller must free with GEOSFree(). NULL on exception.
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
geos.GEOSGeomTypeId ⇒ number ⏏
Returns the GEOSGeomTypeId number for this geometry.
Kind: global property of geos
Returns: number - The geometry type number, or -1 on exception.
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
geos.GEOSGeomTypeId_r ⇒ number ⏏
Returns the GEOSGeomTypeId number for this geometry.
Kind: global property of geos
Returns: number - The geometry type number, or -1 on exception.
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
geos.GEOSGeomType_r ⇒ StringPointer ⏏
Returns the geometry type string for this geometry. eg: "GeometryCollection", "LineString"
Kind: global property of geos
Returns: StringPointer - A string with the geometry type. Caller must free with GEOSFree(). NULL on exception.
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
geos.GEOSGeom_clone ⇒ GEOSGeometry ⏏
Create a new copy of the input geometry.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | The geometry to copy |
geos.GEOSGeom_clone_r ⇒ GEOSGeometry ⏏
Create a new copy of the input geometry.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | The geometry to copy |
geos.GEOSGeom_createCircularString ⇒ GEOSGeometry ⏏
Creates a CircularString geometry.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated CircularString geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| s | GEOSCoordSequence | Input coordinate sequence, ownership passes to the geometry |
geos.GEOSGeom_createCircularString_r ⇒ GEOSGeometry ⏏
Creates a CircularString geometry.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated CircularString geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| s | GEOSCoordSequence | Input coordinate sequence, ownership passes to the geometry |
geos.GEOSGeom_createCollection ⇒ GEOSGeometry ⏏
Create a geometry collection.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated geometry collection. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| type | number | The geometry type, enumerated by GEOSGeomTypes |
| geoms | GEOSGeometry | A list of geometries that will form the collection |
| ngeoms | number | The number of geometries in the geoms list |
geos.GEOSGeom_createCollection_r ⇒ GEOSGeometry ⏏
Create a geometry collection.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated geometry collection. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| type | number | The geometry type, enumerated by GEOSGeomTypes |
| geoms | GEOSGeometry | A list of geometries that will form the collection |
| ngeoms | number | The number of geometries in the geoms list |
geos.GEOSGeom_createCompoundCurve ⇒ GEOSGeometry ⏏
Creates a CompoundCurve geometry.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated CompoundCurve geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| curves | GEOSGeometry | A list of geometries that will form the CompoundCurve |
| ncurves | number | The number of geometries in the curves list |
geos.GEOSGeom_createCompoundCurve_r ⇒ GEOSGeometry ⏏
Creates a CompoundCurve geometry.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated CompoundCurve geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| curves | GEOSGeometry | A list of geometries that will form the CompoundCurve |
| ncurves | number | The number of geometries in the curves list |
geos.GEOSGeom_createCurvePolygon ⇒ GEOSGeometry ⏏
Creates a CurvePolygon geometry from ring geometries.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| shell | GEOSGeometry | A ring that is the exterior ring of the polygon. |
| holes | GEOSGeometry | An array of rings that are the holes. |
| nholes | number | The number of rings in the holes array. |
geos.GEOSGeom_createCurvePolygon_r ⇒ GEOSGeometry ⏏
Creates a CurvePolygon geometry from ring geometries.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| shell | GEOSGeometry | A ring that is the exterior ring of the polygon. |
| holes | GEOSGeometry | An array of rings that are the holes. |
| nholes | number | The number of rings in the holes array. |
geos.GEOSGeom_createEmptyCircularString_r ⇒ GEOSGeometry ⏏
Creates an empty CircularString geometry.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated CircularString geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
geos.GEOSGeom_createEmptyCollection ⇒ GEOSGeometry ⏏
Create an empty geometry collection.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated empty geometry collection. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| type | number | The geometry type, enumerated by GEOSGeomTypes |
geos.GEOSGeom_createEmptyCollection_r ⇒ GEOSGeometry ⏏
Create an empty geometry collection.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated empty geometry collection. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| type | number | The geometry type, enumerated by GEOSGeomTypes |
geos.GEOSGeom_createEmptyCompoundCurve_r ⇒ GEOSGeometry ⏏
Creates an empty CompoundCurve geometry.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated CompoundCurve geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
geos.GEOSGeom_createEmptyCurvePolygon_r ⇒ GEOSGeometry ⏏
Creates an empty CurvePolygon geometry.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated CurvePolygon geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
geos.GEOSGeom_createEmptyLineString_r ⇒ GEOSGeometry ⏏
Creates an emptylinestring geometry.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated linestring geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
geos.GEOSGeom_createEmptyPoint_r ⇒ GEOSGeometry ⏏
Creates an empty point.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated empty point geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
geos.GEOSGeom_createEmptyPolygon_r ⇒ GEOSGeometry ⏏
Creates an empty polygon geometry.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated empty polygon geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
geos.GEOSGeom_createLineString ⇒ GEOSGeometry ⏏
Creates a linestring geometry.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated linestring geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| s | GEOSCoordSequence | Input coordinate sequence, ownership passes to the geometry |
geos.GEOSGeom_createLineString_r ⇒ GEOSGeometry ⏏
Creates a linestring geometry.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated linestring geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| s | GEOSCoordSequence | Input coordinate sequence, ownership passes to the geometry |
geos.GEOSGeom_createLinearRing ⇒ GEOSGeometry ⏏
Creates a linear ring geometry, for use in a polygon.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated linear ring geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| s | GEOSCoordSequence | Input coordinate sequence, ownership passes to the geometry |
geos.GEOSGeom_createLinearRing_r ⇒ GEOSGeometry ⏏
Creates a linear ring geometry, for use in a polygon.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated linear ring geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| s | GEOSCoordSequence | Input coordinate sequence, ownership passes to the geometry |
geos.GEOSGeom_createPoint ⇒ GEOSGeometry ⏏
Creates a point geometry from a coordinate sequence.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated point geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| s | GEOSCoordSequence | Input coordinate sequence, ownership passes to the geometry |
geos.GEOSGeom_createPointFromXY ⇒ GEOSGeometry ⏏
Creates a point geometry from a pair of coordinates.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated point geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| x | number | The X coordinate |
| y | number | The Y coordinate |
geos.GEOSGeom_createPointFromXY_r ⇒ GEOSGeometry ⏏
Creates a point geometry from a pair of coordinates.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated point geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| x | number | The X coordinate |
| y | number | The Y coordinate |
geos.GEOSGeom_createPoint_r ⇒ GEOSGeometry ⏏
Creates a point geometry from a coordinate sequence.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated point geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| s | GEOSCoordSequence | Input coordinate sequence, ownership passes to the geometry |
geos.GEOSGeom_createPolygon ⇒ GEOSGeometry ⏏
Creates a polygon geometry from linear ring geometries.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| shell | GEOSGeometry | A linear ring that is the exterior ring of the polygon. |
| holes | GEOSGeometry | An array of linear rings that are the holes. |
| nholes | number | The number of rings in the holes array. |
geos.GEOSGeom_createPolygon_r ⇒ GEOSGeometry ⏏
Creates a polygon geometry from linear ring geometries.
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated geometry. NULL on exception. Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| shell | GEOSGeometry | A linear ring that is the exterior ring of the polygon. |
| holes | GEOSGeometry | An array of linear rings that are the holes. |
| nholes | number | The number of rings in the holes array. |
geos.GEOSGeom_createRectangle ⇒ GEOSGeometry ⏏
Create a rectangular polygon from bounding coordinates. Will return a point geometry if width and height are 0.
Kind: global property of geos
Returns: GEOSGeometry - GEOSGeometry*
| Param | Type | Description |
|---|---|---|
| xmin | number | Left bound of envelope |
| ymin | number | Lower bound of envelope |
| xmax | number | Right bound of envelope |
| ymax | number | Upper bound of envelope |
geos.GEOSGeom_createRectangle_r ⇒ GEOSGeometry ⏏
Create a rectangular polygon from bounding coordinates. Will return a point geometry if width and height are 0.
Kind: global property of geos
Returns: GEOSGeometry - GEOSGeometry*
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| xmin | number | Left bound of envelope |
| ymin | number | Lower bound of envelope |
| xmax | number | Right bound of envelope |
| ymax | number | Upper bound of envelope |
geos.GEOSGeom_destroy ⇒ null ⏏
Release the memory associated with a geometry.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | The geometry to be destroyed. |
geos.GEOSGeom_destroy_r ⇒ null ⏏
Release the memory associated with a geometry.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | The geometry to be destroyed. |
geos.GEOSGeom_extractUniquePoints ⇒ GEOSGeometry ⏏
Return all distinct vertices of input geometry as a MultiPoint. Note that only 2 dimensions of the vertices are considered when testing for equality.
Kind: global property of geos
Returns: GEOSGeometry - The distinct points Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | The input geometry |
geos.GEOSGeom_extractUniquePoints_r ⇒ GEOSGeometry ⏏
Return all distinct vertices of input geometry as a MultiPoint. Note that only 2 dimensions of the vertices are considered when testing for equality.
Kind: global property of geos
Returns: GEOSGeometry - The distinct points Caller is responsible for freeing with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | The input geometry |
geos.GEOSGeom_getCoordSeq ⇒ number ⏏
Return the coordinate sequence underlying the given geometry (Must be a LineString, LinearRing or Point). Do not directly free the coordinate sequence, it is owned by the parent geometry.
Kind: global property of geos
Returns: number - Coordinate sequence or NULL on exception.
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
geos.GEOSGeom_getCoordSeq_r ⇒ number ⏏
Return the coordinate sequence underlying the given geometry (Must be a LineString, LinearRing or Point). Do not directly free the coordinate sequence, it is owned by the parent geometry.
Kind: global property of geos
Returns: number - Coordinate sequence or NULL on exception.
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
geos.GEOSGeom_getCoordinateDimension ⇒ number ⏏
Return the cartesian dimension of the geometry.
Kind: global property of geos
Returns: number - The dimension
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
geos.GEOSGeom_getCoordinateDimension_r ⇒ number ⏏
Return the cartesian dimension of the geometry.
Kind: global property of geos
Returns: number - The dimension
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
geos.GEOSGeom_getDimensions ⇒ number ⏏
Return the planar dimensionality of the geometry.
Kind: global property of geos
Returns: number - The dimensionality
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
geos.GEOSGeom_getDimensions_r ⇒ number ⏏
Return the planar dimensionality of the geometry.
Kind: global property of geos
Returns: number - The dimensionality
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
geos.GEOSGeom_getExtent ⇒ number ⏏
Finds the extent (minimum and maximum X and Y value) of the geometry. Raises an exception for empty geometry input.
Kind: global property of geos
Returns: number - 1 on success, 0 on exception
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
| xmin | NumberPointer | Pointer to place result for minimum X value |
| ymin | NumberPointer | Pointer to place result for minimum Y value |
| xmax | NumberPointer | Pointer to place result for maximum X value |
| ymax | NumberPointer | Pointer to place result for maximum Y value |
geos.GEOSGeom_getExtent_r ⇒ number ⏏
Finds the extent (minimum and maximum X and Y value) of the geometry. Raises an exception for empty geometry input.
Kind: global property of geos
Returns: number - 1 on success, 0 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
| xmin | NumberPointer | Pointer to place result for minimum X value |
| ymin | NumberPointer | Pointer to place result for minimum Y value |
| xmax | NumberPointer | Pointer to place result for maximum X value |
| ymax | NumberPointer | Pointer to place result for maximum Y value |
geos.GEOSGeom_getPrecision ⇒ number ⏏
Read the currently set precision value from the geometry and returns the grid size if it is a fixed precision or 0.0 if it is full floating point precision.
Kind: global property of geos
Returns: number - The grid size, or -1 on exception
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
geos.GEOSGeom_getPrecision_r ⇒ number ⏏
Read the currently set precision value from the geometry and returns the grid size if it is a fixed precision or 0.0 if it is full floating point precision.
Kind: global property of geos
Returns: number - The grid size, or -1 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
geos.GEOSGeom_getUserData ⇒ Pointer ⏏
Return the anonymous "user data" for this geometry. User data must be managed by the caller, and is not freed when the geometry is destroyed.
Kind: global property of geos
Returns: Pointer - A void* to the user data, caller is responsible for casting to the appropriate type.
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
geos.GEOSGeom_getUserData_r ⇒ Pointer ⏏
Return the anonymous "user data" for this geometry. User data must be managed by the caller, and is not freed when the geometry is destroyed.
Kind: global property of geos
Returns: Pointer - A void* to the user data, caller is responsible for casting to the appropriate type.
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
geos.GEOSGeom_getXMax ⇒ number ⏏
Finds the maximum X value in the geometry.
Kind: global property of geos
Returns: number - 0 on exception
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
| value | NumberPointer | Pointer to place result |
geos.GEOSGeom_getXMax_r ⇒ number ⏏
Finds the maximum X value in the geometry.
Kind: global property of geos
Returns: number - 0 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
| value | NumberPointer | Pointer to place result |
geos.GEOSGeom_getXMin ⇒ number ⏏
Finds the minimum X value in the geometry.
Kind: global property of geos
Returns: number - 0 on exception
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
| value | NumberPointer | Pointer to place result |
geos.GEOSGeom_getXMin_r ⇒ number ⏏
Finds the minimum X value in the geometry.
Kind: global property of geos
Returns: number - 0 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
| value | NumberPointer | Pointer to place result |
geos.GEOSGeom_getYMax ⇒ number ⏏
Finds the maximum Y value in the geometry.
Kind: global property of geos
Returns: number - 0 on exception
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
| value | NumberPointer | Pointer to place result |
geos.GEOSGeom_getYMax_r ⇒ number ⏏
Finds the maximum Y value in the geometry.
Kind: global property of geos
Returns: number - 0 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
| value | NumberPointer | Pointer to place result |
geos.GEOSGeom_getYMin ⇒ number ⏏
Finds the minimum Y value in the geometry.
Kind: global property of geos
Returns: number - 0 on exception
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
| value | NumberPointer | Pointer to place result |
geos.GEOSGeom_getYMin_r ⇒ number ⏏
Finds the minimum Y value in the geometry.
Kind: global property of geos
Returns: number - 0 on exception
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
| value | NumberPointer | Pointer to place result |
geos.GEOSGeom_releaseCollection ⇒ GEOSGeometry ⏏
Release the sub-geometries of a collection for management. by the caller. The input collection remains as an empty collection, that the caller is responsible for destroying. The output geometries are also the responsibility of the caller, as is the containing array, which must be freed with GEOSFree().
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated array of GEOSGeometry pointers.
| Param | Type | Description |
|---|---|---|
| collection | GEOSGeometry | The collection that will have its components released. |
| ngeoms | NumberPointer | A pointer to a variable that will be filled with the size of the output array. |
geos.GEOSGeom_releaseCollection_r ⇒ GEOSGeometry ⏏
Release the sub-geometries of a collection for management. by the caller. The input collection remains as an empty collection, that the caller is responsible for destroying. The output geometries are also the responsibility of the caller, as is the containing array, which must be freed with GEOSFree().
Kind: global property of geos
Returns: GEOSGeometry - A newly allocated array of GEOSGeometry pointers.
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| collection | GEOSGeometry | The collection that will have its components released. |
| ngeoms | NumberPointer | A pointer to a variable that will be filled with the size of the output array. |
geos.GEOSGeom_setPrecision ⇒ GEOSGeometry ⏏
Change the coordinate precision of a geometry. This will affect the precision of the existing geometry as well as any geometries derived from this geometry using overlay functions. The output will be a valid GEOSGeometry.
Kind: global property of geos
Returns: GEOSGeometry - The precision reduced result. Caller must free with GEOSGeom_destroy() NULL on exception.
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
| gridSize | number | cell size of grid to round coordinates to, or 0 for FLOATING precision |
| flags | number | The bitwise OR of members of the GEOSPrecisionRules enum |
geos.GEOSGeom_setPrecision_r ⇒ GEOSGeometry ⏏
Change the coordinate precision of a geometry. This will affect the precision of the existing geometry as well as any geometries derived from this geometry using overlay functions. The output will be a valid GEOSGeometry.
Kind: global property of geos
Returns: GEOSGeometry - The precision reduced result. Caller must free with GEOSGeom_destroy() NULL on exception.
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
| gridSize | number | cell size of grid to round coordinates to, or 0 for FLOATING precision |
| flags | number | The bitwise OR of members of the GEOSPrecisionRules enum |
geos.GEOSGeom_setUserData ⇒ null ⏏
Set the anonymous "user data" for this geometry.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
| userData | Pointer | Void pointer to user data |
geos.GEOSGeom_setUserData_r ⇒ null ⏏
Set the anonymous "user data" for this geometry.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
| userData | Pointer | Void pointer to user data |
geos.GEOSGeom_transformXY ⇒ GEOSGeometry ⏏
Apply XY coordinate transform callback to all coordinates in a copy of input geometry. If the callback returns an error, returned geometry will be NULL. Z and M values, if present, are not modified by this function.
Kind: global property of geos
Returns: GEOSGeometry - a copy of the input geometry with transformed coordinates. Caller must free with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| g | GEOSGeometry | Input geometry |
| callback | GEOSTransformXYCallback | a function to be executed for each coordinate in the geometry. The callback takes 3 parameters: x and y coordinate values to be updated and a void userdata pointer. |
| userdata | Pointer | an optional pointer to pe passed to 'callback' as an argument |
geos.GEOSGeom_transformXY_r ⇒ GEOSGeometry ⏏
Apply XY coordinate transform callback to all coordinates in a copy of input geometry. If the callback returns an error, returned geometry will be NULL. Z and M values, if present, are not modified by this function.
Kind: global property of geos
Returns: GEOSGeometry - a copy of the input geometry with transformed coordinates. Caller must free with GEOSGeom_destroy().
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| g | GEOSGeometry | Input geometry |
| callback | GEOSTransformXYCallback | a function to be executed for each coordinate in the geometry. The callback takes 3 parameters: x and y coordinate values to be updated and a void userdata pointer. |
| userdata | Pointer | an optional pointer to pe passed to 'callback' as an argument |