API de FreeCAD

From FreeCAD Documentation
Revision as of 13:01, 4 August 2018 by FuzzyBot (talk | contribs) (Updating to match new version of source page)

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)

Example:

import FreeCAD
print FreeCAD.listDocuments()
mydoc = FreeCAD.activeDocument()


Config Dump ( )

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

Returns: .

ConfigGet ( [chaîne] )

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

Returns: Une chaîne

. ConfigSet ( chaîne, chaîne )

Description: Définir la clé donnée (première chaîne) à la valeur donnée (deuxième chaîne de caractères)

Returns: .

Version ( )

Description: Imprime la version FreeCAD

Returns: .

activeDocument ( )

Description: Retour au document actif ou None s'il n'y a pas de document actif

Returns: . Un document FreeCAD

. addExportType ( chaîne, chaîne )

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

Returns: .

addImportType ( chaîne, chaîne)

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

Returns: .

closeDocument ( Nom du document )

Description: Ferme le document donné

Returns:

getDocument ( Nom du document )

Description: retourner un document ou lever une exception s'il n'existe aucun document avec le nom donné

Returns: .

getExportType ( chaîne )

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

Returns: . Une chaîne

. getImportType ( chaîne )

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

Returns: . Une chaîne

. listDocuments ( )

Description: Retourne un dictionnaire des noms et des pointeurs d'objet de tous les documents

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

NewDocument ( [chaîne] )

Description: Crée et retourne un nouveau document avec un nom donné. Le nom du document doit être unique, qui est automatiquement vérifié. Si aucun nom n'est fourni, le document sera nommé "Untitled"

Returns: . Le document nouvellement créé

. Open ( chaîne )

Description: Voir openDocument

Returns:

openDocument ( filepath )

Description: Créer et renvoyer un document et charger un fichier de projet dans le document. L'argument de chaîne doit pointer vers un fichier existant. S'il n'existe pas le fichier ou si le fichier ne peut être chargé une exception I/O est levée. Dans ce cas, le document créé est maintenu, mais sera vide

Returns: . Le document FreeCAD

. SetActiveDocument ( Nom du document )

Description: Définir le document actif par son nom

Returns: .