Part scripting/fr: Difference between revisions

From FreeCAD Documentation
No edit summary
(Updating to match new version of source page)
Line 10: Line 10:
== Introduction ==
== Introduction ==


<div class="mw-translate-fuzzy">
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.
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.
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]].
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]].
</div>


<div class="mw-translate-fuzzy">
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.
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.
</div>


<div class="mw-translate-fuzzy">
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]].
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]].
</div>


===Voir aussi===
===Voir aussi===
Line 32: Line 38:


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.
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=
{{Code|code=
$INSTALL_DIR/Mod/Part/parttests/part_test_objects.py
$INSTALL_DIR/Mod/Part/parttests/part_test_objects.py
Line 38: Line 45:
==Exemples==
==Exemples==


===Line===

<div class="mw-translate-fuzzy">
Pour créer un élément ligne, passer à la console Python et taper :
Pour créer un élément ligne, passer à la console Python et taper :
</div>


{{Code|code=
{{Code|code=
import Part,PartGui
import FreeCAD as App
import Part
doc=App.newDocument()

l=Part.LineSegment()
doc = App.newDocument()
l.StartPoint=(0.0,0.0,0.0)

l.EndPoint=(1.0,1.0,1.0)
line = Part.LineSegment()
doc.addObject("Part::Feature","Line").Shape=l.toShape()
line.StartPoint = (0.0, 0.0, 0.0)
line.EndPoint = (1.0, 1.0, 1.0)
obj = doc.addObject("Part::Feature", "Line")
obj.Shape= line.toShape()

doc.recompute()
doc.recompute()
}}
}}


<div class="mw-translate-fuzzy">
Passons en revue l'exemple Python ci-dessus étape par étape :
Passons en revue l'exemple Python ci-dessus étape par étape :
</div>


{{Code|code=
{{Code|code=
import Part,PartGui
import FreeCAD as App
import Part
doc=App.newDocument()
doc = App.newDocument()
}}
}}


<div class="mw-translate-fuzzy">
Charge l'atelier Part et crée un nouveau document
Charge l'atelier Part et crée un nouveau document
</div>


{{Code|code=
{{Code|code=
l=Part.LineSegment()
line = Part.LineSegment()
l.StartPoint=(0.0,0.0,0.0)
line.StartPoint = (0.0, 0.0, 0.0)
l.EndPoint=(1.0,1.0,1.0)
line.EndPoint = (1.0, 1.0, 1.0)
}}
}}


Line 68: Line 89:


{{Code|code=
{{Code|code=
doc.addObject("Part::Feature","Line").Shape=l.toShape()
obj = doc.addObject("Part::Feature", "Line")
obj.Shape= line.toShape()
}}
}}


<div class="mw-translate-fuzzy">
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.
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.
</div>


{{Code|code=
{{Code|code=
Line 77: Line 101:
}}
}}


<div class="mw-translate-fuzzy">
Met à jour le document. Cela prépare également la représentation visuelle du nouvel objet Part.
Met à jour le document. Cela prépare également la représentation visuelle du nouvel objet Part.
</div>


<div class="mw-translate-fuzzy">
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.
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.
</div>


<div class="mw-translate-fuzzy">
Une ligne peut également être créée en utilisant :
Une ligne peut également être créée en utilisant :
</div>


{{Code|code=
{{Code|code=
import FreeCAD
import FreeCAD as App
import Part
import Part
DOC = FreeCAD.newDocument()


def mycreateLine(pt1, pt2, objName):
def my_create_line(pt1, pt2, obj_name):
obj = DOC.addObject("Part::Line", objName)
obj = App.ActiveDocument.addObject("Part::Line", obj_name)
obj.X1 = pt1[0]
obj.X1 = pt1[0]
obj.Y1 = pt1[1]
obj.Y1 = pt1[1]
Line 98: Line 127:
obj.Z2 = pt2[2]
obj.Z2 = pt2[2]


DOC.recompute()
App.ActiveDocument.recompute()
return obj
return obj


line = mycreateLine((0,0,0), (0,10,0), "LineName")
line = my_create_line((0, 0, 0), (0, 10, 0), "LineName")
}}
}}

===Circle===


Un cercle peut être créé de la même manière:
Un cercle peut être créé de la même manière:


{{Code|code=
{{Code|code=
import FreeCAD as App
import Part
import Part

doc = App.activeDocument()
doc = App.activeDocument()

c = Part.Circle()
circle = Part.Circle()
c.Radius=10.0
circle.Radius = 10.0
f = doc.addObject("Part::Feature", "Circle")
obj = doc.addObject("Part::Feature", "Circle")
f.Shape = c.toShape()
obj.Shape = circle.toShape()

doc.recompute()
doc.recompute()
}}
}}


<div class="mw-translate-fuzzy">
ou en utilisant :
ou en utilisant :
</div>


{{Code|code=
{{Code|code=
import FreeCAD
import FreeCAD as App
import Part
import Part
DOC = FreeCAD.newDocument()


def mycreateCircle(rad, objName):
def my_create_circle(rad, obj_name):
obj = DOC.addObject("Part::Circle", objName)
obj = App.ActiveDocument.addObject("Part::Circle", obj_name)
obj.Radius = rad
obj.Radius = rad


DOC.recompute()
App.ActiveDocument.recompute()
return obj
return obj


circle = mycreateCircle(5.0, "CircleName")
circle = my_create_circle(5.0, "CircleName")
}}
}}


<div class="mw-translate-fuzzy">
ou créer un cercle défini par son centre, son axe et son rayon en utilisant :
ou créer un cercle défini par son centre, son axe et son rayon en utilisant :
</div>


{{Code|code=
{{Code|code=
import FreeCAD as App
import Part
import Part

doc = App.activeDocument()
doc = App.activeDocument()

center = App.Vector(1,2,3)
axis = App.Vector(1,1,1)
center = App.Vector(1, 2, 3)
axis = App.Vector(1, 1, 1)
radius = 10
radius = 10
c=Part.Circle(center,axis,radius)
circle = Part.Circle(center, axis, radius)
f = doc.addObject("Part::Feature", "Circle")
obj = doc.addObject("Part::Feature", "Circle")
f.Shape = c.toShape()
obj.Shape = circle.toShape()

doc.recompute()
doc.recompute()
}}
}}


<div class="mw-translate-fuzzy">
ou créer un cercle défini par trois points en utilisant :
ou créer un cercle défini par trois points en utilisant :
</div>


{{Code|code=
{{Code|code=
import FreeCAD as App
import Part
import Part

doc = App.activeDocument()
doc = App.activeDocument()

p1 = App.Vector(10,0,0)
p2 = App.Vector(0,10,0)
p1 = App.Vector(10, 0, 0)
p3 = App.Vector(0,0,10)
p2 = App.Vector(0, 10, 0)
c = Part.Circle(p1,p2,p3)
p3 = App.Vector(0, 0, 10)
circle = Part.Circle(p1, p2, p3)
f = doc.addObject("Part::Feature", "Circle")
obj = doc.addObject("Part::Feature", "Circle")
f.Shape = c.toShape()
obj.Shape = circle.toShape()

doc.recompute()
doc.recompute()
}}
}}


<div class="mw-translate-fuzzy">
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:
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:
</div>


{{Code|code=
{{Code|code=
s = f.Shape
shape = obj.Shape
e = s.Edges[0]
edge = shape.Edges[0]
c = e.Curve
curve = edge.Curve
}}
}}


<div class="mw-translate-fuzzy">
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.
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.
</div>

===Arc===

An arc can be created like this:

{{Code|code=
import FreeCAD as App
import Part

doc = App.activeDocument()

p1 = App.Vector(10, 0, 0)
p2 = App.Vector(0, 10, 0)
p3 = App.Vector(-10, 0, 0)
arc = Part.Arc(p1, p2, p3)
obj = doc.addObject("Part::Feature", "Arc")
obj.Shape = arc.toShape()

doc.recompute()
}}

This draws a half circle. The center is at (0, 0, 0). The radius is 10. P1 is the start point on +X axis. P2 is the middle point on +Y axis and P3 is the end point on -X axis.

You can also create an arc from a circle:

{{Code|code=
import FreeCAD as App
import Part

doc = App.activeDocument()

p1 = App.Vector(10, 0, 0)
p2 = App.Vector(0, 10, 0)
p3 = App.Vector(-10, 0, 0)
circle = Part.Circle(p1, p2, p3)
arc = Part.ArcOfCircle(circle, 0.0, 0.7854)
obj = doc.addObject("Part::Feature", "Arc")
obj.Shape = arc.toShape()

doc.recompute()
}}


It needs a circle, and a start angle and end angle in radians.
Rendez-vous sur la page [[Topological_data_scripting/fr|Scripts pour création topologique]] si vous voulez en savoir plus.





Revision as of 20:35, 13 February 2022

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

Line

Pour créer un élément ligne, passer à la console Python et taper :

import FreeCAD as App
import Part

doc = App.newDocument()

line = Part.LineSegment()
line.StartPoint = (0.0, 0.0, 0.0)
line.EndPoint = (1.0, 1.0, 1.0)
obj = doc.addObject("Part::Feature", "Line")
obj.Shape= line.toShape()

doc.recompute()

Passons en revue l'exemple Python ci-dessus étape par étape :

import FreeCAD as App
import Part
doc = App.newDocument()

Charge l'atelier Part et crée un nouveau document

line = Part.LineSegment()
line.StartPoint = (0.0, 0.0, 0.0)
line.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.

obj = doc.addObject("Part::Feature", "Line")
obj.Shape= line.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 as App
import Part

def my_create_line(pt1, pt2, obj_name):
    obj = App.ActiveDocument.addObject("Part::Line", obj_name)
    obj.X1 = pt1[0]
    obj.Y1 = pt1[1]
    obj.Z1 = pt1[2]

    obj.X2 = pt2[0]
    obj.Y2 = pt2[1]
    obj.Z2 = pt2[2]

    App.ActiveDocument.recompute()
    return obj

line = my_create_line((0, 0, 0), (0, 10, 0), "LineName")

Circle

Un cercle peut être créé de la même manière:

import FreeCAD as App
import Part

doc = App.activeDocument()

circle = Part.Circle() 
circle.Radius = 10.0  
obj = doc.addObject("Part::Feature", "Circle")
obj.Shape = circle.toShape()

doc.recompute()

ou en utilisant :

import FreeCAD as App
import Part

def my_create_circle(rad, obj_name):
    obj = App.ActiveDocument.addObject("Part::Circle", obj_name)
    obj.Radius = rad

    App.ActiveDocument.recompute()
    return obj

circle = my_create_circle(5.0, "CircleName")

ou créer un cercle défini par son centre, son axe et son rayon en utilisant :

import FreeCAD as App
import Part

doc = App.activeDocument()

center = App.Vector(1, 2, 3)
axis = App.Vector(1, 1, 1)
radius = 10
circle = Part.Circle(center, axis, radius)
obj = doc.addObject("Part::Feature", "Circle")
obj.Shape = circle.toShape()

doc.recompute()

ou créer un cercle défini par trois points en utilisant :

import FreeCAD as App
import Part

doc = App.activeDocument()

p1 = App.Vector(10, 0, 0)
p2 = App.Vector(0, 10, 0)
p3 = App.Vector(0, 0, 10)
circle = Part.Circle(p1, p2, p3)
obj = doc.addObject("Part::Feature", "Circle")
obj.Shape = circle.toShape()

doc.recompute()

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:

shape = obj.Shape
edge = shape.Edges[0]
curve = edge.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.

Arc

An arc can be created like this:

import FreeCAD as App
import Part

doc = App.activeDocument()

p1 = App.Vector(10, 0, 0)
p2 = App.Vector(0, 10, 0)
p3 = App.Vector(-10, 0, 0)
arc = Part.Arc(p1, p2, p3)
obj = doc.addObject("Part::Feature", "Arc")
obj.Shape = arc.toShape()

doc.recompute()

This draws a half circle. The center is at (0, 0, 0). The radius is 10. P1 is the start point on +X axis. P2 is the middle point on +Y axis and P3 is the end point on -X axis.

You can also create an arc from a circle:

import FreeCAD as App
import Part

doc = App.activeDocument()

p1 = App.Vector(10, 0, 0)
p2 = App.Vector(0, 10, 0)
p3 = App.Vector(-10, 0, 0)
circle = Part.Circle(p1, p2, p3)
arc = Part.ArcOfCircle(circle, 0.0, 0.7854)
obj = doc.addObject("Part::Feature", "Arc")
obj.Shape = arc.toShape()

doc.recompute()

It needs a circle, and a start angle and end angle in radians.