Skip to content

Commit

Permalink
Merge pull request #4653 from nortikin/update_menu_nodes_comments_v10
Browse files Browse the repository at this point in the history 
Update Vector/* docs and menu tooltips
  • Loading branch information
@satabol
satabol authored Sep 11, 2022
2 parents a27f55f + c386a6a commit 693a9c9
Show file tree
Hide file tree
Showing 43 changed files with 792 additions and 220 deletions.
93 changes: 51 additions & 42 deletions docs/nodes/generator/cylinder_mk2.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,56 +32,61 @@ Parameters

The **Separate**, **Cap T**, **Cap B**, **Center** and the **Angle Units** can be given by the node only. The other parameters can take values either from the node or the external nodes.

+-----------------------+---------+---------+-------------------------------------------------------+
| Param | Type | Default | Description |
+=======================+=========+=========+=======================================================+
| **Radius Top** | Float | 1.00 | The radius of the top parallel. |
+-----------------------+---------+---------+-------------------------------------------------------+
| **Radius Bottom** | Float | 1.00 | The radius of the bottom parallel. |
+-----------------------+---------+---------+-------------------------------------------------------+
| **Parallels** | Int | 2 | The number of parallel lines. |
| | | | This is also the number of points in a meridian. |
+-----------------------+---------+---------+-------------------------------------------------------+
| **Meridians** | Int | 32 | The number of meridian lines. |
| | | | This is also the number of points in a parallel. |
+-----------------------+---------+---------+-------------------------------------------------------+
| **Height** | Float | 2.00 | The height of the cylinder. |
+-----------------------+---------+---------+-------------------------------------------------------+
| **Twist** | Float | 0.0 | The amount of rotation around the z-axis of the |
| | | | parallel lines from the bottom to the top parallel. |
+-----------------------+---------+---------+-------------------------------------------------------+
| **Phase** | Float | 0.0 | The amount of rotation around the z-axis of all the |
| | | | vertices in the mesh. |
+-----------------------+---------+---------+-------------------------------------------------------+
| **Parallels Profile** | [Float] | [ ] | The scale modulating the radius of the parallels. [1] |
+-----------------------+---------+---------+-------------------------------------------------------+
| **Meridians Profile** | [Float] | [ ] | The scale modulating the radius of the meridians. [1] |
+-----------------------+---------+---------+-------------------------------------------------------+
| **Caps T** | Boolean | True | Generate the top cap or not. |
+-----------------------+---------+---------+-------------------------------------------------------+
| **Caps B** | Boolean | True | Generate the bottom cap or not. |
+-----------------------+---------+---------+-------------------------------------------------------+
| **Separate** | Boolean | False | Separate the parallels into separate lists. [2] |
+-----------------------+---------+---------+-------------------------------------------------------+
| **Center** | Boolean | True | Center the cylinder around the origin. |
+-----------------------+---------+---------+-------------------------------------------------------+
| **Angle Units** | Enum | RAD | The **Twist** and **Phase** angles are interpreted as |
| | RAD | | RAD : Radians [0, 2*pi] |
| | DEG | | DEG : Degrees [0, 360] |
| | UNI | | UNI : Unities [0, 1] |
+-----------------------+---------+---------+-------------------------------------------------------+
+-----------------------+---------+---------+-----------------------------------------------------------+
| Param | Type | Default | Description |
+=======================+=========+=========+===========================================================+
| **Radius Top** | Float | 1.00 | The radius of the top parallel. |
+-----------------------+---------+---------+-----------------------------------------------------------+
| **Radius Bottom** | Float | 1.00 | The radius of the bottom parallel. |
+-----------------------+---------+---------+-----------------------------------------------------------+
| **Parallels** | Int | 2 | The number of parallel lines. |
| | | | |
| | | | This is also the number of points in a meridian. |
+-----------------------+---------+---------+-----------------------------------------------------------+
| **Meridians** | Int | 32 | The number of meridian lines. |
| | | | |
| | | | This is also the number of points in a parallel. |
+-----------------------+---------+---------+-----------------------------------------------------------+
| **Height** | Float | 2.00 | The height of the cylinder. |
+-----------------------+---------+---------+-----------------------------------------------------------+
| **Twist** | Float | 0.0 | The amount of rotation around the z-axis of the |
| | | | |
| | | | parallel lines from the bottom to the top parallel. |
+-----------------------+---------+---------+-----------------------------------------------------------+
| **Phase** | Float | 0.0 | The amount of rotation around the z-axis of all the |
| | | | |
| | | | vertices in the mesh. |
+-----------------------+---------+---------+-----------------------------------------------------------+
| **Parallels Profile** | [Float] | [ ] | The scale modulating the radius of the parallels. **[1]** |
+-----------------------+---------+---------+-----------------------------------------------------------+
| **Meridians Profile** | [Float] | [ ] | The scale modulating the radius of the meridians. **[1]** |
+-----------------------+---------+---------+-----------------------------------------------------------+
| **Caps T** | Boolean | True | Generate the top cap or not. |
+-----------------------+---------+---------+-----------------------------------------------------------+
| **Caps B** | Boolean | True | Generate the bottom cap or not. |
+-----------------------+---------+---------+-----------------------------------------------------------+
| **Separate** | Boolean | False | Separate the parallels into separate lists. **[2]** |
+-----------------------+---------+---------+-----------------------------------------------------------+
| **Center** | Boolean | True | Center the cylinder around the origin. |
+-----------------------+---------+---------+-----------------------------------------------------------+
| **Angle Units** | Enum | RAD | The **Twist** and **Phase** angles are interpreted as |
| | | | |
| | * RAD | | * RAD : Radians [0.0, 2*pi] |
| | * DEG | | * DEG : Degrees [0.0, 360.0] |
| | * UNI | | * UNI : Unities [0.0, 1.0] |
+-----------------------+---------+---------+-----------------------------------------------------------+

Notes:
[1] : If connected the profiles need to have lists of at least 2 values.
[2] : This splits the verts, edges, and polys into separate parallel sections.

* **[1]** : If connected the profiles need to have lists of at least 2 values.
* **[2]** : This splits the verts, edges, and polys into separate parallel sections.


Extended Parameters
-------------------
The Property Panel provides additional parameters.

**Cyclic**
This parameter is used for treating the connected **Parallels Profile** as a cyclic spline curve and it is useful to ensure smooth parallel curves whenever there's discontinuity in the value and/or in the tangent of the starting/ending points of the profile.
* **Cyclic** This parameter is used for treating the connected **Parallels Profile** as a cyclic spline curve and it is useful to ensure smooth parallel curves whenever there's discontinuity in the value and/or in the tangent of the starting/ending points of the profile.


Outputs
Expand All @@ -93,6 +98,9 @@ Depending on the type of the inputs the node will generate only one or multiples

If **Separate** is True, the node will output the parallel sections as separate lists (verts, edges and polys).

.. image:: https://user-images.githubusercontent.com/14288520/189488345-2daba527-0aa0-463d-bd0d-4dfbbc0d59af.png
:target: https://user-images.githubusercontent.com/14288520/189488345-2daba527-0aa0-463d-bd0d-4dfbbc0d59af.png

**Examples**

.. image:: https://user-images.githubusercontent.com/14288520/188701121-947eabdc-b13d-45f6-9ea5-4204162a0c97.png
Expand All @@ -109,4 +117,5 @@ See also
--------

Example of a manual meridian profile:

* Number-> :doc:`Curve Mapper </nodes/number/curve_mapper>`
6 changes: 5 additions & 1 deletion docs/nodes/generator/line_mk4.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,15 @@ Parameters
| Param | Type | Default | Description |
+===============+=====================+==============+=========================================================+
| **Direction** | Enum: | "X" | * X/Y/Z - Ortho direction |
| | | | |
| | X/Y/Z/OP/OD | | * OP - Origin and point on line |
| | | | * OD - Origin and Direction |
+---------------+---------------------+--------------+---------------------------------------------------------+
| **Length** | Enum: | "Size" | Method of line size determination |
| | Size/Num/Step/St+Si | | |
| | | | |
| | Size/Num/Step/ | | |
| | | | |
| | St+Si | | |
+---------------+---------------------+--------------+---------------------------------------------------------+
| **Center** | Boolean | False | center line in origin |
+---------------+---------------------+--------------+---------------------------------------------------------+
Expand Down
8 changes: 8 additions & 0 deletions docs/nodes/generator/ngon.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,19 @@ All parameters can be given by the node or an external input.
| Param | Type | Default | Description |
+================+===============+=============+=============================================================+
| **Radius** | Float | 1.00 | Radius of escribed circle. When ``RandomR`` is zero, |
| | | | |
| | | | then all vertices will be at this distance from origin. |
+----------------+---------------+-------------+-------------------------------------------------------------+
| **N Sides** | Int | 5 | Number of sides of polygon to generate. With higher |
| | | | |
| | | | values and ``Shift`` = 0, ``RandomR`` = 0, ``RandomPhi`` |
| | | | |
| | | | = 0, you will get the same output as from Circle node. |
+----------------+---------------+-------------+-------------------------------------------------------------+
| **Divisions** | Int | 1 | Divide each side of the polygon to specified number of |
| | | | |
| | | | segments. For example, with ``Divisions`` = 2, there will |
| | | | |
| | | | be an additional vertex at the middle of each side. |
+----------------+---------------+-------------+-------------------------------------------------------------+
| **RandomR** | Float | 0.0 | Amplitude of randomization of vertices along radius. |
Expand All @@ -67,8 +72,11 @@ All parameters can be given by the node or an external input.
| | | | ``RandomPhi`` != 0. |
+----------------+---------------+-------------+-------------------------------------------------------------+
| **Shift** | Int | 0 | Also known as "star factor". When this is zero, each vertex |
| | | | |
| | | | is connected by edge to next one, and you will get usual |
| | | | |
| | | | polygon. Otherwise, n'th vertex will be connected to |
| | | | |
| | | | (n+shift+1)'th. In this case, you will get sort of star. |
+----------------+---------------+-------------+-------------------------------------------------------------+

Expand Down
5 changes: 3 additions & 2 deletions docs/nodes/generator/segment.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ Parameters
| Param | Type | Default | Description |
+===============+===============+==============+=========================================================+
| **Cute modes**| Enum | "Cuts" | **Cuts** - cut line evenly |
| | | | **Steps** - cut line proportionally by given steps |
| | | | |
| | Cuts/Steps | | **Steps** - cut line proportionally by given steps |
+---------------+---------------+--------------+---------------------------------------------------------+
| **Split to | Boolean | | |
| objects** | (N panel) | True       | Each line will be put to separate object any way |
Expand Down Expand Up @@ -63,7 +64,7 @@ The AB mode will output a divided segment for each vector pair, the step can be
.. image:: https://user-images.githubusercontent.com/14288520/188512296-6287d7eb-ae38-4087-9a31-1fe433deea93.gif
:target: https://user-images.githubusercontent.com/14288520/188512296-6287d7eb-ae38-4087-9a31-1fe433deea93.gif

* Modifiers->Modifier Make :doc:`UV Connections </nodes/modifier_make/uv_connect>`
* Modifiers->Modifier Make-> :doc:`UV Connection </nodes/modifier_make/uv_connect>`
* Modifiers->Modifier Make :doc:`WireFrame </nodes/modifier_make/wireframe>`
* Viz-> :doc:`Viewer Draw </nodes/viz/viewer_draw_mk4>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
Expand Down
Loading

0 comments on commit 693a9c9

Please sign in to comment.