Annotation.Geometry.Outline

Create and manipulate free line closed outlines.

The Outline type is an alias for the OpenSolid Geometry Polygon2d type so if a functionality is not provided by this module, you can easily extend it with functions from the OpenSolid/Geometry package.

empty : Outline

Create an empty outline.

fromPoints : List Point -> Outline

Create a closed outline from a list of points.

points : Contour -> List Point

Retrieve the list of points of the outline.

module Annotation.Geometry.Outline
    exposing
        ( empty
        , fromPoints
        , points
        )

{-| Create and manipulate free line closed outlines.

The `Outline` type is an alias for the [OpenSolid Geometry Polygon2d][polygon2d]
type so if a functionality is not provided by this module,
you can easily extend it with functions from the OpenSolid/Geometry package.

[polygon2d]: http://package.elm-lang.org/packages/opensolid/geometry/2.0.1/OpenSolid-Polygon2d#Polygon2d

@docs empty, fromPoints, points

-}

import Annotation.Geometry.Types exposing (..)
import OpenSolid.Polygon2d as Polygon2d exposing (Polygon2d)


{-| Create an empty outline.
-}
empty : Outline
empty =
    fromPoints []


{-| Create a closed outline from a list of points.
-}
fromPoints : List Point -> Outline
fromPoints =
    Polygon2d.fromVertices


{-| Retrieve the list of points of the outline.
-}
points : Contour -> List Point
points =
    Polygon2d.vertices