Merge pull request #4656 from nortikin/update_menu_nodes_comments_v12

Update docs and menu Color/*, some fixes other menus and docs

Merge pull request #4656 from nortikin/update_menu_nodes_comments_v12
Update docs and menu Color/*, some fixes other menus and docs
9fb13ea6 · satabol · GitHub · 7cb34506 · 4e4b5e54 · 9fb13ea6
--- a/docs/nodes/color/color_in_mk1.rst
+++ b/docs/nodes/color/color_in_mk1.rst
@@ -4,6 +4,9 @@ Color In
 Functionality
 -------------

+.. image:: https://user-images.githubusercontent.com/14288520/189630585-fe6276d3-e81c-4879-9d12-e1a28b7ab089.png
+  :target: https://user-images.githubusercontent.com/14288520/189630585-fe6276d3-e81c-4879-9d12-e1a28b7ab089.png
+
 Creates color data from ranges or number values either integer of floats.

 With the NumPy implementation the node will accept regular lists or lists of NumPy arrays if the arrays have two axis arrays with shape [n,3]
@@ -15,9 +18,8 @@ It can also output Numpy arrays (flat arrays) when using the activating the "Out
 Inputs and Parameters
 ---------------------

-**Use Alpha** - Include alpha (transparency) data in the outputs.
-
-**Color space** - RGB, HSV and HSL inputs are available.
+* **Use Alpha** - Include alpha (transparency) data in the outputs.
+* **Color space** - RGB, HSV and HSL inputs are available.

 - RGB:

@@ -65,12 +67,21 @@ Examples

 Differences between HSV and HSL:

-.. image:: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/color/color_in/color_in_hsv_hsl_sverchok_blender_example.png
+.. image:: https://user-images.githubusercontent.com/14288520/189630656-716363b1-02bb-4eee-8538-acb696584375.png
+  :target: https://user-images.githubusercontent.com/14288520/189630656-716363b1-02bb-4eee-8538-acb696584375.png

+* Generator-> :doc:`Plane </nodes/generator/plane_mk3>`
+* Vector-> :doc:`Vector Out </nodes/vector/vector_out>`
+* Viz-> :doc:`Texture Viewer </nodes/viz/viewer_texture>`
+* Text-> :doc:`Stethoscope </nodes/text/stethoscope_v28>`

 Tuning noise into color data:

-.. image:: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/color/color_in/color_in_noise_hsv_sverchok_blender_example.png
-
+.. image:: https://user-images.githubusercontent.com/14288520/189630696-415d23f2-a1d8-4995-8000-9beb42ab1006.png
+  :target: https://user-images.githubusercontent.com/14288520/189630696-415d23f2-a1d8-4995-8000-9beb42ab1006.png

 Gist: https://gist.github.com/cf884ea62f9960d609158ef2d5c994ed
+
+* Generator-> :doc:`Plane </nodes/generator/plane_mk3>`
+* Vector-> :doc:`Vector Noise </nodes/vector/noise_mk3>`
+* Viz-> :doc:`Texture Viewer </nodes/viz/viewer_texture>`
\ Нет новой строки в конце файла
--- a/docs/nodes/color/color_index.rst
+++ b/docs/nodes/color/color_index.rst
@@ -8,7 +8,7 @@ Color
   color_input
   color_in_mk1
   color_out_mk1
-   color_ramp
   color_mix
   formula_color
+   color_ramp
   texture_evaluate_mk2
--- a/docs/nodes/color/color_input.rst
+++ b/docs/nodes/color/color_input.rst
 Color Input
 ===========

+.. image:: https://user-images.githubusercontent.com/14288520/189617415-3c76a399-1438-4119-ac5a-f6a8d70e47a9.png
+  :target: https://user-images.githubusercontent.com/14288520/189617415-3c76a399-1438-4119-ac5a-f6a8d70e47a9.png
+
 Functionality
 -------------

@@ -28,5 +31,5 @@ This node has only one output: **Color**. It is RGB or RGBA vector, depending on
 Examples
 --------

-.. image:: https://user-images.githubusercontent.com/284644/36633499-b5b7108a-19b8-11e8-8e39-243d9dd42e7e.png
-
+.. image:: https://user-images.githubusercontent.com/14288520/189617473-db7d63ff-43e0-42fd-8afb-a7499e932337.png
+  :target: https://user-images.githubusercontent.com/14288520/189617473-db7d63ff-43e0-42fd-8afb-a7499e932337.png
\ Нет новой строки в конце файла
--- a/docs/nodes/color/color_mix.rst
+++ b/docs/nodes/color/color_mix.rst
 Color Mix
 =========

+.. image:: https://user-images.githubusercontent.com/14288520/189637346-17f6026c-f23a-45bd-881b-f9fbb1186a7c.png
+  :target: https://user-images.githubusercontent.com/14288520/189637346-17f6026c-f23a-45bd-881b-f9fbb1186a7c.png
+
 Functionality
 -------------

@@ -33,8 +36,23 @@ This node has only one output: **Color**. It is RGB or RGBA vector, depending on
 Examples
 --------

-.. image:: https://user-images.githubusercontent.com/10011941/98450826-530e4600-2140-11eb-8206-b3e4e40c8565.png
+.. image:: https://user-images.githubusercontent.com/14288520/189637424-1c11fb70-8a77-4beb-9246-d3a56ed1f444.png
+  :target: https://user-images.githubusercontent.com/14288520/189637424-1c11fb70-8a77-4beb-9246-d3a56ed1f444.png
+
+* Number-> :doc:`Random Num Gen </nodes/number/random_num_gen>`
+* Color-> :doc:`Color In </nodes/color/color_in_mk1>`
+* Viz-> :doc:`Texture Viewer </nodes/viz/viewer_texture>`
+
+.. image:: https://user-images.githubusercontent.com/14288520/189637924-d205352a-dc24-4ff2-a6e6-3eaa5825cd27.png
+  :target: https://user-images.githubusercontent.com/14288520/189637924-d205352a-dc24-4ff2-a6e6-3eaa5825cd27.png
+
+* Number-> :doc:`Number Range </nodes/number/number_range>`
+* Viz-> :doc:`Texture Viewer </nodes/viz/viewer_texture>`

-.. image:: https://user-images.githubusercontent.com/10011941/98450861-9b2d6880-2140-11eb-9c46-728aeb3ced01.png
+.. image:: https://user-images.githubusercontent.com/14288520/189637489-60c76248-466d-4d13-bf9d-e971cc22e271.png
+  :target: https://user-images.githubusercontent.com/14288520/189637489-60c76248-466d-4d13-bf9d-e971cc22e271.png

-.. image:: https://user-images.githubusercontent.com/10011941/98450881-da5bb980-2140-11eb-861c-e45c1f483a84.png
+* Number-> :doc:`Random Num Gen </nodes/number/random_num_gen>`
+* Number-> :doc:`Number Range </nodes/number/number_range>`
+* Color-> :doc:`Color In </nodes/color/color_in_mk1>`
+* Viz-> :doc:`Texture Viewer </nodes/viz/viewer_texture>`
\ Нет новой строки в конце файла
--- a/docs/nodes/color/color_out_mk1.rst
+++ b/docs/nodes/color/color_out_mk1.rst
 Color Out
 =========

+.. image:: https://user-images.githubusercontent.com/14288520/189633039-ea3d2f29-e400-4383-b643-f13cc745780e.png
+  :target: https://user-images.githubusercontent.com/14288520/189633039-ea3d2f29-e400-4383-b643-f13cc745780e.png
+
 Functionality
 -------------

@@ -56,4 +59,10 @@ In the N-Panel (and on the right-click menu) you can find:
 Examples
 --------

-.. image:: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/color/color_out/color_out_texture_hsv_sverchok_blender_example.png
+.. image:: https://user-images.githubusercontent.com/14288520/189633073-cc6a2caf-ec93-484f-aedc-ace6cccad6eb.png
+  :target: https://user-images.githubusercontent.com/14288520/189633073-cc6a2caf-ec93-484f-aedc-ace6cccad6eb.png
+
+* Generator-> :doc:`Plane </nodes/generator/plane_mk3>`
+* Color-> :doc:`Texture Evaluate </nodes/color/texture_evaluate_mk2>`
+* Color-> :doc:`Color In </nodes/color/color_in_mk1>`
+* Viz-> :doc:`Texture Viewer </nodes/viz/viewer_texture>`
\ Нет новой строки в конце файла
--- a/docs/nodes/color/color_ramp.rst
+++ b/docs/nodes/color/color_ramp.rst
 Color Ramp
 ==========

+.. image:: https://user-images.githubusercontent.com/14288520/189643169-e8791fe1-51b4-4508-8c0f-cb4691f4e117.png
+  :target: https://user-images.githubusercontent.com/14288520/189643169-e8791fe1-51b4-4508-8c0f-cb4691f4e117.png
+
 Functionality
 -------------

@@ -24,9 +27,7 @@ Parameters
 ----------

 * **Animate Node**. Update node on frame change
-
 * **Update**. Update node
-
 * **Use Alpha** Output RGBA or RGB colors


@@ -43,4 +44,10 @@ Examples

 Basic usage:

-.. image:: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/color/color_ramp/color_ramp_sverchok_blender_example.png
+.. image:: https://user-images.githubusercontent.com/14288520/189643223-692b702c-1d7d-41d8-993f-76765d0ce2b8.png
+  :target: https://user-images.githubusercontent.com/14288520/189643223-692b702c-1d7d-41d8-993f-76765d0ce2b8.png
+
+* Generator-> :doc:`Plane </nodes/generator/plane_mk3>`
+* Vector-> :doc:`Vector Noise </nodes/vector/noise_mk3>`
+* Number-> :doc:`Map Range </nodes/number/range_map>`
+* Viz-> :doc:`Texture Viewer </nodes/viz/viewer_texture>`
\ Нет новой строки в конце файла
--- a/docs/nodes/color/formula_color.rst
+++ b/docs/nodes/color/formula_color.rst
 Color by Formula
 ================

+.. image:: https://user-images.githubusercontent.com/14288520/189641212-68f98b04-5fcb-4670-9821-dd46aa04b9d9.png
+  :target: https://user-images.githubusercontent.com/14288520/189641212-68f98b04-5fcb-4670-9821-dd46aa04b9d9.png
+
 Functionality
 -------------

@@ -26,4 +29,6 @@ resulted colors to red, green, blue and alpha elements of which was applied expr

 Example of usage
 ----------------
+
 .. image:: https://user-images.githubusercontent.com/22656834/37774133-44806c24-2e01-11e8-85ba-361a18315ff9.png
+    :target: https://user-images.githubusercontent.com/22656834/37774133-44806c24-2e01-11e8-85ba-361a18315ff9.png
--- a/docs/nodes/color/texture_evaluate_mk2.rst
+++ b/docs/nodes/color/texture_evaluate_mk2.rst
 Texture Evaluate
 ================

+.. image:: https://user-images.githubusercontent.com/14288520/189663161-48c45f22-ec8a-4973-b881-6da7fb829f11.png
+  :target: https://user-images.githubusercontent.com/14288520/189663161-48c45f22-ec8a-4973-b881-6da7fb829f11.png
+
 This node evaluates a  texture at specific coordinates

 Inputs & Parameters
@@ -10,11 +13,15 @@ Inputs & Parameters
 | Parameters     | Description                                                             |
 +================+=========================================================================+
 | Mapping        | Vectors mapping mode. Offers:                                           |
+|                |                                                                         |
 |                | UV Coordinates (with domain 0 to 1) and                                 |
+|                |                                                                         |
 |                | Object (with domain -1 to 1)                                            |
 +----------------+-------------------------------------------------------------------------+
 | Channel        | Color channel to output                                                 |
+|                |                                                                         |
 |                | Offers: Red, Green, Blue, Hue, Saturation, Value, Alpha, RGB Average,   |
+|                |                                                                         |
 |                | Luminosity and Color                                                    |
 +----------------+-------------------------------------------------------------------------+
 | Use Alpha      | Toggle to add alpha channel (Only when Channel is set to Color)         |
@@ -31,21 +38,34 @@ Examples


 .. image:: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/vector/texture_evaluate/texture_evaluate_sverchok_blender_example_1.png
+    :target: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/vector/texture_evaluate/texture_evaluate_sverchok_blender_example_1.png

 Mixing 3 textures

-.. image:: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/vector/texture_evaluate/texture_evaluate_sverchok_blender_example_2.png
+.. image:: https://user-images.githubusercontent.com/14288520/189663199-78a379ee-0a7c-49ba-80b3-52f31f13fe6a.png
+  :target: https://user-images.githubusercontent.com/14288520/189663199-78a379ee-0a7c-49ba-80b3-52f31f13fe6a.png
+
+* Generator-> :doc:`Plane </nodes/generator/plane_mk3>`
+* Logic-> :doc:`Logic Functions </nodes/logic/logic_node>`
+* Modifier->Modifier Change-> :doc:`Mask Vertices </nodes/modifier_change/vertices_mask>`
+* Viz-> :doc:`Viewer Draw </nodes/viz/viewer_draw_mk4>`

 Masking mesh with texture

 .. image:: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/vector/texture_evaluate/texture_evaluate_sverchok_blender_example_3.png
+    :target: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/vector/texture_evaluate/texture_evaluate_sverchok_blender_example_3.png

 Blender procedural textures work in 3D space

 .. image:: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/vector/texture_evaluate/texture_evaluate_sverchok_blender_example_4.png
+    :target: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/vector/texture_evaluate/texture_evaluate_sverchok_blender_example_4.png

 You can input multiple textures, when joined [[texture, texture,..],[..],..] they will be used in a single set of vertices with a single output list

-.. image:: https://raw.githubusercontent.com/vicdoval/sverchok/docs_images/images_for_docs/vector/texture_evaluate/texture_evaluate_sverchok_blender_example_5.png
+.. image:: https://user-images.githubusercontent.com/14288520/189665154-9b97814d-e3b0-4e15-a886-8fe0ea2b4e1a.png
+  :target: https://user-images.githubusercontent.com/14288520/189665154-9b97814d-e3b0-4e15-a886-8fe0ea2b4e1a.png
+
+* Generator-> :doc:`Plane </nodes/generator/plane_mk3>`
+* Viz-> :doc:`Texture Viewer </nodes/viz/viewer_texture>`

 Differences between Object Mapping and UV Coordinates mapping
--- a/docs/nodes/list_masks/mask_join.rst
+++ b/docs/nodes/list_masks/mask_join.rst
 List Mask Join In
 =================

-.. image:: https://user-images.githubusercontent.com/14288520/188214090-da2fd597-c35c-4a90-8b96-b0b12d9c950e.png
-  :target: https://user-images.githubusercontent.com/14288520/188214090-da2fd597-c35c-4a90-8b96-b0b12d9c950e.png
+.. image:: https://user-images.githubusercontent.com/14288520/189611716-899bd122-6af1-4025-bc6f-62b2ccff5ade.png
+  :target: https://user-images.githubusercontent.com/14288520/189611716-899bd122-6af1-4025-bc6f-62b2ccff5ade.png

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

--- a/nodes/color/color_in_mk1.py
+++ b/nodes/color/color_in_mk1.py
@@ -98,7 +98,7 @@ def fprop_generator(**altprops):
 class SvColorsInNodeMK1(bpy.types.Node, SverchCustomTreeNode):
    """
    Triggers: rgb, hsv, hsl -> color
-    Tooltip: Generator for Color data from color components
+    Tooltip: Generator for Color data from color components.\n\tIn: R,G,B,A / H,S,V,A / H,S,L,A\n\tParams: Choise [RGB]/HSV/HSL, Use Alpha [On]/Off\n\tOut: Color

    """
    bl_idname = 'SvColorsInNodeMK1'
@@ -125,9 +125,9 @@ class SvColorsInNodeMK1(bpy.types.Node, SverchCustomTreeNode):
    v_: fprop_generator(name='V', description='Value / Brightness (0..1)')

    mode_options = [
-        ("RGB", "RGB", "", 0),
-        ("HSV", "HSV", "", 1),
-        ("HSL", "HSL", "", 2),
+        ("RGB", "RGB", "Red, Green, Blue", 0),
+        ("HSV", "HSV", "Hue, Saturation, Value", 1),
+        ("HSL", "HSL", "Hue, Saturation, Lightness", 2),
    ]

    selected_mode: bpy.props.EnumProperty(

--- a/nodes/color/color_input.py
+++ b/nodes/color/color_input.py
@@ -29,7 +29,7 @@ from sverchok.utils.nodes_mixins.show_3d_properties import Show3DProperties
 class SvColorInputNode(Show3DProperties, bpy.types.Node, SverchCustomTreeNode):
    """
    Triggers: Color Input
-    Tooltip: Specify color using color picker
+    Tooltip: Specify color using color picker.\n\tNo input.\n\tParam: Use Alpha On/[Off]\n\tOut: Color: RGB/RGBA [0.0, 0.0, 0.0, 1.0]
    """
    bl_idname = "SvColorInputNode"
    bl_label = "Color Input"

--- a/nodes/color/color_mix.py
+++ b/nodes/color/color_mix.py
@@ -195,7 +195,7 @@ def color_mix(params, constant, matching_f):
 class SvColorMixNode(bpy.types.Node, SverchCustomTreeNode):
    """
    Triggers: Colors Math
-    Tooltip: Mix colors with various methods.
+    Tooltip: Mix colors with various methods.\n\tIn: Factor [0.0-1.0], Color A, Color B\n\tParams: Choise ([Mix]/Darken/Multiply/Burn,Add and other)\n\tOut: Color
    """
    bl_idname = 'SvColorMixNode'
    bl_label = 'Color Mix'

--- a/nodes/color/color_out_mk1.py
+++ b/nodes/color/color_out_mk1.py
@@ -38,7 +38,7 @@ def unpack_list_to_np(obj):
 class SvColorsOutNodeMK1(bpy.types.Node, SverchCustomTreeNode):
    """
    Triggers: col -> rgb, hsv, hsl
-    Tooltip: Generator for Color data from color components
+    Tooltip: Generator for Color data from color components.\n\tIn: Color\n\tParams: Color Space [RGB]/HSV/HSL\n\tOut: R,G,B / H,S,V / H,S,L

    """
    bl_idname = 'SvColorsOutNodeMK1'
@@ -51,9 +51,9 @@ class SvColorsOutNodeMK1(bpy.types.Node, SverchCustomTreeNode):
            self.outputs[idx].name = socket
        updateNode(self, context)
    mode_options = [
-        ("RGB", "RGB", "", 0),
-        ("HSV", "HSV", "", 1),
-        ("HSL", "HSL", "", 2),
+        ("RGB", "RGB", "Red, Green, Blue", 0),
+        ("HSV", "HSV", "Hue, Saturation, Value", 1),
+        ("HSL", "HSL", "Hue, Saturation, Lightness", 2),
    ]

    selected_mode: bpy.props.EnumProperty(

--- a/nodes/color/color_ramp.py
+++ b/nodes/color/color_ramp.py
@@ -46,7 +46,7 @@ def color_ramp_mapper(params, constant, matching_f):
 class SvColorRampNode(bpy.types.Node, SverchCustomTreeNode):
    """
    Triggers: Color Gradient
-    Tooltip:  Map input list to a defined color
+    Tooltip:  Map input list to a defined color.\n\tIn: Value\n\tParams: Color Stops, Use Alpha [On]/Off, Update Node (Btn)\n\tOut: Color

    """
    bl_idname = 'SvColorRampNode'

--- a/nodes/color/formula_color.py
+++ b/nodes/color/formula_color.py
@@ -24,7 +24,11 @@ from sverchok.data_structure import (updateNode, second_as_first_cycle as safc)


 class SvFormulaColorNode(bpy.types.Node, SverchCustomTreeNode):
-    ''' Change Colors by Math '''
+    '''Change Colors by Math
+    In: Colors(rgba), Colors(RGBA)
+    Params: Formula R, G, B, A (mix of rgba/RGBA)
+    Out: Colors
+    '''
    bl_idname = 'SvFormulaColorNode'
    bl_label = 'Color by Formula'
    bl_icon = 'OUTLINER_OB_EMPTY'

--- a/nodes/color/texture_evaluate_mk2.py
+++ b/nodes/color/texture_evaluate_mk2.py
@@ -77,7 +77,7 @@ mapper_funcs = {
 class SvTextureEvaluateNodeMk2(bpy.types.Node, SverchCustomTreeNode):
    """
    Triggers: Scene Texture In
-    Tooltip: Evaluate Scene texture at input coordinates
+    Tooltip: Evaluate Scene texture at input coordinates.\n\tIn:Vertices, Texture\n\tParams: Mapping Object/[UV Coordinates], Channel: [Alpha]/R/G/B/Hue/Sat/Val/RGB Aver/Lumin/Color\n\tOut: value (float)

    """