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.

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.

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:

Puis, dans le fichier Import_Ext.py, faites:

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.

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

Ajout et suppression d'objet(s) dans un groupe
PS: vous pouvez aussi ajouter un groupe dans un groupe. ..

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

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.

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:

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 et
 * 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: 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:
 * 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

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:

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

Pour le supprimer, il suffit de:

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

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:

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.

Fonction résidente avec action au clic de souris
Here with SelObserver on a object select

Other example with ViewObserver on a object select or view

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)

Recherche d'un élément en donnant son Label
PS: Les angles sont affichés en Radian, pour la convertir un radian en degrés faites :


 * 1) angle en Degrés vers Radians :
 * 2) *Angle en radian = pi * (angle en Degrés) / 180
 * 3) *Angle en radian = math.radians(angle en Degrés )
 * 4) angle en Radians vers Degrés :
 * 5) *Angle en Degrés = 180 * (angle en radian) / pi
 * 6) *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

Autre méthode d'affichage "Int" et "Float"

Créer un objet dans la position de la camera
Ici le même code simplifié

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