FreeCAD API

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

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎日本語 • ‎română
(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()
Method.png ConfigDump ( )

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

Returns: {{{4}}}

Method.png ConfigGet ( [string] )

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

Returns: Un șir.

Method.png ConfigSet ( string, string )

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

Returns:

Method.png Versiunea ( )

Description: Imprimă versiunea FreeCAD.

Returns:


Method.png activeDocument ( )

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

Returns: Un document FreeCAD.


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


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


Method.png closeDocument ( Denumire document )

Description: Închide documentul dat

Returns:

Method.png getDocument ( Nume document )

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

Returns:

Method.png getExportType ( string )

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

Returns: Un șir text.

Method.png getImportType ( string )

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

Returns: Un șir.


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

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

Method.png open ( string )

Description: Vezi openDocument

Returns:

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

Method.png setActiveDocument ( Nume document )

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

Returns: