Doc update 2.4 Documentation Draw Nodes (#645)

* Read Node doc to DocUpdate-2.4 (3rd attempt) * Documentation Write node * Documentation Nodes NodeGraph * FileBrowser improved ( Project relative path) + links corrections * Update getstarted-environment-fileselect.rst * Update getstarted-environment-fileselect.rst * Documentation: Checkerboard-Colorwheel-Ramp-Common Properrties - Draw nodes * nodes - draw -Lightwrap node * Draw Nodes documentation Co-authored-by: Frédéric Devernay <devernay@users.noreply.github.com>
NatronGitHub · Jul 1, 2021 · 3b779be · 3b779be
1 parent c4c06b6
commit 3b779be
Show file tree

Hide file tree

Showing 42 changed files with 412 additions and 1 deletion.
diff --git a/Documentation/source/guide/_images/TheNodes-Draw/nodes-draw-lightwrap-compare.gif b/Documentation/source/guide/_images/TheNodes-Draw/nodes-draw-lightwrap-compare.gif
diff --git a/...mentation/source/guide/_images/TheNodes-Draw/nodes-draw-lightwrap-interface.gif b/...mentation/source/guide/_images/TheNodes-Draw/nodes-draw-lightwrap-interface.gif
diff --git a/Documentation/source/guide/_images/TheNodes-Draw/nodes-draw-lightwrap-plus.gif b/Documentation/source/guide/_images/TheNodes-Draw/nodes-draw-lightwrap-plus.gif
diff --git a/...mentation/source/guide/_images/TheNodes-Draw/nodes-draw-lightwrap-wrap_only.gif b/...mentation/source/guide/_images/TheNodes-Draw/nodes-draw-lightwrap-wrap_only.gif
diff --git a/...tation/source/guide/_images/TheNodes-Draw/nodes_draw_noise01PoissonGaussian.jpg b/...tation/source/guide/_images/TheNodes-Draw/nodes_draw_noise01PoissonGaussian.jpg
diff --git a/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_noise02.jpg b/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_noise02.jpg
diff --git a/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_plasma01.jpg b/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_plasma01.jpg
diff --git a/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_plasma02.jpg b/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_plasma02.jpg
diff --git a/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_plasma03.jpg b/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_plasma03.jpg
diff --git a/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_radial01.jpg b/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_radial01.jpg
diff --git a/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_ramp01.jpg b/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_ramp01.jpg
diff --git a/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_rand01.jpg b/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_rand01.jpg
diff --git a/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_rand02.jpg b/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_rand02.jpg
diff --git a/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_rectangle01.jpg b/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_rectangle01.jpg
diff --git a/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_roto03_feather.jpg b/Documentation/source/guide/_images/TheNodes-Draw/nodes_draw_roto03_feather.jpg
diff --git a/...mentation/source/guide/_images/TheNodes-Draw/thenodes-draw-roto-interface01.gif b/...mentation/source/guide/_images/TheNodes-Draw/thenodes-draw-roto-interface01.gif
diff --git a/...mentation/source/guide/_images/TheNodes-Draw/thenodes-draw-roto-interface02.gif b/...mentation/source/guide/_images/TheNodes-Draw/thenodes-draw-roto-interface02.gif
diff --git a/...mentation/source/guide/_images/TheNodes-Draw/thenodes-draw-roto-interface03.gif b/...mentation/source/guide/_images/TheNodes-Draw/thenodes-draw-roto-interface03.gif
diff --git a/Documentation/source/guide/_images/TheNodes-Draw/thenodes-draw-roto01.mp4 b/Documentation/source/guide/_images/TheNodes-Draw/thenodes-draw-roto01.mp4
diff --git a/Documentation/source/guide/_images/TheNodes-Image/Checkerboard_default.gif b/Documentation/source/guide/_images/TheNodes-Image/Checkerboard_default.gif
diff --git a/Documentation/source/guide/_images/TheNodes-Image/Checkerboard_grid.gif b/Documentation/source/guide/_images/TheNodes-Image/Checkerboard_grid.gif
diff --git a/Documentation/source/guide/_images/TheNodes-Image/Checkerboard_offset.gif b/Documentation/source/guide/_images/TheNodes-Image/Checkerboard_offset.gif
diff --git a/Documentation/source/guide/_images/TheNodes-Image/ColorWheel-default.gif b/Documentation/source/guide/_images/TheNodes-Image/ColorWheel-default.gif
diff --git a/Documentation/source/guide/_images/TheNodes-Image/ColorWheel-pattern.gif b/Documentation/source/guide/_images/TheNodes-Image/ColorWheel-pattern.gif
diff --git a/Documentation/source/guide/_images/TheNodes-Image/ColorWheel-testing.gif b/Documentation/source/guide/_images/TheNodes-Image/ColorWheel-testing.gif
diff --git a/Documentation/source/guide/_images/TheNodes-Various/node_window_generic.gif b/Documentation/source/guide/_images/TheNodes-Various/node_window_generic.gif
diff --git a/Documentation/source/guide/_images/TheNodes-Various/nodes_properties.gif b/Documentation/source/guide/_images/TheNodes-Various/nodes_properties.gif
diff --git a/Documentation/source/guide/_images/TheNodes-Various/nodes_utility_tools.gif b/Documentation/source/guide/_images/TheNodes-Various/nodes_utility_tools.gif
diff --git a/Documentation/source/guide/fromNuke_01.rst b/Documentation/source/guide/fromNuke_01.rst
@@ -0,0 +1,13 @@
+
+
+Nodes equivalents
+
+Nuke - Natron
+CurveTool - ImageStatistics
+Copy - Shuffle
+
+
+
+Python
+Nuke - 
+Get value of a pixel - Use image statistics node + retrieve value with an expression
diff --git a/Documentation/source/guide/thenodes-common-properties.rst b/Documentation/source/guide/thenodes-common-properties.rst
@@ -0,0 +1,66 @@
+.. for help on writing/extending this file, see the reStructuredText cheatsheet
+   http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
+
+.. toctree::
+   :maxdepth: 2
+
+
+Common Properties
+=================
+
+We describe here the type of parameters that can be found on many nodes. And how to use the properties window.
+
+The properties window
+---------------------
+
+.. image:: _images/TheNodes-Various/nodes_properties.gif
+
+The Utility icons
+-----------------
+
+.. image:: _images/TheNodes-Various/nodes_utility_tools.gif
+
+
+Layers Properties
+-----------------
+
+Channels to process
+Output Layer
+Mask
+
+Time Properties
+---------------
+
+Frame Range
+
+Lifetime Range
+
+Enable Lifetime
+
+
+Geometric Properties
+--------------------
+
+Extent
+
+Transform
+
+Filtering
+
+Functional Properties
+---------------------
+
+Mix
+
+
+Utility
+
+Hide Inputs
+
+Force caching
+
+Preview
+
+Disable
+
+
diff --git a/Documentation/source/guide/thenodes-draw-lightwrap.rst b/Documentation/source/guide/thenodes-draw-lightwrap.rst
@@ -0,0 +1,41 @@
+.. for help on writing/extending this file, see the reStructuredText cheatsheet
+    http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
+
+Lightwrap Node
+=========
+
+LightWrap helps composite objects onto a bright background by simulating reflections from the background light on the foreground, around its edges. 
+
+Input A is the foreground image and its matte, and input B the the background to use for the wrapping effect.
+
+The output of LightWrap should then be composited over the background to give the final composite.
+
+
+.. image:: _images/TheNodes-Draw/nodes-draw-lightwrap-compare.gif
+
+Usage
+--------
+
+.. image:: _images/TheNodes-Draw/nodes-draw-lightwrap-interface.gif
+
+Increase FGBlur and Intensity to make the Lightwrap more visible.
+
+Increase Diffuse and BGBlur to make the Lightwrap softer, that is remove details from the background.
+
+It is easier to adjust the settings with the Generate  wrap only box.
+
+.. image:: _images/TheNodes-Draw/nodes-draw-lightwrap-wrap_only.gif
+
+This can be useful to manage precisely how Lightwrap is composited onto the FG image.
+It is common practice to use a "plus" Merge rather than the default "Over". (see Merge3 node in the example below)
+
+.. image:: _images/TheNodes-Draw/nodes-draw-lightwrap-plus.gif
+
+Use "Enable Glow" to allow the Lightwrap to be visible also on the background image itself.
+
+The lightwrap can also be made of a unique color of your choice with "Use Constant Highlight" and "Constant" color.
+
+.. toctree::
+    :maxdepth: 2
+
+
diff --git a/Documentation/source/guide/thenodes-draw-plasma.rst b/Documentation/source/guide/thenodes-draw-plasma.rst
@@ -0,0 +1,32 @@
+.. for help on writing/extending this file, see the reStructuredText cheatsheet
+    http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
+
+Plasma Node
+=========
+
+Creates cloudy  noise. Brightness of the result can be modulated by the source image
+
+.. image:: _images/TheNodes-Draw/nodes_draw_plasma01.jpg
+
+
+Usage
+--------
+
+.. image:: _images/TheNodes-Draw/nodes_draw_plasma02.jpg
+
+The "Scale" parameter changes the size of the clouds pattern
+
+check "Static Seed" for a freeze frame of the effect
+
+.. image:: _images/TheNodes-Draw/nodes_draw_plasma03.jpg
+
+Above:
+    - high alpha/low beta gives clean clouds
+
+    - low alpha / high beta gives noisy clouds
+
+This node alone is not suitable for image regrain. but with a scale of 1 it can partly simulate the splotchy behavior of high speed film stocks
+
+
+.. toctree::
+    :maxdepth: 2
diff --git a/Documentation/source/guide/thenodes-draw-radial.rst b/Documentation/source/guide/thenodes-draw-radial.rst
@@ -0,0 +1,33 @@
+.. for help on writing/extending this file, see the reStructuredText cheatsheet
+    http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
+
+Radial Node
+=========
+
+Radial creates a radial gradient. 
+
+It is very useful for masking off a color adjustment and its softness parameter can be edited without compromising its edge values too much. Frequently use it to mask out nebulous regions of an effect. 
+
+It is faster to use and to process that a Roto or RotoPaint node. 
+
+.. image:: _images/TheNodes-Draw/nodes_draw_radial01.jpg
+
+Usage
+--------
+
+Use the rectangle gizmo visible when properties are opened to edit the shape 
+If an exact circle is required then the "2" button should be pressed in the size parameters.
+If the circle should be centered in the image press the "center" button 
+
+A hard-edged circle can be obtained by setting the softness paramet to 0.
+
+The End colors can be changed with "color 0" and "color 1" parameters.
+
+To fill the image with the effect set "Extent" to "Project"
+
+The node allows different 2 of transitions. With or without the "Perceptually linear" checkbox.
+
+.. toctree::
+    :maxdepth: 2
+
+
diff --git a/Documentation/source/guide/thenodes-draw-ramp.rst b/Documentation/source/guide/thenodes-draw-ramp.rst
@@ -0,0 +1,21 @@
+.. for help on writing/extending this file, see the reStructuredText cheatsheet
+   http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
+
+Ramp Node
+=========
+
+
+
+Ramp is what grown-ups call a gradient. The Ramp node of Natron give a butter-smooth gradient that is best used to mask off color operations.
+
+.. image:: _images/TheNodes-Draw/nodes_draw_ramp01.jpg
+
+Usage
+--------
+
+The End colors can be changed. And the end positions can be moved in the viewer with the point 0 / Point 1 widgets visible in the viewer when the properties of the node are opened.
+
+The Ramp type allows different types of transitions. The gradient is always linear. The colorwheel node can be changed to become a radial gradient.
+
+.. toctree::
+    :maxdepth: 2
diff --git a/Documentation/source/guide/thenodes-draw-rand_noise.rst b/Documentation/source/guide/thenodes-draw-rand_noise.rst
@@ -0,0 +1,45 @@
+.. for help on writing/extending this file, see the reStructuredText cheatsheet
+    http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
+
+Rand Node
+=========
+
+Creates uniform Random noise.
+This node alone is not suitable for image regrain.
+
+.. image:: _images/TheNodes-Draw/nodes_draw_rand01.jpg
+2 different Rand with different values of "Density"
+
+
+Usage
+--------
+
+.. image:: _images/TheNodes-Draw/nodes_draw_rand02.jpg
+
+The "Density" parameter allows to change the average distance between the random dots of the noise
+
+check "Static Seed" for a freeze frame of the effect
+
+Noise Node
+=========
+
+Creates noiseover the source image.
+
+.. image:: _images/TheNodes-Draw/nodes_draw_noise01PoissonGaussian.jpg
+2 different types of Noise. Poisson on the left, Gaussian on the right.
+
+
+Usage
+--------
+
+.. image:: _images/TheNodes-Draw/nodes_draw_noise02.jpg
+
+The Sigma parameter control the amount of noise.
+
+The "type "Poisson" noise reacts to the source image. It could be used to simulate electronic sensor noise. It gives a black result when no source image is provided. Type "Gaussian" is more uniform and is not dependant on the source image
+
+check "Static Seed" for a freeze frame of the effect
+
+
+.. toctree::
+    :maxdepth: 2
diff --git a/Documentation/source/guide/thenodes-draw-rectangle.rst b/Documentation/source/guide/thenodes-draw-rectangle.rst
@@ -0,0 +1,30 @@
+.. for help on writing/extending this file, see the reStructuredText cheatsheet
+    http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
+
+Rectangle Node
+=========
+
+the Rectangle node makes rectangle shapes. It can add rounded corners and soft edges to the shapes.
+It is very useful for masking off a color adjustment and its softness parameter can be edited without compromising its edge values too much. Frequently use it to mask out nebulous regions of an effect. 
+
+It is faster to use and to process that a Roto or RotoPaint node. 
+
+.. image:: _images/TheNodes-Draw/nodes_draw_radial01.jpg
+
+Usage
+--------
+
+Use the rectangle gizmo visible when properties are opened to edit the shape 
+If an exact square is required then the "2" button should be disabled in the size parameters.
+If the rectangle should be centered in the image press the "center" button.
+
+A hard-edged circle can be obtained by setting the softness paramet to 0.
+
+The End colors can be changed with "color 0" and "color 1" parameters.
+
+To fill the image with the effect set "Extent" to "Project".
+
+.. toctree::
+    :maxdepth: 2
+
+
diff --git a/Documentation/source/guide/thenodes-draw-roto.rst b/Documentation/source/guide/thenodes-draw-roto.rst
@@ -0,0 +1,58 @@
+.. for help on writing/extending this file, see the reStructuredText cheatsheet
+    http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
+
+Roto Node
+=========
+
+Using a Roto node a vector shape may be drawn (like the pen tool in Photoshop or Illustrator). There are two main uses for this node:
+
+    - To make a mask: In a situation where a node such as Multiply is being used to darken an image, a Roto shape may be used as a mask: to limit the effects of that node.
+    - To make an alpha channel: In a situation when the alpha of an image needs editing, a Roto shape may be used to add to, remove from or replace that alpha.
+
+Added to this is a host of other functionality. It may, for example, be used to hide or revel one layer from another. This functionality can be used to hide glitches in an image using something called a 'clean plate'.
+
+Natron's Roto node has many parameters parameters in the tabs. However, most day to day usage is covered effectively by the first two tabs. 
+
+.. image:: _images/TheNodes-Draw/thenodes-draw-roto-interface02.gif
+
+
+Usage
+--------
+
+Basic usage:
+    - create the node with 'o' or 'p' shortcut
+    - start click+dragging in the viewer
+    - click on the firs point to close it
+    - If you want soft edges around your shape, pull the little red lines protruding from each control points. The dotted line that appear is the limit of the soft edgea
+    - That's it you image now have your shape drawn (in the alpha channel by default)
+
+    .. image:: _images/TheNodes-Draw/nodes_draw_roto03_feather.jpg
+
+
+
+To edit the shape you have tools in the viewer window:
+
+In the viewer the tools to create or edit shapes are:
+    - 1: "Autokey" create a new key to your shape each time you move any part of it. If this is disabled click on the "+" (25) to create a key
+    - 2: "FeatherLink" lets you move a point on the shape and the feather point follows.
+    - 3: "display feather" can disable viewing/editing the feather points (dotted line)
+    - 4: sticky selection of vertices. Helps editing the shape with constant selection
+    - 5: sticky bounding box: Helps editing the shape with constant selection.
+    - 6: "Ripple Edit" let you change the shape on all keyframes in an offset manner
+    - 7-8: Add / Delete keyframe to the currently selected shape (similar to 25/26 in the properties
+    - 9: show transform. Let you move the whole shape without the need to edit each point of the shape. Good for rotoscoping "hard objects" wich shape doesn't change much over time.
+    - 10: Select/transform "arrow" tools. Select it after the creation of the Curve
+    - 11: Add/remove points tool
+    - 12:create shape tool. Long click to get the choice between freeform, rectangle, ellipse shapes.
+    - 13: pencil tools
+
+.. image:: _images/TheNodes-Draw/thenodes-draw-roto-interface03.gif
+
+
+.. note::
+    The layers don't have geometric properties. Their only purpose is to group paint dabs/masks to enable/disable these in  s ingle click
+
+See :doc:`The Rotopaint <compositing-rotopaint>` section for more informations.
+
+.. toctree::
+    :maxdepth: 2
diff --git a/Documentation/source/guide/thenodes-draw.rst b/Documentation/source/guide/thenodes-draw.rst
@@ -0,0 +1,18 @@
+.. for help on writing/extending this file, see the reStructuredText cheatsheet
+   http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
+   
+Draw Nodes
+==========
+
+These are the nodes located in the pencil icon of the toolbar.
+
+.. toctree::
+      :maxdepth: 1
+
+      thenodes-draw-lightwrap
+      thenodes-draw-plasma
+      thenodes-draw-radial
+      thenodes-draw-ramp
+      thenodes-draw-rand_noise
+      thenodes-draw-rectangle
+      thenodes-draw-roto
diff --git a/Documentation/source/guide/thenodes-image-ColorWheel.rst b/Documentation/source/guide/thenodes-image-ColorWheel.rst
@@ -0,0 +1,25 @@
+.. for help on writing/extending this file, see the reStructuredText cheatsheet
+   http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
+   
+ColorWheel Node
+===============
+
+.. toctree::
+    :maxdepth: 2
+
+The ColorWheel node can be used to generate disc patterns. By default it generates a preview of all the colors in the visible spectrum
+
+.. image:: _images/TheNodes-Image/ColorWheel-default.gif
+
+Usage
+--------
+
+The pattern can be changed in size and color.
+
+The ColorWheel can be used to test the result of a color grading. Below we can easily see the settings of an HSVTool darkening the reds.
+
+.. image:: _images/TheNodes-Image/ColorWheel-testing.gif
+
+The ColorWheel can be desaturated to turn it into a circular geometric pattern.
+
+.. image:: _images/TheNodes-Image/ColorWheel-pattern.gif