FreeCAD Scripting Basics/ru: Difference between revisions

From FreeCAD Documentation
No edit summary
(Updating to match new version of source page)
 
(121 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<languages/>
== Написание сценариев Python в FreeCAD ==


<div class="mw-translate-fuzzy">
FreeCAD построен с нуля, чтобы быть полностью контролируемым Python сценариями. Почти все части FreeCAD, такие как интерфейс, содержимое сцены, и даже представление этого содержания в окне 3D просмотра доступны из встроенного Python интерпретатора или из своих собственных сценариев. Как результат, FreeCAD вероятно, является одной из наиболее глубоко настраиваемый инженерных приложений, доступных сегодня.
{{Docnav/ru
|[[Python scripting tutorial/ru|Python scripting tutorial]]
|[[Topological_data_scripting/ru|Topological data scripting]]
}}
</div>


{{TOCright}}
В своем нынешнем состоянии однако, FreeCAD имеет очень мало "родных" команд для взаимодействовия с вашими 3D-объектами, в основном, потому что он все еще находится в ранней стадии развития, но и потому, что философски это больше платформа для развития САD, чем пользовательское приложение. Но простота сценариев на Python внутри FreeCAD, вероятно, поможет гораздо быстрее увидеть новые функциональные возможности, разрабатываемые "продвинутыми пользователями", или, как правило, пользователями, которые немного знают о Python программировании, как мы надеемся, у себя


== Написание сценариев Python в FreeCAD ==
Если вы не знакомы с Python, мы рекомендуем Вам искать учебники по интернету, и бегло взглянуть на его структуру. Python это очень простой язык для обучения, особенно потому, он может быть сразу запущен внутри интерпритатора, где и простая команда и готовая программа может быть выполнена "на лету", без необходимости компилировать что-либо. FreeCAD имеет встроенный в Python интерпритатор.


FreeCAD с начала построен так, чтобы быть полностью контролируемым сценариями Python. Почти все части FreeCAD, такие как интерфейс, содержимое сцены, и даже представление этого содержания в окне 3D просмотра доступны из встроенного Python интерпретатора или из своих собственных сценариев. Как результат, FreeCAD вероятно, является одной из наиболее глубоко настраиваемый инженерных приложений, доступных сегодня.
===Интерпритатор===


Если вы не знакомы с Python, мы рекомендуем Вам искать учебники по интернету, и бегло взглянуть на его структуру. Python это очень простой язык для обучения, особенно потому, он может быть сразу запущен внутри интерпритатора, где и простая команда и готовая программа может быть выполнена "на лету", без необходимости компилировать что-либо. FreeCAD имеет встроенный в Python интерпритатор. Если вы не видите окно с надписью '''Консоль Python''', как показано ниже, вы можете активировать его через {{MenuCommand|Вид → Панели → Консоль Python}}.
В интерпретаторе , вы можете получить доступ к установленным в вашей системе модулям Python, а также встроенным модулям FreeCAD, и всем дополнительным модулям FreeCAD что вы установите позже. Скриншот ниже показывает, Python интерпритатор:


===Интерпретатор===
[[Image:screenshot_pythoninterpreter.jpg|The FreeCAD python interpreter]]


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

[[Image:screenshot_pythoninterpreter.jpg|The FreeCAD Python interpreter]]

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


[[Image:screenshot_classbrowser.jpg|The FreeCAD class browser]]
[[Image:screenshot_classbrowser.jpg|The FreeCAD class browser]]


Таким образом, сначало наберите '''App.''' или'''Gui.''' посмотрите, что происходит. Другой, более общий Python метод изучения содержимого модулей и классов является использование команды dir(). Например, ввод '''print dir()''' выведет список всех модулей, загруженных в FreeCAD. '''print dir(App)''' покажет вам все, что содержит App модуль и.т.д.
Таким образом, сначало наберите {{incode|App.}} или {{incode|Gui.}} посмотрите, что происходит. Другой, более общий Python метод изучения содержимого модулей и классов является использование команды {{incode|print(dir())}}. Например, ввод {{incode|print(dir())}} выведет список всех модулей, загруженных в FreeCAD. {{incode|print(dir(App))}} покажет вам все, что содержит App модуль и т.д.


Еще одна полезная особенность интерпритатора возможность вернуться назад по истории команд и извлечь строки кода, которые вы уже набрали ранее. Для перемещения по истории команд, просто используйте CTRL+UP или CTRL+DOWN.
Еще одна полезная особенность интерпритатора возможность вернуться назад по истории команд и извлечь строки кода, которые вы уже набрали ранее. Для перемещения по истории команд, просто используйте {{KEY|Up arrow}} или {{KEY|Down arrow}}.


Щелкнув правой кнопкой мыши в окне интерпритатора, у вас также есть несколько других опций, таких как копирование всей истории (полезно для эксперимента что-то сделать, а затем получить полный сценарий этого), или вставить имя файла с полным путем.
Щелкнув правой кнопкой мыши в окне интерпритатора, у вас также есть несколько других опций, таких как копирование всей истории (полезно для эксперимента что-то сделать, а затем получить полный сценарий этого), или вставить имя файла с полным путем.
{{Top}}

===Python Help===
===Python Help===


В меню help, вы найдете запись названием "Python help", которая откроется окно браузера, содержащего полный, создаваемую в реальном времени, документацию всех модулей Python, доступные в интепритаторе FreeCAD, в том числе Python и FreeCAD встроенные модули , установленные в систему модули, и дополнительные модули FreeCAD. Доступна ли документация зависит от того, сколько усилий разработчик каждого модуля приложил к документированию своего кода, но, как правило Python модули имеют репутацию хорошо задокументированных. Ваше окно FreeCAD должно оставаться открытым для того чтобы система документации работала.
В меню {{MenuCommand|Справка}}, вы найдете раздел {{MenuCommand|Автоматически сгенерированная документация python}}, при открытии которого откроется окно браузера, содержащего полную, создаваемую в реальном времени, документацию всех модулей Python, доступных в интерпретаторе FreeCAD, встроенных модулях Python и FreeCAD, установленных в систему модулей и дополнительные модулей FreeCAD. Доступна ли документация зависит от того, сколько усилий разработчик каждого модуля приложил к документированию своего кода, но, как правило Python модули имеют репутацию хорошо задокументированных. Ваше окно FreeCAD должно оставаться открытым для того чтобы система документации работала. В разделе {{MenuCommand|Документация по созданию скриптов на Python}} находится ссылка на этот вики-раздел [[Power_users_hub/ru|Power users hub]].
{{Top}}

==Встроеные модули==
==Встроеные модули==


С FreeCAD предназначена для запуска без графического интерфейса пользователя, почти все функциональные возможности разделены на две группы: Базовая функциональности, названные App, и Gui функциональность, названный Gui. Таким образом, наши два основных встроенных в FreeCAD модуля называются App и Gui. Эти два модуля можно также подключить из сценариев, вне интерпретатора, с соответствующими названиями FreeCAD и FreeCADGui.
Поскольку FreeCAD спроектирован с возможностью запуска без графического интерфейса пользователя (Graphical User Interface, GUI), почти все функциональные возможности разделены на две группы: Базовая функциональности, названные {{incode|App}}, и функциональность интерфейса, названный {{incode|Gui}}. Эти два модуля можно также подключить из сценариев, вне интерпретатора, под названиями {{incode|FreeCAD}} и {{incode|FreeCADGui}} соответственно.


* В '''App модуле''', вы найдете все, связанное с самим приложением, такие методы как открытия или закрытия файлов, а также документов, как настройка активного документа или объявление его содержания.
* В модуле {{incode|App}} вы найдете все, связанное с самим приложением, такие методы как открытия или закрытия файлов, а также документов, как настройка активного документа или объявление его содержания.


* В '''Gui модуле''', вы найдете инструменты для доступа и управления элементами графического интерфейса, такими как инструментарии и и их панели инструментов, и, что более интересно, графическое представление всего содержимого FreeCAD.
* В модуле {{incode|Gui}} вы найдете инструменты для доступа и управления элементами графического интерфейса, такими как инструментарии и и их панели инструментов, и, что более интересно, графическое представление всего содержимого FreeCAD.

Список всего что содержиться в этих модулях - немного контрпродуктивная задача, поскольку они растут довольно быстро с развитием FreeCAD. Но два инструмента (класс браузер и Python help) для просмотра должны обеспечить вас, в любой момент, полной и актуальной документацией по этим модулям.


Перелистывание содержимого этих модулей не слишком полезно, поскольку они растут довольно быстро с развитием FreeCAD. Но два инструмента просмотра (браузер классов и справка Python) должны обеспечить вас полной и актуальной документацией в любой момент.
{{Top}}
===Объекты модулей App и Gui===
===Объекты модулей App и Gui===


Как мы уже говорили, в FreeCAD, всё разделенные между основным и представлением. Это включает в себя и 3D-объекты. Вы можете получить доступ определяющим свойствам объектов (одна из особенностей FreeCAD) с помощью модуля App, и измененить то, как они представлены на экране с помощью модуля Gui. Например, куб имеет свойства, которые определяют его, такие как ширина, длина, высота, они хранятся в App объекта, а представление свойств, таких как цвета граней, режим отрисовки, хранятся в соответствующем Gui объекте.
Как мы уже говорили, в FreeCAD, всё разделенные между основным и представлением. Это подразумевает и 3D-объекты. Вы можете получить доступ определяющим свойствам объектов (одна из особенностей FreeCAD) с помощью модуля {{incode|App}}, и изменить то, как они представлены на экране с помощью модуля {{incode|Gui}}. Например, куб имеет свойства, которые определяют его, такие как ширина, длина, высота, они хранятся в объекте {{incode|App}}, а свойства представления, такие как цвета граней, режим отрисовки, хранятся в соответствующем объекте {{incode|Gui}}.


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


Для каждого App объекта в вашем документе, существует соответствующий объект Gui. Сам документ, собственно, также App и Gui объект. Это, конечно, действует только при запуске FreeCAD с полным интерфейсом. В режиме командной строки ,без графического интерфейса , доступны только App объекты. Обратите внимание, что часть Gui объектов создается снова каждый раз когдат App объект отмечен как "to be recomputed"[вольно:был пересчитан] (например, когда один из его параметров изменился), поэтому изменения, которые вы могли сделать непосредственно на Gui объекте, могут быть потеряны.
Для каждого объекта {{incode|App}} в вашем документе существует соответствующий объект {{incode|Gui}}. Фактически и сам документ содержит объекты {{incode|App}} и {{incode|Gui}}. Это, конечно, действует только при запуске FreeCAD с полным интерфейсом. В режиме командной строки графического интерфейса нет, так что доступны только объекты {{incode|App}}. Обратите внимание, что часть объектов {{incode|Gui}} создается снова каждый раз когда объект {{incode|App}} отмечен как "подлежащий пересчёту" (например, когда один из его параметров изменился), поэтому изменения, которые вы могли сделать непосредственно на объекте {{incode|Gui}} могут быть потеряны.


чтобы получить доступ к App части, введите:
чтобы получить доступ к части {{incode|App}} чего-либо, введите:
myObject = App.ActiveDocument.getObject("ObjectName")
где "ObjectName это имя вашего объекта. Вы также можете ввести:
myObject = App.ActiveDocument.ObjectName


{{Code|code=
чтобы получить доступ к Gui части некоторого объекта, введите:
myViewObject = Gui.ActiveDocument.getObject("ObjectName")
myObject = App.ActiveDocument.getObject("ObjectName")
}}
где "ObjectName это имя вашего объекта. Вы также можете ввести:
myViewObject = App.ActiveDocument.ObjectName.ViewObject


где {{incode|"ObjectName"}} это имя вашего объекта. Вы также можете ввести:
If we have no GUI (for example we are in command line mode), the last line will return None.
Если у нас нет графического интерфейса (например, мы находимся в режиме командной строки), последняя строка вернет None.


{{Code|code=
=== Объекты документа ===
myObject = App.ActiveDocument.ObjectName
}}


чтобы получить доступ к части {{incode|Gui}} того же объекта, введите:
В FreeCAD всё над чем вы работаете находится внутри документов. Документ содержит свою геометрию и может быть сохранен в файл. Одновременно может быть открыто несколько документов. Документ, также как и геометрия, содержащиеся внутри него, имеет App и Gui части . App часть содержит вашу фактически определенную геометрию, в то время как Gui часть содержит различные отображения(views) вашего документа. Вы можете открывать несколько окон, каждое из которых отображение вашей работы с различным масштабом или точкой зрения. Эти виды являются входят в Gui часть вашего документа.

{{Code|code=
myViewObject = Gui.ActiveDocument.getObject("ObjectName")
}}

где {{incode|"ObjectName"}} - имя вашего объекта. Вы также можете ввести:

{{Code|code=
myViewObject = App.ActiveDocument.ObjectName.ViewObject
}}

Если мы находимся в режиме командной строки и графического интерфейса нет, последняя строка вернет {{incode|None}}.
{{Top}}
===Объекты документа===

В FreeCAD всё, над чем вы работаете, находится внутри документов. Документ содержит вашу геометрию и может быть сохранен в файл. Одновременно может быть открыто несколько документов. Документ, также как и геометрия, содержащиеся внутри него, имеет объекты {{incode|App}} и {{incode|Gui}}. Объект {{incode|App}} содержит фактически определенную Вами геометрию, в то время как объект {{incode|Gui}} содержит различные отображения из вашего документа. Вы можете открывать несколько окон, каждое из которых отображение вашей работы с различным масштабом или точкой зрения. Эти виды входят в объект {{incode|Gui}} вашего документа.

Чтобы получить доступ к части {{incode|App}} текущего открытого (активного) документа, введите:

{{Code|code=
myDocument = App.ActiveDocument
}}


Чтобы получить доступ к App части текущего открытого (активного) документа, введите:
myDocument = App.ActiveDocument
Чтобы создать новый документ, введите:
Чтобы создать новый документ, введите:

myDocument = App.newDocument("Document Name")
{{Code|code=
Чтобы получить доступ к Gui части текущего открытого (активного) документа, введите:
myDocument = App.newDocument("Document Name")
myGuiDocument = Gui.ActiveDocument
}}

Чтобы получить доступ к части {{incode|Gui}} текущего открытого (активного) документа, введите:

{{Code|code=
myGuiDocument = Gui.ActiveDocument
}}

чтобы получить доступ к текущему виду, введите:
чтобы получить доступ к текущему виду, введите:
myView = Gui.ActiveDocument.ActiveView


{{Code|code=
{{docnav|Introduction to python|Mesh Scripting}}
myView = Gui.ActiveDocument.ActiveView
}}
{{Top}}
==Использование дополнительных модулей==

<div class="mw-translate-fuzzy">
Модули {{incode|FreeCAD}} и {{incode|FreeCADGui}} отвечают за создание и управление объектами в документе FreeCAD. Они не занимаются созданием или изменением геометрии. Это потому, что эта геометрия может быть нескольких типов, и поэтому она управляется дополнительными модулями, каждый из которых отвечает за управление определенным типом геометрии. Например, [[Part Workbench/ru|Модуль Part]] использует ядро OpenCascade и поэтому может создавать и манипулировать геометрией типа [http://en.wikipedia.org/wiki/Boundary_representation B-rep]. В то же время [[Mesh Workbench/ru|Модуль Mesh]] может создавать и модифицировать объекты типа сетка. Таким образом, FreeCAD может обрабатывать самые разные типы объектов, которые могут сосуществовать в одном документе, и новые типы могут быть легко добавлены в будущем.
</div>
{{Top}}
===Создание объектов===

Каждый модуль имеет свой собственный способ обработки своей геометрии, но обычно они все могут создавать объекты в документе. Но документ FreeCAD также знает о доступных типах объектов, предоставляемых модулями:

{{Code|code=
FreeCAD.ActiveDocument.supportedTypes()
}}

перечислит все возможные объекты, которые вы можете создать. Например, давайте создадим сетку (поддерживаемую модулем {{incode|Mesh}}) и деталь (поддерживаемую модулем {{incode|Part}}):

{{Code|code=
myMesh = FreeCAD.ActiveDocument.addObject("Mesh::Feature", "myMeshName")
myPart = FreeCAD.ActiveDocument.addObject("Part::Feature", "myPartName")
}}

Первый аргумент - это тип объекта, второй - имя объекта. Наши два объекта выглядят почти одинаково: они еще не содержат никакой геометрии, и большинство их свойств одинаковы, когда вы проверяете их с помощью {{incode|dir(myMesh)}} и {{incode|dir(myPart)}}. За исключением одного, {{incode|myMesh}} имеет свойство {{incode|Mesh}}, а {{incode|myPart}} - свойство {{incode|Shape}}. Здесь хранятся данные Mesh и Part. Например, давайте создадим куб {{incode|Part}} и сохраним его в нашем объекте {{incode|myPart}}:

{{Code|code=
import Part
cube = Part.makeBox(2, 2, 2)
myPart.Shape = cube
}}

Вы можете попытаться сохранить куб в свойстве {{incode|Mesh}} объекта {{incode|myMesh}}, он вернет сообщение об ошибке неправильного типа. Это происходит из-за того, что каждое свойство предназначены для хранения только определенного типа. В свойстве {{incode|Mesh}} вы можете сохранять только то, что создано с помощью модуля {{incode|Mesh}}. Обратите внимание, что большинство модулей также имеют ярлык для добавления своей геометрии в документ:

{{Code|code=
import Part
cube = Part.makeBox(2, 2, 2)
Part.show(cube)
}}
{{Top}}
===Изменение объектов===

Модификация объекта выполняется так же:

{{Code|code=
import Part
cube = Part.makeBox(2, 2, 2)
myPart.Shape = cube
}}

Теперь давайте изменим форму на большую:

{{Code|code=
biggercube = Part.makeBox(5, 5, 5)
myPart.Shape = biggercube
}}
{{Top}}
===Запрос объектов===

Вы всегда можете посмотреть на тип объекта следующим образом:

{{Code|code=
myObj = FreeCAD.ActiveDocument.getObject("myObjectName")
print(myObj.TypeId)
}}

или проверить, является ли объект производным от одного из базовых объектов (элемент детали, элемент сетки и т.д.):

{{Code|code=
print(myObj.isDerivedFrom("Part::Feature"))
}}

Теперь вы действительно можете начать играть с FreeCAD! Насчёт полного списка всех доступных модулей и доступных инструментов смотрите в разделе [[:Category:API|Category:API]].
{{Top}}


<div class="mw-translate-fuzzy">
{{languages | {{en|FreeCAD Scripting Basics/en}} {{es|FreeCAD Scripting Basics/es}} {{se|FreeCAD Scripting Basics/se}} }}
{{Docnav/ru
|[[Python scripting tutorial/ru|Python scripting tutorial]]
|[[Topological_data_scripting/ru|Topological data scripting]]
}}
</div>


{{Powerdocnavi{{#translation:}}}}
[[Category:Poweruser Documentation]]
[[Category:Developer Documentation{{#translation:}}]]
[[Category:Python Code{{#translation:}}]]

Latest revision as of 13:46, 22 October 2021

Написание сценариев Python в FreeCAD

FreeCAD с начала построен так, чтобы быть полностью контролируемым сценариями Python. Почти все части FreeCAD, такие как интерфейс, содержимое сцены, и даже представление этого содержания в окне 3D просмотра доступны из встроенного Python интерпретатора или из своих собственных сценариев. Как результат, FreeCAD вероятно, является одной из наиболее глубоко настраиваемый инженерных приложений, доступных сегодня.

Если вы не знакомы с Python, мы рекомендуем Вам искать учебники по интернету, и бегло взглянуть на его структуру. Python это очень простой язык для обучения, особенно потому, он может быть сразу запущен внутри интерпритатора, где и простая команда и готовая программа может быть выполнена "на лету", без необходимости компилировать что-либо. FreeCAD имеет встроенный в Python интерпритатор. Если вы не видите окно с надписью Консоль Python, как показано ниже, вы можете активировать его через Вид → Панели → Консоль Python.

Интерпретатор

В интерпретаторе вы можете получить доступ к установленным в вашей системе модулям Python, а также встроенным модулям FreeCAD, и всем дополнительным модулям FreeCAD что вы установите позже. Скриншот ниже показывает интерпретатор Python:

The FreeCAD Python interpreter

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

The FreeCAD class browser

Таким образом, сначало наберите App. или Gui. посмотрите, что происходит. Другой, более общий Python метод изучения содержимого модулей и классов является использование команды print(dir()). Например, ввод print(dir()) выведет список всех модулей, загруженных в FreeCAD. print(dir(App)) покажет вам все, что содержит App модуль и т.д.

Еще одна полезная особенность интерпритатора возможность вернуться назад по истории команд и извлечь строки кода, которые вы уже набрали ранее. Для перемещения по истории команд, просто используйте Up arrow или Down arrow.

Щелкнув правой кнопкой мыши в окне интерпритатора, у вас также есть несколько других опций, таких как копирование всей истории (полезно для эксперимента что-то сделать, а затем получить полный сценарий этого), или вставить имя файла с полным путем.

наверх

Python Help

В меню Справка, вы найдете раздел Автоматически сгенерированная документация python, при открытии которого откроется окно браузера, содержащего полную, создаваемую в реальном времени, документацию всех модулей Python, доступных в интерпретаторе FreeCAD, встроенных модулях Python и FreeCAD, установленных в систему модулей и дополнительные модулей FreeCAD. Доступна ли документация зависит от того, сколько усилий разработчик каждого модуля приложил к документированию своего кода, но, как правило Python модули имеют репутацию хорошо задокументированных. Ваше окно FreeCAD должно оставаться открытым для того чтобы система документации работала. В разделе Документация по созданию скриптов на Python находится ссылка на этот вики-раздел Power users hub.

наверх

Встроеные модули

Поскольку FreeCAD спроектирован с возможностью запуска без графического интерфейса пользователя (Graphical User Interface, GUI), почти все функциональные возможности разделены на две группы: Базовая функциональности, названные App, и функциональность интерфейса, названный Gui. Эти два модуля можно также подключить из сценариев, вне интерпретатора, под названиями FreeCAD и FreeCADGui соответственно.

  • В модуле App вы найдете все, связанное с самим приложением, такие методы как открытия или закрытия файлов, а также документов, как настройка активного документа или объявление его содержания.
  • В модуле Gui вы найдете инструменты для доступа и управления элементами графического интерфейса, такими как инструментарии и и их панели инструментов, и, что более интересно, графическое представление всего содержимого FreeCAD.

Перелистывание содержимого этих модулей не слишком полезно, поскольку они растут довольно быстро с развитием FreeCAD. Но два инструмента просмотра (браузер классов и справка Python) должны обеспечить вас полной и актуальной документацией в любой момент.

наверх

Объекты модулей App и Gui

Как мы уже говорили, в FreeCAD, всё разделенные между основным и представлением. Это подразумевает и 3D-объекты. Вы можете получить доступ определяющим свойствам объектов (одна из особенностей FreeCAD) с помощью модуля App, и изменить то, как они представлены на экране с помощью модуля Gui. Например, куб имеет свойства, которые определяют его, такие как ширина, длина, высота, они хранятся в объекте App, а свойства представления, такие как цвета граней, режим отрисовки, хранятся в соответствующем объекте Gui.

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

Для каждого объекта App в вашем документе существует соответствующий объект Gui. Фактически и сам документ содержит объекты App и Gui. Это, конечно, действует только при запуске FreeCAD с полным интерфейсом. В режиме командной строки графического интерфейса нет, так что доступны только объекты App. Обратите внимание, что часть объектов Gui создается снова каждый раз когда объект App отмечен как "подлежащий пересчёту" (например, когда один из его параметров изменился), поэтому изменения, которые вы могли сделать непосредственно на объекте Gui могут быть потеряны.

чтобы получить доступ к части App чего-либо, введите:

myObject = App.ActiveDocument.getObject("ObjectName")

где "ObjectName" это имя вашего объекта. Вы также можете ввести:

myObject = App.ActiveDocument.ObjectName

чтобы получить доступ к части Gui того же объекта, введите:

myViewObject = Gui.ActiveDocument.getObject("ObjectName")

где "ObjectName" - имя вашего объекта. Вы также можете ввести:

myViewObject = App.ActiveDocument.ObjectName.ViewObject

Если мы находимся в режиме командной строки и графического интерфейса нет, последняя строка вернет None.

наверх

Объекты документа

В FreeCAD всё, над чем вы работаете, находится внутри документов. Документ содержит вашу геометрию и может быть сохранен в файл. Одновременно может быть открыто несколько документов. Документ, также как и геометрия, содержащиеся внутри него, имеет объекты App и Gui. Объект App содержит фактически определенную Вами геометрию, в то время как объект Gui содержит различные отображения из вашего документа. Вы можете открывать несколько окон, каждое из которых отображение вашей работы с различным масштабом или точкой зрения. Эти виды входят в объект Gui вашего документа.

Чтобы получить доступ к части App текущего открытого (активного) документа, введите:

myDocument = App.ActiveDocument

Чтобы создать новый документ, введите:

myDocument = App.newDocument("Document Name")

Чтобы получить доступ к части Gui текущего открытого (активного) документа, введите:

myGuiDocument = Gui.ActiveDocument

чтобы получить доступ к текущему виду, введите:

myView = Gui.ActiveDocument.ActiveView

наверх

Использование дополнительных модулей

Модули FreeCAD и FreeCADGui отвечают за создание и управление объектами в документе FreeCAD. Они не занимаются созданием или изменением геометрии. Это потому, что эта геометрия может быть нескольких типов, и поэтому она управляется дополнительными модулями, каждый из которых отвечает за управление определенным типом геометрии. Например, Модуль Part использует ядро OpenCascade и поэтому может создавать и манипулировать геометрией типа B-rep. В то же время Модуль Mesh может создавать и модифицировать объекты типа сетка. Таким образом, FreeCAD может обрабатывать самые разные типы объектов, которые могут сосуществовать в одном документе, и новые типы могут быть легко добавлены в будущем.

наверх

Создание объектов

Каждый модуль имеет свой собственный способ обработки своей геометрии, но обычно они все могут создавать объекты в документе. Но документ FreeCAD также знает о доступных типах объектов, предоставляемых модулями:

FreeCAD.ActiveDocument.supportedTypes()

перечислит все возможные объекты, которые вы можете создать. Например, давайте создадим сетку (поддерживаемую модулем Mesh) и деталь (поддерживаемую модулем Part):

myMesh = FreeCAD.ActiveDocument.addObject("Mesh::Feature", "myMeshName")
myPart = FreeCAD.ActiveDocument.addObject("Part::Feature", "myPartName")

Первый аргумент - это тип объекта, второй - имя объекта. Наши два объекта выглядят почти одинаково: они еще не содержат никакой геометрии, и большинство их свойств одинаковы, когда вы проверяете их с помощью dir(myMesh) и dir(myPart). За исключением одного, myMesh имеет свойство Mesh, а myPart - свойство Shape. Здесь хранятся данные Mesh и Part. Например, давайте создадим куб Part и сохраним его в нашем объекте myPart:

import Part
cube = Part.makeBox(2, 2, 2)
myPart.Shape = cube

Вы можете попытаться сохранить куб в свойстве Mesh объекта myMesh, он вернет сообщение об ошибке неправильного типа. Это происходит из-за того, что каждое свойство предназначены для хранения только определенного типа. В свойстве Mesh вы можете сохранять только то, что создано с помощью модуля Mesh. Обратите внимание, что большинство модулей также имеют ярлык для добавления своей геометрии в документ:

import Part
cube = Part.makeBox(2, 2, 2)
Part.show(cube)

наверх

Изменение объектов

Модификация объекта выполняется так же:

import Part
cube = Part.makeBox(2, 2, 2)
myPart.Shape = cube

Теперь давайте изменим форму на большую:

biggercube = Part.makeBox(5, 5, 5)
myPart.Shape = biggercube

наверх

Запрос объектов

Вы всегда можете посмотреть на тип объекта следующим образом:

myObj = FreeCAD.ActiveDocument.getObject("myObjectName")
print(myObj.TypeId)

или проверить, является ли объект производным от одного из базовых объектов (элемент детали, элемент сетки и т.д.):

print(myObj.isDerivedFrom("Part::Feature"))

Теперь вы действительно можете начать играть с FreeCAD! Насчёт полного списка всех доступных модулей и доступных инструментов смотрите в разделе Category:API.

наверх