FreeCAD API

From FreeCAD Documentation
Revision as of 21:00, 27 February 2020 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.

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()
ConfigDump ( )

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

Devuelve:



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.



ConfigSet ( string, string )

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

Devuelve:



Version ( )

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

Devuelve:



activeDocument ( )

Descripción:

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



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:



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:



closeDocument ( Document name )

Descripción: Cierra el documento indicado

Devuelve:



getDocument ( Document name )

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

Devuelve:



getExportType ( string )

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

Devuelve: Una cadena de texto.



getImportType ( string )

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

Devuelve: Una cadena de texto.



listDocuments ( )

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

Devuelve: Una lista de nombres.



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.



open ( string )

Descripción: Ver openDocument

Devuelve:



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.



setActiveDocument ( Document name )

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

Devuelve: