FeaturePython Custom Properties/fr

Introduction
Voir aussi : Documentation API générée automatiquement (documentation C++).

Les propriétés sont les véritables blocs de construction des objets FeaturePython. Grâce à elles, l'utilisateur pourra interagir et modifier votre objet. Après avoir créé un nouvel objet FeaturePython dans votre document :

Vous pouvez obtenir une liste des propriétés disponibles en émettant :



Créer un objet FeaturePython et lui ajouter une propriété
Ce code créera un objet avec le nom interne (automatiquement renommé en  et ainsi de suite, si un objet nommé  existe déjà) et lui affectera l'étiquette personnalisée. Cette étiquette sera affichée dans la Vue en arborescence. Les Expressions peuvent faire référence à cet objet par son étiquette en utilisant.

Pour ajouter une propriété à cet objet, utilisez la forme longue de comme indiqué ci-dessous. FreeCAD divisera automatiquement et l'affichera avec des espaces  dans l'Onglet Données de la vue Propriété.

est le type de la propriété. Les différents types sont décrits plus en détail ci-dessous.

Vous pouvez également utiliser la forme courte qui omet les deux derniers arguments. La sous-section a par défaut la valeur et l'infobulle n'est pas affichée avec ce formulaire.

Pour obtenir ou définir la propriété, utilisez :

Si le type de la propriété est App::PropertyEnumeration, le setter a un comportement spécial : la définition d'une liste de chaînes définit les cas autorisés par l'énumération, la définition d'une chaîne sélectionne l'un de ces cas. Pour définir la liste des cas possibles et définir le cas actuel, utilisez :

App::PropertyAcceleration
Une propriété acceleration. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyAngle
Une propriété d'angle. Elle peut contenir une valeur. Vous pouvez utiliser la variable "Value" pour obtenir une variable flottante. Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyArea
Une propriété area. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyBool
Une propriété booléenne. Elle peut contenir et. Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyBoolList
Une propriété contenant une liste de booléens. Elle peut contenir une liste Python de booléens, par exemple. Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyColor
Une propriété de couleur. Elle peut contenir un tuple de quatre valeurs. Chaque élément peut prendre des valeurs comprises entre 0.0 et 1.0. Vous pouvez définir les valeurs rouge, verte et bleue. Vous pouvez également définir la transparence des étapes. Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyColorList
Une propriété colorList. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyDirection
Identique à App::PropertyVectorDistance.

App::PropertyDistance
Une propriété de distance. Elle peut contenir une valeur positive, négative ou nulle. Utilisez le paramètre "Value" de la propriété pour obtenir la valeur sous forme de nombre flottant. La valeur est toujours en mm, mais dans l'éditeur de propriétés, elle est présentée avec les unités des préférences. Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLength est une propriété similaire qui ne peut pas contenir de valeur négative.

App::PropertyEnumeration
Une propriété de type énumération. Les éléments autorisés sont définis en donnant à la propriété la valeur d'une liste. Ensuite, elle peut contenir des éléments de la liste donnée. La liste des éléments autorisés peut être modifiée en donnant à nouveau à la propriété la valeur d'une liste. Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

A partir de FreeCAD 0.20, vous pouvez également grouper des énumérations, qui sont affichées dans l'interface graphique à l'aide d'une interface de sous-menu. Pour grouper, utilisez le caractère comme séparateur, par exemple :

Item A",   "Group 1

L'interface graphique affichera ceci comme une structure de menu :
 * Groupe 1
 * Elément A
 * Elément B
 * Groupe 2
 * Autre élément
 * Dernier élément

App::PropertyExpressionEngine
Une propriété expressionEngine. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyFile
Une propriété de nom de fichier. Elle peut contenir une chaîne de caractères indiquant le chemin d'accès à un nom de fichier :(autorise-t-elle les chemins relatifs ou absolus ou les deux ?). Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyFileIncluded
Une propriété de nom de fichier qui inclut également le fichier lui-même dans le document. Le fichier n'est pas chargé en mémoire, il est copié de l'archive du document dans le répertoire transitoire du document. Là, il est accessible en lecture. Vous pouvez obtenir le chemin d'accès transitoire par. Comme valeur, la propriété accepte une chaîne contenant le chemin d'accès au fichier d'origine. La propriété renvoie le chemin du fichier temporaire dans le répertoire transitoire. Pour plus de détails, voir cet exemple de l'atelier Arch.

App::PropertyFloat
Une propriété de flottant. Elle peut contenir une valeur. Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyFloatConstraint
Une propriété de contrainte flottante. Elle peut contenir une valeur. En utilisant cette propriété, vous pouvez définir les valeurs de début et de fin. Vous pouvez également définir un intervalle de pas. Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyFloatList
Une propriété de liste de valeurs flottantes. Elle peut contenir une liste de valeurs. Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyFont
Une propriété font. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyForce
Une propriété force. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyFrequency
Une propriété frequency. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyInteger
Une propriété entière. Elle peut contenir une valeur entière comprise entre -2147483646 et 2147483647 inclus. Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyIntegerConstraint
Une propriété de contrainte entière. Avec cette propriété, vous pouvez définir une valeur par défaut, une valeur minimale, une valeur maximale et une taille de pas. Toutes les valeurs doivent être des entiers et peuvent être comprises entre -2147483646 et 2147483647 inclus. Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyIntegerList
Une propriété de liste d'entiers. Elle peut contenir une liste de valeurs. Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyIntegerSet
Une propriété integerSet. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLength
Une propriété de longueur. Elle peut contenir une valeur positive ou nulle. Utilisez le paramètre "Value" de la propriété pour obtenir la valeur sous forme de nombre flottant. La valeur est toujours en mm mais dans l'éditeur de propriétés, elle est présentée avec les unités des préférences. Pour plus de détails, voir la section Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyDistance est une propriété similaire qui peut aussi contenir une valeur négative.

App::PropertyLink
Une propriété de lien. Elle peut contenir un lien vers un objet. Lorsque vous appelez cette propriété, elle renvoie l'objet lié. Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyLinkChild
Une propriété linkChild. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLinkGlobal
Une propriété linkGlobal. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLinkHidden
Une propriété linkHidden. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLinkList
Une propriété de liste de liens. Elle peut contenir une liste d'objets liés. Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyLinkListChild
Une propriété linkListChild. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLinkListGlobal
Une propriété linkListGlobal. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLinkListHidden
Une propriété linkListHidden. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLinkSub
Une propriété linkSub. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLinkSubChild
Une propriété linkSubChild. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLinkSubGlobal
Une propriété linkSubGlobal. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLinkSubHidden
Une propriété linkSubHidden. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLinkSubList
Une propriété linkSubList. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLinkSubListChild
Une propriété linkSubListChild. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLinkSubListGlobal
Une propriété linkSubListGlobal. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyLinkSubListHidden
Une propriété linkSubListHidden. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyMap
Une propriété map. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyMaterial
Une propriété de matériau. Elle peut contenir un objet matériau de FreeCAD. Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyMaterialList
Une propriété de liste de matériaux. Elle peut contenir une liste de matériaux. Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyMatrix
Une propriété matrix. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyPath
Une propriété de chemin. Elle peut contenir une chaîne de caractères représentant un chemin d'accès à un dossier :(autorise-t-elle également les chemins d'accès aux fichiers ? autorise-t-elle les chemins relatifs ou absolus, ou les deux ?) Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyPercent
Une propriété percent. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyPersistentObject
Une propriété persistentObject. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyPlacement
Une propriété de placement. Elle peut contenir un objet. Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyPlacementLink
Une propriété placementLink. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyPlacementList
Une propriété de liste de placement. Elle peut contenir une liste de. Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyPosition
Identique à App::PropertyVectorDistance.

App::PropertyPrecision
Une propriété precision. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyPressure
Une propriété pressure. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyPythonObject
Une propriété pythonObject. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyQuantity
Une propriété quantity. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyQuantityConstraint
Une propriété quantityConstraint. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertySpeed
Une propriété speed. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyString
Une propriété string. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyStringList
Une propriété stringList. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyUUID
Une propriété uUID. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyVacuumPermittivity
Une propriété vacuumPermittivity. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyVector
Une propriété vectorielle. Elle peut contenir un objet de FreeCAD. La valeur peut être définie en fournissant un vecteur ou un tuple. Pour plus de détails, voir la section Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyVectorDistance
Une propriété vectorielle qui est presque identique à App::PropertyVector. La seule différence est que dans l'éditeur de propriétés, les paramètres "x", "y" et "z" de cette propriété sont présentés avec des unités des préférences. Mais en interne, toutes les valeurs sont sans unité et donc en mm.

App::PropertyVectorList
Une propriété de liste de vecteurs. Elle peut contenir une liste de. La valeur peut être définie en fournissant une liste de vecteurs et/ou de tuples. Pour plus de détails, voir la section Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

App::PropertyVolume
Une propriété volume. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyXLink
Une propriété xLink. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyXLinkList
Une propriété xLinkList. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyXLinkSub
Une propriété xLinkSub. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

App::PropertyXLinkSubList
Une propriété xLinkSubList. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

Mesh::PropertyCurvatureList
Une propriété curvatureList. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

Mesh::PropertyMeshKernel
Une propriété de noyau de maillage. Elle peut contenir un objet. Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

Mesh::PropertyNormalList
Une propriété normalList. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

Part::PropertyFilletEdges
Une propriété filletEdges. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

Part::PropertyGeometryList
Une propriété geometryList. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

Part::PropertyPartShape
Une propriété de forme de pièce. Elle peut contenir un objet. Pour plus de détails, voir la section sur Création d'un objet FeaturePython et ajout d'une propriété à celui-ci.

Part::PropertyShapeHistory
Une propriété shapeHistory. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

Path::PropertyPath
Une propriété path. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

Path::PropertyTool
Une propriété tool. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

Path::PropertyTooltable
Une propriété tooltable. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

Sketcher::PropertyConstraintList
Une propriété constraintList. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

Spreadsheet::PropertyColumnWidths
Une propriété columnWidths. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

Spreadsheet::PropertyRowHeights
Une propriété rowHeights. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

Spreadsheet::PropertySheet
Une propriété sheet. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section sur Créer un objet FeaturePython et lui ajouter une propriété.

Spreadsheet::PropertySpreadsheetQuantity
Une propriété spreadsheetQuantity. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

TechDraw::PropertyCenterLineList
Une propriété centerLineList. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

TechDraw::PropertyCosmeticEdgeList
Une propriété cosmeticEdgeList. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

TechDraw::PropertyCosmeticVertexList
Une propriété cosmeticVertexList. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.

TechDraw::PropertyGeomFormatList
Une propriété geomFormatList. Elle peut contenir des "types et/ou valeurs autorisés". Pour plus de détails, voir la section Créer un objet FeaturePython et lui ajouter une propriété.