[Bf-docboard-svn] bf-manual: [8612] branches/blender-3.0-release/blender_docs/manual/animation/motion_paths.rst: Motion Paths: Cleanup and RNA links

Wed Nov 10 01:01:42 CET 2021

Revision: 8612
          https://developer.blender.org/rBM8612
Author:   Blendify
Date:     2021-11-10 01:01:42 +0100 (Wed, 10 Nov 2021)
Log Message:
-----------
Motion Paths: Cleanup and RNA links

Modified Paths:
--------------
    branches/blender-3.0-release/blender_docs/manual/animation/motion_paths.rst

Modified: branches/blender-3.0-release/blender_docs/manual/animation/motion_paths.rst
===================================================================

--- branches/blender-3.0-release/blender_docs/manual/animation/motion_paths.rst	2021-11-09 22:45:17 UTC (rev 8611)
+++ branches/blender-3.0-release/blender_docs/manual/animation/motion_paths.rst	2021-11-10 00:01:42 UTC (rev 8612)
@@ -1,5 +1,5 @@
-.. _bpy.types.AnimViz:
-.. _bpy.ops.object.paths_calculate:
+.. _bpy.types.AnimVizMotionPaths:
+.. _bpy.types.MotionPath:
 
 ************
 Motion Paths
@@ -53,74 +53,127 @@
 
    The Motion Paths panel in the Armature tab.
 
-Type
-   Around Frame
+.. _bpy.types.AnimVizMotionPaths.type:
+
+Paths Type
+   Type of range to show for Motion Paths.
+
+   :Around Frame:
       Display paths of points within a fixed number of frames around the current frame.
       When you enable this button, you get paths for a given number of frames before and after the current one
       (again, as with ghosts).
-   In Range
+   :In Range:
       Display paths of points within specified range.
 
-      Clock Button
+      .. _bpy.ops.pose.paths_range_update:
+
+      Update Range from Scene (Clock Icon)
          Updates the display frame range from the scene frame range.
-Frame Range
-   Before, After
-      Number of frames to show before and after the current frame
-      (only for *Around Current Frame* Onion-skinning method).
-   Start, End
+
+.. _bpy.types.AnimVizMotionPaths.frame_start:
+.. _bpy.types.AnimVizMotionPaths.frame_end:
+
+Frame Range Start, End
       Starting and Ending frame of range of paths to display/calculate
       (not for *Around Current Frame* Onion-skinning method).
-   Step
-      Allows displaying one point for every *n* frames on the path.
-      Mostly useful when you enable the frame number display (see below), to avoid cluttering the 3D Viewport.
 
-Cache/Bone Cache
-   From, To
-      These are the start/end frames of the range in which motion paths are shown.
-      You cannot modify this range without deleting the motion path first.
-Calculate/Update Paths
+.. _bpy.types.AnimVizMotionPaths.frame_before:
+.. _bpy.types.AnimVizMotionPaths.frame_after:
+
+Frame Range Before, After
+      Number of frames to show before and after the current frame
+      (only for *Around Current Frame* Onion-skinning method).
+
+.. _bpy.types.AnimVizMotionPaths.frame_step:
+
+Step
+   Allows displaying one point for every *n* frames on the path.
+   Mostly useful when you enable the frame number display (see below), to avoid cluttering the 3D Viewport.
+
+.. _bpy.types.MotionPath.frame_start:
+.. _bpy.types.MotionPath.frame_end:
+
+Cache/Bone Cache From, To
+   These are the start/end frames of the range in which motion paths are shown.
+   You cannot modify this range without deleting the motion path first.
+
+.. _bpy.ops.pose.paths_calculate:
+.. _bpy.ops.object.paths_calculate:
+
+Calculate
    If no paths have been calculated, Calculate Paths will create a new motion path in cache based on
    the options specified in the pop-up menu or the :ref:`bpy.ops.screen.redo_last` panel.
-   If a path has already been calculated, Update Paths will update the path shape to the current animation.
-   To change the frame range of the calculated path, you need to delete the path and calculate it again.
 
    Start, End
       These are the start/end frames of the range in which motion paths are shown.
-      You have to *Calculate Paths* again if you modify this setting, to update the paths in the 3D Viewport.
-      The start frame is *inclusive*
-      (i.e. if you set *Start* to 1, you will really see the frame 1 as starting point of the paths...).
+      The start frame is *inclusive*, so if you set *Start* to 1,
+      you will really see the frame 1 as starting point of the paths...
+   
    Bake Location
-      Bones only -- By default, you get the tips' paths.
-      By changing this setting to Tails, you will get the paths of the bone's roots
-      (remember that in Blender UI, bones' roots are called "heads"...).
-      You have to *Calculate Paths* again if you modify this setting,
-      to update the paths in the 3D Viewport.
+      Which point on the bones is used when calculating paths.
+      Only available for bones while in Pose mode.
+
+      :Heads: Calculates the path position of the bone's heads.
+      :Tails: Calculates the path position of the bone's heads.
+
+.. _bpy.ops.pose.paths_update:
+.. _bpy.ops.object.paths_update:
+
+Update Paths
+   In the case a path has already been calculated, this operator will update the path shape to the current animation.
+   To change the frame range of the calculated path, you need to delete the path and calculate it again.
+
+.. _bpy.ops.pose.paths_clear:
+.. _bpy.ops.object.paths_clear:
+
 Clear Paths ``X``
    Clears paths on all objects/bones or just the selected ones when holding :kbd:`Shift`.
 
 
-Show
-----
+Display
+-------
 
+.. _bpy.types.AnimVizMotionPaths.show_frame_numbers:
+
 Frame Numbers
    When enabled, a small number appears next to each frame dot on the path,
    which is of course the number of the corresponding frame.
+
+.. _bpy.types.AnimVizMotionPaths.show_keyframe_highlight:
+
 Keyframes
    When enabled, big yellow square dots are displayed on motion paths, showing the keyframes of their bones
    (i.e. only the paths of keyed bones at a given frame get a yellow dot at this frame).
+
+.. _bpy.types.AnimVizMotionPaths.show_keyframe_action_all:
+
 \+ Non-Grouped Keyframes
    For bone motion paths, it searches the whole Action for keyframes instead of
    in groups with matching name only (this is slower).
+
+.. _bpy.types.AnimVizMotionPaths.show_keyframe_numbers:
+
 Keyframe Numbers
    When enabled, you will see the numbers of the displayed keyframes,
    so this option is obviously only valid when *Show Keys* is enabled.
+
+.. _bpy.types.MotionPath.lines:
+
 Lines
    Toggles whether the lines between the points are shown.
 
-   Thickness, Custom Color
-      Customizable thickness and color for the lines.
+.. _bpy.types.MotionPath.line_thickness:
 
+Thickness
+   Line thickness for motion path.
 
+.. _bpy.types.MotionPath.use_custom_color:
+.. _bpy.types.MotionPath.color:
+
+Custom Color
+   Use custom color for this motion path.
+
+
 Example
 =======
 

