Object API

From FreeCAD Documentation
Jump to: navigation, search
This page is a translated version of the page Object API and the translation is 100% complete.

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎română
(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
Property.png Contenu

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

Property.png Label

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

Property.png Nom

Returns: Le nom unique d'un objet.

Property.png 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.

Property.png PropertiesList

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

Property.png État

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

Property.png Type

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

Property.png ViewObject

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

Method.png getAllDerivedFrom ( )

Description:

Returns: Tous les descendants de cet objet

Method.png GetDocumentation propriété ( )

Description:

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

Method.png 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é.

Method.png getPropertyByName ( )

Description:

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

Method.png getTypeOfProperty ( )

Description:

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

Method.png isDerivedFrom ( )

Description:

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

Method.png purgeTouched ( )

Description: Marque l'objet comme inchangé

Returns:

Method.png contact ( )

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

Returns: