Documentation: Shift and Ctrl keys for drawing boxes and box/ellipse rulers - #2452
Open
mejiasmario wants to merge 1 commit into
Open
mejiasmario wants to merge 1 commit into
mejiasmario wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Since 0.30.6, pressing Shift while drawing a box centers it on the first point and Ctrl confines it to a square. The same keys apply to "Box" and "Ellipse" rulers. The manual doesn't mention this yet: "Doing Measurements" still says that Shift/Ctrl constrain the direction for every ruler, and "Creating A Box" doesn't mention the keys. I ran into this myself in issue #2440.
This PR:
measure.xml: adds a paragraph on the "Box" and "Ellipse" rulers and their Shift/Ctrl behavior, and a pointer to it in the paragraph about direction constraints.create_box.xml: adds a paragraph on Ctrl (square) and Shift (centered).The wording follows the code in
antService.ccandedtBoxService.cc: both keys work independently and can be combined, and they apply only while drawing, not when moving a point of an existing ruler.Test Plan
ut_runner layHelpIndexTestpasses.