blender/blender-manual
23
23
Fork 104
Code Issues 74 Pull Requests 6 Projects 1 Releases Wiki Activity

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
Conversation 1 Commits 3 Files Changed 4 +52 -46
Germano Cavalcante commented 2024-03-25 14:34:28 +01:00
Member
Copy Link

Updates:

  • Rename 'Snap With' to 'Snap Base'
  • Rename 'Snap To' to 'Snap Target'
  • Update Snap Menu Image
  • Add 'Snap to Grid' information
  • Remove 'Absolute Grid Snap'
  • Add 'Rotation Increment' Information (should be in 4.1 0)

Improvements:

  • Add a note to 'Set Snap Base' explaining what happens when only
    incremental snapping is enabled
Updates: - Rename 'Snap With' to 'Snap Base' - Rename 'Snap To' to 'Snap Target' - Update Snap Menu Image - Add 'Snap to Grid' information - Remove 'Absolute Grid Snap' - Add 'Rotation Increment' Information (should be in 4.1 [0]) Improvements: - Add a note to 'Set Snap Base' explaining what happens when only incremental snapping is enabled [0]: https://projects.blender.org/blender/blender/commit/060174cf14
Germano Cavalcante added the
Module
Modeling
 label 2024-03-25 14:34:28 +01:00
Germano Cavalcante added 1 commit 2024-03-25 14:34:30 +01:00 
The names 'Snap With' and 'Snap To' have been renamed to 'Snap Base'
and 'Snap Target'.

Documentation needs to reflect this.

The image has been updated.

And documentation has also been added for the "Rotation Increment"
(Ref [1]).

[0]: https://projects.blender.org/blender/blender/commit/f66cb1e635
[1]: https://projects.blender.org/blender/blender/commit/060174cf14
Germano Cavalcante requested review from Aaron Carlisle 2024-03-25 14:34:41 +01:00
Germano Cavalcante added 1 commit 2024-03-28 14:21:51 +01:00
Germano Cavalcante changed title from Update snap menu documentation to Update and improve snapping documentation 2024-03-28 14:22:41 +01:00
Matthew Hinson requested changes 2024-04-06 21:09:06 +02:00
manual/editors/3dview/controls/snapping.rst Outdated
@ -97,4 +96,1 @@
grid cell size.
If you want to snap to the viewport grid instead, you can enable *Absolute Grid Snap*
(see below).
Matthew Hinson commented 2024-04-06 20:45:26 +02:00
Member
Copy Link

Should also remove the "By default" at the start of the note, since that implies there are other possibilities for the Increment snap target - which is no longer the case.

Should also remove the "By default" at the start of the note, since that implies there are other possibilities for the `Increment` snap target - which is no longer the case.
mano-wii marked this conversation as resolved
manual/editors/3dview/controls/snapping.rst
@ -227,1 +220,4 @@
but you can also enable it for rotating and scaling.
Rotation Increment
======
Matthew Hinson commented 2024-04-06 20:38:32 +02:00
Member
Copy Link

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)
mano-wii marked this conversation as resolved
manual/editors/3dview/controls/snapping.rst Outdated
@ -228,0 +224,4 @@
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.
Matthew Hinson commented 2024-04-06 20:39:51 +02:00
Member
Copy Link

Keyboard shortcuts should be formatted like :kbd:`Shift`.
(Same for the UV editor)

Keyboard shortcuts should be formatted like :kbd:\`Shift\`. (Same for the UV editor)
Matthew-Hinson marked this conversation as resolved
manual/modeling/transform/modal_map.rst
@ -50,0 +51,4 @@
.. 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.
Matthew Hinson commented 2024-04-06 21:08:20 +02:00
Member
Copy Link

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.
mano-wii marked this conversation as resolved
Germano Cavalcante added 1 commit 2024-04-07 15:55:46 +02:00
Germano Cavalcante commented 2024-04-07 15:58:12 +02:00
Author
Member
Copy Link

Fixed documentation.
The changes were:

  • Remove note about Incremental Snap's "Default" behavior
  • Add description based on the removed Note for the Incremental Snap
  • Style and Formatting Fixes (number of =, :kbd:)
  • Improve/Fix 'Set Snap Base' documentation
Fixed documentation. The changes were: - Remove note about Incremental Snap's "Default" behavior - Add description based on the removed Note for the Incremental Snap - Style and Formatting Fixes (number of `=`, :kbd:) - Improve/Fix 'Set Snap Base' documentation
Aaron Carlisle approved these changes 2024-04-12 04:17:28 +02:00
Matthew Hinson merged commit 1c6741801f into main 2024-04-21 20:04:49 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Matthew Hinson
Aaron Carlisle
Labels
Clear labels   
Meta
Good First Issue

  
Module
Animation & Rigging

  
Module
Core

  
Module
Development Management

  
Module
Eevee & Viewport

  
Module
Grease Pencil

  
Module
Modeling

  
Module
Nodes & Physics

  
Module
Pipeline, Assets & IO

  
Module
Platforms, Builds, Tests & Devices

  
Module
Python API

  
Module
Rendering & Cycles

  
Module
Sculpt, Paint & Texture

  
Module
User Interface

  
Module
VFX & Video

  
Priority
High

  
Priority
Low

  
Priority
Normal

  
Status
Archived

  
Status
Confirmed

  
Status
Duplicate

  
Status
Needs Information from Developers

  
Status
Needs Information from User

  
Status
Needs Triage

  
Status
Resolved

  
Type
Bug

  
Type
Design

  
Type
Known Issue

  
Type
Patch

  
Type
Report

  
Type
To Do

No Label
Meta
Good First Issue
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
Eevee & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds, Tests & Devices
Module
Python API
Module
Rendering & Cycles
Module
Sculpt, Paint & Texture
Module
User Interface
Module
VFX & Video
Priority
High
Priority
Low
Priority
Normal
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Information from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender-manual#104750
No description provided.
Delete Branch "mano-wii/blender-manual:transform_documentation"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?