ImplicitCAD
ImplicitCAD copied to clipboard
Main module missing haddock
As a newcomer to CAD (but not to Haskell), the haddock pages leave much to be desired. For example, what is this R
parameter to all of the write
functions? It's completely undocumented. Diving into the source suggests it's some sort of resolution, but I'm unsure if I should be giving it big or small values. A good rule of thumb is that every function and non-obvious parameter exported by the main module should have haddock.
Here are some things I've learned in playing around with the system.
- Smaller resolution values result in clearer models (and superlinear slow downs when rendering)
- The camera for PNG3 appears to be facing forwards
- The coordinate system is
(width, depth, height)
- Functions that end in
R
have a "roundness" as their first parameter. It's unclear what units this is measured in. - Size and position units appear to be in
mm
Could you submit those as changes to the comments? the state of the haddock docs is sad, my apologies.
Gladly. I'll try to get that done this weekend.
I believe you've fixed this. ;)