Scripted objects/ru

Кроме стандартных типов объектов, таких как аннотации, полигональные сетки и детали, FreeCAD так же предлагает удивительные возможности для создания объектов, полностью состоящих из скриптов Python, названые Python Функционалы (Python Features). Эти объекты будут вести себя точно так же как и любой другой объект FreeCAD, могут быть сохранены в документе и открыты на любом другом компьютере с установленным FreeCAD, так как код python, определяющий этот объект, также сохраняется в документе.

Должна быть понята одна особенность, эти объекты сохраняются в файлах FreeCAD FcStd вместе с модулем pythonа json. Этот модуль превращает объект pythonа в строку, позволяя его добавление в сохраняемый файл. При загрузке, модуль json использует эту строку для пересоздания оригинального объекта, обеспечивает его доступ к исходному коду, создавшему объект. Это значит, что если Вы сохранили этот пользовательский объект и открыли его на машине, где код python, который сгенерировал объект, отсутствует, объект не может быть восстановлен. Если Вы распространяете эти объекты среди других друзей, Вам нужно передавать вместе с ними скрипт pythonа, который его создал.

Python Функционалы следуют тому же правилу что и все FreeCAD Функционалы: они разделены на App и GUI части. App часть, Документированный Объект(Document Object), определяет геометрию нашего объекта, тогда как его GUI часть, Визуальное Представление Объекта(View Provider Object), определяет как объект будет отрисован на экране. Визуальное Представление Объекта, как и любой другой FreeCAD функционал, доступно только когда если вы запустили FreeCAD с его собственным GUI. Есть несколько свойств и методов доступных для создания вашего объекта. Свойства должны быть любыми Свойства должны быть любыми предопределенные типами свойств которые предлагает FreeCAD, и они появятся в окне отображающим свойства, так что они могут быть отредактированы пользователем. Таким образом, Python Функционалы являются истинно и полностью параметрическими. вы можете отдельно задать свойства Документированного и Визуального Объектов.

Подсказка: В предыдущих версиях мы использовали модуль Pythonа cPickle. Однако этот модуль выполняет любой код и это может создать проблемы безопасности. Поэтому мы перешли на модуль json Pythonа.

Простой пример
Следующий пример можно найти в файле src/Mod/TemplatePyMod/FeaturePython.py вместе с другими примерами:

Что нужно знать
Если Ваш объект полагается на то, что будет пересчитан во время создания, Вы должны сделать это вручную в функции, поскольку пересчёт не вызывается автоматически. Этот пример не требует этого поскольку метод класса  имеет тот же эффект, что и функция, но пример ниже полагается на то, что будет пересчитан перед тем как будет показан в окне трёхмерного просмотра. В этих примерах это делается вручную с помощью, но в более сложных сценариях Вы должны решить, где пересчитать либо весь документ, или объект FeaturePython.

Этот пример создаёт несколько исключений трасс стека в окне отчётов. Это поскольку метод  класса  вызывается каждый раз как свойство добавляется в. Когда первое было добавлено, параметры Width и Height и потому попытки доступа к ним безуспешны.

Описание и  находится в теме форума obj.Proxy.Type is a dict, not a string.

Доступные свойства
Свойства это действительные строительные камни(не вспомнил замену) Python Функционалов. Через них пользователь может взаимодествовать с объектом и изменять его. После создания нового Python Функционала в вашем документе ( a=FreeCAD.ActiveDocument.addObject("App::FeaturePython","Box") ),вы можете получить список доступных свойств, использовав:

Вы получите список доступных свойств:

При добавлении новых свойств к пользовательским объектам, позаботьтесь об этом:
 * Не используйте символы "<" или ">" в описании свойств (это вызовет поломку xml части .fcstd файла)
 * Свойства хранятся в .fcstd файле в алфавитном порядке. Если у вас есть форма(shape) в ваших свойствах, любое свойство имя которого идет, в алфавитном порядке, после "Shape", будет загружено ПОСЛЕ формы, что может привести к странному поведению.

Полный список атрибутов свойств можно посмотреть в заголовочном файле C++ PropertyStandard. Например, если Вы хотите позволить пользователю вводить ограниченный диапазон значений (например, используя using PropertyIntegerConstraint), в Python Вы назначаете кортеж, содержащий не только значение свойства, но и верхний, нижний предел и шаг изменения, как сделано ниже:

Property Type
По умолчанию свойства могут быть обновлены. Можно сделать их только для чтения, например, в случае если хочется показать результат метода. Так же можно скрыть свойство. Тип свойства может быть установлен используя

где режим это short int, которое может быть установлено в: 0 -- по умолчанию, чтение и запись 1 -- только чтение 2 -- скрыто

The EditorModes are not set at FreeCAD file reload. This could to be done by the __setstate__ function. See http://forum.freecadweb.org/viewtopic.php?f=18&t=13460&start=10#p108072. By using the setEditorMode the properties are only read only in PropertyEditor. They could still be changed from python. To really make them read only the setting has to be passed directly inside the addProperty function. See http://forum.freecadweb.org/viewtopic.php?f=18&t=13460&start=20#p109709 for an example.

Using the direct setting in the addProperty function, you also have more possibilities. In particular, an interesting one is mark a property as an output property. This way FreeCAD won't mark the feature as touched when changing it (so no need to recompute).

Example of output property (see also https://forum.freecadweb.org/viewtopic.php?t=24928):

The property types that can be set at last parameter of the addProperty function are: 0 -- Prop_None, No special property type 1 -- Prop_ReadOnly, Property is read-only in the editor 2 -- Prop_Transient, Property won't be saved to file 4 -- Prop_Hidden, Property won't appear in the editor 8 -- Prop_Output, Modified property doesn't touch its parent container 16 -- Prop_NoRecompute, Modified property doesn't touch its container for recompute

Вы можете найти эти различные типы свойств, определённые в заголовочном файле PropertyContainer исходного кода C++

Другие примеры, посложней
Этот пример использует Модуль Деталей для создания октаэдра, затем создает собственное представление coin с помощью pivy.

Сначала сам Документированный Объект:

Теперь, мы обладаем визуальным представлением объекта, ответственного за отображение объекта в 3D сцене:

Наконец, когда определен наш объект и его визуальный объект, нам просто нужно вызвать их:

Создание выделяемых объектов
Если вы хотите чтобы ваш объект можно было выбрать, или по крайней мере его часть, щелкнув по нему в окне, вы должны включить его coin геометрию внутрь узла SoFCSelection. Если ваш объект обладает сложным представлением, с виджетами, аннотациями, и т.д, вам может потребоваться только часть его в SoFCSelection. Все что находится в SoFCSelection постоянно сканируется FreeCAD для обнаружения выделения/предварительного отбора, так что имеет смысл попробовать не перегружать его ненужным сканированием.

Как только части графа сцены, которые должны быть выбраны, оказываются внутри узлов SoFCSelection, вам необходимо предоставить два метода для обработки пути выбора. Путь выбора может принимать форму строки, содержащей имена каждого элемента в пути, или массива объектов графа сцены. Вы предоставляете два метода:, который преобразует путь строки в массив объектов scenegraph (графа сцены), и , который принимает элемент, по которому щелкнули в графе сцены, и возвращает его строковое имя (примечание, а не его строковый путь).

Вот вышеприведённый пример с молекулой, адаптированный для выбора элементов молекулы:

Работа с простыми формами
Если ваш параметрический объект просто выводит форму, вам не нужно импользовать объект визуального представления. форма будет отображена используя стандартное FreeCAD-ое представление форм :

Тот же код с использованием ViewProviderLine

Scenegraph Structure
You may have noticed that the examples above construct their scenegraphs in slightly different ways. Some use while others use.

Each feature in a FreeCAD document is based the following scenegraph structure:

The displays only one of its children, depending on which display mode is selection in FreeCAD.

The examples which use are constructing their scenegraphs solely out of coin3d scenegraph elements. Under the covers, adds a new child to the ; the name of that node will match the display mode it was passed.

The examples which use also construct part of their geometry using functions from the Part workbench, such as. This constructs the different display mode scenegraphs under the ; when we later come to add coin3d elements to the scenegraph, we need to add them to the existing display mode scenegraphs using rather than creating a new child of the.

When using to add geometry to the scenegraph, each display mode should have its own node which is passed to ; don't reuse the same node for this. Doing so will confuse the selection mechanism. It's okay if each display mode's node has the same geometry nodes added below it, just the root of each display mode needs to be distinct.

Here is the above molecule example, adapted to be drawn only with Coin3D scenegraph objects instead of using objects from the Part workbench:

Дальнейшая информация
Дополнительные страницы Вики FreeCADа:
 * Scripted objects saving attributes
 * Scripted objects migration
 * Scripted objects with attachment
 * Viewproviders

Interesting forum threads about scripted objects:
 * Python object attributes lost at load
 * New FeaturePython is grey
 * Explanation on __getstate__ and __setstate__, official documentation
 * Eigenmode frequency always 0?
 * how to implement python feature's setEdit properly?

В добавок к представленным здесь примерам, посмотрите исходный код FreeCAD src/Mod/TemplatePyMod/FeaturePython.py насчёт дополнительных примеров.