## Generated by Codox

# Walkmap 0.1.0-SNAPSHOT

# walkmap.path

Essentially the specification for things we shall consider to be path. Note that for these purposes `path` means any continuous linear feature, where such features specifically include watercourses.

### check-path

#### macro

`(check-path o)`

If `o` is not a path, throw an `IllegalArgumentException` with an appropriate message; otherwise, returns `o`. Macro, so exception is thrown from the calling function.

view source

### check-paths

#### macro

`(check-paths o)`

If `o` is not a sequence of paths, throw an `IllegalArgumentException` with an appropriate message; otherwise, returns `o`. Macro, so exception is thrown from the calling function.

view source

### length

`(length path)`

Return the length of this path, in metres. Note that 1. This is not the same as the distance from the start to the end of the path, which, except for absolutely straight paths, will be shorter; 2. It is not even quite the same as the length of the path as rendered, since paths will generally be rendered as spline curves.

view source

### path

`(path & vertices)`

Return a path constructed from these `vertices`.

view source

### path->edges

`(path->edges o)`

if `o` is a path, a polygon, or a sequence of vertices, return a sequence of edges representing that path, polygon or sequence.

Throws `IllegalArgumentException` if `o` is not a path, a polygon, or sequence of vertices.

view source

### path?

`(path? o)`

True if `o` satisfies the conditions for a path. A path shall be a map having the key `:vertices`, whose value shall be a sequence of vertices as defined in `walkmap.vertex`.

view source

### polygon->path

`(polygon->path o)`

If `o` is a polygon, return an equivalent path. What’s different about a path is that in polygons there is an implicit edge between the first vertex and the last. In paths, there isn’t, so we need to add that edge explicitly.

If `o` is not a polygon, will throw an exception.

view source