Object API/es: Difference between revisions

From FreeCAD Documentation
No edit summary
(Updating to match new version of source page)
Line 1: Line 1:
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:
Siendo paramétricos, los objetos del documento en FreeCAD pueden tener un montón de propiedades adicionales, pero estas son las básicas, presentes en cada objeto del documento de FreeCAD. Los objetos se pueden recuperar simplemente por su nombre. Por ejemplo:


myObj = FreeCAD.ActiveDocument.myObjectName
myObj = FreeCAD.ActiveDocument.myObjectName
print myObj.PropertiesList
print myObj.PropertiesList


{{APIProperty/es|Content|Una representación XML de las propiedades de un objeto.}}
{{APIProperty|Content|an XML representation of the properties of an object.}}
{{APIProperty/es|Label|Obtiene/establece la etiqueta de los objetos. La cadena de texto puede ser unicode.}}
{{APIProperty|Label|Gets/sets the objects label. The string can be unicode.}}
{{APIProperty/es|Name|El nombre único de un objeto.}}
{{APIProperty|Name|the unique name of an object.}}
{{APIProperty/es|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|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/es|Pos|La parte posición de una ubicación}}
{{APIProperty|PropertiesList|a list of the properties of an object}}
{{APIProperty/es|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/es|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/es|Type|Una cadena de texto describiendo el tipo del objeto}}
{{APIProperty|ViewObject|the associated View Provider (FreeCADGUI object) of an object}}
{{APIFunction|getAllDerivedFrom| | |all descentences of this object}}
{{APIProperty/es|ViewObject|El Proveedor de Vista asociado (objeto FreeCADGUI) a un objeto}}
{{APIFunction/es|getAllDerivedFrom| | |Todos los descendientes de este objeto}}
{{APIFunction|getDocumentationOfProperty| | |the documentation string of the property of this class.}}
{{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/es|getDocumentationOfProperty| | |La cadena de texto de documentación de la propiedad de esta clase.}}
{{APIFunction|getPropertyByName| | |the value of a named property.}}
{{APIFunction/es|getGroupOfProperty| | |El nombre del grupo al cual pertenece el objeto en esta clase. Las propiedades ordenadas en diferentes grupos denominados según convenga.}}
{{APIFunction/es|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|isDerivedFrom| | |True if given type is a father}}
{{APIFunction/es|getTypeOfProperty| | |El tipo de una propiedad denominada. Esto puede ser (Hidden,ReadOnly,Output) o cualquier combinación.}}
{{APIFunction/es|isDerivedFrom| | |True si el tipo dado es un padre}}
{{APIFunction|purgeTouched| |Marks the object as unchanged| }}
{{APIFunction/es|purgeTouched| |Marca el objeto como unchanged| }}
{{APIFunction|touch| |Marks the object as changed (touched)| }}
{{APIFunction/es|touch| |Marca el objeto como changed (tocado)| }}


[[Category:API]]
{{languages/es | {{en|Object_API}} }}
<languages/>

[[Category:API/es]]

Revision as of 03:01, 28 September 2014

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:

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

Returns: an XML representation of the properties of an object.

Label

Returns: Gets/sets the objects label. The string can be unicode.

Name

Returns: the unique name of an object.

Placement

Returns: 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.

PropertiesList

Returns: a list of the properties of an object

State

Returns: the FreeCAD state of an object (ie. if it needs to be recomputed)

Type

Returns: a string describing the type of an object

ViewObject

Returns: the associated View Provider (FreeCADGUI object) of an object

getAllDerivedFrom( )

Description:

Returns: all descentences of this object

getDocumentationOfProperty( )

Description:

Returns: the documentation string of the property of this class.

getGroupOfProperty( )

Description:

Returns: the name of the group which the property belongs to in this class. The properties sorted in differnt named groups for convenience.

getPropertyByName( )

Description:

Returns: the value of a named property.

getTypeOfProperty( )

Description:

Returns: the type of a named property. This can be (Hidden,ReadOnly,Output) or any combination.

isDerivedFrom( )

Description:

Returns: True if given type is a father

purgeTouched( )

Description: Marks the object as unchanged

Returns:

touch( )

Description: Marks the object as changed (touched)

Returns:

Other languages: