[Bf-docboard-svn] bf-manual: [7908] trunk/blender_docs/manual: Add documentation for attribute domains
Wannes Malfait
noreply at blender.org
Wed Mar 31 19:18:45 CEST 2021
Revision: 7908
https://developer.blender.org/rBM7908
Author: Wannes
Date: 2021-03-31 19:18:45 +0200 (Wed, 31 Mar 2021)
Log Message:
-----------
Add documentation for attribute domains
Modified Paths:
--------------
trunk/blender_docs/manual/editors/spreadsheet.rst
trunk/blender_docs/manual/modeling/geometry_nodes/attributes_reference.rst
Modified: trunk/blender_docs/manual/editors/spreadsheet.rst
===================================================================
--- trunk/blender_docs/manual/editors/spreadsheet.rst 2021-03-31 16:18:01 UTC (rev 7907)
+++ trunk/blender_docs/manual/editors/spreadsheet.rst 2021-03-31 17:18:45 UTC (rev 7908)
@@ -29,7 +29,7 @@
Geometry Component Type
Part of the geometry to display data from.
- :Mesh: Mesh component containing point, corner, polygon and edge data.
+ :Mesh: Mesh component containing point, corner, face and edge data.
:Point Cloud: Point cloud component containing only point data.
:Instances: Display which objects and collections are instanced and their transforms.
@@ -39,8 +39,8 @@
Attribute domain to display.
:Point: Display attributes that are stored per point.
- :Corner: Display attributes that are stored per polygon corner.
- :Polygon: Display attributes that are stored per polygon.
+ :Corner: Display attributes that are stored per face corner.
+ :Face: Display attributes that are stored per face.
:Edge: Display attributes that are stored per edge.
.. _bpy.ops.spreadsheet.toggle_pin:
Modified: trunk/blender_docs/manual/modeling/geometry_nodes/attributes_reference.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/attributes_reference.rst 2021-03-31 16:18:01 UTC (rev 7907)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/attributes_reference.rst 2021-03-31 17:18:45 UTC (rev 7908)
@@ -17,22 +17,46 @@
Attribute data types are converted implicitly where possible, just like node sockets.
+Attribute Domains
+===========================
+All attributes have a domain and type associated with them. Knowing the domain of an attribute is
+important to know which parts of the geometry the attribute can affect. You can use the
+:doc:`Spreadsheet Editor </editors/spreadsheet>` to determine the domains of attributes.
+
+#. Point domain attributes are associated with the vertices of the mesh or the points in a point cloud.
+#. Edge domain attributes are associated with the edges of the mesh.
+#. Face domain attributes are associated with the faces of the mesh.
+#. Face corner domain attributes are associated with the corners of the faces of the mesh. An example is the
+ *UVMap* attribute.
+
+.. note::
+
+ For point cloud objects, every attribute has the *point* domain.
+
+.. tip::
+
+ Use the :doc:`Attribute Convert </modeling/geometry_nodes/attribute/attribute_convert>` node to change
+ the domain and type of attributes.
+
+
Built-In Attributes
===================
-Built-in attributes always exist, and cannot be removed. Their data type can not be changed.
+Built-in attributes always exist, and cannot be removed. Their data type and domain can not be changed.
.. list-table::
- :widths: 10 10 50
+ :widths: 10 10 10 50
:header-rows: 1
* - Name
- Type
+ - Domain
- Notes
* - **position**
- *Vector*
+ - *Point*
- Built-in attribute describing vertex or point locations, in the modifier
object's transform space. Any node that changes the location of points will adjust
this attribute, like the :doc:`Transform </modeling/geometry_nodes/geometry/transform>`
@@ -40,6 +64,7 @@
* - **radius**
- *Float*
+ - *Point*
- A built-in attribute on point cloud data created by
the :doc:`Point Distribute Node </modeling/geometry_nodes/point/point_distribute>`
Used to set the size for the points in the viewport.
@@ -46,23 +71,27 @@
* - **material_index**
- *Integer*
- - Used to specify the material slot for every polygon in a mesh.
+ - *Face*
+ - Used to specify the material slot for every face in a mesh.
* - **crease**
- *Float*
+ - *Edge*
- Edge attribute used by the Subdivision Surface node and modifier.
It only allows values between 0 and 1.
* - **normal**
- *Vector*
- - Normal of a polygon. This is a bit different from the other builtin attributes in that
+ - *Face*
+ - Normal of a face. This is a bit different from the other builtin attributes in that
it cannot be modified. It is automatically derived from the mesh. If this attribute is
accessed on non-point domains, it might not be normalized, because it is interpolated
- from normals of neighboring polygons.
+ from normals of neighboring faces.
* - **shade_smooth**
- *Boolean*
- - Polygon attribute determining if a polygon should have smooth shading enabled.
+ - *Face*
+ - Attribute determining if a face should have smooth shading enabled.
Naming Conventions
==================
More information about the Bf-docboard-svn
mailing list