App FeaturePython

From FreeCAD Documentation
Revision as of 09:49, 30 December 2019 by David69 (talk | contribs) (Created page with "Voir Part Feature pour les informations générales sur l'ajout d'objets au programme.")
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. C'est une chaîne UTF8 arbitraire. 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

Base

  • 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.
Propriétés cachées de Vue
  • VueProxy (PythonObject): une classe de fournisseur de vue personnalisée associée à cet objet. Par defaut, vide.

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.

An App FeaturePython is created with the addObject() method of the document.

import FreeCAD as App

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

For example, the Draft Text, Draft Dimension, and Working plane proxy elements of the Draft Workbench are App::FeaturePython objects with a custom icon. They hold data but not an actual Part TopoShape.