Code snippets/fr: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
Line 1: Line 1:
<languages/>
<languages/>
{{TutorialInfo/fr
|Topic= Python
|Level= Beginner
|Time=
|Author=
|FCVersion=
|Files=
}}

<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Cette page contient, des exemples, des extraits de code en Python FreeCAD, recueillis auprès d'utilisateurs expérimentés et de produits de discussions sur les [http://forum.freecadweb.org/ forums].
Cette page contient, des exemples, des extraits de code en Python FreeCAD, recueillis auprès d'utilisateurs expérimentés et de produits de discussions sur les [http://forum.freecadweb.org/ forums].
Line 5: Line 14:
Lisez les et utilisez les comme point de départ pour vos propres scripts . .
Lisez les et utilisez les comme point de départ pour vos propres scripts . .
</div>
</div>



<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 12: Line 22:


Ceci est un simple exemple.
Ceci est un simple exemple.
</div>
</div>
{{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())
}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 20: Line 40:
Vous avez ici toutes vos commandes personnalisées.
Vous avez ici toutes vos commandes personnalisées.
</div>
</div>
{{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())
}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 32: Line 64:
Cette ligne doit être ajoutée au fichier '''InitGui.py''' pour ajouter la nouvelle extension de fichier à la liste:
Cette ligne doit être ajoutée au fichier '''InitGui.py''' pour ajouter la nouvelle extension de fichier à la liste:
</div>
</div>
{{Code|code=

# 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")
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Puis, dans le fichier '''Import_Ext.py''', faites:
Puis, dans le fichier '''Import_Ext.py''', faites:
</div>
</div>
{{Code|code=

def open(filename):
doc=App.newDocument()
# here you do all what is needed with filename, read, classify data, create corresponding FreeCAD objects
doc.recompute()
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Pour '''exporter''' votre document avec une nouvelle extension, le fonctionnement est le même,
Pour '''exporter''' votre document avec une nouvelle extension, le fonctionnement est le même,
Line 42: Line 82:


FreeCAD.addExportType("Your new File Type (*.ext)","Export_Ext")
FreeCAD.addExportType("Your new File Type (*.ext)","Export_Ext")
</div>
</div>


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 49: Line 89:
Une ligne, à uniquement deux points.
Une ligne, à uniquement deux points.
</div>
</div>
{{Code|code=

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()
}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 55: Line 106:
Un polygone est simplement un ensemble de segments connnectés (un polyline dans AutoCAD) il n'est pas obligatoirement fermé.
Un polygone est simplement un ensemble de segments connnectés (un polyline dans AutoCAD) il n'est pas obligatoirement fermé.
</div>
</div>
{{Code|code=
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()
}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
=== Ajout et suppression d'objet(s) dans un groupe ===
=== Ajout et suppression d'objet(s) dans un groupe ===
</div>
</div>
{{Code|code=

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
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
'''PS:''' vous pouvez aussi ajouter un groupe dans un groupe . . .
'''PS:''' vous pouvez aussi ajouter un groupe dans un groupe . . .
Line 67: Line 139:
=== Ajout d'une maille (Mesh) ===
=== Ajout d'une maille (Mesh) ===
</div>
</div>
{{Code|code=
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
}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
=== Ajout d'un arc ou d'un cercle ===
=== Ajout d'un arc ou d'un cercle ===
</div>
</div>
{{Code|code=
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()
}}

<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
=== Accéder et changer la représentation d'un objet ===
=== Accéder et changer la représentation d'un objet ===
Line 77: Line 183:
</div>
</div>
{{Code|code=
{{Code|code=
gad=Gui.activeDocument() # access the active document containing all
pyuic mywidget.ui > mywidget.py
# view representations of the features in the
}}
# corresponding App document
<div class="mw-translate-fuzzy">
=== Recherche du vecteur normal() sur une surface ===
</div>
{{Code|code=
@"C:\Python27\python" "C:\Python27\Lib\site-packages\PyQt4\uic\pyuic.py" -x %1.ui > %1.py
}}
<div class="mw-translate-fuzzy">
Cet exemple montre comment trouver le vecteur normal() d'une face en cherchant les paramètres uv d'un point sur la surface et utiliser les paramètres u, v pour trouver le vecteur normal()
</div>
{{Code|code=
compQt4 myUiFile
}}
<div class="mw-translate-fuzzy">
===Recherche et sélection de tous les éléments sous le curseur===
</div>


v=gad.getObject("Cube") # access the view representation to the Mesh feature 'Cube'
<!--T:55-->
v.ShapeColor # prints the color to the console
<div class="mw-translate-fuzzy">
v.ShapeColor=(1.0,1.0,1.0) # sets the shape color to white
===Lire et écrire une Expression===
</div>

{{Code|code=
pyside-uic mywidget.ui -o mywidget.py
}}
}}
<div class="mw-translate-fuzzy">
===Enregistre la vue 3Den pratiquant une rotation dans une série de 36 fichiers dans les axes X Y Z===
</div>



<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 116: Line 200:
</div>
</div>
{{Code|code=
{{Code|code=
App.newDocument()
from PySide import QtCore, QtGui
v=Gui.activeDocument().activeView()

class Ui_Dialog(object):
#This class logs any mouse button events. As the registered callback function fires twice for 'down' and
def setupUi(self, Dialog):
#'up' events we need a boolean flag to handle this.
Dialog.setObjectName("Dialog")
class ViewObserver:
Dialog.resize(187, 178)
def logPosition(self, info):
self.title = QtGui.QLabel(Dialog)
down = (info["State"] == "DOWN")
self.title.setGeometry(QtCore.QRect(10, 10, 271, 16))
self.title.setObjectName("title")
pos = info["Position"]
if (down):
self.label_width = QtGui.QLabel(Dialog)
FreeCAD.Console.PrintMessage("Clicked on position: ("+str(pos[0])+", "+str(pos[1])+")\n")
...

o = ViewObserver()
self.retranslateUi(Dialog)
c = v.addEventCallback("SoMouseButtonEvent",o.logPosition)
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))
...
}}
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 141: Line 220:
Pour terminer l'observation il suffit de faire:
Pour terminer l'observation il suffit de faire:
</div>
</div>
{{Code|code=

v.removeEventCallback("SoMouseButtonEvent",c)
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Les types d’évènements suivants sont pris en charge:
Les types d’évènements suivants sont pris en charge:
Line 152: Line 233:
* '''SoSpaceballButtonEvent''' -- tous les évènements Haut et Bas (pour le spaceball)
* '''SoSpaceballButtonEvent''' -- tous les évènements Haut et Bas (pour le spaceball)
</div>
</div>

{{Code|code=
from PySide import QtGui
import mywidget
d = QtGui.QWidget()
d.ui = mywidget.Ui_Dialog()
d.ui.setupUi(d)
d.show()
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Les fonctions Python qui peuvent être enregistrées avec '''addEventCallback()''' attendent la définition d'une bibliothèque.
Les fonctions Python qui peuvent être enregistrées avec '''addEventCallback()''' attendent la définition d'une bibliothèque.
Line 189: Line 263:
* '''Rotation''' -- un quaternion, tuple de quattre '''[http://docs.python.org/library/functions.html#float float()]'''
* '''Rotation''' -- un quaternion, tuple de quattre '''[http://docs.python.org/library/functions.html#float float()]'''
</div>
</div>
{{Code|code=
d.hide()
}}


<div class="mw-translate-fuzzy">
===Afficher les évènements claviers et commandes===
</div>
<syntaxhighlight>
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
</syntaxhighlight>
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
=== Manipulation de scènes graphiques en Python ===
=== Manipulation de scènes graphiques en Python ===
Line 198: Line 290:
Il est aussi possible d'afficher ou de changer de scène en programmation Python, avec le module '''[[pivy/fr|pivy]]''' en combinaison avec [http://www.coin3d.org/ Coin]
Il est aussi possible d'afficher ou de changer de scène en programmation Python, avec le module '''[[pivy/fr|pivy]]''' en combinaison avec [http://www.coin3d.org/ Coin]
</div>
</div>
{{Code|code=

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()
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
L'API Python de pivy est créé en utilisant l'outil [http://www.swig.org/ SWIG]. Comme dans FreeCAD nous utilisons certains noeuds (nodes) écrits automatiquement nous ne pouvons pas les créer directement en Python.
L'API Python de pivy est créé en utilisant l'outil [http://www.swig.org/ SWIG]. Comme dans FreeCAD nous utilisons certains noeuds (nodes) écrits automatiquement nous ne pouvons pas les créer directement en Python.
Line 205: Line 303:
</div>
</div>
{{Code|code=
{{Code|code=
type = SoType.fromName("SoFCSelection")
import FreeCAD, Part
node = type.createInstance()
}}
}}

<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
=== Ajouter et effacer des objets de la scène ===
=== Ajouter et effacer des objets de la scène ===
Line 214: Line 314:
</div>
</div>
{{Code|code=
{{Code|code=
from pivy import coin
def createPlane(self):
sg = Gui.ActiveDocument.ActiveView.getSceneGraph()
try:
co = coin.SoCoordinate3()
# first we check if valid numbers have been entered
pts = [[0,0,0],[10,0,0]]
w = float(self.width.text())
co.point.setValues(0,len(pts),pts)
h = float(self.height.text())
ma = coin.SoBaseColor()
except ValueError:
ma.rgb = (1,0,0)
print "Error! Width and Height values must be valid numbers!"
li = coin.SoLineSet()
else:
li.numVertices.setValue(2)
# create a face from 4 points
no = coin.SoSeparator()
p1 = FreeCAD.Vector(0,0,0)
no.addChild(co)
p2 = FreeCAD.Vector(w,0,0)
no.addChild(ma)
p3 = FreeCAD.Vector(w,h,0)
no.addChild(li)
p4 = FreeCAD.Vector(0,h,0)
sg.addChild(no)
pointslist = [p1,p2,p3,p4,p1]
mywire = Part.makePolygon(pointslist)
myface = Part.Face(mywire)
Part.show(myface)
self.hide()
}}
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 237: Line 333:
</div>
</div>
{{Code|code=
{{Code|code=
sg.removeChild(no)
QtCore.QObject.connect(self.create,QtCore.SIGNAL("pressed()"),self.createPlane)
}}
}}
<div class="mw-translate-fuzzy">
===Enregistre la vue 3Den pratiquant une rotation dans une série de 36 fichiers dans les axes X Y Z===
</div>

{{Code|code=
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)
}}

<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
===Ajout de widgets personnalisés à l'interface===
===Ajout de widgets personnalisés à l'interface===
Line 244: Line 419:
Vous pouvez créer un widget avec [http://fr.wikipedia.org/wiki/Qt Qt designer], le transformer en Script Python et l'incorporer dans l'interface de FreeCAD avec [[PySide/fr|PySide]].
Vous pouvez créer un widget avec [http://fr.wikipedia.org/wiki/Qt Qt designer], le transformer en Script Python et l'incorporer dans l'interface de FreeCAD avec [[PySide/fr|PySide]].
</div>
</div>

{{Code|code=
class plane():
def __init__(self):
self.d = QtGui.QWidget()
self.ui = Ui_Dialog()
self.ui.setupUi(self.d)
self.d.show()
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Généralement codé comme ceci (il est simple, vous pouvez aussi le coder directement en Python):
Généralement codé comme ceci (il est simple, vous pouvez aussi le coder directement en Python):
</div>
</div>
{{Code|code=
{{Code|code=
class myWidget_Ui(object):
import mywidget
def setupUi(self, myWidget):
myDialog = mywidget.plane()
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))
}}
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Puis, vous devez créer une référence à la fenêtre FreeCAD Qt, lui insérer le widget personnalisé, et transférer le code Ui du widget que nous venons de faire dans le vôtre avec:
Puis, vous devez créer une référence à la fenêtre FreeCAD Qt, lui insérer le widget personnalisé, et transférer le code Ui du widget que nous venons de faire dans le vôtre avec:
</div>
</div>
{{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
}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 270: Line 457:
</div>
</div>
{{Code|code=
{{Code|code=
# create new Tab in ComboView
# -*- coding: utf-8 -*-
from PySide import QtGui,QtCore
#from PySide import uic


def getMainWindow():
# Form implementation generated from reading ui file 'mywidget.ui'
"returns the main window"
#
# using QtGui.qApp.activeWindow() isn't very reliable because if another
# Created: Mon Jun 1 19:09:10 2009
# widget than the mainwindow is active (e.g. a dialog) the wrong widget is
# by: PyQt4 UI code generator 4.4.4
# returned
# Modified for PySide 16:02:2015
toplevel = QtGui.qApp.topLevelWidgets()
# WARNING! All changes made in this file will be lost!
for i in toplevel:
if i.metaObject().className() == "Gui::MainWindow":
return i
raise Exception("No main window found")


def getComboView(mw):
from PySide import QtCore, QtGui
dw=mw.findChildren(QtGui.QDockWidget)
import FreeCAD, Part
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()
class Ui_Dialog(object):
tab = getComboView(getMainWindow())
def setupUi(self, Dialog):
tab2=QtGui.QDialog()
Dialog.setObjectName("Dialog")
tab.addTab(tab2,"A Special Tab")
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")


#uic.loadUi("/myTaskPanelforTabs.ui",tab2)
self.retranslateUi(Dialog)
tab2.show()
QtCore.QObject.connect(self.create,QtCore.SIGNAL("pressed()"),self.createPlane)
#tab.removeTab(2)
QtCore.QMetaObject.connectSlotsByName(Dialog)


}}
def retranslateUi(self, Dialog):
<div class="mw-translate-fuzzy">
Dialog.setWindowTitle(QtGui.QApplication.translate("Dialog", "Dialog", None, QtGui.QApplication.UnicodeUTF8))
===Activer ou désactiver une fenêtre===
self.title.setText(QtGui.QApplication.translate("Dialog", "Plane-O-Matic", None, QtGui.QApplication.UnicodeUTF8))
</div>
self.label_width.setText(QtGui.QApplication.translate("Dialog", "Width", None, QtGui.QApplication.UnicodeUTF8))
{{Code|code=
self.label_height.setText(QtGui.QApplication.translate("Dialog", "Height", None, QtGui.QApplication.UnicodeUTF8))
from PySide import QtGui
self.create.setText(QtGui.QApplication.translate("Dialog", "Create!", None, QtGui.QApplication.UnicodeUTF8))
mw=FreeCADGui.getMainWindow()
dws=mw.findChildren(QtGui.QDockWidget)


# objectName may be :
def createPlane(self):
# "Report view"
try:
# "Tree view"
# first we check if valid numbers have been entered
# "Property view"
w = float(self.width.text())
# "Selection view"
h = float(self.height.text())
# "Combo View"
except ValueError:
# "Python console"
print "Error! Width and Height values must be valid numbers!"
# "draftToolbar"
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)


for i in dws:
class plane():
if i.objectName() == "Report view":
def __init__(self):
dw=i
self.d = QtGui.QWidget()
break
self.ui = Ui_Dialog()

self.ui.setupUi(self.d)
va=dw.toggleViewAction()
self.d.show()
va.setChecked(True) # True or False
dw.setVisible(True) # True or False
}}
}}

<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
===Ouverture d'une page web===
===Ouverture d'une page web===
</div>
</div>
{{Code|code=
import WebGui
WebGui.openBrowser("http://www.example.com")
}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
===Obtenir le code HTML d'une page Web ouverte===
===Obtenir le code HTML d'une page Web ouverte===
</div>
{{Code|code=
from PySide import QtGui,QtWebKit
a = QtGui.qApp
mw = a.activeWindow()
v = mw.findChild(QtWebKit.QWebFrame)
html = unicode(v.toHtml())
print html
}}

<div class="mw-translate-fuzzy">
===Extraire et utiliser les coordonnées de 3 points sélectionnés===
</div>
</div>
{{Code|code=
{{Code|code=
# -*- coding: utf-8 -*-
# -*- coding: utf-8 -*-
# the line above to put the accentuated in the remarks
# Create by flachyjoe
# 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:
from PySide import QtCore, QtGui
# 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")
try:
}}
_fromUtf8 = QtCore.QString.fromUtf8
except AttributeError:
def _fromUtf8(s):
return s


<div class="mw-translate-fuzzy">
try:
===Lister les objets===
_encoding = QtGui.QApplication.UnicodeUTF8
</div>
def _translate(context, text, disambig):
{{Code|code=
return QtGui.QApplication.translate(context, text, disambig, _encoding)
# -*- coding: utf-8 -*-
except AttributeError:
import FreeCAD,Draft
def _translate(context, text, disambig):
# List all objects of the document
return QtGui.QApplication.translate(context, text, disambig)
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
class Ui_MainWindow(object):
}}
<div class="mw-translate-fuzzy">
===Lister les dimensions en donnant le nom de l'objet===
</div>
<syntaxhighlight>
for edge in FreeCAD.ActiveDocument.MyObjectName.Shape.Edges: # replace "MyObjectName" for list
print edge.Length
</syntaxhighlight>


def __init__(self, MainWindow):
self.window = MainWindow


<div class="mw-translate-fuzzy">
MainWindow.setObjectName(_fromUtf8("MainWindow"))
===Fonction résidente avec action au clic de souris===
MainWindow.resize(400, 300)
</div>
self.centralWidget = QtGui.QWidget(MainWindow)
Here with '''SelObserver''' on a object select
self.centralWidget.setObjectName(_fromUtf8("centralWidget"))
{{Code|code=
# -*- 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
self.pushButton = QtGui.QPushButton(self.centralWidget)
App.Console.PrintMessage("addSelection"+ "\n")
self.pushButton.setGeometry(QtCore.QRect(30, 170, 93, 28))
App.Console.PrintMessage(str(doc)+ "\n") # Name of the document
self.pushButton.setObjectName(_fromUtf8("pushButton"))
App.Console.PrintMessage(str(obj)+ "\n") # Name of the object
self.pushButton.clicked.connect(self.on_pushButton_clicked) #connection pushButton
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
self.lineEdit = QtGui.QLineEdit(self.centralWidget)
App.Console.PrintMessage("removeSelection"+ "\n")
self.lineEdit.setGeometry(QtCore.QRect(30, 40, 211, 22))
self.lineEdit.setObjectName(_fromUtf8("lineEdit"))
self.lineEdit.returnPressed.connect(self.on_lineEdit_clicked) #connection lineEdit


def setSelection(self,doc): # Selection in ComboView
self.checkBox = QtGui.QCheckBox(self.centralWidget)
App.Console.PrintMessage("setSelection"+ "\n")
self.checkBox.setGeometry(QtCore.QRect(30, 90, 81, 20))
self.checkBox.setChecked(True)
self.checkBox.setObjectName(_fromUtf8("checkBoxON"))
self.checkBox.clicked.connect(self.on_checkBox_clicked) #connection checkBox


def clearSelection(self,doc): # If click on the screen, clear the selection
self.radioButton = QtGui.QRadioButton(self.centralWidget)
App.Console.PrintMessage("clearSelection"+ "\n") # If click on another object, clear the previous object
self.radioButton.setGeometry(QtCore.QRect(30, 130, 95, 20))
s =SelObserver()
self.radioButton.setObjectName(_fromUtf8("radioButton"))
FreeCADGui.Selection.addObserver(s) # install the function mode resident
self.radioButton.clicked.connect(self.on_radioButton_clicked) #connection radioButton
#FreeCADGui.Selection.removeObserver(s) # Uninstall the resident function
}}


Other example with '''ViewObserver''' on a object select or view
MainWindow.setCentralWidget(self.centralWidget)
<syntaxhighlight>
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)
self.menuBar = QtGui.QMenuBar(MainWindow)
c = v.addEventCallback("SoMouseButtonEvent",o.logPosition)
self.menuBar.setGeometry(QtCore.QRect(0, 0, 400, 26))
self.menuBar.setObjectName(_fromUtf8("menuBar"))
MainWindow.setMenuBar(self.menuBar)


</syntaxhighlight>
self.mainToolBar = QtGui.QToolBar(MainWindow)
<div class="mw-translate-fuzzy">
self.mainToolBar.setObjectName(_fromUtf8("mainToolBar"))
===Recherche et sélection de tous les éléments sous le curseur===
MainWindow.addToolBar(QtCore.Qt.TopToolBarArea, self.mainToolBar)
</div>
{{Code|code=
from pivy import coin
import FreeCADGui


def mouse_over_cb( event_callback):
self.statusBar = QtGui.QStatusBar(MainWindow)
event = event_callback.getEvent()
self.statusBar.setObjectName(_fromUtf8("statusBar"))
pos = event.getPosition().getValue()
MainWindow.setStatusBar(self.statusBar)
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))


self.retranslateUi(MainWindow)


view = FreeCADGui.ActiveDocument.ActiveView
def retranslateUi(self, MainWindow):
MainWindow.setWindowTitle(_translate("MainWindow", "MainWindow", 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))


mouse_over = view.addEventCallbackPivy( coin.SoLocation2Event.getClassTypeId(), mouse_over_cb )
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")


# to remove Callback :
def on_radioButton_clicked(self):
#view.removeEventCallbackPivy( coin.SoLocation2Event.getClassTypeId(), mouse_over)
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):
#The easy way is probably to use FreeCAD's selection.
# if self.lineEdit.textChanged():
#FreeCADGui.ActiveDocument.ActiveView.getObjectsInfo(mouse_coords)
App.Console.PrintMessage(str(self.lineEdit.displayText())+" LineEdit Display\r\n")


####
def on_pushButton_clicked(self):
#you get that kind of result :
App.Console.PrintMessage("Terminé\r\n")
#'Document': 'Unnamed', 'Object': 'Box', 'Component': 'Face2', 'y': 8.604081153869629, 'x': 21.0, 'z': 8.553047180175781
self.window.hide()


####
MainWindow = QtGui.QMainWindow()
#You can use this data to add your element to FreeCAD's selection :
ui = Ui_MainWindow(MainWindow)
#FreeCADGui.Selection.addSelection(FreeCAD.ActiveDocument.Box,'Face2',21.0,8.604081153869629,8.553047180175781)
MainWindow.show()
}}
}}
<div class="mw-translate-fuzzy">
===Extraire et utiliser les coordonnées de 3 points sélectionnés===
</div>


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
===Afficher les évènements claviers et commandes===
===Lister les composantes d'un objet===
</div>
</div>

<div class="mw-translate-fuzzy">
===Lister les dimensions en donnant le nom de l'objet===
</div>

{{Code|code=
{{Code|code=
# -*- coding: utf-8 -*-
# -*- 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


from PySide import QtCore, QtGui
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
try:
App.Console.PrintMessage("Selection > " + str(sel[0].Name) + " " + str(sel[0].Label) +"\n"+"\n")
_fromUtf8 = QtCore.QString.fromUtf8
except AttributeError:
def _fromUtf8(s):
return s


for j in enumerate(sel[0].Shape.Edges): # Search the "Edges" and their lengths
try:
compt_E+=1
_encoding = QtGui.QApplication.UnicodeUTF8
Edges.append("Edge%d" % (j[0]+1))
def _translate(context, text, disambig):
EdgesLong.append(str(sel[0].Shape.Edges[compt_E-1].Length))
return QtGui.QApplication.translate(context, text, disambig, _encoding)
perimetre += (sel[0].Shape.Edges[compt_E-1].Length) # calculates the perimeter
except AttributeError:
def _translate(context, text, disambig):
return QtGui.QApplication.translate(context, text, disambig)


# 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
class Ui_MainWindow(object):
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]
def __init__(self, MainWindow):
Vertx.append("X1: "+str(num.Point.x))
self.window = MainWindow
path = FreeCAD.ConfigGet("UserAppData")
Vertx.append("Y1: "+str(num.Point.y))
# path = FreeCAD.ConfigGet("AppHomePath")
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:
MainWindow.setObjectName(_fromUtf8("MainWindow"))
num = sel[0].Shape.Edges[compt_E-1].Vertexes[1]
MainWindow.resize(400, 300)
Vertx.append("X2: "+str(num.Point.x))
self.centralWidget = QtGui.QWidget(MainWindow)
Vertx.append("Y2: "+str(num.Point.y))
self.centralWidget.setObjectName(_fromUtf8("centralWidget"))
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")
self.pushButton = QtGui.QPushButton(self.centralWidget)
App.Console.PrintMessage("Perimeter of the form : "+str(perimetre)+"\n")
self.pushButton.setGeometry(QtCore.QRect(30, 170, 93, 28))
self.pushButton.setObjectName(_fromUtf8("pushButton"))
self.pushButton.clicked.connect(self.on_pushButton_clicked) #connection pushButton


App.Console.PrintMessage("\n")
self.lineEdit = QtGui.QLineEdit(self.centralWidget)
FacesSurf = []
self.lineEdit.setGeometry(QtCore.QRect(30, 40, 211, 22))
for j in enumerate(sel[0].Shape.Faces): # Search the "Faces" and their surface
self.lineEdit.setObjectName(_fromUtf8("lineEdit"))
compt_F+=1
self.lineEdit.returnPressed.connect(self.on_lineEdit_clicked) #connection lineEdit
Faces.append("Face%d" % (j[0]+1))
FacesSurf.append(str(sel[0].Shape.Faces[compt_F-1].Area))


# Displays 'Face' and its surface
self.checkBox = QtGui.QCheckBox(self.centralWidget)
App.Console.PrintMessage("Face"+str(compt_F)+" > Surface "+str(sel[0].Shape.Faces[compt_F-1].Area)+"\n")
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


# Displays 'Face' and its CenterOfMass
self.radioButton = QtGui.QRadioButton(self.centralWidget)
App.Console.PrintMessage("Face"+str(compt_F)+" > Center "+str(sel[0].Shape.Faces[compt_F-1].CenterOfMass)+"\n")
self.radioButton.setGeometry(QtCore.QRect(30, 130, 95, 20))
self.radioButton.setObjectName(_fromUtf8("radioButton"))
self.radioButton.clicked.connect(self.on_radioButton_clicked) #connection radioButton


# Displays 'Face' and its Coordinates
MainWindow.setCentralWidget(self.centralWidget)
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
self.menuBar = QtGui.QMenuBar(MainWindow)
App.Console.PrintMessage("Face"+str(compt_F)+" > Coordinate"+str(FacesCoor)+"\n")
self.menuBar.setGeometry(QtCore.QRect(0, 0, 400, 26))
self.menuBar.setObjectName(_fromUtf8("menuBar"))
MainWindow.setMenuBar(self.menuBar)


# Displays 'Face' and its Volume
self.mainToolBar = QtGui.QToolBar(MainWindow)
App.Console.PrintMessage("Face"+str(compt_F)+" > Volume "+str(sel[0].Shape.Faces[compt_F-1].Volume)+"\n")
self.mainToolBar.setObjectName(_fromUtf8("mainToolBar"))
App.Console.PrintMessage("\n")
MainWindow.addToolBar(QtCore.Qt.TopToolBarArea, self.mainToolBar)


# Displays the total surface of the form
self.statusBar = QtGui.QStatusBar(MainWindow)
App.Console.PrintMessage("Surface of the form : "+str(sel[0].Shape.Area)+"\n")
self.statusBar.setObjectName(_fromUtf8("statusBar"))
MainWindow.setStatusBar(self.statusBar)


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


detail()
# 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()
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
===Lister les objets===
===Lister les PropertiesList===
</div>
</div>
{{Code|code=
{{Code|code=
import FreeCADGui
# Affiche un icône sur le bouton PushButton
from FreeCAD import Console
# self.image_01 = "C:\Program Files\FreeCAD0.13\icone01.png" # the name of the icon
o = App.ActiveDocument.ActiveObject
self.image_01 = path+"icone01.png" # the name of the icon
op = o.PropertiesList
icon01 = QtGui.QIcon()
for p in op:
icon01.addPixmap(QtGui.QPixmap(self.image_01),QtGui.QIcon.Normal, QtGui.QIcon.Off)
Console.PrintMessage("Property: "+ str(p)+ " Value: " + str(o.getPropertyByName(p))+"\r\n")
self.pushButton.setIcon(icon01)
self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button
}}
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
===Ajouter une Propriété "Commentaire"===
===Fonction résidente avec action au clic de souris===
</div>
</div>
{{Code|code=
{{Code|code=
import Draft
# path = FreeCAD.ConfigGet("UserAppData")
obj = FreeCADGui.Selection.getSelection()[0]
path = FreeCAD.ConfigGet("AppHomePath")
obj.addProperty("App::PropertyString","GComment","Draft","Font name").GComment = "Comment here"
App.activeDocument().recompute()
}}
}}

<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
===Lister les composantes d'un objet===
===Recherche et extraction de données===
</div>
</div>
{{Code|code=
self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button
}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Exemple de recherche et décodage des informations d'un objet
===Lister les PropertiesList===
</div>
</div>


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Chaque section est séparée par des dièses "############" vous pouvez les copier directement dans la console, les utiliser dans vos macro ou utiliser la macro complète. La description de la commande est dans le commentaire.
{{docnav/fr|[[Embedding FreeCAD/fr|Incorporer FreeCAD]]|[[Line drawing function/fr|Fonction Line drawing]]}}
</div>
</div>


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
L'affichage se fait dans la vue rapport (Menu Affichage > Vues > Vue rapport)
[[Category:Poweruser Documentation/fr]]
[[Category:Python Code/fr]]
[[Category:Tutorials/fr]]
</div>
</div>
{{Code|code=
{{Code|code=


# -*- coding: utf-8 -*-
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
# Create by flachyjoe
from PySide import QtCore, QtGui
# 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:
try:
SubElement = FreeCADGui.Selection.getSelectionEx() # sub element name with getSelectionEx()
_fromUtf8 = QtCore.QString.fromUtf8
element_ = SubElement[0].SubElementNames[0] # name of 1 element selected
except AttributeError:
App.Console.PrintMessage("elementSelec : "+str(element_)+"\n\n")
def _fromUtf8(s):
except:
return s
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
##################################################################################
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:
try:
SubElement = FreeCADGui.Selection.getSelectionEx() # sub element name with getSelectionEx()
_encoding = QtGui.QApplication.UnicodeUTF8
subElementName = Gui.Selection.getSelectionEx()[0].SubElementNames[0] # sub element name with getSelectionEx()
def _translate(context, text, disambig):
App.Console.PrintMessage("subElementName : "+str(subElementName)+"\n")
return QtGui.QApplication.translate(context, text, disambig, _encoding)
except AttributeError:
subObjectLength = Gui.Selection.getSelectionEx()[0].SubObjects[0].Length # sub element Length
def _translate(context, text, disambig):
App.Console.PrintMessage("subObjectLength: "+str(subObjectLength)+"\n\n")
return QtGui.QApplication.translate(context, text, disambig)
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")
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")
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")
##################################################################################
sel = FreeCADGui.Selection.getSelection() # select object with getSelection()
boundBox_= sel[0].Shape.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")
class Form(object):
App.Console.PrintMessage("boundBoxLY : "+str(boundBoxLY)+"\n")
def __init__(self, title, width, height):
App.Console.PrintMessage("boundBoxLZ : "+str(boundBoxLZ)+"\n")
self.window = QtGui.QMainWindow()
App.Console.PrintMessage("boundBoxDiag : "+str(boundBoxDiag)+"\n\n")
self.title=title
##################################################################################
self.window.setObjectName(_fromUtf8(title))
self.window.setWindowTitle(_translate(self.title, self.title, None))
sel = FreeCADGui.Selection.getSelection() # select object with getSelection()
self.window.resize(width, height)
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()
Yaw = sel[0].Shape.Placement.Rotation.toEuler()[0] # decode angle Euler Yaw
App.Console.PrintMessage("Yaw : "+str(Yaw)+"\n")
Pitch = sel[0].Shape.Placement.Rotation.toEuler()[1] # decode angle Euler Pitch
App.Console.PrintMessage("Pitch : "+str(Pitch)+"\n")
Roll = sel[0].Shape.Placement.Rotation.toEuler()[2] # decode angle Euler Yaw
App.Console.PrintMessage("Roll : "+str(Roll)+"\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 0
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")
##################################################################################


def show(self):
self.createUI()
self.retranslateUI()
self.window.show()
def setText(self, control, text):
control.setText(_translate(self.title, text, None))
}}
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
===Recherche et extraction de données===
===Recherche d'un élément en donnant son Label===
</div>
</div>
{{Code|code=
# 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")
##################################################################################

}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
'''PS:''' Les angles sont affichés en Radian, pour la convertir un radian en degrés faites :
Exemple de recherche et décodage des informations d'un objet
</div>
</div>


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
#angle en Degrés vers Radians :
Chaque section est séparée par des dièses "############" vous pouvez les copier directement dans la console, les utiliser dans vos macro ou utiliser la macro complète. La description de la commande est dans le commentaire.
#*Angle en radian = '''pi * (angle en Degrés) / 180'''
#*Angle en radian = math.radians(angle en Degrés )
#angle en Radians vers Degrés :
#*Angle en Degrés = '''180 * (angle en radian) / pi'''
#*Angle en Degrés = math.degrees(angle en radian)
</div>
</div>
{{Code|code=

# -*- coding: utf-8 -*-
# Create by flachyjoe
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()
}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
===Coordonnées Cartésiennes ===
===Recherche d'un élément en donnant son Label===
</div>
</div>


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Ce code affiche les coordonnées cartésiennes de l'objet sélectionné.
Ici le même code simplifié
</div>
</div>


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Changer la valeur "numberOfPoints" si vous voulez plus ou moins de précision
===Ajouter une Propriété "Commentaire"===
</div>
</div>

==Icon personalised in ComboView==

Here an example to create an object with properties and icon personalised in ComboView

Download the example icon to the same directory as the macro [[File:FreeCADIco.png|icon Example for the macro|24px]]

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

[[File:Qt_Example_02.png|icon personalised]]
{{clear}}

{{Code|code=
{{Code|code=
numberOfPoints = 100 # Decomposition number (or precision you can change)
import PySide
selectedEdge = FreeCADGui.Selection.getSelectionEx()[0].SubObjects[0].copy() # select one element
import FreeCAD, FreeCADGui, Part
points = selectedEdge.discretize(numberOfPoints) # discretize the element
from pivy import coin
i=0
from PySide import QtGui ,QtCore
for p in points: # list and display the coordinates
from PySide.QtGui import *
i+=1
from PySide.QtCore import *
print i, " X", p.x, " Y", p.y, " Z", p.z
import Draft

global path
param = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Macro")# macro path in FreeCAD preferences
path = param.GetString("MacroPath","") + "/" # macro path
path = path.replace("\\","/") # convert the "\" to "/"


class IconViewProviderToFile: # Class ViewProvider create Property view of object
def __init__( self, obj, icon):
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):
return self.modes

#####################################################
########## Example with icon to file # begin ########
#####################################################

object1 = FreeCAD.ActiveDocument.addObject("App::FeaturePython", "Icon_In_File_Disk") # create your object
object1.addProperty("App::PropertyString","Identity", "ExampleTitle0", "Identity of object").Identity = "FCSpring" # Identity of object
object1.addProperty("App::PropertyFloat" ,"Pitch", "ExampleTitle0", "Pitch betwen 2 heads").Pitch = 2.0 # other Property Data
object1.addProperty("App::PropertyBool" ,"View", "ExampleTitle1", "Hello world").View = True # ...
object1.addProperty("App::PropertyColor" ,"LineColor","ExampleTitle2", "Color to choice").LineColor = (0.13,0.15,0.37) # ...
#...other Property Data
#...other Property Data
#
object1.ViewObject.Proxy = IconViewProviderToFile( object1, path + "FreeCADIco.png") # icon download to file
App.ActiveDocument.recompute()
#
#__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



#####################################################
########## Example with icon in macro # begin #######
#####################################################

def setIconInMacro(self): # def contener the icon in format .xpm
# File format XPM created by Gimp "https://www.gimp.org/"
# 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") #
object2.addProperty("App::PropertyString","Identity","ExampleTitle","Identity of object").Identity = "FCSpring"
#...other Property Data
#...other Property Data
#
object2.ViewObject.Proxy = IconViewProviderToFile( object2, setIconInMacro("")) # icon in macro (.XPM)
App.ActiveDocument.recompute()
########## example with icon in macro end



####################################################################
########## Example with icon to FreeCAD ressource # begin ##########
####################################################################

object3 = FreeCAD.ActiveDocument.addObject("App::FeaturePython", "Icon_Ressource_FreeCAD") #
object3.addProperty("App::PropertyString","Identity","ExampleTitle","Identity of object").Identity = "FCSpring"
#...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

}}
}}
<div class="mw-translate-fuzzy">

Autre méthode d'affichage "Int" et "Float"
Complete example creating a cube and its icon
</div>

{{Code|code=
{{Code|code=
import Part
#https://forum.freecadweb.org/viewtopic.php?t=10255#p83319
import FreeCAD, Part, math
from FreeCAD import Base
from FreeCAD import Base
from PySide import QtGui


c=Part.makeCylinder(2,10) # create the circle
global path
Part.show(c) # display the shape
param = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Macro")# macro path in FreeCAD preferences
path = param.GetString("MacroPath","") + "/" # macro path
path = path.replace("\\","/") # convert the "\" to "/"


# slice accepts two arguments:
def setIconInMacro(self):
#+ the normal of the cross section plane
return """
#+ the distance from the origin to the cross section plane. Here you have to find a value so that the plane intersects your object
/* XPM */
s=c.slice(Base.Vector(0,1,0),0) #
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",
" ",
" ",
" ",
" .. .. ",
" +@#+++.$$ ",
" +.#+%..$$ ",
" &*$ &*#* ",
" & =&= = ",
" ++& +.== %= ",
" ++$@ ..$ %= & ",
" ..-&%.#$$ &## +=$ ",
" .# ..$ ..#%%.#$$ ",
" ; =+=## %-$# ",
" &= ;& %= ",
" ;+ &=; %= ",
" ++$- +*$- ",
" .#&&+.@$$ ",
" ..$# ..$# ",
" .. .. ",
" ",
" ",
" "};
"""


# here the result is a single wire
class PartFeature:
# depending on the source object this can be several wires
def __init__(self, obj):
s=s[0]
obj.Proxy = self


# if you only need the vertexes of the shape you can use
class Box(PartFeature):
v=[]
def __init__(self, obj):
for i in s.Vertexes:
PartFeature.__init__(self, obj)
v.append(i.Point)
obj.addProperty("App::PropertyLength", "Length", "Box", "Length of the box").Length = 1.0
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


# but you can also sub-sample the section to have a certain number of points (int) ...
def onChanged(self, fp, prop):
p1=s.discretize(20)
try:
ii=0
if prop == "Length" or prop == "Width" or prop == "Height":
for i in p1:
fp.Shape = Part.makeBox(fp.Length,fp.Width,fp.Height)
except:
ii+=1
print i # Vector()
pass
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
def execute(self, fp):
#import Draft
fp.Shape = Part.makeBox(fp.Length,fp.Width,fp.Height)
#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"


class ViewProviderBox:
def __init__(self, obj, icon):
obj.Proxy = self
self.icone = icon
def getIcon(self):
return self.icone


# ... or define a sampling distance (float)
def attach(self, obj):
p2=s.discretize(0.5)
return
ii=0

for i in p2:
def setupContextMenu(self, obj, menu):
ii+=1
action = menu.addAction("Set default height")
print i # Vector()
action.triggered.connect(lambda f=self.setDefaultHeight, arg=obj:f(arg))
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)
action = menu.addAction("Hello World")
action.triggered.connect(self.showHelloWorld)

def setDefaultHeight(self, view):
view.Object.Height = 15.0

def showHelloWorld(self):
QtGui.QMessageBox.information(None, "Hi there", "Hello World")

def makeBox():
FreeCAD.newDocument()
a=FreeCAD.ActiveDocument.addObject("Part::FeaturePython","Box")
Box(a)
# ViewProviderBox(a.ViewObject, path + "FreeCADIco.png") # icon download to file
# ViewProviderBox(a.ViewObject, ":/icons/Draft_Draft.svg") # icon to FreeCAD ressource
ViewProviderBox(a.ViewObject, setIconInMacro("")) # icon in macro (.XPM)
App.ActiveDocument.recompute()

makeBox()


## 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"


}}
}}
<div class="mw-translate-fuzzy">

===Sélectionne tous les objets du document===
==Use QFileDialog for writing to a file==
</div>
Complete code:
{{Code|code=
{{Code|code=
import FreeCAD
# -*- coding: utf-8 -*-
for obj in FreeCAD.ActiveDocument.Objects:
import PySide
print obj.Name # display the object Name
from PySide import QtGui ,QtCore
objName = obj.Name
from PySide.QtGui import *
obj = App.ActiveDocument.getObject(objName)
from PySide.QtCore import *
Gui.Selection.addSelection(obj) # select the object
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)

}}
}}
<div class="mw-translate-fuzzy">

===Sélectionner une face d'un objet===
==Use QFileDialog to read a file==
</div>
Complete code:
{{Code|code=
{{Code|code=
# select one face of the object
# -*- coding: utf-8 -*-
import PySide
import FreeCAD, Draft
App=FreeCAD
from PySide import QtGui ,QtCore
nameObject = "Box" # objet
from PySide.QtGui import *
faceSelect = "Face3" # face to selection
from PySide.QtCore import *
loch=App.ActiveDocument.getObject(nameObject) # objet
path = FreeCAD.ConfigGet("UserAppData")
Gui.Selection.clearSelection() # clear all selection

Gui.Selection.addSelection(loch,faceSelect) # select the face specified
OpenName = ""
s = Gui.Selection.getSelectionEx()
try:
#Draft.makeFacebinder(s) #
OpenName = QFileDialog.getOpenFileName(None,QString.fromLocal8Bit("Read a file txt"),path, "*.txt") # PyQt4
# "here the text displayed on windows" "here the filter (extension)"
except Exception:
OpenName, Filter = PySide.QtGui.QFileDialog.getOpenFileName(None, "Read a file txt", path, "*.txt") #PySide
# "here the text displayed on windows" "here the filter (extension)"
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

for ligne in file: # read the file
X = ligne.rstrip('\n\r') #.split() # decode the line
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)

}}
}}

==Use QColorDialog to get the color==
Complete code:
{{Code|code=
# -*- coding: utf-8 -*-
# https://deptinfo-ensip.univ-poitiers.fr/ENS/pyside-docs/PySide/QtGui/QColor.html
import PySide
from PySide import QtGui ,QtCore
from PySide.QtGui import *
from PySide.QtCore import *
path = FreeCAD.ConfigGet("UserAppData")

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

}}

<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
===Créer un objet dans la position de la camera===
L'affichage se fait dans la vue rapport (Menu Affichage > Vues > Vue rapport)
</div>
</div>
{{Code|code=
{{Code|code=
# create one object of the position to camera with "getCameraOrientation()"
# Here the code to display the icon on the '''pushButton''',
# the object is still facing the screen
# change the name to another button, ('''radioButton, checkBox''') as well as the path to the icon,
import Draft


plan = FreeCADGui.ActiveDocument.ActiveView.getCameraOrientation()
# Displays an icon on the button PushButton
plan = str(plan)
# self.image_01 = "C:\Program Files\FreeCAD0.13\icone01.png" # he name of the icon
###### extract data
self.image_01 = path+"icone01.png" # the name of the icon
a = ""
icon01 = QtGui.QIcon()
for i in plan:
icon01.addPixmap(QtGui.QPixmap(self.image_01),QtGui.QIcon.Normal, QtGui.QIcon.Off)
if i in ("0123456789e.- "):
self.pushButton.setIcon(icon01)
a+=i
self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the direction of the button
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])
# path = FreeCAD.ConfigGet("UserAppData") # gives the user path
yP = float(a[1])
path = FreeCAD.ConfigGet("AppHomePath") # gives the installation path of FreeCAD
zP = float(a[2])
qP = float(a[3])


pl = FreeCAD.Placement()
# This command reverses the horizontal button, right to left
pl.Rotation.Q = (xP,yP,zP,qP) # rotation of object
self.pushButton.setLayoutDirection(QtCore.Qt.RightToLeft) # This command reverses the horizontal button
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
# Displays an info button
#rec = Draft.makeCircle(radius=5,placement=pl,face=False,support=None) # create circle
self.pushButton.setToolTip(_translate("MainWindow", "Quitter la fonction", None)) # Displays an info button
print rec.Name

# This function gives a color button
self.pushButton.setStyleSheet("background-color: red") # This function gives a color button

# 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
self.pushButton.setStyleSheet("color : #ff0000; background-color : #0000ff;" ) # combination of the two, button, and text

# replace the icon in the main window
MainWindow.setWindowIcon(QtGui.QIcon('C:\Program Files\FreeCAD0.13\View-C3P.png'))

# 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))
}}
}}

<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Ici le même code simplifié
'''PS:''' Les angles sont affichés en Radian, pour la convertir un radian en degrés faites :
</div>
</div>
{{Code|code=
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)
}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
=== Recherche du vecteur normal() sur une surface ===
===Coordonnées Cartésiennes ===
</div>
</div>


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Cet exemple montre comment trouver le vecteur normal() d'une face en cherchant les paramètres uv d'un point sur la surface et utiliser les paramètres u, v pour trouver le vecteur normal()
#angle en Degrés vers Radians :
#*Angle en radian = '''pi * (angle en Degrés) / 180'''
#*Angle en radian = math.radians(angle en Degrés )
#angle en Radians vers Degrés :
#*Angle en Degrés = '''180 * (angle en radian) / pi'''
#*Angle en Degrés = math.degrees(angle en radian)
</div>
</div>
{{Code|code=
{{Code|code=
def normal(self):
# conversion from a lineEdit
ss=FreeCADGui.Selection.getSelectionEx()[0].SubObjects[0].copy()#SubObjects[0] is the edge list
App.activeDocument().CopyRight.Text = str(unicode(self.lineEdit_20.text() , 'ISO-8859-1').encode('UTF-8'))
points = ss.discretize(3.0)#points on the surface edge,
DESIGNED_BY = unicode(self.lineEdit_01.text(), 'ISO-8859-1').encode('UTF-8')
#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)
}}
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
===Lire et écrire une Expression===
Ce code affiche les coordonnées cartésiennes de l'objet sélectionné.
</div>
</div>
{{Code|code=
{{Code|code=
import Draft
def utf8(unio):
doc = FreeCAD.ActiveDocument
return unicode(unio).encode('UTF8')
}}


pl=FreeCAD.Placement()
<FONT COLOR="#FF0000">'''UnicodeEncodeError: 'ascii' codec can't encode character u'\xe9' in position 9: ordinal not in range(128)'''</FONT>
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]


{{Code|code=
# conversion
a = u"Nom de l'élément : "
f.write('''a.encode('iso-8859-1')'''+str(element_)+"\n")
}}
<div class="mw-translate-fuzzy">
Changer la valeur "numberOfPoints" si vous voulez plus ou moins de précision
</div>
{{Code|code=
def iso8859(encoder):
return unicode(encoder).encode('iso-8859-1')
}}
<div class="mw-translate-fuzzy">
Autre méthode d'affichage "Int" et "Float"
</div>
{{Code|code=
iso8859(unichr(176))
}}
<div class="mw-translate-fuzzy">
===Sélectionne tous les objets du document===
</div>
{{Code|code=
unichr(ord(176))
}}
<div class="mw-translate-fuzzy">
===Activer ou désactiver une fenêtre===
</div>
{{Code|code=
uniteSs = "mm"+iso8859(unichr(178))
print unicode(uniteSs, 'iso8859')
}}
}}




<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
{{docnav/fr|[[Embedding FreeCAD/fr|Incorporer FreeCAD]]|[[Line drawing function/fr|Fonction Line drawing]]}}
===Créer un objet dans la position de la camera===
</div>
</div>


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
[[Category:Poweruser Documentation/fr]]
===Sélectionner une face d'un objet===
[[Category:Python Code/fr]]
[[Category:Tutorials/fr]]
</div>
</div>



Revision as of 14:47, 27 January 2019

Tutoriel
Thème
Python
Niveau
Beginner
Temps d'exécution estimé
Auteurs
Version de FreeCAD
Fichiers exemples
Voir aussi
None

Cette page contient, des exemples, des extraits de code en Python FreeCAD, recueillis auprès d'utilisateurs expérimentés et de produits de discussions sur les forums.

Lisez les et utilisez les comme point de départ pour vos propres scripts . .


Un fichier typique InitGui.py

En plus de votre module principal, chaque module doit contenir, un fichier InitGui.py, responsable de l'insertion du module dans l'interface principale.

Ceci est un simple exemple.

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())

Un fichier module typique

Ceci est l'exemple d'un fichier module principal, il contient tout ce que fait votre module. C'est le fichier Scripts.py invoqué dans l'exemple précédent. Vous avez ici toutes vos commandes personnalisées.

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())

Importer un nouveau type de fichier

Importer un nouveau type de fichier dans FreeCAD est facile. FreeCAD ne prends pas en considération l'importation de n'importe quelle données dans un document ouvert, parce que, vous ne pouvez pas ouvrir directement un nouveau type de fichier.

Donc, ce que vous devez faire, c'est ajouter la nouvelle extension de fichier à la liste des extensions connues de FreeCAD, et, d'écrire le code qui va lire le fichier et créer les objets FreeCAD que vous voulez.

Cette ligne doit être ajoutée au fichier InitGui.py pour ajouter la nouvelle extension de fichier à la liste:

# 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")

Puis, dans le fichier Import_Ext.py, faites:

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

Pour exporter votre document avec une nouvelle extension, le fonctionnement est le même, mais vous devrez faire:

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

Ajouter une ligne

Une ligne, à uniquement deux 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()

Ajouter un polygone

Un polygone est simplement un ensemble de segments connnectés (un polyline dans AutoCAD) il n'est pas obligatoirement fermé.

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()

Ajout et suppression d'objet(s) dans un groupe

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

PS: vous pouvez aussi ajouter un groupe dans un groupe . . .

Ajout d'une maille (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

Ajout d'un arc ou d'un cercle

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()

Accéder et changer la représentation d'un objet

Chaque objet dans un document FreeCAD a un objet vue associé a une représentation qui stocke tous les paramètres qui définissent les propriétés de l'objet, comme, la couleur, l'épaisseur de la ligne, 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

Observation des évènements de la souris dans la vue 3D via Python

Le cadre Inventor permet d'ajouter un ou plusieurs noeuds (nodes) de rappel à la scène graphique visualisée. Par défaut, FreeCAD, possède un noeud (node) de rappel installé par la visionneuse (fenêtre d'affichage des graphes), qui permet d'ajouter des fonctions statiques ou globales en C++. Des méthodes de liaisons appropriées sont fournies avec Python, pour permettre l'utilisation de cette technique à partir de codes Python.

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)

Maintenant, choisissez une zone dans l'écran (surface de travail) 3D et observez les messages affichés dans la fenêtre de sortie.

Pour terminer l'observation il suffit de faire:

v.removeEventCallback("SoMouseButtonEvent",c)

Les types d’évènements suivants sont pris en charge:

  • SoEvent -- tous types d'évènements
  • SoButtonEvent -- tous les évènements, boutons, molette
  • SoLocation2Event -- tous les évènements 2D (déplacements normaux de la souris)
  • SoMotion3Event -- tous les évènements 3D (pour le spaceball)
  • SoKeyboardEvent -- évènements des touches flèche haut et flèche bas
  • SoMouseButtonEvent -- tous les évènements boutons Haut et Bas de la souris
  • SoSpaceballButtonEvent -- tous les évènements Haut et Bas (pour le spaceball)

Les fonctions Python qui peuvent être enregistrées avec addEventCallback() attendent la définition d'une bibliothèque.

Suivant la façon dont l’évènement survient, la bibliothèque peut disposer de différentes clefs.

Il y a une clef pour chaque événement:

  • Type -- le nom du type d'évènement par exemple SoMouseEvent, SoLocation2Event, ...
  • Time -- l'heure courante codée dans une chaîne string
  • Position -- un tuple de deux integers, donant la position x,y de la souris
  • ShiftDown -- type boolean, true si Shift est pressé sinon, false
  • CtrlDown -- type boolean, true si Ctrl est pressé sinon, false
  • AltDown -- type boolean, true si Alt est pressé sinon, false

Pour un évènement bouton comme clavier, souris ou spaceball

  • State -- la chaîne UP si le bouton est relevé, DOWN si le bouton est enfoncé ou UNKNOWN si rien ne se passe

Pour un évènement clavier:

  • Key -- le caractère de la touche qui est pressée

Pour un évènement bouton de souris:

  • Button -- le bouton pressé peut être BUTTON1, ..., BUTTON5 ou tous

Pour un évènement spaceball:

  • Button -- le bouton pressé peut être BUTTON1, ..., BUTTON7 ou tous

Et finalement les évènement de mouvements:

  • Translation -- un tuple de trois float()
  • Rotation -- un quaternion, tuple de quattre float()

Afficher les évènements claviers et commandes

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

Manipulation de scènes graphiques en Python

Il est aussi possible d'afficher ou de changer de scène en programmation Python, avec le module pivy en combinaison avec 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()

L'API Python de pivy est créé en utilisant l'outil SWIG. Comme dans FreeCAD nous utilisons certains noeuds (nodes) écrits automatiquement nous ne pouvons pas les créer directement en Python. Il est cependant, possible de créer un noeud avec son nom interne. Un exemple de SoFCSelection, le type peut être créé avec:

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

Ajouter et effacer des objets de la scène

Ajouter de nouveaux noeuds dans la scène graphique peut être fait de cette façon. Prenez toujours soin d'ajouter un SoSeparator pour, contenir les propriétés de la forme géométrique, les coordonnées et le matériel d'un même objet. L'exemple suivant ajoute une ligne rouge à partir de (0,0,0) à (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)

Pour le supprimer, il suffit de:

sg.removeChild(no)

Enregistre la vue 3Den pratiquant une rotation dans une série de 36 fichiers dans les axes X Y Z

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)

Ajout de widgets personnalisés à l'interface

Vous pouvez créer un widget avec Qt designer, le transformer en Script Python et l'incorporer dans l'interface de FreeCAD avec PySide.

Généralement codé comme ceci (il est simple, vous pouvez aussi le coder directement en 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))

Puis, vous devez créer une référence à la fenêtre FreeCAD Qt, lui insérer le widget personnalisé, et transférer le code Ui du widget que nous venons de faire dans le vôtre avec:

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

Ajout d'une liste déroulante

Le code suivant vous permet d'ajouter une liste déroulante dans FreeCAD, en plus des onglets "Projet" et "tâches".

Il utilise également le module uic pour charger un fichier ui directement dans cet onglet.

# 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)

Activer ou désactiver une fenêtre

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

Ouverture d'une page web

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

Obtenir le code HTML d'une page Web ouverte

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

Extraire et utiliser les coordonnées de 3 points sélectionnés

# -*- 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")

Lister les objets

# -*- 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

Lister les dimensions en donnant le nom de l'objet

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


Fonction résidente avec action au clic de souris

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)

Recherche et sélection de tous les éléments sous le curseur

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)

Lister les composantes d'un objet

# -*- 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()

Lister les 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")

Ajouter une Propriété "Commentaire"

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

Recherche et extraction de données

Exemple de recherche et décodage des informations d'un objet

Chaque section est séparée par des dièses "############" vous pouvez les copier directement dans la console, les utiliser dans vos macro ou utiliser la macro complète. La description de la commande est dans le commentaire.

L'affichage se fait dans la vue rapport (Menu Affichage > Vues > Vue rapport)

# -*- 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
##################################################################################
 
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")
    
    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")
    
    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")
##################################################################################
 
sel = FreeCADGui.Selection.getSelection()                                 # select object with getSelection()
boundBox_= sel[0].Shape.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()
Yaw = sel[0].Shape.Placement.Rotation.toEuler()[0]                        # decode angle Euler Yaw
App.Console.PrintMessage("Yaw            : "+str(Yaw)+"\n")
Pitch = sel[0].Shape.Placement.Rotation.toEuler()[1]                      # decode angle Euler Pitch
App.Console.PrintMessage("Pitch          : "+str(Pitch)+"\n")
Roll = sel[0].Shape.Placement.Rotation.toEuler()[2]                       # decode angle Euler Yaw
App.Console.PrintMessage("Roll           : "+str(Roll)+"\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 0
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")
##################################################################################

Recherche d'un élément en donnant son 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: Les angles sont affichés en Radian, pour la convertir un radian en degrés faites :

  1. angle en Degrés vers Radians :
    • Angle en radian = pi * (angle en Degrés) / 180
    • Angle en radian = math.radians(angle en Degrés )
  2. angle en Radians vers Degrés :
    • Angle en Degrés = 180 * (angle en radian) / pi
    • Angle en Degrés = math.degrees(angle en radian)

Coordonnées Cartésiennes

Ce code affiche les coordonnées cartésiennes de l'objet sélectionné.

Changer la valeur "numberOfPoints" si vous voulez plus ou moins de précision

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

Autre méthode d'affichage "Int" et "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"

Sélectionne tous les objets du 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

Sélectionner une face d'un objet

# 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)                       #

Créer un objet dans la position de la 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

Ici le même code simplifié

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)

Recherche du vecteur normal() sur une surface

Cet exemple montre comment trouver le vecteur normal() d'une face en cherchant les paramètres uv d'un point sur la surface et utiliser les paramètres u, v pour trouver le vecteur normal()

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)

Lire et écrire une 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]