Code snippets/fr

Introduction
Cette page contient des exemples, des pièces, des extraits de code FreeCAD en Python, recueillis auprès d'utilisateurs expérimentés et 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.

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

top

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.

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

top

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.

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

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

top

Ajouter une ligne
Une ligne, à uniquement deux points.

A line simply has 2 points.

top

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

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

top

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

top

Ajout d'une maille (Mesh)
top

Ajout d'un arc ou d'un cercle
top

Accéder et changer la représentation d'un objet
Chaque objet dans un document FreeCAD a un objet de représentation de vue associé qui stocke tous les paramètres qui définissent la façon dont cet objet apparaît: c'est-à-dire la couleur, la largeur de ligne, etc... Voir aussi l'extrait ci-dessous Lister les composantes d'un objet.

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

top

Replace the form of mouse with one image
top

Replace the form of mouse with one image (cross) include
The image is created by Gimp exported in a .XPM file. Copy and use the code between the bracket "{" code to copy  "}"

top

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.

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

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

top

Afficher les évènements claviers et commandes
Cette macro affiche dans la vue du rapport les touches enfoncées et tous les événements commande

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

top

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

It is also possible to get and change the scenegraph in Python, with the 'pivy' module -- a Python binding for 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:

top

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

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

Pour le supprimer, il suffit de:

top

Enregistre la vue 3Den pratiquant une rotation dans une série de 36 fichiers dans les axes X Y Z
Affichez l'extrait de code en développant cette section

top

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.

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

Le code python produit par le compilateur python Ui (l'outil qui convertit les fichiers .ui de qt-designer en code python) 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:

top

Ajout d'une liste déroulante
Le code suivant vous permet d'ajouter un onglet à la Vue Combinée, distinct des onglets "Modèle" et "Tâches" préexistants. Il utilise également le module pour charger un fichier d'interface utilisateur directement dans cet onglet.

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

top

Activer ou désactiver une fenêtre
Ce script donne la possibilité de manipuler l'interface utilisateur de la console Python pour afficher/masquer différents composants dans de l'interface de FreeCAD tels que:
 * Vue rapport
 * vue en arborescence
 * Éditeur de propriétés
 * Fenêtre de sélection
 * Vue Combinée
 * console Python
 * draftToolbar

top

Ouverture d'une page web
top

Obtenir le code HTML d'une page Web ouverte
top

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

Lister les objets
top

Lister les dimensions en donnant le nom de l'objet
top

Fonction résidente avec action au clic de souris
Ici avec SelObserver sur un objet selectionné

Autre exemple avec ViewObserver sur un objet selectionné

top

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

Lister les composantes d'un objet
Cette fonction répertorie les composants d'un objet et extrait:
 * de cet objet, ses coordonnées XYZ,
 * ses bords et leurs longueurs centre de masse et coordonnées
 * ses faces et leur centre de masse
 * ses faces et leurs surfaces et coordonnées

top

Lister les PropertiesList
top

Ajout d'un seul commentaire de propriété
top

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)

top

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)

top

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"

top

Sélectionne tous les objets du document
top

Sélectionner une face d'un objet
top

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

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

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

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

top

Obtenir le vecteur normal d'une surface à partir d'un fichier STL
top

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

top

Lire et écrire une Expression
Vous avez terminé et voulez quitter :

top

Créer une esquisse sur une surface dans PartDesign
Cet extrait de code peut être utile si vous souhaitez créer une esquisse sur une surface dans PartDesign à partir d'une macro. Notez que ce corps peut être Aucun si aucun corps actif n'est sélectionné et que la sélection peut être vide.

top

Comment simuler un clic de souris sur une coordonnée donnée
La position est relative au widget GL. Voir fil du forum.

top

En relation

 * Objets crées par script
 * Macros

top