Part Part2DObject/fr: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{TOCright}}


== Introduction ==
== Introduction ==
Line 5: Line 6:
[[File:Tree_Part2D.svg|32px]]
[[File:Tree_Part2D.svg|32px]]


Un objet [[Part Part2DObject/fr|Part Part2DObject]] ou formellement un {{incode|Part::Part2DObject}}, est un élément simple associé à une [[Part_TopoShape/fr|une forme topologique]] qui peut être affiché dans la [[3D view/fr|Vue 3D]].
[[Part_Part2DObject/fr|Part Part2DObject]], ou formellement un {{incode|Part::Part2DObject}}, est un élément simple associé à une [[Part_TopoShape/fr|une forme topologique]] qui peut être affiché dans la [[3D_view/fr|Vue 3D]].


Le {{incode|Part::Part2DObject}} est dérivé d'un [[Part Feature/fr|Part Feature]] mais est spécialisé pour la géométrie 2D, étant donné que sa forme reposera sur un plan. Ce plan est défini par sa propriété {{PropertyData|Placement}} (position, normale et rotation). Cependant, le plan peut également être défini en prenant en charge des éléments géométriques, tel que le plan créé par trois sommets arbitraires ou une face d'un corps solide.
Le {{incode|Part::Part2DObject}} est dérivé de [[Part_Feature/fr|Part Feature]] mais est spécialisé pour la géométrie 2D, étant donné que sa forme reposera sur un plan. Ce plan est défini par sa propriété {{PropertyData|Placement}} (position, normale et rotation). Cependant, le plan peut également être défini en prenant en charge des éléments géométriques, tel que le plan créé par trois sommets arbitraires ou une face d'un corps solide.


[[File:FreeCAD_core_objects.svg|800px]]
[[File:FreeCAD_core_objects.svg|800px]]


{{Caption|Diagramme simplifié des relations entre les objets centraux du programme. La classe {{incode|Part::Part2DObject}} est spécialisée pour les formes 2D, c'est donc la classe de base pour les objets plans créés avec les ateliers Draft et Sketcher. Il comprend une extension qui lui permet d'être attaché aux faces et aux plans.}}
{{Caption|Diagramme simplifié des relations entre les objets centraux dans Freecad}}


== Utilisation ==
== Utilisation ==


[[Part Part2DObject/fr|Part Part2DObject]] est un objet interne. Par conséquent, il ne peut pas être créé à partir de l'interface graphique, uniquement à partir de la [[Python console/fr|Console Python]], comme décrit dans la section [[Part_Feature#Script|Script]].
[[Part_Part2DObject/fr|Part Part2DObject]] est un objet interne. Par conséquent, il ne peut pas être créé à partir de l'interface graphique, uniquement à partir de la [[Python_console/fr|Console Python]], comme décrit dans la section [[#Script|Script]].


{{incode|Part::Part2DObject}} est défini dans l'[[Part Workbench/fr|atelier Part]] mais peut être utilisé comme classe de base pour les [[scripted objects/fr|Objets créés par script]] dans tous les [[Workbenches/fr|Ateliers]] qui produisent des formes géométriques 2D. Par exemple, c'est l'objet de base pour les esquisses ([[Sketcher_SketchObject/fr|Sketcher SketchObject]]), et pour la plupart des objets créés avec l'[[Draft Workbench|atelier Draft]].
{{incode|Part::Part2DObject}} est défini dans l'[[Part_Workbench/fr|atelier Part]] mais peut être utilisé comme classe de base pour les [[Scripted_objects/fr|Objets créés par script]] dans tous les [[Workbenches/fr|Ateliers]] qui produisent des formes géométriques 2D. Par exemple, c'est l'objet de base pour les esquisses ([[Sketcher_SketchObject/fr|Sketcher SketchObject]]), et pour la plupart des objets créés avec l'[[Draft_Workbench|atelier Draft]].


Des ateliers peuvent ajouter plus de propriétés à cet élément de base pour produire un objet au comportement complexe.
Des ateliers peuvent ajouter plus de propriétés à cet élément de base pour produire un objet au comportement complexe.
Line 25: Line 26:
Voir [[Property/fr|Propriétés]] pour tous les types de propriétés que les objets scriptés peuvent avoir.
Voir [[Property/fr|Propriétés]] pour tous les types de propriétés que les objets scriptés peuvent avoir.


Un [[Part_Part2DObject/fr|Part Part2DObject]] (de classe {{incode|Part::Part2DObject}}) est dérivé d'un [[Part_Feature/fr|Part Feature]] (de classe {{incode|Part::Feature}}) de fait, il partage toutes les propriétés de cette dernière.
[[Part_Part2DObject/fr|Part Part2DObject]] (de classe {{incode|Part::Part2DObject}}) est dérivé de [[Part_Feature/fr|Part Feature]] (de classe {{incode|Part::Feature}}) et hérite de toutes ses propriétés.


Outre les propriétés décrites dans [[Part Feature/fr|Part Feature]], le corps de PartDesign a les propriétés suivantes dans l'[[property editor/fr|éditeur de propriétés]]. Les propriétés masquées peuvent être affichées en utilisant la commande {{MenuCommand|Show all}} dans le menu contextuel de l'[[property editor/fr|éditeur de propriétés]].
Le Part2DObject possède également les propriétés supplémentaires suivantes dans l'[[Property_editor/fr|éditeur de propriétés]]. Les propriétés cachées peuvent être affichées à l'aide de la commande {{MenuCommand|Show all}} du menu contextuel de l'[[Property_editor/fr|éditeur de propriétés]].


===Données===
===Données===


{{TitleProperty|Attachment}}
{{TitleProperty|Attachment}}
* {{PropertyData/fr|Map Mode|Enumeration}}: {{value|Deactivated}} "Désactivé" par défaut. Cette propriété détermine un plan que l'objet utilisera comme référence pour la géométrie 2D. En cliquant sur l'ellipse {{KEY|...}}, à droite du champ de saisie, s'ouvre le [[Task_panel/fr|Panneau des tâches]] de [[Part_EditAttachment/fr|Part Ancrage]] qui permet de sélectionner le plan de support en sélectionnant différents éléments dans le panneau de tâches [[3D_view/fr|Vue 3D]]. Les différents modes sont: {{value|Deactivated}}, {{value|Translate origin}}, {{value|Object's XY}}, {{value|Object's XZ}}, {{value|Object's YZ}}, {{value|Plane face}}, {{value|Tangent to surface}}, {{value|Normal to edge}}, {{value|Frenet NB}}, {{value|Frenet TN}}, {{value|Frenet TB}}, {{value|Concentric}}, {{value|Revolution section}}, {{value|Plane by 3 points}}, {{value|Normal to 3 points}}, {{value|Folding}}, {{value|Inertia 2-3}}, {{value|Align O-N-X}}, {{value|Align O-N-Y}}, {{value|Align O-X-Y}}, {{value|Align O-X-N}}, {{value|Align O-Y-N}}, {{value|Align O-Y-X}}.


* <div id="Property_Attacher_Type"></div>{{PropertyData|Attacher Type|String|Hidden}} : nom de la classe de l'objet moteur de l'attachement. La valeur par défaut est {{incode|Attacher::AttachEnginePlane}}.
Voir [[Part_EditAttachment/fr|Part Ancrage]] pour plus d'informations sur tous les modes de mappage.
* <div id="Property_Support"></div>{{PropertyData|Support|LinkSubList}} : il s'agit du plan ou de la face supportant la géométrie 2D. Par défaut, il s'agit d'une liste vide {{incode|[]}}.

* <div id="Property_Map_Mode"></div>{{PropertyData|Map Mode|Enumeration}} : {{value|Deactivated}} par défaut. Cette propriété détermine un plan que l'objet utilisera comme référence pour la géométrie 2D. En cliquant sur l'ellipse {{KEY|...}} (trois points), à droite du champ de saisie, lance la commande [[Part_EditAttachment/fr|Part Ancrage]] qui permet de sélectionner le plan de référence en choisissant différents éléments dans la [[3D_view/fr|Vue 3D]]. Les différents modes sont : {{value|Deactivated}}, {{value|Translate origin}}, {{value|Object's XY}}, {{value|Object's XZ}}, {{value|Object's YZ}}, {{value|Plane face}}, {{value|Tangent to surface}}, {{value|Normal to edge}}, {{value|Frenet NB}}, {{value|Frenet TN}}, {{value|Frenet TB}}, {{value|Concentric}}, {{value|Revolution section}}, {{value|Plane by 3 points}}, {{value|Normal to 3 points}}, {{value|Folding}}, {{value|Inertia 2-3}}, {{value|Align O-N-X}}, {{value|Align O-N-Y}}, {{value|Align O-X-Y}}, {{value|Align O-X-N}}, {{value|Align O-Y-N}}, {{value|Align O-Y-X}}.
Les deux propriétés suivantes sont normalement masquées. Ils deviennent visibles une fois que {{PropertyData/fr|Map Mode}} est autre chose que {{value|Deactivated}}.
* {{PropertyData/fr|Map Reversed|Bool}}: par défaut à {{FALSE}}, s'il est à {{TRUE}}, la direction Z sera inversée. Par exemple, un [[sketch/fr|sketch]] sera mis à l'envers.
* <div id="Property_Map_Reversed"></div>{{PropertyData|Map Reversed|Bool}} : sa valeur par défaut est {{FALSE}} ; si elle est {{TRUE}}, la direction Z sera inversée. Par exemple, une [[sketch/fr|esquisse]] sera retournée à l'envers. Caché si {{PropertyData|Map Mode}} est {{value|Deactivated}}.
* <div id="Property_Map_Path"></div>{{PropertyData|Map Path Parameter|Float|Hidden}} : définit le point de la courbe vers lequel mapper une [[sketch/fr|esquisse]]. Il va de {{value|0}} à {{value|1}}, qui correspondent aux {{value|start}} et {{value|end}}. La valeur par défaut est {{value|0}}.
* {{PropertyData/fr|Attachment Offset|Placement}}: la position de l'objet dans la [[3D view/fr|vue 3D]] par rapport au placement de l'objet attaché. Le placement est défini par un point {{incode|Base}} (vecteur) et {{incode|Rotation}} (axe et angle). Voir [[Placement/fr|Positionnement]].
* <div id="Property_Attachment_Offset"></div>{{PropertyData|Attachment Offset|Placement}} : la position de l'objet dans la [[3D_view/fr|Vue 3D]], par rapport au placement de l'objet d'attachement. L'emplacement est défini par un point {{incode|Base}} (vecteur) et un {{incode|Rotation}} (axe et angle). Voir [[Placement/fr|Placement]]. Masqué si {{PropertyData|Map Mode}} est {{value|Deactivated}}.

===== Propriétés cachées de Données =====

{{TitleProperty|Base}}

* {{PropertyData/fr|Proxy|PythonObject}}: classe personnalisée associée à cet objet. Cela n'existe que pour la version [[Python/fr|Python]]. Voir [[Part_Part2DObject/fr#Script|Script]].

{{TitleProperty|Attachment}}

* {{PropertyData/fr|Attacher Type|String}}: nom de classe de l'objet moteur d'attachement qui pilote l'ancrage. Par défaut {{incode|Attacher::AttachEnginePlane}}.
* {{PropertyData/fr|Support|LinkSubList}}: c'est le plan ou la face supportant la géométrie 2D. Par défaut, une liste vide {{incode|[]}}.
* {{PropertyData/fr|Map Path Parameter|Float}}: définit le point de la courbe sur laquelle mapper une [[sketch/fr|Esquisse]]. Il va de {{value|0}} à {{value|1}}, ce qui correspond aux {{value|start}} et {{value|end}}. Par défaut {{value|0}}.

=== Vue ===

{{TitleProperty|Grid}}
* {{PropertyView/fr|Grid Size|Length}}: une valeur flottante qui détermine la taille de l'espacement des lignes de grille locales dans la [[3D view/fr|Vue 3D]]. Par défaut {{value|10 mm}}.
* {{PropertyView/fr|Grid Snap|Bool}}: par défaut {{FALSE}}. Si mis à {{TRUE}}, la grille peut être utilisée pour capturer des points.
* {{PropertyView/fr|Grid Style|Enumeration}}: le style des lignes de la grille :{{value|Dashed}} (default) ou {{value|Light}}.
* {{PropertyView/fr|Show Grid|Bool}}: par défaut {{FALSE}}. Si mis à {{TRUE}}, une grille locale à l'objet sera affichée dans la [[3D view/fr|Vue 3D]]. Cette grille est indépendante de la [[Draft_ToggleGrid/fr|Bascule de l'affichage de la grille]].
* {{PropertyView/fr|Tight Grid|Bool}}: si mis à {{TRUE}}, valeur par defaut, la grille locale sera localisée autour de l'origine de la forme, sinon elle se prolongera davantage.

===== Propriétés cachées de Données =====

{{TitleProperty|Base}}

* {{PropertyView/fr|Proxy|PythonObject}}: classe personnalisée associée à cet objet. Cela n'existe que pour la version [[Python/fr|Python]]. Voir [[Part_Part2DObject/fr#Script|Script]].

Toutes les autres propriétés de vue, y compris les propriétés masquées, sont celles de l'objet de base [[Part_Feature/fr|Part Feature]]


== Script ==
== Script ==


{{Emphasis|Voir aussi:}} [[FreeCAD Scripting Basics/fr|FreeCAD Script de base]], et [[scripted objects/fr|objet scripté]].
{{Emphasis|Voir aussi :}} [[FreeCAD_Scripting_Basics/fr|Débuter avec les scripts]] et [[Scripted_objects/fr|Objets créés par script]].


Voir [[Part_Feature/fr|Part Feature]] pour les informations générales sur l'ajout d'objets au document.
Voir [[Part_Feature/fr|Part Feature]] pour les informations générales sur l'ajout d'objets au document.


Un Part2DObject est créé avec la méthode {{incode|addObject()}} du document.
Un Part2DObject est créé avec la méthode {{incode|addObject()}} du document.

{{Code|code=
{{Code|code=
import FreeCAD as App
import FreeCAD as App
Line 84: Line 57:
}}
}}


Pour la sous-classification de [[Python/fr|Python]], vous devez créer l'objet {{incode|Part::Part2DObjectPython}}.
Ce {{incode|Part::Feature}} de base n'a pas d'objet Proxy, il ne peut donc pas être entièrement utilisé pour la sous-classification.

Par conséquent, pour la sous-classe [[Python/fr|Python]], vous devez créer l'objet {{incode|Part::Part2DObjectPython}}.


{{Code|code=
{{Code|code=
Line 96: Line 67:
}}
}}


Par exemple, la plupart des outils de [[Draft_Workbench/fr|Atelier Draft]], comme [[Draft_Line/fr|Draft Ligne]], [[Draft_Rectangle/fr|Draft Rectangle]], [[Draft_Polygon/fr|Draft Polygone]] etc... sont des objets {{incode|Part::Part2DObjectPython}} avec une icône personnalisée et des propriétés supplémentaires.


{{Part Tools navi{{#translation:}}}}
{{Document_objects_navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 19:15, 13 July 2022

Introduction

Part Part2DObject, ou formellement un Part::Part2DObject, est un élément simple associé à une une forme topologique qui peut être affiché dans la Vue 3D.

Le Part::Part2DObject est dérivé de Part Feature mais est spécialisé pour la géométrie 2D, étant donné que sa forme reposera sur un plan. Ce plan est défini par sa propriété DonnéesPlacement (position, normale et rotation). Cependant, le plan peut également être défini en prenant en charge des éléments géométriques, tel que le plan créé par trois sommets arbitraires ou une face d'un corps solide.

Diagramme simplifié des relations entre les objets centraux dans Freecad

Utilisation

Part Part2DObject est un objet interne. Par conséquent, il ne peut pas être créé à partir de l'interface graphique, uniquement à partir de la Console Python, comme décrit dans la section Script.

Part::Part2DObject est défini dans l'atelier Part mais peut être utilisé comme classe de base pour les Objets créés par script dans tous les Ateliers qui produisent des formes géométriques 2D. Par exemple, c'est l'objet de base pour les esquisses (Sketcher SketchObject), et pour la plupart des objets créés avec l'atelier Draft.

Des ateliers peuvent ajouter plus de propriétés à cet élément de base pour produire un objet au comportement complexe.

Propriétés

Voir Propriétés pour tous les types de propriétés que les objets scriptés peuvent avoir.

Part Part2DObject (de classe Part::Part2DObject) est dérivé de Part Feature (de classe Part::Feature) et hérite de toutes ses propriétés.

Le Part2DObject possède également les propriétés supplémentaires suivantes dans l'éditeur de propriétés. Les propriétés cachées peuvent être affichées à l'aide de la commande Show all du menu contextuel de l'éditeur de propriétés.

Données

Attachment

  • Données (Hidden)Attacher Type (String) : nom de la classe de l'objet moteur de l'attachement. La valeur par défaut est Attacher::AttachEnginePlane.
  • DonnéesSupport (LinkSubList) : il s'agit du plan ou de la face supportant la géométrie 2D. Par défaut, il s'agit d'une liste vide [].
  • DonnéesMap Mode (Enumeration) : Deactivated par défaut. Cette propriété détermine un plan que l'objet utilisera comme référence pour la géométrie 2D. En cliquant sur l'ellipse ... (trois points), à droite du champ de saisie, lance la commande Part Ancrage qui permet de sélectionner le plan de référence en choisissant différents éléments dans la Vue 3D. Les différents modes sont : Deactivated, Translate origin, Object's XY, Object's XZ, Object's YZ, Plane face, Tangent to surface, Normal to edge, Frenet NB, Frenet TN, Frenet TB, Concentric, Revolution section, Plane by 3 points, Normal to 3 points, Folding, Inertia 2-3, Align O-N-X, Align O-N-Y, Align O-X-Y, Align O-X-N, Align O-Y-N, Align O-Y-X.
  • DonnéesMap Reversed (Bool) : sa valeur par défaut est false ; si elle est true, la direction Z sera inversée. Par exemple, une esquisse sera retournée à l'envers. Caché si DonnéesMap Mode est Deactivated.
  • Données (Hidden)Map Path Parameter (Float) : définit le point de la courbe vers lequel mapper une esquisse. Il va de 0 à 1, qui correspondent aux start et end. La valeur par défaut est 0.
  • DonnéesAttachment Offset (Placement) : la position de l'objet dans la Vue 3D, par rapport au placement de l'objet d'attachement. L'emplacement est défini par un point Base (vecteur) et un Rotation (axe et angle). Voir Placement. Masqué si DonnéesMap Mode est Deactivated.

Script

Voir aussi : Débuter avec les scripts et Objets créés par script.

Voir Part Feature pour les informations générales sur l'ajout d'objets au document.

Un Part2DObject est créé avec la méthode addObject() du document.

import FreeCAD as App

doc = App.newDocument()
obj = App.ActiveDocument.addObject("Part::Part2DObject", "Name")
obj.Label = "Custom label"

Pour la sous-classification de Python, vous devez créer l'objet Part::Part2DObjectPython.

import FreeCAD as App

doc = App.newDocument()
obj = App.ActiveDocument.addObject("Part::Part2DObjectPython", "Name")
obj.Label = "Custom label"