App DocumentObject: Difference between revisions

From FreeCAD Documentation
m (→‎Scripting: It is usually better to create one of the sub-classes, for example, App FeaturePython, Part Feature, or Part Part2DObject.)
No edit summary
 
(27 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{TOCright}}
<translate>
<translate>


== Introduction ==
== Introduction == <!--T:1-->


</translate>
</translate>
Line 8: Line 9:
<translate>
<translate>


<!--T:2-->
An [[App_DocumentObject|App DocumentObject]] object, or formally an {{incode|App::DocumentObject}}, is the base class of all object classes handled in the document.
An [[App_DocumentObject|App DocumentObject]] object, or formally an {{incode|App::DocumentObject}}, is the base class of all object classes handled in the document.


<!--T:18-->
In general terms, a "DocumentObject" is any "thing" that can appear in the [[Tree_view|Tree view]], and which is saved and restored when opening a document.

<!--T:19-->
[[File:App_DocumentObject_example.png]]

<!--T:20-->
{{Caption|Tree view showing different objects in the document. Each of them is a "document object", ultimately derived from the base {{incode|App::DocumentObject}} class.}}

<!--T:3-->
[[File:FreeCAD_core_objects.svg|800px]]
[[File:FreeCAD_core_objects.svg|800px]]


<!--T:4-->
{{Caption|Simplified diagram of the relationships between the core objects in the program. The {{incode|App::DocumentObject}} class is the base class of essentially all objects in the software.}}
{{Caption|Simplified diagram of the relationships between the core objects in FreeCAD}}


== How to use ==
== Usage == <!--T:5-->


<!--T:6-->
The [[App_DocumentObject|App DocumentObject]] is an internal object, so it cannot be created from the graphical interface. It is not meant to be used directly; rather, it is meant to be sub-classed by classes that will handle different types of data. Therefore, almost every object in the software, that is, every element that has an icon and that can be listed in the [[tree view|tree view]], is a "DocumentObject".
The [[App_DocumentObject|App DocumentObject]] is an internal class, so it cannot be created from the graphical interface, nor is it meant to be used by itself. It just defines the basic behavior and properties of objects in the program.


<!--T:7-->
Some of the most important DocumentObjects are the following:
Some of the most important DocumentObjects are the following:
* The [[App_GeoFeature|App GeoFeature]] class, which is the base object of all geometrical objects, that is, of objects that have a [[Placement|Placement]] property that defines their position in the [[3D view|3D view]].
* The [[App_FeaturePython|App FeaturePython]] class, an empty object that can be used for different purposes, depending on the added properties.
* The [[App_GeoFeature|App GeoFeature]] class, the base object of all geometrical objects, that is, of objects that have a [[Placement|Placement]] property that defines their position in the [[3D_view|3D view]].
* The [[Part_Feature|Part Feature]] class, which is derived from App GeoFeature, and which is the parent class of objects with 2D and 3D shapes.
* The [[Part_Feature|Part Feature]] class, derived from App GeoFeature, and the parent class of objects with 2D and 3D [[Part_TopoShape|topological shapes]].
* The [[Mesh_Feature|Mesh Feature]] class, derived from App GeoFeature, and the parent class of objects with 2D and 3D [[Mesh_MeshObject|meshes]].


== Properties ==
== Properties == <!--T:8-->


<!--T:17-->
See [[Property|Property]] for all property types that scripted objects can have.

<!--T:9-->
These are the basic properties that essentially all objects have. These properties can be accessed from the [[Python console|Python console]].
These are the basic properties that essentially all objects have. These properties can be accessed from the [[Python console|Python console]].


<!--T:10-->
* {{PropertyData|ExpressionEngine}}: a list of expressions that can be used.
* {{PropertyData|Label}}: the user editable name of this object.
* {{PropertyData|Label|String}}: the user editable name of this object, it is an arbitrary UTF8 string. By default, it is the same as the {{incode|Name}}.
* {{PropertyData|Label2}}: a longer, user editable description of this object.
* {{PropertyData|Label2|String}}: a longer, user editable description of this object, it is an arbitrary UTF8 string that may include newlines. By default, it is an empty string {{value|""}}.
* {{PropertyData|Visibility}}: whether to display the object or not.
* {{PropertyData|Expression Engine|ExpressionEngine}}: a list of expressions.
* {{PropertyData|Visibility|Bool}}: whether to display the object or not.


<!--T:11-->
== Scripting ==
For derived objects, only {{PropertyData|Label}} will be listed in the [[property editor|property editor]] by default. The other properties will be hidden.


== Scripting == <!--T:12-->
{{Emphasis|See also:}} [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]], and [[scripted objects|scripted objects]].


<!--T:13-->
See [[Part_Feature|Part Feature]] for the general information on adding objects to the program.
{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]] and [[Scripted_objects|scripted objects]].


<!--T:14-->
A DocumentObject is created with the {{incode|addObject()}} method of the document. However, in general, there is no need to create this object manually. It is usually better to create one of the sub-classes, for example, [[App_FeaturePython|App FeaturePython]], [[Part_Feature|Part Feature]], or [[Part_Part2DObject|Part Part2DObject]].
See [[Part_Feature|Part Feature]] for the general information on adding objects to the document.

<!--T:15-->
A DocumentObject is created with the {{incode|addObject()}} method of the document. However, in general, there is no need to create this object manually. It is usually better to subclass one of the more complex classes, for example, [[App_FeaturePython|App FeaturePython]], [[App_GeoFeature|App GeoFeature]], [[Part_Feature|Part Feature]], [[Part_Part2DObject|Part Part2DObject]], etc.


</translate>
</translate>
Line 47: Line 75:
obj.Label = "Custom label"
obj.Label = "Custom label"
}}
}}
<translate>



{{Userdocnavi}}
{{Document_objects_navi{{#translation:}}}}
</translate>
{{Userdocnavi{{#translation:}}}}

Latest revision as of 07:44, 22 February 2022

Introduction

An App DocumentObject object, or formally an App::DocumentObject, is the base class of all object classes handled in the document.

In general terms, a "DocumentObject" is any "thing" that can appear in the Tree view, and which is saved and restored when opening a document.

Tree view showing different objects in the document. Each of them is a "document object", ultimately derived from the base App::DocumentObject class.

Simplified diagram of the relationships between the core objects in FreeCAD

Usage

The App DocumentObject is an internal class, so it cannot be created from the graphical interface, nor is it meant to be used by itself. It just defines the basic behavior and properties of objects in the program.

Some of the most important DocumentObjects are the following:

  • The App FeaturePython class, an empty object that can be used for different purposes, depending on the added properties.
  • The App GeoFeature class, the base object of all geometrical objects, that is, of objects that have a Placement property that defines their position in the 3D view.
  • The Part Feature class, derived from App GeoFeature, and the parent class of objects with 2D and 3D topological shapes.
  • The Mesh Feature class, derived from App GeoFeature, and the parent class of objects with 2D and 3D meshes.

Properties

See Property for all property types that scripted objects can have.

These are the basic properties that essentially all objects have. These properties can be accessed from the Python console.

  • DataLabel (String): the user editable name of this object, it is an arbitrary UTF8 string. By default, it is the same as the Name.
  • DataLabel2 (String): a longer, user editable description of this object, it is an arbitrary UTF8 string that may include newlines. By default, it is an empty string "".
  • DataExpression Engine (ExpressionEngine): a list of expressions.
  • DataVisibility (Bool): whether to display the object or not.

For derived objects, only DataLabel will be listed in the property editor by default. The other properties will be hidden.

Scripting

See also: FreeCAD Scripting Basics and scripted objects.

See Part Feature for the general information on adding objects to the document.

A DocumentObject is created with the addObject() method of the document. However, in general, there is no need to create this object manually. It is usually better to subclass one of the more complex classes, for example, App FeaturePython, App GeoFeature, Part Feature, Part Part2DObject, etc.

import FreeCAD as App

doc = App.newDocument()
obj = App.ActiveDocument.addObject("App::DocumentObject", "Name")
obj.Label = "Custom label"