Power users hub/id



This is the place to come if you want to have a deeper insight into FreeCAD. Here you can learn about customizing FreeCAD for your needs.

These pages are in early stage of development. If you can't find the information you are looking for, or have found useful information somewhere we have not linked to, then please leave a comment on the talk page, or, why not? Add some more content here yourself!

One of the nicest features of FreeCAD is that you can script and extend it extremely far without the need to compile anything or touch the source code. All the scripting part is done in Python, a very powerful but simple programming language. With simple Python scripts, you have total access to about any part of FreeCAD. For example, you can:
 * Create and modify geometry: Is there a special object you need that's not present in the default FreeCAD installation? You can easily create a new object type, either from scratch or by adapting an existing type.
 * Create custom tools and commands: At the moment, FreeCAD already has extensive functionality, but there aren't many convenient tools and commands for the final user yet. But it is already easy to create your own sets of tools.
 * Modify the interface: The FreeCAD user interface is still very basic at this stage. But everything is there for you to extend it to your needs. You can, for example, create toolbars to put your own tools, create special panels for interacting with your tools, etc.
 * Modify the scene representation: FreeCAD has separate processes for building up and computing the geometry and displaying that geometry on your screen. You have full access to the way the scene contents are displayed on screen, therefore you can modify that representation, interact with it, or add all kinds of custom behaviours and screen widgets, like information, draggers, anchors or temporary entities.

Customizing FreeCAD

 * Interface Customization: Starting with the beginning: Toolbars and shortcuts
 * Working with Macros: Easily record often repeated tasks or Python code

General

 * Introduction to Python - See also other Python tutorials at the bottom of this page
 * FreeCAD scripting tutorial - A general look at python scripting in FreeCAD
 * FreeCAD Scripting Basics: Well, the basics...
 * Gui Command : Adding custom commands to the GUI
 * Using mixed Units in FreeCAD

Modules
As the functionality of FreeCAD is separated in Modules which deal with special data types and applications. FreeCAD has built-in modules and Extension Modules (plug-ins). Once plugin modules are installed, they become availible to you as easily as the built-in modules. The modules described below are the default modules, includeed in every FreeCAD installation.


 * The Builtin modules are the principal FreeCAD modules. They contain tools for manipulating general FreeCAD configurations, documents and their contents.

Working with Meshes

 * Mesh Scripting: How to interact with the Mesh Module

Working with Parts

 * The Part Module: How Open CASCADE Technology tools and structure is used in FreeCAD
 * Topological data scripting: How to interact with the Part Module
 * PythonOCC: How to unleash the whole Open CASCADE power
 * Mesh to Part: Converting between object types

Accessing the Coin scenegraph

 * The Coin/Inventor scenegraph: How the FreeCAD scene representation works
 * Pivy: How to access and modify the scenegraph

Controlling the Qt interface

 * PySide: How to access the interface, and modify its contents
 * Using the FreeCAD GUI in another Qt application with PyQt

Working with parametric objects

 * Scripted objects: How to make 100% Python-scripted objects in FreeCAD
 * Drawing Module: Automating the 3D-to-2D process

Examples

 * Code snippets : A collection of pieces of FreeCAD Python code, to serve as ingredients in your scripts...
 * Line drawing function: How to build a simple tool to draw lines
 * Dialog creation: How to construct dialogs with Qt designer, and use them in FreeCAD
 * Embedding FreeCAD: How to import FreeCAD as a Python module in other applications
 * The Draft Module adds basic 2d drawing functions to freecad. It is written entirely in Python, so it can be a good example if you want to write your own modules.
 * FreeCAD vector math library : A couple of handy functions to manipulate FreeCAD vectors. This library is also included in the Draft module.

API Functions
The complete API description can be found here. Note that it can be incomplete, since we still didn't find a way to include it automatically on this wiki. For more accurate information, browse the modules directly from FreeCAD.

Advanced modification

 * Start up and Configuration: Startup and command line options
 * Install on Windows: Using the windows installer
 * Compiling FreeCAD on Windows and Compiling FreeCAD on Unix
 * Branding: Simple modifications you can do to the source code to change some aspects of FreeCAD
 * Extra python modules : Extend the FreeCAD python interpreter with these powerful modules!

Python tutorials
These are good generic tutorials, not specific to FreeCAD, that might interest you if you are totally new to python.

Python
 * Official python tutorial - A very complete tutorial for discovering python
 * Non-programmer tutorial for python - an excellent wikibook
 * Python for newbies - one big tutorial covering all the basics

PyQt - How to create and manage FreeCAD's Qt UI interface from python
 * Basic PyQt tutorial : A simple and short linux-based tutorial that will explain how to work with PyQt and Qt Designer
 * First programs in PyQt4 : A platform-agnostic tutorial showing the interns of python + qt
 * programming Qt applications in python : A more in-depth tutorial covering all the process of working with qt and python.

Pivy - How to interact with FreeCAD's 3D scenes
 * Basic Pivy tutorial : A very simple tutorial form the official Pivy site
 * Introducing Pivy into studierstube : A document that is not really a tutorial, but that illustrates well how Pivy works

Community projects
On the Community portal, you can find other FreeCAD-based projects run by the FreeCAD users community. If you are starting a new FreeCAD project, be sure to list it there! We also have a page with things you can do if you would like to Help FreeCAD.