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 52 additions and 46 deletions

View File

@ -33,17 +33,16 @@ or more temporarily by holding :kbd:`Ctrl`.
.. _bpy.types.ToolSettings.snap_target:
Snap With
Snap Base
=========
.. reference::
:Mode: Object, Edit, and Pose Mode
:Header: :menuselection:`Snapping --> Snap with`
:Header: :menuselection:`Snapping --> Snap Base`
:Shortcut: :kbd:`Shift-Ctrl-Tab`
Determines what part of the selection will coincide with the target.
(The rest of the selection will follow along.)
Determines which point in the geometry is the snap base that will snap to the target.
Active
Snaps using the origin (in Object Mode) or center (in Edit Mode) of the active element.
@ -75,13 +74,13 @@ Closest
.. _bpy.types.ToolSettings.snap_elements_base:
Snap To
=======
Snap Target
===========
.. reference::
:Mode: Object, Edit, and Pose Mode
:Header: :menuselection:`Snapping --> Snap To`
:Header: :menuselection:`Snapping --> Snap Target`
:Shortcut: :kbd:`Shift-Ctrl-Tab`
Determines the target which the selection will be snapped to.
@ -89,15 +88,11 @@ Determines the target which the selection will be snapped to.
Increment
Snaps to grid points. When in Orthographic view, the snapping increment changes depending on the zoom level.
.. note::
By default, this option won't snap to the grid that's displayed in the viewport,
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
grid cell size.
If you want to snap to the viewport grid instead, you can enable *Absolute Grid Snap*
(see below).
This option snaps to an imaginary grid that starts at the selection's original location and has the same
resolution as the viewport grid. In other words, it lets you move the selection in "increments" of the
grid cell size.
Grid
Snaps to the grid that's displayed in the viewport.
Vertex
Snaps to the vertex that's closest to the mouse cursor.
Edge
@ -123,13 +118,13 @@ Edge Perpendicular
.. _bpy.types.ToolSettings.snap_elements_individual:
Snap Individual Elements To
===========================
Snap Target for Individual Elements
===================================
.. reference::
: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`
Type of element for individual transformed elements to snap to.
@ -153,7 +148,7 @@ Target Selection
================
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:
@ -179,11 +174,6 @@ Include Non-Edited :guilabel:`Edit Mode`
Exclude Non-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:
Align Rotation to Target
@ -225,3 +215,10 @@ Affect
Specifies which transformations are affected by snapping.
By default, snapping only happens while moving something,
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
mano-wii marked this conversation as resolved
Review

Please make sure the number of = signs matches the length of the title (same for the UV editor)

Please make sure the number of `=` signs matches the length of the title (same for the UV editor)
and activated by default with the :kbd:`Shift` key.

View File

@ -12,8 +12,8 @@ see :ref:`UV Editing <bpy.ops.uv.snap_selected>`.
.. _bpy.types.ToolSettings.snap_uv_element:
Snap To
=======
Snap Target
===========
.. reference::
@ -23,15 +23,12 @@ Snap To
Increment
Snaps to grid points.
.. note::
This option snaps to an imaginary grid that starts at the selection's original location and has the same
resolution as the grid displayed in the editor. In other words, it lets you move the selection in
"increments" of the grid cell size.
By default, this option won't snap to the grid that's displayed in the editor,
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
grid cell size.
If you want to snap to the viewport grid instead, you can enable *Absolute Grid Snap*
(see below).
Grid
Snaps to grid points.
Vertex
Snaps to the vertex that's closest to the mouse cursor.
@ -40,12 +37,7 @@ Vertex
Additional Options
==================
.. _bpy.types.ToolSettings.use_snap_uv_grid_absolute:
Absolute Grid Snap :guilabel:`Increment`
Snaps to the grid, instead of snapping in increments relative to the current location.
Target :guilabel:`Vertex`
Snap Base :guilabel:`Vertex`
See :ref:`3D Viewport Snapping <bpy.types.ToolSettings.snap_target>` for more information.
@ -55,3 +47,11 @@ Affect
Specifies which transformations are affected by snapping.
By default, snapping only happens while moving something,
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 :kbd:`Shift` key.

Binary file not shown.

View File

@ -41,12 +41,21 @@ The default hotkey in this case is :kbd:`Ctrl`.
Set Snap Base
-------------
Snap Base is taken automatically depending on the :ref:`Snap With <bpy.types.ToolSettings.snap_target>` options.
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.
The Snap Base is automatically determined based on the :ref:`Snap Base <bpy.types.ToolSettings.snap_target>` options.
However, this automatic snap detection point of origin may not always align with the user's intentions.
Therefore, transform operations include a utility to set a new snap origin point during the transformation.
The new Snap Base will correspond to the snap point whose target is defined by the
:ref:`Snap Target <bpy.types.ToolSettings.snap_elements_base>`.
By default the hotkey is :kbd:`B`.
.. note::
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.
If only Snap to Increment is enabled as :ref:`Snap Target <bpy.types.ToolSettings.snap_elements_base>`,
the targets `Vertex`, `Edge`, `Face` and `Edge Center` will be used instead.
Add Snap Point
--------------