App FeaturePython/ru

Введение
Объект  App FeaturePython, или формально, является простым экземпляром App DocumentObject в Python.

Это простой объект, который по умолчанию не имеет многих свойств, например таких как разположение и топологическая форма. Этот объект предназначен для общего использования; в зависимости от назначенных ему свойств его можно использовать для управления различными типами данных.



Применение
App FeaturePython является внутренним объектом, поэтому его нельзя создать с помощью графического интерфейса. Он предназначен для подклассов классов, которые будут обрабатывать различные типы данных.

См. Составление скриптов для получения дополнительной информации.

Свойства
App FeaturePython ( класс) является производным от базового App DocumentObject ( класса), поэтому он разделяет все свойства последнего.

In addition to the properties described in App DocumentObject, the FeaturePython has a basic view provider, so it does appear in the tree view.

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

These are the properties available in the property editor. Hidden properties can be shown by using the command in the context menu of the property editor.

Свойства

 * : a custom class associated with this object.
 * : 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 that may include newlines. By default, it is an empty string.
 * : a list of expressions. By default, it is empty.
 * : whether to display the object or not.

Параметры отображения
These properties correspond to the basic properties of the base viewprovider,, that is inherited by all viewproviders in the software.


 * : a custom view provider class associated with this object. This property only exist for those classes that are able to assign a custom class.


 * : it is empty by default.
 * : it defaults to, in which case the object will appear in the tree view; otherwise, the object will be hidden in the tree view. Once an object in the tree is invisible, you can see it again by opening the context menu over the name of the document (right-click), and selecting . Then the hidden item can be chosen and can be switched back to.
 * : it defaults to, in which case the object will be visible in the 3D view if it has a Shape, otherwise it will be invisible. By default this property can be toggled on and off by selecting the object, and pressing the bar in the keyboard.


 * : it controls the way in which the selection occurs in the 3D view if the object has a Shape, and there are many objects partially covered by others. It defaults to, meaning that no special highlighting will occur; means that the object will appear on top of any other object when selected;  means that the object will appear on top only if the entire object is selected in the tree view;  means that the object will appear on top only if a subelement (vertex, edge, face) is selected in the 3D view.
 * : it controls the way the object is highlighted if it has a Shape. If it is, the entire shape (vertices, edges, and faces) will be highlighted in the 3D view; if it is a bounding box will appear surrounding the object and will be highlighted.

Составление скриптов
Основы составления скриптов в FreeCAD, и скриптовые объекты.

Общие сведения о добавлении объектов в программу смотрите в разделе Объект "Part::Feature".

App FeaturePython создается с помощью метода документа.

For example, the Draft Text, Draft Dimension, and Working plane proxy elements of the Draft Workbench are objects with a custom icon and additional properties. They hold data but not an actual Part TopoShape.

If the desired object should have a placement, a shape, an attachment, or other complex properties, it is better to create one of the more complex classes, for example, App GeoFeature, Part Feature, or Part Part2DObject.