FreeCADGui API

From FreeCAD Documentation
This page is a translated version of the page FreeCADGui API and the translation is 75% complete.
Other languages:
(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 módulo es el homologo al módulo de FreeCAD. Contiene todo lo relacionado con la interfaz de usuario y las vistas 3D. Ejemplo:

import FreeCAD as App
import FreeCADGui as Gui

# get the 3D model document
doc = App.ActiveDocument    

# get the visual representation model document
gui_doc = Gui.ActiveDocument

gui_doc.activateWorkbench("myWorkbench")


activateWorkbench ( string )

Descripción: Activa un entorno por nombre

Devuelve: nada


activeDocument ( )

Descripción:

Devuelve: el documento activo o Nada si no existe ninguno


activeWorkbench ( )

Descripción:

Devuelve: el objeto del entorno de trabajo actual


addCommand ( string, object )

Descripción: Añade un comando de FreeCAD. La cadena es el nombre del comando y el objeto esun nombre de clase definiendo el comando

Devuelve:


addIcon ( string, string o list )

Descripción: Añade un icono como nombre de archivo o en formato XPM al sistema

Devuelve:


addIconPath ( string )

Descripción: Añade una nueva ruta al sistema donde encontrar archivos de iconos

Devuelve:


addPreferencePage ( string,string )

Descripción: Añade un formulario UI al letrero de diálogo de preferencias. El primer argumento especifica el nombre del archivo y el segundo el nombre del grupo

Devuelve:


addWorkbench ( string, object )

Descripción: Añade un entorno de trabajo bajo un nombre definido. La cadena de texto es el nombre del entorno de trabajo y el objeto es un nombre de clase definido en el entorno de trabajo

Devuelve:


createDialog ( string )

Descripción: Abre un archivo UI

Devuelve:


getDocument ( string )

Descripción: Obtiene un documento por su nombre

Devuelve: el documento


getWorkbench ( string )

Descripción: Obtiene un entorno de trabajo por su nombre

Devuelve: el entorno de trabajo


insert ( string )

Descripción: Abre una macro, archivo de Inventor o VRML

Devuelve: el documento


listWorkbenches ( )

Descripción: Muestra una lista de todos los entornos de trabajo

Devuelve: una lista


open ( string )

Descripción: Abre una macro, archivo de Inventor o VRML file

Devuelve: el documento abierto


removeWorkbench ( string )

Descripción: Elimina un entorno de trabajo por nombre

Devuelve:


runCommand ( string )

Descripción: Ejecuta un comando de FreeCAD por nombre

Devuelve:


updateGui ( )

Descripción: Actualiza la ventana principal y todas sus ventanas

Devuelve: