| Copyright | (c) 2011 diagrams-lib team (see LICENSE) |
|---|---|
| License | BSD-style (see LICENSE) |
| Maintainer | diagrams-discuss@googlegroups.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Diagrams.TwoD.Polygons
Description
This module defines a general API for creating various types of polygons.
- data PolyType n
- data PolyOrientation n
- data PolygonOpts n = PolygonOpts {
- _polyType :: PolyType n
- _polyOrient :: PolyOrientation n
- _polyCenter :: Point V2 n
- polyType :: Lens' (PolygonOpts n) (PolyType n)
- polyOrient :: Lens' (PolygonOpts n) (PolyOrientation n)
- polyCenter :: Lens' (PolygonOpts n) (Point V2 n)
- polygon :: (InSpace V2 n t, TrailLike t, OrderedField n) => PolygonOpts n -> t
- polyTrail :: OrderedField n => PolygonOpts n -> Located (Trail V2 n)
- polyPolarTrail :: OrderedField n => [Angle n] -> [n] -> Located (Trail V2 n)
- polySidesTrail :: OrderedField n => [Angle n] -> [n] -> Located (Trail V2 n)
- polyRegularTrail :: OrderedField n => Int -> n -> Located (Trail V2 n)
- orient :: OrderedField n => V2 n -> Located (Trail V2 n) -> Transformation V2 n
- data StarOpts
- star :: OrderedField n => StarOpts -> [Point V2 n] -> Path V2 n
- data GraphPart a
- orbits :: (Int -> Int) -> Int -> [GraphPart Int]
- mkGraph :: (Int -> Int) -> [a] -> [GraphPart a]
Polygons
Method used to determine the vertices of a polygon.
Constructors
| PolyPolar [Angle n] [n] | A "polar" polygon.
To construct an n-gon, use a list of n-1 angles and n radii. Extra angles or radii are ignored. Cyclic polygons (with all vertices lying on a
circle) can be constructed using a second
argument of |
| PolySides [Angle n] [n] | A polygon determined by the distance between successive vertices and the external angles formed by each three successive vertices. In other words, a polygon specified by "turtle graphics": go straight ahead x1 units; turn by external angle a1; go straight ahead x2 units; turn by external angle a2; etc. The polygon will be centered at the centroid of its vertices.
To construct an n-gon, use a list of n-2 angles and n-1 edge lengths. Extra angles or lengths are ignored. |
| PolyRegular Int n | A regular polygon with the given number of sides (first argument) and the given radius (second argument). |
data PolyOrientation n Source
Determine how a polygon should be oriented.
Constructors
| NoOrient | No special orientation; the first vertex will be at (1,0). This is the default. |
| OrientH | Orient horizontally, so the bottommost edge is parallel to the x-axis. |
| OrientV | Orient vertically, so the leftmost edge is parallel to the y-axis. |
| OrientTo (V2 n) | Orient so some edge is facing in the direction of, that is, perpendicular to, the given vector. |
Instances
| Eq n => Eq (PolyOrientation n) | |
| Ord n => Ord (PolyOrientation n) | |
| Read n => Read (PolyOrientation n) | |
| Show n => Show (PolyOrientation n) |
data PolygonOpts n Source
Options for specifying a polygon.
Constructors
| PolygonOpts | |
Fields
| |
Instances
| Num n => Default (PolygonOpts n) | The default polygon is a regular pentagon of radius 1, centered at the origin, aligned to the x-axis. |
polyType :: Lens' (PolygonOpts n) (PolyType n) Source
Specification for the polygon's vertices.
polyOrient :: Lens' (PolygonOpts n) (PolyOrientation n) Source
Should a rotation be applied to the polygon in order to orient it in a particular way?
polyCenter :: Lens' (PolygonOpts n) (Point V2 n) Source
Should a translation be applied to the polygon in order to place the center at a particular location?
polygon :: (InSpace V2 n t, TrailLike t, OrderedField n) => PolygonOpts n -> t Source
Generate the polygon described by the given options.
polyTrail :: OrderedField n => PolygonOpts n -> Located (Trail V2 n) Source
Generate a polygon. See PolygonOpts for more information.
Generating polygon vertices
polyPolarTrail :: OrderedField n => [Angle n] -> [n] -> Located (Trail V2 n) Source
Generate the located trail of a polygon specified by polar data
(central angles and radii). See PolyPolar.
polySidesTrail :: OrderedField n => [Angle n] -> [n] -> Located (Trail V2 n) Source
Generate the vertices of a polygon specified by side length and
angles, and a starting point for the trail such that the origin
is at the centroid of the vertices. See PolySides.
polyRegularTrail :: OrderedField n => Int -> n -> Located (Trail V2 n) Source
Generate the vertices of a regular polygon. See PolyRegular.
orient :: OrderedField n => V2 n -> Located (Trail V2 n) -> Transformation V2 n Source
Generate a transformation to orient a trail. orient v t
generates the smallest rotation such that one of the segments
adjacent to the vertex furthest in the direction of v is
perpendicular to v.
Star polygons
Options for creating "star" polygons, where the edges connect possibly non-adjacent vertices.
Constructors
| StarFun (Int -> Int) | Specify the order in which the vertices should be connected by a function that maps each vertex index to the index of the vertex that should come next. Indexing of vertices begins at 0. |
| StarSkip Int | Specify a star polygon by a "skip". A skip of 1 indicates a normal polygon, where edges go between successive vertices. A skip of 2 means that edges will connect every second vertex, skipping one in between. Generally, a skip of n means that edges will connect every nth vertex. |
star :: OrderedField n => StarOpts -> [Point V2 n] -> Path V2 n Source
Create a generalized star polygon. The StarOpts are used
to determine in which order the given vertices should be
connected. The intention is that the second argument of type
[Point v] could be generated by a call to polygon, regPoly, or
the like, since a list of vertices is TrailLike. But of course
the list can be generated any way you like. A Path vTrailLike) because the resulting path
may have more than one component, for example if the vertices are
to be connected in several disjoint cycles.
Function graphs
These functions are used to implement star, but are exported on
the offchance that someone else finds them useful.
Pieces of a function graph can either be cycles or "hairs".