Code snippets/fr

= Code_snippets/fr =

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:

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

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 l=Part.Line 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
 * 1) add a line element to the document and set its points

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 v=App.Vector(0,0,0) n.append(v) v=App.Vector(10,0,0) n.append(v) p=doc.addObject("Part::Polygon","Polygon") p.Nodes=n doc.recompute
 * 1) create a 3D vector, set its coordinates and add it to the list
 * 1) ... repeat for all nodes
 * 2) Create a polygon object and set its nodes

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 m = Mesh.Mesh 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) m.scale(100.0) me=doc.addObject("Mesh::Feature","Cube") me.Mesh=m
 * 1) create a new empty mesh
 * 1) build up box out of 12 facets
 * 1) scale to a edge langth of 100
 * 1) add the mesh to the active document

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 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)
 * 1) This class logs any mouse button events. As the registered callback function fires twice for 'down' and
 * 2) 'up' events we need a boolean flag to handle this.

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: 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: Pour un évènement bouton comme clavier, souris ou spaceball Pour un évènement clavier: Pour un évènement bouton de souris: Pour un évènement spaceball: Et finalement les évènement de mouvements:
 * 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 et
 * SoMouseButtonEvent -- tous les évènements boutons Haut et Bas de la souris
 * SoSpaceballButtonEvent -- tous les évènements Haut et Bas (pour le spaceball)
 * 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 est pressé sinon, false
 * CtrlDown -- type boolean, true si est pressé sinon, false
 * AltDown -- type boolean, true si est pressé sinon, false
 * State -- la chaîne UP si le bouton est relevé, DOWN si le bouton est enfoncé ou UNKNOWN si rien ne se passe
 * Key -- le caractère de la touche qui est pressée
 * Button -- le bouton pressé peut être BUTTON1, ..., BUTTON5 ou tous
 * Button -- le bouton pressé peut être BUTTON1, ..., BUTTON7 ou tous
 * Translation -- un tuple de trois float
 * Rotation -- un quaternion, tuple de quattre float

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)

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


 * Ici, le code Python est généré par le compilateur Ui Python avec le module pyuic.py (il existe aussi pyuic4.py attention à la compatibilité).
 * Vous pouvez trouver ce fichier à l'emplacement "C:\Program Files\FreeCAD0.13\bin\PyQt4\uic",
 * pyuic.py est l'outil qui convertit les fichiers qt-designer .ui (Interface Utilisateur) en fichier .py (code Python), la ligne de commande dans la console DOS est "pyuic -x fichier.ui > fichier.py"
 * vous pouvez créer un fichier .bat pour automatiser la commande:
 * (avec Python27) copier cette ligne dans un fichier texte, et, le sauver le sous le nom "compile.bat"

@"C:\Python27\python" "C:\Python27\Lib\site-packages\PyQt4\uic\pyuic.py" -x %1.ui > %1.py

(au besoin, adaptez le chemin à votre version de Python)

Si vous utilisez les outils fourni dans FreeCAD, le code sera,

@"C:\Program Files\FreeCAD0.13\bin\python" "C:\Program Files\FreeCAD0.13\bin\PyQt4\uic\pyuic.py" -x %1.ui > %1.py

Autres liens de documentation "Python and Qt", sur Développez.com et bien d'autres.
 * et tapez à la ligne de commande " compile fichier " sans extension, le nom "fichier" entré .ui, sera le nom sortant avec extension .py
 * ATTENTION: il faut que les fichiers soient présents, et, accessibles, vérifiez que les fichiers sont présents et que les chemins sont justes !
 * pour cet exemple entièrement automatique et simplifié, "compile.bat" est au même endroit que le fichier.ui à convertir en fichier.py

Vous pouvez installer une version complète de Python qui comprend PyQt, Qt Designer ...

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.

from PyQt4 import QtGui,QtCore from PyQt4 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) 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
 * 1) from PySide import QtGui,QtCore
 * 1) tab.removeTab(2)

Ouverture d'une page web
import WebGui WebGui.openBrowser("http://www.example.com")

Obtenir le code HTML d'une page Web ouverte
from PyQt4 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
import Part, FreeCAD, math, PartGui, FreeCADGui from FreeCAD import Base, Console sel = FreeCADGui.Selection.getSelection # " sel " renferme les points sélectionnes if len(sel)!=3 : # s'il n'y a pas 3 objets sélectionnés, une erreur s'affiche dans la Vue rapport # Le \r et \n en fin de ligne signifient Retour chariot et le Saut de ligne CR + LF. Console.PrintError("Sélectionnez 3 points exactement\r\n") else : points=[] for obj in sel: points.append(obj.Shape.BoundBox.Center)
 * 1) -*- coding: utf-8 -*-
 * 2) la ligne ci dessus permet de mettre des accentué dans les remarques
 * 3) si cette ligne est absente, une erreur sera renvoyée
 * 4) extraire et utiliser les coordonnées de 3 points séléctionnés

for pt in points: # affichage des coordonnées dans la Vue rapport 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
App.ActiveDocument=App.getDocument("Unnamed") doc = FreeCAD.ActiveDocument print "Nom du document : ", doc.Name objs = FreeCAD.ActiveDocument.Objects for obj in objs: name = obj.Name       # liste le nom des objets print name            # affiche le nom de l'objet
 * 1) -*- coding: utf-8 -*-
 * 2) Liste les objets
 * 1) print objs
 * 2) print len(FreeCAD.ActiveDocument.Objects)
 * 1) doc.removeObject("Ortho") # efface l'objet désigné

Fonction résidente avec action au clic de souris
class SelObserver: def addSelection(self,doc,obj,sub,pnt): # Sélection print "addSelection" print doc                           # Nom du document print obj                           # Nom de l'objet print sub                           # Nom de la partie de l'objet print pnt                           # Coordonnées de l'objet
 * 1) -*- coding: utf-8 -*-
 * 2) provoque une action au clic de souris sur un objet
 * 3) cette fonction reste résidente (en mémoire) grâce à "addObserver(s)"
 * 4) "removeObserver(s) # désinstalle la fonction résidente

def removeSelection(self,doc,obj,sub):  # Effacer l'objet sélectionné print "removeSelection" def setSelection(self,doc):             # Sélection dans ComboView print "setSelection" def clearSelection(self,doc):           # Si clic sur l'écran, éffacer la sélection print "clearSelection"              # Si clic sur un autre objet, éfface le précédent

s=SelObserver FreeCADGui.Selection.addObserver(s)   # installe la fonction en mode résident
 * 1) FreeCADGui.Selection.removeObserver(s) # désinstalle la fonction résidente

Lister les composantes d'un objet

 * 1) -*- coding: utf-8 -*-
 * 2) This function list the components of an object
 * 3) and extract this object its XYZ coordinates,
 * 4) its edges and their lengths center of mass and coordinates
 * 5) its faces and their center of mass
 * 6) its faces and their surfaces and coordinates
 * 7) 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