Object API/es: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
Being parametric, document objects in FreeCAD can have a lot of additional properties, but these are the basic ones, present in every FreeCAD Document Object. Objects can be retrieved simply by their name. Example:
{{VeryImportantMessage|(October 2019) Do not edit this page. The information is incomplete and outdated. For the latest API, see the [https://www.freecadweb.org/api autogenerated API documentation], or generate the documentation yourself, see [[Source documentation|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
{{Code|code=
print myObj.PropertiesList
myObj = FreeCAD.ActiveDocument.myObjectName
print myObj.PropertiesList
}}


{{APIProperty|Content|an XML representation of the properties of an object.}}
{{APIProperty|Content|Una representación XML de las propiedades de un objeto.}}
{{APIProperty|Label|Gets/sets the objects label. The string can be unicode.}}
{{APIProperty|Label|Obtiene/establece la etiqueta de los objetos. La cadena de texto puede ser unicode.}}
{{APIProperty|Name|the unique name of an object.}}
{{APIProperty|Name|El nombre único de un objeto.}}
{{APIProperty|Placement|Gets/sets the Placement of an object. A placement defines an orientation (rotation) and a position (base) in 3D space. It is used when no scaling or other distortion is needed.}}
{{APIProperty|Placement|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.}}
{{APIProperty|PropertiesList|a list of the properties of an object}}
{{APIProperty|PropertiesList|Una lista de las propiedades de un objeto.}}
{{APIProperty|State|the FreeCAD state of an object (ie. if it needs to be recomputed)}}
{{APIProperty|State| El estado de FreeCAD de un objeto (por ejemplo si necesita ser recalculado).}}
{{APIProperty|Type|a string describing the type of an object}}
{{APIProperty|Type|Una cadena de texto describiendo el tipo del objeto.}}
{{APIProperty|ViewObject|the associated View Provider (FreeCADGUI object) of an object}}
{{APIProperty|ViewObject|El Proveedor de Vista asociado (objeto FreeCADGUI) a un objeto.}}
{{APIFunction|getAllDerivedFrom| | |all descentences of this object}}
{{APIFunction|getAllDerivedFrom| | |Todos los descendientes de este objeto.}}
{{APIFunction|getDocumentationOfProperty| | |the documentation string of the property of this class.}}
{{APIFunction|getDocumentationOfProperty| | |La cadena de texto de documentación de la propiedad de esta clase.}}
{{APIFunction|getGroupOfProperty| | |the name of the group which the property belongs to in this class. The properties sorted in differnt named groups for convenience.}}
{{APIFunction|getGroupOfProperty| | |El nombre del grupo al cual pertenece el objeto en esta clase. Las propiedades ordenadas en diferentes grupos denominados según convenga.}}
{{APIFunction|getPropertyByName| | |the value of a named property.}}
{{APIFunction|getPropertyByName| | |El valor de una propiedad denominada.}}
{{APIFunction|getTypeOfProperty| | |the type of a named property. This can be (Hidden,ReadOnly,Output) or any combination.}}
{{APIFunction|getTypeOfProperty| | |tEl tipo de una propiedad denominada. Esto puede ser (Hidden,ReadOnly,Output) o cualquier combinación.}}
{{APIFunction|isDerivedFrom| | |True if given type is a father}}
{{APIFunction|isDerivedFrom| | |True si el tipo dado es un padre.}}
{{APIFunction|purgeTouched| |Marks the object as unchanged| }}
{{APIFunction|purgeTouched| |Marca el objeto como unchanged| }}
{{APIFunction|touch| |Marks the object as changed (touched)| }}
{{APIFunction|touch| |Marca el objeto como changed (tocado)| }}


{{Userdocnavi{{#translation:}}}}
[[Category:API]]
[[Category:API{{#translation:}}]]
<languages/>
[[Category:Poweruser Documentation{{#translation:}}]]
{{clear}}

Latest revision as of 21:02, 27 February 2020

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.

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
Content

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

Label

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

Name

Returns: El nombre único de un objeto.

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.

PropertiesList

Returns: Una lista de las propiedades de un objeto.

State

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

Type

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

ViewObject

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

getAllDerivedFrom( )

Description:

Returns: Todos los descendientes de este objeto.

getDocumentationOfProperty( )

Description:

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

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.

getPropertyByName( )

Description:

Returns: El valor de una propiedad denominada.

getTypeOfProperty( )

Description:

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

isDerivedFrom( )

Description:

Returns: True si el tipo dado es un padre.

purgeTouched( )

Description: Marca el objeto como unchanged

Returns:

touch( )

Description: Marca el objeto como changed (tocado)

Returns: