[Bf-docboard-svn] bf-manual: [7423] trunk/blender_docs/manual: Document new Attribute Node features from D2057.

[Alexander Gavrilov]

Revision: 7423
          https://developer.blender.org/rBM7423
Author:   angavrilov
Date:     2020-11-25 19:52:37 +0100 (Wed, 25 Nov 2020)
Log Message:
-----------
Document new Attribute Node features from D2057.

Ref rB9bc177d8ded4 rB6fdcca8de64c T82408

Modified Paths:
--------------
    trunk/blender_docs/manual/files/data_blocks.rst
    trunk/blender_docs/manual/images/render_shader-nodes_input_attribute_node.png
    trunk/blender_docs/manual/render/shader_nodes/input/attribute.rst

Modified: trunk/blender_docs/manual/files/data_blocks.rst
===================================================================
--- trunk/blender_docs/manual/files/data_blocks.rst	2020-11-25 18:29:59 UTC (rev 7422)
+++ trunk/blender_docs/manual/files/data_blocks.rst	2020-11-25 18:52:37 UTC (rev 7423)
@@ -356,6 +356,8 @@
 Custom properties are a way to store your own data in Blender's data-blocks.
 It can be used for rigging (where bones and objects can have custom properties driving other properties),
 and Python scripts, where it's common to define new settings not available in Blender.
+It is also possible to access custom properties from materials via the
+:doc:`Attribute Node </render/shader_nodes/input/attribute>`.
 
 Only certain data supports custom properties:
 

Modified: trunk/blender_docs/manual/images/render_shader-nodes_input_attribute_node.png
===================================================================
(Binary files differ)

Modified: trunk/blender_docs/manual/render/shader_nodes/input/attribute.rst
===================================================================
--- trunk/blender_docs/manual/render/shader_nodes/input/attribute.rst	2020-11-25 18:29:59 UTC (rev 7422)
+++ trunk/blender_docs/manual/render/shader_nodes/input/attribute.rst	2020-11-25 18:52:37 UTC (rev 7423)
@@ -23,35 +23,64 @@
 
 Name
    Name of the attribute.
-   Most attributes are more easily available through the various input nodes, except for these:
 
-   Vertex Color Layers
-      These can be retrieved this by their names.
-   Density
-      Gives a scalar defining the density of any smoke inside
-      the :doc:`Fluid Domain </physics/fluid/type/domain/index>`.
-   Color
-      Gives the color of the smoke inside the :doc:`Fluid Domain </physics/fluid/type/domain/index>`.
-      The color and vector outputs are the same. The Factor output is an average of the channels.
-   Temperature
-      Gives a scalar defining the temperature of the volume. Values in the range 0 - 1 map to 0 - 1000 kelvin.
-      This may be used to render physically-based fire with the Blackbody or Principled Volume shaders.
-      All three outputs are the same.
-   Flame
-      Gives a scalar defining the density of any fire inside
-      the :doc:`Fluid Domain </physics/fluid/type/domain/index>`.
-      All three outputs are the same.
-   Ocean Foam
-      Gives a scalar defining where foam might appear when using
-      an :doc:`Ocean Modifier </modeling/modifiers/physics/ocean>`.
-      This depends on the name you give this property.
+Type
+   Specifies the type of the attribute.
 
-   .. seealso::
+   Geometry (default)
+      The attribute is associated with the geometry of the object, and its value varies from vertex
+      to vertex, or within the volume of the object.
 
-      For a full list of options see `This Thread <https://blender.stackexchange.com/questions/14262#14267>`__
-      on the Blender Stack Exchange.
+      Most geometry attributes are more easily available through the various input nodes, except for these:
 
+      Vertex Color Layers
+         These can be retrieved this by their names.
+      Density
+         Gives a scalar defining the density of any smoke inside
+         the :doc:`Fluid Domain </physics/fluid/type/domain/index>`.
+      Color
+         Gives the color of the smoke inside the :doc:`Fluid Domain </physics/fluid/type/domain/index>`.
+         The color and vector outputs are the same. The Factor output is an average of the channels.
+      Temperature
+         Gives a scalar defining the temperature of the volume. Values in the range 0 - 1 map to 0 - 1000 kelvin.
+         This may be used to render physically-based fire with the Blackbody or Principled Volume shaders.
+         All three outputs are the same.
+      Flame
+         Gives a scalar defining the density of any fire inside
+         the :doc:`Fluid Domain </physics/fluid/type/domain/index>`.
+         All three outputs are the same.
+      Ocean Foam
+         Gives a scalar defining where foam might appear when using
+         an :doc:`Ocean Modifier </modeling/modifiers/physics/ocean>`.
+         This depends on the name you give this property.
 
+      .. seealso::
+
+         For a full list of options see `This Thread <https://blender.stackexchange.com/questions/14262#14267>`__
+         on the Blender Stack Exchange.
+
+   Object
+      The attribute name specifies a :ref:`custom property <files-data_blocks-custom-properties>` name,
+      or a RNA path to a built-in property (like the Single Property :ref:`driver variables <drivers-variables>`).
+
+      The values of attributes of this type are defined once per object. The name or path is looked
+      up first in the object datablock, followed by the mesh datablock if not found. Custom properties
+      have priority over built-in ones.
+
+      The property value must be an integer, float, or a vector of 1 to 4 floats; properties of other types
+      are ignored. If a suitable property is not found, all sockets of the node, including *Alpha*, output 0.
+
+      .. tip::
+         The ``color`` attribute will output the value of the Color field in the
+         :ref:`Viewport Display <properties-object-viewport-display>` panel of the object,
+         unless overridden by a custom property.
+
+   Instancer
+      Similar to *Object*, but the attribute is looked up in the instancer particle system settings,
+      followed by the instancer object. If the current object is not instanced, or the property is
+      not found, falls back to the *Object* mode.
+
+
 Outputs
 =======
 
@@ -61,3 +90,5 @@
    XYZ vector interpolated from the attribute.
 Factor
    Scalar value interpolated from the attribute.
+Alpha
+   Alpha channel of the attribute, when available. If the attribute has no alpha channel, generally defaults to 1.