[Bf-docboard-svn] bf-manual: [8143] trunk/blender_docs/manual: Nodes: Docs for the raycast geometry node.

[Lukas Toenne]

Revision: 8143
          https://developer.blender.org/rBM8143
Author:   lukastoenne
Date:     2021-06-18 12:38:20 +0200 (Fri, 18 Jun 2021)
Log Message:
-----------
Nodes: Docs for the raycast geometry node.

Modified Paths:
--------------
    trunk/blender_docs/manual/modeling/geometry_nodes/geometry/index.rst

Added Paths:
-----------
    trunk/blender_docs/manual/images/modeling_geometry-nodes_geometry_raycast_node.png
    trunk/blender_docs/manual/modeling/geometry_nodes/geometry/raycast.rst

Added: trunk/blender_docs/manual/images/modeling_geometry-nodes_geometry_raycast_node.png
===================================================================
(Binary files differ)

Index: trunk/blender_docs/manual/images/modeling_geometry-nodes_geometry_raycast_node.png
===================================================================
--- trunk/blender_docs/manual/images/modeling_geometry-nodes_geometry_raycast_node.png	2021-06-16 02:54:12 UTC (rev 8142)
+++ trunk/blender_docs/manual/images/modeling_geometry-nodes_geometry_raycast_node.png	2021-06-18 10:38:20 UTC (rev 8143)

Property changes on: trunk/blender_docs/manual/images/modeling_geometry-nodes_geometry_raycast_node.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Modified: trunk/blender_docs/manual/modeling/geometry_nodes/geometry/index.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/geometry/index.rst	2021-06-16 02:54:12 UTC (rev 8142)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/geometry/index.rst	2021-06-18 10:38:20 UTC (rev 8143)
@@ -10,4 +10,5 @@
    convex_hull.rst
    delete_geometry.rst
    join_geometry.rst
+   raycast.rst
    transform.rst

Added: trunk/blender_docs/manual/modeling/geometry_nodes/geometry/raycast.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/geometry/raycast.rst	                        (rev 0)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/geometry/raycast.rst	2021-06-18 10:38:20 UTC (rev 8143)
@@ -0,0 +1,85 @@
+.. index:: Geometry Nodes; Raycast
+.. _bpy.types.GeometryNodeRaycast:
+
+*******
+Raycast
+*******
+
+.. figure:: /images/modeling_geometry-nodes_geometry_raycast_node.png
+   :align: center
+
+   Raycast node.
+
+The *Raycast* node intersects rays from one geometry onto another.
+It computes hit points on the target mesh and returns normals, distances
+and any surface attribute specified by the user.
+
+A ray starts on each point of the input *Geometry*. Rays continue
+in the *Ray Direction* until they either hit the *Target Geometry*
+or reach the *Ray Length* limit. If the target is hit, the value of the *Is Hit*
+attribute in the output mesh will be true. *Hit Position*, *Hit Normal* and
+*Hit Distance* are the properties of the target mesh at the intersection point.
+In addition, a *Target Attribute* can be specified that is interpolated
+at the hit point and the result stored in *Hit Attribute*.
+
+
+Inputs
+======
+
+Geometry
+   Rays are created at the geometry points.
+
+Target Geometry
+   Geometry that rays are tested against.
+
+Ray Direction
+   Direction of each ray from the starting position.
+
+Ray Length
+   Maximum distance a ray can travel before being considered "no hit".
+
+Target Attribute
+   An optional attribute of the *Target Geometry* that will be interpolated at the hit points. The resulting values are stored in the output attribute named by *Hit Attribute*.
+
+Is Hit
+   Boolean output attribute that is true for each ray which has hit the *Target Geometry*.
+
+Hit Position
+   Output attribute storing the intersection point with the target mesh.
+
+Hit Normal
+   Output attribute storing the surface normal vector at the hit location.
+
+Hit Distance
+   Output attribute storing distance from the ray origin to the hit point.
+
+Hit Attribute
+   Output Attribute storing interpolated values of the *Target Attribute* at the hit positions.
+
+
+Properties
+==========
+
+Ray Direction
+   :Attribute: The input is a text field that expects an attribute name.
+   :Vector: The input is a vector of three float numbers.
+
+Ray Length
+   :Attribute: The input is a text field that expects an attribute name.
+   :Float: The input is a number field.
+
+Mapping
+   How attributes of the target mesh are mapped to the attribute values on the result geometry.
+
+   Interpolated
+      Vertex and corner attributes are interpolated with a bilinear function.
+
+   Nearest
+      Chooses the attribute value of the closest vertex or face corner without interpolating.
+
+
+Outputs
+=======
+
+Geometry
+   Geometry that contains output attributes for each ray.


Property changes on: trunk/blender_docs/manual/modeling/geometry_nodes/geometry/raycast.rst
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property