Skip to content

Commit

Permalink
Merge pull request #4637 from nortikin/update_menu_nodes_comments_v03
Browse files Browse the repository at this point in the history
- Update List->List Struct/**

Except:
List Item Insert - do not work with example
List Slice Light - no in Shift-A menu
  • Loading branch information
satabol authored Sep 1, 2022
2 parents 35b50f3 + 9b95578 commit dfca0a2
Show file tree
Hide file tree
Showing 25 changed files with 244 additions and 43 deletions.
6 changes: 3 additions & 3 deletions docs/nodes/generator/generator_index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
**********
Generators
**********
*********
Generator
*********

.. toctree::
:maxdepth: 1
Expand Down
4 changes: 2 additions & 2 deletions docs/nodes/generator/segment.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Segment generator
=================
Segment
=======

.. image:: https://user-images.githubusercontent.com/28003269/72606242-ac01b900-3937-11ea-9cb5-1e7b67c00bca.png

Expand Down
2 changes: 1 addition & 1 deletion docs/nodes/list_main/decompose.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Example of usage
.. 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>`
* Curve->Bezier-> :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>`
Expand Down
2 changes: 1 addition & 1 deletion docs/nodes/list_main/join.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Examples
.. 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>`
* Curve->Bezier-> :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>`
12 changes: 10 additions & 2 deletions docs/nodes/list_struct/flip.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
List Flip
=========

.. image:: https://user-images.githubusercontent.com/14288520/187999003-a4180572-59d1-47ed-9d02-839bbb58115a.png
:target: https://user-images.githubusercontent.com/14288520/187999003-a4180572-59d1-47ed-9d02-839bbb58115a.png

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

Expand Down Expand Up @@ -33,5 +36,10 @@ Outputs
Examples
--------

.. image:: https://cloud.githubusercontent.com/assets/5783432/5603155/cd1cc280-9386-11e4-9998-a066258ca94b.jpg
:alt: flip
.. image:: https://user-images.githubusercontent.com/14288520/187999021-e519b2c7-2718-46e6-86ac-e19d8cea2283.png
:alt: flip
:target: https://user-images.githubusercontent.com/14288520/187999021-e519b2c7-2718-46e6-86ac-e19d8cea2283.png

* Script-> :doc:`Formula </nodes/script/formula_mk5>`
* List->List Main-> :doc:`List Join </nodes/list_main/join>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
15 changes: 15 additions & 0 deletions docs/nodes/list_struct/item.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
List Item
=========

.. image:: https://user-images.githubusercontent.com/14288520/187971764-8db7c649-349a-4641-8eb5-7177e89875cd.png
:target: https://user-images.githubusercontent.com/14288520/187971764-8db7c649-349a-4641-8eb5-7177e89875cd.png

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

Expand Down Expand Up @@ -39,3 +42,15 @@ Examples
--------

Trying various inputs, adjusting the parameters, and piping the output to a *Debug Print* (or stethoscope) node will be the fastest way to acquaint yourself with the inner workings of the *List Item* Node.

.. image:: https://user-images.githubusercontent.com/14288520/187971779-869195ac-8805-4a96-acee-48660b6096a8.png
:target: https://user-images.githubusercontent.com/14288520/187971779-869195ac-8805-4a96-acee-48660b6096a8.png

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

.. image:: https://user-images.githubusercontent.com/14288520/187973547-84721898-e7e1-4a98-b3ce-aa8ab9cf9165.png
:target: https://user-images.githubusercontent.com/14288520/187973547-84721898-e7e1-4a98-b3ce-aa8ab9cf9165.png

* Number-> :doc:`Number Range </nodes/number/number_range>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
70 changes: 62 additions & 8 deletions docs/nodes/list_struct/levels.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
List Levels
===========

.. image:: https://user-images.githubusercontent.com/14288520/188002611-0f681313-5bf5-4f83-a5c3-4221af3d83ae.png
:target: https://user-images.githubusercontent.com/14288520/188002611-0f681313-5bf5-4f83-a5c3-4221af3d83ae.png

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

Expand Down Expand Up @@ -66,33 +69,84 @@ Examples of Usage

By default, all checkboxes are disabled, so the node does nothing:

.. image:: https://user-images.githubusercontent.com/28003269/187598033-b1489f12-a949-4a14-842c-b77b4d1a94c0.png
.. image:: https://user-images.githubusercontent.com/14288520/188002648-3e992748-06d7-42a9-aeed-e917b183d1c5.png
:target: https://user-images.githubusercontent.com/14288520/188002648-3e992748-06d7-42a9-aeed-e917b183d1c5.png

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

Let's wrap each number into a separate list (this is what "Graft" option of output socket menus does as well):

.. image:: https://user-images.githubusercontent.com/28003269/187598129-4cd1cb55-4122-43dd-b175-d5ed36b353d9.png
.. image:: https://user-images.githubusercontent.com/14288520/188002682-f598ec87-90f5-46e3-a4c0-2ba0f4de3f23.png
:target: https://user-images.githubusercontent.com/14288520/188002682-f598ec87-90f5-46e3-a4c0-2ba0f4de3f23.png

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

By enabling "Wrap" at the next level, we put each vertex into a separate list:

.. image:: https://user-images.githubusercontent.com/28003269/187598191-b9da1499-c19b-46b4-8564-6e548ca2a2a0.png
.. image:: https://user-images.githubusercontent.com/14288520/188002711-0a43caf7-cf5a-4e89-9422-9eadd2de44c1.png
:target: https://user-images.githubusercontent.com/14288520/188002711-0a43caf7-cf5a-4e89-9422-9eadd2de44c1.png

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

The next level - put each list of vertices (object) into a separate list:

.. image:: https://user-images.githubusercontent.com/28003269/187598252-75720f20-48a9-4760-8c97-661867e9843a.png
.. image:: https://user-images.githubusercontent.com/14288520/188002729-8e60dcd0-ac12-4d83-97cc-bd9534ffdfb5.png
:target: https://user-images.githubusercontent.com/14288520/188002729-8e60dcd0-ac12-4d83-97cc-bd9534ffdfb5.png

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


And the outermost level - put the whole data structure into additional pair of square brackets:

.. image:: https://user-images.githubusercontent.com/28003269/187598332-9e6ef1a8-80de-4ca4-9991-659c24c6fdc9.png
.. image:: https://user-images.githubusercontent.com/14288520/188002754-ff585102-c296-43ba-9041-6b9eb2285be1.png
:target: https://user-images.githubusercontent.com/14288520/188002754-ff585102-c296-43ba-9041-6b9eb2285be1.png

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


By enabling "Flatten" at the deepest available level, we concatenate vertices data into lists of numbers:

.. image:: https://user-images.githubusercontent.com/28003269/187598388-c978e176-e697-4535-ba5b-c7e7612182d4.png
.. image:: https://user-images.githubusercontent.com/14288520/188003925-ccf47ee0-07f1-4ee5-b1ad-4666f94fea9f.png
:target: https://user-images.githubusercontent.com/14288520/188003925-ccf47ee0-07f1-4ee5-b1ad-4666f94fea9f.png

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


By flattening at the outermost level, we concatenate lists of vertices into a single list of vertices:

.. image:: https://user-images.githubusercontent.com/28003269/187598453-09121868-9fc0-4078-90f9-21d5dc50a40c.png
.. image:: https://user-images.githubusercontent.com/14288520/188003950-3bc52742-46e9-4dca-b508-44ba143604eb.png
:target: https://user-images.githubusercontent.com/14288520/188003950-3bc52742-46e9-4dca-b508-44ba143604eb.png

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


If we enable both Flatten flags, we concatenate lists of vertices into lists of numbers, AND we concatenate lists of numbers into a single list of numbers:

.. image:: https://user-images.githubusercontent.com/28003269/187598519-c849fde8-352a-43a5-b638-787e0e9d425c.png
.. image:: https://user-images.githubusercontent.com/14288520/188003979-cbfcdc08-8477-4126-a1a2-f38c436fd3f1.png
:target: https://user-images.githubusercontent.com/14288520/188003979-cbfcdc08-8477-4126-a1a2-f38c436fd3f1.png

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

.. image:: https://user-images.githubusercontent.com/14288520/188002634-8ff0edf1-da21-4dd9-af2f-503a17ca4eba.png
:target: https://user-images.githubusercontent.com/14288520/188002634-8ff0edf1-da21-4dd9-af2f-503a17ca4eba.png

* Number-> :doc:`Number Range </nodes/number/number_range>`
* List->List Struct-> :doc:`List Split </nodes/list_struct/split>`
* List->List Main-> :doc:`List Zip </nodes/list_main/zip>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
15 changes: 7 additions & 8 deletions docs/nodes/list_struct/list_struct_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,16 @@ List Struct
.. toctree::
:maxdepth: 1

flip
shift_mk2
repeater
slice
split
start_end
item
item_insert
repeater
reverse
shift_mk2
shuffle
slice
slice_lite
sort
split
start_end
flip
levels

slice_lite
32 changes: 30 additions & 2 deletions docs/nodes/list_struct/repeater.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
List Repeater
=============

.. image:: https://user-images.githubusercontent.com/14288520/187916847-eddb3806-d466-4730-bcba-5cf71ff2bf9e.png
:target: https://user-images.githubusercontent.com/14288520/187916847-eddb3806-d466-4730-bcba-5cf71ff2bf9e.png

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

Expand Down Expand Up @@ -41,7 +44,32 @@ Examples

Trying various inputs, adjusting the parameters, and piping the output to a *Debug Print* (or stethoscope) node will be the fastest way to acquaint yourself with the inner workings of the *List Repeater* Node.

.. image:: https://user-images.githubusercontent.com/14288520/187930209-252a899b-9db9-4125-8417-6d2d110ce40c.png
:target: https://user-images.githubusercontent.com/14288520/187930209-252a899b-9db9-4125-8417-6d2d110ce40c.png

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

.. image:: https://user-images.githubusercontent.com/14288520/187932385-97321a1c-8a75-41bc-982a-59c420226aec.png
:target: https://user-images.githubusercontent.com/14288520/187932385-97321a1c-8a75-41bc-982a-59c420226aec.png

* List->List Main-> :doc:`List Join </nodes/list_main/join>`
* Curve->Bezier-> :doc:`Bezier Spline (Curve) </nodes/curve/bezier_spline>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`

A practical reason to use the node is when you need a series of copies of edge or polygon lists. Usually in conjunction with `Matrix Apply`, which outputs a series of `vertex lists` as a result of transform parameters.

.. image:: https://cloud.githubusercontent.com/assets/619340/4186432/efb79892-3760-11e4-9d17-5c7a7a22d9d9.PNG
:alt: ListRepeater_Demo1.PNG
.. image:: https://user-images.githubusercontent.com/14288520/187916873-4eb95b3a-ab51-451f-b45d-04c56714182e.png
:alt: ListRepeater_Demo1.PNG
:target: https://user-images.githubusercontent.com/14288520/187916873-4eb95b3a-ab51-451f-b45d-04c56714182e.png

* Generator-> :doc:`Circle </nodes/generator/circle>`
* Transform-> :doc:`Move </nodes/transforms/move_mk3>`
* 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>`
* Transforms-> :doc:`Matrix Apply (verts) </nodes/transforms/apply>`
* List->List Struct-> :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>`
11 changes: 9 additions & 2 deletions docs/nodes/list_struct/reverse.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
List Reverse
============

.. image:: https://user-images.githubusercontent.com/14288520/187989090-d505d1bd-601d-47bc-bfeb-4b7026949a30.png
:target: https://user-images.githubusercontent.com/14288520/187989090-d505d1bd-601d-47bc-bfeb-4b7026949a30.png

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

Expand All @@ -25,7 +28,11 @@ Depends on incoming data and can be nested. Level 0 is top level (totally zoomed
Examples
--------

.. image:: https://cloud.githubusercontent.com/assets/5990821/4190715/1452079c-3788-11e4-8ce2-716b5046cf56.png
:alt: ListReverseDemo1.PNG
.. image:: https://user-images.githubusercontent.com/14288520/187989115-28629d0a-d37b-4d17-9ac5-82ac7cf4dad4.png
:target: https://user-images.githubusercontent.com/14288520/187989115-28629d0a-d37b-4d17-9ac5-82ac7cf4dad4.png

* Number-> :doc:`Number Range </nodes/number/number_range>`
* List->List Main-> :doc:`List Zip </nodes/list_main/zip>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`

In this example the node reverse a list a integers
21 changes: 19 additions & 2 deletions docs/nodes/list_struct/shift_mk2.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
List Shift
==========

.. image:: https://user-images.githubusercontent.com/14288520/187798671-b50c6cfc-d4a9-4f20-8cc5-048b7fd1794f.png
:target: https://user-images.githubusercontent.com/14288520/187798671-b50c6cfc-d4a9-4f20-8cc5-048b7fd1794f.png

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

Expand Down Expand Up @@ -31,5 +34,19 @@ Outputs
Examples
--------

.. image:: https://cloud.githubusercontent.com/assets/5783432/5603102/bec2bc6e-9384-11e4-9e4a-905da01b7ac1.gif
:alt: shift
.. image:: https://user-images.githubusercontent.com/14288520/187798687-fb5f8564-43f6-40ac-bd87-6e02af1a1649.png
:target: https://user-images.githubusercontent.com/14288520/187798687-fb5f8564-43f6-40ac-bd87-6e02af1a1649.png

* Number-> :doc:`Number Range </nodes/number/number_range>`
* List->List Main-> :doc:`List Zip </nodes/list_main/zip>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`

.. image:: https://user-images.githubusercontent.com/14288520/187798712-9237d83a-3b6b-4f9b-b3e7-f9794208838d.gif
:alt: shift
:target: https://user-images.githubusercontent.com/14288520/187798712-9237d83a-3b6b-4f9b-b3e7-f9794208838d.gif

* Number-> :doc:`Number Range </nodes/number/number_range>`
* Generator-> :doc:`Segment </nodes/generator/segment>`
* Vector-> :doc:`Vector In </nodes/vector/vector_in>`
* Modifiers->Modifier Make-> :doc:`UV Connection </nodes/modifier_make/uv_connect>`
* Viz-> :doc:`Viewer Draw </nodes/viz/viewer_draw_mk4>`
9 changes: 9 additions & 0 deletions docs/nodes/list_struct/shuffle.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
List Shuffle
============

.. image:: https://user-images.githubusercontent.com/14288520/187994149-88dec5a7-e39c-4752-b736-80d0c01f9327.png
:target: https://user-images.githubusercontent.com/14288520/187994149-88dec5a7-e39c-4752-b736-80d0c01f9327.png

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

Expand Down Expand Up @@ -43,3 +46,9 @@ Examples
The shuffle operation is based on the python random.shuffle. https://docs.python.org/3.4/library/random.html?highlight=shuffle#random.shuffle

Trying various inputs, adjusting the parameters, and piping the output to a *Debug Print* (or stethoscope) node will be the fastest way to acquaint yourself with the inner workings of the *List Shuffle* Node.

.. image:: https://user-images.githubusercontent.com/14288520/187994179-bbc77d38-d352-48d6-add8-7346645fba0d.png
:target: https://user-images.githubusercontent.com/14288520/187994179-bbc77d38-d352-48d6-add8-7346645fba0d.png

* Number-> :doc:`Number Range </nodes/number/number_range>`
* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`
11 changes: 10 additions & 1 deletion docs/nodes/list_struct/slice.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
List Slice
==========

.. image:: https://user-images.githubusercontent.com/14288520/187927363-e884daad-0fb7-46ab-b4bd-9c37db8014d4.png
:target: https://user-images.githubusercontent.com/14288520/187927363-e884daad-0fb7-46ab-b4bd-9c37db8014d4.png


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

Expand Down Expand Up @@ -55,8 +60,12 @@ Some slice examples.
>>> l[-1:2]
[]

.. image:: https://user-images.githubusercontent.com/14288520/187927397-eaaec673-f32d-489a-8749-7eecfba79070.png
:target: https://user-images.githubusercontent.com/14288520/187927397-eaaec673-f32d-489a-8749-7eecfba79070.png

.. image:: https://cloud.githubusercontent.com/assets/5783432/5229789/771e02b8-7725-11e4-8970-ac33c87f55ec.png
:alt: slice multiple objects from one list (may be many objects also)
:target: https://cloud.githubusercontent.com/assets/5783432/5229789/771e02b8-7725-11e4-8970-ac33c87f55ec.png
:alt: slice multiple objects from one list (may be many objects also)

Notes
-----
Expand Down
Loading

0 comments on commit dfca0a2

Please sign in to comment.