[Bf-docboard-svn] bf-manual: [8490] trunk/blender_docs/manual/modeling/geometry_nodes: Geometry Nodes: Add documentation for the remaining curve nodes

Hans Goudey noreply at blender.org
Tue Oct 19 06:40:15 CEST 2021


Revision: 8490
          https://developer.blender.org/rBM8490
Author:   HooglyBoogly
Date:     2021-10-19 06:40:15 +0200 (Tue, 19 Oct 2021)
Log Message:
-----------
Geometry Nodes: Add documentation for the remaining curve nodes

Modified Paths:
--------------
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/index.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/resample_curve.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/sample_curve.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/set_curve_radius.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/set_curve_tilt.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/set_handle_positions.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/set_spline_cyclic.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/set_spline_resolution.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/set_spline_type.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/input/normal.rst

Added Paths:
-----------
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_handle_position.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_parameter.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_tangent.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_tilt.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/fillet_curve.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/curve/is_spline_cyclic.rst

Added: trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_handle_position.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_handle_position.rst	                        (rev 0)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_handle_position.rst	2021-10-19 04:40:15 UTC (rev 8490)
@@ -0,0 +1,37 @@
+.. index:: Geometry Nodes; Curve Handle Position
+.. _bpy.types.GeometryNodeInputCurveHandlePositions:
+
+**************************
+Curve Handle Position Node
+**************************
+
+.. figure:: /images/modeling_geometry-nodes_curve_curve-handle-positions_node.png
+   :align: right
+
+   Curve Handle Position Node
+
+The *Curve Handle Position* node outputs the position of each of a Bézier spline's handles.
+
+The set node for this data is the :doc:`Set Handle Positions node </modeling/geometry_nodes/curve/set_handle_positions>`.
+
+
+Inputs
+======
+
+This node has no inputs.
+
+
+Properties
+==========
+
+This node has no properties.
+
+
+Outputs
+=======
+
+Left
+   The position of the curve's left handles.
+
+Right
+   The position of the curve's right handles.


Property changes on: trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_handle_position.rst
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_parameter.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_parameter.rst	                        (rev 0)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_parameter.rst	2021-10-19 04:40:15 UTC (rev 8490)
@@ -0,0 +1,49 @@
+.. index:: Geometry Nodes; Curve Parameter
+.. _bpy.types.GeometryNodeCurveParameter:
+
+********************
+Curve Parameter Node
+********************
+
+.. figure:: /images/modeling_geometry-nodes_curve_curve-parameter_node.png
+   :align: right
+
+   Curve Parameter Node
+
+The *Curve Parameter* node outputs how far along each spline a control point is, with a value between
+zero and one. The output is different from dividing the index by the total number of control points,
+because the control points might not be equally spaced along the curve.
+
+The first value is zero, so the output corresponds to the length at the control point rather than
+including the length of the following segment.
+
+When used on the spline domain, the node outputs the portion of the total length of the curve (including
+all splines) has been traversed at the start of each spline. The order of the curve's splines is visible
+in the :doc:`Spreadsheet Editor </editors/spreadsheet>`.
+
+.. warning::
+
+   For NURBS and Bezier spline curves, keep in mind that the value retrieved from this node is the
+   value at every control point, which may not correspond to the visible *evaluated* points. For
+   NURBS splines the difference may be even more pronounced and the result may not be as expected.
+   A :doc:`/modeling/geometry_nodes/curve/resample_curve` node can be used to create a Poly spline,
+   where there is a control point for every evaluated point.
+
+
+Inputs
+======
+
+This node has no inputs.
+
+
+Properties
+==========
+
+This node has no properties.
+
+
+Outputs
+=======
+
+Factor
+   The portion of the total length of the spline at each control point.


Property changes on: trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_parameter.rst
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_tangent.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_tangent.rst	                        (rev 0)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_tangent.rst	2021-10-19 04:40:15 UTC (rev 8490)
@@ -0,0 +1,40 @@
+.. index:: Geometry Nodes; Curve Tangent
+.. _bpy.types.GeometryNodeInputTangent:
+
+******************
+Curve Tangent Node
+******************
+
+.. figure:: /images/modeling_geometry-nodes_curve_curve-tangent_node.png
+   :align: right
+
+   Curve Tangent Node
+
+The *Curve Tangent* node outputs the direction that a curve points in at each control point, depending
+on the direction of the curve (which can be controlled with the 
+:doc:`Reverse Curve node</modeling/geometry_nodes/curve/reverse_curve>`).
+The output values are normalized vectors.
+
+.. warning::
+
+   For NURBS and Bezier spline curves, keep in mind that the value retrieved from this node is the
+   value at every control point, which may not correspond to the visible *evaluated* points. For
+   NURBS splines the difference may be even more pronounced and the result may not be as expected.
+   A :doc:`/modeling/geometry_nodes/curve/resample_curve` node can be used to create a Poly spline,
+   where there is a control point for every evaluated point.
+
+Inputs
+======
+
+This node has no inputs.
+
+Properties
+==========
+
+This node has no properties.
+
+Outputs
+=======
+
+Tangent
+   The direction of the curve at every control point.
\ No newline at end of file


Property changes on: trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_tangent.rst
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_tilt.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_tilt.rst	                        (rev 0)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_tilt.rst	2021-10-19 04:40:15 UTC (rev 8490)
@@ -0,0 +1,35 @@
+.. index:: Geometry Nodes; Curve Tilt
+.. _bpy.types.GeometryNodeInputCurveTilt:
+
+************************
+Curve Tilt Node
+************************
+
+.. figure:: /images/modeling_geometry-nodes_curve_curve-tilt_node.png
+   :align: right
+
+   Curve Tilt Node
+
+The *Curve Tilt* node outputs the angle used to turn the curve normal around the direction of the 
+curve tangent in its evaluated points. Keep in mind that the output is per-control point, just like
+the values that can be controlled in curve edit mode. For NURBS and Bezier splines, the values will
+be interpolated to the final evaluated points.
+
+The input node for this data is the :doc:`Set Curve Tilt node </modeling/geometry_nodes/curve/set_curve_tilt>`.
+
+
+Inputs
+======
+
+This node has no inputs.
+
+Properties
+==========
+
+This node has no properties.
+
+Outputs
+=======
+
+Tilt
+   The tilt angle for the normal in radians.


Property changes on: trunk/blender_docs/manual/modeling/geometry_nodes/curve/curve_tilt.rst
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/blender_docs/manual/modeling/geometry_nodes/curve/fillet_curve.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/curve/fillet_curve.rst	                        (rev 0)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/curve/fillet_curve.rst	2021-10-19 04:40:15 UTC (rev 8490)
@@ -0,0 +1,52 @@
+.. index:: Geometry Nodes; Fillet Curve
+.. _bpy.types.GeometryNodeFilletCurve:
+
+*****************
+Fillet Curve Node
+*****************
+
+.. figure:: /images/modeling_geometry-nodes_curve_fillet-curve_node.png
+   :align: right
+
+   Fillet Curve Node
+
+The *Fillet Curve* rounds corners on curve control points, similar effect of the
+:doc:`Bevel Modifier </modeling/modifiers/generate/bevel>` on a 2D mesh. However, a key difference
+is that the rounded portions created by the curve fillet node are always portions of a circle.
+
+
+Inputs
+======
+
+Curve
+   Standard geometry input with a curve component.
+
+Radius
+   The radius of the circle portion generated at each fillet.
+
+Count
+   Only in *Poly* mode, the number of control points to add for each fillet.
+
+Limit Radius
+   Whether to limit the maximum value of the radius in order to avoid overlapping fillets.
+
+
+Properties
+==========
+
+Method
+   :Bézier:
+      Only two control points will be generated for every filleted control point. The shape generated
+      by the aligned handles on the generated control points on either side of the fillet is used to
+      create the circle portion shape, meaning the number of segments in the fillet shape depends on
+      the :doc:`spline's resolution value </modeling/geometry_nodes/curve/spline_resolution>`.
+   :Poly:
+      The number of control points generated for each field input is controlled directly with an
+      integer field input. This mode works better for Poly and NURBS splines.
+
+
+Outputs
+=======
+
+Curve
+   Standard geometry input with a curve component.


Property changes on: trunk/blender_docs/manual/modeling/geometry_nodes/curve/fillet_curve.rst
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: trunk/blender_docs/manual/modeling/geometry_nodes/curve/index.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/curve/index.rst	2021-10-18 15:07:58 UTC (rev 8489)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/curve/index.rst	2021-10-19 04:40:15 UTC (rev 8490)
@@ -9,6 +9,7 @@
    curve_length.rst
    curve_to_mesh.rst
    fill_curve.rst
+   fillet_curve.rst
    resample_curve.rst
    reverse_curve.rst
    sample_curve.rst
@@ -20,7 +21,12 @@
 .. toctree::
    :maxdepth: 1
 
+   curve_handle_position.rst
+   curve_parameter.rst
+   curve_tangent.rst
+   curve_tilt.rst
    handle_type_selection.rst
+   is_spline_cyclic.rst
    spline_length.rst
    spline_resolution.rst
 
@@ -36,12 +42,3 @@
    set_spline_cyclic.rst
    set_spline_resolution.rst
    set_spline_type.rst
-
-.. missing documentation
-   fillet_curve.rst
-
-   curve_handle_position.rst
-   curve_parameter.rst
-   curve_tangent.rst
-   curve_tilt.rst
-   is_spline_cyclic.rst

Added: trunk/blender_docs/manual/modeling/geometry_nodes/curve/is_spline_cyclic.rst

@@ Diff output truncated at 10240 characters. @@


More information about the Bf-docboard-svn mailing list