Adding a new mouse navigation option to FreeCAD

From FreeCAD Documentation
Jump to navigation Jump to search
This tutorial is still a WIP. Feel free to help improve it
Freecad.svg Tutorial
Topic
Adding new navigation option to FreeCAD
Level
Advanced
Time to complete
Not provided
Authors
Kunda1
FreeCAD version
0.19.x and above
Example files
None

Introduction

This tutorial attempts to help developers understand how to add their own custom 'mouse' models to FreeCAD. There are currently several options within FreeCAD to customize navigation, they are listed in the Mouse navigation page. Some of the options include: Revit, OpenCascade, Inventor, Touchpad etc...

Prerequisite

  • Familiarity with cplusplus syntax
  • Ability to compile FreeCAD from source

Relevant source files

At the time of writing this documentation the relevant source code files required are located at:

  • src/Gui/NavigationStyle.(h,cpp)
  • src/Gui/(Foo)NavigationStyle.cpp Foo is a placeholder for the different mouse/navigation modes, for example: Revit, Inventor, OpenCascade, Touchpad, CAD etc...
  • src/Gui/CMakeLists.txt - Add your new mouse/navigation mode here so it's picked up by the compiler
  • src/Gui/SoFCDB.cpp

Historical code commits

We can refer to previous code commits that added different mouse modes for orientation. Here are a few:

Source code

Developer Documentation