Port Profile node mk3 to 2.80 branch (#2543)

* Support ctrl+enter. * Support importing standard examples. * Add some profile examples. * Support "negated variable" syntax. * Start documentation. * Support for H/h, V/v commands. * Add an example of H/V commands usage. * update documentation. * Support S/s commands. * Fix table in the documentation. * Fix "c"/"s" implementation according to SVG specification. * Remove dummy "even_spread" component from C/c commands. * Change synax of "num_verts" parameter of curve commands. * Update documentation. * Implement Q/q, T/t commands (quadratic bezier) * info -> debug * Update example. * X command: support "remove doubles" functionality. * Add example. * Extend list of available functions. * Add examples. * Support JSON export/import. * Add example. * fix in "from selection" operator. * Add example. Update examples. * Support multiple segments for C/c, S/s commands. Support multisegment for Q/q, T/t commands. * Add examples. * Update documentation. Update documentation. * Support default values and let-expressions. * Update examples. Update documentation. Add example. * Split ProfileMk3 node implementation into several modules. * Add unit tests. * minor comment update. * Allow several X commands. * Add examples. update example. * Differentiate X and x commands. * Add tests. * Update documentation. Add/update examples. * Bugfix (tested versus Inkscape and Firefox). * File was not picked up by cherry-pick... * Update node to 2.80 standards * Update documentation. * Update tests. * Minor bugfix. * Update examples. * Update from master * Update menu name to 2.80 standard.

Port Profile node mk3 to 2.80 branch (#2543)
* Support ctrl+enter. * Support importing standard examples. * Add some profile examples. * Support "negated variable" syntax. * Start documentation. * Support for H/h, V/v commands. * Add an example of H/V commands usage. * update documentation. * Support S/s commands. * Fix table in the documentation. * Fix "c"/"s" implementation according to SVG specification. * Remove dummy "even_spread" component from C/c commands. * Change synax of "num_verts" parameter of curve commands. * Update documentation. * Implement Q/q, T/t commands (quadratic bezier) * info -> debug * Update example. * X command: support "remove doubles" functionality. * Add example. * Extend list of available functions. * Add examples. * Support JSON export/import. * Add example. * fix in "from selection" operator. * Add example. Update examples. * Support multiple segments for C/c, S/s commands. Support multisegment for Q/q, T/t commands. * Add examples. * Update documentation. Update documentation. * Support default values and let-expressions. * Update examples. Update documentation. Add example. * Split ProfileMk3 node implementation into several modules. * Add unit tests. * minor comment update. * Allow several X commands. * Add examples. update example. * Differentiate X and x commands. * Add tests. * Update documentation. Add/update examples. * Bugfix (tested versus Inkscape and Firefox). * File was not picked up by cherry-pick... * Update node to 2.80 standards * Update documentation. * Update tests. * Minor bugfix. * Update examples. * Update from master * Update menu name to 2.80 standard.
b9ea301d · Ilya V. Portnov · GitHub · 80408e37 · b9ea301d · b9ea301d
--- a/docs/nodes/generators_extended/profile_mk3.rst
+++ b/docs/nodes/generators_extended/profile_mk3.rst
+=======================
+Profile Parametric Node
+=======================
+
+
+**Profile Node** implements a useful subset of the SVG path section commands (see SVG specification_).
+Used domain-specific language (DSL) is based on SVG specification, but does not exactly follow it,
+by adding some extensions and not supporting some features.
+
+Profile definition consists of a series of statements (also called commands).
+
+Statements may optionally be separated by semicolons (`;`).
+For some commands (namely: `H`/`h`, `V`/`v`) the trailing semicolon is **required**!
+
+There are the following statements supported:
+
+* "default" statement: `default <name> = <value>`. Here `<name>` is any valid python variable identifier,
+  and `<value>` is a number or expression (see below). This statement declares a default value for the
+  variable; this value will be used if corresponding input of the node is not connected.
+* "let" statement: `let <name> = <value>`.  Here `<name>` is any valid python variable identifier,
+  and `<value>` is a number or expression (see below). This statement declares
+  a "name binding"; it may be used to calculate some value once and use it in
+  the following statements several times. Variables defined by "let" statements
+  will not appear as node inputs.
+* Line and curve segment commands - see the table below for details.
+
+The following segment types are available:
+
+---------------+-------+--------------------------------------------------------------------------------+ 
+| name          | cmd   | parameters                                                                     | 
+===============+=======+================================================================================+ 
+| MoveTo        | M,  m | <2v coordinate>                                                                |
+---------------+-------+--------------------------------------------------------------------------------+ 
+| LineTo        | L,  l | (<2v coordinate>)+ ["n = " num_segments] [z]                                   |
+---------------+-------+--------------------------------------------------------------------------------+ 
+| HorLineTo     | H,  h | (<x>)+ ["n = " num_segments] ";"                                               |
+---------------+-------+--------------------------------------------------------------------------------+ 
+| VertLineTo    | V,  v | (<y>)+ ["n = " num_segments] ";"                                               |
+---------------+-------+--------------------------------------------------------------------------------+ 
+| CurveTo       | C,  c | (<2v control1> <2v control2> <2v knot2>)+ ["n = " num_verts] [z]               |
+---------------+-------+--------------------------------------------------------------------------------+ 
+| SmoothCurveTo | S,  s | (<2v control2> <2v knot2>)+ ["n = " num_verts] [z]                             |
+---------------+-------+--------------------------------------------------------------------------------+ 
+| QuadCurveTo   | Q,  q | (<2v control> <2v knot2>)+ ["n = " num_segments] [z]                           |
+---------------+-------+--------------------------------------------------------------------------------+ 
+| SmthQuadCurve | T,  t | (<2v knot2>)+ ["n = " num_segments] [z]                                        |
+---------------+-------+--------------------------------------------------------------------------------+ 
+| ArcTo         | A,  a | <2v rx,ry> <float rot> <int flag1> <int flag2> <2v x,y> ["n = " num_verts] [z] |
+---------------+-------+--------------------------------------------------------------------------------+ 
+| ClosePath     | x     |                                                                                |  
+---------------+-------+--------------------------------------------------------------------------------+ 
+| CloseAll      | X     |                                                                                |  
+---------------+-------+--------------------------------------------------------------------------------+ 
+| comment       | #     | anything after # is a comment.                                                 |
+---------------+-------+--------------------------------------------------------------------------------+ 
+
+::
+
+    <>  : mandatory field
+    []  : optional field
+    2v  : two point vector `a,b`
+            - no backticks
+            - a and b can be 
+                - number literals
+                - lowercase 1-character symbols for variables
+    (...)+ : this sequence may appear several times
+    int : means the value will be cast as an int even if you input float
+          flags generally are 0 or 1.
+    ["n = " num_verts] : for curve and line commands, number of subdivisions may be specified.
+          For curve commands, default number of segments is specified in node settings (in the N panel).
+          For line commands, default number of segments is always 1.
+    z   : is optional for closing a line
+    X   : as a final command to close the edges (cyclic) [-1, 0]
+          in addition, if the first and last vertex share coordinate space
+          the last vertex is dropped and the cycle is made anyway.
+    #   : single line comment prefix
+
+
+Commands starting with capital letters (M, L, C, A) define all coordinates in absolute mode.
+Commands starting with lower case letters (m, l, c, a) define all coordinates in relative mode,
+i.e. each coordinate is defined with relation to "current pen position".
+
+Each integer or floating value may be represented as
+ 
+* Integer or floating literal (usual python syntax, such as 5 or 7.5)
+* Variable name, such as `a` or `b` or `variable_name`
+* Negation sign and a variable name, such as `-a` or `-size`.
+* Expression enclosed in curly brackets, such as `{a+1}` or `{sin(phi)}`
+
+ArcTo only take enough parameters to complete one Arc, unlike real SVG command
+which take a whole sequence of chained ArcTo commands. The decision
+to keep it at one segment type per line is mainly to preserve readability.
+
+Other curve segments (C/c, S/s, Q/q, T/t) allow to draw several segments with
+one command, as well as in SVG; but still, in many cases it is a good idea to
+use one segment per command, for readability reasons.
+
+All curve segment types allow you to specify how many vertices are
+used to generate the segment. SVG doesn't let you specify such things, but it
+makes sense to allow it for the creation of geometry.
+
+**Note**: "default" and "let" definitions may use previously defined variables,
+or variables expected to be provided as inputs. Just note that these statements
+are evaluated in the same order as they follow in the input profile text.
+
+For examples, see "Examples of usage" section below, or `profile_examples`
+directory in Sverchok distribution.
+
+.. _specification: https://www.w3.org/TR/SVG/paths.html
+
+Expression syntax
+-----------------
+
+Syntax being used in profile definitions is standard Python's syntax for expressions. 
+For exact syntax definition, please refer to https://docs.python.org/3/reference/expressions.html.
+
+In short, you can use usual mathematical operations (`+`, `-`, `*`, `/`, `**`
+for power), numbers, variables, parenthesis, and function call, such as
+`sin(x)`.
+
+One difference with Python's syntax is that you can call only restricted number
+of Python's functions. Allowed are:
+
+- Functions from math module:
+  - acos, acosh, asin, asinh, atan, atan2,
+        atanh, ceil, copysign, cos, cosh, degrees,
+        erf, erfc, exp, expm1, fabs, factorial, floor,
+        fmod, frexp, fsum, gamma, hypot, isfinite, isinf,
+        isnan, ldexp, lgamma, log, log10, log1p, log2, modf,
+        pow, radians, sin, sinh, sqrt, tan, tanh, trunc;
+- Constants from math module: pi, e;
+- Additional functions: abs;
+- From mathutlis module: Vector, Matrix;
+- Python type conversions: tuple, list.
+
+This restriction is for security reasons. However, Python's ecosystem does not
+guarantee that noone can call some unsafe operations by using some sort of
+language-level hacks. So, please be warned that usage of this node with profile
+definition obtained from unknown or untrusted source can potentially harm your
+system or data.
+
+Examples of valid expressions are:
+
+* 1.0
+* x
+* {x+1}
+* {0.75*X + 0.25*Y}
+* {R * sin(phi)}
+
+Inputs
+------
+
+Set of inputs for this node depends on expressions used in the profile
+definition. Each variable used in profile (except ones declared with "let"
+statements) becomes one input. If there are no variables used in profile, then
+this node will have no inputs.
+
+Parameters
+----------
+
+This node has the following parameters:
+
+- **Axis**. Available values are **X**, **Y**, **Z**. This parameter specifies
+  the plane in which the curve will be produced. For example, default value of
+  **Z** means that all points will belong to XOY plane.
+- **File name**. Name of Blender text buffer, containing profile description.
+- **Precision**. Number of decimal places used for points coordinates when
+  generating a profile by **from selection** operator. Default value is 8. This
+  parameter is only available in the N panel.
+- **Curve points count**. Default number of points for curve segment commands.
+  Default value is 20. This parameter is available only in the N panel.
+- **X command threshold**. This parameter provides control over "remove
+  doubles" functionality of the X command: if the distance between last and
+  first points is less than this threshold, X command will remove the last
+  point and connect pre-last point to the first instead.
+
+Outputs
+-------
+
+This node has the following outputs:
+
+* **Vertices**. Resulting curve vertices.
+* **Edges**. Edges of the resulting curve.
+* **Knots**. Knot points of all curve segments (C/c, S/s, Q/q, T/t commands) used in the profile.
+* **KnotNames**. Names of all knot points. This output in junction with
+  **Knots** may be used to display all knots in the 3D view by use of **Viewer
+  Index** node - this is very useful for debugging of your profile.
+
+Operators
+---------
+
+As you know there are three types of curves in Blender - Polylines, Bezier curves and NURBS curves.
+This node has one operator button: **from selection**. This operator works only with Bezier curves.
+It takes an active Curve object, generates profile description from it and sets up the node
+to use this generated profile. You can adjust the profile by editing created Blender's text bufrfer.
+
+If you want to import other type of curve you have to convert one to Bezier type. 
+Fortunately it is possible to do in edit mode with button *Set Spline Type* in the *T* panel.
+More information about conversion looks `here <https://docs.blender.org/manual/en/dev/modeling/curves/editing/introduction.html#set-spline-type>`_.
+
+.. image:: https://user-images.githubusercontent.com/28003269/41649336-67dc2d1c-748c-11e8-9989-5b7d8d212b1c.png
+
+One can also load one of examples, which are provided within Sverchok distribution. For that,
+in the **N** panel of Profile node, see "Profile templates" menu.
+
+Examples
+--------
+
+If you have experience with SVG paths most of this will be familiar. The
+biggest difference is that only the LineTo command accepts many points. It is a
+good idea to always start the profile with a M <pos>,<pos>.
+
+::
+
+    M 0,0
+    L a,a b,0 c,0 d,d e,-e 
+    
+
+the fun bit about this is that all these variables / components can be dynamic
+
+::
+
+    M 0,0
+    L 0,3 2,3 2,4
+    C 2,5 2,5 3,5 n=10
+    L 5,5
+    C 7,5 7,5 7,3 n=10
+    L 7,2 5,0
+    X
+    
+or
+
+::
+
+    M a,a
+    L a,b c,b -c,d
+    C c,e c,e b,e n=g
+    L e,e
+    C f,e f,e f,-b n=g
+    L f,c e,a
+    X
+
+
+Examples of usage
+-----------------
+
+The node started out as a thought experiment and turned into something quite
+useful, you can see how it evolved in the `initial github thread <https://github.com/nortikin/sverchok/issues/350>`_ ; 
+See also `last github thread <https://github.com/nortikin/sverchok/pull/2450>`_ and examples provided within Sverchok distribution (N panel of the node).
+ 
+Example usage:
+
+.. image:: https://user-images.githubusercontent.com/284644/59453976-8e60f400-8e2a-11e9-8a27-34be6e1fc037.png
+
+::
+
+      Q 3,H 6,0
+      t 6,0
+      t 6,0
+      t 0,-6
+      t -6,0
+      t -6,0
+      t -6,0
+      t 0,6
+ 
+
+.. image:: https://user-images.githubusercontent.com/284644/59548976-f4a35f00-8f6f-11e9-89cd-4c7257e3d753.png
+
+::
+
+      C 1,1 2,1 3,0 4,-1 5,-1 6,0
+      s 1,2 0,3 -1,5 0,6
+      S 1,7 0,6 -1,-1 0,0 n=40
+      X
+
+An example with use of "default" and "let" statements:
+
+.. image:: https://user-images.githubusercontent.com/284644/59552437-4237c000-8fa0-11e9-91ac-6fd41cae2d73.png
+
+:: 
+
+      default straight_len = 1;
+      default radius = 0.4;
+
+      let rem = {radius / tan(phi/2)};
+
+      H straight_len ;
+      a radius,radius 0 0 1
+        {rem * (1 - cos(phi))}, {rem * sin(phi)}
+        n = 10
+      l {- straight_len * cos(phi)}, {straight_len * sin(phi)}
+
+Gotchas
+-------
+
+The update mechanism doesn't process inputs or anything until the following conditions are satisfied:
+
+* All inputs have to be connected, except ones that have default values
+  declared by "default" statements.
+* The file field on the Node points to an existing Text File.
+
+
+Keyboard Shortcut to refresh Profile Node
+-----------------------------------------
+
+Updates made to the profile path text file are not propagated automatically to
+any nodes that might be reading that file. 
+To refresh a Profile Node simply hit ``Ctrl+Enter`` In TextEditor while you are
+editing the file, or click one of the inputs or output sockets of Profile Node.
+There are other ways to refresh (change a value on one of the incoming nodes,
+or clicking the sockets of the incoming nodes)
+
--- a/index.md
+++ b/index.md
@@ -37,6 +37,7 @@
    Hilbert3dNode
    HilbertImageNode
    SvProfileNodeMK2
+    SvProfileNodeMK3
    SvMeshEvalNode
    SvGenerativeArtNode
    SvImageComponentsNode

--- a/nodes/generators_extended/profile_mk3.py
+++ b/nodes/generators_extended/profile_mk3.py
--- a/profile_examples/arc_fillet.txt
+++ b/profile_examples/arc_fillet.txt
+default straight_len = 1;
+default radius = 0.4;
+
+let rem = {radius / tan(phi/2)};
+
+H straight_len ;
+a radius,radius 0 0 1
+  {rem * (1 - cos(phi))}, {rem * sin(phi)}
+  n = 10
+l {- straight_len * cos(phi)}, {straight_len * sin(phi)}
\ Нет новой строки в конце файла
--- a/profile_examples/barrel.txt
+++ b/profile_examples/barrel.txt
+default caps_divisions = 4
+let handle_x = {width/2};
+let handle_y = {height/8};
+
+M {-width/2},0
+h width n=caps_divisions;
+c handle_x,handle_y handle_x,{height-handle_y} 0,height
+h -width n=caps_divisions;
+c -handle_x,-handle_y -handle_x,{-height+handle_y} 0,-height
+X
--- a/profile_examples/bevel_line.txt
+++ b/profile_examples/bevel_line.txt
+L d,rad {len-d},rad len,0
+
--- a/profile_examples/complex_curve.txt
+++ b/profile_examples/complex_curve.txt
+M -1.0,0.0 
+L -1.0,4.0 
+l -2,0
+C -5.0,4.0 -5.0,6.0 -3.0,6.0
+l 2,0
+l 0,1
+C -1.0,9.0 1.0,9.0 1.0,7.0
+l 0,-1
+l 2,0
+C 5.0,6.0 5.0,4.0 3.0,4.0
+L 1.0,4.0 1.0,0.0 
+X
+
--- a/profile_examples/complex_rectangle.txt
+++ b/profile_examples/complex_rectangle.txt
+default width = 4
+default height = 3
+default radius = 0.5
+default b_width = 2;
+default b_height = 0.5
+
+let w2 = {width/2 - radius}
+let w = {width - 2*radius}
+let h = {height - 2*radius}
+let dw = {(w - b_width)/2}
+
+H w2;
+q radius,0 radius,radius
+v h ;
+q 0,radius -radius,radius
+h -dw ;
+v -b_height ;
+h -b_width ;
+v b_height ;
+h -dw;
+q -radius,0 -radius,-radius
+v -h;
+q 0,-radius radius,-radius
+X
\ Нет новой строки в конце файла
--- a/profile_examples/i-beam.txt
+++ b/profile_examples/i-beam.txt
+default bottom_w = 0.6
+default bottom_dx = 0.1
+default bottom_height = 0.3
+default base_height = 1
+default base_w = 0.2
+default top_w = 1.2
+default top_dx = bottom_dx
+default top_height = bottom_height
+default base_dx = bottom_dx
+
+H bottom_w ;
+l bottom_dx, bottom_height
+H base_w ;
+l base_dx, base_height
+H top_w ;
+l top_dx, top_height
+H 0 ;
\ Нет новой строки в конце файла
--- a/profile_examples/pawn.txt
+++ b/profile_examples/pawn.txt
+M 0,0 
+
+#C.1
+H 1.92243171 ;
+#L.2...
+L 1.99824715,0.31148303 1.72891283,0.30400151 
+#C.4
+C 1.80497479,0.3788166 1.92841959,0.38629809 1.95709872,0.52844679 
+#C.5
+C 1.99377036,0.71021062 1.55546045,0.8829388 1.30994821,1.07085621 
+
+#C.6
+C 1.05147767,1.26869202 0.67236388,1.61017454 0.51690823,2.03073382 
+
+#C.7
+C 0.35324755,2.47349048 0.28897169,2.84397411 0.31041858,3.18887138 
+
+#C.8
+C 0.33866882,3.64317679 0.69765115,3.57411408 0.92902559,3.8307848 
+
+#C.9
+C 1.10597277,4.02707767 0.61380589,3.98830867 0.41398257,3.99238539 
+
+#C.10
+C 0.67996293,4.1811552 0.78434891,4.38305283 0.78329557,4.66000605 
+
+#C.11
+C 0.78170198,5.07901382 0.47744593,5.28435373 0.0,5.2843318 
--- a/profile_examples/quadratic_bubble.txt
+++ b/profile_examples/quadratic_bubble.txt
+Q 2,1 4,0
+t 1, -3 -3,-3
+T 0,0
+X
\ Нет новой строки в конце файла
--- a/profile_examples/quadratic_fillet.txt
+++ b/profile_examples/quadratic_fillet.txt
+default straight_len = 1;
+default radius = 0.2;
+
+H straight_len ;
+q radius,0 {radius - radius * cos(phi)}, {radius * sin(phi)}
+l {- straight_len * cos(phi)}, {straight_len * sin(phi)}
\ Нет новой строки в конце файла
--- a/profile_examples/quadratic_goggles.txt
+++ b/profile_examples/quadratic_goggles.txt
+Q {size/2},C size,0
+t size,0
+t size,0
+t 0,-size
+t -size,0
+t -size,0
+t -size,0
+t 0,size
+X
\ Нет новой строки в конце файла
--- a/profile_examples/quadratic_sample.txt
+++ b/profile_examples/quadratic_sample.txt
+Q 3,H 6,0
+t 6,0
+t 6,0
+t 0,-6
+t -6,0
+t -6,0
+t -6,0
+t 0,6
\ Нет новой строки в конце файла
--- a/profile_examples/rectangle.txt
+++ b/profile_examples/rectangle.txt
+l width,0 0,height {-width},0 z
--- a/profile_examples/rounded_line.txt
+++ b/profile_examples/rounded_line.txt
+let dr = {R - r}
+let straight_len = {length - 2*dr}
+
+v r;
+a dr,dr 0 0 0
+  dr,dr
+h straight_len;
+a dr,dr 0 0 0
+  dr,-dr
+v -r;
\ Нет новой строки в конце файла
--- a/profile_examples/simple_curve.txt
+++ b/profile_examples/simple_curve.txt
+C control,control {size-control},control size,0 n=n
--- a/profile_examples/smooth_arrow.txt
+++ b/profile_examples/smooth_arrow.txt
+C 1,1 2,1 3,0 4,-1 5,-1 6,0
+s 1,2 0,3 -1,5 0,6
+S 1,7 0,6 -1,-1 0,0 n=40
+X
\ Нет новой строки в конце файла
--- a/profile_examples/smooth_curve.txt
+++ b/profile_examples/smooth_curve.txt
+M 0,0
+C 1,1 3,1 4,0
+s 3,-1 4,0 
+s 3,1 4,0 
+s 1,-3 0,-4
+s -3,-1 -4,0
+s -3,1 -4,0
+s -3,-1 -4,0
+
--- a/profile_examples/square.txt
+++ b/profile_examples/square.txt
+M -size, -size
+L size,-size size,size -size,size z
+