Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Import cylinderMK2 node from 2.79 to 2.80 #2404

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions docs/nodes/generator/cylinder_mk2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
Cylinder MK2
============

Functionality
-------------

This node generates primarily cylindrical shapes, but its settings allow to create a wide variety of tube like shapes.

Inputs
------

All inputs are vectorized and they will accept single or multiple values.

- **Radius Top**
- **Radius Bottom**
- **Parallels**
- **Meridians**
- **Height**
- **Twist**
- **Phase**
- **Scale**
- **Parallels Profile** [1]
- **Meridians Profile** [1]

[1] : The profiles inputs do not take input values from the node, but can take multiple values form the outside nodes.

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] |
+-----------------------+---------+---------+-------------------------------------------------------+

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.


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.


Outputs
-------

**Vertices**, **Edges** and **Polygons**.
All outputs will be generated when the output sockets are connected.
Depending on the type of the inputs the node will generate only one or multiples independant cylinder shapes.

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


1 change: 1 addition & 0 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
SvBoxNode
SvCircleNode
CylinderNode
SvCylinderNodeMK2
SphereNode
SvIcosphereNode
SvTorusNode
Expand Down
Loading