Skip to content

Commit

Permalink
Merge pull request #4647 from nortikin/update_menu_nodes_comments_v08
Browse files Browse the repository at this point in the history 
Update docs and menu Number/*
  • Loading branch information
@satabol
satabol authored Sep 8, 2022
2 parents 621821c + 494421d commit c991a43
Show file tree
Hide file tree
Showing 37 changed files with 577 additions and 204 deletions.
8 changes: 7 additions & 1 deletion docs/nodes/generator/cylinder_mk2.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,10 @@ If **Separate** is True, the node will output the parallel sections as separate

* Number-> :doc:`A Number </nodes/number/numbers>`
* Number-> :doc:`Random Num Gen </nodes/number/random_num_gen>`
* Viz-> :doc:`Viewer Draw </nodes/viz/viewer_draw_mk4>`
* Viz-> :doc:`Viewer Draw </nodes/viz/viewer_draw_mk4>`

See also
--------

Example of a manual meridian profile:
* Number-> :doc:`Curve Mapper </nodes/number/curve_mapper>`
8 changes: 8 additions & 0 deletions docs/nodes/generator/random_vector_mk3.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,14 @@ Notes
Seed is applied per output, not for the whole operation
A unit vector has length of 1, a convex hull of random unit vectors will approximate a sphere with radius off 1.

Remark
------

For random numeric list see:

* Number-> :doc:`Random Num Gen </nodes/number/random_num_gen>` (int/float, range)
* Number-> :doc:`Random </nodes/number/random>` (float, count, 0-1)

Examples
--------

Expand Down
14 changes: 14 additions & 0 deletions docs/nodes/list_masks/mask_convert.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,17 @@ Examples of usage
.. image:: https://user-images.githubusercontent.com/28003269/83627743-7a1c8680-a5a8-11ea-99d1-ff9f01762216.png
:target: https://user-images.githubusercontent.com/28003269/83627743-7a1c8680-a5a8-11ea-99d1-ff9f01762216.png

Filter vertices and edges if some faces hided:

.. image:: https://user-images.githubusercontent.com/14288520/188969070-a084e68a-a657-4106-b9bf-a538f218a16c.png
:target: https://user-images.githubusercontent.com/14288520/188969070-a084e68a-a657-4106-b9bf-a538f218a16c.png

* Generator-> :doc:`Box </nodes/generator/box_mk2>`
* List->List Main-> :doc:`List Length </nodes/list_main/length>`
* List-> :doc:`List Mask (Out) </nodes/list_masks/mask>`
* Logic-> :doc:`Logic Functions (Not) </nodes/logic/logic_node>`
* Modifier->Modifier Change-> :doc:`Mask Vertices </nodes/modifier_change/vertices_mask>`
* Number-> :doc:`Random Num Gen </nodes/number/random_num_gen>`

.. image:: https://user-images.githubusercontent.com/14288520/188969187-0dafea41-0015-4eda-ae8d-ae8384b7f060.gif
:target: https://user-images.githubusercontent.com/14288520/188969187-0dafea41-0015-4eda-ae8d-ae8384b7f060.gif
2 changes: 1 addition & 1 deletion docs/nodes/list_struct/repeater.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ A practical reason to use the node is when you need a series of copies of edge o
* Number-> :doc:`Number Range </nodes/number/number_range>`
* Matrix-> :doc:`Matrix In </nodes/matrix/matrix_in_mk4>`
* Transforms-> :doc:`Matrix Apply (verts) </nodes/transforms/apply>`
* List->List Struct-> :doc:`List Length </nodes/list_main/length>`
* List->List Main-> :doc:`List Length </nodes/list_main/length>`
* Modifier->Modifier Change :doc:`Mesh Join </nodes/modifier_change/mesh_join_mk2>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
* Viz-> :doc:`Viewer Draw </nodes/viz/viewer_draw_mk4>`
20 changes: 20 additions & 0 deletions docs/nodes/number/curve_mapper.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Curve Mapper
============

.. image:: https://user-images.githubusercontent.com/14288520/189163825-3b10bd74-e86d-4767-99e3-13265c4e3a24.png
:target: https://user-images.githubusercontent.com/14288520/189163825-3b10bd74-e86d-4767-99e3-13265c4e3a24.png

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

Expand Down Expand Up @@ -39,11 +42,28 @@ Examples
Basic range remapping:

.. image:: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/number/Curve%20Mapper/curve_mapper_sverchok__blender_example_1.png
:target: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/number/Curve%20Mapper/curve_mapper_sverchok__blender_example_1.png

* Number-> :doc:`Number Range </nodes/number/number_range>`
* Viz-> :doc:`Texture Viewer </nodes/viz/viewer_texture>`

Using the node to define the column profile:

.. image:: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/number/Curve%20Mapper/curve_mapper_sverchok__blender_example_2.png
:target: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/number/Curve%20Mapper/curve_mapper_sverchok__blender_example_2.png

* Generator-> :doc:`Cylinder </nodes/generator/cylinder_mk2>`
* Generator-> :doc:`Plane </nodes/generator/plane_mk3>`
* Number-> :doc:`Number Range </nodes/number/number_range>`
* Matrix-> :doc:`Matrix In </nodes/matrix/matrix_in_mk4>`
* Viz-> :doc:`Viewer Draw </nodes/viz/viewer_draw_mk4>`

Example of the Curve output usage:

.. image:: https://user-images.githubusercontent.com/284644/80520701-4051d200-89a3-11ea-92fd-2f2f2004e4e7.png
:target: https://user-images.githubusercontent.com/284644/80520701-4051d200-89a3-11ea-92fd-2f2f2004e4e7.png

* Curve-> :doc:`Naturally Parametrized Curve </nodes/curve/length_rebuild>`
* Surface-> :doc:`Revolution Surface </nodes/surface/revolution_surface>`
* Surface-> :doc:`Evaluate Surface </nodes/surface/evaluate_surface>`
* Viz-> :doc:`Viewer Draw </nodes/viz/viewer_draw_mk4>`
11 changes: 11 additions & 0 deletions docs/nodes/number/easing.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Easing 0..1
===========

.. image:: https://user-images.githubusercontent.com/14288520/189156964-e5eb2bf2-0de8-45a1-a99d-8ffee5d62acf.png
:target: https://user-images.githubusercontent.com/14288520/189156964-e5eb2bf2-0de8-45a1-a99d-8ffee5d62acf.png

This node offers a finite list of interpolation functions. We've collected the easing functions in a visual document here

https://zeffii.github.io/docs_easing_node/
Expand All @@ -19,4 +22,12 @@ Add the node to the tree and connect something useful to the input, and scroll t


.. |visual_easing| image:: https://user-images.githubusercontent.com/619340/82451459-51779580-9aae-11ea-9dce-9a4dc1236014.png
:target: https://user-images.githubusercontent.com/619340/82451459-51779580-9aae-11ea-9dce-9a4dc1236014.png
.. |visual_viewport| image:: https://user-images.githubusercontent.com/619340/111627552-76808600-87ef-11eb-9929-f9295d766623.png
:target: https://user-images.githubusercontent.com/619340/111627552-76808600-87ef-11eb-9929-f9295d766623.png

* Number-> :doc:`Number Range </nodes/number/number_range>`
* Viz-> :doc:`Viewer 2D </nodes/viz/viewer_2d>`

.. image:: https://user-images.githubusercontent.com/14288520/189158182-ba3c78dc-bf17-415c-874a-ec6c3590ab5a.gif
:target: https://user-images.githubusercontent.com/14288520/189158182-ba3c78dc-bf17-415c-874a-ec6c3590ab5a.gif
24 changes: 17 additions & 7 deletions docs/nodes/number/exponential.rst
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Exponential Sequence
====================

*destination after Beta: Number*
.. image:: https://user-images.githubusercontent.com/14288520/189185050-cfe71e89-3201-4b88-a6aa-8c72aedd5d2f.png
:target: https://user-images.githubusercontent.com/14288520/189185050-cfe71e89-3201-4b88-a6aa-8c72aedd5d2f.png

Functionality
-------------
Expand All @@ -26,22 +27,28 @@ This node has the following parameters:
| Parameter | Type | Default | Description |
+================+===============+=============+====================================================+
| **Mode** | Enum: Log or | Log | If Log, then x_n = x0*exp(alpha*n). |
| | Base | | If Base, then x_n = x0*base^n. |
| | Base | | |
| | | | If Base, then x_n = x0*base^n. |
+----------------+---------------+-------------+----------------------------------------------------+
| **X0** | Float | 1.0 | Item of sequence for N=0. |
+----------------+---------------+-------------+----------------------------------------------------+
| **Alpha** | Float | 0.1 | Coefficient in formula exp(alpha*n). Used only in |
| | | | Log mode. |
| **Alpha** | Float | 0.1 | Coefficient in formula exp(alpha*n). |
| | | | |
| | | | Used only in Log mode. |
+----------------+---------------+-------------+----------------------------------------------------+
| **Base** | Float | 2.0 | Exponential base in formula base^n. Used only in |
| | | | Base mode. |
| **Base** | Float | 2.0 | Exponential base in formula base^n. |
| | | | |
| | | | Used only in Base mode. |
+----------------+---------------+-------------+----------------------------------------------------+
| **N from** | Int | 0 | Minimal value of N. |
+----------------+---------------+-------------+----------------------------------------------------+
| **N to** | Int | 10 | Maximal value of N. |
+----------------+---------------+-------------+----------------------------------------------------+
| **Max** | Float | 0.0 | If non-zero, then all output sequence will be |
| | | | re-scaled so that maximum of absolute values will |
| | | | re-scaled |
| | | | |
| | | | so that maximum of absolute values will |
| | | | |
| | | | be equal to number specified. |
+----------------+---------------+-------------+----------------------------------------------------+

Expand All @@ -59,8 +66,11 @@ Example of usage
Given simplest nodes setup:

.. image:: https://cloud.githubusercontent.com/assets/284644/5692369/d73d4846-9914-11e4-9bf3-133427d8d069.png
:target: https://cloud.githubusercontent.com/assets/284644/5692369/d73d4846-9914-11e4-9bf3-133427d8d069.png


you will have something like:

.. image:: https://cloud.githubusercontent.com/assets/284644/5692368/d6e3f8fe-9914-11e4-81cf-d6dffda3b359.png
:target: https://cloud.githubusercontent.com/assets/284644/5692368/d6e3f8fe-9914-11e4-81cf-d6dffda3b359.png

21 changes: 17 additions & 4 deletions docs/nodes/number/fibonacci.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Fibonacci Sequence
==================

.. image:: https://user-images.githubusercontent.com/14288520/189181489-6896836d-2249-4df1-8651-47752bb9fcaf.png
:target: https://user-images.githubusercontent.com/14288520/189181489-6896836d-2249-4df1-8651-47752bb9fcaf.png

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

Expand Down Expand Up @@ -45,10 +48,20 @@ inputs, then this node will produce several sequences.
Example of usage
----------------

Given simplest nodes setup:
No scale (max=0). Real Fibonacci values:

.. image:: https://user-images.githubusercontent.com/14288520/189183869-023d705c-a53b-4705-896d-4b7a0d6beec1.png
:target: https://user-images.githubusercontent.com/14288520/189183869-023d705c-a53b-4705-896d-4b7a0d6beec1.png

* Number-> :doc:`Number Range </nodes/number/number_range>`
* Vector-> :doc:`Vector In </nodes/vector/vector_in>`
* Viz-> :doc:`Viewer 2D </nodes/viz/viewer_2d>`

.. image:: https://cloud.githubusercontent.com/assets/284644/5691665/22a8bc0e-98f5-11e4-9ecc-924addf22178.png
Rescale to max value:

you will have something like:
.. image:: https://user-images.githubusercontent.com/14288520/189183892-b59c5f64-29a0-4caf-8546-3b8f51c0709f.png
:target: https://user-images.githubusercontent.com/14288520/189183892-b59c5f64-29a0-4caf-8546-3b8f51c0709f.png

.. image:: https://cloud.githubusercontent.com/assets/284644/5691664/227c9d0e-98f5-11e4-87c9-fb6f552e1b89.png
* Number-> :doc:`Number Range </nodes/number/number_range>`
* Vector-> :doc:`Vector In </nodes/vector/vector_in>`
* Viz-> :doc:`Viewer 2D </nodes/viz/viewer_2d>`
8 changes: 8 additions & 0 deletions docs/nodes/number/float_to_int.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Float to Integer
================

.. image:: https://user-images.githubusercontent.com/14288520/189150410-6de52cf6-21d4-4d08-8d2c-e756107ef937.png
:target: https://user-images.githubusercontent.com/14288520/189150410-6de52cf6-21d4-4d08-8d2c-e756107ef937.png

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

Expand Down Expand Up @@ -28,3 +31,8 @@ Examples

[1.0, 3.0, 2.4, 5.7] becomes [1, 3, 2, 6]

.. image:: https://user-images.githubusercontent.com/14288520/189150447-83ba97de-78c0-4be7-8453-7bfedad60d69.png
:target: https://user-images.githubusercontent.com/14288520/189150447-83ba97de-78c0-4be7-8453-7bfedad60d69.png

* Number-> :doc:`A Number </nodes/number/numbers>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
18 changes: 17 additions & 1 deletion docs/nodes/number/list_input.rst
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
List Input
==========

.. image:: https://user-images.githubusercontent.com/14288520/189119138-868bf887-8eb0-4839-8cf2-9664388bcb35.png
:target: https://user-images.githubusercontent.com/14288520/189119138-868bf887-8eb0-4839-8cf2-9664388bcb35.png

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

Provides a way to create a flat list of *Integers*, *Floats*, or *Vectors*.
The length of the list is hardcoded to a maximum of **32** elements for integer or float and **10** vectors,
we believe that if you need more then you should use a Text File and the Text In node.
we believe that if you need more then you should use a Text File

.. image:: https://user-images.githubusercontent.com/14288520/189121461-11d4ff38-7142-4da7-884a-10bf8e3d4915.png
:target: https://user-images.githubusercontent.com/14288520/189121461-11d4ff38-7142-4da7-884a-10bf8e3d4915.png

and the :doc:`Text->Text In+ </nodes/text/text_in_mk2>` node.


Parameters
----------
Expand All @@ -32,3 +41,10 @@ Examples
Useful when you have no immediate need to generate such lists programmatically.

.. image:: https://user-images.githubusercontent.com/28003269/70140711-c7c63e00-16ae-11ea-9266-e4f24586e448.png
:target: https://user-images.githubusercontent.com/28003269/70140711-c7c63e00-16ae-11ea-9266-e4f24586e448.png


.. image:: https://user-images.githubusercontent.com/14288520/189119167-e08360ab-fd27-47d1-947d-1c0628bdac8a.png
:target: https://user-images.githubusercontent.com/14288520/189119167-e08360ab-fd27-47d1-947d-1c0628bdac8a.png

* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
Loading

0 comments on commit c991a43

Please sign in to comment.