API di FreeCAD

From FreeCAD Documentation
Revision as of 20:49, 8 October 2019 by Renatorivo (talk | contribs)
(Ottobre 2019) Non modificare queste pagine. Le informazioni sono incomplete e obsolete. Per l'API più recente, consultare la documentazione API autogenerata o generare la documentazione autonomamente. Vedere Documentazione del codice sorgente.

Questo è il modulo principale (root) di FreeCAD. Può anche essere chiamato con "App" dall'interprete FreeCAD. Contiene tutto quello che serve per manipolare i documenti e il loro contenuto (oggetti).

Esempio:

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

Description: Stampa un dizionario contenente tutto l'ambiente di configurazione di FreeCAD.

Returns:

ConfigGet([string])

Description: Restituisce il valore della chiave data. Se non si specifica nessuna chiave, viene restituita la configurazione completa

Returns: Una stringa.

ConfigSet(string, string)

Description: Imposta la chiave data (prima stringa) al valore dato (seconda stringa).

Returns:

Version( )

Description: Stampa la versione di FreeCAD.

Returns:

activeDocument( )

Description: Restituisce il documento attivo o Nulla se non vi è alcun documento attivo.

Returns: Un documento di FreeCAD.

addExportType(string, string)

Description: Aggiunge a FreeCAD un nuovo tipo di file di esportazione. La prima stringa deve essere formattata come in questo esempio: "Documento di Word (*.doc)". La seconda stringa è il nome di uno script / modulo python che contiene una funzione export().

Returns:

addImportType(string, string)

Description: Aggiunge a FreeCAD un nuovo tipo di file importazione, funziona allo stesso modo di addExportType, il modulo di gestione python deve contenere una funzione open() e/o una funzione import().

Returns:

closeDocument(Document name)

Description: Chiude un dato documento

Returns:

getDocument(Document name)

Description: Restituisce un documento o solleva un'eccezione se non vi è alcun documento con il nome dato.

Returns:

getExportType(string)

Description: Restituisce il nome del modulo che può esportare il tipo di file specificato.

Returns: Una stringa.

getImportType(string)

Description: Restituisce il nome del modulo che può importare il tipo di file specificato.

Returns: Una stringa.

listDocuments( )

Description: Restituisce un dizionario di nomi e di puntatori di oggetti di tutti i documenti.

Returns: Un dizionario di nomi e di puntatori di oggetti.

newDocument([string])

Description: Crea e restituisce un nuovo documento con un determinato nome. Il nome del documento deve essere univoco, e viene controllato automaticamente. Se non viene fornito nessun nome, il documento sarà "Senza titolo".

Returns: Il documento appena creato.

open(string)

Description: Vedere openDocument

Returns:

openDocument(filepath)

Description: Crea e restituisce un documento e carica un file di progetto nel documento. L'argomento stringa deve puntare ad un file esistente. Se il file non esiste o il file non può essere caricato viene generata una eccezione di I /O. In questo caso il documento creato viene mantenuto, ma sarà vuoto.

Returns: Il documento di FreeCAD aperto.

setActiveDocument(Document name)

Description: Imposta il documento attivo con il suo nome.

Returns: