App DocumentObject/en

Introduction


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



How to use
The 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, is a "DocumentObject".

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 shapes.

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


 * : a list of expressions.
 * : the user editable name of this object, it is an arbitrary UTF8 string.
 * : a longer, user editable description of this object, it is an arbitrary UTF8 string.
 * : whether to display the object or not.

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

Scripting
FreeCAD Scripting Basics, and scripted objects.

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

A DocumentObject is created with the 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, Part Feature, or Part Part2DObject.