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.


Este es el módulo principal (raíz) de FreeCAD. También puede ser llamado por "App" desde el interprete de FreeCAD. Contiene todo lo que es necesario para manipular documentos y sus contenidos (objectos).

Ejemplo:

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

Descripción: Muestra un diccionario conteniendo todo el entorno de configuración de FreeCAD.

Devuelve:



Method.png ConfigGet ( [string] )

Descripción: Devuelve el valor de una clave dada. Si no se indica la clave, devuelve la configuración completa.

Devuelve: Una cadena de texto.



Method.png ConfigSet ( string, string )

Descripción: Establece la clave dada (primera cadena de texto) al valor indicado (segunda cadena de texto).

Devuelve:



Method.png Version ( )

Descripción: Muestra la versión de FreeCAD.

Devuelve:



Method.png activeDocument ( )

Descripción:

Devuelve: Devuelve el documento activo o Nada si no hay ningún documento activo.



Method.png addExportType ( string, string )

Descripción: Añade un nuevo tipo de formato de archivo de exportación a FreeCAD. La primera cadena de texto debe estar formada como en este ejemplo: "Documento de Word (*.doc)". La segunda cadena es el nombre de un archivo de guión / módulo de Python conteniendo una función export().

Devuelve:



Method.png addImportType ( string, string )

Descripción: Añade un nuevo tipo de formato de archivo de importación a FreeCAD, funciona del mismo modo que addExportType, el módulo de Python debe contener una función open() y/o import().

Devuelve:



Method.png closeDocument ( Document name )

Descripción: Cierra el documento indicado

Devuelve:



Method.png getDocument ( Document name )

Descripción: Devuelve un documento o eleva una excepción si no existe un documento con el nombre indicado.

Devuelve:



Method.png getExportType ( string )

Descripción: Devuelve el nombre del módulo que puede exportar el tipo de archivo especificado.

Devuelve: Una cadena de texto.



Method.png getImportType ( string )

Descripción: Devuelve el nombre del módulo que puede exportar el tipo de archivo especificado.

Devuelve: Una cadena de texto.



Method.png listDocuments ( )

Descripción: Devuelve una lista de nombres de todos los documentos.

Devuelve: Una lista de nombres.



Method.png newDocument ( [string] )

Descripción: Crea y devuelve un nuevo documento con el nombre indicado. El nombre del documento debe ser único, lo que se comprueba de forma automática. Si no se indica ningún nombre, el documento se llamará "Untitled".

Devuelve: El nuevo documento creado.



Method.png open ( string )

Descripción: Ver openDocument

Devuelve:



Method.png openDocument ( filepath )

Descripción: Crea y devuelve un documento y carga un archivo de proyecto dentro del documento. La cadena de texto del argumento debe apuntar a un archivo existente. Si no existe el archivo o si no puede cargarse se lanza una excepción I/O. En este caso el documento creado se guarda, pero estará vacío.

Devuelve: El documento de FreeCAD abierto.



Method.png setActiveDocument ( Document name )

Descripción: Establece el documento activo por su nombre.

Devuelve: