Difference between revisions of "Modules:EventBindings-3.4"
From Slicer Wiki
| Line 26: | Line 26: | ||
* consistent set of mouse-mode switches in 2D, 3D windows | * consistent set of mouse-mode switches in 2D, 3D windows | ||
* use the right menu button to bring up a context-dependent menu (e.g. actions appropriate for the item under the cursor). | * use the right menu button to bring up a context-dependent menu (e.g. actions appropriate for the item under the cursor). | ||
| + | |||
| + | = Application Hot-keys (keyboard accelerators) = | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- border="1" | ||
| + | ! align="left" |Key(s) | ||
| + | ! align="left" |Action bound to key(s) | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''Ctrl+O''' | ||
| + | | align="left" |Load a new scene (clears existing scene) | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''Ctrl+A''' | ||
| + | | align="left" |Import a scene (does not clear existing scene) | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''Ctrl+W''' | ||
| + | | align="left" | Close a scene | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''Ctrl+H ''' | ||
| + | | align="left" | Set the current module to be the "home" module -- the module that's exposed when Slicer starts up. | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''Ctrl+Z ''' | ||
| + | | align="left" | Undo the last undoable action | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''Ctrl+Y ''' | ||
| + | | align="left" | Redo the last redoable action | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''Space-key ''' | ||
| + | | align="left" | Toggles the display of Slicer's Edit Box. | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''Ctrl+P ''' | ||
| + | | align="left" | Display the Python console | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''Ctrl+L ''' | ||
| + | | align="left" | Create a new fiducial list. | ||
| + | |} | ||
| + | |||
| + | == Slice Viewer Hot-keys (keyboard accelerators) == | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- border="1" | ||
| + | ! align="left" |Key(s) | ||
| + | ! align="left" |Action bound to key(s) | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''` (back-tick key)''' | ||
| + | | align="left" |Navigate to next fiducial in the active Slice Viewer, or in all viewers if they are linked | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''Ctrl+` (back-tick key)''' | ||
| + | | align="left" |Navigate to next fiducial in all Slice Viewers, independent of their linked state | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''Shift+` (back-tick key)''' | ||
| + | | align="left" | Navigate to the previous fiducial in the active Slice Viewer, or in all viewers if they are linked | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''Ctrl+Shift+` (back-tick key)''' | ||
| + | | align="left" | Navigate to the previous fiducial in all Slice Viewers, independent of their linked state | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''p-key''' | ||
| + | | align="left" | Place a new fiducial in the active Slice Viewer(adds to the current fiducial list, or creates a list if there are none) | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''o-key''' | ||
| + | | align="left" | Turn on the Slice Plane reformat widget in the active Slice Viewer | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''v-key''' | ||
| + | | align="left" | Toggles the slice plane visibility in the main 3D Viewer | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''r-key''' | ||
| + | | align="left" | Fits the slice view to the volume extents in the active Slice Viewer, or in all viewers if they are linked (the first non-none volume will be used in order of Background, Foreground and Label layers) | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''b-key''' | ||
| + | | align="left" | Decrement slice in the active Slice Viewer (left or down) by one unit of background pixel spacing | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''f-key''' | ||
| + | | align="left" | Increment slice in the active Slice Viewer (right or up) by one unit of backgroun dpixel spacing | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''Backspace-key''' | ||
| + | | align="left" | When the mouse is hovering over a fiducial in the Slice Viewer (turning it yellow), delete that fiducial | ||
| + | |- | ||
| + | | style="width:200px" | <font color="blue"> '''Delete-key''' | ||
| + | | align="left" | When the mouse is hovering over a fiducial in the Slice Viewer (turning it yellow), delete that fiducial | ||
| + | |} | ||
| + | |||
== Global "hot-keys" == | == Global "hot-keys" == | ||
| Line 227: | Line 307: | ||
| None | | None | ||
|} | |} | ||
| − | |||
== Module-specific hot-keys == | == Module-specific hot-keys == | ||
Revision as of 20:43, 5 May 2009
Home < Modules:EventBindings-3.4Return to Slicer Documentation
Keyboard accelerators
Note: this page is currently being updated. Material below is appropriate for Slicer3.2
A list of global "hot-keys" and module-specific "hot-keys" for Slicer2 and Slicer3 is being actively compiled below. (This page is a little out of sync with development -- please make current!) With respect to the specification of keyboard accelerators, please follow these three recommendations;
- Before assigning "hot-keys" to functionality, either in the main Slicer application or in a new module, please consult the list below to make sure the key is not already mapped.
- Across Slicer modules, try to use similar "hot-key" assignments for similar functionality, and try to observe existing paradigms outlined below; this consistency makes Slicer easier for users to learn.
- Once you assign "hot-keys" in your module, please add those mappings to the list below for others to reference.
Design paradigms
- use CTRL-modified keys as global, and non-modified keys for module-specific accelerators.
- use ALT modifiers to access menu items
- SHIFT modifiers should apply to all instances of the same type as the current window
Design ideas
- using CTRL-1, CTRL-2 CTRL-3 to navigate to most commonly used modules in the base (for instance, Data, Volumes, Editor?).
- having hotkeys to toggle between axial, saggital, and coronal views in a slice window.
- having a hotkey to toggle any window the mouse is inside between full screen and current size.
- consistent set of mouse actions in 2D, 3D and control windows
- consistent set of mouse-mode switches in 2D, 3D windows
- use the right menu button to bring up a context-dependent menu (e.g. actions appropriate for the item under the cursor).
Application Hot-keys (keyboard accelerators)
| Key(s) | Action bound to key(s) |
|---|---|
| Ctrl+O | Load a new scene (clears existing scene) |
| Ctrl+A | Import a scene (does not clear existing scene) |
| Ctrl+W | Close a scene |
| Ctrl+H | Set the current module to be the "home" module -- the module that's exposed when Slicer starts up. |
| Ctrl+Z | Undo the last undoable action |
| Ctrl+Y | Redo the last redoable action |
| Space-key | Toggles the display of Slicer's Edit Box. |
| Ctrl+P | Display the Python console |
| Ctrl+L | Create a new fiducial list. |
Slice Viewer Hot-keys (keyboard accelerators)
| Key(s) | Action bound to key(s) |
|---|---|
| ` (back-tick key) | Navigate to next fiducial in the active Slice Viewer, or in all viewers if they are linked |
| Ctrl+` (back-tick key) | Navigate to next fiducial in all Slice Viewers, independent of their linked state |
| Shift+` (back-tick key) | Navigate to the previous fiducial in the active Slice Viewer, or in all viewers if they are linked |
| Ctrl+Shift+` (back-tick key) | Navigate to the previous fiducial in all Slice Viewers, independent of their linked state |
| p-key | Place a new fiducial in the active Slice Viewer(adds to the current fiducial list, or creates a list if there are none) |
| o-key | Turn on the Slice Plane reformat widget in the active Slice Viewer |
| v-key | Toggles the slice plane visibility in the main 3D Viewer |
| r-key | Fits the slice view to the volume extents in the active Slice Viewer, or in all viewers if they are linked (the first non-none volume will be used in order of Background, Foreground and Label layers) |
| b-key | Decrement slice in the active Slice Viewer (left or down) by one unit of background pixel spacing |
| f-key | Increment slice in the active Slice Viewer (right or up) by one unit of backgroun dpixel spacing |
| Backspace-key | When the mouse is hovering over a fiducial in the Slice Viewer (turning it yellow), delete that fiducial |
| Delete-key | When the mouse is hovering over a fiducial in the Slice Viewer (turning it yellow), delete that fiducial |
Global "hot-keys"
Window Behavior
| Action | Slicer3 Key | Meaning | Slicer3 Key |
| Toggle Maximize current window | Control-m | Make the current Slice or 3D View expand to full view space or return to previous size depending on current state | None |
| Toggle Control Pane View | F5 (KWW default) | Show or hide the Control Pane depending on state | None |
MRML
| Action | Slicer3 Key | Meaning | Slicer3 Key |
| Open Scene... | Control-O | Bring up file browser to locate .mrml file | None |
| Save Scene | Control-S | Save current scene no browser, disabled if no current file. If no current scene, does Save As... | None |
| Save Scene As... | None | Bring up file browser to locate .mrml file | None |
| Undo | Control-Z | Revert to last undo point | None |
| Redo | Control-Y | Revert to last redo point | None |
| Other Menu Items | Alt-<letter> | Bring up or invoke menu or menu item corresponding to letter | Same |
Slice Manipulation
| Action | Slicer3 Key | Meaning | Slicer3 Key |
| Next slice | Right Arrow and Up Arrow | Axial: move Superior, Sag: Right, Cor: Anterior | Right Arrow |
| Previous slice | Left Arrow and Down Arrow | Axial: move Inferior, Sag: Left, Cor: Posterior | Left Arrow |
| Linked Motion | Shift Key | Cause other slice windows to scroll to RAS point at current cursor location | Same |
| Toggle Slice Visible | v | Make the current slice window show as a plane in the 3D view | None |
| Toggle All Slices Visible | V | Make all slices show in 3D View | None |
| Toggle Foreground/Background Opacity | T | Change opacity of foreground overlay | None |
| Toggle Label Overlay | g | Show/Hide Label for this slice | None |
| Toggle Label Overlay | G | Show/Hide Label for all slices | None |
| Cycle Orientations | Tab | Cycle through Axial/Sagittal/Coronal | None |
| Cycle All Orientations | Shift-Tab | Cycle through Axial/Sagittal/Coronal in all slice windows | None |
| Fit to volume | f | Set the field of view to match the full extent of the foreground and background volumes | None |
| Fit to volumes all | Shift-F | Set the field of view in all slices to match the full extent of the foreground and background volumes | None |
3D Manipulation
| Action | Slicer3 Key | Meaning | Slicer3 Key |
| Wireframe | w | change render mode to wireframe | Same |
| Shaded | s | change render mode to shaded | Same |
| Reset View | r | Set camera to see all objects | None |
| Toggle Rock Mode | TBD | Toggle rock mode | None |
| Toggle Spin Mode | TBD | Toggle spin mode | None |
| Action | Slicer3 Key | Meaning | Slicer3 Key |
| Application Menu | Space Bar | Brings up a popup menu with all the application operations and their key binding information | None |
| Module Navigation | Control-<number> | Jumps to the numbered module (number order is the same as the order of the shortcut icons in the toolbar at the top of the application. | None |
| Move through module history | Control-PageUp/PageDown | Short cuts for the two arrow buttons next to the module popup menu | None |
| Search for Module | Control-F | Starts an incremental search through the module names and descriptions, terminated by Enter to jump to the module. Probably needs a dialog box. | None |
Module-specific hot-keys
Fiducials
| Action | Slicer3 Key | Meaning | Slicer3 Key |
| Add Fiducial | Control-p | Adds fiducial at current pointer position | Same |
| Delete Fiducial | Control-d | Deletes the fiducial picked from current mouse position (ignored if no fiducial is under mouse) | Same |
| Select Fiducial | Control-q | Selects/Deselects the fiducial under the mouse | q |
Editor
| Action | Slicer3 Key | Meaning | Slicer3 Key |
Mouse Actions
Button Use Constraints
- Alt-Left mouse button should always be available as a substitute for the middle mouse button to support two button mice. On Mac, you can also use the command key with a mouse click to get middle mouse events.
- Contrl-Left mouse button should always be available as a substitute for the right mouse button to support one button mice (on Mac).
Toolbar
The current mouse mode will always be visible in a toolbar in the slicer display. There will also be hot keys to select specify mouse modes. Instead of (or in addition to) a toolbar we may want to use a WWidget in the overlay planes to reflect the mouse mode.
