[Bf-docboard-svn] bf-manual: [8625] branches/blender-3.0-release/blender_docs/manual: Geometry Nodes: Add general fields description page

Hans Goudey noreply at blender.org
Thu Nov 11 06:46:57 CET 2021


Revision: 8625
          https://developer.blender.org/rBM8625
Author:   HooglyBoogly
Date:     2021-11-11 06:46:57 +0100 (Thu, 11 Nov 2021)
Log Message:
-----------
Geometry Nodes: Add general fields description page

Modified Paths:
--------------
    branches/blender-3.0-release/blender_docs/manual/modeling/geometry_nodes/index.rst
    branches/blender-3.0-release/blender_docs/manual/modeling/geometry_nodes/inspection.rst

Added Paths:
-----------
    branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_constant.png
    branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-1.png
    branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-2.png
    branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-3.png
    branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_title.png
    branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_varying.png
    branches/blender-3.0-release/blender_docs/manual/modeling/geometry_nodes/fields.rst

Added: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_constant.png
===================================================================
(Binary files differ)

Index: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_constant.png
===================================================================
--- branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_constant.png	2021-11-11 05:39:47 UTC (rev 8624)
+++ branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_constant.png	2021-11-11 05:46:57 UTC (rev 8625)

Property changes on: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_constant.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+image/png
\ No newline at end of property
Added: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-1.png
===================================================================
(Binary files differ)

Index: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-1.png
===================================================================
--- branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-1.png	2021-11-11 05:39:47 UTC (rev 8624)
+++ branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-1.png	2021-11-11 05:46:57 UTC (rev 8625)

Property changes on: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-1.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+image/png
\ No newline at end of property
Added: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-2.png
===================================================================
(Binary files differ)

Index: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-2.png
===================================================================
--- branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-2.png	2021-11-11 05:39:47 UTC (rev 8624)
+++ branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-2.png	2021-11-11 05:46:57 UTC (rev 8625)

Property changes on: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-2.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+image/png
\ No newline at end of property
Added: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-3.png
===================================================================
(Binary files differ)

Index: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-3.png
===================================================================
--- branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-3.png	2021-11-11 05:39:47 UTC (rev 8624)
+++ branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-3.png	2021-11-11 05:46:57 UTC (rev 8625)

Property changes on: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_flow-3.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+image/png
\ No newline at end of property
Added: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_title.png
===================================================================
(Binary files differ)

Index: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_title.png
===================================================================
--- branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_title.png	2021-11-11 05:39:47 UTC (rev 8624)
+++ branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_title.png	2021-11-11 05:46:57 UTC (rev 8625)

Property changes on: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_title.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+image/png
\ No newline at end of property
Added: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_varying.png
===================================================================
(Binary files differ)

Index: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_varying.png
===================================================================
--- branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_varying.png	2021-11-11 05:39:47 UTC (rev 8624)
+++ branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_varying.png	2021-11-11 05:46:57 UTC (rev 8625)

Property changes on: branches/blender-3.0-release/blender_docs/manual/images/modeling_geometry-nodes_fields_varying.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+image/png
\ No newline at end of property
Added: branches/blender-3.0-release/blender_docs/manual/modeling/geometry_nodes/fields.rst
===================================================================
--- branches/blender-3.0-release/blender_docs/manual/modeling/geometry_nodes/fields.rst	                        (rev 0)
+++ branches/blender-3.0-release/blender_docs/manual/modeling/geometry_nodes/fields.rst	2021-11-11 05:46:57 UTC (rev 8625)
@@ -0,0 +1,136 @@
+.. index:: Geometry Nodes; Fields
+
+******
+Fields
+******
+
+.. figure:: /images/modeling_geometry-nodes_fields_title.png
+   :align: center
+
+   A field input to a node.
+
+
+
+What Are Fields?
+================
+
+Fundamentally, a field is a function: aset of instructions that can transform an arbitrary number
+of inputs into a single output. A field's result can then be calculated many times with different
+input data. They are used all over geometry nodes to allow calculations that have different results
+for every element (mesh vertices, faces, etc.).
+
+For example, in the screenshot above, the field connected to the "Set Position" node
+depends on two inputs, :doc:`position </modeling/geometry_nodes/input/position>` and 
+:doc:`index </modeling/geometry_nodes/input/index>`, and transforms them into
+into a vector using a single instruction.
+
+
+Node Socket Types
+=================
+
+Socket shapes are used to convey which sockets are fields and which regular data.
+There are three possible socket shapes, each conveying the socket's "field status".
+
+Socket Shapes
+   :Circle:
+      The socket requires a single real value, it cannot accept a field input.
+      For output sockets, this means the node always outputs a single value.
+   :Diamond:
+      The socket can accept a field input, or it outputs a field. A constant single
+      value can be connected to these sockets, but then the output will often not
+      vary per element.
+   :Diamond with Dot:
+      The socket can be a field, but it is currently a single value. This is helpful
+      because it allows tracking where single values are calculated, instead of a field
+      with many different results. It also means that :ref:`socket-inspection` will show
+      the value instead of field input names.
+
+.. figure:: /images/modeling_geometry-nodes_fields_constant.png
+   :align: center
+
+   The socket shape is a diamon with a dot, meaning the field has the same value
+   for every element. Every point will be moved up by 5m.
+
+.. figure:: /images/modeling_geometry-nodes_fields_varying.png
+   :align: center
+
+   The socket shape is a diamond and the field input now has a varying input. In other words, 
+   the value can be different for every element. In this case, the position will be doubled,
+   since the offset for every point is the point's position.
+
+
+.. tip::
+
+   Often it is desired to extract a single value from a field. While it doesn't
+   make sense conceptually to simply change a field into a single value,
+   the :doc:`/modeling/geometry_nodes/attribute/transfer_attribute` in *Index* mode
+   or the :doc:`/modeling/geometry_nodes/attribute/attribute_statistic` can be used
+   to retrieve a single value from a field evaluated on a geometry.
+
+
+Node Types
+==========
+
+Nodes can be separated into two categories categories-- data flow nodes that usually pass around
+geometries, and field nodes that operate on data per-element. Field nodes can be input nodes that
+bring geometry data into the node tree, or function nodes that operate on that data.
+
+Data Flow Nodes
+~~~~~~~~~~~~~~~
+
+Nodes with a geometry input and a geometry output will almost always be data flow nodes, meaning
+they actually change geometry data that will be outputed from the geometry nodes modifier.
+
+Function Nodes
+~~~~~~~~~~~~~~
+Nodes with diamond socket inputs and outputs are field nodes, and resemble the instructions
+that will be evaluated by data flow nodes. Examples of function nodes are the math nodes
+and also more complex nodes like the :doc:`/modeling/geometry_nodes/geometry/geometry_proximity`.
+
+Input Nodes
+~~~~~~~~~~~~
+Input nodes provide data to the field evaluation process. By themselves, they mean nothing; they
+must be evaluated within the context of a data flow node (geometry) to actually output a value.
+Examples of input nodes are the built-in attribute input nodes like 
+:doc:`position </modeling/geometry_nodes/input/position>` and 
+:doc:`ID </modeling/geometry_nodes/input/id>`, but also selection nodes like 
+:doc:`endpoint selection </modeling/geometry_nodes/curve/endpoint_selection>`.
+
+Field inputs may also come from other nodes that process geometry like the 
+:doc:`/modeling/geometry_nodes/point/distribute_points_on_faces`, 
+in the form of :ref:`anonymous-attributes`.
+
+
+Field Context
+=============
+
+One common misunderstanding is that the same field network used in multipled places will

@@ Diff output truncated at 10240 characters. @@


More information about the Bf-docboard-svn mailing list