grey/BOSL2
1
0
Fork 0
mirror of https://github.com/BelfrySCAD/BOSL2.git synced 2025-01-01 09:49:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Tweaked offset() description formatting.

Browse source
This commit is contained in:
Revar Desmera 2019-07-16 15:18:00 -07:00
parent fadfd998cf
commit ad59d88ce2
1 changed files with 17 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
geometry.scad
View file

@ -810,24 +810,25 @@ function _offset_region(
// Function: offset()
//
// Description:
// Takes an input path and returns a path offset by the specified amount. As with the built-in offset() module, you can use
// `r` to specify rounded offset and `delta` to specify offset with corners. Positive offsets shift the path
// to the left (relative to the direction of the path).
// Takes an input path and returns a path offset by the specified amount. As with the built-in
// offset() module, you can use `r` to specify rounded offset and `delta` to specify offset with
// corners. Positive offsets shift the path to the left (relative to the direction of the path).
//
// When offsets shrink the path, segments cross and become invalid. By default `offset()` checks for this situation.
// To test validity the code checks that segments have distance larger than (r or delta) from the input path.
// This check takes O(N^2) time and may mistakenly eliminate segments you wanted included in various situations,
// so you can disable it if you wish by setting check_valid=false. Another situation is that the test is not
// sufficiently thorough and some segments persist that should be eliminated. In this case, increase `quality`
// to 2 or 3. (This increases the number of samples on the segment that are checked.) Run time will increase.
// In some situations you may be able to decrease run time by setting quality to 0, which causes only segment
// ends to be checked.
// When offsets shrink the path, segments cross and become invalid. By default `offset()` checks
// for this situation. To test validity the code checks that segments have distance larger than (r
// or delta) from the input path. This check takes O(N^2) time and may mistakenly eliminate
// segments you wanted included in various situations, so you can disable it if you wish by setting
// check_valid=false. Another situation is that the test is not sufficiently thorough and some
// segments persist that should be eliminated. In this case, increase `quality` to 2 or 3. (This
// increases the number of samples on the segment that are checked.) Run time will increase. In
// some situations you may be able to decrease run time by setting quality to 0, which causes only
// segment ends to be checked.
//
// For construction of polyhedra `offset()` can also return face lists. These list faces between the
// original path and the offset path where the vertices are ordered with the original path first,
// starting at `firstface_index` and the offset path vertices appearing afterwords. The direction
// of the faces can be flipped using `flip_faces`. When you request faces the return value
// is a list: [offset_path, face_list].
// For construction of polyhedra `offset()` can also return face lists. These list faces between
// the original path and the offset path where the vertices are ordered with the original path
// first, starting at `firstface_index` and the offset path vertices appearing afterwords. The
// direction of the faces can be flipped using `flip_faces`. When you request faces the return
// value is a list: [offset_path, face_list].
// Arguments:
// path = the path to process. A list of 2d points.
// r = offset radius. Distance to offset. Will round over corners.