jepler/dashing
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

improve documentation

Browse source 
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
This commit is contained in:
Jeff Epler 2017-06-02 16:11:55 -05:00
parent b209a5bd09
commit 2bb91cceeb
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -31,9 +31,19 @@ I would be interested in passing this project to a new maintainer.
The winding rule `wr` defines which regions are in the interior of the contours.
For each dash or dot in the resulting hatch, `cb` is called with the output segment.
`parse_numbers(std::string line)`: Read a comma and/or space-separated
`xyhatch(const HatchPattern&, const C &segments, Cb cb, const char \*wr)`:
The container C holds segments which must define a set of closed
contours.
The winding rule `wr` defines which regions are in the interior of the contours.
For each dash or dot in the resulting hatch, `cb` is called with the output segment.
`HatchPattern::FromFile`: Read a hatch pattern from a file.
`parse\_numbers(std::string line)`: Read a comma and/or space-separated
sequence of numbers into a vector
`SegmentsFromFile`, `ContoursFromFile`, `ContourToSegments`, `ContoursToSegments`: Read and convert segments and contours
Useful winding rules include:
* `[](int i) { return i % 2 != 0; }`, the even-odd winding rule
* `[](int i) { return i != 0;}`, the non-zero winding rule