grey/BOSL2
1
0
Fork 0
mirror of https://github.com/BelfrySCAD/BOSL2.git synced 2024-12-29 08:19:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Tweaked docs for reindex_polygon

Browse source
This commit is contained in:
Adrian Mariano 2020-02-29 23:09:16 -05:00
parent 1e6cf426a9
commit 4a3ecfe9ba
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
geometry.scad
View file

@ -1030,13 +1030,13 @@ function polygon_shift_to_closest_point(path, pt) =
// Usage:
// newpoly = reindex_polygon(reference, poly);
// Description:
// Rotates and possibly reverses the point order of a polygon path to optimize its pairwise point
// association with a reference polygon. The two polygons must have the same number of vertices.
// Rotates and possibly reverses the point order of a 2d or 3d polygon path to optimize its pairwise point
// association with a reference polygon. The two polygons must have the same number of vertices and be the same dimension.
// The optimization is done by computing the distance, norm(reference[i]-poly[i]), between
// corresponding pairs of vertices of the two polygons and choosing the polygon point order that
// makes the total sum over all pairs as small as possible. Returns the reindexed polygon. Note
// that the geometry of the polygon is not changed by this operation, just the labeling of its
// vertices. If the input polygon is oriented opposite the reference then its point order is
// vertices. If the input polygon is 2d and is oriented opposite the reference then its point order is
// flipped.
// Arguments:
// reference = reference polygon path