MultiPolygon class

A multi polygon with an array of polygons (each with an array of rings).

Inheritance

Constructors

MultiPolygon(List<List<PositionSeries>> polygons, {Box? bounds})
A multi polygon with an array of polygons (each with an array of rings).
const
MultiPolygon.build(Iterable<Iterable<Iterable<double>>> polygons, {Coords type = Coords.xy, Box? bounds})
Builds a multi polygon from an array of polygons (each with an array of rings).
factory
MultiPolygon.decode(Uint8List bytes, {BinaryFormat<SimpleGeometryContent> format = WKB.geometry, CoordRefSys? crs, Map<String, dynamic>? options})
Decodes a multi polygon geometry from bytes conforming to format.
factory
MultiPolygon.decodeHex(String bytesHex, {BinaryFormat<SimpleGeometryContent> format = WKB.geometry, CoordRefSys? crs, Map<String, dynamic>? options})
Decodes a multi polygon geometry from bytesHex (as a hex string) conforming to format.
factory
MultiPolygon.from(Iterable<Iterable<Iterable<Position>>> polygons, {Box? bounds})
A multi polygon with an array of polygons (each with an array of rings).
factory
MultiPolygon.fromGeometries(Iterable<Polygon> polygons, {Box? bounds})
A multi polygon from an array of polygons (each item as an instance of Polygon).
factory
MultiPolygon.parse(String text, {TextReaderFormat<SimpleGeometryContent> format = GeoJSON.geometry, CoordRefSys? crs, Map<String, dynamic>? options})
Parses a multi polygon geometry from text conforming to format.
factory
MultiPolygon.parseCoords(Iterable<Iterable<String>> polygons, {Pattern delimiter = ',', Coords type = Coords.xy, bool swapXY = false, bool singlePrecision = false})
Parses a multi polygon geometry from polygons with each polygon containing rings that are formatted as texts (with coordinate values separated by delimiter).
factory

Properties

bounds → Box?
An optional bounding box explicitely set (or otherwise directly available) for this object.
no setterinherited
coordType → Coords
A value of Coords representing the coordinate type of position data contained directly or within child objects.
no setteroverride
geomType → Geom
The geometry type.
no setteroverride
hashCode → int
The hash code for this object.
no setteroverride
isEmptyByGeometry → bool
Returns true if this geometry is considered empty.
no setteroverride
polygons → Iterable<Polygon>
All polygons as a lazy iterable of Polygon geometries.
no setter
ringArrays → List<List<PositionSeries>>
The ring arrays of all polygons.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

area2D() → double
Returns the area of this geometry calculated in a cartesian 2D plane.
override
boundsAligned2D({Aligned align = Aligned.center, PositionScheme scheme = Position.scheme}) → Position?
Returns an aligned 2D position relative to a bounding box accessed by getBounds.
inherited
calculateBounds({PositionScheme scheme = Position.scheme}) → Box?
Calculate a bounding box for this object.
override
centroid2D({PositionScheme scheme = Position.scheme}) → Position?
Returns the centroid of this geometry calculated in a cartesian 2D plane.
override
dimensionality2D() → Dimensionality
Returns the true dimensionality of this geometry in 2D.
inherited
equals2D(covariant Geometry other, {double toleranceHoriz = defaultEpsilon}) → bool
True if this and other equals by testing 2D coordinate values of all position data (that must be in same order in both objects) contained directly or by child objects.
override
equals3D(covariant Geometry other, {double toleranceHoriz = defaultEpsilon, double toleranceVert = defaultEpsilon}) → bool
True if this and other equals by testing 3D coordinate values of all position data (that must be in same order in both objects) contained directly or by child objects.
override
equalsCoords(covariant Geometry other) → bool
True if this and other contain exactly same coordinate values (or both are empty) in the same order and with the same coordinate type.
override
getBounds({PositionScheme scheme = Position.scheme}) → Box?
Returns the current bounds if it's populated and conforms to scheme, or otherwise returns one calculated by calculateBounds.
inherited
length2D() → double
Returns the length of this geometry calculated in a cartesian 2D plane.
override
length3D() → double
Returns the length of this geometry calculated in a cartesian 3D space.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
populated({int traverse = 0, bool onBounds = true, PositionScheme scheme = Position.scheme}) → MultiPolygon
Returns a geometry of the same subtype as this with certain data members populated.
override
project(Projection projection) → MultiPolygon
Returns an object of the same subtype as this with all position data projected using projection and non-positional properties left intact.
override
toBytes({BinaryFormat<SimpleGeometryContent> format = WKB.geometry, Endian? endian, CoordRefSys? crs, Map<String, dynamic>? options}) → Uint8List
The binary representation of this geometry object, with format applied.
inherited
toBytesHex({BinaryFormat<SimpleGeometryContent> format = WKB.geometry, Endian? endian, CoordRefSys? crs, Map<String, dynamic>? options}) → String
The binary representation as a hex string of this geometry object, with format applied.
inherited
toString() → String
The string representation of this geometry object as specified by GeoJSON.
inherited
toText({TextWriterFormat<SimpleGeometryContent> format = GeoJSON.geometry, int? decimals, CoordRefSys? crs, Map<String, dynamic>? options}) → String
The string representation of this geometry object, with format applied.
inherited
unpopulated({int traverse = 0, bool onBounds = true}) → MultiPolygon
Returns a geometry of the same subtype as this with certain data members unpopulated (or cleared).
override
writeTo(SimpleGeometryContent writer, {String? name}) → void
Writes this geometry object to writer.
override

Operators

operator ==(Object other) → bool
The equality operator.
override