NA-MIC Project Weeks

Back to Projects List

SlicerMouseMaster - Advanced Mouse Customization for 3D Slicer

Key Investigators

• Ben Zwick (The University of Western Australia and Talk2View, Australia)
• Andy Huynh (Talk2View, Australia)

Project Description

SlicerMouseMaster is a 3D Slicer extension for advanced mouse customization, button remapping, and workflow optimization. It allows users to assign custom actions to extra mouse buttons (back, forward, thumb buttons), create workflow-specific presets, and use context-sensitive bindings that change based on the active Slicer module.

Objective

1. Submit to Extension Index
2. Add support for additional mouse models
3. Create workflow presets for common tasks
4. Improve cross-platform compatibility

Approach and Plan

1. Submit to Extension Index

• Complete submission requirements
• Test on all platforms (Linux, macOS, Windows)
• Create extension icon and screenshots

2. Add mouse model support

• Test with various mice from different manufacturers
• Improve button detection wizard
• Create community mouse profile database

3. Create workflow presets

• Segment Editor optimized preset
• Markups workflow preset
• Volume rendering preset

4. Cross-platform compatibility

• Test button codes across operating systems
• Document platform-specific differences
• Implement platform-specific fallbacks

Progress and Next Steps

1. Submitted extension to Slicer Extensions Index (PR #2308)
2. Created comprehensive documentation site with user guide, developer guide, and API reference
3. Implemented automated screenshot generation for documentation via CI
4. Added support for Logitech MX Master 3S and MX Master 4 mice
5. Created default presets for common workflows (Segment Editor, Markups, Volume Rendering)

Illustrations

MouseMaster module interface showing mouse selection, preset management, and button mappings

Background and References

• Source code: https://github.com/benzwick/SlicerMouseMaster
• Documentation: https://benzwick.github.io/SlicerMouseMaster
• Extensions Index PR: https://github.com/Slicer/ExtensionsIndex/pull/2308

Features

• Button Remapping: Assign custom actions to mouse buttons (back, forward, thumb, etc.)
• Mouse Profiles: Built-in support for popular mice with auto-detection
• Workflow Presets: Save and share button configurations for different tasks
• Context-Sensitive Bindings: Different mappings per Slicer module
• Cross-Platform: Works on Linux. Not tested on macOS or Windows.

Supported Mice

• Logitech MX Master 3S/4 (fully supported)
• Generic 3-button and 5-button mice (basic support)
• Custom profiles via button detection wizard