Scripts

Work in progress -- need some revision

Introduction
With Scripting we mean create topological objects using FreeCAD's Python interpreter. FreeCAD could be used a "very good" replacement of OpenSCAD, manìinly beacause it has a real Python interpreter, that means that it has a real programming language on board, almost everything you could do with the GUI, is doable with a Python Script.

Sadly information about scripting in the documentation, and even in this wiki are scattered around and lacks of "writing" uniformity and most of them are explained in a too technical manner.

Wetting you appetite
The first obstacle in an easy way to scripting is that there is no direct way to access the FreeCAD internal Python editor through a menu item or a icon on the toolbar area, but knowing that FreeCAD opens a file with a extension in the internal Python editor, the most simple trick is create in your favourite text editor and then open it with the usual command.

To make the things in a polite way, the fila has to be written with some order, FreeCAD Python editor have a good "Syntax HIghlighting" that lacks in many simple editors like Windows Notepad or some basic Linux editors, so it is sufficient to write these few lines:

Save them with a meaningfull name with extension and load the resulting file in FreeCAD, with the said File - Open command.

A minimal example of what is necessary to have in a script is shown in this portion of code that you could be use as a template for almost any future script:

Some tricks are incorporated in the above code:


 * This line import FreeCAD in the FreeCAD Python interpreter, it may seem a redundant thing, but it isn't
 * Base and Vector are widely used in FreeCAD scipting, import them in this manner will save you to invoke them with or  instead of    or, this will save many keystrokes and make codelines much smaller.

Let's start with a small script that does a very small job, but display the power of this approach.

Put these lines after the "template" code and press the green arrow in the Macro toolbar

You will see some magic things, a new document is open named "Pippo" (Italian name of Goofy) and you will see in the 3d view a cube, like the one in the image below.



Something more...
Not too amazing? Yes, but we have to start somewhere, we can do the same thing with a Cylinder, add these lines of code after the method and before the line.

Even here nothing too exciting. But please note some peculiarities:


 * The absence of the usual reference to the, present in many Documentation code snippets, is deliberate, this code could be used even invoking FreeCAD as a module in an external Python, the thing is not easily doable with an AppImage, but with some care it could be done. Plus in the standard Python motto that "better explicit than implicit"  is explaining in a very "poor" way where the things are from.
 * note the use of the "constant" name assigned to the active Document in = ; active Document is not a "constant" in a strict sense, but in a "semantical"  way is our "active Document", that for our use is a proper "constant" so the Python convention to use the  "ALL CAPS" name for "constants", not to mention that  is much shorten than.
 * every method returns a geometry, this became clear in the continuation of the page.
 * geometry didn't have the property, when using the simple geometries to make more complex geometry, managing  is a ankward thing.

Now what to do with this geometries?

Let's introduce boolean operations. As a starter example put these lines after, this create a method for a Fusion also know as Union operation:

Nothing exceptional also here, note however the uniformity in method coding; This approach is more linear that those seen around other tutorial on scripting, this "linearity" help greatly in readability and also with cut-copy-paste operations.

Let's use the geometries, delete lines below the code section starting with, and insert the following lines:

Launch the script with the green arrow and we will see in the 3D view something like:



Placement
Placement Concept is relatively complex, see Aeroplane Tutorial for a more deep explanation.

We usually are in need of placing geometries respect each other, when building complex object this is a recurring task, the most common way is to use the geometry property.

FreeCAD offer a wide choice of ways to set this property, one is more tailored to another depending the knowledge and the background of the user, but the more plain writing is explained in the cited Tutorial, it use a peculiar definition of the portion of, quite easy to learn.

But over other consideration, one thing is crucial, geometry reference point, in other word the point from which the object is modeled by FreeCAD, as described in this table, copied from Placement:

This information has to be keep in mind especially when we have to apply a rotation.

Some examples may help, delete all the line after method and insert the portion of code below:

Let's explain something in the code:


 * We have used a method to define a spehere, using the most easy definition, using only the radius.
 * We have introduced a second writing for the 'Union or Fusion, using multiple objects, not more distant from the usual Part::Fuse it uses Part:Multifuse and use only one property, we have passed a tuple as arguments, but it accepts also a list.
 * We have defined a complex object aeroplano (italian word for aeroplane), but we have done it in a "parametric" way, defining some parameters and deriving other parameters, through some calculation, based on the main parameters.
 * We have used some Placement poperties around in the method and before returning the final geometries we have used a  property with the Yaw-Pitch-Roll, writing. Note the last, that define a center of rotation of the whole geometry.

It can be easily noted that aeroplano geometry rotate around his "barycenter" or "center of gravity", that I've fixed at wing center, a place that is relatively "natural", but could be placed wherever you want.

The first  is the Translation vector, not used here, but if you substitute  with these lines to the code

You will se in the Report window this text:

What has happened?

FreeCAD has translated the in other word our  definition that specifies three components, Translation, Rotation and center of rotation in the "internal" values of only two components, Translation and Rotation'.

you can easily visualize the value of using a print statement in the  method and see that it is:

in other word the rotation center of the geometry is at, but this rotation center is not shown in the GUI, it could be entered as a value, it could not be easily retrieved.

This is the meaning of the word "ankward" that I've used to define property.