Update and improve snapping documentation #104750

Merged
Matthew Hinson merged 3 commits from mano-wii/blender-manual:transform_documentation into main 2024-04-21 20:04:49 +02:00
4 changed files with 31 additions and 27 deletions
Showing only changes of commit dd87c8931d - Show all commits

View File

@ -74,13 +74,13 @@ Closest
.. _bpy.types.ToolSettings.snap_elements_base: .. _bpy.types.ToolSettings.snap_elements_base:
Snap To Snap Target
======= ===========
.. reference:: .. reference::
:Mode: Object, Edit, and Pose Mode :Mode: Object, Edit, and Pose Mode
:Header: :menuselection:`Snapping --> Snap To` :Header: :menuselection:`Snapping --> Snap Target`
:Shortcut: :kbd:`Shift-Ctrl-Tab` :Shortcut: :kbd:`Shift-Ctrl-Tab`
Determines the target which the selection will be snapped to. Determines the target which the selection will be snapped to.
@ -94,9 +94,8 @@ Increment
but an imaginary grid with the same resolution that starts at the selection's but an imaginary grid with the same resolution that starts at the selection's
original location. In other words, it lets you move the selection in "increments" of the original location. In other words, it lets you move the selection in "increments" of the
grid cell size. grid cell size.
Grid
If you want to snap to the viewport grid instead, you can enable *Absolute Grid Snap* Snaps to the grid that's displayed in the viewport.
(see below).
Vertex Vertex
Snaps to the vertex that's closest to the mouse cursor. Snaps to the vertex that's closest to the mouse cursor.
Edge Edge
@ -122,13 +121,13 @@ Edge Perpendicular
.. _bpy.types.ToolSettings.snap_elements_individual: .. _bpy.types.ToolSettings.snap_elements_individual:
Snap Individual Elements To Snap Target for Individual Elements
=========================== ===================================
.. reference:: .. reference::
:Mode: Object, Edit, and Pose Mode :Mode: Object, Edit, and Pose Mode
:Header: :menuselection:`Snapping --> Snap Individual Elements To` :Header: :menuselection:`Snapping --> Snap Target for Individual Elements`
:Shortcut: :kbd:`Shift-Ctrl-Tab` :Shortcut: :kbd:`Shift-Ctrl-Tab`
Type of element for individual transformed elements to snap to. Type of element for individual transformed elements to snap to.
@ -152,7 +151,7 @@ Target Selection
================ ================
Sets more detailed snapping options. The available options depend on the mode Sets more detailed snapping options. The available options depend on the mode
(Object/Edit) as well as the Snap To selection. (Object/Edit) as well as the :ref:`Snap Target <bpy.types.ToolSettings.snap_elements_base>`.
.. _bpy.types.ToolSettings.use_snap_self: .. _bpy.types.ToolSettings.use_snap_self:
@ -178,11 +177,6 @@ Include Non-Edited :guilabel:`Edit Mode`
Exclude Non-Selectable Exclude Non-Selectable
Snap only to objects that are selectable. Snap only to objects that are selectable.
.. _bpy.types.ToolSettings.use_snap_grid_absolute:
Absolute Grid Snap :guilabel:`Increment`
Snaps to the grid, instead of snapping in increments relative to the current location.
.. _bpy.types.ToolSettings.use_snap_align_rotation: .. _bpy.types.ToolSettings.use_snap_align_rotation:
Align Rotation to Target Align Rotation to Target

View File

@ -12,8 +12,8 @@ see :ref:`UV Editing <bpy.ops.uv.snap_selected>`.
.. _bpy.types.ToolSettings.snap_uv_element: .. _bpy.types.ToolSettings.snap_uv_element:
Snap To Snap Target
======= ===========
.. reference:: .. reference::
@ -30,8 +30,8 @@ Increment
original location. In other words, it lets you move the selection in "increments" of the original location. In other words, it lets you move the selection in "increments" of the
grid cell size. grid cell size.
If you want to snap to the viewport grid instead, you can enable *Absolute Grid Snap* Grid
(see below). Snaps to grid points.
Vertex Vertex
Snaps to the vertex that's closest to the mouse cursor. Snaps to the vertex that's closest to the mouse cursor.
@ -40,12 +40,7 @@ Vertex
Additional Options Additional Options
================== ==================
.. _bpy.types.ToolSettings.use_snap_uv_grid_absolute: Snap Base :guilabel:`Vertex`
Absolute Grid Snap :guilabel:`Increment`
Snaps to the grid, instead of snapping in increments relative to the current location.
Target :guilabel:`Vertex`
See :ref:`3D Viewport Snapping <bpy.types.ToolSettings.snap_target>` for more information. See :ref:`3D Viewport Snapping <bpy.types.ToolSettings.snap_target>` for more information.
@ -55,3 +50,11 @@ Affect
Specifies which transformations are affected by snapping. Specifies which transformations are affected by snapping.
By default, snapping only happens while moving something, By default, snapping only happens while moving something,
but you can also enable it for rotating and scaling. but you can also enable it for rotating and scaling.
Rotation Increment
======
Angle used in incremental snapping for the rotation operator.
The second value is the `Rotation Precision Increment`, used for finer transformations
and activated by default with the `Shift` key.

Binary file not shown.

View File

@ -44,9 +44,16 @@ Set Snap Base
Snap Base is taken automatically depending on the :ref:`Snap Base <bpy.types.ToolSettings.snap_target>` options. Snap Base is taken automatically depending on the :ref:`Snap Base <bpy.types.ToolSettings.snap_target>` options.
However, this automatic snap detection point of origin is not always what the user desires. However, this automatic snap detection point of origin is not always what the user desires.
Therefore, transform operations have a utility to set a new snap origin point during the transformation. Therefore, transform operations have a utility to set a new snap origin point during the transformation.
By default the hotkey is :kbd:`B`. By default the hotkey is :kbd:`B`.
.. note::
If only Snap to Increment is enabled as :ref:`Snap Target <bpy.types.ToolSettings.snap_elements_base>`,
the targets `Vert`, `Edge`, `Face`, `Edge Center`, `Edge Perpendicular` will be used instead.
mano-wii marked this conversation as resolved
Review

Could add some explanation about how this Set Snap Base command actually works, because right now, it's rather minimal and the note kind of comes out of nowhere. (The section is about setting the Snap Base, so why is there suddenly a note about the Snap Target?)

The first snap target which the note refers to is called "Vertex" in the UI, not "Vert." Also, are you sure that Edge Perpendicular is used? I tried it but couldn't confirm.

Could add some explanation about how this Set Snap Base command actually works, because right now, it's rather minimal and the note kind of comes out of nowhere. (The section is about setting the Snap Base, so why is there suddenly a note about the Snap Target?) The first snap target which the note refers to is called "Vertex" in the UI, not "Vert." Also, are you sure that Edge Perpendicular is used? I tried it but couldn't confirm.
Add Snap Point Add Snap Point
-------------- --------------