API des objets

From FreeCAD Documentation
Revision as of 08:13, 19 October 2019 by David69 (talk | contribs) (Created page with "{{VeryImportantMessage|(Octobre 2019) Ne modifiez pas cette page. L'information est incomplète et obsolète. Pour la dernière API, consultez la [https://www.freecadweb.org/a...")
Other languages:
(Octobre 2019) Ne modifiez pas cette page. L'information est incomplète et obsolète. Pour la dernière API, consultez la documentation de l'API générée automatiquement, ou générez la documentation vous-même, voir Source documentation.

Êtant paramétrique, les Objets Documents dans FreeCAD peuvent avoir beaucoup de propriétés supplémentaires, mais ce sont celles de base, présentes dans chaque Objet Document FreeCAD document. Les objets peuvent être récupérés tout simplement par leur nom. Exemple:

myObj = FreeCAD.ActiveDocument.myObjectName
print myObj.PropertiesList
Contenu

Returns: . Une représentation XML des propriétés d'un objet

Label

Returns: Obtient/définit l'étiquette des objets. La chaîne peut être unicode.

Nom

Returns: Le nom unique d'un objet.

Placement

Returns: Obtient/définit le placement d'un objet. Un placement définit une orientation (rotation) et une position (de base) dans l'espace 3D. Il est utilisé lorsque aucune mise à l'échelle ou autre distorsion n'est nécessaire.

PropertiesList

Returns: Une liste des propriétés d'un objet

État

Returns: L'état FreeCAD d'un objet (.-À-dire se il doit être recalculé)

Type

Returns: Une chaîne décrivant le type d'un objet

ViewObject

Returns: The View fournisseur associé (objet FreeCADGUI) d'un objet

getAllDerivedFrom ( )

Description:

Returns: Tous les descendants de cet objet

GetDocumentation propriété ( )

Description:

Returns: . La chaîne de documentation de la propriété de cette classe

getGroupOfProperty ( )

Description:

Returns: Le nom du groupe auquel la propriété appartient dans cette classe. Les propriétés sont classées dans différents groupes nommés pour plus de commodité.

getPropertyByName ( )

Description:

Returns: . La valeur d'une propriété nommée

getTypeOfProperty ( )

Description:

Returns: Le type d'une propriété nommée. Cela peut être (Hidden, ReadOnly,Output) ou toute combinaison.

isDerivedFrom ( )

Description:

Returns: Vrai si le type donné est un père

purgeTouched ( )

Description: Marque l'objet comme inchangé

Returns:

contact ( )

Description: Marque l'objet comme modifié (touché)

Returns: