[Bf-docboard-svn] bf-manual: [7543] trunk/blender_docs/manual/modeling/modifiers/nodes: Corrections and clarifications to geometry nodes documentation
Hans Goudey
noreply at blender.org
Wed Jan 6 19:55:50 CET 2021
Revision: 7543
https://developer.blender.org/rBM7543
Author: HooglyBoogly
Date: 2021-01-06 19:55:49 +0100 (Wed, 06 Jan 2021)
Log Message:
-----------
Corrections and clarifications to geometry nodes documentation
Modified Paths:
--------------
trunk/blender_docs/manual/modeling/modifiers/nodes/attribute/attribute_compare.rst
trunk/blender_docs/manual/modeling/modifiers/nodes/attribute/attribute_math.rst
trunk/blender_docs/manual/modeling/modifiers/nodes/attribute/attribute_randomize.rst
trunk/blender_docs/manual/modeling/modifiers/nodes/geometry/join_geometry.rst
trunk/blender_docs/manual/modeling/modifiers/nodes/geometry/transform.rst
trunk/blender_docs/manual/modeling/modifiers/nodes/mesh/edge_split.rst
trunk/blender_docs/manual/modeling/modifiers/nodes/point/point_distribute.rst
trunk/blender_docs/manual/modeling/modifiers/nodes/point/point_instance.rst
Modified: trunk/blender_docs/manual/modeling/modifiers/nodes/attribute/attribute_compare.rst
===================================================================
--- trunk/blender_docs/manual/modeling/modifiers/nodes/attribute/attribute_compare.rst 2021-01-06 14:20:49 UTC (rev 7542)
+++ trunk/blender_docs/manual/modeling/modifiers/nodes/attribute/attribute_compare.rst 2021-01-06 18:55:49 UTC (rev 7543)
@@ -14,7 +14,7 @@
Like the :doc:`Attribute Math </modeling/modifiers/nodes/attribute/attribute_math>` node,
it is also possible to switch to using single values for inputs. This node can be combined with
the :doc:`Point Separate </modeling/modifiers/nodes/point/point_separate>` node for more flexibility
-for which points to separate out.
+for which points to separate to the second output geometry.
Inputs
@@ -27,9 +27,9 @@
The first and second input to the math operation.
Depending on the *Type* input, this is either an attribute name or an input of the specified data type.
-Epsilon
- For the *Equal* and *Not Equal* operations, this value is used as a threshold for still considering
- the two inputs as equal.
+Threshold
+ This value is used as a threshold for still considering the two inputs as equal
+ for the *Equal* and *Not Equal* operations,
Result
Name of the attribute where the computed result it stored.
@@ -48,7 +48,7 @@
For operations besides *Equal* and *Not Equal*, the input attributes
are converted implicitly to the float data type.
For the equality operations on vectors, the distance between
- the vector inputs are used.
+ the vector inputs is used.
Type A, B
Controls whether to use an attribute or a single value of the specified data type as an input.
Modified: trunk/blender_docs/manual/modeling/modifiers/nodes/attribute/attribute_math.rst
===================================================================
--- trunk/blender_docs/manual/modeling/modifiers/nodes/attribute/attribute_math.rst 2021-01-06 14:20:49 UTC (rev 7542)
+++ trunk/blender_docs/manual/modeling/modifiers/nodes/attribute/attribute_math.rst 2021-01-06 18:55:49 UTC (rev 7543)
@@ -10,7 +10,7 @@
.. figure:: /images/modeling_modifiers_nodes_attribute-math.png
:align: right
- Attribute Math Node.
+ The Attribute Math Node.
Inputs
@@ -25,8 +25,8 @@
Result
Name of the attribute where the computed result it stored.
- A new attribute with that name is added, if it does not exist yet.
- If it does exist, the existing attribute is overridden.
+ A new attribute with that name is added if it does not exist yet.
+ If it does exist, the values of the existing attribute are overridden.
Properties
Modified: trunk/blender_docs/manual/modeling/modifiers/nodes/attribute/attribute_randomize.rst
===================================================================
--- trunk/blender_docs/manual/modeling/modifiers/nodes/attribute/attribute_randomize.rst 2021-01-06 14:20:49 UTC (rev 7542)
+++ trunk/blender_docs/manual/modeling/modifiers/nodes/attribute/attribute_randomize.rst 2021-01-06 18:55:49 UTC (rev 7543)
@@ -46,7 +46,10 @@
Vector
Array of three (floating point) values.
+ Boolean
+ A true or false value.
+
Outputs
=======
Modified: trunk/blender_docs/manual/modeling/modifiers/nodes/geometry/join_geometry.rst
===================================================================
--- trunk/blender_docs/manual/modeling/modifiers/nodes/geometry/join_geometry.rst 2021-01-06 14:20:49 UTC (rev 7542)
+++ trunk/blender_docs/manual/modeling/modifiers/nodes/geometry/join_geometry.rst 2021-01-06 18:55:49 UTC (rev 7543)
@@ -5,13 +5,14 @@
Join Geometry
*************
-With the *Join Geometry* you can merge separately generated pieces of geometry into a single one.
+The *Join Geometry* node merges separately generated pieces of geometry into a single one.
If the inputted pieces contain different types of geometry, the output will contain multiple types of geometry.
.. figure:: /images/modeling_modifiers_nodes_join-geometry.png
- Join Geometry node.
+ The Join Geometry node.
+
Inputs
======
@@ -19,12 +20,6 @@
Standard geometry input.
-Properties
-==========
-
-This node has no properties.
-
-
Output
======
Modified: trunk/blender_docs/manual/modeling/modifiers/nodes/geometry/transform.rst
===================================================================
--- trunk/blender_docs/manual/modeling/modifiers/nodes/geometry/transform.rst 2021-01-06 14:20:49 UTC (rev 7542)
+++ trunk/blender_docs/manual/modeling/modifiers/nodes/geometry/transform.rst 2021-01-06 18:55:49 UTC (rev 7543)
@@ -8,11 +8,12 @@
.. figure:: /images/modeling_modifiers_nodes_transform.png
:align: right
- Transform modifier node.
+ The Transform node.
The *Transform Node* allows you to move, rotate or scale the geometry.
The transformation is applied to the entire geometry, and not per element.
-For example, you can not rotate individual point cloud points with this node.
+For example, rotation with this node will change the location of each point
+rather than changing the rotation of individual points. For that, the *Rotate Points* node can be used.
Inputs
@@ -22,7 +23,7 @@
Standard geometry input.
Translation
- Translates the geometry in local space of the modified object.
+ Translates the geometry in the local space of the modified object.
Rotation
Euler rotation in local space.
Scale
@@ -29,12 +30,6 @@
Scale to transform the geometry in local space.
-Properties
-==========
-
-This node has no properties.
-
-
Output
======
Modified: trunk/blender_docs/manual/modeling/modifiers/nodes/mesh/edge_split.rst
===================================================================
--- trunk/blender_docs/manual/modeling/modifiers/nodes/mesh/edge_split.rst 2021-01-06 14:20:49 UTC (rev 7542)
+++ trunk/blender_docs/manual/modeling/modifiers/nodes/mesh/edge_split.rst 2021-01-06 18:55:49 UTC (rev 7543)
@@ -8,9 +8,9 @@
.. figure:: /images/modeling_modifiers_nodes_edge-split.png
:align: right
- Edge Split Node.
+ The Edge Split Node.
-Like the :doc:`/modeling/modifiers/generate/edge_split` the *Edge Split* node splits, duplicates edges
+Like the :doc:`/modeling/modifiers/generate/edge_split`, the *Edge Split* node splits and duplicates edges
within a mesh, breaking 'links' between faces around those split edges.
.. note::
Modified: trunk/blender_docs/manual/modeling/modifiers/nodes/point/point_distribute.rst
===================================================================
--- trunk/blender_docs/manual/modeling/modifiers/nodes/point/point_distribute.rst 2021-01-06 14:20:49 UTC (rev 7542)
+++ trunk/blender_docs/manual/modeling/modifiers/nodes/point/point_distribute.rst 2021-01-06 18:55:49 UTC (rev 7543)
@@ -8,7 +8,7 @@
.. figure:: /images/modeling_modifiers_nodes_point-distribute.png
:align: right
- Point Distribute Node.
+ The Point Distribute Node.
The *Point Distribute* node distributes points on the surface of the input geometry object.
@@ -21,7 +21,7 @@
.. note::
- Only meshes are supported.
+ The input geometry must contain a mesh with faces.
Distance Min
The minimal distance points can have to each other.
@@ -28,18 +28,18 @@
This option is only available on distribution methods that supports it.
Density Max
- The point density for the point distribution.
- In other words, how many points there will be within one square meter.
+ The point density for the point distribution. The units are number of points per square meter.
+ This value is multiplied by the values from the *Density Attribute*.
.. note::
- This will be capped on distributions with the *Distance Min* option.
+ This will be capped on distributions by the *Distance Min* option.
If the density is greater than what the minimal distance allows,
no new points will be added after this threshold has been passed.
Density Attribute
- Which attribute to use for influencing the point density.
- The input values are mapped between zero and the *Density*.
+ The name of the attribute to use for influencing the point density.
+ The values of this attribute are multiplied by *Density Max* for the final density value.
Properties
@@ -48,8 +48,9 @@
Distribution Method
Random
Distribute points randomly on the surface.
+
Poisson Disk
- Project points on the surface evenly with a Poisson disk distribution.
+ Distribute points more evenly on the XY plane, then project them to the mesh along the Z axis.
Seed
The random :term:`Seed` to use when generating points.
Modified: trunk/blender_docs/manual/modeling/modifiers/nodes/point/point_instance.rst
===================================================================
--- trunk/blender_docs/manual/modeling/modifiers/nodes/point/point_instance.rst 2021-01-06 14:20:49 UTC (rev 7542)
+++ trunk/blender_docs/manual/modeling/modifiers/nodes/point/point_instance.rst 2021-01-06 18:55:49 UTC (rev 7543)
@@ -8,21 +8,26 @@
.. figure:: /images/modeling_modifiers_nodes_point-instance.png
:align: right
- Point Instance Node.
+ The Point Instance Node.
The *Point Instance* node instances an element to each of the points present in the input geometry.
It works for both point cloud and mesh vertices.
-.. note::
-
- This node only works if the modifier belongs to a point cloud object.
+.. warning::
+ Because the output geometry is only a set of instances objects or collections, the *Attribute* nodes
+ will not work on the output of this node. The location, rotation, and scale of individual points should
+ be adjusted before this node.
+
Inputs
======
Geometry
Standard geometry input.
+ The **location**, **rotation**, and **scale** or **radius** attributes affect the transform of each instanced
+ object.
+
Object
The object to instantiate.
@@ -30,9 +35,20 @@
Properties
==========
-This node has no properties.
+Type
+ Object
+ Instance a single object on each point.
+ Collection
+ Instance either an entire collection or a random choice from its objects or sub-collections.
+Whole Collection
+ When instancing collections, this property chooses between instancing the entire collection or
+ a random choice of its objects and sub-collections.
+Seed
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-docboard-svn
mailing list