App FeaturePython/fr: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
Line 42: Line 42:
=== Vue ===
=== Vue ===


These properties correspond to the basic properties of the base [[viewprovider|viewprovider]], {{incode|Gui::ViewProviderDocumentObject}}, that is inherited by all viewproviders in the software.
{{TitleProperty|Base}}


<div class="mw-translate-fuzzy">
* {{PropertyView/fr|Display Mode|Enumeration}}: vide par défaut.
* {{PropertyView/fr|Display Mode|Enumeration}}: vide par défaut.
* {{PropertyView/fr|On Top When Selected|Enumeration}}: {{value|Disabled}} (défaut), {{value|Enabled}}, {{value|Object}}, {{value|Element}}.
* {{PropertyView/fr|On Top When Selected|Enumeration}}: {{value|Disabled}} (défaut), {{value|Enabled}}, {{value|Object}}, {{value|Element}}.
Line 49: Line 50:
* {{PropertyView/fr|Show In Tree|Bool}}: s'il s'agit de {{TRUE}}, l'objet apparaît dans la [[tree view|vue arborescente]]. Sinon, il est défini comme invisible.
* {{PropertyView/fr|Show In Tree|Bool}}: s'il s'agit de {{TRUE}}, l'objet apparaît dans la [[tree view|vue arborescente]]. Sinon, il est défini comme invisible.
* {{PropertyView/fr|Visibility|Bool}}: s'il s'agit de {{TRUE}}, l'objet apparaît dans la [[3D view/fr|Vue 3D]]; sinon, il est invisible. Par défaut, cette propriété peut être activée et désactivée en appuyant sur la barre {{KEY|Espace}} du clavier.
* {{PropertyView/fr|Visibility|Bool}}: s'il s'agit de {{TRUE}}, l'objet apparaît dans la [[3D view/fr|Vue 3D]]; sinon, il est invisible. Par défaut, cette propriété peut être activée et désactivée en appuyant sur la barre {{KEY|Espace}} du clavier.
</div>

{{TitleProperty|Selection}}

* {{PropertyView|On Top When Selected|Enumeration}}: {{value|Disabled}} (default), {{value|Enabled}}, {{value|Object}}, {{value|Element}}.
* {{PropertyView|Selection Style|Enumeration}}: {{value|Shape}} (default), {{value|BoundBox}}. If the option is {{value|Shape}}, the entire shape (vertices, edges, and faces) will be highlighted in the [[3D view|3D view]]; if it is {{value|BoundBox}} only the bounding box will be highlighted.


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


<div class="mw-translate-fuzzy">
* {{PropertyView/fr|Proxy|PythonObject}}: une classe de fournisseur de vue personnalisée associée à cet objet.
* {{PropertyView/fr|Proxy|PythonObject}}: une classe de fournisseur de vue personnalisée associée à cet objet.
</div>

* {{PropertyView|Proxy|PythonObject}}: a custom view provider class associated with this object.


== Script ==
== Script ==

Revision as of 18:54, 10 September 2020

Other languages:

Introduction

Un objet App FeaturePython, ou officiellement App::FeaturePython, est une simple instance de App DocumentObject dans Python.

Il s'agit d'un objet simple qui, par défaut, n'a pas beaucoup de propriétés, par exemple, pas de Positionnement ni forme topologique. Cet objet est destiné à un usage général, et en lui donnant des propriétés. Il peut être utilisé pour gérer différents types de données.

Diagramme simplifié des relations entre les objets centraux du programme. La classe App::FeaturePython est une implémentation simple de App::DocumentObject qui peut être utilisée à n'importe quelle fin, car elle n'a pas de TopoShape par défaut.

Utilisation

App FeaturePython est un objet interne. Il ne peut donc pas être créé à partir de l'interface graphique. Il est censé être sous-classé par des classes qui géreront différents types de données.

Voir Script pour plus d'informations.

Propriétés

Une classe App FeaturePython (App::FeaturePython classe) est dérivée de la classe de base App DocumentObject (App::DocumentObject classe).Elle partage toutes les propriétés de cette dernière.

En plus des propriétés décrites dans App DocumentObject, FeaturePython possède un fournisseur de vues de base, il apparaît donc dans la vue arborescente.

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

Ce sont les propriétés disponibles dans l'éditeur de propriétés. Les propriétés masquées peuvent être affichées en utilisant la commande Show all dans le menu contextuel de l'éditeur de propriétés.

Données

Base

  • DonnéesLabel (String): le nom modifiable par l'utilisateur de cet objet, il s'agit d'une chaîne UTF8 arbitraire.
Propriétés cachées de Données
  • DonnéesExpression Engine (ExpressionEngine): une liste d'expressions. Par défaut, elle est vide [].
  • DonnéesLabel2 (String): description plus longue et modifiable par l'utilisateur de cet objet, il s'agit d'une chaîne UTF8 arbitraire qui peut inclure des retours à la ligne. Par défaut, il s'agit d'une chaîne vide "".
  • DonnéesProxy (PythonObject): classe associée à cet objet.
  • DonnéesVisibility (Bool): affiche ou non l'objet.

Vue

These properties correspond to the basic properties of the base viewprovider, Gui::ViewProviderDocumentObject, that is inherited by all viewproviders in the software.

  • VueDisplay Mode (Enumeration): vide par défaut.
  • VueOn Top When Selected (Enumeration): Disabled (défaut), Enabled, Object, Element.
  • VueSelection Style (Enumeration): Shape (défaut), BoundBox. Si l'option est Shape, la forme entière (sommets, arêtes et faces) sera mise en surbrillance dans la Vue 3D; s'il s'agit de BoundBox, seul le cadre de sélection sera mis en surbrillance.
  • VueShow In Tree (Bool): s'il s'agit de true, l'objet apparaît dans la vue arborescente. Sinon, il est défini comme invisible.
  • VueVisibility (Bool): s'il s'agit de true, l'objet apparaît dans la Vue 3D; sinon, il est invisible. Par défaut, cette propriété peut être activée et désactivée en appuyant sur la barre Espace du clavier.

Selection

  • VueOn Top When Selected (Enumeration): Disabled (default), Enabled, Object, Element.
  • VueSelection Style (Enumeration): Shape (default), BoundBox. If the option is Shape, the entire shape (vertices, edges, and faces) will be highlighted in the 3D view; if it is BoundBox only the bounding box will be highlighted.
Propriétés cachées de Vue
  • VueProxy (PythonObject): une classe de fournisseur de vue personnalisée associée à cet objet.
  • VueProxy (PythonObject): a custom view provider class associated with this object.

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

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

import FreeCAD as App

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

Par exemple, les éléments Draft Text, Draft Dimension et Proxy pour plan de travail de l'Atelier Draft sont des App::FeaturePython objets avec une icône personnalisée et des propriétés additionnelles. Ils contiennent des données mais pas une Part TopoShape réelle.

Si l'objet souhaité doit avoir un placement, une forme, une pièce jointe ou d'autres propriétés complexes, il est préférable de créer l'une des classes les plus complexes, par exemple, App GeoFeature, Part Feature ou Part Part2DObject.