Jump to content

Toggle the table of contents

Code snippets

From FreeCAD Documentation

This page is a translated version of the page Code snippets and the translation is 1% complete.

Other languages:

Introduction

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...

Snippets

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.

classScriptWorkbench(Workbench):MenuText="Scripts"defInitialize(self):importScripts# assuming Scripts.py is your modulelist=["Script_Cmd"]# That list must contain command names, that can be defined in Scripts.pyself.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.

importFreeCAD,FreeCADGuiclassScriptCmd:defActivated(self):# Here your write what your ScriptCmd does...FreeCAD.Console.PrintMessage('Hello, World!')defGetResources(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 filesFreeCAD.addImportType("Your new File Type (*.ext)","Import_Ext")

Then in the Import_Ext.py file:

defopen(filename):doc=App.newDocument()# here you do all what is needed with filename, read, classify data, create corresponding FreeCAD objectsdoc.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")

Add a line

A line simply has 2 points.

importPart,PartGuidoc=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()

Add a polygon

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

importPart,PartGuidoc=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=ndoc.recompute()

Add and remove an object to/from 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 grpgrp.removeObject(lin)# removes the lin object from the group grp

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

Add a Mesh

importMeshdoc=App.activeDocument()# create a new empty meshm=Mesh.Mesh()# build up box out of 12 facetsm.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 100m.scale(100.0)# add the mesh to the active documentme=doc.addObject("Mesh::Feature","Cube")me.Mesh=m

Add an arc or a circle

importPartdoc=App.activeDocument()c=Part.Circle()c.Radius=10.0f=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()

Access and change the representation of an object

Each object in a FreeCAD document has an associated view representation object that stores all the parameters that define how that object appears: i.e. color, linewidth, etc... See also List the components of an object snippet below

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

Replace the form of mouse with one image

importPySide2fromPySide2importQtCore,QtGui,QtWidgetsfromPySide2.QtWidgetsimportQApplicationfromPySide2.QtGuiimportQColor,QPixmap,QImage,QPainter,QCursorfromPySide2.QtCoreimportQtmyImage=QtGui.QPixmap("Complete_Path_to_image.bmp")cursor=QtGui.QCursor(myImage)QtWidgets.QApplication.setOverrideCursor(QtGui.QCursor(cursor))

Replace the form of mouse with one image (cross) include

The image is created by Gimp exported in a .XPM file. Copy and use the code between the bracket "{" code to copy "}"

importPySide2fromPySide2importQtCore,QtGui,QtWidgetsfromPySide2.QtWidgetsimportQApplicationfromPySide2.QtGuiimportQColor,QPixmap,QImage,QPainter,QCursorfromPySide2.QtCoreimportQtcross32x32Icon=["32 32 2 1"," c None",". c #FF0000"," . "," . "," . "," . "," . "," . "," . "," . "," . "," . "," . "," . "," . "," . "," . "," ","............... . .............."," "," . "," . "," . "," . "," . "," . "," . "," . "," . "," . "," . "," . "," . "," . "]myImage=QtGui.QPixmap(cross32x32Icon)cursor=QtGui.QCursor(myImage)QtWidgets.QApplication.setOverrideCursor(QtGui.QCursor(cursor))

Observe camera change in the 3D viewer via Python

This can be done adding a Node sensor to the camera:

frompivyimportcoindefcallback(*args):cam,sensor=argsprint()print("Cam position : {}".format(cam.position.getValue().getValue()))print("Cam rotation : {}".format(cam.orientation.getValue().getValue()))camera_node=Gui.ActiveDocument.ActiveView.getCameraNode()node_sensor=coin.SoNodeSensor(callback,camera_node)node_sensor.attach(camera_node)

Observe 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.classViewObserver:deflogPosition(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()classViewObserver:deflogPosition(self,info):try:down=(info["Key"])FreeCAD.Console.PrintMessage(str(down)+"\n")# here the character pressedFreeCAD.Console.PrintMessage(str(info)+"\n")# list all events commandFreeCAD.Console.PrintMessage("_______________________________________"+"\n")exceptException:Noneo=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.

frompivy.coinimport*# load the pivy moduleview=Gui.ActiveDocument.ActiveView# get the active viewerroot=view.getSceneGraph()# the root is an SoSeparator noderoot.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()

Add and remove 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):

frompivyimportcoinsg=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)

Save the sceneGraph in 3 series of 36 files

View the code snippet by expanding this section

importmathimporttimefromFreeCADimportBasefrompivyimportcoinsize=(1000,1000)dirname="C:/Temp/animation/"steps=36angle=2*math.pi/stepsmatX=Base.Matrix()matX.rotateX(angle)stepsX=Base.Placement(matX).RotationmatY=Base.Matrix()matY.rotateY(angle)stepsY=Base.Placement(matY).RotationmatZ=Base.Matrix()matZ.rotateZ(angle)stepsZ=Base.Placement(matZ).Rotationview=Gui.ActiveDocument.ActiveViewcam=view.getCameraNode()rotCamera=Base.Rotation(*cam.orientation.getValue().getValue())# this sets the lookat point to the center of circumsphere of the global bounding boxview.fitAll()# the camera's position, i.e. the user's eye pointposition=Base.Vector(*cam.position.getValue().getValue())distance=cam.focalDistance.getValue()# view directionvec=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 fixlookat=position+vec*distance# around x axisforiinrange(steps):rotCamera=stepsX.multiply(rotCamera)cam.orientation.setValue(*rotCamera.Q)vec=rotCamera.multVec(Base.Vector(0,0,-1))pos=lookat-vec*distancecam.position.setValue(pos.x,pos.y,pos.z)Gui.updateGui()time.sleep(0.3)view.saveImage(dirname+"x-%d.png"%i,*size)# around y axisforiinrange(steps):rotCamera=stepsY.multiply(rotCamera)cam.orientation.setValue(*rotCamera.Q)vec=rotCamera.multVec(Base.Vector(0,0,-1))pos=lookat-vec*distancecam.position.setValue(pos.x,pos.y,pos.z)Gui.updateGui()time.sleep(0.3)view.saveImage(dirname+"y-%d.png"%i,*size)# around z axisforiinrange(steps):rotCamera=stepsZ.multiply(rotCamera)cam.orientation.setValue(*rotCamera.Q)vec=rotCamera.multVec(Base.Vector(0,0,-1))pos=lookat-vec*distancecam.position.setValue(pos.x,pos.y,pos.z)Gui.updateGui()time.sleep(0.3)view.saveImage(dirname+"z-%d.png"%i,*size)

Add 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):

classmyWidget_Ui(object):defsetupUi(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 widgetself.label=QtGui.QLabel(myWidget)# creates a labelself.label.setGeometry(QtCore.QRect(50,50,200,24))# sets its sizeself.label.setObjectName("label")# sets its name, so it can be found by namedefretranslateUi(self,draftToolbar):# built-in QT function that manages translations of widgetsmyWidget.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.qAppFCmw=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 declaredmyNewFreeCADWidget=QtGui.QDockWidget()# create a new dckwidgetmyNewFreeCADWidget.ui=myWidget_Ui()# load the Ui scriptmyNewFreeCADWidget.ui.setupUi(myNewFreeCADWidget)# setup the uiFCmw.addDockWidget(QtCore.Qt.RightDockWidgetArea,myNewFreeCADWidget)# add the widget to the main window

Add a Tab to the Combo View

The following code allows you to add a tab to the Combo view, separate from the preexisting "Model" and "Tasks" tabs. It also uses the uic module to load an UI file directly in that tab.

# create new Tab in ComboViewfromPySideimportQtGui,QtCore#from PySide import uicdefgetMainWindow():"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# returnedtoplevel=QtGui.qApp.topLevelWidgets()foriintoplevel:ifi.metaObject().className()=="Gui::MainWindow":returniraiseException("No main window found")defgetComboView(mw):dw=mw.findChildren(QtGui.QDockWidget)foriindw:ifstr(i.objectName())=="Combo View":returni.findChild(QtGui.QTabWidget)elifstr(i.objectName())=="Python Console":returni.findChild(QtGui.QTabWidget)raiseException("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

This script give the ability to manipulate the UI from the Python console to show/hide different components in the FreeCAD interface such as:

fromPySideimportQtGuimw=FreeCADGui.getMainWindow()dws=mw.findChildren(QtGui.QDockWidget)# objectName may be :# "Report view"# "Tree view"# "Property view"# "Selection view"# "Combo View"# "Python console"# "draftToolbar"foriindws:ifi.objectName()=="Report view":dw=ibreakva=dw.toggleViewAction()va.setChecked(True)# True or Falsedw.setVisible(True)# True or False

Open a custom webpage

importWebGuiWebGui.openBrowser("http://www.example.com")

Get the HTML contents of an opened webpage

fromPySideimportQtGui,QtWebKita=QtGui.qAppmw=a.activeWindow()v=mw.findChild(QtWebKit.QWebFrame)html=unicode(v.toHtml())print(html)

Retrieve 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 selectedimportPart,FreeCAD,math,PartGui,FreeCADGuifromFreeCADimportBase,Consolesel=FreeCADGui.Selection.getSelection()# " sel " contains the items selectediflen(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=[]forobjinsel:points.append(obj.Shape.BoundBox.Center)forptinpoints:# display of the coordinates in the report viewConsole.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 -*-importFreeCAD,Draft# List all objects of the documentdoc=FreeCAD.ActiveDocumentobjs=FreeCAD.ActiveDocument.Objects#App.Console.PrintMessage(str(objs) + "\n")#App.Console.PrintMessage(str(len(FreeCAD.ActiveDocument.Objects)) + " Objects" + "\n")forobjinobjs: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 textexcept: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

foredgeinFreeCAD.ActiveDocument.MyObjectName.Shape.Edges:# replace "MyObjectName" for listprint(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 functionclassSelObserver:defsetPreselection(self,doc,obj,sub):# Preselection objectApp.Console.PrintMessage(str(sub)+"\n")# The part of the object namedefaddSelection(self,doc,obj,sub,pnt):# Selection objectApp.Console.PrintMessage("addSelection"+"\n")App.Console.PrintMessage(str(doc)+"\n")# Name of the documentApp.Console.PrintMessage(str(obj)+"\n")# Name of the objectApp.Console.PrintMessage(str(sub)+"\n")# The part of the object nameApp.Console.PrintMessage(str(pnt)+"\n")# Coordinates of the objectApp.Console.PrintMessage("______"+"\n")defremoveSelection(self,doc,obj,sub):# Remove the selectionApp.Console.PrintMessage("removeSelection"+"\n")defsetSelection(self,doc):# Set selectionApp.Console.PrintMessage("setSelection"+"\n")defclearSelection(self,doc):# If click on the screen, clear the selectionApp.Console.PrintMessage("clearSelection"+"\n")# If click on another object, clear the previous objects=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.classViewObserver:def__init__(self,view):self.view=viewdeflogPosition(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)

Display the active document

classDocObserver:# document ObserverdefslotActivateDocument(self,doc):print(doc.Name)obs=DocObserver()App.addDocumentObserver(obs)#App.removeDocumentObserver(obs) # desinstalle la fonction residente

To remove the observer call:

App.removeDocumentObserver(obs)# desinstalle la fonction residente

Find/select all elements below the cursor

frompivyimportcoinimportFreeCADGuidefmouse_over_cb(event_callback):event=event_callback.getEvent()pos=event.getPosition().getValue()listObjects=FreeCADGui.ActiveDocument.ActiveView.getObjectsInfo((int(pos[0]),int(pos[1])))obj=[]iflistObjects:FreeCAD.Console.PrintMessage("\n *** Objects under mouse pointer ***")foroinlistObjects:label=str(o["Object"])ifnotlabelinobj:obj.append(label)FreeCAD.Console.PrintMessage("\n"+str(obj))view=FreeCADGui.ActiveDocument.ActiveViewmouse_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

This function list the components of an object and extracts:

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

# -*- 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/2014importDraft,Partdefdetail():sel=FreeCADGui.Selection.getSelection()# Select an objectiflen(sel)!=0:# If there is a selection thenVertx=[]Edges=[]Faces=[]compt_V=0compt_E=0compt_F=0pas=0perimetre=0.0EdgesLong=[]# Displays the "Name" and the "Label" of the selectionApp.Console.PrintMessage("Selection > "+str(sel[0].Name)+" "+str(sel[0].Label)+"\n"+"\n")forjinenumerate(sel[0].Shape.Edges):# Search the "Edges" and their lengthscompt_E+=1Edges.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 lengthApp.Console.PrintMessage("Edge"+str(compt_E)+" Length > "+str(sel[0].Shape.Edges[compt_E-1].Length)+"\n")# Displays the "Edge" and its center massApp.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 1App.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 2App.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=[]forjinenumerate(sel[0].Shape.Faces):# Search the "Faces" and their surfacecompt_F+=1Faces.append("Face%d"%(j[0]+1))FacesSurf.append(str(sel[0].Shape.Faces[compt_F-1].Area))# Displays 'Face' and its surfaceApp.Console.PrintMessage("Face"+str(compt_F)+" > Surface "+str(sel[0].Shape.Faces[compt_F-1].Area)+"\n")# Displays 'Face' and its CenterOfMassApp.Console.PrintMessage("Face"+str(compt_F)+" > Center "+str(sel[0].Shape.Faces[compt_F-1].CenterOfMass)+"\n")# Displays 'Face' and its CoordinatesFacesCoor=[]fco=0forf0insel[0].Shape.Faces[compt_F-1].Vertexes:# Search the Vertexes of the facefco+=1FacesCoor.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 CoordinatesApp.Console.PrintMessage("Face"+str(compt_F)+" > Coordinate"+str(FacesCoor)+"\n")# Displays 'Face' and its VolumeApp.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 formApp.Console.PrintMessage("Surface of the form  : "+str(sel[0].Shape.Area)+"\n")# Displays the total Volume of the formApp.Console.PrintMessage("Volume of the form  : "+str(sel[0].Shape.Volume)+"\n")detail()

List the PropertiesList

importFreeCADGuifromFreeCADimportConsoleo=App.ActiveDocument.ActiveObjectop=o.PropertiesListforpinop:Console.PrintMessage("Property: "+str(p)+" Value: "+str(o.getPropertyByName(p))+"\r\n")

Add a single Property Comment

importDraftobj=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 "Report View" window (View > Views > Report view)

# -*- coding: utf-8 -*-from__future__importunicode_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 in Report view: View > Views > report view## rev:30/08/2014:29/09/2014:17/09/2015 22/11/2019 30/12/2022fromFreeCADimportBaseimportDraftVecUtils,Draft,Part################################################################################### info in the objectbox=App.ActiveDocument.getObject('Box')# object ####print(dir(box))# all options disponible in the object####print(box.Name)# object name####print(box.Content)# content of the object in XML format#################################################################################### example of using the information listed## search the name of the active document mydoc=FreeCAD.activeDocument().Name# Name of active DocumentApp.Console.PrintMessage("Active docu  : "+(mydoc)+"\n")################################################################################### search the document name and the name of the object selectedsel=FreeCADGui.Selection.getSelection()# select object with getSelection()object_FullName=sel[0].FullName# file Name and Name of the object selectedApp.Console.PrintMessage("object_FullName: "+(object_FullName)+"\n")################################################################################### search the label of the object selectedsel=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")###################################################################################TypeID object FreeCAD selectedsel=FreeCADGui.Selection.getSelection()# select object with getSelection()App.Console.PrintMessage("sel  : "+str(sel[0])+"\n\n")# sel[0] first object selected################################################################################### search the Name of the object selectedsel=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")################################################################################### search the Sub Element Name of the sub object selectedtry:SubElement=FreeCADGui.Selection.getSelectionEx()# sub element name with getSelectionEx()element_=SubElement[0].SubElementNames[0]# name of 1 element selectedApp.Console.PrintMessage("elementSelec  : "+str(element_)+"\n\n")except:App.Console.PrintMessage("Oups"+"\n\n")################################################################################### give the length of the subObject selectedSubElementLength=Gui.Selection.getSelectionEx()[0].SubObjects[0].Length# sub element or element name with getSelectionEx()App.Console.PrintMessage("SubElement length: "+str(SubElementLength)+"\n")# length################################################################################### list the edges and the coordinates of the object[0] selectedsel=FreeCADGui.Selection.getSelection()# select object with getSelection()i=0forjinenumerate(sel[0].Shape.Edges):# list all Edgesi+=1App.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 pointApp.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 pointApp.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")################################################################################### give the sub element name, length, coordinates, BoundBox, BoundBox.Center, Area of the SubObjects selectedtry: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 LengthApp.Console.PrintMessage("subObjectLength: "+str(subObjectLength)+"\n\n")subObjectX1=Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[0].Point.x# sub element coordinate X1App.Console.PrintMessage("subObject_X1  : "+str(subObjectX1)+"\n")subObjectY1=Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[0].Point.y# sub element coordinate Y1App.Console.PrintMessage("subObject_Y1  : "+str(subObjectY1)+"\n")subObjectZ1=Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[0].Point.z# sub element coordinate Z1App.Console.PrintMessage("subObject_Z1  : "+str(subObjectZ1)+"\n\n")try:subObjectX2=Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[1].Point.x# sub element coordinate X2App.Console.PrintMessage("subObject_X2  : "+str(subObjectX2)+"\n")subObjectY2=Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[1].Point.y# sub element coordinate Y2App.Console.PrintMessage("subObject_Y2  : "+str(subObjectY2)+"\n")subObjectZ2=Gui.Selection.getSelectionEx()[0].SubObjects[0].Vertexes[1].Point.z# sub element coordinate Z2App.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 coordinatesApp.Console.PrintMessage("subObjectBBox  : "+str(subObjectBoundBox)+"\n")subObjectBoundBoxCenter=Gui.Selection.getSelectionEx()[0].SubObjects[0].BoundBox.Center# sub element BoundBoxCenterApp.Console.PrintMessage("subObjectBBoxCe: "+str(subObjectBoundBoxCenter)+"\n")surfaceFace=Gui.Selection.getSelectionEx()[0].SubObjects[0].Area# Area of the face selectedApp.Console.PrintMessage("surfaceFace  : "+str(surfaceFace)+"\n\n")except:App.Console.PrintMessage("Oups"+"\n\n")################################################################################### give the area of the objectsel=FreeCADGui.Selection.getSelection()# select object with getSelection()surface=sel[0].Shape.Area# Area object completeApp.Console.PrintMessage("surfaceObjet  : "+str(surface)+"\n\n")################################################################################### give the Center Of Mass and coordinates of the objectsel=FreeCADGui.Selection.getSelection()# select object with getSelection()CenterOfMass=sel[0].Shape.CenterOfMass# Center of Mass of the objectApp.Console.PrintMessage("CenterOfMass  : "+str(CenterOfMass)+"\n")App.Console.PrintMessage("CenterOfMassX  : "+str(CenterOfMass[0])+"\n")# coordinates [0]=X [1]=Y [2]=ZApp.Console.PrintMessage("CenterOfMassY  : "+str(CenterOfMass[1])+"\n")# or CenterOfMass.x, CenterOfMass.y, CenterOfMass.zApp.Console.PrintMessage("CenterOfMassZ  : "+str(CenterOfMass[2])+"\n\n")################################################################################### list the all faces of the object selectedsel=FreeCADGui.Selection.getSelection()# select object with getSelection()forjinenumerate(sel[0].Shape.Faces):# List alles faces of the objectApp.Console.PrintMessage("Face  : "+str("Face%d"%(j[0]+1))+"\n")App.Console.PrintMessage("\n\n")################################################################################### give the volume of the object selectedsel=FreeCADGui.Selection.getSelection()# select object with getSelection()volume_=sel[0].Shape.Volume# Volume of the objectApp.Console.PrintMessage("volume_  : "+str(volume_)+"\n\n")################################################################################### give the BoundBox of the oject selected all typeobjs=FreeCADGui.Selection.getSelection()# select object with getSelection()iflen(objs)>=1:# serch the object typeifhasattr(objs[0],"Shape"):s=objs[0].Shapeelifhasattr(objs[0],"Mesh"):# upgrade with wmayer thanks #http://forum.freecadweb.org/viewtopic.php?f=13&t=22331s=objs[0].Meshelifhasattr(objs[0],"Points"):s=objs[0].PointsboundBox_=s.BoundBox# BoundBox of the objectApp.Console.PrintMessage("boundBox_  : "+str(boundBox_)+"\n")# boundBoxLX=boundBox_.XLength# Length x boundBox rectangleboundBoxLY=boundBox_.YLength# Length y boundBox rectangleboundBoxLZ=boundBox_.ZLength# Length z boundBox rectangleboundBoxXMin=boundBox_.XMin# coordonate XMinboundBoxYMin=boundBox_.YMin# coordonate YMinboundBoxZMin=boundBox_.ZMin# coordonate ZMinboundBoxXMax=boundBox_.XMax# coordonate XMaxboundBoxYMax=boundBox_.YMax# coordonate YMaxboundBoxZMax=boundBox_.ZMax# coordonate ZMaxboundBoxDiag=boundBox_.DiagonalLength# Diagonal Length boundBox rectangleboundBoxCenter=boundBox_.Center# BoundBox CenterboundBoxCenterOfGravity=boundBox_.CenterOfGravity# BoundBox CenterOfGravityApp.Console.PrintMessage("boundBoxLX  : "+str(boundBoxLX)+"\n")App.Console.PrintMessage("boundBoxLY  : "+str(boundBoxLY)+"\n")App.Console.PrintMessage("boundBoxLZ  : "+str(boundBoxLZ)+"\n\n")App.Console.PrintMessage("boundBoxXMin  : "+str(boundBoxXMin)+"\n")App.Console.PrintMessage("boundBoxYMin  : "+str(boundBoxYMin)+"\n")App.Console.PrintMessage("boundBoxZMin  : "+str(boundBoxZMin)+"\n")App.Console.PrintMessage("boundBoxXMax  : "+str(boundBoxXMax)+"\n")App.Console.PrintMessage("boundBoxYMax  : "+str(boundBoxYMax)+"\n")App.Console.PrintMessage("boundBoxZMax  : "+str(boundBoxZMax)+"\n\n")App.Console.PrintMessage("boundBoxDiag  : "+str(boundBoxDiag)+"\n")App.Console.PrintMessage("boundBoxCenter : "+str(boundBoxCenter)+"\n")App.Console.PrintMessage("boundBox Center of Gravity : "+str(boundBoxCenterOfGravity)+"\n\n")################################################################################### give the complete placement of the object selectedsel=FreeCADGui.Selection.getSelection()# select object with getSelection()pl=sel[0].Shape.Placement# Placement Vector XYZ and Yaw-Pitch-RollApp.Console.PrintMessage("Placement  : "+str(pl)+"\n")################################################################################### give the placement Base (xyz) of the object selectedsel=FreeCADGui.Selection.getSelection()# select object with getSelection()pl=sel[0].Shape.Placement.Base# Placement Vector XYZApp.Console.PrintMessage("PlacementBase  : "+str(pl)+"\n\n")################################################################################### give the placement Base (xyz) of the object selectedsel=FreeCADGui.Selection.getSelection()# select object with getSelection()oripl_X=sel[0].Placement.Base[0]# decode Placement Xoripl_Y=sel[0].Placement.Base[1]# decode Placement Yoripl_Z=sel[0].Placement.Base[2]# decode Placement Z# same #oripl_X = sel[0].Placement.Base.x # decode Placement X#oripl_Y = sel[0].Placement.Base.y # decode Placement Y#oripl_Z = sel[0].Placement.Base.z # decode Placement ZApp.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")################################################################################### give the placement rotation of the object selected (x, y, z, angle rotation)sel=FreeCADGui.Selection.getSelection()# select object with getSelection()rotation=sel[0].Placement.Rotation# decode Placement RotationApp.Console.PrintMessage("rotation  : "+str(rotation)+"\n\n")################################################################################### give the placement rotation of the object selected (x, y, z, angle rotation)sel=FreeCADGui.Selection.getSelection()# select object with getSelection()pl=sel[0].Shape.Placement.Rotation# decode Placement Rotation other methodApp.Console.PrintMessage("Placement Rot  : "+str(pl)+"\n\n")################################################################################### give the rotation of the object selected (angle rotation)sel=FreeCADGui.Selection.getSelection()# select object with getSelection()pl=sel[0].Shape.Placement.Rotation.Angle# decode Placement Rotation AngleApp.Console.PrintMessage("Placement Rot Angle  : "+str(pl)+"\n\n")################################################################################### give the rotation.Q of the object selected (angle rotation in Radian) for convert: math.degrees(angleInRadian)sel=FreeCADGui.Selection.getSelection()# select object with getSelection()Rot=sel[0].Placement.Rotation.Q# Placement Rotation QApp.Console.PrintMessage("Rot  : "+str(Rot)+"\n")Rot_0=sel[0].Placement.Rotation.Q[0]# decode Placement Rotation QApp.Console.PrintMessage("Rot_0  : "+str(Rot_0)+" rad , "+str(180*Rot_0/3.1416)+" deg "+"\n")# or math.degrees(angle)Rot_1=sel[0].Placement.Rotation.Q[1]# decode Placement Rotation 1App.Console.PrintMessage("Rot_1  : "+str(Rot_1)+" rad , "+str(180*Rot_1/3.1416)+" deg "+"\n")# or math.degrees(angle)Rot_2=sel[0].Placement.Rotation.Q[2]# decode Placement Rotation 2App.Console.PrintMessage("Rot_2  : "+str(Rot_2)+" rad , "+str(180*Rot_2/3.1416)+" deg "+"\n")# or math.degrees(angle)Rot_3=sel[0].Placement.Rotation.Q[3]# decode Placement Rotation 3App.Console.PrintMessage("Rot_3  : "+str(Rot_3)+"\n\n")Rot_Axis=sel[0].Placement.Rotation.Axis# Placement Rotation .AxisApp.Console.PrintMessage("Rot_Axis  : "+str(Rot_Axis)+"\n")Rot_Angle=sel[0].Placement.Rotation.Angle# Placement Rotation .AngleApp.Console.PrintMessage("Rot_Angle  : "+str(Rot_Angle)+"\n\n")################################################################################### give the rotation of the object selected toEuler (angle rotation in degrees)sel=FreeCADGui.Selection.getSelection()# select object with getSelection()angle=sel[0].Shape.Placement.Rotation.toEuler()# angle EulerApp.Console.PrintMessage("Angle  : "+str(angle)+"\n")Yaw=sel[0].Shape.Placement.Rotation.toEuler()[0]# decode angle Euler Yaw (Z) lacet (alpha)App.Console.PrintMessage("Yaw  : "+str(Yaw)+"\n")Pitch=sel[0].Shape.Placement.Rotation.toEuler()[1]# decode angle Euler Pitch (Y) tangage (beta)App.Console.PrintMessage("Pitch  : "+str(Pitch)+"\n")Roll=sel[0].Shape.Placement.Rotation.toEuler()[2]# decode angle Euler Roll (X) roulis (gamma)App.Console.PrintMessage("Roll  : "+str(Roll)+"\n\n")rot=App.Rotation()rot.setYawPitchRoll(45,45,0)print("Angle: ",rot.Angle)print("Axis: ",rot.Axis)print("RawAxis: ",rot.RawAxis)print("YawPitchRoll: ",rot.getYawPitchRoll())print("Rotation: ",rot)print("Quaternion: ",rot.Q)################################################################################### find Midpoint of the selected lineimportDraft,DraftGeomUtilssel=FreeCADGui.Selection.getSelection()vecteur=DraftGeomUtils.findMidpoint(sel[0].Shape.Edges[0])# find MidpointApp.Console.PrintMessage(vecteur)Draft.makePoint(vecteur)##################################################################################

Manual search of an element with label

# Extract the coordinate X,Y,Z and Angle giving the label (here "Cylindre")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")##################################################################################

Note: Usually the angles are given in Radian. To convert them:

angle in Degrees to Radians :
- Angle in radian = pi * (angle in degree) / 180
- Angle in radian = math.radians(angle in degree)
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 elementpoints=selectedEdge.discretize(numberOfPoints)# discretize the elementi=0forpinpoints:# list and display the coordinatesi+=1print(i," X",p.x," Y",p.y," Z",p.z)

Other method display on "Int" and "Float"

importPartfromFreeCADimportBasec=Part.makeCylinder(2,10)# create the circlePart.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 objects=c.slice(Base.Vector(0,1,0),0)# # here the result is a single wire# depending on the source object this can be several wiress=s[0]# if you only need the vertexes of the shape you can usev=[]foriins.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=0foriinp1:ii+=1print(i)# Vector()print(ii,": X:",i.x," Y:",i.y," Z:",i.z)# Vector decodeDraft.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=0foriinp2:ii+=1print(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

importFreeCADforobjinFreeCAD.ActiveDocument.Objects:print(obj.Name)# display the object NameobjName=obj.Nameobj=App.ActiveDocument.getObject(objName)Gui.Selection.addSelection(obj)# select the object

Select a face of an object by Name object and Face number

# select one face of the objectimportFreeCAD,DraftApp=FreeCADnameObject="Box"# objetfaceSelect="Face3"# face to selectionloch=App.ActiveDocument.getObject(nameObject)# objetGui.Selection.clearSelection()# clear all selectionGui.Selection.addSelection(loch,faceSelect)# select the face specifieds=Gui.Selection.getSelectionEx()#Draft.makeFacebinder(s) #

Get the normal vector of a face of an object by Name object and number Face (r.Q)

## normal of a face by giving the number of the face and the name of the object (rotation Q with yL, uV) = (App.Vector (x, y, z), angle))## normal d'une face en donnant le numero de la face et le nom de l'objet (rotation Q avec yL, uV) = (App.Vector(x, y, z),angle))fromFreeCADimportVectornumero_Face=2# number of the face searched (begin 0, 1, 2, 3 .....)nomObjet="Box"# object nameyL=Gui.ActiveDocument.getObject(nomObjet).Object.Shape.Faces[numero_Face].CenterOfMassuv=Gui.ActiveDocument.getObject(nomObjet).Object.Shape.Faces[numero_Face].Surface.parameter(yL)nv=Gui.ActiveDocument.getObject(nomObjet).Object.Shape.Faces[numero_Face].normalAt(uv[0],uv[1])direction=yL.sub(nv+yL)print("Direction  : ",direction)r=App.Rotation(App.Vector(0,0,1),direction)print("Rotation  : ",r)print("Rotation Q : ",r.Q)

Get the normal vector of a face of an object by Name object and number of Face

numero_Face=2# number of the face searched (begin 0, 1, 2, 3 .....)nomObjet="Box"# object namenormal=Gui.ActiveDocument.getObject(nomObjet).Object.Shape.Faces[numero_Face].normalAt(0,0)print("Face"+str(numero_Face)," : ",normal)

Get the normal vector of an object selected and number of Face

## normal of a face by giving the number of the face of the selected objectselectionObjects=FreeCADGui.Selection.getSelection()numero_Face=3# numero de la face rechercheenormal=selectionObjects[0].Shape.Faces[numero_Face].normalAt(0,0)print(normal)# selectionne la face numeroteeGui.Selection.clearSelection()Gui.Selection.addSelection(selectionObjects[0],"Face"+str(numero_Face))

Get the 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

defnormal(self):ss=FreeCADGui.Selection.getSelectionEx()[0].SubObjects[0].copy()#SubObjects[0] is the edge listpoints=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]forppinpoints:pt=FreeCAD.Base.Vector(pp.x,pp.y,pp.z)#a point on the surface edgeuv=face.Surface.parameter(pt)# find the surface u,v parameter of a point on the surface edgeu=uv[0]v=uv[1]normal=face.normalAt(u,v)#use u,v to find normal vectorprint(normal)line=Part.makeLine((pp.x,pp.y,pp.z),(normal.x,normal.y,normal.z))Part.show(line)

Get the normal vector of the face and create a line at the point mouse clicked

importPySide2importDraft,Part,FreeCAD,FreeCADGuiimportFreeCADGuiasGuifromFreeCADimportBaseFreeCAD.ActiveDocument.openTransaction("Tyty")# memorise les actions (avec annuler restore)selectedFace=FreeCADGui.Selection.getSelectionEx()[0].SubObjects[0]pointClick=FreeCADGui.Selection.getSelectionEx()[0].PickedPoints[0]########## section directionplr=FreeCAD.Placement()yL=pointClickuv=selectedFace.Surface.parameter(yL)nv=direction=selectedFace.normalAt(uv[0],uv[1])r=App.Rotation(App.Vector(0,0,1),nv)plr.Rotation.Q=r.Qplr.Base=pointClick########## section directionline=Draft.make_wire([App.Vector(0.0,0.0,0.0),App.Vector(0.0,0.0,20.0)])# create lineline.Placement=plrFreeCAD.ActiveDocument.recompute()print("Direction (radian) : ",direction)# direction in radian

Get the normal vector of a surface from a STL file

defgetNormal(cb):ifcb.getEvent().getState()==coin.SoButtonEvent.UP:pp=cb.getPickedPoint()ifpp:vec=pp.getNormal().getValue()index=coin.cast(pp.getDetail(),"SoFaceDetail").getFaceIndex()print("Normal: {}, Face index: {}".format(str(vec),index))frompivyimportcoinmeth=Gui.ActiveDocument.ActiveView.addEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(),getNormal)

you are done then run for quit:

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

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 screenimportDraftplan=FreeCADGui.ActiveDocument.ActiveView.getCameraOrientation()plan=str(plan)###### extract dataa=""foriinplan:ifiin("0123456789e.- "):a+=ia=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 objectpl.Base=FreeCAD.Vector(0.0,0.0,0.0)# here coordinates XYZ of Objectrec=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 circleprint(rec.Name)

here same code simplified

importDraftpl=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)

Read And write one Expression

importDraftdoc=FreeCAD.ActiveDocumentpl=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 circleprint(obj.PropertiesList)# properties disponible in the objdoc.getObject(obj.Name).setExpression('Radius',u'2mm')# modify the radiusdoc.getObject(obj.Name).setExpression('Placement.Base.x',u'10mm')# modify the placement doc.getObject(obj.Name).setExpression('FirstAngle',u'90')# modify the first angledoc.recompute()expressions=obj.ExpressionEngine# read the expression listprint(expressions)foriinexpressions:# list and separate the data expressionprint(i[0]," = ",i[1])

Create a Sketch on a Surface in PartDesign

This snippet can be useful, if you want to create a sketch on a surface in PartDesign from inside a macro. Note, that body might be None, if no active body is selected and that the Selection might be empty.

body=Gui.ActiveDocument.ActiveView.getActiveObject('pdbody')first_selection=Gui.Selection.getSelectionEx()[0]feature=first_selection.Objectface_name=first_selection.SubElementNames[0]sketch=App.ActiveDocument.addObject('Sketcher::SketchObject','MySketch')body.addObject(sketch)sketch.MapMode='FlatFace'sketch.Support=(feature,face_name)App.ActiveDocument.recompute()

How to Simulate a Mouse Click at a given Coordinate

The position is relative to the GL widget. See forum thread.

fromPySide2importQtCorefromPySide2importQtGuifromPySide2importQtWidgetsmw=Gui.getMainWindow()gl=mw.findChild(QtWidgets.QOpenGLWidget)me=QtGui.QMouseEvent(QtCore.QEvent.MouseButtonRelease,QtCore.QPoint(800,300),QtCore.Qt.LeftButton,QtCore.Qt.LeftButton,QtCore.Qt.NoModifier)app=QtWidgets.QApplication.instance()app.sendEvent(gl,me)

If you have a 3d point and want to get the 2d point on the opengl widget then use this:

fromPySide2importQtCorefromPySide2importQtGuifromPySide2importQtWidgetsfromFreeCADimportBasex,y,z,=10,10,10v=Gui.ActiveDocument.ActiveViewpoint3d=Base.Vector(x,y,z)point2d=v.getPointOnScreen(point3d)size=v.getSize()coordX=point2d[0]coordY=size[1]-point2d[1]me=QtGui.QMouseEvent(QtCore.QEvent.MouseButtonRelease,QtCore.QPoint(coordX,coordY),QtCore.Qt.LeftButton,QtCore.Qt.LeftButton,QtCore.Qt.NoModifier)

How to create a face with holes using Python API

This snippet demonstrates how to create a face with internal holes through the Python API. See forum thread.

importFreeCAD,Part# Create poles that will define the Facepts=[(-2,2,0),(0,2,1),(2,2,0),(2,-2,0),(0,-2,1),(-2,-2,0)]bs=Part.BSplineCurve()bs.buildFromPoles(pts,True)# True makes this periodic/closed# Make the Face from the curvemyFace=Part.makeFilledFace([bs.toShape()])# Create geometry for holes that will be cut in the surfacehole0=Part.Geom2d.Circle2d(FreeCAD.Base.Vector2d(0,0),1.0)hole1=Part.Geom2d.Circle2d(FreeCAD.Base.Vector2d(0,1.5),0.1)edge0=hole0.toShape(myFace)edge1=hole1.toShape(myFace)wireb=Part.Wire(bs.toShape())wire0=Part.Wire(edge0)wire1=Part.Wire(edge1)# Cut holes in the facemyFace.cutHoles([wire0])myFace.validate()# This is requiredmyFace.cutHoles([wire1])myFace.validate()Part.show(myFace)

Close and restart FreeCAD

importPySide2fromPySide2importQtWidgets,QtCore,QtGuidefrestart_freecad():"""Shuts down and restarts FreeCAD"""args=QtWidgets.QApplication.arguments()[1:]ifFreeCADGui.getMainWindow().close():QtCore.QProcess.startDetached(QtWidgets.QApplication.applicationFilePath(),args)

Coin3D

See Coin3d snippets

Related

Power user documentation

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

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

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

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

Hubs:User hub, Power users hub, Developer hub

Retrieved from "http://wiki.freecad.org/index.php?title=Code_snippets/cs&oldid=1353643"