FreeCAD Scripting Basics: Difference between revisions

From FreeCAD Documentation
No edit summary
 
Line 1: Line 1:
== Introduction ==
== Introduction ==

FreeCAD is built from scratch to be totally controlled by python scrips. Almost all parts of FreeCAD such as the interface, the scene contents, and even the representation of this content in the 3d views are accessible from the built-in python interpreter or from your own scripts. As a result, FreeCAD is probably one of the most deeply customizable engineering application availible today.

In its current state however, FreeCAD has very few "native" commands to interact on your 3D objects, mainly because it is still in early stage of development, but also because the philosophy behind it is more to provide a platform for CAD development than a user-tailored application. But the ease of python scripting inside FreeCAD will probably help much to see quickly new functionality being developed by "power users", or, typically, users who know a bit of python programming, like, we hope, yourself.

If you are not familiar with python, we recommend you to search for tutorials on the internet, and have a quick look at its structure. Python is a very easy language to learn, especially because it can be run inside an interpreter, where from simple commands to complete programs can be executed on the fly, without the need to compile anything. FreeCAD has a built-in python interpreter.

From the interpreter, you can access all your system-installed python modules, as well as the built-in FreeCAD modules, and all additional FreeCAD modules you installed later.

To be continued...


== Handling the Documents ==
== Handling the Documents ==

Revision as of 17:02, 18 March 2008

Introduction

FreeCAD is built from scratch to be totally controlled by python scrips. Almost all parts of FreeCAD such as the interface, the scene contents, and even the representation of this content in the 3d views are accessible from the built-in python interpreter or from your own scripts. As a result, FreeCAD is probably one of the most deeply customizable engineering application availible today.

In its current state however, FreeCAD has very few "native" commands to interact on your 3D objects, mainly because it is still in early stage of development, but also because the philosophy behind it is more to provide a platform for CAD development than a user-tailored application. But the ease of python scripting inside FreeCAD will probably help much to see quickly new functionality being developed by "power users", or, typically, users who know a bit of python programming, like, we hope, yourself.

If you are not familiar with python, we recommend you to search for tutorials on the internet, and have a quick look at its structure. Python is a very easy language to learn, especially because it can be run inside an interpreter, where from simple commands to complete programs can be executed on the fly, without the need to compile anything. FreeCAD has a built-in python interpreter.

From the interpreter, you can access all your system-installed python modules, as well as the built-in FreeCAD modules, and all additional FreeCAD modules you installed later.

To be continued...

Handling the Documents

The Document objects