Object API

From FreeCAD Documentation
Jump to: navigation, search
This page is a translated version of the page Object API and the translation is 80% 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.


Siendo paramétricos, los objetos del documento en FreeCAD pueden tener diversas propiedades adicionales, pero éstas son las básicas, presentes en cada objeto del documento de FreeCAD. Los objetos se pueden recuperar fácilmente por su nombre. Por ejemplo:

myObj = FreeCAD.ActiveDocument.myObjectName
print myObj.PropertiesList
Property.png Content

Returns: Una representación XML de las propiedades de un objeto.

Property.png Label

Returns: Obtiene/establece la etiqueta de los objetos. La cadena de texto puede ser unicode.

Property.png Name

Returns: El nombre único de un objeto.

Property.png Placement

Returns: Obtiene/establece la ubicación de un objeto. Una ubicación define una orientación (rotación) y una posición (base) en el espacio 3D. Se utiliza cuando es necesario no escalar u otra distorsión.

Property.png PropertiesList

Returns: Una lista de las propiedades de un objeto.

Property.png State

Returns: El estado de FreeCAD de un objeto (por ejemplo si necesita ser recalculado).

Property.png Type

Returns: Una cadena de texto describiendo el tipo del objeto.

Property.png ViewObject

Returns: El Proveedor de Vista asociado (objeto FreeCADGUI) a un objeto.

Method.png getAllDerivedFrom( )

Description:

Returns: Todos los descendientes de este objeto.

Method.png getDocumentationOfProperty( )

Description:

Returns: La cadena de texto de documentación de la propiedad de esta clase.

Method.png getGroupOfProperty( )

Description:

Returns: El nombre del grupo al cual pertenece el objeto en esta clase. Las propiedades ordenadas en diferentes grupos denominados según convenga.

Method.png getPropertyByName( )

Description:

Returns: El valor de una propiedad denominada.

Method.png getTypeOfProperty( )

Description:

Returns: tEl tipo de una propiedad denominada. Esto puede ser (Hidden,ReadOnly,Output) o cualquier combinación.

Method.png isDerivedFrom( )

Description:

Returns: True si el tipo dado es un padre.

Method.png purgeTouched( )

Description: Marca el objeto como unchanged

Returns:

Method.png touch( )

Description: Marca el objeto como changed (tocado)

Returns: