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

Update docs and images, some errata #4636

Merged
merged 1 commit into from
Aug 31, 2022
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
2 changes: 1 addition & 1 deletion docs/nodes/generators_extended/pentagon_tiler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ In the N-Panel (and on the right-click menu) you can find:

**Angle Units**: Choose if the input angles will be interpreted as Degrees or Radians

**Flat output**: Flatten output by list-joining level 1 and unwarping it (default set to True)
**Flat output**: Flatten output by list-joining level 1 and unwraping it (default set to True)

**Match List Global**: Define how list with different lengths should be matched. Refers to the matching of groups (level 1)

Expand Down
2 changes: 1 addition & 1 deletion docs/nodes/generators_extended/triangle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ In the N-Panel (and on the right-click menu) you can find:

**Tolerance**: Removing Doubles Tolerance (only active when "Remove Doubles" is True)

**Flat output**: Flatten output by list-joining level 1 and unwarping it (default set to True)
**Flat output**: Flatten output by list-joining level 1 and unwraping it (default set to True)

**Match List Global**: Define how list with different lengths should be matched. Refers to the matching of groups (level 1)

Expand Down
47 changes: 42 additions & 5 deletions docs/nodes/list_main/constant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Constant List
=============

.. image:: https://user-images.githubusercontent.com/14288520/187515870-f8b16699-e1f4-49bd-b398-5077539e2aba.png
:target: https://user-images.githubusercontent.com/14288520/187515870-f8b16699-e1f4-49bd-b398-5077539e2aba.png

Functionality
-------------
Expand Down Expand Up @@ -50,25 +51,61 @@ Examples of usage

A simple example:

.. image:: https://user-images.githubusercontent.com/284644/74590945-286de180-5035-11ea-8c88-949ce11beb1c.png
.. image:: https://user-images.githubusercontent.com/14288520/187686031-a9e200c0-de63-4021-950f-c4cff8c855a9.png
:target: https://user-images.githubusercontent.com/14288520/187686031-a9e200c0-de63-4021-950f-c4cff8c855a9.png

* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
* Text-> :doc:`Data Shape </nodes/text/shape>`

If **Output level** would be 1 in this setup, the result would be `[0.06,
0.06, 0.06]`. If **Output level** would be 3, the result would be `[[[0.06,
0.06, 0.06]]]`.
0.06, 0.06]]]`:

.. image:: https://user-images.githubusercontent.com/14288520/187686049-9e05a419-95f7-46c8-bc62-08beaee85589.png
:target: https://user-images.githubusercontent.com/14288520/187686049-9e05a419-95f7-46c8-bc62-08beaee85589.png

* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
* Text-> :doc:`Data Shape </nodes/text/shape>`

More complex example:

.. image:: https://user-images.githubusercontent.com/284644/74590944-27d54b00-5035-11ea-8d62-6aeeac135e6e.png
.. image:: https://user-images.githubusercontent.com/14288520/187686059-70276803-32bd-4855-8bc3-4e2616bb0e0e.png
:target: https://user-images.githubusercontent.com/14288520/187686059-70276803-32bd-4855-8bc3-4e2616bb0e0e.png

* Number-> :doc:`List Input </nodes/number/list_input>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
* Text-> :doc:`Data Shape </nodes/text/shape>`


If **Output level** would be 1 in this setup, the result would be `[1, 1, 1, 2,
2, 2, 2, 2]`. If **Output level** would be 3, the result would be `[[[1, 1, 1],
[2, 2, 2, 2, 2]]]`.
[2, 2, 2, 2, 2]]]`:

.. image:: https://user-images.githubusercontent.com/14288520/187686070-80366925-2893-470d-b6af-6651d6825b26.png
:target: https://user-images.githubusercontent.com/14288520/187686070-80366925-2893-470d-b6af-6651d6825b26.png

* Number-> :doc:`List Input </nodes/number/list_input>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
* Text-> :doc:`Data Shape </nodes/text/shape>`

Another complex example:

.. image:: https://user-images.githubusercontent.com/284644/74590942-273cb480-5035-11ea-9ed7-84da04e3d590.png
.. image:: https://user-images.githubusercontent.com/14288520/187688679-f97b4d33-989f-4406-8fb7-fec0df09a056.png
:target: https://user-images.githubusercontent.com/14288520/187688679-f97b4d33-989f-4406-8fb7-fec0df09a056.png

* Number-> :doc:`List Input </nodes/number/list_input>`
* List->List Main-> :doc:`List Join </nodes/list_main/join>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
* Text-> :doc:`Data Shape </nodes/text/shape>`

If **Output level** would be 1 in this setup, the result would be `[1, 1, 1, 2,
2, 2, 2, 2, 3, 3, 3, 4, 4, 4, 4, 4]`. If **Output level** would be 2, the
result would be `[[1, 1, 1], [2, 2, 2, 2, 2], [3, 3, 3], [4, 4, 4, 4, 4]]`.

.. image:: https://user-images.githubusercontent.com/14288520/187688692-bcf57546-26b8-4f01-85a6-280942092053.png
:target: https://user-images.githubusercontent.com/14288520/187688692-bcf57546-26b8-4f01-85a6-280942092053.png

* Number-> :doc:`List Input </nodes/number/list_input>`
* List->List Main-> :doc:`List Join </nodes/list_main/join>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
* Text-> :doc:`Data Shape </nodes/text/shape>`
20 changes: 17 additions & 3 deletions docs/nodes/list_main/decompose.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ List Decompose
==============

.. image:: https://user-images.githubusercontent.com/14288520/187529767-1291c5cd-40cd-45b6-a44c-78c02e8c33c5.png
:target: https://user-images.githubusercontent.com/14288520/187529767-1291c5cd-40cd-45b6-a44c-78c02e8c33c5.png

Functionality
-------------
Expand Down Expand Up @@ -39,17 +40,30 @@ Example of usage
**Decomposed simple list in 2 level:**

.. image:: https://user-images.githubusercontent.com/14288520/187661007-c9b8a9c2-d62c-4d32-9f3b-c9326ec411a5.png
:target: https://user-images.githubusercontent.com/14288520/187661007-c9b8a9c2-d62c-4d32-9f3b-c9326ec411a5.png

:doc:`Number->Number range </nodes/number/number_range>`,
:doc:`Text->Stethoscope MK2 </nodes/text/stethoscope_v28>`
* Number-> :doc:`Number Range </nodes/number/number_range>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`

**Use 'Auto set' button:**

1. Set Level
2. Press Auto set

.. image:: https://user-images.githubusercontent.com/14288520/187530201-2c9fa567-486e-49d6-9c7c-8138b5dfcbe1.png
:target: https://user-images.githubusercontent.com/14288520/187530201-2c9fa567-486e-49d6-9c7c-8138b5dfcbe1.png

* Number-> :doc:`List Input </nodes/number/list_input>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`

**Decompose list of Bezier Curves:**

.. image:: https://user-images.githubusercontent.com/14288520/187531176-a495c440-f76b-49a4-adc5-5bd66e65a869.png
.. image:: https://user-images.githubusercontent.com/14288520/187531176-a495c440-f76b-49a4-adc5-5bd66e65a869.png
:target: https://user-images.githubusercontent.com/14288520/187531176-a495c440-f76b-49a4-adc5-5bd66e65a869.png

* Curve-> :doc:`Bezier Spline (Curve) </nodes/curve/bezier_spline>`
* List->List Main-> :doc:`List Join </nodes/list_main/join>`
* Curve-> :doc:`Evaluate Curve </nodes/curve/eval_curve>`
* Viz-> :doc:`Viewer Draw </nodes/viz/viewer_draw_mk4>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`

9 changes: 7 additions & 2 deletions docs/nodes/list_main/func.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ List Math
=========

.. image:: https://user-images.githubusercontent.com/14288520/187527983-9ecef862-b83b-460e-bc7a-eda13ca91252.png
:target: https://user-images.githubusercontent.com/14288520/187527983-9ecef862-b83b-460e-bc7a-eda13ca91252.png

Functionality
-------------
Expand Down Expand Up @@ -31,7 +32,7 @@ Logical OR Return True if any value in the list is logical True
Logical AND Return True if all values in the list are logical True
=================== ======================================

**Warp:** Adds one level of warping (output becomes [output])
**Wrap:** Adds one level of wraping (output becomes [output])

Outputs
-------
Expand All @@ -43,7 +44,11 @@ The output is always going to be a number, integer or float, depending on the in
Examples
--------

.. image:: https://cloud.githubusercontent.com/assets/5990821/4191546/dd4edc6e-378e-11e4-8015-8f66ec59b68e.png
.. image:: https://user-images.githubusercontent.com/14288520/187716616-57161d36-4b66-4680-b5bc-e94304944c46.png
:alt: ListMathDemo1.PNG
:target: https://user-images.githubusercontent.com/14288520/187716616-57161d36-4b66-4680-b5bc-e94304944c46.png

* Number-> :doc:`Number Range </nodes/number/number_range>`
* Text-> :doc:`Data Shape </nodes/text/shape>`

In this example the node shows all the possible outputs.
18 changes: 17 additions & 1 deletion docs/nodes/list_main/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ List Index
==========

.. image:: https://user-images.githubusercontent.com/14288520/187533476-0cce7810-4f52-4997-92d9-6ffac7c0669f.png
:target: https://user-images.githubusercontent.com/14288520/187533476-0cce7810-4f52-4997-92d9-6ffac7c0669f.png

Functionality
-------------
Expand Down Expand Up @@ -39,8 +40,23 @@ Examples

**Finding index of maximum value in array of random values**

.. image:: https://user-images.githubusercontent.com/28003269/107858186-57878080-6e4c-11eb-84a4-3f23260caa9f.png
.. image:: https://user-images.githubusercontent.com/14288520/187765990-caf44dc8-02f9-4568-be60-f805442deb57.png
:target: https://user-images.githubusercontent.com/14288520/187765990-caf44dc8-02f9-4568-be60-f805442deb57.png


* Number-> :doc:`Random Num Gen </nodes/number/random_num_gen>`
* List->List Main-> :doc:`List Math </nodes/list_main/func>`
* List->List Main-> :doc:`List Index </nodes/list_main/index>`
* List->List Struct-> :doc:`List Item </nodes/list_struct/item>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`

**Finding several indices:**

.. image:: https://user-images.githubusercontent.com/14288520/187533943-79991e77-371a-48ad-bc93-5073691c2beb.png
:target: https://user-images.githubusercontent.com/14288520/187533943-79991e77-371a-48ad-bc93-5073691c2beb.png

"-1" - Not found

* Number-> :doc:`Number Range </nodes/number/number_range>`
* Number-> :doc:`List Input </nodes/number/list_input>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
9 changes: 8 additions & 1 deletion docs/nodes/list_main/join.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ List Join
=========

.. image:: https://user-images.githubusercontent.com/14288520/187512380-c7e79c39-f868-489a-879d-dd3a063dea53.png
:target: https://user-images.githubusercontent.com/14288520/187512380-c7e79c39-f868-489a-879d-dd3a063dea53.png

Functionality
-------------
Expand Down Expand Up @@ -79,4 +80,10 @@ Examples

**Combine Bezier Spline Curves with 'List Join' node to Create a Surface**

.. image:: https://user-images.githubusercontent.com/14288520/187514973-08b68caf-2024-4316-b2d5-834d49f96712.png
.. image:: https://user-images.githubusercontent.com/14288520/187514973-08b68caf-2024-4316-b2d5-834d49f96712.png
:target: https://user-images.githubusercontent.com/14288520/187514973-08b68caf-2024-4316-b2d5-834d49f96712.png

* Curve-> :doc:`Bezier Spline (Curve) </nodes/curve/bezier_spline>`
* Surfaces-> :doc:`Surface from Curves </nodes/surface/interpolating_surface>`
* Surfaces-> :doc:`Evaluate Surfaces </nodes/surface/evaluate_surface>`
* Viz-> :doc:`Viewer Draw </nodes/viz/viewer_draw_mk4>`
17 changes: 14 additions & 3 deletions docs/nodes/list_main/length.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ List Length
===========

.. image:: https://user-images.githubusercontent.com/14288520/187519011-8e55b053-801f-43f1-9d45-727a11633ca1.png
:target: https://user-images.githubusercontent.com/14288520/187519011-8e55b053-801f-43f1-9d45-727a11633ca1.png

Functionality
-------------
Expand Down Expand Up @@ -29,8 +30,18 @@ Examples

Often a few experiments with input hooked-up to a debug node will make the exact working of this Node instantly clearer than any explanation.

.. image:: https://cloud.githubusercontent.com/assets/619340/4186453/1a375026-3761-11e4-8e41-11b57736be1a.PNG
.. image:: https://user-images.githubusercontent.com/14288520/187696438-05bf888a-086e-4a49-a6e6-0752ce3ef475.png
:alt: ListLengthDemo1.PNG
:target: https://user-images.githubusercontent.com/14288520/187696438-05bf888a-086e-4a49-a6e6-0752ce3ef475.png

.. image:: https://cloud.githubusercontent.com/assets/619340/4186454/1a3de7b0-3761-11e4-9520-79b331ad6822.PNG
:alt: ListLengthDemo2.PNG
* Vector-> :doc:`Vector X/Y/Z </nodes/vector/axis_input_mk2>`
* Number-> :doc:`Number Range </nodes/number/number_range>`
* Matrix-> :doc:`Matrix In </nodes/matrix/matrix_in_mk4>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`

.. image:: https://user-images.githubusercontent.com/14288520/187696469-0fba9dff-0423-406c-9a19-7ef0d607d996.png
:alt: ListLengthDemo2.PNG
:target: https://user-images.githubusercontent.com/14288520/187696469-0fba9dff-0423-406c-9a19-7ef0d607d996.png

* Number-> :doc:`Number Range </nodes/number/number_range>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
Loading