FreeCAD-Doc/localwiki/FreeCAD_API-es.html
2018-07-19 18:47:02 -05:00

199 lines
9.3 KiB
HTML

<html><head><title>FreeCAD API/es</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type='text/css' href='wiki.css' rel='stylesheet'></head><body><h1>FreeCAD API/es</h1></div>
<div id="mw-content-text" lang="es" dir="ltr" class="mw-content-ltr"><hr/><div class="mw-parser-output"><p>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).
</p><p>Ejemplo:
</p>
<pre>import FreeCAD
print FreeCAD.listDocuments()
mydoc = FreeCAD.activeDocument() </pre>
<p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>ConfigDump</b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> Muestra un diccionario conteniendo todo el entorno de configuración de FreeCAD.
</p><p><small><b>Devuelve</b>:</small>
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>ConfigGet</b></big> ( <i>[string]</i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> Devuelve el valor de una clave dada. Si no se indica la clave, devuelve la configuración completa.
</p><p><small><b>Devuelve</b>:</small> Una cadena de texto.
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>ConfigSet</b></big> ( <i>string, string</i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> Establece la clave dada (primera cadena de texto) al valor indicado (segunda cadena de texto).
</p><p><small><b>Devuelve</b>:</small>
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>Version</b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> Muestra la versión de FreeCAD.
</p><p><small><b>Devuelve</b>:</small>
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>activeDocument</b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small>
</p><p><small><b>Devuelve</b>:</small> Devuelve el documento activo o Nada si no hay ningún documento activo.
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>addExportType</b></big> ( <i>string, string</i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> 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().
</p><p><small><b>Devuelve</b>:</small>
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>addImportType</b></big> ( <i>string, string</i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> 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().
</p><p><small><b>Devuelve</b>:</small>
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>closeDocument</b></big> ( <i>Document name</i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> Cierra el documento indicado
</p><p><small><b>Devuelve</b>:</small>
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>getDocument</b></big> ( <i>Document name</i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> Devuelve un documento o eleva una excepción si no existe un documento con el nombre indicado.
</p><p><small><b>Devuelve</b>:</small>
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>getExportType</b></big> ( <i>string</i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> Devuelve el nombre del módulo que puede exportar el tipo de archivo especificado.
</p><p><small><b>Devuelve</b>:</small> Una cadena de texto.
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>getImportType</b></big> ( <i>string</i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> Devuelve el nombre del módulo que puede exportar el tipo de archivo especificado.
</p><p><small><b>Devuelve</b>:</small> Una cadena de texto.
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>listDocuments</b></big> ( <i> </i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> Devuelve una lista de nombres de todos los documentos.
</p><p><small><b>Devuelve</b>:</small> Una lista de nombres.
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>newDocument</b></big> ( <i>[string]</i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> 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".
</p><p><small><b>Devuelve</b>:</small> El nuevo documento creado.
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>open</b></big> ( <i>string</i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> Ver openDocument
</p><p><small><b>Devuelve</b>:</small>
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>openDocument</b></big> ( <i>filepath</i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> 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.
</p><p><small><b>Devuelve</b>:</small> El documento de FreeCAD abierto.
</p>
</div>
</div>
<p><br />
</p><p><br />
</p>
<div class="api">
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>setActiveDocument</b></big> ( <i>Document name</i> )</div>
<div class="description">
<p><small><b>Descripción</b>:</small> Establece el documento activo por su nombre.
</p><p><small><b>Devuelve</b>:</small>
</p>
</div>
</div>
<div style="clear:both"></div>
</div>
</div>
</div><div class="printfooter">
Online version: "<a dir="ltr" href="https://www.freecadweb.org/wiki/index.php?title=FreeCAD_API/es&amp;oldid=133254">http://www.freecadweb.org/wiki/index.php?title=FreeCAD_API/es&amp;oldid=133254</a>"</div>
<div id="catlinks" class="catlinks" data-mw="interface"></div><div class="visualClear"></div>
</div>
</div>
<div id="mw-navigation">
<h2>Navigation menu</h2>
</body></html>