Part scripting/fr: Difference between revisions
(Created page with "Script Part") |
No edit summary |
||
(41 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
{{TOCright}} |
|||
== Scripting == |
|||
== Introduction == |
|||
The main data structure used in the Part module is the [http://en.wikipedia.org/wiki/Boundary_representation BRep] data type from OpenCascade. |
|||
Almost all contents and object types of the Part module are available by [[Python|Python]] scripting. This includes geometric primitives, such as Line and Circle (or Arc), and the whole range of TopoShapes, like Vertexes, Edges, Wires, Faces, Solids and Compounds. For each of those objects, several creation methods exist, and for some of them, especially the TopoShapes, advanced operations like boolean union/difference/intersection are also available. Explore the contents of the Part module, as described in the [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]] page, to know more. |
|||
La structure principale des données utilisée dans le module Part est le type de données [https://fr.wikipedia.org/wiki/B-Rep BRep] d'OpenCascade. |
|||
=== Examples === |
|||
Presque tous les contenus et types d'objets du module Part sont disponibles par script [[Python/fr|Python]]. Cela inclut les primitives géométriques, telles que Ligne et Cercle (ou Arc), et toute la gamme de TopoShapes, comme les sommets, les arêtes, les fils, les faces, les solides et les composés. Pour chacun de ces objets, plusieurs méthodes de création existent, et pour certaines d'entre elles, en particulier les TopoShapes, des opérations avancées comme l'union booléenne/différence/intersection sont également disponibles. Pour en savoir plus, explorez le contenu du module Part, comme décrit dans la page [[FreeCAD_Scripting_Basics/fr|Notions de base sur les scripts FreeCAD]]. |
|||
L'objet le plus simple pouvant être créé est une [[Part Feature/fr|Part Feature]], qui possède une simple propriété {{PropertyData/fr|Placement}} et des propriétés de base permettant de définir sa couleur et son apparence. |
|||
Un autre objet simple utilisé dans les objets géométriques 2D est [[Part Part2DObject/fr|Part2DObject]] qui constitue la base des [[Sketcher_SketchObject/fr|Sketcher SketchObject]] ([[Sketcher_Workbench/fr|atelier Sketcher]]) et la plupart des [[Draft Workbench/fr|éléments Draft]]. |
|||
===Voir aussi=== |
|||
* [[Topological_data_scripting/fr|Scripts pour création topologique]] |
|||
* [[OpenCASCADE/fr|OpenCASCADE]] |
|||
==Script de test== |
|||
Testez la création de [[Part_Primitives/fr|Part Primitives]] avec un script. {{Version/fr|0.19}} |
|||
{{Code|code= |
|||
import parttests.part_test_objects as pto |
|||
pto.create_test_file("example_file") |
|||
}} |
|||
Ce script se trouve dans le répertoire d'installation du programme et peut être examiné pour voir comment les primitives de base sont construites. |
|||
{{Code|code= |
|||
$INSTALL_DIR/Mod/Part/parttests/part_test_objects.py |
|||
}} |
|||
==Exemples== |
|||
Pour créer un élément ligne, passer à la console Python et taper : |
|||
To create a line element switch to the Python console and type in: |
|||
{{Code|code= |
{{Code|code= |
||
import Part,PartGui |
import Part,PartGui |
||
Line 19: | Line 45: | ||
}} |
}} |
||
Passons en revue l'exemple Python ci-dessus étape par étape : |
|||
Let's go through the above python example step by step: |
|||
{{Code|code= |
{{Code|code= |
||
import Part,PartGui |
import Part,PartGui |
||
Line 25: | Line 52: | ||
}} |
}} |
||
Charge l'atelier Part et crée un nouveau document |
|||
{{Code|code= |
{{Code|code= |
||
l=Part.LineSegment() |
l=Part.LineSegment() |
||
Line 32: | Line 60: | ||
}} |
}} |
||
Line |
La fonction Line décrit en fait un segment de ligne, d'où le point de départ et le point final. |
||
{{Code|code= |
{{Code|code= |
||
doc.addObject("Part::Feature","Line").Shape=l.toShape() |
doc.addObject("Part::Feature","Line").Shape=l.toShape() |
||
}} |
}} |
||
Cette commande ajoute un objet de type Part (Pièce) au document et affecte la représentation de forme du segment de ligne à la propriété 'Shape' ('forme') de l'objet ajouté. Il est important de comprendre ici que nous avons utilisé une primitive géométrique (Part.LineSegment) pour créer un TopoShape à partir de celle-ci (la méthode toShape()). Seules les formes peuvent être ajoutées au document. Dans FreeCAD, les primitives géométriques sont utilisées comme des "structures de base" pour construire les formes. |
|||
{{Code|code= |
{{Code|code= |
||
doc.recompute() |
doc.recompute() |
||
}} |
}} |
||
Met à jour le document. Cela prépare également la représentation visuelle du nouvel objet Part. |
|||
Updates the document. This also prepares the visual representation of the new part object. |
|||
Notez qu'une Line Segment (segment de ligne) peut être créée en spécifiant son point de départ et son point final directement dans le constructeur, par ex. Part.LineSegment(point1, point2) ou nous pouvons créer une ligne par défaut et définir ses propriétés après, comme nous l'avons fait ici. |
|||
Une ligne peut également être créée en utilisant : |
|||
{{Code|code= |
|||
import FreeCAD |
|||
import Part |
|||
DOC = FreeCAD.newDocument() |
|||
def mycreateLine(pt1, pt2, objName): |
|||
obj = DOC.addObject("Part::Line", objName) |
|||
obj.X1 = pt1[0] |
|||
obj.Y1 = pt1[1] |
|||
obj.Z1 = pt1[2] |
|||
obj.X2 = pt2[0] |
|||
obj.Y2 = pt2[1] |
|||
obj.Z2 = pt2[2] |
|||
DOC.recompute() |
|||
return obj |
|||
line = mycreateLine((0,0,0), (0,10,0), "LineName") |
|||
}} |
|||
Un cercle peut être créé de la même manière: |
|||
A circle can be created in a similar way: |
|||
{{Code|code= |
{{Code|code= |
||
import Part |
import Part |
||
Line 57: | Line 111: | ||
}} |
}} |
||
ou en utilisant : |
|||
Note again, we used the circle (geometry primitive) to construct a shape out of it. We can of course still access our construction geometry afterwards, by doing: |
|||
{{Code|code= |
|||
import FreeCAD |
|||
import Part |
|||
DOC = FreeCAD.newDocument() |
|||
def mycreateCircle(rad, objName): |
|||
obj = DOC.addObject("Part::Circle", objName) |
|||
obj.Radius = rad |
|||
DOC.recompute() |
|||
return obj |
|||
circle = mycreateCircle(5.0, "CircleName") |
|||
}} |
|||
Notez qu'une fois encore, nous avons utilisé le cercle (primitive géométrique) pour construire une forme. Nous pouvons bien sûr toujours accéder à notre géométrie de construction par la suite, en faisant: |
|||
{{Code|code= |
{{Code|code= |
||
s = f.Shape |
s = f.Shape |
||
Line 64: | Line 136: | ||
}} |
}} |
||
Ici on prend la forme de notre objet f, puis nous prenons la liste de ses arêtes. Dans ce cas il y aura une seule arête parce que nous avons fait toute la forme à partir d'un cercle unique, c'est pourquoi nous ne prenons que le premier élément de la liste des arêtes, et puis nous récupérons sa courbe. Chaque arête a une courbe, qui est la géométrie primitive, sur laquelle elle est basée. |
|||
Here we take the shape of our object f, then we take its list of edges. In this case there will be only one because we made the whole shape out of a single circle, so we take only the first item of the Edges list, and we takes its curve. Every Edge has a Curve, which is the geometry primitive it is based on. |
|||
Rendez-vous sur la page [[Topological_data_scripting/fr|Scripts pour création topologique]] si vous voulez en savoir plus. |
|||
Head to the [[Topological data scripting|Topological data scripting]] page if you would like to know more. |
|||
{{Part Tools navi}} |
|||
{{Powerdocnavi{{#translation:}}}} |
|||
{{Userdocnavi}} |
|||
[[Category:Developer Documentation{{#translation:}}]] |
|||
[[Category:Python Code{{#translation:}}]] |
|||
{{Part Tools navi{{#translation:}}}} |
|||
{{clear}} |
Revision as of 10:24, 17 October 2020
Introduction
La structure principale des données utilisée dans le module Part est le type de données BRep d'OpenCascade. Presque tous les contenus et types d'objets du module Part sont disponibles par script Python. Cela inclut les primitives géométriques, telles que Ligne et Cercle (ou Arc), et toute la gamme de TopoShapes, comme les sommets, les arêtes, les fils, les faces, les solides et les composés. Pour chacun de ces objets, plusieurs méthodes de création existent, et pour certaines d'entre elles, en particulier les TopoShapes, des opérations avancées comme l'union booléenne/différence/intersection sont également disponibles. Pour en savoir plus, explorez le contenu du module Part, comme décrit dans la page Notions de base sur les scripts FreeCAD.
L'objet le plus simple pouvant être créé est une Part Feature, qui possède une simple propriété DonnéesPlacement et des propriétés de base permettant de définir sa couleur et son apparence.
Un autre objet simple utilisé dans les objets géométriques 2D est Part2DObject qui constitue la base des Sketcher SketchObject (atelier Sketcher) et la plupart des éléments Draft.
Voir aussi
Script de test
Testez la création de Part Primitives avec un script. introduit dans la version 0.19
import parttests.part_test_objects as pto
pto.create_test_file("example_file")
Ce script se trouve dans le répertoire d'installation du programme et peut être examiné pour voir comment les primitives de base sont construites.
$INSTALL_DIR/Mod/Part/parttests/part_test_objects.py
Exemples
Pour créer un élément ligne, passer à la console Python et taper :
import Part,PartGui
doc=App.newDocument()
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()
Passons en revue l'exemple Python ci-dessus étape par étape :
import Part,PartGui
doc=App.newDocument()
Charge l'atelier Part et crée un nouveau document
l=Part.LineSegment()
l.StartPoint=(0.0,0.0,0.0)
l.EndPoint=(1.0,1.0,1.0)
La fonction Line décrit en fait un segment de ligne, d'où le point de départ et le point final.
doc.addObject("Part::Feature","Line").Shape=l.toShape()
Cette commande ajoute un objet de type Part (Pièce) au document et affecte la représentation de forme du segment de ligne à la propriété 'Shape' ('forme') de l'objet ajouté. Il est important de comprendre ici que nous avons utilisé une primitive géométrique (Part.LineSegment) pour créer un TopoShape à partir de celle-ci (la méthode toShape()). Seules les formes peuvent être ajoutées au document. Dans FreeCAD, les primitives géométriques sont utilisées comme des "structures de base" pour construire les formes.
doc.recompute()
Met à jour le document. Cela prépare également la représentation visuelle du nouvel objet Part.
Notez qu'une Line Segment (segment de ligne) peut être créée en spécifiant son point de départ et son point final directement dans le constructeur, par ex. Part.LineSegment(point1, point2) ou nous pouvons créer une ligne par défaut et définir ses propriétés après, comme nous l'avons fait ici.
Une ligne peut également être créée en utilisant :
import FreeCAD
import Part
DOC = FreeCAD.newDocument()
def mycreateLine(pt1, pt2, objName):
obj = DOC.addObject("Part::Line", objName)
obj.X1 = pt1[0]
obj.Y1 = pt1[1]
obj.Z1 = pt1[2]
obj.X2 = pt2[0]
obj.Y2 = pt2[1]
obj.Z2 = pt2[2]
DOC.recompute()
return obj
line = mycreateLine((0,0,0), (0,10,0), "LineName")
Un cercle peut être créé de la même manière:
import Part
doc = App.activeDocument()
c = Part.Circle()
c.Radius=10.0
f = doc.addObject("Part::Feature", "Circle")
f.Shape = c.toShape()
doc.recompute()
ou en utilisant :
import FreeCAD
import Part
DOC = FreeCAD.newDocument()
def mycreateCircle(rad, objName):
obj = DOC.addObject("Part::Circle", objName)
obj.Radius = rad
DOC.recompute()
return obj
circle = mycreateCircle(5.0, "CircleName")
Notez qu'une fois encore, nous avons utilisé le cercle (primitive géométrique) pour construire une forme. Nous pouvons bien sûr toujours accéder à notre géométrie de construction par la suite, en faisant:
s = f.Shape
e = s.Edges[0]
c = e.Curve
Ici on prend la forme de notre objet f, puis nous prenons la liste de ses arêtes. Dans ce cas il y aura une seule arête parce que nous avons fait toute la forme à partir d'un cercle unique, c'est pourquoi nous ne prenons que le premier élément de la liste des arêtes, et puis nous récupérons sa courbe. Chaque arête a une courbe, qui est la géométrie primitive, sur laquelle elle est basée.
Rendez-vous sur la page Scripts pour création topologique si vous voulez en savoir plus.
- Scripts FreeCAD : Python, Introduction à Python, Tutoriel sur les scripts Python, Débuter avec les scripts
- Modules : Modules intégrés, Unités, Quantity
- Ateliers : Création d'atelier, Commands Gui, Les commandes, Installer des ateliers supplémentaires
- Maillages et objets Parts : Scripts Mesh, Script de données topologiques, Conversion objet Mesh en Part, PythonOCC
- Objets paramétriques : Objets créés par script, Viewproviders (Icône personnalisée dans l'arborescence)
- Scénographie : Graphe de scène Coin (Inventor), Pivy
- Interface graphique : Création d'interface, Création d'une boite de dialogue (1, 2, 3, 4, 5), PySide, Exemples PySide débutant, intermédiaire, expérimenté
- Macros : Macros, Comment installer des macros
- Intégration : Intégrer FreeCAD, Intégration de FreeCADGui
- Autre : Expressions, Extraits de codes, Fonction - tracer une ligne, Bibliothèque mathématique vectorielle de FreeCAD (déprécié)
- Primitives : Box, Cylindre, Sphère, Cône, Tore, Tube, Primitives, Générateur de formes
- Création et modification des objets : Extrusion, Révolution, Miroir, Congé, Chanfrein, Créer une face, Surface réglée, Lissage, Balayage, Section, Coupes, Décalage 3D, Décalage 2D, Évidement, Projection sur surface, Ancrage
---
- Booléen : Créé un composé, Éclater le composé, Filtre composé, Opération booléenne, Soustraction, Union, Intersection, Connecter, Intégrer, Découper, Fragments booléens, Séparer/exploser, Scinder, OU exclusif
- Mesure : Mesure linéaire, Mesure Angulaire, Rafraîchir les mesures, Effacer toute mesure, Tout basculer, Mesures dans la 3D, Mesures selon le repère global
- Autre outils : Importation, Exportation, Sélection par zone, Forme à partir d'un maillage, Points à partir d'un maillage, Convertir en solide, Inverser les formes, Copie simple, Copie transformée, Copie d'un élément, Affiner la forme, Vérifier la géométrie, Supprimer la fonctionnalité, Apparence, Définir les couleurs