Module geometry

Module geometry 

Source
Expand description

All geometry types and structs

Modules§

bbox
BBox and BBox3D shapes and utilities
impls
Impls that we want to hide to make the code more readable
interpolate
Interpolation tools
primitive
Primitive geometry types (used by GeoJSON spec)
vector
Vector geometry types (used by the s2json spec for both WGS84 and S2Geometry)
vector_point
The VectorPoint struct is a powerful tool for 2D and 3D points

Structs§

BBox
Bounding Box
BBox3D
3D Bounding Box
BaseGeometry
BaseGeometry is the a generic geometry type
Point
Definition of a Point. May represent WebMercator Lon-Lat or S2Geometry S-T
Point3D
Definition of a 3D Point. May represent WebMercator Lon-Lat or S2Geometry S-T with a z-value
PointOrPoint3D
Define a Point or Point3D
STPoint
A Point in S2 Space with a Face
VectorBaseGeometry
BaseGeometry is the a generic geometry type
VectorPoint
Vector Points

Enums§

Axis
The axis to apply an operation to
BBOX
BBox or BBox3D
Geometry
All possible geometry shapes
GeometryType
Enum to represent specific geometry types as strings
VectorGeometry
Vector Geometry
VectorGeometryType
Enum to represent specific vector geometry types as strings
VectorOffsets
All possible geometry offsets

Traits§

Bounded
Trait for types that have a min and max value. Used by BBox and BBox3D
FullXY
Composite Trait for XY use cases
FullXYM
Composite Trait for XYM use cases
FullXYZ
Composite Trait for XYZ use cases
FullXYZM
Composite Trait for XYZM use cases
GetM
Trait to extract the m value
GetXY
Trait to extract the x and y values
GetXYM
Composite Trait: XY + M
GetXYZ
Composite Trait: XY + Z
GetXYZM
Composite Trait: XY + Z + M
GetZ
Trait to extract the z value
Interpolate
Easy access to interpolation tooling for All S2JSON Core Types
NewXY
Trait to create a new XY
NewXYM
Trait to create a new XY
NewXYZ
Trait to create a new XYZ
NewXYZM
Trait to create a new XYZM
SetM
Trait to set the m value
SetXY
Trait to set the x and y values
SetXYM
Composite Trait: XY + M
SetXYZ
Composite Trait: XY + Z
SetXYZM
Composite Trait: XY + Z + M
SetZ
Trait to set the z value

Type Aliases§

LineString
Definition of a LineString
LineString3D
Definition of a 3D LineString
LineString3DGeometry
LineString3DGeometry is a 3D line
LineStringGeometry
LineStringGeometry is a line
MultiLineString
Definition of a MultiLineString
MultiLineString3D
Definition of a 3D MultiLineString
MultiLineString3DGeometry
MultiLineString3DGeometry contains multiple 3D lines
MultiLineStringGeometry
MultiLineStringGeometry contains multiple lines
MultiPoint
Definition of a MultiPoint
MultiPoint3D
Definition of a 3D MultiPoint
MultiPoint3DGeometry
MultiPoint3DGeometry contains multiple 3D points
MultiPointGeometry
MultiPointGeometry contains multiple points
MultiPolygon
Definition of a MultiPolygon
MultiPolygon3D
Definition of a 3D MultiPolygon
MultiPolygon3DGeometry
MultiPolygon3DGeometry is a 3D polygon with multiple polygons with their own potential holes
MultiPolygonGeometry
MultiPolygonGeometry is a polygon with multiple polygons with their own potential holes
Point3DGeometry
Point3DGeometry is a 3D point
PointGeometry
PointGeometry is a point
Polygon
Definition of a Polygon
Polygon3D
Definition of a 3D Polygon
Polygon3DGeometry
Polygon3DGeometry is a 3D polygon with potential holes
PolygonGeometry
PolygonGeometry is a polygon with potential holes
VectorLineOffset
An offset defines how far the starting line is from the original starting point pre-slice
VectorLineString
Definition of a Vector LineString
VectorLineStringGeometry
LineStringGeometry is a line
VectorMultiLineOffset
A collection of offsets
VectorMultiLineString
Definition of a Vector MultiLineString
VectorMultiLineStringGeometry
MultiLineStringGeometry contains multiple lines
VectorMultiPoint
Definition of a Vector MultiPoint
VectorMultiPointGeometry
MultiPointGeometry contains multiple points
VectorMultiPolygon
Definition of a Vector MultiPolygon
VectorMultiPolygonGeometry
MultiPolygonGeometry is a polygon with multiple polygons with their own potential holes
VectorMultiPolygonOffset
A collection of collections of offsets
VectorPointGeometry
PointGeometry is a point
VectorPolygon
Definition of a Vector Polygon
VectorPolygonGeometry
PolygonGeometry is a polygon with potential holes
VectorPolygonOffset
A collection of offsets