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

Extraits


Un fichier typique InitGui.py
Chaque module doit contenir, en plus de votre fichier de module principal, un fichier InitGui.py, chargé d'insérer le module dans l'interface graphique principale. Ceci est un exemple simple.



Un fichier module typique
Ceci est un exemple de fichier de module principal, contenant tout ce que fait votre module. Il s'agit du fichier Scripts.py appelé par l'exemple précédent. Vous pouvez avoir toutes vos commandes personnalisées ici.



Importer un nouveau type de fichier
Créer un importateur pour un nouveau type de fichier dans FreeCAD est facile. FreeCAD ne considère pas que vous importez des données dans un document ouvert mais plutôt que vous pouvez simplement ouvrir directement le nouveau type de fichier. Donc, ce que vous devez faire est d'ajouter la nouvelle extension de fichier à la liste des extensions connues de FreeCAD et d'écrire le code qui lira le fichier et créera 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 a uniquement deux points.



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



Ajouter et supprimer un objet dans/d'un groupe
Remarque: vous pouvez aussi ajouter d'autres groupes à un groupe...



Ajouter une maille (Mesh)


Ajouter un arc ou un cercle


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.



Remplacer la forme de la souris par une image


Remplacer la forme de la souris par une image (croix)
L'image est créée par Gimp et exportée dans un fichier .XPM. Copiez et utilisez le code entre le crochet "{" code to copy  "}"



Observer le changement de caméra dans la vue 3D via Python
Cela peut être fait en ajoutant un capteur Node à la caméra.



Observer des évènements de la souris dans la vue 3D via Python
La structure Inventor permet d'ajouter un ou plusieurs nœuds de rappel au graphe de scène de la vue. Par défaut dans FreeCAD, un nœud de rappel est installé par vue, ce qui permet d'ajouter des fonctions C ++ globales ou statiques. Dans la liaison Python appropriée, certaines méthodes sont fournies pour utiliser cette technique à partir du code 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



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



Manipuler des graphes de scène en Python
Il est également possible d'obtenir et de modifier le graphe de scène en Python, avec le module 'pivy' - une liaison Python pour 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 type 'SoFCSelection' peut être créé avec:



Ajouter et effacer des objets au/de graphe de scène
Ajouter de nouveaux noeuds dans le graphe de scène 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 l'information du matériau 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:

<span id="Save_the_sceneGraph_in_3_series_of_36_files">

Enregistrer le graphe de scène en 3 séries de 36 fichiers
Affichez l'extrait de code en développant cette section

<span id="Add_custom_widgets_to_the_interface">

Ajouter des widgets personnalisés à l'interface
Vous pouvez créer des widgets personnalisés avec Qt Designer, les transformer en script Python, puis les charger dans l'interface FreeCAD avec 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:

<span id="Add_a_Tab_to_the_Combo_View">

Ajouter un onglet à la vue combinée
Le code suivant vous permet d'ajouter un onglet à la Vue combinée, distinct des onglets "Modèle" et "Tâches" éxistants. Il utilise également le module pour charger un fichier d'interface utilisateur directement dans cet onglet.

<span id="Enable_or_disable_a_window">

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

<span id="Open_a_custom_webpage">

Ouvrir une page web personnalisée
<span id="Get_the_HTML_contents_of_an_opened_webpage">

Obtenir le code HTML d'une page Web ouverte
<span id="Retrieve_the_coordinates_of_3_selected_points_or_objects">

Extraire les coordonnées de 3 points ou 3 objets sélectionnés
<span id="List_all_objects">

Lister les objets
<span id="List_the_dimensions_of_an_object,_given_its_name">

Lister les dimensions en donnant le nom de l'objet
<span id="Function_resident_with_the_mouse_click_action">

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

Autre exemple avec ViewObserver sur un objet selectionné

<span id="Find/select_all_elements_below_the_cursor">

Rechercher et sélectionner tous les éléments sous le curseur
<span id="List_the_components_of_an_object">

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

<span id="List_the_PropertiesList">

Lister les PropertiesList
<span id="Add_a_single_Property_Comment">

Ajouter un seul commentaire de propriété
<span id="Search_and_data_extraction">

Rechercher et extraire des 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)

<span id="Manual_search_of_an_element_with_label">

Rechercher manuellement un élément par son label
Remarque: les angles sont généralement affichés en radian. Pour les convertir:


 * 1) angle en degré vers radian:
 * 2) *Angle en radian = pi * (angle en degré) / 180
 * 3) *Angle en radian = math.radians(angle en degré)
 * 4) angle en radian vers degré :
 * 5) *Angle en degré = 180 * (angle en radian) / pi
 * 6) *Angle en degré = math.degrees(angle en radian)

<span id="Cartesian_coordinates">

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"

<span id="Select_all_objects_in_the_document">

Sélectionner tous les objets du document
<span id="Select_a_face_of_an_object_by_Name_object_and_Face_number">

Sélectionner une face d'un objet par le nom de l'objet et numéro de la face
<span id="Get_the_normal_vector_of_a_face_of_an_object_by_Name_object_and_number_Face_(r.Q)">

Obtenir le vecteur normal d'une face d'un objet par le nom de l'objet et numéro de la face (r.Q)
<span id="Get_the_normal_vector_of_a_face_of_an_object_by_Name_object_and_number_of_Face">

Obtenir le vecteur normal d'une face d'un objet par le nom de l'objet et numéro de la face
<span id="Get_the_normal_vector_of_an_object_selected_and_number_of_Face">

Obtenir le vecteur normal d'un objet sélectionné et le numéro de la face
<span id="Get_the_normal_vector_on_the_surface">

Obtenir le 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

<span id="Get_the_normal_vector_of_the_face_and_create_a_line_at_the_point_mouse_clicked">

Crée une ligne sur la normale de la face au point cliqué par la souris
<span id="Get_the_normal_vector_of_a_surface_from_a_STL_file">

Obtenir le vecteur normal d'une surface à partir d'un fichier STL
Vous avez terminé et voulez quitter :

<span id="Create_one_object_to_the_position_of_the_Camera">

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

<span id="Read_And_write_one_Expression">

Lire et écrire une Expression
<span id="Create_a_Sketch_on_a_Surface_in_PartDesign">

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.

<span id="How_to_Simulate_a_Mouse_Click_at_a_given_Coordinate">

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

Si vous avez un point 3d et que vous voulez obtenir le point 2d sur le widget opengl, alors utilisez ceci:

<span id="How_to_create_a_face_with_holes_using_Python_API">

Comment créer une face avec des trous à l'aide de l'API Python
Cet extrait montre comment créer une face avec des trous à l'aide de l'API Python. Voir fil du forum.

<span id="Close_and_restart_FreeCAD">

Coin3D
Voir Bouts de codes Coin3d

En relation

 * Objets crées par script
 * Macros
 * Script de données topologiques