[Bf-docboard-svn] bf-manual: [8380] trunk/blender_docs/manual/editors/graph_editor/fcurves: Fcurve settings: use field lists for enum items

Aaron Carlisle noreply at blender.org
Sun Sep 12 22:49:27 CEST 2021


Revision: 8380
          https://developer.blender.org/rBM8380
Author:   Blendify
Date:     2021-09-12 22:49:27 +0200 (Sun, 12 Sep 2021)
Log Message:
-----------
Fcurve settings: use field lists for enum items

I am still a bit torn by the usage of aligned images.
Instead, the images may later be placed into a table.

Modified Paths:
--------------
    trunk/blender_docs/manual/editors/graph_editor/fcurves/introduction.rst
    trunk/blender_docs/manual/editors/graph_editor/fcurves/sidebar/curve.rst

Modified: trunk/blender_docs/manual/editors/graph_editor/fcurves/introduction.rst
===================================================================
--- trunk/blender_docs/manual/editors/graph_editor/fcurves/introduction.rst	2021-09-12 20:30:01 UTC (rev 8379)
+++ trunk/blender_docs/manual/editors/graph_editor/fcurves/introduction.rst	2021-09-12 20:49:27 UTC (rev 8380)
@@ -85,38 +85,40 @@
 Mode for the :term:`Interpolation` between the current and next keyframe.
 
 
-Interpolation
-^^^^^^^^^^^^^
+.. rubric:: Interpolation
 
-Constant
+:Constant:
+   .. figure:: /images/editors_graph-editor_fcurves_introduction_constant.png
+      :align: right
+      :width: 300px
+
+      Constant.
+
    There is no interpolation at all. The curve holds the value of its last keyframe,
    giving a discrete (stairway) "curve".
    Usually only used during the initial "blocking" stage in pose-to-pose animation workflows.
 
-   .. figure:: /images/editors_graph-editor_fcurves_introduction_constant.png
+:Linear:
+   .. figure:: /images/editors_graph-editor_fcurves_introduction_linear.png
+      :align: right
       :width: 300px
 
-      Constant.
+      Linear.
 
-Linear
    This simple interpolation creates a straight segment, giving a non-continuous line.
    It can be useful when using only two keyframes and the *Extrapolation* extend mode,
    to easily get an infinite straight line (i.e. a linear curve).
 
-   .. figure:: /images/editors_graph-editor_fcurves_introduction_linear.png
+:Bézier:
+   .. figure:: /images/editors_graph-editor_fcurves_editing_clean1.png
+      :align: right
       :width: 300px
 
-      Linear.
+      Bézier.
 
-Bézier
    The more powerful and useful interpolation, and the default one.
    It gives nicely smoothed curves, i.e. smooth animations!
 
-   .. figure:: /images/editors_graph-editor_fcurves_editing_clean1.png
-      :width: 300px
-
-      Bézier.
-
 .. note::
 
    Remember that some F-curves can only take discrete values,
@@ -123,8 +125,7 @@
    in which case they are always shown as if constant interpolated, whatever option you chose.
 
 
-Easing (by strength)
-^^^^^^^^^^^^^^^^^^^^
+.. rubric:: Easing (by strength)
 
 Different methods of easing interpolations for F-curve segment.
 The "Robert Penner easing equations" (basically, equations which define some preset ways that
@@ -146,13 +147,12 @@
    http://robertpenner.com/easing/
 
 
-Dynamic Effects
-^^^^^^^^^^^^^^^
+.. rubric:: Dynamic Effects
 
 These additional easing types imitate (fake) physics-based effects like bouncing/springing effects.
 The corresponding settings can be found in the :menuselection:`Sidebar region --> Active Keyframe panel`.
 
-Back
+:Back:
    Cubic easing with overshoot and settle.
    Use this one when you want a bit of an overshoot coming into the next keyframe,
    or perhaps for some wind-up anticipation.
@@ -160,11 +160,11 @@
    Back
       The back property controls the size and direction (i.e. above/below the curve) of the overshoot.
 
-Bounce
+:Bounce:
    Exponentially decaying parabolic bounce, like when objects collide.
    e.g. for Bouncing balls, etc.
 
-Elastic
+:Elastic:
    Exponentially decaying sine wave, like an elastic band.
    This is like bending a stiff pole stuck to some surface,
    and watching it rebound and settle back to its original state.
@@ -192,14 +192,14 @@
 The Easing Type has no effect if the :ref:`Interpolation Mode <editors-graph-fcurves-settings-interpolation>`
 is set to either *Constant*, *Linear*, or *Bézier*.
 
-Automatic Easing
+:Automatic Easing:
    The most commonly expected of the below behaviors is used.
    For the transitional effects, this is basically *ease in*, while for the physics effects it is *ease out*.
-Ease In
+:Ease In:
    Effect builds up to the second keyframe.
-Ease Out
+:Ease Out:
    Effect fades out from the first keyframe.
-Ease In Out
+:Ease In Out:
    Effect occurs on both ends of the segment.
 
 
@@ -217,23 +217,25 @@
 
 There are two basic extrapolation modes:
 
-Constant
-   The default one, curves before their first keyframe and after their last one have a constant value
-   (the one of these first and last keyframes).
-
+:Constant:
    .. figure:: /images/editors_graph-editor_fcurves_introduction_extrapolate1.png
+      :align: right
       :width: 300px
 
       Constant extrapolation.
 
-Linear
-   Curves ends are straight lines (linear), as defined by the slope of their first and last keyframes.
+   The default one, curves before their first keyframe and after their last one have a constant value
+   (the one of these first and last keyframes).
 
+:Linear:
    .. figure:: /images/editors_graph-editor_fcurves_introduction_extrapolate2.png
+      :align: right
       :width: 300px
 
       Linear extrapolation.
 
+   Curves ends are straight lines (linear), as defined by the slope of their first and last keyframes.
+
 Additional extrapolation methods (e.g. the *Cycles* modifier)
 are located in the :doc:`F-Curve Modifiers </editors/graph_editor/fcurves/sidebar/modifiers>`.
 
@@ -261,45 +263,50 @@
 
 By using the other, non-automatic modes, you have full manual control over the slope.
 
-Automatic
-   Handle positions are automatically chosen to produce smooth curves.
-
+:Automatic:
    .. figure:: /images/editors_graph-editor_fcurves_introduction_auto.png
-      :width: 400px
+      :align: right
+      :width: 300px
 
       Auto handles.
 
-Auto Clamped
-   Automatic handles clamped to prevent overshoots and
-   changes in the curve direction between keyframes (S-shapes).
+   Handle positions are automatically chosen to produce smooth curves.
 
+:Auto Clamped:
    .. figure:: /images/editors_graph-editor_fcurves_introduction_autoclamped.png
-      :width: 400px
+      :align: right
+      :width: 300px
 
       Auto clamped handles.
 
-Vector
-   Creates automatic linear interpolation between keyframes. The segments remain linear when
-   keyframe centers are moved. However, when the handles are moved, the handle type switches to *Free*.
+   Automatic handles clamped to prevent overshoots and
+   changes in the curve direction between keyframes (S-shapes).
 
+:Vector:
    .. figure:: /images/editors_graph-editor_fcurves_introduction_vector.png
-      :width: 400px
+      :align: right
+      :width: 300px
 
       Vector handles.
 
-Aligned
-   The two handles of the curve point are locked together to always point in exactly opposite directions.
-   This results in a curve that is always smooth at the control point.
+   Creates automatic linear interpolation between keyframes. The segments remain linear when
+   keyframe centers are moved. However, when the handles are moved, the handle type switches to *Free*.
 
+:Aligned:
    .. figure:: /images/editors_graph-editor_fcurves_introduction_aligned.png
-      :width: 400px
+      :align: right
+      :width: 300px
 
       Aligned handles.
 
-Free
-   The handles can be moved completely independently, and thus can result in a sharp change of direction.
+   The two handles of the curve point are locked together to always point in exactly opposite directions.
+   This results in a curve that is always smooth at the control point.
 
+:Free:
    .. figure:: /images/editors_graph-editor_fcurves_introduction_free.png
-      :width: 400px
+      :align: right
+      :width: 300px
 
       Free handles.
+
+   The handles can be moved completely independently, and thus can result in a sharp change of direction.

Modified: trunk/blender_docs/manual/editors/graph_editor/fcurves/sidebar/curve.rst
===================================================================
--- trunk/blender_docs/manual/editors/graph_editor/fcurves/sidebar/curve.rst	2021-09-12 20:30:01 UTC (rev 8379)
+++ trunk/blender_docs/manual/editors/graph_editor/fcurves/sidebar/curve.rst	2021-09-12 20:49:27 UTC (rev 8380)
@@ -34,11 +34,11 @@
 Display Color
    The method used to determine the color of the F-curve shown in the Graph editor.
 
-   Auto Rainbow
+   :Auto Rainbow:
       Increment the hue of the F-curve color based on the channel index.
-   Auto XYZ to RGB
+   :Auto XYZ to RGB:
       For property sets like location XYZ, automatically set the set of colors to red, green, blue.
-   User Defined
+   :User Defined:
       Define a custom color for the active F-curve.
 
 .. _bpy.types.FCurve.auto_smoothing:
@@ -54,7 +54,7 @@
 
       From left to right, four *Auto Clamped* keys, one *Vector*, and the rest are *Automatic*.
 
-   None
+   :None:
       Only directly adjacent key values are considered when computing the handles.
       Vector handles are pointed directly at the adjacent keyframes.
 
@@ -62,7 +62,7 @@
       truly smooth curves in the most trivial cases. Note the kinks in the yellow curve
       around the keys located between the extremes, and near the Vector handles.
 
-   Continuous Acceleration
+   :Continuous Acceleration:
       A system of equations is solved in order to avoid or minimize jumps in acceleration
       at every keyframe. Vector handles are integrated into the curves as smooth transitions
       to imaginary straight lines beyond the keyframe.



More information about the Bf-docboard-svn mailing list