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

vnf usage messages

Browse source
This commit is contained in:
Adrian Mariano 2022-03-30 20:50:55 -04:00
parent bca34303cf
commit 0af8b9527a
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
vnf.scad
View file

@ -27,7 +27,7 @@ EMPTY_VNF = [[],[]]; // The standard empty VNF with no vertices or faces.
// Function: vnf_vertex_array() // Function: vnf_vertex_array()
// Usage: // Usage:
// vnf = vnf_vertex_array(points, [caps], [cap1], [cap2], [style], [reverse], [col_wrap], [row_wrap]); // vnf = vnf_vertex_array(points, [caps=], [cap1=], [cap2=], [style=], [reverse=], [col_wrap=], [row_wrap=]);
// Description: // Description:
// Creates a VNF structure from a rectangular vertex list, by dividing the vertices into columns and rows, // Creates a VNF structure from a rectangular vertex list, by dividing the vertices into columns and rows,
// adding faces to tile the surface. You can optionally have faces added to wrap the last column // adding faces to tile the surface. You can optionally have faces added to wrap the last column
@ -1087,7 +1087,7 @@ function _triangulate_planar_convex_polygons(polys) =
// Function: vnf_bend() // Function: vnf_bend()
// Usage: // Usage:
// bentvnf = vnf_bend(vnf,r,d,[axis]); // bentvnf = vnf_bend(vnf,r|d=,[axis=]);
// Description: // Description:
// Bend a VNF around the X, Y or Z axis, splitting up faces as necessary. Returns the bent // Bend a VNF around the X, Y or Z axis, splitting up faces as necessary. Returns the bent
// VNF. For bending around the Z axis the input VNF must not cross the Y=0 plane. For bending // VNF. For bending around the Z axis the input VNF must not cross the Y=0 plane. For bending
@ -1292,7 +1292,7 @@ module _show_faces(vertices, faces, size=1) {
// Module: debug_vnf() // Module: debug_vnf()
// Usage: // Usage:
// debug_vnf(vnfs, [faces], [vertices], [opacity], [size], [convexity]); // debug_vnf(vnfs, [faces=], [vertices=], [opacity=], [size=], [convexity=]);
// Description: // Description:
// A drop-in module to replace `vnf_polyhedron()` to help debug vertices and faces. // A drop-in module to replace `vnf_polyhedron()` to help debug vertices and faces.
// Draws all the vertices at their 3D position, numbered in blue by their // Draws all the vertices at their 3D position, numbered in blue by their
@ -1332,7 +1332,7 @@ module debug_vnf(vnf, faces=true, vertices=true, opacity=0.5, size=1, convexity=
// Usage: As Function // Usage: As Function
// fails = vnf_validate(vnf); // fails = vnf_validate(vnf);
// Usage: As Module // Usage: As Module
// vnf_validate(vnf, [size]); // vnf_validate(vnf, [size], [check_isects]);
// Description: // Description:
// When called as a function, returns a list of non-manifold errors with the given VNF. // When called as a function, returns a list of non-manifold errors with the given VNF.
// Each error has the format `[ERR_OR_WARN,CODE,MESG,POINTS,COLOR]`. // Each error has the format `[ERR_OR_WARN,CODE,MESG,POINTS,COLOR]`.
@ -1358,6 +1358,8 @@ module debug_vnf(vnf, faces=true, vertices=true, opacity=0.5, size=1, convexity=
// Arguments: // Arguments:
// vnf = The VNF to validate. // vnf = The VNF to validate.
// size = The width of the lines and diameter of points used to highlight edges and vertices. Module only. Default: 1 // size = The width of the lines and diameter of points used to highlight edges and vertices. Module only. Default: 1
// --
// show_warns = If true show warnings for non-triangular faces. Default: true
// check_isects = If true, performs slow checks for intersecting faces. Default: false // check_isects = If true, performs slow checks for intersecting faces. Default: false
// Example: BIG_FACE Warnings; Faces with More Than 3 Vertices. CGAL often will fail to accept that a face is planar after a rotation, if it has more than 3 vertices. // Example: BIG_FACE Warnings; Faces with More Than 3 Vertices. CGAL often will fail to accept that a face is planar after a rotation, if it has more than 3 vertices.
// vnf = skin([ // vnf = skin([
@ -1628,6 +1630,7 @@ function _edge_not_reported(edge, varr, reports) =
module vnf_validate(vnf, size=1, show_warns=true, check_isects=false) { module vnf_validate(vnf, size=1, show_warns=true, check_isects=false) {
no_children($children);
faults = vnf_validate( faults = vnf_validate(
vnf, show_warns=show_warns, vnf, show_warns=show_warns,
check_isects=check_isects check_isects=check_isects