simon/walkmap
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

More documentation

Browse source
This commit is contained in:
Simon Brooke 2020-05-24 22:22:22 +01:00
parent b6e618695e
commit aafab5faa8
No known key found for this signature in database
GPG key ID: A7A4F18D1D4DF987
2 changed files with 34 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -20,6 +20,9 @@ Lein dependency:
[walkmap "0.1.0-SNAPSHOT"] [walkmap "0.1.0-SNAPSHOT"]
* [API documentation](https://simon-brooke.github.io/walkmap/codox/index.html)
* [Test coverage](https://simon-brooke.github.io/walkmap/cloverage/index.html)
### Converting heightmaps to STL ### Converting heightmaps to STL
Doesn't work yet, and is not a priority. Use Doesn't work yet, and is not a priority. Use
@ -74,6 +77,20 @@ from height maps. These exclusion maps will probably be represented as SVG.
This is not yet implemented. This is not yet implemented.
Culling facets in ocean areas is implemented and works:
(require '[walkmap.core :refer [cull-ocean-facets *sea-level*]])
(cull-ocean-facets stl)
If sea level in your heightmaps is not zero, e.g. is 5, set it thus:
(def ^:dynamic *sea-level* 5.0)
(cull-ocean-facets stl)
It is **strongly recomended** that you set `*sea-level*` to a floating point
number, not an integer, because numbers are specified in the STL file as
floating point, and in Clojure, `(= 5 5.0)` returns `false`.
### Merging road maps and river system maps ### Merging road maps and river system maps
It is intended that it should be possible to merge road maps (maps of already It is intended that it should be possible to merge road maps (maps of already

17
doc/intro.md
View file

@ -16,6 +16,9 @@ Lein dependency:
[walkmap "0.1.0-SNAPSHOT"] [walkmap "0.1.0-SNAPSHOT"]
* [API documentation](https://simon-brooke.github.io/walkmap/codox/index.html)
* [Test coverage](https://simon-brooke.github.io/walkmap/cloverage/index.html)
### Converting heightmaps to STL ### Converting heightmaps to STL
Doesn't work yet, and is not a priority. Use Doesn't work yet, and is not a priority. Use
@ -70,6 +73,20 @@ from height maps. These exclusion maps will probably be represented as SVG.
This is not yet implemented. This is not yet implemented.
Culling facets in ocean areas is implemented and works:
(require '[walkmap.core :refer [cull-ocean-facets *sea-level*]])
(cull-ocean-facets stl)
If sea level in your heightmaps is not zero, e.g. is 5, set it thus:
(def ^:dynamic *sea-level* 5.0)
(cull-ocean-facets stl)
It is **strongly recomended** that you set `*sea-level*` to a floating point
number, not an integer, because numbers are specified in the STL file as
floating point, and in Clojure, `(= 5 5.0)` returns `false`.
### Merging road maps and river system maps ### Merging road maps and river system maps
It is intended that it should be possible to merge road maps (maps of already It is intended that it should be possible to merge road maps (maps of already