FreeCAD API

From FreeCAD Documentation
Jump to navigation Jump to search
This page is a translated version of the page FreeCAD API and the translation is 100% complete.
Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎polski • ‎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.

C'est le module principal (root) de FreeCAD. Il peut également être appelé par "App" de l'interprète FreeCAD. Il contient tout ce qui est nécessaire pour manipuler des documents et leur contenu (objets)

Exemple:

import FreeCAD
print FreeCAD.listDocuments()
mydoc = FreeCAD.activeDocument()
Method.png ConfigDump( )

Description: Imprime un dictionnaire contenant tout l'environnement de configuration FreeCAD.

Returns:

Method.png ConfigGet([string])

Description: Renvoie la valeur de la clé donnée. Si aucune clé n'est fournie, la configuration complète est renvoyée

Returns: Une chaîne.

Method.png ConfigSet(string, string)

Description: Définit la clé donnée (première chaîne) sur la valeur donnée (deuxième chaîne).

Returns:

Method.png Version( )

Description: Imprime la version FreeCAD.

Returns:

Method.png activeDocument( )

Description: Renvoie le document actif ou Aucun s'il n'y a pas de document actif.

Returns: Un document FreeCAD.

Method.png addExportType(string, string)

Description: Ajoute un nouveau type de fichier d'exportation à FreeCAD. La première chaîne doit être formatée comme cet exemple: "Document Word (*.doc)". La deuxième chaîne est le nom d'un script/module python contenant une fonction export().

Returns:

Method.png addImportType(string, string)

Description: Ajoute un nouveau type de fichier d'importation à FreeCAD, fonctionne de la même manière que addExportType, le module de gestion python doit contenir une fonction open() et/ou import().

Returns:

Method.png closeDocument(Nom du document)

Description: Ferme le document donné

Returns:

Method.png getDocument(Nom du document)

Description: Renvoie un document ou déclenche une exception s'il n'y a pas de document avec le nom donné.

Returns:

Method.png getExportType(string)

Description: Renvoie le nom du module qui peut exporter le type de fichier spécifié.

Returns: Une chaîne.

Method.png getImportType(string)

Description: Renvoie le nom du module qui peut importer le type de fichier spécifié.

Returns: Une chaîne.

Method.png listDocuments( )

Description: Renvoie un dictionnaire de noms et de pointeurs d'objet de tous les documents.

Returns: Un dictionnaire de noms et de pointeurs d'objet.

Method.png newDocument([string], [hidden=False])

Description: Crée et renvoie un nouveau document avec un nom donné. Le nom du document doit être unique, ce qui est vérifié automatiquement. Si aucun nom n'est fourni, le document sera nommé "Sans titre". Si hidden=True est passé, FreeCAD en mode GUI n'affichera pas le document et n'affichera pas d'onglet pour le document; cela permet d'effectuer des opérations automatiques sur un document temporaire (ou de créer un document et de l'enregistrer) sans perturber l'interface utilisateur.

Returns: Le document nouvellement créé.

Method.png open(string)

Description: Voir openDocument

Returns:

Method.png openDocument(filepath, [hidden])

Description: Crée et renvoie un document et charge un fichier projet dans le document. L'argument chaîne doit pointer vers un fichier existant. Si le fichier n'existe pas ou si le fichier ne peut pas être chargé, une exception d'E / S est levée. Dans ce cas, le document créé est conservé, mais sera vide. Si hidden=True est passé, FreeCAD en mode GUI n'affichera pas le document et n'affichera pas d'onglet pour le document; cela permet d'effectuer des opérations automatiques sur un document et de le fermer sans perturber l'interface utilisateur.

Returns: Le document FreeCAD ouvert.

Method.png setActiveDocument(Nom du document)

Description: Définit le document actif par son nom.

Returns: