Jump to content

App DocumentObject

From FreeCAD Documentation
This page is a translated version of the page App DocumentObject and the translation is 100% complete.

Introduction

Un objet App DocumentObject, ou officiellement App::DocumentObject, est la classe de base de toutes les classes d'objets gérées dans le document.

De manière générale, un « DocumentObject » est tout « élément » pouvant apparaître dans l'arborescence et qui est enregistré et restauré lors de l'ouverture d'un document.

Arborescence affichant différents objets dans le document. Chacun d'entre eux est un « objet document », dérivé en fin de compte de la classe de base App::DocumentObject.

Diagramme simplifié des relations entre les objets clés dans Freecad

Utilisation

App DocumentObject est une classe interne, elle ne peut donc pas être créée à partir de l'interface graphique, ni destinée à être utilisée seule. Il définit simplement le comportement de base et les propriétés des objets dans le programme.

Certains des DocumentObjects les plus importants sont les suivants:

  • La classe App FeaturePython, un objet vide qui peut être utilisé à différentes fins, en fonction des propriétés ajoutées.
  • La classe App GeoFeature, l'objet de base de tous les objets géométriques, c'est-à-dire des objets qui ont une propriété Placement qui définit leur position dans la vue 3D.
  • La classe Part Feature, dérivée d'App GeoFeature, et la classe parent d'objets avec des formes topologiques 2D et 3D .
  • La classe Mesh Feature, dérivée d'App GeoFeature, et la classe parent d'objets avec des maillages 2D et 3D.

Propriétés

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

Voir Part Feature pour une explication des propriétés énumérées ci-dessous.

Données

Base

  • DonnéesLabel (String)
  • Données (Hidden)Label2 (String)
  • Données (Hidden)Expression Engine (ExpressionEngine)
  • Données (Hidden)Visibility (Bool)

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 DocumentObject est créé avec la méthode addObject() du document. Cependant, en général, il n'est pas nécessaire de créer cet objet manuellement. Il est généralement préférable de sous-classer l'une des sous-classes les plus complexes, par exemple, App FeaturePython, App GeoFeature, |Part Feature, Part Part2DObject, etc.

import FreeCAD as App

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