Difference between revisions of "Code snippets"

From FreeCAD Documentation
Jump to: navigation, search
(replace "</syntaxhighlight>" to "{{Code|code= ")
(Use four spaces for indentation in the Python example)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
<languages/>
 
<languages/>
 
<translate>
 
<translate>
<!--T:1-->
+
<!--T:55-->
In this page we will show how to build a simple Qt Dialog with [http://qt-project.org/doc/qt-4.8/designer-manual.html Qt Designer], Qt's official tool for designing interfaces, then convert it to python code, then use it inside FreeCAD. I'll assume in the example that you know how to edit and run python scripts already, and that you can do simple things in a terminal window such as navigate, etc. You must also have, of course, pyqt installed.
+
{{docnav|[[Embedding FreeCAD|Embedding FreeCAD]]|[[Line drawing function|Line drawing function]]}}
  
== Designing the dialog == <!--T:2-->
+
<!--T:69-->
In CAD applications, designing a good UI (User Interface) is very important. About everything the user will do will be through some piece of interface: reading dialog boxes, pressing buttons, choosing between icons, etc. So it is very important to think carefully to what you want to do, how you want the user to behave, and how will be the workflow of your action.
+
{{TutorialInfo
 +
|Topic= Python
 +
|Level= Beginner
 +
|Time=
 +
|Author=
 +
|FCVersion=
 +
|Files=
 +
}}
  
<!--T:3-->
+
<!--T:1-->
There are a couple of concepts to know when designing interface:
+
This page contains examples, pieces, chunks of FreeCAD python code collected from users experiences and discussions on the forums. Read and use it as a start for your own scripts...
* [http://en.wikipedia.org/wiki/Modal_window Modal/non-modal dialogs]: A modal dialog appears in front of your screen, stopping the action of the main window, forcing the user to respond to the dialog, while a non-modal dialog doesn't stop you from working on the main window. In some case the first is better, in other cases not.
 
* Identifying what is required and what is optional: Make sure the user knows what he must do. Label everything with proper description, use tooltips, etc.
 
* Separating commands from parameters: This is usually done with buttons and text input fields. The user knows that clicking a button will produce an action while changing a value inside a text field will change a parameter somewhere. Nowadays, though, users usually know well what is a button, what is an input field, etc. The interface toolkit we are using, Qt, is a state-of-the-art toolkit, and we won't have to worry much about making things clear, since they will already be very clear by themselves.
 
 
 
<!--T:4-->
 
So, now that we have well defined what we will do, it's time to open the qt designer. Let's design a very simple dialog, like this:
 
 
 
<!--T:5-->
 
[[Image:Qttestdialog.jpg]]
 
 
 
<!--T:6-->
 
We will then use this dialog in FreeCAD to produce a nice rectangular plane. You might find it not very useful to produce nice rectangular planes, but it will be easy to change it later to do more complex things. When you open it, Qt Designer looks like this:
 
 
 
<!--T:7-->
 
[[Image:Qtdesigner-screenshot.jpg]]
 
  
<!--T:8-->
+
=== A typical InitGui.py file === <!--T:2-->
It is very simple to use. On the left bar you have elements that can be dragged on your widget. On the right side you have properties panels displaying all kinds of editable properties of selected elements. So, begin with creating a new widget. Select "Dialog without buttons", since we don't want the default Ok/Cancel buttons. Then, drag on your widget '''3 labels''', one for the title, one for writing "Height" and one for writing "Width". Labels are simple texts that appear on your widget, just to inform the user. If you select a label, on the right side will appear several properties that you can change if you want, such as font style, height, etc.
+
Every module must contain, besides your main module file, an InitGui.py file, responsible for inserting the module in the main Gui. This is an example of a simple one.  
 
 
<!--T:9-->
 
Then, add '''2 LineEdits''', which are text fields that the user can fill in, one for the height and one for the width. Here too, we can edit properties. For example, why not set a default value? For example 1.00 for each. This way, when the user will see the dialog, both values will be filled already and if he is satisfied he can directly press the button, saving precious time. Then, add a '''PushButton''', which is the button the user will need to press after he filled the 2 fields.
 
 
 
<!--T:10-->
 
Note that I chose very simple controls here, but Qt has many more options, for example you could use Spinboxes instead of LineEdits, etc... Have a look at what is available, you will surely have other ideas.
 
 
 
<!--T:11-->
 
That's about all we need to do in Qt Designer. One last thing, though, let's rename all our elements with easier names, so it will be easier to identify them in our scripts:
 
 
 
<!--T:12-->
 
[[Image:Qtpropeditor.jpg]]
 
 
</translate>
 
</translate>
 +
{{Code|code=
 +
class ScriptWorkbench (Workbench):
 +
    MenuText = "Scripts"
 +
    def Initialize(self):
 +
        import Scripts # assuming Scripts.py is your module
 +
        list = ["Script_Cmd"] # That list must contain command names, that can be defined in Scripts.py
 +
        self.appendToolbar("My Scripts",list)
 +
       
 +
Gui.addWorkbench(ScriptWorkbench())
 +
}}
 
<translate>
 
<translate>
  
== Converting our dialog to python == <!--T:13-->
+
=== A typical module file === <!--T:3-->
 +
This is an example of a main module file, containing everything your module does. It is the Scripts.py file invoked by the previous example. You can have all your custom commands here.
 
</translate>
 
</translate>
 +
{{Code|code=
 +
import FreeCAD, FreeCADGui
 +
 +
class ScriptCmd:
 +
  def Activated(self):
 +
      # Here your write what your ScriptCmd does...
 +
      FreeCAD.Console.PrintMessage('Hello, World!')
 +
  def GetResources(self):
 +
      return {'Pixmap' : 'path_to_an_icon/myicon.png', 'MenuText': 'Short text', 'ToolTip': 'More detailed text'}
 +
     
 +
FreeCADGui.addCommand('Script_Cmd', ScriptCmd())
 +
}}
 
<translate>
 
<translate>
<!--T:14-->
+
 
Now, let's save our widget somewhere. It will be saved as an .ui file, that we will easily convert to python script with pyuic. On windows, the pyuic program is bundled with pyqt (to be verified), on linux you probably will need to install it separately from your package manager (on debian-based systems, it is part of the pyqt4-dev-tools package). To do the conversion, you'll need to open a terminal window (or a command prompt window on windows), navigate to where you saved your .ui file, and issue:
+
=== Import a new filetype === <!--T:4-->
 +
Making an importer for a new filetype in FreeCAD is easy. FreeCAD doesn't consider that you import data in an opened document, but rather that you simply can directly open the new filetype. So what you need to do is to add the new file extension to FreeCAD's list of known extensions, and write the code that will read the file and create the FreeCAD objects you want:
 +
 
 +
<!--T:5-->
 +
This line must be added to the InitGui.py file to add the new file extension to the list:
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
pyuic mywidget.ui > mywidget.py
+
# Assumes Import_Ext.py is the file that has the code for opening and reading .ext files
 +
FreeCAD.addImportType("Your new File Type (*.ext)","Import_Ext")
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:56-->
+
<!--T:6-->
In Windows pyuic.py is located in "C:\Python27\Lib\site-packages\PyQt4\uic\pyuic.py"
+
Then in the Import_Ext.py file:
For conversion create a batch file called "compQt4.bat:
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
@"C:\Python27\python" "C:\Python27\Lib\site-packages\PyQt4\uic\pyuic.py" -x %1.ui > %1.py
+
def open(filename):  
 +
  doc=App.newDocument()
 +
  # here you do all what is needed with filename, read, classify data, create corresponding FreeCAD objects
 +
  doc.recompute()
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:57-->
+
<!--T:7-->
In the DOS console type without extension
+
To export your document to some new filetype works the same way, except that you use:
 +
FreeCAD.addExportType("Your new File Type (*.ext)","Export_Ext")
 +
 
 +
=== Adding a line === <!--T:8-->
 +
A line simply has 2 points.
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
compQt4 myUiFile
+
 
 +
import Part,PartGui
 +
doc=App.activeDocument()
 +
# add a line element to the document and set its points
 +
l=Part.LineSegment()
 +
l.StartPoint=(0.0,0.0,0.0)
 +
l.EndPoint=(1.0,1.0,1.0)
 +
doc.addObject("Part::Feature","Line").Shape=l.toShape()
 +
doc.recompute()
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:58-->
+
 
Into Linux : to do
+
=== Adding a polygon === <!--T:9-->
 +
A polygon is simply a set of connected line segments (a polyline in AutoCAD). It doesn't need to be closed.
 
</translate>
 
</translate>
 
+
{{Code|code=
<!--T:55-->
+
import Part,PartGui
 +
doc=App.activeDocument()
 +
n=list()
 +
# create a 3D vector, set its coordinates and add it to the list
 +
v=App.Vector(0,0,0)
 +
n.append(v)
 +
v=App.Vector(10,0,0)
 +
n.append(v)
 +
#... repeat for all nodes
 +
# Create a polygon object and set its nodes
 +
p=doc.addObject("Part::Polygon","Polygon")
 +
p.Nodes=n
 +
doc.recompute()
 +
}}
 
<translate>
 
<translate>
<!--T:59-->
 
Since FreeCAD progressively moved away from PyQt after version 0.13, in favour of [http://qt-project.org/wiki/PySide PySide] (Choose your PySide install [http://pyside.readthedocs.org/en/latest/building/ building PySide]), to make the file based on PySide now you have to use:
 
  
 +
=== Adding and removing an object to a group === <!--T:10-->
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
pyside-uic mywidget.ui -o mywidget.py
+
doc=App.activeDocument()
 +
grp=doc.addObject("App::DocumentObjectGroup", "Group")
 +
lin=doc.addObject("Part::Feature", "Line")
 +
grp.addObject(lin) # adds the lin object to the group grp
 +
grp.removeObject(lin) # removes the lin object from the group grp
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:60-->
+
<!--T:11-->
In Windows uic.py are located in "C:\Python27\Lib\site-packages\PySide\scripts\uic.py"
+
Note: You can even add other groups to a group...
For create batch file "compSide.bat":
+
 
 +
=== Adding a Mesh === <!--T:12-->
 +
</translate>
 
{{Code|code=
 
{{Code|code=
@"C:\Python27\python" "C:\Python27\Lib\site-packages\PySide\scripts\uic.py" %1.ui > %1.py
+
import Mesh
 +
doc=App.activeDocument()
 +
# create a new empty mesh
 +
m = Mesh.Mesh()
 +
# build up box out of 12 facets
 +
m.addFacet(0.0,0.0,0.0, 0.0,0.0,1.0, 0.0,1.0,1.0)
 +
m.addFacet(0.0,0.0,0.0, 0.0,1.0,1.0, 0.0,1.0,0.0)
 +
m.addFacet(0.0,0.0,0.0, 1.0,0.0,0.0, 1.0,0.0,1.0)
 +
m.addFacet(0.0,0.0,0.0, 1.0,0.0,1.0, 0.0,0.0,1.0)
 +
m.addFacet(0.0,0.0,0.0, 0.0,1.0,0.0, 1.0,1.0,0.0)
 +
m.addFacet(0.0,0.0,0.0, 1.0,1.0,0.0, 1.0,0.0,0.0)
 +
m.addFacet(0.0,1.0,0.0, 0.0,1.0,1.0, 1.0,1.0,1.0)
 +
m.addFacet(0.0,1.0,0.0, 1.0,1.0,1.0, 1.0,1.0,0.0)
 +
m.addFacet(0.0,1.0,1.0, 0.0,0.0,1.0, 1.0,0.0,1.0)
 +
m.addFacet(0.0,1.0,1.0, 1.0,0.0,1.0, 1.0,1.0,1.0)
 +
m.addFacet(1.0,1.0,0.0, 1.0,1.0,1.0, 1.0,0.0,1.0)
 +
m.addFacet(1.0,1.0,0.0, 1.0,0.0,1.0, 1.0,0.0,0.0)
 +
# scale to a edge langth of 100
 +
m.scale(100.0)
 +
# add the mesh to the active document
 +
me=doc.addObject("Mesh::Feature","Cube")
 +
me.Mesh=m
 
}}
 
}}
In the DOS console type without extension
+
<translate>
 +
 
 +
=== Adding an arc or a circle === <!--T:13-->
 +
</translate>
 
{{Code|code=
 
{{Code|code=
compSide myUiFile
+
import Part
 +
doc = App.activeDocument()
 +
c = Part.Circle()
 +
c.Radius=10.0 
 +
f = doc.addObject("Part::Feature", "Circle") # create a document with a circle feature
 +
f.Shape = c.toShape() # Assign the circle shape to the shape property
 +
doc.recompute()
 
}}
 
}}
Into Linux : to do
+
<translate>
 
 
  
<!--T:15-->
+
=== Accessing and changing representation of an object === <!--T:14-->
On some systems the program is called pyuic4 instead of pyuic. This will simply convert the .ui file into a python script. If we open the mywidget.py file, its contents is very easy to understand:
+
Each object in a FreeCAD document has an associated view representation object that stores all the parameters that define how the object appear, like color, linewidth, etc...
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
from PySide import QtCore, QtGui
+
gad=Gui.activeDocument()   # access the active document containing all
 
+
                          # view representations of the features in the
class Ui_Dialog(object):
+
                          # corresponding App document
    def setupUi(self, Dialog):
 
        Dialog.setObjectName("Dialog")
 
        Dialog.resize(187, 178)
 
        self.title = QtGui.QLabel(Dialog)
 
        self.title.setGeometry(QtCore.QRect(10, 10, 271, 16))
 
        self.title.setObjectName("title")
 
        self.label_width = QtGui.QLabel(Dialog)
 
        ...
 
 
 
        self.retranslateUi(Dialog)
 
        QtCore.QMetaObject.connectSlotsByName(Dialog)
 
  
  def retranslateUi(self, Dialog):
+
v=gad.getObject("Cube")   # access the view representation to the Mesh feature 'Cube'
        Dialog.setWindowTitle(QtGui.QApplication.translate("Dialog", "Dialog", None, QtGui.QApplication.UnicodeUTF8))
+
v.ShapeColor              # prints the color to the console
        self.title.setText(QtGui.QApplication.translate("Dialog", "Plane-O-Matic", None, QtGui.QApplication.UnicodeUTF8))
+
v.ShapeColor=(1.0,1.0,1.0) # sets the shape color to white
        ...
 
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:16-->
 
As you see it has a very simple structure: a class named Ui_Dialog is created, that stores the interface elements of our widget. That class has two methods, one for setting up the widget, and one for translating its contents, which is part of the general Qt mechanism for translating interface elements. The setup method simply creates, one by one, the widgets as we defined them in Qt Designer, and sets their options as we decided earlier. Then, the whole interface gets translated, and finally, the slots get connected (we'll talk about that later).
 
  
<!--T:17-->
+
=== Observing mouse events in the 3D viewer via Python === <!--T:15-->
We can now create a new widget and use this class to create its interface. We can already see our widget in action, by putting our mywidget.py file in a place where FreeCAD will find it (in the FreeCAD bin directory, or in any of the Mod subdirectories), and, in the FreeCAD python interpreter, issue:
+
The Inventor framework allows to add one or more callback nodes to the scenegraph of the viewer. By default in FreeCAD one callback node is installed per viewer which allows to add global or static C++ functions. In the appropriate Python binding some methods are provided to make use of this technique from within Python code.
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
from PySide import QtGui
+
App.newDocument()
import mywidget
+
v=Gui.activeDocument().activeView()
d = QtGui.QWidget()
+
d.ui = mywidget.Ui_Dialog()
+
#This class logs any mouse button events. As the registered callback function fires twice for 'down' and
d.ui.setupUi(d)
+
#'up' events we need a boolean flag to handle this.
d.show()
+
class ViewObserver:
 +
  def logPosition(self, info):
 +
      down = (info["State"] == "DOWN")
 +
      pos = info["Position"]
 +
      if (down):
 +
          FreeCAD.Console.PrintMessage("Clicked on position: ("+str(pos[0])+", "+str(pos[1])+")\n")
 +
     
 +
o = ViewObserver()
 +
c = v.addEventCallback("SoMouseButtonEvent",o.logPosition)
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:18-->
+
<!--T:16-->
And our dialog will appear! Note that our Python interpreter is still working, we have a non-modal dialog. So, to close it, we can (apart from clicking its close icon, of course) issue:
+
Now, pick somewhere on the area in the 3D viewer and observe the messages in the output window. To finish the observation just call
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
d.hide()
+
v.removeEventCallback("SoMouseButtonEvent",c)
 
}}
 
}}
 
<translate>
 
<translate>
 +
<!--T:17-->
 +
The following event types are supported
 +
* SoEvent -- all kind of events
 +
* SoButtonEvent -- all mouse button and key events
 +
* SoLocation2Event -- 2D movement events (normally mouse movements)
 +
* SoMotion3Event -- 3D movement events (normally spaceball)
 +
* SoKeyboardEvent -- key down and up events
 +
* SoMouseButtonEvent -- mouse button down and up events
 +
* SoSpaceballButtonEvent -- spaceball button down and up events
  
== Making our dialog do something == <!--T:19-->
+
<!--T:18-->
Now that we can show and hide our dialog, we just need to add one last part: To make it do something! If you play a bit with Qt designer, you'll quickly discover a whole section called "signals and slots". Basically, it works like this: elements on your widgets (in Qt terminology, those elements are themselves widgets) can send signals. Those signals differ according to the widget type. For example, a button can send a signal when it is pressed and when it is released. Those signals can be connected to slots, which can be special functionality of other widgets (for example a dialog has a "close" slot to which you can connect the signal from a close button), or can be custom functions. The [http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/classes.html PyQt Reference Documentation] lists all the qt widgets, what they can do, what signals they can send, etc...
+
The Python function that can be registered with addEventCallback() expects a dictionary. Depending on the watched event the dictionary can contain different keys.  
 +
 +
For all events it has the keys:
 +
* Type -- the name of the event type i.e. SoMouseEvent, SoLocation2Event, ...
 +
* Time -- the current time as string
 +
* Position -- a tuple of two integers, mouse position
 +
* ShiftDown -- a boolean, true if Shift was pressed otherwise false
 +
* CtrlDown -- a boolean, true if Ctrl was pressed otherwise false
 +
* AltDown -- a boolean, true if Alt was pressed otherwise false
 +
 +
For all button events, i.e. keyboard, mouse or spaceball events
 +
* State -- A string 'UP' if the button was up, 'DOWN' if it was down or 'UNKNOWN' for all other cases
 +
 +
For keyboard events:
 +
* Key -- a character of the pressed key
 +
 +
For mouse button event
 +
* Button -- The pressed button, could be BUTTON1, ..., BUTTON5 or ANY
 +
 +
For spaceball events:
 +
* Button -- The pressed button, could be BUTTON1, ..., BUTTON7 or ANY
 +
 +
And finally motion events:
 +
* Translation -- a tuple of three floats
 +
* Rotation -- a quaternion for the rotation, i.e. a tuple of four floats
  
<!--T:20-->
+
===Display keys pressed and Events command=== <!--T:50-->
What we will do here, is to create a new function that will create a plane based on height and width, and to connect that function to the pressed signal emitted by our "Create!" button. So, let's begin with importing our FreeCAD modules, by putting the following line at the top of the script, where we already import QtCore and QtGui:
+
This macro displays in the report view the keys pressed and all events command
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
import FreeCAD, Part
+
App.newDocument()
 +
v=Gui.activeDocument().activeView()
 +
class ViewObserver:
 +
  def logPosition(self, info):
 +
      try:
 +
          down = (info["Key"])
 +
          FreeCAD.Console.PrintMessage(str(down)+"\n") # here the character pressed
 +
          FreeCAD.Console.PrintMessage(str(info)+"\n") # list all events command
 +
          FreeCAD.Console.PrintMessage("_______________________________________"+"\n")
 +
      except Exception:
 +
          None
 +
 +
o = ViewObserver()
 +
c = v.addEventCallback("SoEvent",o.logPosition)
 +
 
 +
#v.removeEventCallback("SoEvent",c) # remove ViewObserver
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:21-->
+
=== Manipulate the scenegraph in Python === <!--T:19-->
Then, let's add a new function to our Ui_Dialog class:
+
It is also possible to get and change the scenegraph in Python, with the 'pivy' module -- a Python binding for Coin.
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
def createPlane(self):
+
from pivy.coin import *                # load the pivy module
    try:
+
view = Gui.ActiveDocument.ActiveView  # get the active viewer
        # first we check if valid numbers have been entered
+
root = view.getSceneGraph()           # the root is an SoSeparator node
        w = float(self.width.text())
+
root.addChild(SoCube())
        h = float(self.height.text())
+
view.fitAll()
    except ValueError:
 
        print "Error! Width and Height values must be valid numbers!"
 
    else:
 
        # create a face from 4 points
 
        p1 = FreeCAD.Vector(0,0,0)
 
        p2 = FreeCAD.Vector(w,0,0)
 
        p3 = FreeCAD.Vector(w,h,0)
 
        p4 = FreeCAD.Vector(0,h,0)
 
        pointslist = [p1,p2,p3,p4,p1]
 
        mywire = Part.makePolygon(pointslist)
 
        myface = Part.Face(mywire)
 
        Part.show(myface)
 
        self.hide()
 
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:22-->
+
<!--T:20-->
Then, we need to inform Qt to connect the button to the function, by placing the following line just before QtCore.QMetaObject.connectSlotsByName(Dialog):
+
The Python API of pivy is created by using the tool SWIG. As we use in FreeCAD some self-written nodes you cannot create them directly in Python.
 +
However, it is possible to create a node by its internal name. An instance of the type 'SoFCSelection' can be created with
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
QtCore.QObject.connect(self.create,QtCore.SIGNAL("pressed()"),self.createPlane)
+
type = SoType.fromName("SoFCSelection")
 +
node = type.createInstance()
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:23-->
+
 
This, as you see, connects the pressed() signal of our create object (the "Create!" button), to a slot named createPlane, which we just defined. That's it! Now, as a final touch, we can add a little function to create the dialog, it will be easier to call. Outside the Ui_Dialog class, let's add this code:
+
=== Adding and removing objects to/from the scenegraph === <!--T:21-->
 +
Adding new nodes to the scenegraph can be done this way. Take care of always adding a SoSeparator to contain the geometry, coordinates and material info of a same object. The following example adds a red line from (0,0,0) to (10,0,0):
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
class plane():
+
from pivy import coin
  def __init__(self):
+
sg = Gui.ActiveDocument.ActiveView.getSceneGraph()
      self.d = QtGui.QWidget()
+
co = coin.SoCoordinate3()
      self.ui = Ui_Dialog()
+
pts = [[0,0,0],[10,0,0]]
      self.ui.setupUi(self.d)
+
co.point.setValues(0,len(pts),pts)
      self.d.show()
+
ma = coin.SoBaseColor()
 +
ma.rgb = (1,0,0)
 +
li = coin.SoLineSet()
 +
li.numVertices.setValue(2)
 +
no = coin.SoSeparator()
 +
no.addChild(co)
 +
no.addChild(ma)
 +
no.addChild(li)
 +
sg.addChild(no)
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:24-->
+
<!--T:22-->
(Python reminder: the __init__ method of a class is automatically executed whenever a new object is created!)
+
To remove it, simply issue:
Then, from FreeCAD, we only need to do:
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
import mywidget
+
sg.removeChild(no)
myDialog = mywidget.plane()
 
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:25-->
+
===Saves the sceneGraph with a rotation in a series of 36 files in the X Y Z axis=== <!--T:60-->
That's all Folks... Now you can try all kinds of things, like for example inserting your widget in the FreeCAD interface (see the [[Code snippets]] page), or making much more advanced custom tools, by using other elements on your widget.
 
 
 
== The complete script == <!--T:26-->
 
This is the complete script, for reference:
 
 
</translate>
 
</translate>
{{Code|code=
 
# -*- coding: utf-8 -*-
 
 
# Form implementation generated from reading ui file 'mywidget.ui'
 
#
 
# Created: Mon Jun  1 19:09:10 2009
 
#      by: PyQt4 UI code generator 4.4.4
 
# Modified for PySide 16:02:2015
 
# WARNING! All changes made in this file will be lost!
 
 
from PySide import QtCore, QtGui
 
import FreeCAD, Part
 
 
class Ui_Dialog(object):
 
  def setupUi(self, Dialog):
 
      Dialog.setObjectName("Dialog")
 
      Dialog.resize(187, 178)
 
      self.title = QtGui.QLabel(Dialog)
 
      self.title.setGeometry(QtCore.QRect(10, 10, 271, 16))
 
      self.title.setObjectName("title")
 
      self.label_width = QtGui.QLabel(Dialog)
 
      self.label_width.setGeometry(QtCore.QRect(10, 50, 57, 16))
 
      self.label_width.setObjectName("label_width")
 
      self.label_height = QtGui.QLabel(Dialog)
 
      self.label_height.setGeometry(QtCore.QRect(10, 90, 57, 16))
 
      self.label_height.setObjectName("label_height")
 
      self.width = QtGui.QLineEdit(Dialog)
 
      self.width.setGeometry(QtCore.QRect(60, 40, 111, 26))
 
      self.width.setObjectName("width")
 
      self.height = QtGui.QLineEdit(Dialog)
 
      self.height.setGeometry(QtCore.QRect(60, 80, 111, 26))
 
      self.height.setObjectName("height")
 
      self.create = QtGui.QPushButton(Dialog)
 
      self.create.setGeometry(QtCore.QRect(50, 140, 83, 26))
 
      self.create.setObjectName("create")
 
 
      self.retranslateUi(Dialog)
 
      QtCore.QObject.connect(self.create,QtCore.SIGNAL("pressed()"),self.createPlane)
 
      QtCore.QMetaObject.connectSlotsByName(Dialog)
 
 
  def retranslateUi(self, Dialog):
 
      Dialog.setWindowTitle(QtGui.QApplication.translate("Dialog", "Dialog", None, QtGui.QApplication.UnicodeUTF8))
 
      self.title.setText(QtGui.QApplication.translate("Dialog", "Plane-O-Matic", None, QtGui.QApplication.UnicodeUTF8))
 
      self.label_width.setText(QtGui.QApplication.translate("Dialog", "Width", None, QtGui.QApplication.UnicodeUTF8))
 
      self.label_height.setText(QtGui.QApplication.translate("Dialog", "Height", None, QtGui.QApplication.UnicodeUTF8))
 
      self.create.setText(QtGui.QApplication.translate("Dialog", "Create!", None, QtGui.QApplication.UnicodeUTF8))
 
  
  def createPlane(self):
 
      try:
 
          # first we check if valid numbers have been entered
 
          w = float(self.width.text())
 
          h = float(self.height.text())
 
      except ValueError:
 
          print "Error! Width and Height values must be valid numbers!"
 
      else:
 
          # create a face from 4 points
 
          p1 = FreeCAD.Vector(0,0,0)
 
          p2 = FreeCAD.Vector(w,0,0)
 
          p3 = FreeCAD.Vector(w,h,0)
 
          p4 = FreeCAD.Vector(0,h,0)
 
          pointslist = [p1,p2,p3,p4,p1]
 
          mywire = Part.makePolygon(pointslist)
 
          myface = Part.Face(mywire)
 
          Part.show(myface)
 
 
class plane():
 
  def __init__(self):
 
      self.d = QtGui.QWidget()
 
      self.ui = Ui_Dialog()
 
      self.ui.setupUi(self.d)
 
      self.d.show()
 
}}
 
<translate>
 
==Creation of a dialog with buttons== <!--T:27-->
 
 
===Method 1=== <!--T:28-->
 
An example of a dialog box complete with its connections.
 
</translate>
 
 
{{Code|code=
 
{{Code|code=
# -*- coding: utf-8 -*-
+
import math
# Create by flachyjoe
+
import time
 +
from FreeCAD import Base
 +
from pivy import coin
  
from PySide import QtCore, QtGui
+
size=(1000,1000)
 +
dirname = "C:/Temp/animation/"
 +
steps=36
 +
angle=2*math.pi/steps
  
try:
+
matX=Base.Matrix()
    _fromUtf8 = QtCore.QString.fromUtf8
+
matX.rotateX(angle)
except AttributeError:
+
stepsX=Base.Placement(matX).Rotation
    def _fromUtf8(s):
 
        return s
 
  
try:
+
matY=Base.Matrix()
    _encoding = QtGui.QApplication.UnicodeUTF8
+
matY.rotateY(angle)
    def _translate(context, text, disambig):
+
stepsY=Base.Placement(matY).Rotation
        return QtGui.QApplication.translate(context, text, disambig, _encoding)
 
except AttributeError:
 
    def _translate(context, text, disambig):
 
        return QtGui.QApplication.translate(context, text, disambig)
 
  
 +
matZ=Base.Matrix()
 +
matZ.rotateZ(angle)
 +
stepsZ=Base.Placement(matZ).Rotation
  
class Ui_MainWindow(object):
+
view=Gui.ActiveDocument.ActiveView
 +
cam=view.getCameraNode()
 +
rotCamera=Base.Rotation(*cam.orientation.getValue().getValue())
  
    def __init__(self, MainWindow):
+
# this sets the lookat point to the center of circumsphere of the global bounding box
        self.window = MainWindow
+
view.fitAll()
  
        MainWindow.setObjectName(_fromUtf8("MainWindow"))
+
# the camera's position, i.e. the user's eye point
        MainWindow.resize(400, 300)
+
position=Base.Vector(*cam.position.getValue().getValue())
        self.centralWidget = QtGui.QWidget(MainWindow)
+
distance=cam.focalDistance.getValue()
        self.centralWidget.setObjectName(_fromUtf8("centralWidget"))
 
  
        self.pushButton = QtGui.QPushButton(self.centralWidget)
+
# view direction
        self.pushButton.setGeometry(QtCore.QRect(30, 170, 93, 28))
+
vec=rotCamera.multVec(Base.Vector(0,0,-1))
        self.pushButton.setObjectName(_fromUtf8("pushButton"))
 
        self.pushButton.clicked.connect(self.on_pushButton_clicked) #connection pushButton
 
  
        self.lineEdit = QtGui.QLineEdit(self.centralWidget)
+
# this is the point on the screen the camera looks at
        self.lineEdit.setGeometry(QtCore.QRect(30, 40, 211, 22))
+
# when rotating the camera we should make this point fix
        self.lineEdit.setObjectName(_fromUtf8("lineEdit"))
+
lookat=position+vec*distance
        self.lineEdit.returnPressed.connect(self.on_lineEdit_clicked) #connection lineEdit
 
  
        self.checkBox = QtGui.QCheckBox(self.centralWidget)
+
# around x axis
        self.checkBox.setGeometry(QtCore.QRect(30, 90, 81, 20))
+
for i in range(steps):
        self.checkBox.setChecked(True)
+
    rotCamera=stepsX.multiply(rotCamera)
        self.checkBox.setObjectName(_fromUtf8("checkBoxON"))
+
    cam.orientation.setValue(*rotCamera.Q)
        self.checkBox.clicked.connect(self.on_checkBox_clicked) #connection checkBox
+
    vec=rotCamera.multVec(Base.Vector(0,0,-1))
 +
    pos=lookat-vec*distance
 +
    cam.position.setValue(pos.x,pos.y,pos.z)
 +
    Gui.updateGui()
 +
    time.sleep(0.3)
 +
    view.saveImage(dirname+"x-%d.png" % i,*size)
  
        self.radioButton = QtGui.QRadioButton(self.centralWidget)
+
# around y axis
        self.radioButton.setGeometry(QtCore.QRect(30, 130, 95, 20))
+
for i in range(steps):
        self.radioButton.setObjectName(_fromUtf8("radioButton"))
+
    rotCamera=stepsY.multiply(rotCamera)
        self.radioButton.clicked.connect(self.on_radioButton_clicked) #connection radioButton
+
    cam.orientation.setValue(*rotCamera.Q)
 +
    vec=rotCamera.multVec(Base.Vector(0,0,-1))
 +
    pos=lookat-vec*distance
 +
    cam.position.setValue(pos.x,pos.y,pos.z)
 +
    Gui.updateGui()
 +
    time.sleep(0.3)
 +
    view.saveImage(dirname+"y-%d.png" % i,*size)
  
        MainWindow.setCentralWidget(self.centralWidget)
+
# around z axis
 +
for i in range(steps):
 +
    rotCamera=stepsZ.multiply(rotCamera)
 +
    cam.orientation.setValue(*rotCamera.Q)
 +
    vec=rotCamera.multVec(Base.Vector(0,0,-1))
 +
    pos=lookat-vec*distance
 +
    cam.position.setValue(pos.x,pos.y,pos.z)
 +
    Gui.updateGui()
 +
    time.sleep(0.3)
 +
    view.saveImage(dirname+"z-%d.png" % i,*size)
 +
}}
 +
<translate>
  
        self.menuBar = QtGui.QMenuBar(MainWindow)
+
===Adding custom widgets to the interface=== <!--T:23-->
        self.menuBar.setGeometry(QtCore.QRect(0, 0, 400, 26))
+
You can create custom widgets with Qt designer, transform them into a python script, and then load them into the FreeCAD interface with PySide.
        self.menuBar.setObjectName(_fromUtf8("menuBar"))
 
        MainWindow.setMenuBar(self.menuBar)
 
  
        self.mainToolBar = QtGui.QToolBar(MainWindow)
+
<!--T:24-->
         self.mainToolBar.setObjectName(_fromUtf8("mainToolBar"))
+
The python code produced by the Ui python compiler (the tool that converts qt-designer .ui files into python code) generally looks like this (it is simple, you can also code it directly in python):
         MainWindow.addToolBar(QtCore.Qt.TopToolBarArea, self.mainToolBar)
+
</translate>
 +
{{Code|code=
 +
class myWidget_Ui(object):
 +
    def setupUi(self, myWidget):
 +
        myWidget.setObjectName("my Nice New Widget")
 +
         myWidget.resize(QtCore.QSize(QtCore.QRect(0,0,300,100).size()).expandedTo(myWidget.minimumSizeHint())) # sets size of the widget
 +
 +
         self.label = QtGui.QLabel(myWidget) # creates a label
 +
        self.label.setGeometry(QtCore.QRect(50,50,200,24)) # sets its size
 +
        self.label.setObjectName("label") # sets its name, so it can be found by name
  
         self.statusBar = QtGui.QStatusBar(MainWindow)
+
    def retranslateUi(self, draftToolbar): # built-in QT function that manages translations of widgets
         self.statusBar.setObjectName(_fromUtf8("statusBar"))
+
         myWidget.setWindowTitle(QtGui.QApplication.translate("myWidget", "My Widget", None, QtGui.QApplication.UnicodeUTF8))
        MainWindow.setStatusBar(self.statusBar)
+
         self.label.setText(QtGui.QApplication.translate("myWidget", "Welcome to my new widget!", None, QtGui.QApplication.UnicodeUTF8))
 +
}}
 +
<translate>
 +
<!--T:25-->
 +
Then, all you need to do is to create a reference to the FreeCAD Qt window, insert a custom widget into it, and "transform" this widget into yours with the Ui code we just made:
 +
</translate>
 +
{{Code|code=
 +
app = QtGui.qApp
 +
FCmw = app.activeWindow() # the active qt window, = the freecad window since we are inside it
 +
# FCmw = FreeCADGui.getMainWindow() # use this line if the 'addDockWidget' error is declared
 +
myNewFreeCADWidget = QtGui.QDockWidget() # create a new dckwidget
 +
myNewFreeCADWidget.ui = myWidget_Ui() # load the Ui script
 +
myNewFreeCADWidget.ui.setupUi(myNewFreeCADWidget) # setup the ui
 +
FCmw.addDockWidget(QtCore.Qt.RightDockWidgetArea,myNewFreeCADWidget) # add the widget to the main window
 +
}}
 +
<translate>
  
        self.retranslateUi(MainWindow)
+
===Adding a Tab to the Combo View=== <!--T:26-->
 +
The following code allows you to add a tab to the FreeCAD ComboView, besides the "Project" and "Tasks" tabs. It also uses the uic module to load an ui file directly in that tab.
 +
</translate>
 +
{{Code|code=
 +
# create new Tab in ComboView
 +
from PySide import QtGui,QtCore
 +
#from PySide import uic
  
    def retranslateUi(self, MainWindow):
+
def getMainWindow():
        MainWindow.setWindowTitle(_translate("MainWindow", "MainWindow", None))
+
  "returns the main window"
        self.pushButton.setText(_translate("MainWindow", "OK", None))
+
  # using QtGui.qApp.activeWindow() isn't very reliable because if another
        self.lineEdit.setText(_translate("MainWindow", "tyty", None))
+
  # widget than the mainwindow is active (e.g. a dialog) the wrong widget is
        self.checkBox.setText(_translate("MainWindow", "CheckBox", None))
+
  # returned
        self.radioButton.setText(_translate("MainWindow", "RadioButton", None))
+
  toplevel = QtGui.qApp.topLevelWidgets()
 +
  for i in toplevel:
 +
      if i.metaObject().className() == "Gui::MainWindow":
 +
          return i
 +
  raise Exception("No main window found")
  
    def on_checkBox_clicked(self):
+
def getComboView(mw):
        if self.checkBox.checkState()==0:
+
  dw=mw.findChildren(QtGui.QDockWidget)
            App.Console.PrintMessage(str(self.checkBox.checkState())+" CheckBox KO\r\n")
+
  for i in dw:
        else:    
+
      if str(i.objectName()) == "Combo View":
            App.Console.PrintMessage(str(self.checkBox.checkState())+" CheckBox OK\r\n")
+
          return i.findChild(QtGui.QTabWidget)
#       App.Console.PrintMessage(str(self.lineEdit.setText("tititi"))+" LineEdit\r\n") #write text to the lineEdit window !
+
       elif str(i.objectName()) == "Python Console":
#        str(self.lineEdit.setText("tititi")) #écrit le texte dans la fenêtre lineEdit
+
          return i.findChild(QtGui.QTabWidget)
        App.Console.PrintMessage(str(self.lineEdit.displayText())+" LineEdit\r\n")
+
  raise Exception ("No tab widget found")
  
    def on_radioButton_clicked(self):
+
mw = getMainWindow()
        if self.radioButton.isChecked():
+
tab = getComboView(getMainWindow())
            App.Console.PrintMessage(str(self.radioButton.isChecked())+" Radio OK\r\n")
+
tab2=QtGui.QDialog()
        else:
+
tab.addTab(tab2,"A Special Tab")
            App.Console.PrintMessage(str(self.radioButton.isChecked())+" Radio KO\r\n")
 
  
    def on_lineEdit_clicked(self):
+
#uic.loadUi("/myTaskPanelforTabs.ui",tab2)
#        if self.lineEdit.textChanged():
+
tab2.show()
            App.Console.PrintMessage(str(self.lineEdit.displayText())+" LineEdit Display\r\n")
+
#tab.removeTab(2)
  
    def on_pushButton_clicked(self):
 
        App.Console.PrintMessage("Terminé\r\n")
 
        self.window.hide()
 
 
MainWindow = QtGui.QMainWindow()
 
ui = Ui_MainWindow(MainWindow)
 
MainWindow.show()
 
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:29-->
+
===Enable or disable a window=== <!--T:47-->
Here the same window but with an icon on each button.
 
 
 
<!--T:50-->
 
Download associated icons (click right "Copy the image below ...)"
 
 
 
<!--T:51-->
 
[[File:Icone01.png]]  [[File:Icone02.png]]  [[File:Icone03.png]]
 
 
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
# -*- coding: utf-8 -*-
+
from PySide import QtGui
 
+
mw=FreeCADGui.getMainWindow()
from PySide import QtCore, QtGui
+
dws=mw.findChildren(QtGui.QDockWidget)
 
 
try:
 
    _fromUtf8 = QtCore.QString.fromUtf8
 
except AttributeError:
 
    def _fromUtf8(s):
 
        return s
 
 
 
try:
 
    _encoding = QtGui.QApplication.UnicodeUTF8
 
    def _translate(context, text, disambig):
 
        return QtGui.QApplication.translate(context, text, disambig, _encoding)
 
except AttributeError:
 
    def _translate(context, text, disambig):
 
        return QtGui.QApplication.translate(context, text, disambig)
 
 
 
 
 
class Ui_MainWindow(object):
 
 
 
    def __init__(self, MainWindow):
 
        self.window = MainWindow
 
        path = FreeCAD.ConfigGet("UserAppData")
 
#        path = FreeCAD.ConfigGet("AppHomePath")
 
 
 
        MainWindow.setObjectName(_fromUtf8("MainWindow"))
 
        MainWindow.resize(400, 300)
 
        self.centralWidget = QtGui.QWidget(MainWindow)
 
        self.centralWidget.setObjectName(_fromUtf8("centralWidget"))
 
 
 
        self.pushButton = QtGui.QPushButton(self.centralWidget)
 
        self.pushButton.setGeometry(QtCore.QRect(30, 170, 93, 28))
 
        self.pushButton.setObjectName(_fromUtf8("pushButton"))
 
        self.pushButton.clicked.connect(self.on_pushButton_clicked) #connection pushButton
 
 
 
        self.lineEdit = QtGui.QLineEdit(self.centralWidget)
 
        self.lineEdit.setGeometry(QtCore.QRect(30, 40, 211, 22))
 
        self.lineEdit.setObjectName(_fromUtf8("lineEdit"))
 
        self.lineEdit.returnPressed.connect(self.on_lineEdit_clicked) #connection lineEdit
 
 
 
        self.checkBox = QtGui.QCheckBox(self.centralWidget)
 
        self.checkBox.setGeometry(QtCore.QRect(30, 90, 100, 20))
 
        self.checkBox.setChecked(True)
 
        self.checkBox.setObjectName(_fromUtf8("checkBoxON"))
 
        self.checkBox.clicked.connect(self.on_checkBox_clicked) #connection checkBox
 
 
 
        self.radioButton = QtGui.QRadioButton(self.centralWidget)
 
        self.radioButton.setGeometry(QtCore.QRect(30, 130, 95, 20))
 
        self.radioButton.setObjectName(_fromUtf8("radioButton"))
 
        self.radioButton.clicked.connect(self.on_radioButton_clicked) #connection radioButton
 
  
        MainWindow.setCentralWidget(self.centralWidget)
+
# objectName may be :
 +
# "Report view"
 +
# "Tree view"
 +
# "Property view"
 +
# "Selection view"
 +
# "Combo View"
 +
# "Python console"
 +
# "draftToolbar"
  
        self.menuBar = QtGui.QMenuBar(MainWindow)
+
for i in dws:
        self.menuBar.setGeometry(QtCore.QRect(0, 0, 400, 26))
+
  if i.objectName() == "Report view":
        self.menuBar.setObjectName(_fromUtf8("menuBar"))
+
    dw=i
        MainWindow.setMenuBar(self.menuBar)
+
    break
  
        self.mainToolBar = QtGui.QToolBar(MainWindow)
+
va=dw.toggleViewAction()
        self.mainToolBar.setObjectName(_fromUtf8("mainToolBar"))
+
va.setChecked(True)       # True or False
        MainWindow.addToolBar(QtCore.Qt.TopToolBarArea, self.mainToolBar)
+
dw.setVisible(True)       # True or False
 
 
        self.statusBar = QtGui.QStatusBar(MainWindow)
 
        self.statusBar.setObjectName(_fromUtf8("statusBar"))
 
        MainWindow.setStatusBar(self.statusBar)
 
 
 
        self.retranslateUi(MainWindow)
 
 
 
        # Affiche un icone sur le bouton PushButton
 
        # self.image_01 = "C:\Program Files\FreeCAD0.13\Icone01.png" # adapt the icon name
 
        self.image_01 = path+"Icone01.png" # adapt the name of the icon
 
        icon01 = QtGui.QIcon()
 
        icon01.addPixmap(QtGui.QPixmap(self.image_01),QtGui.QIcon.Normal, QtGui.QIcon.Off)
 
        self.pushButton.setIcon(icon01)  
 
        self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button
 
 
 
        # Affiche un icone sur le bouton RadioButton
 
        # self.image_02 = "C:\Program Files\FreeCAD0.13\Icone02.png" # adapt the name of the icon
 
        self.image_02 = path+"Icone02.png" # adapter le nom de l'icone
 
        icon02 = QtGui.QIcon()
 
        icon02.addPixmap(QtGui.QPixmap(self.image_02),QtGui.QIcon.Normal, QtGui.QIcon.Off)
 
        self.radioButton.setIcon(icon02)
 
        # self.radioButton.setLayoutDirection(QtCore.Qt.RightToLeft) #  This command reverses the direction of the button
 
 
 
        # Affiche un icone sur le bouton CheckBox
 
        # self.image_03 = "C:\Program Files\FreeCAD0.13\Icone03.png" # the name of the icon
 
        self.image_03 = path+"Icone03.png" # adapter le nom de l'icone
 
        icon03 = QtGui.QIcon()
 
        icon03.addPixmap(QtGui.QPixmap(self.image_03),QtGui.QIcon.Normal, QtGui.QIcon.Off)
 
        self.checkBox.setIcon(icon03)
 
        # self.checkBox.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button
 
 
 
 
 
    def retranslateUi(self, MainWindow):
 
        MainWindow.setWindowTitle(_translate("MainWindow", "FreeCAD", None))
 
        self.pushButton.setText(_translate("MainWindow", "OK", None))
 
        self.lineEdit.setText(_translate("MainWindow", "tyty", None))
 
        self.checkBox.setText(_translate("MainWindow", "CheckBox", None))
 
        self.radioButton.setText(_translate("MainWindow", "RadioButton", None))
 
 
 
    def on_checkBox_clicked(self):
 
        if self.checkBox.checkState()==0:
 
            App.Console.PrintMessage(str(self.checkBox.checkState())+"  CheckBox KO\r\n")
 
        else:   
 
            App.Console.PrintMessage(str(self.checkBox.checkState())+" CheckBox OK\r\n")
 
          # App.Console.PrintMessage(str(self.lineEdit.setText("tititi"))+" LineEdit\r\n") # write text to the lineEdit window !
 
          # str(self.lineEdit.setText("tititi")) #écrit le texte dans la fenêtre lineEdit
 
        App.Console.PrintMessage(str(self.lineEdit.displayText())+" LineEdit\r\n")
 
 
 
    def on_radioButton_clicked(self):
 
        if self.radioButton.isChecked():
 
            App.Console.PrintMessage(str(self.radioButton.isChecked())+" Radio OK\r\n")
 
        else:
 
            App.Console.PrintMessage(str(self.radioButton.isChecked())+"  Radio KO\r\n")
 
 
 
    def on_lineEdit_clicked(self):
 
          # if self.lineEdit.textChanged():
 
          App.Console.PrintMessage(str(self.lineEdit.displayText())+" LineEdit Display\r\n")
 
 
 
    def on_pushButton_clicked(self):
 
        App.Console.PrintMessage("Terminé\r\n")
 
        self.window.hide()
 
 
 
MainWindow = QtGui.QMainWindow()
 
ui = Ui_MainWindow(MainWindow)
 
MainWindow.show()
 
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:30-->
+
 
Here the code to display the icon on the '''pushButton''', change the name for another button, ('''radioButton, checkBox''') and the path to the icon.
+
===Opening a custom webpage=== <!--T:27-->
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
        # Affiche un icône sur le bouton PushButton
+
import WebGui
        # self.image_01 = "C:\Program Files\FreeCAD0.13\icone01.png" # the name of the icon
+
WebGui.openBrowser("http://www.example.com")
        self.image_01 = path+"icone01.png" # the name of the icon
 
        icon01 = QtGui.QIcon()
 
        icon01.addPixmap(QtGui.QPixmap(self.image_01),QtGui.QIcon.Normal, QtGui.QIcon.Off)
 
        self.pushButton.setIcon(icon01)
 
        self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button
 
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:31-->
+
 
The command
+
===Getting the HTML contents of an opened webpage=== <!--T:28-->
'''UserAppData''' gives the user path
 
'''AppHomePath''' gives the installation path of FreeCAD
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
#        path = FreeCAD.ConfigGet("UserAppData")
+
from PySide import QtGui,QtWebKit
        path = FreeCAD.ConfigGet("AppHomePath")
+
a = QtGui.qApp
 +
mw = a.activeWindow()
 +
v = mw.findChild(QtWebKit.QWebFrame)
 +
html = unicode(v.toHtml())
 +
print html
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:32-->
+
 
This command reverses the horizontal button, right to left.
+
===Retrieve and use the coordinates of 3 selected points or objects=== <!--T:29-->
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button
+
# -*- coding: utf-8 -*-
 +
# the line above to put the accentuated in the remarks
 +
# If this line is missing, an error will be returned
 +
# extract and use the coordinates of 3 objects selected
 +
import Part, FreeCAD, math, PartGui, FreeCADGui
 +
from FreeCAD import Base, Console
 +
sel = FreeCADGui.Selection.getSelection() # " sel " contains the items selected
 +
if len(sel)!=3 :
 +
  # If there are no 3 objects selected, an error is displayed in the report view
 +
  # The \r and \n at the end of line mean return and the newline CR + LF.
 +
  Console.PrintError("Select 3 points exactly\r\n")
 +
else :
 +
  points=[]
 +
  for obj in sel:
 +
    points.append(obj.Shape.BoundBox.Center)
 +
 
 +
  for pt in points:
 +
    # display of the coordinates in the report view
 +
    Console.PrintMessage(str(pt.x)+"\r\n")
 +
    Console.PrintMessage(str(pt.y)+"\r\n")
 +
    Console.PrintMessage(str(pt.z)+"\r\n")
 +
 
 +
  Console.PrintMessage(str(pt[1]) + "\r\n")
 
}}
 
}}
 
<translate>
 
<translate>
  
===Method 2=== <!--T:33-->
+
===List all objects=== <!--T:30-->
Another method to display a window, here by creating a file '''QtForm.py''' which contains the header program (module called with '''import QtForm'''), and a second module that contains the code window all these accessories, and your code (the calling module).
+
</translate>
 +
{{Code|code=
 +
# -*- coding: utf-8 -*-
 +
import FreeCAD,Draft
 +
# List all objects of the document
 +
doc = FreeCAD.ActiveDocument
 +
objs = FreeCAD.ActiveDocument.Objects
 +
#App.Console.PrintMessage(str(objs) + "\n")
 +
#App.Console.PrintMessage(str(len(FreeCAD.ActiveDocument.Objects)) + " Objects"  + "\n")
  
<!--T:34-->
+
for obj in objs:
This method requires two separate files, but allows to shorten your program using the file ' ' QtForm.py ' ' import. Then distribute the two files together, they are inseparable.
+
    a = obj.Name                                            # list the Name  of the object  (not modifiable)
 +
    b = obj.Label                                            # list the Label of the object  (modifiable)
 +
    try:
 +
        c = obj.LabelText                                    # list the LabeText of the text (modifiable)
 +
        App.Console.PrintMessage(str(a) +" "+ str(b) +" "+ str(c) + "\n") # Displays the Name the Label and the text
 +
    except:
 +
        App.Console.PrintMessage(str(a) +" "+ str(b) + "\n") # Displays the Name and the Label of the object
  
<!--T:35-->
+
#doc.removeObject("Box") # Clears the designated object
The file '''QtForm.py'''
+
}}
 +
<translate>
 +
===List the dimensions of an object, given its name=== <!--T:51-->
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
 +
for edge in FreeCAD.ActiveDocument.MyObjectName.Shape.Edges: # replace "MyObjectName" for list
 +
    print edge.Length
 +
}}
  
 +
<translate>
 +
 +
===Function resident with the mouse click action=== <!--T:31-->
 +
</translate>
 +
Here with '''SelObserver''' on a object select
 +
{{Code|code=
 
# -*- coding: utf-8 -*-
 
# -*- coding: utf-8 -*-
# Create by flachyjoe
+
# causes an action to the mouse click on an object
from PySide import QtCore, QtGui
+
# This function remains resident (in memory) with the function "addObserver(s)"
 +
# "removeObserver(s) # Uninstalls the resident function
 +
class SelObserver:
 +
    def setPreselection(self,doc,obj,sub):                # Preselection object
 +
        App.Console.PrintMessage(str(sub)+ "\n")          # The part of the object name
  
try:
+
    def addSelection(self,doc,obj,sub,pnt):               # Selection object
    _fromUtf8 = QtCore.QString.fromUtf8
+
        App.Console.PrintMessage("addSelection"+ "\n")
except AttributeError:
+
        App.Console.PrintMessage(str(doc)+ "\n")          # Name of the document
  def _fromUtf8(s):
+
        App.Console.PrintMessage(str(obj)+ "\n")          # Name of the object
      return s
+
        App.Console.PrintMessage(str(sub)+ "\n")          # The part of the object name
 +
        App.Console.PrintMessage(str(pnt)+ "\n")          # Coordinates of the object
 +
        App.Console.PrintMessage("______"+ "\n")
  
try:
+
     def removeSelection(self,doc,obj,sub):               # Delete the selected object
    _encoding = QtGui.QApplication.UnicodeUTF8
+
        App.Console.PrintMessage("removeSelection"+ "\n")
     def _translate(context, text, disambig):
 
      return QtGui.QApplication.translate(context, text, disambig, _encoding)
 
except AttributeError:
 
  def _translate(context, text, disambig):
 
      return QtGui.QApplication.translate(context, text, disambig)
 
  
class Form(object):
+
    def setSelection(self,doc):                           # Selection in ComboView
  def __init__(self, title, width, height):
+
        App.Console.PrintMessage("setSelection"+ "\n")
      self.window = QtGui.QMainWindow()
 
      self.title=title
 
      self.window.setObjectName(_fromUtf8(title))
 
      self.window.setWindowTitle(_translate(self.title, self.title, None))
 
      self.window.resize(width, height)
 
  
  def show(self):
+
    def clearSelection(self,doc):                         # If click on the screen, clear the selection
      self.createUI()
+
        App.Console.PrintMessage("clearSelection"+ "\n") # If click on another object, clear the previous object
      self.retranslateUI()
+
s =SelObserver()
      self.window.show()
+
FreeCADGui.Selection.addObserver(s)                       # install the function mode resident
 
+
#FreeCADGui.Selection.removeObserver(s)                   # Uninstall the resident function
  def setText(self, control, text):
 
      control.setText(_translate(self.title, text, None))
 
 
}}
 
}}
<translate>
 
<!--T:36-->
 
The calling file that contains the window and your code.
 
  
<!--T:37-->
+
Other example with '''ViewObserver''' on a object select or view
The file my_file.py
 
 
 
<!--T:38-->
 
The connections are to do, a good exercise.
 
</translate>
 
 
{{Code|code=
 
{{Code|code=
 +
App.newDocument()
 +
v=Gui.activeDocument().activeView()
 +
 +
#This class logs any mouse button events. As the registered callback function fires twice for 'down' and
 +
#'up' events we need a boolean flag to handle this.
 +
class ViewObserver:
 +
  def __init__(self, view):
 +
      self.view = view
 +
 
 +
  def logPosition(self, info):
 +
      down = (info["State"] == "DOWN")
 +
      pos = info["Position"]
 +
      if (down):
 +
          FreeCAD.Console.PrintMessage("Clicked on position: ("+str(pos[0])+", "+str(pos[1])+")\n")
 +
          pnt = self.view.getPoint(pos)
 +
          FreeCAD.Console.PrintMessage("World coordinates: " + str(pnt) + "\n")
 +
          info = self.view.getObjectInfo(pos)
 +
          FreeCAD.Console.PrintMessage("Object info: " + str(info) + "\n")
  
# -*- coding: utf-8 -*-
+
o = ViewObserver(v)
# Create by flachyjoe
+
c = v.addEventCallback("SoMouseButtonEvent",o.logPosition)
from PySide import QtCore, QtGui
 
import QtForm
 
  
class myForm(QtForm.Form):
 
  def createUI(self):
 
      self.centralWidget = QtGui.QWidget(self.window)
 
      self.window.setCentralWidget(self.centralWidget)
 
     
 
      self.pushButton = QtGui.QPushButton(self.centralWidget)
 
      self.pushButton.setGeometry(QtCore.QRect(30, 170, 93, 28))
 
      self.pushButton.clicked.connect(self.on_pushButton_clicked)
 
     
 
      self.lineEdit = QtGui.QLineEdit(self.centralWidget)
 
      self.lineEdit.setGeometry(QtCore.QRect(30, 40, 211, 22))
 
     
 
      self.checkBox = QtGui.QCheckBox(self.centralWidget)
 
      self.checkBox.setGeometry(QtCore.QRect(30, 90, 81, 20))
 
      self.checkBox.setChecked(True)
 
     
 
      self.radioButton = QtGui.QRadioButton(self.centralWidget)
 
      self.radioButton.setGeometry(QtCore.QRect(30, 130, 95, 20))
 
 
 
  def retranslateUI(self):
 
      self.setText(self.pushButton, "Fermer")
 
      self.setText(self.lineEdit, "essai de texte")
 
      self.setText(self.checkBox, "CheckBox")
 
      self.setText(self.radioButton, "RadioButton")
 
 
 
  def on_pushButton_clicked(self):
 
      self.window.hide()
 
 
myWindow=myForm("Fenetre de test",400,300)
 
myWindow.show()
 
 
}}
 
}}
 
<translate>
 
<translate>
 +
===Finding-selecting all elements below cursor=== <!--T:58-->
 +
</translate>
 +
{{Code|code=
 +
from pivy import coin
 +
import FreeCADGui
  
<!--T:52-->
+
def mouse_over_cb( event_callback):
'''Other example'''
+
    event = event_callback.getEvent()
<center>
+
    pos = event.getPosition().getValue()
<gallery widths="400" heights="200">
+
    listObjects = FreeCADGui.ActiveDocument.ActiveView.getObjectsInfo((int(pos[0]),int(pos[1])))
Image:Qt_Example_00.png|Qt example 1
+
    obj = []
Image:Qt_Example_01.png|Qt example details
+
    if listObjects:
</gallery>
+
        FreeCAD.Console.PrintMessage("\n *** Objects under mouse pointer ***")
</center>
+
        for o in listObjects:
{{clear}}
+
            label = str(o["Object"])
 +
            if not label in obj:
 +
                obj.append(label)
 +
        FreeCAD.Console.PrintMessage("\n"+str(obj))
  
<!--T:53-->
 
Are treated :
 
  
<!--T:54-->
+
view = FreeCADGui.ActiveDocument.ActiveView
# icon for window
 
# horizontalSlider
 
# progressBar horizontal
 
# verticalSlider
 
# progressBar vertical
 
# lineEdit
 
# lineEdit
 
# doubleSpinBox
 
# doubleSpinBox
 
# doubleSpinBox
 
# button
 
# button
 
# radioButton with icons
 
# checkBox with icon checked and unchecked
 
# textEdit
 
# graphicsView with 2 graphes
 
The code page and the icons [[Qt_Example|Qt_Example]]
 
</translate>
 
<translate>
 
  
==Icon personalised in ComboView== <!--T:64-->
+
mouse_over = view.addEventCallbackPivy( coin.SoLocation2Event.getClassTypeId(), mouse_over_cb )
  
<!--T:65-->
+
# to remove Callback :
Here an example to create an object with properties and icon personalised in ComboView
+
#view.removeEventCallbackPivy( coin.SoLocation2Event.getClassTypeId(), mouse_over)
  
<!--T:66-->
+
####
Download the example icon to the same directory as the macro [[File:FreeCADIco.png|icon Example for the macro|24px]]
+
#The easy way is probably to use FreeCAD's selection.
 +
#FreeCADGui.ActiveDocument.ActiveView.getObjectsInfo(mouse_coords)
  
<!--T:67-->
+
####
Use of an icon for three different use cases: icon_in_file_disk (format .png), icon_XPM_in_macro (format .XPM) and icon_resource_FreeCAD
+
#you get that kind of result :
 +
#'Document': 'Unnamed', 'Object': 'Box', 'Component': 'Face2', 'y': 8.604081153869629, 'x': 21.0, 'z': 8.553047180175781
  
 +
####
 +
#You can use this data to add your element to FreeCAD's selection :
 +
#FreeCADGui.Selection.addSelection(FreeCAD.ActiveDocument.Box,'Face2',21.0,8.604081153869629,8.553047180175781)
 +
}}
 +
<translate>
 +
 +
===List the components of an object=== <!--T:32-->
 
</translate>
 
</translate>
[[File:Qt_Example_02.png|icon personalised]]
+
{{Code|code=
{{clear}}
+
# -*- coding: utf-8 -*-
 +
# This function list the components of an object
 +
# and extract this object its XYZ coordinates,
 +
# its edges and their lengths center of mass and coordinates
 +
# its faces and their center of mass
 +
# its faces and their surfaces and coordinates
 +
# 8/05/2014
  
{{Code|code=
+
import Draft,Part
import PySide
+
def detail():
import FreeCAD, FreeCADGui, Part
+
    sel = FreeCADGui.Selection.getSelection()  # Select an object
from pivy import coin
+
    if len(sel) != 0:                          # If there is a selection then
from PySide import QtGui ,QtCore
+
        Vertx=[]
from PySide.QtGui import *
+
        Edges=[]
from PySide.QtCore import *
+
        Faces=[]
import Draft
+
        compt_V=0
 +
        compt_E=0
 +
        compt_F=0
 +
        pas    =0
 +
        perimetre = 0.
 +
        EdgesLong = []
  
global path
+
        # Displays the "Name" and the "Label" of the selection
param = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Macro")# macro path in FreeCAD preferences
+
        App.Console.PrintMessage("Selection > " + str(sel[0].Name) + " " + str(sel[0].Label) +"\n"+"\n")
path = param.GetString("MacroPath","") + "/"                       # macro path
 
path = path.replace("\\","/")                                       # convert the "\" to "/"
 
  
 +
        for j in enumerate(sel[0].Shape.Edges):                                    # Search the "Edges" and their lengths
 +
            compt_E+=1
 +
            Edges.append("Edge%d" % (j[0]+1))
 +
            EdgesLong.append(str(sel[0].Shape.Edges[compt_E-1].Length))
 +
            perimetre += (sel[0].Shape.Edges[compt_E-1].Length)                    # calculates the perimeter
  
class IconViewProviderToFile:                                      # Class ViewProvider create Property view of object
+
            # Displays the "Edge" and its length
    def __init__( self, obj, icon):
+
            App.Console.PrintMessage("Edge"+str(compt_E)+" Length > "+str(sel[0].Shape.Edges[compt_E-1].Length)+"\n")
        self.icone = icon
 
       
 
    def getIcon(self):                                              # GetIcon
 
        return self.icone
 
       
 
    def attach(self, obj):                                          # Property view of object
 
        self.modes = []
 
        self.modes.append("Flat Lines")
 
        self.modes.append("Shaded")
 
        self.modes.append("Wireframe")
 
        self.modes.append("Points")
 
        obj.addDisplayMode( coin.SoGroup(),"Flat Lines" )          # Display Mode
 
        obj.addDisplayMode( coin.SoGroup(),"Shaded" )
 
        obj.addDisplayMode( coin.SoGroup(),"Wireframe" )
 
        obj.addDisplayMode( coin.SoGroup(),"Points" )
 
        return self.modes
 
  
    def getDisplayModes(self,obj):
+
            # Displays the "Edge" and its center mass
        return self.modes
+
            App.Console.PrintMessage("Edge"+str(compt_E)+" Center > "+str(sel[0].Shape.Edges[compt_E-1].CenterOfMass)+"\n")
  
#####################################################
+
            num = sel[0].Shape.Edges[compt_E-1].Vertexes[0]
########## Example with icon to file # begin ########
+
            Vertx.append("X1: "+str(num.Point.x))
#####################################################
+
            Vertx.append("Y1: "+str(num.Point.y))
 +
            Vertx.append("Z1: "+str(num.Point.z))
 +
            # Displays the coordinates 1
 +
            App.Console.PrintMessage("X1: "+str(num.Point[0])+" Y1: "+str(num.Point[1])+" Z1: "+str(num.Point[2])+"\n")
  
object1 = FreeCAD.ActiveDocument.addObject("App::FeaturePython", "Icon_In_File_Disk")                                    # create your object
+
            try:
object1.addProperty("App::PropertyString","Identity", "ExampleTitle0", "Identity of object").Identity = "FCSpring"        # Identity of object
+
                num = sel[0].Shape.Edges[compt_E-1].Vertexes[1]
object1.addProperty("App::PropertyFloat" ,"Pitch",    "ExampleTitle0", "Pitch betwen 2 heads").Pitch  = 2.0              # other Property Data
+
                Vertx.append("X2: "+str(num.Point.x))
object1.addProperty("App::PropertyBool" ,"View",    "ExampleTitle1", "Hello world").View            = True              # ...
+
                Vertx.append("Y2: "+str(num.Point.y))
object1.addProperty("App::PropertyColor" ,"LineColor","ExampleTitle2", "Color to choice").LineColor  = (0.13,0.15,0.37) # ...
+
                Vertx.append("Z2: "+str(num.Point.z))
#...other Property Data
+
            except:
#...other Property Data
+
                Vertx.append("-")
#
+
                Vertx.append("-")
object1.ViewObject.Proxy = IconViewProviderToFile( object1, path + "FreeCADIco.png")                                     # icon download to file
+
                Vertx.append("-")
App.ActiveDocument.recompute()
+
            # Displays the coordinates 2
#
+
            App.Console.PrintMessage("X2: "+str(num.Point[0])+" Y2: "+str(num.Point[1])+" Z2: "+str(num.Point[2])+"\n")
#__Detail__:
 
# FreeCAD.ActiveDocument.addObject( = create now object personalized
 
# "App::FeaturePython",            = object as FeaturePython
 
# "Icon_In_File_Disk")             = internal name of your object
 
#
 
#
 
# "App::PropertyString",    = type of Property , availlable : PropertyString, PropertyFloat, PropertyBool, PropertyColor
 
# "Identity",              = name of the feature
 
# "ExampleTitle0",          = title of the "section"
 
# "Identity of object")    = tooltip displayed on mouse
 
# .Identity                = variable (same of name of the feature)
 
# object1.ViewObject.Proxy  = create the view object and gives the icon
 
#
 
########## example with icon to file end
 
  
 +
            App.Console.PrintMessage("\n")
 +
        App.Console.PrintMessage("Perimeter of the form  : "+str(perimetre)+"\n")
  
 +
        App.Console.PrintMessage("\n")
 +
        FacesSurf = []
 +
        for j in enumerate(sel[0].Shape.Faces):                                      # Search the "Faces" and their surface
 +
            compt_F+=1
 +
            Faces.append("Face%d" % (j[0]+1))
 +
            FacesSurf.append(str(sel[0].Shape.Faces[compt_F-1].Area))
  
#####################################################
+
            # Displays 'Face' and its surface
########## Example with icon in macro # begin #######
+
            App.Console.PrintMessage("Face"+str(compt_F)+" >  Surface "+str(sel[0].Shape.Faces[compt_F-1].Area)+"\n")
#####################################################
 
  
def setIconInMacro(self):        # def contener the icon in format .xpm
+
             # Displays 'Face' and its CenterOfMass
    # File format XPM created by Gimp "https://www.gimp.org/"
+
             App.Console.PrintMessage("Face"+str(compt_F)+" > Center "+str(sel[0].Shape.Faces[compt_F-1].CenterOfMass)+"\n")
    # Choice palette Tango
 
    # Create your masterwork ...
 
    # For export the image in XPM format
 
    #    Menu File > Export as > .xpm
 
    # (For convert image true color in Tango color palette :
 
    #    Menu Image > Mode > Indexed ... > Use custom palette > Tango Icon Theme > Convert)
 
    return """
 
            /* XPM */
 
            static char * XPM[] = {
 
            "22 24 5 1",
 
            " c None",
 
            ". c #CE5C00",
 
            "+ c #EDD400",
 
            "@ c #F57900",
 
             "# c #8F5902",
 
             "                      ",
 
            "                      ",
 
            "  ....                ",
 
            "  ..@@@@..            ",
 
            " . ...@......        ",
 
            "  .+++++++++...      ",
 
            "  .      ....++...    ",
 
            .@..@@@@@@.+++++.. ",
 
            "  .@@@@@..#  ++++ .. ",
 
            "  .       ++++  .@..  ",
 
            "  .++++++++  .@@@.+.  ",
 
            " .      ..@@@@@. ++.  ",
 
            " ..@@@@@@@@@.  +++ .  ",
 
            " ....@...# +++++ @..  ",
 
            " .    ++++++++ .@. .  ",
 
            " .++++++++  .@@@@ .  ",
 
            " .  #....@@@@. ++.  ",
 
            " .@@@@@@@@@.. +++ .  ",
 
            " ........  +++++...  ",
 
            " ...  ..+++++ ..@..  ",
 
            "    ......  .@@@ +.  ",
 
            "          ......++.  ",
 
            "                ...  ",
 
            "                      "};
 
        """
 
  
object2 = FreeCAD.ActiveDocument.addObject("App::FeaturePython", "Icon_XPM_In_Macro")                                   #
+
            # Displays 'Face' and its Coordinates
object2.addProperty("App::PropertyString","Identity","ExampleTitle","Identity of object").Identity = "FCSpring"
+
            FacesCoor = []
#...other Property Data
+
            fco = 0
#...other Property Data
+
            for f0 in sel[0].Shape.Faces[compt_F-1].Vertexes:                        # Search the Vertexes of the face
#
+
                fco += 1
object2.ViewObject.Proxy = IconViewProviderToFile( object2, setIconInMacro(""))              # icon in macro (.XPM)
+
                FacesCoor.append("X"+str(fco)+": "+str(f0.Point.x))
App.ActiveDocument.recompute()
+
                FacesCoor.append("Y"+str(fco)+": "+str(f0.Point.y))
########## example with icon in macro end
+
                FacesCoor.append("Z"+str(fco)+": "+str(f0.Point.z))
  
 +
            # Displays 'Face' and its Coordinates
 +
            App.Console.PrintMessage("Face"+str(compt_F)+" >  Coordinate"+str(FacesCoor)+"\n")
  
 +
            # Displays 'Face' and its Volume
 +
            App.Console.PrintMessage("Face"+str(compt_F)+" >  Volume  "+str(sel[0].Shape.Faces[compt_F-1].Volume)+"\n")
 +
            App.Console.PrintMessage("\n")
  
####################################################################
+
        # Displays the total surface of the form
########## Example with icon to FreeCAD ressource # begin ##########
+
        App.Console.PrintMessage("Surface of the form    : "+str(sel[0].Shape.Area)+"\n")
####################################################################
 
  
object3 = FreeCAD.ActiveDocument.addObject("App::FeaturePython", "Icon_Ressource_FreeCAD")                              #
+
        # Displays the total Volume of the form
object3.addProperty("App::PropertyString","Identity","ExampleTitle","Identity of object").Identity = "FCSpring"
+
        App.Console.PrintMessage("Volume  of the form    : "+str(sel[0].Shape.Volume)+"\n")
#...other Property Data
 
#...other Property Data
 
#
 
object3.ViewObject.Proxy = IconViewProviderToFile( object3, ":/icons/Draft_Draft.svg")       # icon to FreeCAD ressource
 
App.ActiveDocument.recompute()
 
########## example with icon to FreeCAD ressource end
 
  
 +
detail()
 
}}
 
}}
 +
<translate>
  
 +
===List the PropertiesList=== <!--T:33-->
 +
</translate>
 +
{{Code|code=
 +
import FreeCADGui
 +
from FreeCAD import Console
 +
o = App.ActiveDocument.ActiveObject
 +
op = o.PropertiesList
 +
for p in op:
 +
    Console.PrintMessage("Property: "+ str(p)+ " Value: " + str(o.getPropertyByName(p))+"\r\n")
 +
}}
 
<translate>
 
<translate>
<!--T:68-->
+
===Adding one Property "Comment"=== <!--T:54-->
Complete example creating a cube and its icon
 
 
</translate>
 
</translate>
 
 
{{Code|code=
 
{{Code|code=
#https://forum.freecadweb.org/viewtopic.php?t=10255#p83319
+
import Draft
import FreeCAD, Part, math
+
obj = FreeCADGui.Selection.getSelection()[0]
from FreeCAD import Base
+
obj.addProperty("App::PropertyString","GComment","Draft","Font name").GComment = "Comment here"
from PySide import QtGui
+
App.activeDocument().recompute()
 +
}}
  
global path
+
<translate>
param = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Macro")# macro path in FreeCAD preferences
+
===Search and data extraction=== <!--T:36-->
path = param.GetString("MacroPath","") + "/"                        # macro path
 
path = path.replace("\\","/")                                      # convert the "\" to "/"
 
  
def setIconInMacro(self):
+
<!--T:37-->
    return """
+
Examples of research and decoding information on an object.
        /* XPM */
 
        static char * xpm[] = {
 
        "22 22 12 1",
 
        " c None",
 
        ". c #A40000",
 
        "+ c #2E3436",
 
        "@ c #CE5C00",
 
        "# c #F57900",
 
        "$ c #FCAF3E",
 
        "% c #5C3566",
 
        "& c #204A87",
 
        "* c #555753",
 
        "= c #3465A4",
 
        "- c #4E9A06",
 
        "; c #729FCF",
 
        "                      ",
 
        "                      ",
 
        "                      ",
 
        "        ..  ..      ",
 
        "      +@#+++.$$      ",
 
        "      +.#+%..$$      ",
 
        "      &*$  &*#*      ",
 
        "      &  =&=  =      ",
 
        "  ++&  +.==  %=    ",
 
        "  ++$@ ..$ %=  &    ",
 
        "  ..-&%.#$$ &## +=$  ",
 
        "  .#  ..$ ..#%%.#$$  ",
 
        "    ;    =+=## %-$#  ",
 
        "    &=  ;&  %=    ",
 
        "      ;+ &=;  %=      ",
 
        "      ++$- +*$-      ",
 
        "      .#&&+.@$$      ",
 
        "      ..$# ..$#      ",
 
        "      ..  ..        ",
 
        "                      ",
 
        "                      ",
 
        "                      "};
 
        """
 
  
class PartFeature:
+
<!--T:38-->
    def __init__(self, obj):
+
Each section is independently and is separated by "############" can be copied directly into the Python console, or in a macro or use this macro. The description of the macro in the commentary.
        obj.Proxy = self
 
  
class Box(PartFeature):
+
<!--T:39-->
    def __init__(self, obj):
+
Displaying it in the "View Report" window (View > Views > View report)
        PartFeature.__init__(self, obj)
+
</translate>
        obj.addProperty("App::PropertyLength", "Length", "Box", "Length of the box").Length = 1.0
+
{{Code|code=
        obj.addProperty("App::PropertyLength", "Width",  "Box", "Width of the box" ).Width  = 1.0
 
        obj.addProperty("App::PropertyLength", "Height", "Box", "Height of the box").Height = 1.0
 
  
    def onChanged(self, fp, prop):
+
# -*- coding: utf-8 -*-
        try:
+
# -*- coding: utf-8 -*-
            if prop == "Length" or prop == "Width" or prop == "Height":
+
from __future__ import unicode_literals
                fp.Shape = Part.makeBox(fp.Length,fp.Width,fp.Height)
+
        except:
+
# Exemples de recherche et de decodage d'informations sur un objet
            pass
+
# Chaque section peut etre copiee directement dans la console Python ou dans une macro ou utilisez la macro tel quel
 +
# Certaines commandes se repetent seul l'approche est differente
 +
# L'affichage se fait dans la Vue rapport : Menu Affichage > Vues > Vue rapport
 +
#
 +
# Examples of research and decoding information on an object
 +
# Each section can be copied directly into the Python console, or in a macro or uses this macro
 +
# Certain commands as repeat alone approach is different
 +
# Displayed on Report view : Menu View > Views > report view
 +
#
 +
# rev:30/08/2014:29/09/2014:17/09/2015
 +
 +
from FreeCAD import Base
 +
import DraftVecUtils, Draft, Part
 +
 +
mydoc = FreeCAD.activeDocument().Name                                    # Name of active Document
 +
App.Console.PrintMessage("Active docu    : "+(mydoc)+"\n")
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
object_Label = sel[0].Label                                              # Label of the object (modifiable)
 +
App.Console.PrintMessage("object_Label  : "+(object_Label)+"\n")
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
App.Console.PrintMessage("sel            : "+str(sel[0])+"\n\n")          # sel[0] first object selected
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
object_Name  = sel[0].Name                                                # Name of the object (not modifiable)
 +
App.Console.PrintMessage("object_Name    : "+str(object_Name)+"\n\n")
 +
##################################################################################
 +
 +
try:
 +
    SubElement = FreeCADGui.Selection.getSelectionEx()                    # sub element name with getSelectionEx()
 +
    element_ = SubElement[0].SubElementNames[0]                          # name of 1 element selected
 +
    App.Console.PrintMessage("elementSelec  : "+str(element_)+"\n\n")           
 +
except:
 +
    App.Console.PrintMessage("Oups"+"\n\n")           
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
App.Console.PrintMessage("sel            : "+str(sel[0])+"\n\n")          # sel[0] first object selected
 +
##################################################################################
 +
 +
SubElement = FreeCADGui.Selection.getSelectionEx()                        # sub element name with getSelectionEx()
 +
App.Console.PrintMessage("SubElement    : "+str(SubElement[0])+"\n\n")  # name of sub element
 +
##################################################################################
  
    def execute(self, fp):
+
SubElement = Gui.Selection.getSelectionEx()[0].SubObjects[0].Length      # sub element or element name with getSelectionEx()
        fp.Shape = Part.makeBox(fp.Length,fp.Width,fp.Height)
+
App.Console.PrintMessage("SubElement length: "+str(length)+"\n")         # length
 +
##################################################################################
  
class ViewProviderBox:
+
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
     def __init__(self, obj, icon):
+
i = 0
         obj.Proxy = self
+
for j in enumerate(sel[0].Shape.Edges):                                   # list all Edges
        self.icone = icon
+
    i += 1
          
+
     App.Console.PrintMessage("Edges n : "+str(i)+"\n")
     def getIcon(self):
+
    a = sel[0].Shape.Edges[j[0]].Vertexes[0]
         return self.icone
+
    App.Console.PrintMessage("X1            : "+str(a.Point.x)+"\n")    # coordinate XYZ first point
 +
    App.Console.PrintMessage("Y1            : "+str(a.Point.y)+"\n")
 +
    App.Console.PrintMessage("Z1            : "+str(a.Point.z)+"\n")
 +
    try:
 +
        a = sel[0].Shape.Edges[j[0]].Vertexes[1]
 +
        App.Console.PrintMessage("X2            : "+str(a.Point.x)+"\n") # coordinate XYZ second point
 +
        App.Console.PrintMessage("Y2            : "+str(a.Point.y)+"\n")
 +
         App.Console.PrintMessage("Z2            : "+str(a.Point.z)+"\n")
 +
    except:
 +
        App.Console.PrintMessage("Oups"+"\n")   
 +
App.Console.PrintMessage("\n")   
 +
##################################################################################
 +
   
 +
try:
 +
    SubElement = FreeCADGui.Selection.getSelectionEx()                                        # sub element name with getSelectionEx()
 +
    subElementName = Gui.Selection.getSelectionEx()[0].SubElementNames[0]                    # sub element name with getSelectionEx()
 +
    App.Console.PrintMessage("subElementName : "+str(subElementName)+"\n")
 +
   
 +
    subObjectLength = Gui.Selection.getSelectionEx()[0].SubObjects[0].Length                  # sub element Length
 +
    App.Console.PrintMessage("subObjectLength: "+str(subObjectLength)+"\n\n")
 +
   
 +
    subObjectX1 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[0].Point.x         # sub element coordinate X1
 +
     App.Console.PrintMessage("subObject_X1  : "+str(subObjectX1)+"\n")
 +
    subObjectY1 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[0].Point.y        # sub element coordinate Y1
 +
    App.Console.PrintMessage("subObject_Y1  : "+str(subObjectY1)+"\n")
 +
    subObjectZ1 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[0].Point.z         # sub element coordinate Z1
 +
    App.Console.PrintMessage("subObject_Z1  : "+str(subObjectZ1)+"\n\n")
  
     def attach(self, obj):
+
     try:
         return
+
         subObjectX2 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[1].Point.x    # sub element coordinate X2
 
+
         App.Console.PrintMessage("subObject_X2  : "+str(subObjectX2)+"\n")
    def setupContextMenu(self, obj, menu):
+
         subObjectY2 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[1].Point.y    # sub element coordinate Y2
         action = menu.addAction("Set default height")
+
        App.Console.PrintMessage("subObject_Y2  : "+str(subObjectY2)+"\n")
         action.triggered.connect(lambda f=self.setDefaultHeight, arg=obj:f(arg))
+
        subObjectZ2 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[1].Point.z    # sub element coordinate Z2
 
+
         App.Console.PrintMessage("subObject_Z2  : "+str(subObjectZ2)+"\n\n")
         action = menu.addAction("Hello World")
+
    except:
         action.triggered.connect(self.showHelloWorld)
+
         App.Console.PrintMessage("Oups"+"\n\n")          
  
     def setDefaultHeight(self, view):
+
     subObjectBoundBox = Gui.Selection.getSelectionEx()[0].SubObjects[0].BoundBox              # sub element BoundBox coordinates
        view.Object.Height = 15.0
+
    App.Console.PrintMessage("subObjectBBox  : "+str(subObjectBoundBox)+"\n")
 +
   
 +
    subObjectBoundBoxCenter = Gui.Selection.getSelectionEx()[0].SubObjects[0].BoundBox.Center # sub element BoundBoxCenter
 +
    App.Console.PrintMessage("subObjectBBoxCe: "+str(subObjectBoundBoxCenter)+"\n")
 +
   
 +
    surfaceFace = Gui.Selection.getSelectionEx()[0].SubObjects[0].Area                        # Area of the face selected
 +
    App.Console.PrintMessage("surfaceFace    : "+str(surfaceFace)+"\n\n")
 +
except:
 +
    App.Console.PrintMessage("Oups"+"\n\n")           
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
surface = sel[0].Shape.Area                                              # Area object complete
 +
App.Console.PrintMessage("surfaceObjet  : "+str(surface)+"\n\n")
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
CenterOfMass = sel[0].Shape.CenterOfMass                                  # Center of Mass of the object
 +
App.Console.PrintMessage("CenterOfMass  : "+str(CenterOfMass)+"\n")
 +
App.Console.PrintMessage("CenterOfMassX  : "+str(CenterOfMass[0])+"\n")  # coordinates [0]=X [1]=Y [2]=Z
 +
App.Console.PrintMessage("CenterOfMassY  : "+str(CenterOfMass[1])+"\n")
 +
App.Console.PrintMessage("CenterOfMassZ  : "+str(CenterOfMass[2])+"\n\n")
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
for j in enumerate(sel[0].Shape.Faces):                                  # List alles faces of the object
 +
    App.Console.PrintMessage("Face          : "+str("Face%d" % (j[0]+1))+"\n")
 +
App.Console.PrintMessage("\n\n")
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
volume_ = sel[0].Shape.Volume                                            # Volume of the object
 +
App.Console.PrintMessage("volume_        : "+str(volume_)+"\n\n")
 +
##################################################################################
 +
 +
objs = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
  
     def showHelloWorld(self):
+
if len(objs) >= 1:
         QtGui.QMessageBox.information(None, "Hi there", "Hello World")
+
     if hasattr(objs[0], "Shape"):
 +
         s = objs[0].Shape
 +
    elif hasattr(objs[0], "Mesh"):      # upgrade with wmayer thanks #http://forum.freecadweb.org/viewtopic.php?f=13&t=22331
 +
        s = objs[0].Mesh
 +
    elif hasattr(objs[0], "Points"):
 +
        s = objs[0].Points
  
def makeBox():
+
#sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
    FreeCAD.newDocument()
+
#boundBox_= sel[0].Shape.BoundBox                                          # BoundBox of the object
    a=FreeCAD.ActiveDocument.addObject("Part::FeaturePython","Box")
+
boundBox_= s.BoundBox                                                      # BoundBox of the object
    Box(a)
+
App.Console.PrintMessage("boundBox_      : "+str(boundBox_)+"\n")
#    ViewProviderBox(a.ViewObject, path + "FreeCADIco.png")    # icon download to file
+
#    ViewProviderBox(a.ViewObject, ":/icons/Draft_Draft.svg") # icon to FreeCAD ressource
+
boundBoxLX  = boundBox_.XLength                                          # Length x boundBox rectangle
    ViewProviderBox(a.ViewObject,  setIconInMacro(""))        # icon in macro (.XPM)
+
boundBoxLY = boundBox_.YLength                                          # Length y boundBox rectangle
    App.ActiveDocument.recompute()
+
boundBoxLZ  = boundBox_.ZLength                                          # Length z boundBox rectangle
 +
boundBoxDiag= boundBox_.DiagonalLength                                    # Diagonal Length boundBox rectangle
  
makeBox()
+
App.Console.PrintMessage("boundBoxLX    : "+str(boundBoxLX)+"\n")
 +
App.Console.PrintMessage("boundBoxLY    : "+str(boundBoxLY)+"\n")
 +
App.Console.PrintMessage("boundBoxLZ    : "+str(boundBoxLZ)+"\n")
 +
App.Console.PrintMessage("boundBoxDiag  : "+str(boundBoxDiag)+"\n\n")
  
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
pl = sel[0].Shape.Placement                                              # Placement Vector XYZ and Yaw-Pitch-Roll
 +
App.Console.PrintMessage("Placement      : "+str(pl)+"\n")
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
pl = sel[0].Shape.Placement.Base                                          # Placement Vector XYZ
 +
App.Console.PrintMessage("PlacementBase  : "+str(pl)+"\n\n")
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
oripl_X = sel[0].Placement.Base[0]                                        # decode Placement X
 +
oripl_Y = sel[0].Placement.Base[1]                                        # decode Placement Y
 +
oripl_Z = sel[0].Placement.Base[2]                                        # decode Placement Z
 +
 +
App.Console.PrintMessage("oripl_X        : "+str(oripl_X)+"\n")
 +
App.Console.PrintMessage("oripl_Y        : "+str(oripl_Y)+"\n")
 +
App.Console.PrintMessage("oripl_Z        : "+str(oripl_Z)+"\n\n")
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
rotation = sel[0].Placement.Rotation                                      # decode Placement Rotation
 +
App.Console.PrintMessage("rotation              : "+str(rotation)+"\n\n")
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
pl = sel[0].Shape.Placement.Rotation                                      # decode Placement Rotation other method
 +
App.Console.PrintMessage("Placement Rot        : "+str(pl)+"\n\n")
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
pl = sel[0].Shape.Placement.Rotation.Angle                                # decode Placement Rotation Angle
 +
App.Console.PrintMessage("Placement Rot Angle  : "+str(pl)+"\n\n")
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
Rot_0 = sel[0].Placement.Rotation.Q[0]                                    # decode Placement Rotation Q
 +
App.Console.PrintMessage("Rot_0        : "+str(Rot_0)+ " rad ,  "+str(180 * Rot_0 / 3.1416)+" deg "+"\n")
 +
 +
Rot_1 = sel[0].Placement.Rotation.Q[1]                                    # decode Placement Rotation 1
 +
App.Console.PrintMessage("Rot_1        : "+str(Rot_1)+ " rad ,  "+str(180 * Rot_1 / 3.1416)+" deg "+"\n")
 +
 +
Rot_2 = sel[0].Placement.Rotation.Q[2]                                    # decode Placement Rotation 2
 +
App.Console.PrintMessage("Rot_2        : "+str(Rot_2)+ " rad ,  "+str(180 * Rot_2 / 3.1416)+" deg "+"\n")
 +
 +
Rot_3 = sel[0].Placement.Rotation.Q[3]                                    # decode Placement Rotation 3
 +
App.Console.PrintMessage("Rot_3        : "+str(Rot_3)+"\n\n")
 +
##################################################################################
 +
 +
sel = FreeCADGui.Selection.getSelection()                                # select object with getSelection()
 +
Yaw  = sel[0].Shape.Placement.Rotation.toEuler()[0]                      # decode angle Euler Yaw (Z)
 +
App.Console.PrintMessage("Yaw            : "+str(Yaw)+"\n")
 +
Pitch = sel[0].Shape.Placement.Rotation.toEuler()[1]                      # decode angle Euler Pitch (Y)
 +
App.Console.PrintMessage("Pitch          : "+str(Pitch)+"\n")
 +
Roll  = sel[0].Shape.Placement.Rotation.toEuler()[2]                      # decode angle Euler Roll (X)
 +
App.Console.PrintMessage("Roll          : "+str(Roll)+"\n\n")
 +
##################################################################################
  
 +
import DraftGeomUtils
 +
sel = FreeCADGui.Selection.getSelection()
 +
vecteur = DraftGeomUtils.findMidpoint(sel[0].Shape.Edges[0])              # find Midpoint
 +
App.Console.PrintMessage(vecteur)
 +
Draft.makePoint(vecteur)
 +
##################################################################################
 
}}
 
}}
 
<translate>
 
<translate>
 
+
===Manual search of an element with label=== <!--T:52-->
==Use QFileDialog for writing to a file== <!--T:61-->
 
Complete code:
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
# -*- coding: utf-8 -*-
+
# Extract the coordinate X,Y,Z and Angle giving the label
import PySide
+
App.Console.PrintMessage("Base.x      : "+str(FreeCAD.ActiveDocument.getObjectsByLabel("Cylindre")[0].Placement.Base.x)+"\n")
from PySide import QtGui ,QtCore
+
App.Console.PrintMessage("Base.y      : "+str(FreeCAD.ActiveDocument.getObjectsByLabel("Cylindre")[0].Placement.Base.y)+"\n")
from PySide.QtGui import *
+
App.Console.PrintMessage("Base.z      : "+str(FreeCAD.ActiveDocument.getObjectsByLabel("Cylindre")[0].Placement.Base.z)+"\n")
from PySide.QtCore import *
+
App.Console.PrintMessage("Base.Angle  : "+str(FreeCAD.ActiveDocument.getObjectsByLabel("Cylindre")[0].Placement.Rotation.Angle)+"\n\n")
path = FreeCAD.ConfigGet("UserAppData")
+
##################################################################################
 
 
try:
 
    SaveName = QFileDialog.getSaveFileName(None,QString.fromLocal8Bit("Save a file txt"),path,            "*.txt") # PyQt4
 
#                                                                    "here the text displayed on windows" "here the filter (extension)
 
except Exception:
 
    SaveName, Filter = PySide.QtGui.QFileDialog.getSaveFileName(None, "Save a file txt", path,            "*.txt") # PySide
 
#                                                                    "here the text displayed on windows" "here the filter (extension)" 
 
if SaveName == "":                                                            # if the name file are not selected then Abord process
 
    App.Console.PrintMessage("Process aborted"+"\n")
 
else:                                                                        # if the name file are selected or created then
 
    App.Console.PrintMessage("Registration of "+SaveName+"\n")                # text displayed to Report view (Menu > View > Report view checked)
 
    try:                                                                      # detect error ...
 
        file = open(SaveName, 'w')                                           # open the file selected to write (w)
 
        try:                                                                  # if error detected to write ...
 
            # here your code
 
            print "here your code"
 
            file.write(str(1)+"\n")                                          # write the number convert in text with (str())
 
            file.write("FreeCAD the best")                                    # write the the text with ("  ")
 
        except Exception:                                                    # if error detected to write
 
            App.Console.PrintError("Error write file "+"\n")                  # detect error ... display the text in red (PrintError)
 
        finally:                                                              # if error detected to write ... or not the file is closed
 
            file.close()                                                     # if error detected to write ... or not the file is closed
 
    except Exception:
 
        App.Console.PrintError("Error Open file "+SaveName+"\n")     # detect error ... display the text in red (PrintError)
 
  
 
}}
 
}}
 
<translate>
 
<translate>
  
==Use QFileDialog to read a file== <!--T:62-->
+
<!--T:40-->
Complete code:
+
'''PS:''' Usually the angles are given in Radian to convert :
</translate>
 
{{Code|code=
 
# -*- coding: utf-8 -*-
 
import PySide
 
from PySide import QtGui ,QtCore
 
from PySide.QtGui import *
 
from PySide.QtCore import *
 
path = FreeCAD.ConfigGet("UserAppData")
 
  
OpenName = ""
+
<!--T:41-->
try:
+
#angle in Degrees to Radians :
    OpenName = QFileDialog.getOpenFileName(None,QString.fromLocal8Bit("Read a file txt"),path,            "*.txt") # PyQt4
+
#*Angle in radian = '''pi * (angle in degree) / 180'''
#                                                                     "here the text displayed on windows" "here the filter (extension)" 
+
#*Angle in radian = math.radians(angle in degree)
except Exception:
+
#angle in Radians to Degrees :
    OpenName, Filter = PySide.QtGui.QFileDialog.getOpenFileName(None, "Read a file txt", path,            "*.txt") #PySide
+
#*Angle in degree = '''180 * (angle in radian) / pi'''
#                                                                     "here the text displayed on windows" "here the filter (extension)" 
+
#*Angle in degree = math.degrees(angle in radian)
if OpenName == "":                                                            # if the name file are not selected then Abord process
 
    App.Console.PrintMessage("Process aborted"+"\n")
 
else:
 
    App.Console.PrintMessage("Read "+OpenName+"\n")                          # text displayed to Report view (Menu > View > Report view checked)
 
    try:                                                                      # detect error to read file
 
        file = open(OpenName, "r")                                            # open the file selected to read (r)  # (rb is binary)
 
        try:                                                                  # detect error ...
 
            # here your code
 
            print "here your code"
 
            op = OpenName.split("/")                                         # decode the path
 
            op2 = op[-1].split(".")                                          # decode the file name
 
            nomF = op2[0]                                                    # the file name are isolated
 
  
            App.Console.PrintMessage(str(nomF)+"\n")                          # the file name are displayed
+
===Cartesian coordinates === <!--T:42-->
  
            for ligne in file:                                               # read the file
+
<!--T:43-->
                X  = ligne.rstrip('\n\r') #.split()                          # decode the line
+
This code displays the Cartesian coordinates of the selected item.
                print X                                                      # print the line in report view other method
 
                                                                              # (Menu > Edit > preferences... > Output window > Redirect internal Python output (and errors) to report view checked)
 
        except Exception:                                                    # if error detected to read
 
            App.Console.PrintError("Error read file "+"\n")                  # detect error ... display the text in red (PrintError)
 
        finally:                                                              # if error detected to read ... or not error the file is closed
 
            file.close()                                                      # if error detected to read ... or not error the file is closed
 
    except Exception:                                                        # if one error detected to read file
 
        App.Console.PrintError("Error in Open the file "+OpenName+"\n")      # if one error detected ... display the text in red (PrintError)
 
  
}}
+
<!--T:44-->
<translate>
+
Change the value of "numberOfPoints" if you want a different number of points (precision)
 
 
==Use QColorDialog to get the color== <!--T:63-->
 
Complete code:
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
# -*- coding: utf-8 -*-
+
numberOfPoints = 100                                                        # Decomposition number (or precision you can change)
# https://deptinfo-ensip.univ-poitiers.fr/ENS/pyside-docs/PySide/QtGui/QColor.html
+
selectedEdge = FreeCADGui.Selection.getSelectionEx()[0].SubObjects[0].copy() # select one element
import PySide
+
points  = selectedEdge.discretize(numberOfPoints)                           # discretize the element
from PySide import QtGui ,QtCore
+
i=0
from PySide.QtGui import *
+
for p in points:                                                             # list and display the coordinates
from PySide.QtCore import *
+
     i+=1
path = FreeCAD.ConfigGet("UserAppData")
+
     print i, " X", p.x, " Y", p.y, " Z", p.z
 
 
couleur = QtGui.QColorDialog.getColor()
 
if couleur.isValid():
 
    red  = int(str(couleur.name()[1:3]),16)    # decode hexadecimal to int()
 
    green = int(str(couleur.name()[3:5]),16)    # decode hexadecimal to int()
 
    blue  = int(str(couleur.name()[5:7]),16)    # decode hexadecimal to int()
 
 
 
     print couleur                              #
 
     print "hexadecimal ",couleur.name()        # color format hexadecimal mode 16
 
    print "Red  color ",red                    # color format decimal
 
    print "Green color ",green                  # color format decimal
 
    print "Blue  color ",blue                  # color format decimal
 
 
 
 
}}
 
}}
 
<translate>
 
<translate>
 
+
<!--T:45-->
==Some useful commands== <!--T:39-->
+
Other method display on "Int" and "Float"
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
# Here the code to display the icon on the '''pushButton''',
+
import Part
# change the name to another button, ('''radioButton, checkBox''') as well as the path to the icon,
+
from FreeCAD import Base
  
      # Displays an icon on the button PushButton
+
c=Part.makeCylinder(2,10)        # create the circle
      # self.image_01 = "C:\Program Files\FreeCAD0.13\icone01.png" # he name of the icon
+
Part.show(c)                     # display the shape
      self.image_01 = path+"icone01.png" # the name of the icon
 
      icon01 = QtGui.QIcon()
 
      icon01.addPixmap(QtGui.QPixmap(self.image_01),QtGui.QIcon.Normal, QtGui.QIcon.Off)
 
       self.pushButton.setIcon(icon01)
 
      self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button
 
  
 +
# slice accepts two arguments:
 +
#+ the normal of the cross section plane
 +
#+ the distance from the origin to the cross section plane. Here you have to find a value so that the plane intersects your object
 +
s=c.slice(Base.Vector(0,1,0),0)  #
  
# path = FreeCAD.ConfigGet("UserAppData") # gives the user path
+
# here the result is a single wire
  path = FreeCAD.ConfigGet("AppHomePath") # gives the installation path of FreeCAD
+
# depending on the source object this can be several wires
 +
s=s[0]
  
# This command reverses the horizontal button, right to left
+
# if you only need the vertexes of the shape you can use
self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the horizontal button
+
v=[]
 +
for i in s.Vertexes:
 +
    v.append(i.Point)
  
# Displays an info button
+
# but you can also sub-sample the section to have a certain number of points (int) ...
self.pushButton.setToolTip(_translate("MainWindow", "Quitter la fonction", None)) # Displays an info button
+
p1=s.discretize(20)
 +
ii=0
 +
for i in p1:
 +
    ii+=1
 +
    print i                                              # Vector()
 +
    print ii, ": X:", i.x, " Y:", i.y, " Z:", i.z        # Vector decode
 +
Draft.makeWire(p1,closed=False,face=False,support=None) # to see the difference accuracy (20)
  
# This function gives a color button
+
## uncomment to use
self.pushButton.setStyleSheet("background-color: red") # This function gives a color button
+
#import Draft
 +
#Draft.downgrade(App.ActiveDocument.ActiveObject,delete=True)  # first transform the DWire in Wire        "downgrade"
 +
#Draft.downgrade(App.ActiveDocument.ActiveObject,delete=True)  # second split the Wire in single objects  "downgrade"
 +
#
 +
##Draft.upgrade(FreeCADGui.Selection.getSelection(),delete=True) # to attach lines contiguous SELECTED use "upgrade"
  
# This function gives a color to the text of the button
 
self.pushButton.setStyleSheet("color : #ff0000") # This function gives a color to the text of the button
 
  
# combinaison des deux, bouton et texte
+
# ... or define a sampling distance (float)
self.pushButton.setStyleSheet("color : #ff0000; background-color : #0000ff;" ) # combination of the two, button, and text
+
p2=s.discretize(0.5)
 +
ii=0
 +
for i in p2:
 +
    ii+=1
 +
    print i                                              # Vector()
 +
    print ii, ": X:", i.x, " Y:", i.y, " Z:", i.z        # Vector decode
 +
Draft.makeWire(p2,closed=False,face=False,support=None) # to see the difference accuracy (0.5)
  
# replace the icon in the main window
+
## uncomment to use
MainWindow.setWindowIcon(QtGui.QIcon('C:\Program Files\FreeCAD0.13\View-C3P.png'))
+
#import Draft
 +
#Draft.downgrade(App.ActiveDocument.ActiveObject,delete=True)  # first transform the DWire in Wire        "downgrade"
 +
#Draft.downgrade(App.ActiveDocument.ActiveObject,delete=True)  # second split the Wire in single objects  "downgrade"
 +
#
 +
##Draft.upgrade(FreeCADGui.Selection.getSelection(),delete=True) # to attach lines contiguous SELECTED use "upgrade"
  
# connects a lineEdit on execute
 
self.lineEdit.returnPressed.connect(self.execute) # connects a lineEdit on "def execute" after validation on enter
 
# self.lineEdit.textChanged.connect(self.execute) # connects a lineEdit on "def execute" with each keystroke on the keyboard
 
 
# display text in a lineEdit
 
self.lineEdit.setText(str(val_X)) # Displays the value in the lineEdit (convert to string)
 
 
# extract the string contained in a lineEdit
 
val_X = self.lineEdit.text() # extract the (string) string contained in lineEdit
 
val_X = float(val_X0)        # converted the string to an floating
 
val_X = int(val_X0)          # convert the string to an integer
 
 
# This code allows you to change the font and its attributes
 
      font = QtGui.QFont()
 
      font.setFamily("Times New Roman")
 
      font.setPointSize(10)
 
      font.setWeight(10)
 
      font.setBold(True) # same result with tags "<b>your text</b>" (in quotes)
 
      self.label_6.setFont(font)
 
      self.label_6.setObjectName("label_6")
 
      self.label_6.setStyleSheet("color : #ff0000") # This function gives a color to the text
 
      self.label_6.setText(_translate("MainWindow", "Select a view", None))
 
 
}}
 
}}
 
<translate>
 
<translate>
 
+
===Select all objects in the document=== <!--T:46-->
<!--T:40-->
 
By using the characters with accents, where you get the error :
 
 
 
<!--T:42-->
 
<FONT COLOR="#FF0000">'''UnicodeDecodeError: 'utf8' codec can't decode bytes in position 0-2: invalid data'''</FONT>
 
 
 
<!--T:41-->
 
Several solutions are possible.
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
# conversion from a lineEdit
+
import FreeCAD
App.activeDocument().CopyRight.Text = str(unicode(self.lineEdit_20.text() , 'ISO-8859-1').encode('UTF-8'))
+
for obj in FreeCAD.ActiveDocument.Objects:
DESIGNED_BY = unicode(self.lineEdit_01.text(), 'ISO-8859-1').encode('UTF-8')
+
    print obj.Name                                # display the object Name
 +
    objName = obj.Name
 +
    obj = App.ActiveDocument.getObject(objName)
 +
    Gui.Selection.addSelection(obj)               # select the object
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:43-->
+
===Selecting a face of an object=== <!--T:49-->
or with the procedure
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
def utf8(unio):
+
# select one face of the object
    return unicode(unio).encode('UTF8')
+
import FreeCAD, Draft
 +
App=FreeCAD
 +
nameObject = "Box"                            # objet
 +
faceSelect = "Face3"                          # face to selection
 +
loch=App.ActiveDocument.getObject(nameObject)  # objet
 +
Gui.Selection.clearSelection()                # clear all selection
 +
Gui.Selection.addSelection(loch,faceSelect)   # select the face specified
 +
s = Gui.Selection.getSelectionEx()
 +
#Draft.makeFacebinder(s)                       #
 
}}
 
}}
 +
<translate>
 +
===Create one object to the position of the Camera=== <!--T:48-->
 +
</translate>
 +
{{Code|code=
 +
# create one object of the position to camera with "getCameraOrientation()"
 +
# the object is still facing the screen
 +
import Draft
  
<FONT COLOR="#FF0000">'''UnicodeEncodeError: 'ascii' codec can't encode character u'\xe9' in position 9: ordinal not in range(128)'''</FONT>
+
plan = FreeCADGui.ActiveDocument.ActiveView.getCameraOrientation()
 +
plan = str(plan)
 +
###### extract data
 +
a    = ""
 +
for i in plan:
 +
    if i in ("0123456789e.- "):
 +
        a+=i
 +
a = a.strip(" ")
 +
a = a.split(" ")
 +
####### extract data
  
 +
#print a
 +
#print a[0]
 +
#print a[1]
 +
#print a[2]
 +
#print a[3]
 +
 +
xP = float(a[0])
 +
yP = float(a[1])
 +
zP = float(a[2])
 +
qP = float(a[3])
 +
 +
pl = FreeCAD.Placement()
 +
pl.Rotation.Q = (xP,yP,zP,qP)        # rotation of object
 +
pl.Base = FreeCAD.Vector(0.0,0.0,0.0) # here coordinates XYZ of Object
 +
rec = Draft.makeRectangle(length=10.0,height=10.0,placement=pl,face=False,support=None) # create rectangle
 +
#rec = Draft.makeCircle(radius=5,placement=pl,face=False,support=None)                  # create circle
 +
print rec.Name
 +
}}
 +
<translate>
 +
<!--T:53-->
 +
here same code simplified
 +
</translate>
 
{{Code|code=
 
{{Code|code=
# conversion
+
import Draft
a = u"Nom de l'élément : "
+
pl = FreeCAD.Placement()
f.write('''a.encode('iso-8859-1')'''+str(element_)+"\n")
+
pl.Rotation = FreeCADGui.ActiveDocument.ActiveView.getCameraOrientation()
 +
pl.Base = FreeCAD.Vector(0.0,0.0,0.0)
 +
rec = Draft.makeRectangle(length=10.0,height=10.0,placement=pl,face=False,support=None)
 
}}
 
}}
 +
 
<translate>
 
<translate>
<!--T:44-->
+
=== Find normal vector on the surface === <!--T:56-->
or with the procedure
+
</translate>
 +
 
 +
<translate>
 +
<!--T:57-->
 +
This example show how to find normal vector on the surface by find the u,v parameters of one point on the surface and use u,v parameters to find normal vector
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
def iso8859(encoder):
+
def normal(self):
    return unicode(encoder).encode('iso-8859-1')
+
  ss=FreeCADGui.Selection.getSelectionEx()[0].SubObjects[0].copy()#SubObjects[0] is the edge list
 +
  points  = ss.discretize(3.0)#points on the surface edge,
 +
            #this example just use points on the edge for example.
 +
            #However point is not necessary on the edge, it can be anywhere on the surface.
 +
  face=FreeCADGui.Selection.getSelectionEx()[0].SubObjects[1]
 +
  for pp in points:
 +
      pt=FreeCAD.Base.Vector(pp.x,pp.y,pp.z)#a point on the surface edge
 +
      uv=face.Surface.parameter(pt)# find the surface u,v parameter of a point on the surface edge
 +
      u=uv[0]
 +
      v=uv[1]
 +
      normal=face.normalAt(u,v)#use u,v to find normal vector
 +
      print normal
 +
      line=Part.makeLine((pp.x,pp.y,pp.z), (normal.x,normal.y,normal.z))
 +
      Part.show(line)
 
}}
 
}}
 
<translate>
 
<translate>
<!--T:45-->
+
===Read And write one Expression=== <!--T:59-->
or
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
iso8859(unichr(176))
+
import Draft
 +
doc = FreeCAD.ActiveDocument
 +
 
 +
pl=FreeCAD.Placement()
 +
pl.Rotation.Q=(0.0,-0.0,-0.0,1.0)
 +
pl.Base=FreeCAD.Vector(0.0,0.0,0.0)
 +
obj = Draft.makeCircle(radius=1.0,placement=pl,face=False,support=None)    # create circle
 +
 
 +
print obj.PropertiesList                                                  # properties disponible in the obj
 +
 
 +
doc.getObject(obj.Name).setExpression('Radius', u'2mm')                    # modify the radius
 +
doc.getObject(obj.Name).setExpression('Placement.Base.x', u'10mm')        # modify the placement
 +
doc.getObject(obj.Name).setExpression('FirstAngle', u'90')                # modify the first angle
 +
doc.recompute()
 +
 
 +
expressions = obj.ExpressionEngine                                        # read the expression list
 +
print expressions
 +
 
 +
for i in expressions:                                                      # list and separate the data expression
 +
    print i[0]," = ",i[1]
 +
 
 
}}
 
}}
 +
 
<translate>
 
<translate>
<!--T:46-->
+
 
or
+
===Get the normal vector of a suface from a STL file=== <!--T:73-->
 
</translate>
 
</translate>
 +
 
{{Code|code=
 
{{Code|code=
unichr(ord(176))
+
def getNormal(cb):
 +
    if cb.getEvent().getState() == coin.SoButtonEvent.UP:
 +
        pp = cb.getPickedPoint()
 +
        if pp:
 +
            vec = pp.getNormal().getValue()
 +
            index = coin.cast(pp.getDetail(), "SoFaceDetail").getFaceIndex()
 +
            print ("Normal: {}, Face index: {}".format(str(vec), index))
 +
 
 +
from pivy import coin
 +
meth=Gui.ActiveDocument.ActiveView.addEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), getNormal)
 
}}
 
}}
 +
 
<translate>
 
<translate>
<!--T:47-->
+
<!--T:74-->
or
+
you are done then run for quit:
 
</translate>
 
</translate>
 +
 
{{Code|code=
 
{{Code|code=
uniteSs = "mm"+iso8859(unichr(178))
+
Gui.ActiveDocument.ActiveView.removeEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), meth)
print unicode(uniteSs, 'iso8859')
 
 
}}
 
}}
 +
 
<translate>
 
<translate>
 +
<!--T:34-->
 +
{{docnav|[[Embedding FreeCAD|Embedding FreeCAD]]|[[Line drawing function|Line drawing function]]}}
  
 +
<!--T:70-->
 +
{{Userdocnavi}}
  
<!--T:48-->
+
<!--T:35-->
{{docnav|Line drawing function|Licence}}
+
[[Category:Poweruser Documentation]]
  
<!--T:49-->
+
<!--T:71-->
[[Category:Poweruser Documentation]]
 
 
[[Category:Python Code]]
 
[[Category:Python Code]]
 +
 +
<!--T:72-->
 +
[[Category:Tutorials]]
  
 
</translate>
 
</translate>
 
{{clear}}
 
{{clear}}

Latest revision as of 08:56, 27 August 2019

Other languages:
čeština • ‎Deutsch • ‎English • ‎español • ‎français • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎polski • ‎română • ‎русский • ‎svenska • ‎Türkçe
Base ExampleCommandModel.png Tutorial
Topic
Python
Level
Beginner
Time to complete
Author
FreeCAD version
Example files


This page contains examples, pieces, chunks of FreeCAD python code collected from users experiences and discussions on the forums. Read and use it as a start for your own scripts...

A typical InitGui.py file

Every module must contain, besides your main module file, an InitGui.py file, responsible for inserting the module in the main Gui. This is an example of a simple one.

class ScriptWorkbench (Workbench): 
    MenuText = "Scripts"
    def Initialize(self):
        import Scripts # assuming Scripts.py is your module
        list = ["Script_Cmd"] # That list must contain command names, that can be defined in Scripts.py
        self.appendToolbar("My Scripts",list) 
        
Gui.addWorkbench(ScriptWorkbench())

A typical module file

This is an example of a main module file, containing everything your module does. It is the Scripts.py file invoked by the previous example. You can have all your custom commands here.

import FreeCAD, FreeCADGui 
 
class ScriptCmd: 
   def Activated(self): 
       # Here your write what your ScriptCmd does...
       FreeCAD.Console.PrintMessage('Hello, World!')
   def GetResources(self): 
       return {'Pixmap' : 'path_to_an_icon/myicon.png', 'MenuText': 'Short text', 'ToolTip': 'More detailed text'} 
       
FreeCADGui.addCommand('Script_Cmd', ScriptCmd())

Import a new filetype

Making an importer for a new filetype in FreeCAD is easy. FreeCAD doesn't consider that you import data in an opened document, but rather that you simply can directly open the new filetype. So what you need to do is to add the new file extension to FreeCAD's list of known extensions, and write the code that will read the file and create the FreeCAD objects you want:

This line must be added to the InitGui.py file to add the new file extension to the list:

# Assumes Import_Ext.py is the file that has the code for opening and reading .ext files
FreeCAD.addImportType("Your new File Type (*.ext)","Import_Ext")

Then in the Import_Ext.py file:

def open(filename): 
   doc=App.newDocument()
   # here you do all what is needed with filename, read, classify data, create corresponding FreeCAD objects
   doc.recompute()

To export your document to some new filetype works the same way, except that you use:

FreeCAD.addExportType("Your new File Type (*.ext)","Export_Ext") 

Adding a line

A line simply has 2 points.

import Part,PartGui 
doc=App.activeDocument() 
# add a line element to the document and set its points 
l=Part.LineSegment()
l.StartPoint=(0.0,0.0,0.0)
l.EndPoint=(1.0,1.0,1.0)
doc.addObject("Part::Feature","Line").Shape=l.toShape() 
doc.recompute()

Adding a polygon

A polygon is simply a set of connected line segments (a polyline in AutoCAD). It doesn't need to be closed.

import Part,PartGui 
doc=App.activeDocument()
n=list() 
# create a 3D vector, set its coordinates and add it to the list 
v=App.Vector(0,0,0) 
n.append(v) 
v=App.Vector(10,0,0) 
n.append(v) 
#... repeat for all nodes 
# Create a polygon object and set its nodes 
p=doc.addObject("Part::Polygon","Polygon") 
p.Nodes=n 
doc.recompute()

Adding and removing an object to a group

doc=App.activeDocument() 
grp=doc.addObject("App::DocumentObjectGroup", "Group") 
lin=doc.addObject("Part::Feature", "Line")
grp.addObject(lin) # adds the lin object to the group grp
grp.removeObject(lin) # removes the lin object from the group grp

Note: You can even add other groups to a group...

Adding a Mesh

import Mesh
doc=App.activeDocument()
# create a new empty mesh
m = Mesh.Mesh()
# build up box out of 12 facets
m.addFacet(0.0,0.0,0.0, 0.0,0.0,1.0, 0.0,1.0,1.0)
m.addFacet(0.0,0.0,0.0, 0.0,1.0,1.0, 0.0,1.0,0.0)
m.addFacet(0.0,0.0,0.0, 1.0,0.0,0.0, 1.0,0.0,1.0)
m.addFacet(0.0,0.0,0.0, 1.0,0.0,1.0, 0.0,0.0,1.0)
m.addFacet(0.0,0.0,0.0, 0.0,1.0,0.0, 1.0,1.0,0.0)
m.addFacet(0.0,0.0,0.0, 1.0,1.0,0.0, 1.0,0.0,0.0)
m.addFacet(0.0,1.0,0.0, 0.0,1.0,1.0, 1.0,1.0,1.0)
m.addFacet(0.0,1.0,0.0, 1.0,1.0,1.0, 1.0,1.0,0.0)
m.addFacet(0.0,1.0,1.0, 0.0,0.0,1.0, 1.0,0.0,1.0)
m.addFacet(0.0,1.0,1.0, 1.0,0.0,1.0, 1.0,1.0,1.0)
m.addFacet(1.0,1.0,0.0, 1.0,1.0,1.0, 1.0,0.0,1.0)
m.addFacet(1.0,1.0,0.0, 1.0,0.0,1.0, 1.0,0.0,0.0)
# scale to a edge langth of 100
m.scale(100.0)
# add the mesh to the active document
me=doc.addObject("Mesh::Feature","Cube")
me.Mesh=m

Adding an arc or a circle

import Part
doc = App.activeDocument()
c = Part.Circle() 
c.Radius=10.0  
f = doc.addObject("Part::Feature", "Circle") # create a document with a circle feature 
f.Shape = c.toShape() # Assign the circle shape to the shape property 
doc.recompute()

Accessing and changing representation of an object

Each object in a FreeCAD document has an associated view representation object that stores all the parameters that define how the object appear, like color, linewidth, etc...

gad=Gui.activeDocument()   # access the active document containing all 
                          # view representations of the features in the
                          # corresponding App document 

v=gad.getObject("Cube")    # access the view representation to the Mesh feature 'Cube' 
v.ShapeColor               # prints the color to the console 
v.ShapeColor=(1.0,1.0,1.0) # sets the shape color to white

Observing mouse events in the 3D viewer via Python

The Inventor framework allows to add one or more callback nodes to the scenegraph of the viewer. By default in FreeCAD one callback node is installed per viewer which allows to add global or static C++ functions. In the appropriate Python binding some methods are provided to make use of this technique from within Python code.

App.newDocument()
v=Gui.activeDocument().activeView()
 
#This class logs any mouse button events. As the registered callback function fires twice for 'down' and
#'up' events we need a boolean flag to handle this.
class ViewObserver:
   def logPosition(self, info):
       down = (info["State"] == "DOWN")
       pos = info["Position"]
       if (down):
           FreeCAD.Console.PrintMessage("Clicked on position: ("+str(pos[0])+", "+str(pos[1])+")\n")
       
o = ViewObserver()
c = v.addEventCallback("SoMouseButtonEvent",o.logPosition)

Now, pick somewhere on the area in the 3D viewer and observe the messages in the output window. To finish the observation just call

v.removeEventCallback("SoMouseButtonEvent",c)

The following event types are supported

  • SoEvent -- all kind of events
  • SoButtonEvent -- all mouse button and key events
  • SoLocation2Event -- 2D movement events (normally mouse movements)
  • SoMotion3Event -- 3D movement events (normally spaceball)
  • SoKeyboardEvent -- key down and up events
  • SoMouseButtonEvent -- mouse button down and up events
  • SoSpaceballButtonEvent -- spaceball button down and up events

The Python function that can be registered with addEventCallback() expects a dictionary. Depending on the watched event the dictionary can contain different keys.

For all events it has the keys:

  • Type -- the name of the event type i.e. SoMouseEvent, SoLocation2Event, ...
  • Time -- the current time as string
  • Position -- a tuple of two integers, mouse position
  • ShiftDown -- a boolean, true if Shift was pressed otherwise false
  • CtrlDown -- a boolean, true if Ctrl was pressed otherwise false
  • AltDown -- a boolean, true if Alt was pressed otherwise false

For all button events, i.e. keyboard, mouse or spaceball events

  • State -- A string 'UP' if the button was up, 'DOWN' if it was down or 'UNKNOWN' for all other cases

For keyboard events:

  • Key -- a character of the pressed key

For mouse button event

  • Button -- The pressed button, could be BUTTON1, ..., BUTTON5 or ANY

For spaceball events:

  • Button -- The pressed button, could be BUTTON1, ..., BUTTON7 or ANY

And finally motion events:

  • Translation -- a tuple of three floats
  • Rotation -- a quaternion for the rotation, i.e. a tuple of four floats

Display keys pressed and Events command

This macro displays in the report view the keys pressed and all events command

App.newDocument()
v=Gui.activeDocument().activeView()
class ViewObserver:
   def logPosition(self, info):
       try:
           down = (info["Key"])
           FreeCAD.Console.PrintMessage(str(down)+"\n") # here the character pressed
           FreeCAD.Console.PrintMessage(str(info)+"\n") # list all events command
           FreeCAD.Console.PrintMessage("_______________________________________"+"\n")
       except Exception:
           None
 
o = ViewObserver()
c = v.addEventCallback("SoEvent",o.logPosition)

#v.removeEventCallback("SoEvent",c) # remove ViewObserver

Manipulate the scenegraph in Python

It is also possible to get and change the scenegraph in Python, with the 'pivy' module -- a Python binding for Coin.

from pivy.coin import *                # load the pivy module
view = Gui.ActiveDocument.ActiveView   # get the active viewer
root = view.getSceneGraph()            # the root is an SoSeparator node
root.addChild(SoCube())
view.fitAll()

The Python API of pivy is created by using the tool SWIG. As we use in FreeCAD some self-written nodes you cannot create them directly in Python. However, it is possible to create a node by its internal name. An instance of the type 'SoFCSelection' can be created with

type = SoType.fromName("SoFCSelection")
node = type.createInstance()

Adding and removing objects to/from the scenegraph

Adding new nodes to the scenegraph can be done this way. Take care of always adding a SoSeparator to contain the geometry, coordinates and material info of a same object. The following example adds a red line from (0,0,0) to (10,0,0):

from pivy import coin
sg = Gui.ActiveDocument.ActiveView.getSceneGraph()
co = coin.SoCoordinate3()
pts = [[0,0,0],[10,0,0]]
co.point.setValues(0,len(pts),pts)
ma = coin.SoBaseColor()
ma.rgb = (1,0,0)
li = coin.SoLineSet()
li.numVertices.setValue(2)
no = coin.SoSeparator()
no.addChild(co)
no.addChild(ma)
no.addChild(li)
sg.addChild(no)

To remove it, simply issue:

sg.removeChild(no)

Saves the sceneGraph with a rotation in a series of 36 files in the X Y Z axis

import math
import time
from FreeCAD import Base
from pivy import coin

size=(1000,1000)
dirname = "C:/Temp/animation/"
steps=36
angle=2*math.pi/steps

matX=Base.Matrix()
matX.rotateX(angle)
stepsX=Base.Placement(matX).Rotation

matY=Base.Matrix()
matY.rotateY(angle)
stepsY=Base.Placement(matY).Rotation

matZ=Base.Matrix()
matZ.rotateZ(angle)
stepsZ=Base.Placement(matZ).Rotation

view=Gui.ActiveDocument.ActiveView
cam=view.getCameraNode()
rotCamera=Base.Rotation(*cam.orientation.getValue().getValue())

# this sets the lookat point to the center of circumsphere of the global bounding box
view.fitAll()

# the camera's position, i.e. the user's eye point
position=Base.Vector(*cam.position.getValue().getValue())
distance=cam.focalDistance.getValue()

# view direction
vec=rotCamera.multVec(Base.Vector(0,0,-1))

# this is the point on the screen the camera looks at
# when rotating the camera we should make this point fix
lookat=position+vec*distance

# around x axis
for i in range(steps):
    rotCamera=stepsX.multiply(rotCamera)
    cam.orientation.setValue(*rotCamera.Q)
    vec=rotCamera.multVec(Base.Vector(0,0,-1))
    pos=lookat-vec*distance
    cam.position.setValue(pos.x,pos.y,pos.z)
    Gui.updateGui()
    time.sleep(0.3)
    view.saveImage(dirname+"x-%d.png" % i,*size)

# around y axis
for i in range(steps):
    rotCamera=stepsY.multiply(rotCamera)
    cam.orientation.setValue(*rotCamera.Q)
    vec=rotCamera.multVec(Base.Vector(0,0,-1))
    pos=lookat-vec*distance
    cam.position.setValue(pos.x,pos.y,pos.z)
    Gui.updateGui()
    time.sleep(0.3)
    view.saveImage(dirname+"y-%d.png" % i,*size)

# around z axis
for i in range(steps):
    rotCamera=stepsZ.multiply(rotCamera)
    cam.orientation.setValue(*rotCamera.Q)
    vec=rotCamera.multVec(Base.Vector(0,0,-1))
    pos=lookat-vec*distance
    cam.position.setValue(pos.x,pos.y,pos.z)
    Gui.updateGui()
    time.sleep(0.3)
    view.saveImage(dirname+"z-%d.png" % i,*size)

Adding custom widgets to the interface

You can create custom widgets with Qt designer, transform them into a python script, and then load them into the FreeCAD interface with PySide.

The python code produced by the Ui python compiler (the tool that converts qt-designer .ui files into python code) generally looks like this (it is simple, you can also code it directly in python):

class myWidget_Ui(object):
    def setupUi(self, myWidget):
        myWidget.setObjectName("my Nice New Widget")
        myWidget.resize(QtCore.QSize(QtCore.QRect(0,0,300,100).size()).expandedTo(myWidget.minimumSizeHint())) # sets size of the widget
 
        self.label = QtGui.QLabel(myWidget) # creates a label
        self.label.setGeometry(QtCore.QRect(50,50,200,24)) # sets its size
        self.label.setObjectName("label") # sets its name, so it can be found by name

    def retranslateUi(self, draftToolbar): # built-in QT function that manages translations of widgets
        myWidget.setWindowTitle(QtGui.QApplication.translate("myWidget", "My Widget", None, QtGui.QApplication.UnicodeUTF8))
        self.label.setText(QtGui.QApplication.translate("myWidget", "Welcome to my new widget!", None, QtGui.QApplication.UnicodeUTF8))

Then, all you need to do is to create a reference to the FreeCAD Qt window, insert a custom widget into it, and "transform" this widget into yours with the Ui code we just made:

app = QtGui.qApp
FCmw = app.activeWindow() # the active qt window, = the freecad window since we are inside it
# FCmw = FreeCADGui.getMainWindow() # use this line if the 'addDockWidget' error is declared
myNewFreeCADWidget = QtGui.QDockWidget() # create a new dckwidget
myNewFreeCADWidget.ui = myWidget_Ui() # load the Ui script
myNewFreeCADWidget.ui.setupUi(myNewFreeCADWidget) # setup the ui
FCmw.addDockWidget(QtCore.Qt.RightDockWidgetArea,myNewFreeCADWidget) # add the widget to the main window

Adding a Tab to the Combo View

The following code allows you to add a tab to the FreeCAD ComboView, besides the "Project" and "Tasks" tabs. It also uses the uic module to load an ui file directly in that tab.

# create new Tab in ComboView
from PySide import QtGui,QtCore
#from PySide import uic

def getMainWindow():
   "returns the main window"
   # using QtGui.qApp.activeWindow() isn't very reliable because if another
   # widget than the mainwindow is active (e.g. a dialog) the wrong widget is
   # returned
   toplevel = QtGui.qApp.topLevelWidgets()
   for i in toplevel:
       if i.metaObject().className() == "Gui::MainWindow":
           return i
   raise Exception("No main window found")

def getComboView(mw):
   dw=mw.findChildren(QtGui.QDockWidget)
   for i in dw:
       if str(i.objectName()) == "Combo View":
           return i.findChild(QtGui.QTabWidget)
       elif str(i.objectName()) == "Python Console":
           return i.findChild(QtGui.QTabWidget)
   raise Exception ("No tab widget found")

mw = getMainWindow()
tab = getComboView(getMainWindow())
tab2=QtGui.QDialog()
tab.addTab(tab2,"A Special Tab")

#uic.loadUi("/myTaskPanelforTabs.ui",tab2)
tab2.show()
#tab.removeTab(2)

Enable or disable a window

from PySide import QtGui
mw=FreeCADGui.getMainWindow()
dws=mw.findChildren(QtGui.QDockWidget)

# objectName may be :
# "Report view"
# "Tree view"
# "Property view"
# "Selection view"
# "Combo View"
# "Python console"
# "draftToolbar"

for i in dws:
  if i.objectName() == "Report view":
    dw=i
    break

va=dw.toggleViewAction()
va.setChecked(True)        # True or False
dw.setVisible(True)        # True or False

Opening a custom webpage

import WebGui
WebGui.openBrowser("http://www.example.com")

Getting the HTML contents of an opened webpage

from PySide import QtGui,QtWebKit
a = QtGui.qApp
mw = a.activeWindow()
v = mw.findChild(QtWebKit.QWebFrame)
html = unicode(v.toHtml())
print html

Retrieve and use the coordinates of 3 selected points or objects

# -*- coding: utf-8 -*-
# the line above to put the accentuated in the remarks
# If this line is missing, an error will be returned
# extract and use the coordinates of 3 objects selected
import Part, FreeCAD, math, PartGui, FreeCADGui
from FreeCAD import Base, Console
sel = FreeCADGui.Selection.getSelection() # " sel " contains the items selected
if len(sel)!=3 :
  # If there are no 3 objects selected, an error is displayed in the report view
  # The \r and \n at the end of line mean return and the newline CR + LF.
  Console.PrintError("Select 3 points exactly\r\n")
else :
  points=[]
  for obj in sel:
    points.append(obj.Shape.BoundBox.Center)

  for pt in points:
    # display of the coordinates in the report view
    Console.PrintMessage(str(pt.x)+"\r\n")
    Console.PrintMessage(str(pt.y)+"\r\n")
    Console.PrintMessage(str(pt.z)+"\r\n")

  Console.PrintMessage(str(pt[1]) + "\r\n")

List all objects

# -*- coding: utf-8 -*-
import FreeCAD,Draft
# List all objects of the document
doc = FreeCAD.ActiveDocument
objs = FreeCAD.ActiveDocument.Objects
#App.Console.PrintMessage(str(objs) + "\n")
#App.Console.PrintMessage(str(len(FreeCAD.ActiveDocument.Objects)) + " Objects"  + "\n")

for obj in objs:
    a = obj.Name                                             # list the Name  of the object  (not modifiable)
    b = obj.Label                                            # list the Label of the object  (modifiable)
    try:
        c = obj.LabelText                                    # list the LabeText of the text (modifiable)
        App.Console.PrintMessage(str(a) +" "+ str(b) +" "+ str(c) + "\n") # Displays the Name the Label and the text
    except:
        App.Console.PrintMessage(str(a) +" "+ str(b) + "\n") # Displays the Name and the Label of the object

#doc.removeObject("Box") # Clears the designated object

List the dimensions of an object, given its name

for edge in FreeCAD.ActiveDocument.MyObjectName.Shape.Edges: # replace "MyObjectName" for list
    print edge.Length


Function resident with the mouse click action

Here with SelObserver on a object select

# -*- coding: utf-8 -*-
# causes an action to the mouse click on an object
# This function remains resident (in memory) with the function "addObserver(s)"
# "removeObserver(s) # Uninstalls the resident function
class SelObserver:
    def setPreselection(self,doc,obj,sub):                # Preselection object
        App.Console.PrintMessage(str(sub)+ "\n")          # The part of the object name

    def addSelection(self,doc,obj,sub,pnt):               # Selection object
        App.Console.PrintMessage("addSelection"+ "\n")
        App.Console.PrintMessage(str(doc)+ "\n")          # Name of the document
        App.Console.PrintMessage(str(obj)+ "\n")          # Name of the object
        App.Console.PrintMessage(str(sub)+ "\n")          # The part of the object name
        App.Console.PrintMessage(str(pnt)+ "\n")          # Coordinates of the object
        App.Console.PrintMessage("______"+ "\n")

    def removeSelection(self,doc,obj,sub):                # Delete the selected object
        App.Console.PrintMessage("removeSelection"+ "\n")

    def setSelection(self,doc):                           # Selection in ComboView
        App.Console.PrintMessage("setSelection"+ "\n")

    def clearSelection(self,doc):                         # If click on the screen, clear the selection
        App.Console.PrintMessage("clearSelection"+ "\n")  # If click on another object, clear the previous object
s =SelObserver()
FreeCADGui.Selection.addObserver(s)                       # install the function mode resident
#FreeCADGui.Selection.removeObserver(s)                   # Uninstall the resident function

Other example with ViewObserver on a object select or view

App.newDocument()
v=Gui.activeDocument().activeView()
 
#This class logs any mouse button events. As the registered callback function fires twice for 'down' and
#'up' events we need a boolean flag to handle this.
class ViewObserver:
   def __init__(self, view):
       self.view = view
   
   def logPosition(self, info):
       down = (info["State"] == "DOWN")
       pos = info["Position"]
       if (down):
           FreeCAD.Console.PrintMessage("Clicked on position: ("+str(pos[0])+", "+str(pos[1])+")\n")
           pnt = self.view.getPoint(pos)
           FreeCAD.Console.PrintMessage("World coordinates: " + str(pnt) + "\n")
           info = self.view.getObjectInfo(pos)
           FreeCAD.Console.PrintMessage("Object info: " + str(info) + "\n")

o = ViewObserver(v)
c = v.addEventCallback("SoMouseButtonEvent",o.logPosition)

Finding-selecting all elements below cursor

from pivy import coin
import FreeCADGui

def mouse_over_cb( event_callback):
    event = event_callback.getEvent()
    pos = event.getPosition().getValue()
    listObjects = FreeCADGui.ActiveDocument.ActiveView.getObjectsInfo((int(pos[0]),int(pos[1])))
    obj = []
    if listObjects:
        FreeCAD.Console.PrintMessage("\n *** Objects under mouse pointer ***")
        for o in listObjects:
            label = str(o["Object"])
            if not label in obj:
                obj.append(label)
        FreeCAD.Console.PrintMessage("\n"+str(obj))


view = FreeCADGui.ActiveDocument.ActiveView

mouse_over = view.addEventCallbackPivy( coin.SoLocation2Event.getClassTypeId(), mouse_over_cb )

# to remove Callback :
#view.removeEventCallbackPivy( coin.SoLocation2Event.getClassTypeId(), mouse_over)

####
#The easy way is probably to use FreeCAD's selection.
#FreeCADGui.ActiveDocument.ActiveView.getObjectsInfo(mouse_coords)

####
#you get that kind of result :
#'Document': 'Unnamed', 'Object': 'Box', 'Component': 'Face2', 'y': 8.604081153869629, 'x': 21.0, 'z': 8.553047180175781

####
#You can use this data to add your element to FreeCAD's selection :
#FreeCADGui.Selection.addSelection(FreeCAD.ActiveDocument.Box,'Face2',21.0,8.604081153869629,8.553047180175781)

List the components of an object

# -*- coding: utf-8 -*-
# This function list the components of an object
# and extract this object its XYZ coordinates,
# its edges and their lengths center of mass and coordinates
# its faces and their center of mass
# its faces and their surfaces and coordinates
# 8/05/2014

import Draft,Part
def detail():
    sel = FreeCADGui.Selection.getSelection()   # Select an object
    if len(sel) != 0:                           # If there is a selection then
        Vertx=[]
        Edges=[]
        Faces=[]
        compt_V=0
        compt_E=0
        compt_F=0
        pas    =0
        perimetre = 0.0   
        EdgesLong = []

        # Displays the "Name" and the "Label" of the selection
        App.Console.PrintMessage("Selection > " + str(sel[0].Name) + "  " + str(sel[0].Label) +"\n"+"\n")

        for j in enumerate(sel[0].Shape.Edges):                                     # Search the "Edges" and their lengths
            compt_E+=1
            Edges.append("Edge%d" % (j[0]+1))
            EdgesLong.append(str(sel[0].Shape.Edges[compt_E-1].Length))
            perimetre += (sel[0].Shape.Edges[compt_E-1].Length)                     # calculates the perimeter

            # Displays the "Edge" and its length
            App.Console.PrintMessage("Edge"+str(compt_E)+" Length > "+str(sel[0].Shape.Edges[compt_E-1].Length)+"\n")

            # Displays the "Edge" and its center mass
            App.Console.PrintMessage("Edge"+str(compt_E)+" Center > "+str(sel[0].Shape.Edges[compt_E-1].CenterOfMass)+"\n")

            num = sel[0].Shape.Edges[compt_E-1].Vertexes[0]
            Vertx.append("X1: "+str(num.Point.x))
            Vertx.append("Y1: "+str(num.Point.y))
            Vertx.append("Z1: "+str(num.Point.z))
            # Displays the coordinates 1
            App.Console.PrintMessage("X1: "+str(num.Point[0])+" Y1: "+str(num.Point[1])+" Z1: "+str(num.Point[2])+"\n")

            try:
                num = sel[0].Shape.Edges[compt_E-1].Vertexes[1]
                Vertx.append("X2: "+str(num.Point.x))
                Vertx.append("Y2: "+str(num.Point.y))
                Vertx.append("Z2: "+str(num.Point.z))
            except:
                Vertx.append("-")
                Vertx.append("-")
                Vertx.append("-")
            # Displays the coordinates 2
            App.Console.PrintMessage("X2: "+str(num.Point[0])+" Y2: "+str(num.Point[1])+" Z2: "+str(num.Point[2])+"\n")

            App.Console.PrintMessage("\n")
        App.Console.PrintMessage("Perimeter of the form  : "+str(perimetre)+"\n") 

        App.Console.PrintMessage("\n")
        FacesSurf = []
        for j in enumerate(sel[0].Shape.Faces):                                      # Search the "Faces" and their surface
            compt_F+=1
            Faces.append("Face%d" % (j[0]+1))
            FacesSurf.append(str(sel[0].Shape.Faces[compt_F-1].Area))

            # Displays 'Face' and its surface
            App.Console.PrintMessage("Face"+str(compt_F)+" >  Surface "+str(sel[0].Shape.Faces[compt_F-1].Area)+"\n")

            # Displays 'Face' and its CenterOfMass
            App.Console.PrintMessage("Face"+str(compt_F)+" >  Center  "+str(sel[0].Shape.Faces[compt_F-1].CenterOfMass)+"\n")

            # Displays 'Face' and its Coordinates
            FacesCoor = []
            fco = 0
            for f0 in sel[0].Shape.Faces[compt_F-1].Vertexes:                        # Search the Vertexes of the face
                fco += 1
                FacesCoor.append("X"+str(fco)+": "+str(f0.Point.x))
                FacesCoor.append("Y"+str(fco)+": "+str(f0.Point.y))
                FacesCoor.append("Z"+str(fco)+": "+str(f0.Point.z))

            # Displays 'Face' and its Coordinates
            App.Console.PrintMessage("Face"+str(compt_F)+" >  Coordinate"+str(FacesCoor)+"\n")

            # Displays 'Face' and its Volume
            App.Console.PrintMessage("Face"+str(compt_F)+" >  Volume  "+str(sel[0].Shape.Faces[compt_F-1].Volume)+"\n")
            App.Console.PrintMessage("\n")

        # Displays the total surface of the form
        App.Console.PrintMessage("Surface of the form    : "+str(sel[0].Shape.Area)+"\n")

        # Displays the total Volume of the form
        App.Console.PrintMessage("Volume  of the form    : "+str(sel[0].Shape.Volume)+"\n")

detail()

List the PropertiesList

import FreeCADGui
from FreeCAD import Console
o = App.ActiveDocument.ActiveObject
op = o.PropertiesList
for p in op:
    Console.PrintMessage("Property: "+ str(p)+ " Value: " + str(o.getPropertyByName(p))+"\r\n")

Adding one Property "Comment"

import Draft
obj = FreeCADGui.Selection.getSelection()[0]
obj.addProperty("App::PropertyString","GComment","Draft","Font name").GComment = "Comment here"
App.activeDocument().recompute()

Search and data extraction

Examples of research and decoding information on an object.

Each section is independently and is separated by "############" can be copied directly into the Python console, or in a macro or use this macro. The description of the macro in the commentary.

Displaying it in the "View Report" window (View > Views > View report)

# -*- coding: utf-8 -*-
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
 
# Exemples de recherche et de decodage d'informations sur un objet
# Chaque section peut etre copiee directement dans la console Python ou dans une macro ou utilisez la macro tel quel
# Certaines commandes se repetent seul l'approche est differente
# L'affichage se fait dans la Vue rapport : Menu Affichage > Vues > Vue rapport
#
# Examples of research and decoding information on an object
# Each section can be copied directly into the Python console, or in a macro or uses this macro
# Certain commands as repeat alone approach is different
# Displayed on Report view : Menu View > Views > report view
#
# rev:30/08/2014:29/09/2014:17/09/2015
 
from FreeCAD import Base
import DraftVecUtils, Draft, Part
 
mydoc = FreeCAD.activeDocument().Name                                     # Name of active Document
App.Console.PrintMessage("Active docu    : "+(mydoc)+"\n")
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
object_Label = sel[0].Label                                               # Label of the object (modifiable)
App.Console.PrintMessage("object_Label   : "+(object_Label)+"\n")
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
App.Console.PrintMessage("sel            : "+str(sel[0])+"\n\n")          # sel[0] first object selected
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
object_Name  = sel[0].Name                                                # Name of the object (not modifiable)
App.Console.PrintMessage("object_Name    : "+str(object_Name)+"\n\n")
##################################################################################
 
try:
    SubElement = FreeCADGui.Selection.getSelectionEx()                    # sub element name with getSelectionEx()
    element_ = SubElement[0].SubElementNames[0]                           # name of 1 element selected
    App.Console.PrintMessage("elementSelec   : "+str(element_)+"\n\n")            
except:
    App.Console.PrintMessage("Oups"+"\n\n")            
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
App.Console.PrintMessage("sel            : "+str(sel[0])+"\n\n")          # sel[0] first object selected
##################################################################################
 
SubElement = FreeCADGui.Selection.getSelectionEx()                        # sub element name with getSelectionEx()
App.Console.PrintMessage("SubElement     : "+str(SubElement[0])+"\n\n")   # name of sub element
##################################################################################

SubElement = Gui.Selection.getSelectionEx()[0].SubObjects[0].Length       # sub element or element name with getSelectionEx()
App.Console.PrintMessage("SubElement length: "+str(length)+"\n")          # length
##################################################################################

sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
i = 0
for j in enumerate(sel[0].Shape.Edges):                                   # list all Edges
    i += 1
    App.Console.PrintMessage("Edges n : "+str(i)+"\n")
    a = sel[0].Shape.Edges[j[0]].Vertexes[0]
    App.Console.PrintMessage("X1             : "+str(a.Point.x)+"\n")     # coordinate XYZ first point
    App.Console.PrintMessage("Y1             : "+str(a.Point.y)+"\n")
    App.Console.PrintMessage("Z1             : "+str(a.Point.z)+"\n")
    try:
        a = sel[0].Shape.Edges[j[0]].Vertexes[1]
        App.Console.PrintMessage("X2             : "+str(a.Point.x)+"\n") # coordinate XYZ second point
        App.Console.PrintMessage("Y2             : "+str(a.Point.y)+"\n")
        App.Console.PrintMessage("Z2             : "+str(a.Point.z)+"\n")
    except:
        App.Console.PrintMessage("Oups"+"\n")    
App.Console.PrintMessage("\n")    
##################################################################################
 
try:
    SubElement = FreeCADGui.Selection.getSelectionEx()                                        # sub element name with getSelectionEx()
    subElementName = Gui.Selection.getSelectionEx()[0].SubElementNames[0]                     # sub element name with getSelectionEx()
    App.Console.PrintMessage("subElementName : "+str(subElementName)+"\n")
    
    subObjectLength = Gui.Selection.getSelectionEx()[0].SubObjects[0].Length                  # sub element Length
    App.Console.PrintMessage("subObjectLength: "+str(subObjectLength)+"\n\n")
    
    subObjectX1 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[0].Point.x         # sub element coordinate X1
    App.Console.PrintMessage("subObject_X1   : "+str(subObjectX1)+"\n")
    subObjectY1 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[0].Point.y         # sub element coordinate Y1
    App.Console.PrintMessage("subObject_Y1   : "+str(subObjectY1)+"\n")
    subObjectZ1 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[0].Point.z         # sub element coordinate Z1
    App.Console.PrintMessage("subObject_Z1   : "+str(subObjectZ1)+"\n\n")

    try:
        subObjectX2 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[1].Point.x     # sub element coordinate X2
        App.Console.PrintMessage("subObject_X2   : "+str(subObjectX2)+"\n")
        subObjectY2 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[1].Point.y     # sub element coordinate Y2
        App.Console.PrintMessage("subObject_Y2   : "+str(subObjectY2)+"\n")
        subObjectZ2 = Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[1].Point.z     # sub element coordinate Z2
        App.Console.PrintMessage("subObject_Z2   : "+str(subObjectZ2)+"\n\n")
    except:
        App.Console.PrintMessage("Oups"+"\n\n")            

    subObjectBoundBox = Gui.Selection.getSelectionEx()[0].SubObjects[0].BoundBox              # sub element BoundBox coordinates
    App.Console.PrintMessage("subObjectBBox  : "+str(subObjectBoundBox)+"\n")
    
    subObjectBoundBoxCenter = Gui.Selection.getSelectionEx()[0].SubObjects[0].BoundBox.Center # sub element BoundBoxCenter
    App.Console.PrintMessage("subObjectBBoxCe: "+str(subObjectBoundBoxCenter)+"\n")
    
    surfaceFace = Gui.Selection.getSelectionEx()[0].SubObjects[0].Area                        # Area of the face selected
    App.Console.PrintMessage("surfaceFace    : "+str(surfaceFace)+"\n\n")
except:
    App.Console.PrintMessage("Oups"+"\n\n")            
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
surface = sel[0].Shape.Area                                               # Area object complete
App.Console.PrintMessage("surfaceObjet   : "+str(surface)+"\n\n")
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
CenterOfMass = sel[0].Shape.CenterOfMass                                  # Center of Mass of the object
App.Console.PrintMessage("CenterOfMass   : "+str(CenterOfMass)+"\n")
App.Console.PrintMessage("CenterOfMassX  : "+str(CenterOfMass[0])+"\n")   # coordinates [0]=X [1]=Y [2]=Z
App.Console.PrintMessage("CenterOfMassY  : "+str(CenterOfMass[1])+"\n")
App.Console.PrintMessage("CenterOfMassZ  : "+str(CenterOfMass[2])+"\n\n")
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
for j in enumerate(sel[0].Shape.Faces):                                   # List alles faces of the object
    App.Console.PrintMessage("Face           : "+str("Face%d" % (j[0]+1))+"\n")
App.Console.PrintMessage("\n\n")
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
volume_ = sel[0].Shape.Volume                                             # Volume of the object
App.Console.PrintMessage("volume_        : "+str(volume_)+"\n\n")
##################################################################################
 
objs = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()

if len(objs) >= 1:
    if hasattr(objs[0], "Shape"):
        s = objs[0].Shape
    elif hasattr(objs[0], "Mesh"):      # upgrade with wmayer thanks #http://forum.freecadweb.org/viewtopic.php?f=13&t=22331
        s = objs[0].Mesh
    elif hasattr(objs[0], "Points"):
        s = objs[0].Points

#sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
#boundBox_= sel[0].Shape.BoundBox                                          # BoundBox of the object
boundBox_= s.BoundBox                                                      # BoundBox of the object
App.Console.PrintMessage("boundBox_      : "+str(boundBox_)+"\n")
 
boundBoxLX  = boundBox_.XLength                                           # Length x boundBox rectangle
boundBoxLY  = boundBox_.YLength                                           # Length y boundBox rectangle
boundBoxLZ  = boundBox_.ZLength                                           # Length z boundBox rectangle
boundBoxDiag= boundBox_.DiagonalLength                                    # Diagonal Length boundBox rectangle

App.Console.PrintMessage("boundBoxLX     : "+str(boundBoxLX)+"\n")
App.Console.PrintMessage("boundBoxLY     : "+str(boundBoxLY)+"\n")
App.Console.PrintMessage("boundBoxLZ     : "+str(boundBoxLZ)+"\n")
App.Console.PrintMessage("boundBoxDiag   : "+str(boundBoxDiag)+"\n\n")

##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
pl = sel[0].Shape.Placement                                               # Placement Vector XYZ and Yaw-Pitch-Roll
App.Console.PrintMessage("Placement      : "+str(pl)+"\n")
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
pl = sel[0].Shape.Placement.Base                                          # Placement Vector XYZ
App.Console.PrintMessage("PlacementBase  : "+str(pl)+"\n\n")
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
oripl_X = sel[0].Placement.Base[0]                                        # decode Placement X
oripl_Y = sel[0].Placement.Base[1]                                        # decode Placement Y
oripl_Z = sel[0].Placement.Base[2]                                        # decode Placement Z
 
App.Console.PrintMessage("oripl_X        : "+str(oripl_X)+"\n")
App.Console.PrintMessage("oripl_Y        : "+str(oripl_Y)+"\n")
App.Console.PrintMessage("oripl_Z        : "+str(oripl_Z)+"\n\n")
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
rotation = sel[0].Placement.Rotation                                      # decode Placement Rotation
App.Console.PrintMessage("rotation              : "+str(rotation)+"\n\n")
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
pl = sel[0].Shape.Placement.Rotation                                      # decode Placement Rotation other method
App.Console.PrintMessage("Placement Rot         : "+str(pl)+"\n\n")
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
pl = sel[0].Shape.Placement.Rotation.Angle                                # decode Placement Rotation Angle
App.Console.PrintMessage("Placement Rot Angle   : "+str(pl)+"\n\n")
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
Rot_0 = sel[0].Placement.Rotation.Q[0]                                    # decode Placement Rotation Q
App.Console.PrintMessage("Rot_0         : "+str(Rot_0)+ " rad ,  "+str(180 * Rot_0 / 3.1416)+" deg "+"\n")
 
Rot_1 = sel[0].Placement.Rotation.Q[1]                                    # decode Placement Rotation 1
App.Console.PrintMessage("Rot_1         : "+str(Rot_1)+ " rad ,  "+str(180 * Rot_1 / 3.1416)+" deg "+"\n")
 
Rot_2 = sel[0].Placement.Rotation.Q[2]                                    # decode Placement Rotation 2
App.Console.PrintMessage("Rot_2         : "+str(Rot_2)+ " rad ,  "+str(180 * Rot_2 / 3.1416)+" deg "+"\n")
 
Rot_3 = sel[0].Placement.Rotation.Q[3]                                    # decode Placement Rotation 3
App.Console.PrintMessage("Rot_3         : "+str(Rot_3)+"\n\n")
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
Yaw   = sel[0].Shape.Placement.Rotation.toEuler()[0]                      # decode angle Euler Yaw (Z)
App.Console.PrintMessage("Yaw            : "+str(Yaw)+"\n")
Pitch = sel[0].Shape.Placement.Rotation.toEuler()[1]                      # decode angle Euler Pitch (Y)
App.Console.PrintMessage("Pitch          : "+str(Pitch)+"\n")
Roll  = sel[0].Shape.Placement.Rotation.toEuler()[2]                      # decode angle Euler Roll (X)
App.Console.PrintMessage("Roll           : "+str(Roll)+"\n\n")
##################################################################################

import DraftGeomUtils
sel = FreeCADGui.Selection.getSelection()
vecteur = DraftGeomUtils.findMidpoint(sel[0].Shape.Edges[0])              # find Midpoint
App.Console.PrintMessage(vecteur)
Draft.makePoint(vecteur)
##################################################################################

Manual search of an element with label

# Extract the coordinate X,Y,Z and Angle giving the label 
App.Console.PrintMessage("Base.x       : "+str(FreeCAD.ActiveDocument.getObjectsByLabel("Cylindre")[0].Placement.Base.x)+"\n")
App.Console.PrintMessage("Base.y       : "+str(FreeCAD.ActiveDocument.getObjectsByLabel("Cylindre")[0].Placement.Base.y)+"\n")
App.Console.PrintMessage("Base.z       : "+str(FreeCAD.ActiveDocument.getObjectsByLabel("Cylindre")[0].Placement.Base.z)+"\n")
App.Console.PrintMessage("Base.Angle   : "+str(FreeCAD.ActiveDocument.getObjectsByLabel("Cylindre")[0].Placement.Rotation.Angle)+"\n\n")
##################################################################################

PS: Usually the angles are given in Radian to convert :

  1. angle in Degrees to Radians :
    • Angle in radian = pi * (angle in degree) / 180
    • Angle in radian = math.radians(angle in degree)
  2. angle in Radians to Degrees :
    • Angle in degree = 180 * (angle in radian) / pi
    • Angle in degree = math.degrees(angle in radian)

Cartesian coordinates

This code displays the Cartesian coordinates of the selected item.

Change the value of "numberOfPoints" if you want a different number of points (precision)

numberOfPoints = 100                                                         # Decomposition number (or precision you can change)
selectedEdge = FreeCADGui.Selection.getSelectionEx()[0].SubObjects[0].copy() # select one element
points  = selectedEdge.discretize(numberOfPoints)                            # discretize the element
i=0
for p in points:                                                             # list and display the coordinates
    i+=1
    print i, " X", p.x, " Y", p.y, " Z", p.z

Other method display on "Int" and "Float"

import Part
from FreeCAD import Base

c=Part.makeCylinder(2,10)        # create the circle
Part.show(c)                     # display the shape

# slice accepts two arguments:
#+ the normal of the cross section plane
#+ the distance from the origin to the cross section plane. Here you have to find a value so that the plane intersects your object
s=c.slice(Base.Vector(0,1,0),0)  # 

# here the result is a single wire
# depending on the source object this can be several wires
s=s[0]

# if you only need the vertexes of the shape you can use
v=[]
for i in s.Vertexes:
    v.append(i.Point)

# but you can also sub-sample the section to have a certain number of points (int) ...
p1=s.discretize(20)
ii=0
for i in p1:
    ii+=1
    print i                                              # Vector()
    print ii, ": X:", i.x, " Y:", i.y, " Z:", i.z        # Vector decode
Draft.makeWire(p1,closed=False,face=False,support=None)  # to see the difference accuracy (20)

## uncomment to use
#import Draft
#Draft.downgrade(App.ActiveDocument.ActiveObject,delete=True)  # first transform the DWire in Wire         "downgrade"
#Draft.downgrade(App.ActiveDocument.ActiveObject,delete=True)  # second split the Wire in single objects   "downgrade"
#
##Draft.upgrade(FreeCADGui.Selection.getSelection(),delete=True) # to attach lines contiguous SELECTED use "upgrade"


# ... or define a sampling distance (float)
p2=s.discretize(0.5)
ii=0
for i in p2:
    ii+=1
    print i                                              # Vector()
    print ii, ": X:", i.x, " Y:", i.y, " Z:", i.z        # Vector decode 
Draft.makeWire(p2,closed=False,face=False,support=None)  # to see the difference accuracy (0.5)

## uncomment to use
#import Draft
#Draft.downgrade(App.ActiveDocument.ActiveObject,delete=True)  # first transform the DWire in Wire         "downgrade"
#Draft.downgrade(App.ActiveDocument.ActiveObject,delete=True)  # second split the Wire in single objects   "downgrade"
#
##Draft.upgrade(FreeCADGui.Selection.getSelection(),delete=True) # to attach lines contiguous SELECTED use "upgrade"

Select all objects in the document

import FreeCAD
for obj in FreeCAD.ActiveDocument.Objects:
    print obj.Name                                # display the object Name
    objName = obj.Name
    obj = App.ActiveDocument.getObject(objName)
    Gui.Selection.addSelection(obj)               # select the object

Selecting a face of an object

# select one face of the object
import FreeCAD, Draft
App=FreeCAD
nameObject = "Box"                             # objet
faceSelect = "Face3"                           # face to selection
loch=App.ActiveDocument.getObject(nameObject)  # objet
Gui.Selection.clearSelection()                 # clear all selection
Gui.Selection.addSelection(loch,faceSelect)    # select the face specified
s = Gui.Selection.getSelectionEx()
#Draft.makeFacebinder(s)                       #

Create one object to the position of the Camera

# create one object of the position to camera with "getCameraOrientation()"
# the object is still facing the screen
import Draft

plan = FreeCADGui.ActiveDocument.ActiveView.getCameraOrientation()
plan = str(plan)
###### extract data
a    = ""
for i in plan:
    if i in ("0123456789e.- "):
        a+=i
a = a.strip(" ")
a = a.split(" ")
####### extract data

#print a
#print a[0]
#print a[1]
#print a[2]
#print a[3]

xP = float(a[0])
yP = float(a[1])
zP = float(a[2])
qP = float(a[3])

pl = FreeCAD.Placement()
pl.Rotation.Q = (xP,yP,zP,qP)         # rotation of object
pl.Base = FreeCAD.Vector(0.0,0.0,0.0) # here coordinates XYZ of Object
rec = Draft.makeRectangle(length=10.0,height=10.0,placement=pl,face=False,support=None) # create rectangle
#rec = Draft.makeCircle(radius=5,placement=pl,face=False,support=None)                   # create circle
print rec.Name

here same code simplified

import Draft
pl = FreeCAD.Placement()
pl.Rotation = FreeCADGui.ActiveDocument.ActiveView.getCameraOrientation()
pl.Base = FreeCAD.Vector(0.0,0.0,0.0)
rec = Draft.makeRectangle(length=10.0,height=10.0,placement=pl,face=False,support=None)

Find normal vector on the surface

This example show how to find normal vector on the surface by find the u,v parameters of one point on the surface and use u,v parameters to find normal vector

def normal(self):
   ss=FreeCADGui.Selection.getSelectionEx()[0].SubObjects[0].copy()#SubObjects[0] is the edge list
   points  = ss.discretize(3.0)#points on the surface edge, 
             #this example just use points on the edge for example. 
             #However point is not necessary on the edge, it can be anywhere on the surface. 
   face=FreeCADGui.Selection.getSelectionEx()[0].SubObjects[1]
   for pp in points:
      pt=FreeCAD.Base.Vector(pp.x,pp.y,pp.z)#a point on the surface edge
      uv=face.Surface.parameter(pt)# find the surface u,v parameter of a point on the surface edge
      u=uv[0]
      v=uv[1]
      normal=face.normalAt(u,v)#use u,v to find normal vector
      print normal
      line=Part.makeLine((pp.x,pp.y,pp.z), (normal.x,normal.y,normal.z))
      Part.show(line)

Read And write one Expression

import Draft
doc = FreeCAD.ActiveDocument

pl=FreeCAD.Placement()
pl.Rotation.Q=(0.0,-0.0,-0.0,1.0)
pl.Base=FreeCAD.Vector(0.0,0.0,0.0)
obj = Draft.makeCircle(radius=1.0,placement=pl,face=False,support=None)    # create circle

print obj.PropertiesList                                                   # properties disponible in the obj

doc.getObject(obj.Name).setExpression('Radius', u'2mm')                    # modify the radius
doc.getObject(obj.Name).setExpression('Placement.Base.x', u'10mm')         # modify the placement 
doc.getObject(obj.Name).setExpression('FirstAngle', u'90')                 # modify the first angle
doc.recompute()

expressions = obj.ExpressionEngine                                         # read the expression list
print expressions

for i in expressions:                                                      # list and separate the data expression
    print i[0]," = ",i[1]


Get the normal vector of a suface from a STL file

def getNormal(cb):
    if cb.getEvent().getState() == coin.SoButtonEvent.UP:
        pp = cb.getPickedPoint()
        if pp:
            vec = pp.getNormal().getValue()
            index = coin.cast(pp.getDetail(), "SoFaceDetail").getFaceIndex()
            print ("Normal: {}, Face index: {}".format(str(vec), index))

from pivy import coin
meth=Gui.ActiveDocument.ActiveView.addEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), getNormal)

you are done then run for quit:

Gui.ActiveDocument.ActiveView.removeEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), meth)