[Bf-docboard-svn] bf-manual: [8382] trunk/blender_docs/manual: Adjust the layout of F-curve docs
Aaron Carlisle
noreply at blender.org
Sun Sep 12 23:20:09 CEST 2021
Revision: 8382
https://developer.blender.org/rBM8382
Author: Blendify
Date: 2021-09-12 23:20:09 +0200 (Sun, 12 Sep 2021)
Log Message:
-----------
Adjust the layout of F-curve docs
Modified Paths:
--------------
trunk/blender_docs/manual/animation/drivers/introduction.rst
trunk/blender_docs/manual/editors/drivers_editor.rst
trunk/blender_docs/manual/editors/graph_editor/channels.rst
trunk/blender_docs/manual/editors/graph_editor/fcurves/editing.rst
trunk/blender_docs/manual/editors/graph_editor/fcurves/index.rst
trunk/blender_docs/manual/editors/graph_editor/introduction.rst
trunk/blender_docs/manual/editors/nla/sidebar.rst
trunk/blender_docs/manual/editors/nla/strips.rst
Added Paths:
-----------
trunk/blender_docs/manual/editors/graph_editor/fcurves/modifiers.rst
trunk/blender_docs/manual/editors/graph_editor/fcurves/properties.rst
Removed Paths:
-------------
trunk/blender_docs/manual/editors/graph_editor/fcurves/sidebar/curve.rst
trunk/blender_docs/manual/editors/graph_editor/fcurves/sidebar/modifiers.rst
Modified: trunk/blender_docs/manual/animation/drivers/introduction.rst
===================================================================
--- trunk/blender_docs/manual/animation/drivers/introduction.rst 2021-09-12 21:05:51 UTC (rev 8381)
+++ trunk/blender_docs/manual/animation/drivers/introduction.rst 2021-09-12 21:20:09 UTC (rev 8382)
@@ -52,7 +52,7 @@
The driver function can be defined artistically with Bézier curve handles or
mathematically with trigonometric functions or polynomial expressions such as :math:`y = a + bx`.
Furthermore, the function can also be procedurally modulated with noise or cyclic repetitions.
-See :doc:`Modifiers </editors/graph_editor/fcurves/sidebar/modifiers>` for more details.
+See :doc:`Modifiers </editors/graph_editor/fcurves/modifiers>` for more details.
Driver Configuration
Modified: trunk/blender_docs/manual/editors/drivers_editor.rst
===================================================================
--- trunk/blender_docs/manual/editors/drivers_editor.rst 2021-09-12 21:05:51 UTC (rev 8381)
+++ trunk/blender_docs/manual/editors/drivers_editor.rst 2021-09-12 21:20:09 UTC (rev 8382)
@@ -27,7 +27,7 @@
Each point on the driver curve has a handle that helps determine the relationship between the two values.
They can be selected and modified to change the shape of the curve.
- See :ref:`editors-graph-fcurves-settings-handles` for more information.
+ See :ref:`F-Curve Handles <editors-graph-fcurves-settings-handles>` for more information.
.. figure:: /images/editors_graph-editor_introduction_f-curve-example.png
@@ -141,7 +141,7 @@
Modifiers Tab
-------------
-See :doc:`F-Curve Modifiers </editors/graph_editor/fcurves/sidebar/modifiers>`.
+See :doc:`F-Curve Modifiers </editors/graph_editor/fcurves/modifiers>`.
.. (Todo) duplicated here: \editors\graph_editor\fcurves\properties.rst
Modified: trunk/blender_docs/manual/editors/graph_editor/channels.rst
===================================================================
--- trunk/blender_docs/manual/editors/graph_editor/channels.rst 2021-09-12 21:05:51 UTC (rev 8381)
+++ trunk/blender_docs/manual/editors/graph_editor/channels.rst 2021-09-12 21:20:09 UTC (rev 8382)
@@ -191,7 +191,7 @@
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>`.
+are located in the :doc:`F-Curve Modifiers </editors/graph_editor/fcurves/modifiers>`.
.. _bpy.ops.graph.hide:
Modified: trunk/blender_docs/manual/editors/graph_editor/fcurves/editing.rst
===================================================================
--- trunk/blender_docs/manual/editors/graph_editor/fcurves/editing.rst 2021-09-12 21:05:51 UTC (rev 8381)
+++ trunk/blender_docs/manual/editors/graph_editor/fcurves/editing.rst 2021-09-12 21:20:09 UTC (rev 8382)
@@ -122,7 +122,7 @@
:Shortcut: :kbd:`Shift-Ctrl-M`
Opens a pop-up allowing you to add modifiers to the active F-curve.
-Settings for the :doc:`modifier </editors/graph_editor/fcurves/sidebar/modifiers>` can be found in
+Settings for the :doc:`modifier </editors/graph_editor/fcurves/modifiers>` can be found in
the :menuselection:`Sidebar --> Modifiers` tab.
Modified: trunk/blender_docs/manual/editors/graph_editor/fcurves/index.rst
===================================================================
--- trunk/blender_docs/manual/editors/graph_editor/fcurves/index.rst 2021-09-12 21:05:51 UTC (rev 8381)
+++ trunk/blender_docs/manual/editors/graph_editor/fcurves/index.rst 2021-09-12 21:20:09 UTC (rev 8382)
@@ -9,4 +9,5 @@
introduction.rst
editing.rst
- sidebar/index.rst
+ properties.rst
+ modifiers.rst
Copied: trunk/blender_docs/manual/editors/graph_editor/fcurves/modifiers.rst (from rev 8381, trunk/blender_docs/manual/editors/graph_editor/fcurves/sidebar/modifiers.rst)
===================================================================
--- trunk/blender_docs/manual/editors/graph_editor/fcurves/modifiers.rst (rev 0)
+++ trunk/blender_docs/manual/editors/graph_editor/fcurves/modifiers.rst 2021-09-12 21:20:09 UTC (rev 8382)
@@ -0,0 +1,313 @@
+.. index:: Modifiers; F-Curve Modifiers
+.. index:: F-Curve Modifiers
+
+.. _bpy.types.FCurveModifiers:
+.. _bpy.types.FModifier:
+
+*****************
+F-Curve Modifiers
+*****************
+
+.. reference::
+
+ :Panel: :menuselection:`Sidebar region --> Modifiers --> Modifiers`
+
+F-Curve modifiers are similar to object modifiers, in that they add non-destructive effects,
+that can be adjusted at any time, and layered to create more complex effects.
+Like object modifiers, F-curve modifiers are evaluated from the top down.
+In other words, the top modifier is calculated first and consequent modifiers are calculated in order.
+Modifiers can be moved by dragging the modifier box from the top right.
+
+Modifiers can be muted or hidden by toggling the checkbox in the modifier's panel header.
+They can be removed using the delete button in the modifier's panel header.
+
+
+Adding a Modifier
+=================
+
+.. figure:: /images/editors_graph-editor_fcurves_sidebar_modifiers_panel.png
+
+ Modifiers panel.
+
+The F-curve modifier panel is located in the Sidebar region.
+Select a curve by selecting one of its curve points, or by selecting the channel list.
+Click on the *Add Modifier* menu to select a modifier.
+
+
+Types of Modifiers
+==================
+
+.. index:: F-Curve Modifiers; Generator Modifier
+.. _bpy.types.FModifierGenerator:
+
+Generator Modifier
+------------------
+
+Generator creates a polynomial function.
+These are basic mathematical formulas that represent lines, parabolas,
+and other more complex curves, depending on the values used.
+
+Mode
+ Method used to represent the equation.
+
+ :Expanded Polynomial: Equation in the form :math:`y = x^1 + x^2 + ... + x^n`.
+ :Factorized Polynomial: Equation in the form :math:`y = (Ax + B)(Cx + D)`.
+
+Additive
+ This option causes the modifier to be added to the curve, instead of replacing it by default.
+
+Order
+ Specify the order of the polynomial, or the highest power of ``X`` for this polynomial.
+ (Number of coefficients: 1.)
+
+ Change the Coefficient values to change the shape of the curve.
+
+ .. seealso::
+
+ The `Wikipedia Page <https://en.wikipedia.org/wiki/Polynomial>`__
+ for more information on polynomials.
+
+Influence
+ Controls the percentage of affect the modifier has on the F-curve.
+
+
+Restrict Frame Range
+^^^^^^^^^^^^^^^^^^^^
+
+Start/End
+ The frame the modifier's affect starts/ends.
+Blend In, Out
+ The number of frames, relative the start/end values above, the modifier takes to fade in/out.
+
+
+.. index:: F-Curve Modifiers; Built-in Function Modifier
+.. _bpy.types.FModifierFunctionGenerator:
+
+Built-in Function Modifier
+--------------------------
+
+These are additional formulas, each with the same options to control their shape.
+Consult mathematics reference for more detailed information on each function:
+
+Type
+ The built-in function to use.
+
+ :Sine: `Sine <https://en.wikipedia.org/wiki/Sine>`__.
+ :Cosine: `Cosine <https://en.wikipedia.org/wiki/Trigonometric_functions>`__.
+ :Tangent: `Tangent <https://en.wikipedia.org/wiki/Trigonometric_functions>`__.
+ :Square Root: The square root of the value.
+ :Natural Logarithm: The natural log of the value.
+ :Normalized Sine: :math:`sin(x)/x`.
+
+Additive
+ This option causes the modifier to be added to the curve, instead of replacing it by default.
+
+Amplitude
+ Adjusts the Y scaling.
+Phase Multiplier
+ Adjusts the X scaling.
+Phase Offset
+ Adjusts the X offset.
+Value Offset
+ Adjusts the Y offset.
+
+Influence
+ Controls the percentage of affect the modifier has on the F-curve.
+
+
+Restrict Frame Range
+^^^^^^^^^^^^^^^^^^^^
+
+Start/End
+ The frame the modifier's affect starts/ends.
+Blend In, Out
+ The number of frames, relative the start/end values above, the modifier takes to fade in/out.
+
+
+.. index:: F-Curve Modifiers; Envelope Modifier
+.. _bpy.types.FModifierEnvelope:
+.. _bpy.types.FModifierEnvelopeControlPoint:
+
+Envelope Modifier
+-----------------
+
+Allows you to adjust the overall shape of a curve with control points.
+
+Reference
+ Set the Y value the envelope is centered around.
+Min
+ Lower distance from Reference Value for ``1:1`` default influence.
+Max
+ Upper distance from Reference Value for ``1:1`` default influence.
+
+Add Control Point
+ Add a set of control points. They will be created at the current frame.
+
+Point
+ Frame
+ Set the frame number for the control point.
+ Min
+ Specifies the lower control point's position.
+ Max
+ Specifies the upper control point's position.
+
+Influence
+ Controls the percentage of affect the modifier has on the F-curve.
+
+
+Restrict Frame Range
+^^^^^^^^^^^^^^^^^^^^
+
+Start/End
+ The frame the modifier's affect starts/ends.
+Blend In, Out
+ The number of frames, relative the start/end values above, the modifier takes to fade in/out.
+
+
+.. index:: F-Curve Modifiers; Cycles Modifier
+.. _bpy.types.FModifierCycles:
+
+Cycles Modifier
+---------------
+
+Cycles allows you add cyclic motion to a curve that has two or more control points.
+The options can be set for before and after the curve.
+
+.. note::
+
+ The Cycles Modifier can only be the first modifier.
+
+Before/After Mode
+ :No Cycles: Do not repeat curve data before/after.
+ :Repeat Motion:
+ Repeats the curve data, while maintaining their values each cycle.
+ :Repeat with Offset:
+ Repeats the curve data, but offsets the value of the first point to the value of the last point each cycle.
+ :Repeat Mirrored:
+ Each cycle the curve data is flipped across the X axis.
+
+Count
+ Set the number of times to cycle the data. A value of 0 cycles the data infinitely.
+
+Influence
+ Controls the percentage of affect the modifier has on the F-curve.
+
+
+Restrict Frame Range
+^^^^^^^^^^^^^^^^^^^^
+
+Start/End
+ The frame the modifier's affect starts/ends.
+Blend In, Out
+ The number of frames, relative the start/end values above, the modifier takes to fade in/out.
+
+
+Trivially Cyclic Curves
+^^^^^^^^^^^^^^^^^^^^^^^
+
+When the *Cycle Mode* for both ends is set to either *Repeat Motion* or
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-docboard-svn
mailing list