[Bf-docboard-svn] bf-manual: [8882] trunk/blender_docs/manual: Geometry Nodes: Accumulate Field Node
Hans Goudey
noreply at blender.org
Wed Jan 26 19:36:23 CET 2022
Revision: 8882
https://developer.blender.org/rBM8882
Author: HooglyBoogly
Date: 2022-01-26 19:36:23 +0100 (Wed, 26 Jan 2022)
Log Message:
-----------
Geometry Nodes: Accumulate Field Node
Thanks to Vyacheslav (@hitrpr) for the second example file.
rBa836ded9902d67359ea94a03c45de7edd4f826fb
Modified Paths:
--------------
trunk/blender_docs/manual/modeling/geometry_nodes/mesh/mesh_island.rst
trunk/blender_docs/manual/modeling/geometry_nodes/utilities/index.rst
Added Paths:
-----------
trunk/blender_docs/manual/images/modeling_geometry-nodes_accumulate-field_node.png
trunk/blender_docs/manual/images/modeling_geometry-nodes_utilities_accumulate-field_box-stack-2.png
trunk/blender_docs/manual/images/modeling_geometry-nodes_utilities_accumulate-field_box-stack.png
trunk/blender_docs/manual/modeling/geometry_nodes/utilities/accumulate_field.rst
Added: trunk/blender_docs/manual/images/modeling_geometry-nodes_accumulate-field_node.png
===================================================================
(Binary files differ)
Index: trunk/blender_docs/manual/images/modeling_geometry-nodes_accumulate-field_node.png
===================================================================
--- trunk/blender_docs/manual/images/modeling_geometry-nodes_accumulate-field_node.png 2022-01-26 17:13:36 UTC (rev 8881)
+++ trunk/blender_docs/manual/images/modeling_geometry-nodes_accumulate-field_node.png 2022-01-26 18:36:23 UTC (rev 8882)
Property changes on: trunk/blender_docs/manual/images/modeling_geometry-nodes_accumulate-field_node.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+image/png
\ No newline at end of property
Added: trunk/blender_docs/manual/images/modeling_geometry-nodes_utilities_accumulate-field_box-stack-2.png
===================================================================
(Binary files differ)
Index: trunk/blender_docs/manual/images/modeling_geometry-nodes_utilities_accumulate-field_box-stack-2.png
===================================================================
--- trunk/blender_docs/manual/images/modeling_geometry-nodes_utilities_accumulate-field_box-stack-2.png 2022-01-26 17:13:36 UTC (rev 8881)
+++ trunk/blender_docs/manual/images/modeling_geometry-nodes_utilities_accumulate-field_box-stack-2.png 2022-01-26 18:36:23 UTC (rev 8882)
Property changes on: trunk/blender_docs/manual/images/modeling_geometry-nodes_utilities_accumulate-field_box-stack-2.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+image/png
\ No newline at end of property
Added: trunk/blender_docs/manual/images/modeling_geometry-nodes_utilities_accumulate-field_box-stack.png
===================================================================
(Binary files differ)
Index: trunk/blender_docs/manual/images/modeling_geometry-nodes_utilities_accumulate-field_box-stack.png
===================================================================
--- trunk/blender_docs/manual/images/modeling_geometry-nodes_utilities_accumulate-field_box-stack.png 2022-01-26 17:13:36 UTC (rev 8881)
+++ trunk/blender_docs/manual/images/modeling_geometry-nodes_utilities_accumulate-field_box-stack.png 2022-01-26 18:36:23 UTC (rev 8882)
Property changes on: trunk/blender_docs/manual/images/modeling_geometry-nodes_utilities_accumulate-field_box-stack.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+image/png
\ No newline at end of property
Modified: trunk/blender_docs/manual/modeling/geometry_nodes/mesh/mesh_island.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/mesh/mesh_island.rst 2022-01-26 17:13:36 UTC (rev 8881)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/mesh/mesh_island.rst 2022-01-26 18:36:23 UTC (rev 8882)
@@ -1,5 +1,5 @@
.. index:: Geometry Nodes; Mesh Island
-.. _bpy.types.GeometryNodeEdgeNeighbors:
+.. _bpy.types.GeometryNodeMeshIsland:
****************
Mesh Island Node
Added: trunk/blender_docs/manual/modeling/geometry_nodes/utilities/accumulate_field.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/utilities/accumulate_field.rst (rev 0)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/utilities/accumulate_field.rst 2022-01-26 18:36:23 UTC (rev 8882)
@@ -0,0 +1,105 @@
+.. index:: Geometry Nodes; Accumulate Field
+.. _bpy.types.GeometryNodeAccumulateField:
+
+*********************
+Accumulate Field Node
+*********************
+
+.. figure:: /images/modeling_geometry-nodes_accumulate-field_node.png
+ :align: right
+
+ Accumulate Field Node.
+
+The *Accumulate Field* node counts a running total of its input values, in the order defined
+by the geometry's :doc:`indices </modeling/geometry_nodes/input/input_index>`. The node's essential
+operation is just addition, but instead of only outputting the final total, it outputs the current
+value at every element.
+
+
+Inputs
+======
+
+Value
+ The values to be accumulated.
+
+ .. warning::
+
+ When accumulating integer values, be careful to make sure that there are not
+ too many large values. The maximum integer that Blender stores internally is
+ around 2 billion. After that, values may wrap around and become negative.
+ See `wikipedia <https://en.wikipedia.org/wiki/Integer_%28computer_science%29>`__
+ for more information.
+
+Group Index
+ An index used to group values together for multiple separate accumulations.
+ This can be thought of as a choice of the "bin" in which to place each value.
+ This input has no effect when it is only a single value.
+
+
+Properties
+==========
+
+Data Type
+ :Float: The node will accumulate a *Float* field.
+ :Integer: The node will accumulate an *Integer* field.
+ :Vector: The node will accumulate a *Vector* field.
+
+Domain
+ The :ref:`attribute domain <attribute-domains>` used for accumulation
+ and for evaluation of the *Value* input. If the
+
+
+Output
+======
+
+Leading
+ The running total of values in the corresponding group, starting at the first value.
+
+Trailing
+ The running total of values in the corresponding group, starting at zero.
+
+Total
+ The total of all of the values in the corresponding group
+
+
+Examples
+========
+
+Table
+-----
+
++-------+-------------+---------+----------+-------+
+| Value | Group Index | Leading | Trailing | Total |
++=======+=============+=========+==========+=======+
+| 1 | 7 | 1 | 0 | 6 |
++-------+-------------+---------+----------+-------+
+| 3 | 7 | 4 | 1 | 6 |
++-------+-------------+---------+----------+-------+
+| 2 | 7 | 6 | 4 | 6 |
++-------+-------------+---------+----------+-------+
+| 1 | 3 | 1 | 0 | 3 |
++-------+-------------+---------+----------+-------+
+| 0 | 3 | 1 | 1 | 3 |
++-------+-------------+---------+----------+-------+
+| 2 | 3 | 3 | 1 | 3 |
++-------+-------------+---------+----------+-------+
+
+A few examples of input values and the node's results. One important take-away from this table
+is that the specific values for the *Group Input* does not matter; it only matters that the
+values are shared between elements.
+
+Stacking Boxes
+--------------
+
+.. figure:: /images/modeling_geometry-nodes_utilities_accumulate-field_box-stack.png
+ :align: center
+
+Here, the node is used in combination with the :doc:`/modeling/geometry_nodes/utilities/random_value`
+node to create a stack of randomly scaled boxes. The *Group Index* input is not used, because all boxes
+are meant to be in the same stack.
+
+.. figure:: /images/modeling_geometry-nodes_utilities_accumulate-field_box-stack-2.png
+ :align: center
+
+A slightly more complicated version of the previous example,
+using the *Group Index* input to create three separate stacks.
Property changes on: trunk/blender_docs/manual/modeling/geometry_nodes/utilities/accumulate_field.rst
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: trunk/blender_docs/manual/modeling/geometry_nodes/utilities/index.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/utilities/index.rst 2022-01-26 17:13:36 UTC (rev 8881)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/utilities/index.rst 2022-01-26 18:36:23 UTC (rev 8882)
@@ -8,6 +8,7 @@
.. toctree::
:maxdepth: 1
+ accumulate_field.rst
align_euler_to_vector.rst
boolean_math.rst
clamp.rst
More information about the Bf-docboard-svn
mailing list