Object API/es: Difference between revisions
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 |
{{APIProperty|Content|an XML representation of the properties of an object.}} |
||
{{APIProperty |
{{APIProperty|Label|Gets/sets the objects label. The string can be unicode.}} |
||
{{APIProperty |
{{APIProperty|Name|the unique name of an object.}} |
||
{{APIProperty |
{{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 |
{{APIProperty|PropertiesList|a list of the properties of an object}} |
||
{{APIProperty |
{{APIProperty|State|the FreeCAD state of an object (ie. if it needs to be recomputed)}} |
||
{{APIProperty |
{{APIProperty|Type|a string describing the type of an object}} |
||
{{APIProperty |
{{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 |
{{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 |
{{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 |
{{APIFunction|purgeTouched| |Marks the object as unchanged| }} |
||
{{APIFunction |
{{APIFunction|touch| |Marks the object as changed (touched)| }} |
||
{{APIFunction/es|touch| |Marca el objeto como changed (tocado)| }} |
|||
⚫ | |||
{{languages/es | {{en|Object_API}} }} |
|||
<languages/> |
|||
⚫ |
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
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.
Description:
Returns: the documentation string of the property of this class.
Description:
Returns: the name of the group which the property belongs to in this class. The properties sorted in differnt named groups for convenience.
Description:
Returns: the type of a named property. This can be (Hidden,ReadOnly,Output) or any combination.