Scripting and macros

FreeCAD scripting basics

Licence

Index

Overview of Python scripting pages

• Python related pages in the Manual:
  • A gentle introduction
  • Creating and manipulating geometry
  • Creating parametric objects
  • Creating interface tools

• Basics:
  • Working with macros
  • Script tutorial
  • Introduction to Python
  • Python scripting tutorial
  • FreeCAD scripting basics

• Built-in workbench related:
  • Drawing scripting (the Drawing workbench is obsolete)
  • FEM scripting
  • Mesh scripting
  • Mesh: Converting between Meshes and Parts
  • Part scripting
  • Part: Basic shape manipulation
  • Part: Create a ball bearing part I
  • Part: Create a ball bearing part II
  • Path scripting
  • Raytracing scripting (the Raytracing workbench is obsolete)

• FeaturePython objects (also called 'scripted objects'):
  • Create a FeaturePython object part I
  • Create a FeaturePython object part II
  • Scripted objects
  • Scripted objects saving attributes
  • Scripted objects migration
  • Scripted objects with attachment
  • Viewprovider
  • Custom icon in tree view
  • Properties
  • Methods

• 3D view:
  • The Coin scenegraph
  • Pivy

• User interface:
  • PySide
  • PySide beginner examples
  • PySide intermediate examples
  • PySide advanced examples
  • PySide usage snippets
  • Interface creation
  • Interface creation with UI files
  • Dialog creation
  • Dialog creation with various widgets
  • Dialog creation reading and writing files
  • Dialog creation setting colors
  • Dialog creation image and animated GIF
  • Qt Example

• Snippets and examples:
  • Define a command
  • Workbench creation
  • Code snippets
  • Macros recipes
  • Line drawing function
  • Macro Half-Hull Model

• Miscellaneous:
  • Debugging
  • Embedding FreeCAD
  • Embedding FreeCADGui
  • Extra python modules
  • FreeCAD vector math library
  • How to install macros
  • IPython notebook integration
  • Macro at startup
  • Profiling
  • Python
  • PythonOCC
  • Python development environment
  • Quantity
  • Svg namespace

FreeCAD scripting basics

Licence

Index

Power user documentation

• FreeCAD scripting: Python, Introduction to Python, Python scripting tutorial, FreeCAD Scripting Basics

---

• Modules: Builtin modules, Units, Quantity
• Workbenches: Workbench creation, Gui Commands, Commands, Installing more workbenches
• Meshes and Parts: Mesh Scripting, Topological data scripting, Mesh to Part, PythonOCC

---

• Parametric objects: Scripted objects, Viewproviders (Custom icon in tree view)
• Scenegraph: Coin (Inventor) scenegraph, Pivy
• Graphical interface: Interface creation, Interface creation completely in Python (1, 2, 3, 4, 5), PySide, PySide examples beginner, intermediate, advanced
• Macros: Macros, How to install macros
• Embedding: Embedding FreeCAD, Embedding FreeCADGui

---

• Other: Expressions, Code snippets, Line drawing function, FreeCAD vector math library (deprecated)

---

• Hubs: User hub, Power users hub, Developer hub