Geometry.PolygonM (Geometry v1.1.0)

A polygon struct, representing a 2D polygon with a measurement.

A non-empty line-string requires at least one ring with four coordinates.

Summary

Types

t()

Functions

new()

Creates an empty PolygonM.

new(rings, srid \\ 0)

Creates a PolygonM from the given rings.

Types

t()

@type t() :: %Geometry.PolygonM{rings: [Geometry.ring()], srid: Geometry.srid()}

Functions

new()

@spec new() :: t()

Creates an empty PolygonM.

Examples

iex> PolygonM.new()
%PolygonM{rings: []}

new(rings, srid \\ 0)

@spec new([Geometry.LineStringM.t()], Geometry.srid()) :: t()

Creates a PolygonM from the given rings.

Examples

iex> PolygonM.new([
...>   LineStringM.new([
...>     PointM.new(35, 10, 14),
...>     PointM.new(45, 45, 24),
...>     PointM.new(10, 20, 34),
...>     PointM.new(35, 10, 14)
...>   ]),
...>   LineStringM.new([
...>     PointM.new(20, 30, 14),
...>     PointM.new(35, 35, 24),
...>     PointM.new(30, 20, 34),
...>     PointM.new(20, 30, 14)
...>   ])
...> ])
%PolygonM{
  rings: [
    [[35, 10, 14], [45, 45, 24], [10, 20, 34], [35, 10, 14]],
    [[20, 30, 14], [35, 35, 24], [30, 20, 34], [20, 30, 14]]
  ],
  srid: 0
}

iex> PolygonM.new()
%PolygonM{}