FreeCAD API

From FreeCAD Documentation
Revision as of 19:26, 6 October 2019 by FuzzyBot (talk | contribs) (Updating to match new version of source page)
(October 2019) Do not edit this page. The information is incomplete and outdated. For the latest API, see the autogenerated API documentation, or generate the documentation yourself, see Source documentation.

Acesta este modulul principal (root) al FreeCAD. Poate fi numit și prin "App" de la interpretul FreeCAD. Conține tot ceea ce este necesar pentru a manipula documentele și conținutul lor (obiecte).

Exempluː

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

Description: Imprimă un dicționar care conține întregul mediu de configurare al FreeCAD

Returns: {{{4}}}

ConfigGet ( [string] )

Description: Returnează valoarea tastei date. Dacă nu este dată nici o tastă, configurația completă este returnată

Returns: Un șir.

ConfigSet ( string, string )

Description: Setați cheia dată (primul șir) la valoarea dată (al doilea șir) .

Returns:

Versiunea ( )

Description: Imprimă versiunea FreeCAD.

Returns:


activeDocument ( )

Description: Returnați documentul activ sau Niciunul dacă nu există document activ.

Returns: Un document FreeCAD.


addExportType ( string, string )

Description: Adaugă un nou tip de fișier de export în FreeCAD. Primul șir trebuie formatat ca în acest exemplu: "Document Word (* .doc)". Al doilea șir este numele unui script / modul python care conține o funcție de export ()

Returns:


addImportType ( șir, șir )

Description: Adaugă un nou tip de fișier de import în FreeCAD, funcționează la fel ca addExportType, modulul de manipulare python trebuie să conțină o funcție open () și / sau o funcție import ().

Returns:


closeDocument ( Denumire document )

Description: Închide documentul dat

Returns:

getDocument ( Nume document )

Description: Returnează un document sau ridică o excepție dacă nu există nici un document cu numele dat.

Returns:

getExportType ( string )

Description: Returnează numele modulului care poate exporta tipul de fișier specificat.

Returns: Un șir text.

getImportType ( string )

Description: Returnează numele modulului care poate importa tipul de fișier specificat.

Returns: Un șir.


listDocuments ( )

Description: Returnează un dicționar de nume și indicatori de obiecte din toate documentele.

Returns: Un dicționar de nume și indicatori de obiect.

newDocument ( [string] )

Description: Creează și returnează un nou document cu un nume dat. Numele documentului trebuie să fie unic, care este verificat automat. Dacă nu este furnizat niciun nume, documentul va fi denumit "Untitled".

Returns: Documentul nou creat.

open ( string )

Description: Vezi openDocument

Returns:

openDocument ( filepath )

Description: Creează și returnează un document și încarcă un fișier proiect în document. Argumentul string trebuie să indice un fișier existent. Dacă fișierul nu există sau fișierul nu poate fi încărcat, o excepție I / O este aruncată. În acest caz, documentul creat este păstrat, dar va fi gol.

Returns: Documentul FreeCAD deschis.

setActiveDocument ( Nume document )

Description: Setați documentul activ după numele acestuia.

Returns: