API — Blender — Interplanety

Изменения в регистрации аддонов через API в Blender 2.8

В Blender 2.7 регистрация и разрегистрация аддонов через Python API производилась через Window manager — wm:

bpy.ops.wm.addon_install(filepath='_path_to_addon', overwrite=True)

bpy.ops.wm.addon_enable(module='addon_name')

bpy.ops.wm.addon_remove(module='addon_name')

bpy.ops.wm.addon_install(filepath='_path_to_addon', overwrite=True)

bpy.ops.wm.addon_enable(module='addon_name')

bpy.ops.wm.addon_remove(module='addon_name')

В Blender 2.8 API операторы работы с аддонами перенесены в preferences:

bpy.ops.preferences.addon_install(filepath='_path_to_addon', overwrite=True)

bpy.ops.preferences.addon_enable(module='addon_name')

bpy.ops.preferences.addon_remove(module='addon_name')

bpy.ops.preferences.addon_install(filepath='_path_to_addon', overwrite=True)

bpy.ops.preferences.addon_enable(module='addon_name')

bpy.ops.preferences.addon_remove(module='addon_name')

Положение 3D курсора в Blender 2.8 Python API

Свойство, указывающее на местоположение 3D-курсора

context.scene.cursor_location

1	context.scene.cursor_location

в Blender 2.8 перенесено в объект курсора

context.scene.cursor.location

1	context.scene.cursor.location

При попытке обращения к позиции курсора через «context.scene.cursor_location» Blender выдаст ошибку:

‘Scene’ object has no attribute ‘cursor_location’

Создание свойств для аддона

При разработке аддонов часто бывает необходимо предоставить пользователю возможность задавать ряд параметров, влияющих на общую работу аддона. Например, пользователь может указать постоянную директорию для загрузки/сохранения файлов или задать тот или иной режим работы аддона. Конечно, интерфейс для задания подобных параметров можно разместить и в рабочей панели аддона, но гораздо удобнее поместить его в отдельную панель свойств аддона, которая размещается под панелью инсталляции аддона в окне Preferences.

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

Создадим простейший аддон и добавим ему глобальный параметр, поместив его в панель свойств аддона:

Читать далее «Создание свойств для аддона»

Умножение матриц, векторов, кватернионов в Blender 2.8 Python API

В Blender 2.7 для умножения матриц, кватернионов и векторов использовался оператор «*» (звездочка). В Blender 2.8 API он заменен на оператор «@» (ат).

При попытке использования оператора «*» для умножения матриц, векторов или кватернионов, Blender 2.8 сигнализирует ошибкой:

Element-wise multiplication: not supported between ‘Matrix’ and ‘Matrix’ types

Пример использования оператора «@»:

bpy.context.region_data.view_rotation @ Vector((0.0, 0.0, 1.0))

1	bpy.context.region_data.view_rotation @ Vector((0.0, 0.0, 1.0))

Доступ к элементам привязки в Blender 2.8 Python API

Свойство, указывающее на выбранный тип привязки в Blender 2.7

bpy.context.scene.tool_settings.snap_element

1	bpy.context.scene.tool_settings.snap_element

в Blender 2.8 изменилось на

bpy.context.scene.tool_settings.snap_elements
# {'EDGE'}

1 2	bpy.context.scene.tool_settings.snap_elements # {'EDGE'}

Указание центральной точки в Blender 2.8 Python API

Указание опорной точки в Blender 2.7

bpy.context.area.spaces[0].pivot_point
# 'BOUNDING_BOX_CENTER':

1 2	bpy.context.area.spaces[0].pivot_point # 'BOUNDING_BOX_CENTER':

в Blender 2.8 API перемещено в:

bpy.context.scene.tool_settings.transform_pivot_point
# 'MEDIAN_POINT'

1 2	bpy.context.scene.tool_settings.transform_pivot_point # 'MEDIAN_POINT'

Свойство use_drag_immediately в Blender 2.8 Python API

Свойство use_drag_immediately в Blender 2.7

bpy.context.preferences.edit.use_drag_immediately

1	bpy.context.preferences.edit.use_drag_immediately

в Blender 2.8 API перемещено в

bpy.context.preferences.inputs.use_drag_immediately
# True

1 2	bpy.context.preferences.inputs.use_drag_immediately # True

Переключение системы координат в Blender 2.8 Python API

Обращение к текущей используемой системе координат, которое в Blender 2.7 осуществлялось через

bpy.context.space_data.transform_orientation

1	bpy.context.space_data.transform_orientation

в Blender 2.8 перенесено в коллекцию объектов TransformOrientatiosSlots. Для получения и изменения текущей системы координат нужно обращаться к объектам коллекции сцены transform_orientation_slots.

bpy.context.window.scene.transform_orientation_slots[0].type

# 'GLOBAL'

bpy.context.window.scene.transform_orientation_slots[0].type = 'LOCAL'
bpy.context.window.scene.transform_orientation_slots[0].type

# 'LOCAL'

bpy.context.window.scene.transform_orientation_slots[0].type

# 'GLOBAL'

bpy.context.window.scene.transform_orientation_slots[0].type = 'LOCAL'

bpy.context.window.scene.transform_orientation_slots[0].type

# 'LOCAL'

Как сделать объект (меш) активным в Blender 2.8 Python API

Для того, чтобы сделать меш (объект) активным в Blender 2.8 Python API вместо своства context.scene используется context.view_layer.

При попытке сделать меш активным через «bpy.context.scene.objects.active» Blender сигнализирует ошибкой:

AttributeError: bpy_prop_collection: attribute «active» not found

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

obj = bpy.context.window.scene.objects[0]
bpy.context.view_layer.objects.active = obj    # obj is the active object now

1 2	obj = bpy.context.window.scene.objects[0] bpy.context.view_layer.objects.active = obj # obj is the active object now

Выбор объекта (меша) в Blender 2.8 Python API

В связи с изменениями Blender API в версии 2.8 выбор меша (объекта) теперь осуществляется с помощью геттера/сеттера.

При попытке проверить выбран ли объект через «bpy.context.active_object.select» Blender сигнализирует ошибкой:

AttributeError: ‘Object’ object has no attribute ‘select’

Для проверки, является ли объект выбранным в Blender 2.8 нужно использовать геттер:

bpy.context.active_object.select_get()
# True

1 2	bpy.context.active_object.select_get() # True

Для того, чтобы выделить объект в Blender 2.8 нужно использовать сеттер:

bpy.context.active_object.select_set(state=True)

1	bpy.context.active_object.select_set(state=True)

Для снятия выбора нужно использовать тот же сеттер:

bpy.context.active_object.select_set(state=False)

1	bpy.context.active_object.select_set(state=False)

Портирование аддона для Blender 2.7 в Blender 2.8

В API последней версии Blender 2.8 разработчики внесли множество изменений, поэтому практически все скрипты и аддоны, написанные для более ранних версий Blender (2.7 и ниже), перестали работать. Для того, чтобы пользоваться полюбившимися аддонами в новой версии Blender, их нужно портировать — исправить их код для корректной работы с новым API Blender.

Изменения, которые необходимо внести в код аддона, чтобы он заработал в Blender 2.80:

Читать далее «Портирование аддона для Blender 2.7 в Blender 2.8»

Является ли свойство объекта read-only — только для чтения

Для того, чтобы проверить, является ли какое-либо свойство любого объекта Blender (меша, нода, модификатора и т.д.) read-only — «только для чтения», нужно выполнить следующие действия:

Для проверки через функцию is_property_readonly нужно выполнить команду вида:

<объект>.is_property_readonly(‘<название свойства>’)

Для проверки через структуру rna нужно выполнить команду вида:

<объект>.bl_rna.properties[‘<название свойства>’].is_readonly

Например свойство меша is_editmode (находится ли меш в режиме редактирования) для активного меша:

bpy.context.active_object.data.is_property_readonly('is_editmode')

# True


bpy.context.active_object.data.bl_rna.properties['is_editmode'].is_readonly

# True

bpy.context.active_object.data.is_property_readonly('is_editmode')

# True

bpy.context.active_object.data.bl_rna.properties['is_editmode'].is_readonly

# True

Как узнать, в какой версии Blender был создан blend-файл

Для того, чтобы узнать, в какой версии Blender был сохранен blend-файл, нужно:

Открыть файл в Blender
В окне Python Console выполнить команду:

bpy.data.version

1	bpy.data.version

или можно открыть blend-файл для просмотра в любом текстовом редакторе, напрмер Notepad++. Версия Blender будет указана в первых 15 символах.

Также версию открытого blend-файла можно посмотеть в окно Outliner в блоке Data Blocks:

Как узнать версию установленного в Blender аддона

Полный список установленных в Blender аддонов можно получить с помощью addon_utils:

import addon_utils
print(addon_utils.modules()[:])

# <module 'space_view3d_3d_navigation' from ...

import addon_utils

print(addon_utils.modules()[:])

# <module 'space_view3d_3d_navigation' from ...

Имея список аддонов, получить версию нужного аддона по его имени можно следующим образом:

import addon_utils
print([addon.bl_info.get('version', (-1,-1,-1)) for addon in addon_utils.modules() if addon.bl_info['name'] == 'ADD-ON_NAME'][0])

# (1,4,0)

import addon_utils

print([addon.bl_info.get('version', (-1,-1,-1)) for addon in addon_utils.modules() if addon.bl_info['name'] == 'ADD-ON_NAME'][0])

# (1,4,0)

Где ADD-ON_NAME — имя нужного аддона.

Если у аддона отсутствует указание версии, будет возвращет результат

# (-1,-1,-1)

1	# (-1,-1,-1)

Изучаем петли (loops)

В общем понимании «петля» или в терминологии 3D – «луп» (с английского loop – петля) обычно представляет собой последовательное выделение нескольких точек, ребер или полигонов меша.

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

Читать далее «Изучаем петли (loops)»

Как передать дополнительные параметры в скрипт или аддон при запуске Blender из командной строки

Blender обрабатывает все параметры, передаваемые при запуске через командную строку. Однако некоторое скрипты и аддоны при запуске Blender из консоли для правильной работы могут требовать указания своих уникальных аргументов. Если указать такие нестандартные параметры в командной строке, Blender попытается обработать и их, что скорее всего приведет к ошибке. Однако в Blender предусмотрен специальный способ отсечения подобных аргументов от обработки программой.

Читать далее «Как передать дополнительные параметры в скрипт или аддон при запуске Blender из командной строки»

Создание переключателя Radiobutton в интерфейсе аддона Blender

Переключатели состояний или так называемые Radio button — «радиокнопки» используют в случае, если нужно ограничить выбор какого-либо значения одним вариантом из нескольких имеющихся. В интерфейсе Blender есть множество подобных кнопок, например переключение между цветным и черно-белым режимами рендера или назначение режима маппинга текстуры к объекту. Подобные кнопки можно создавать и в интерфейсе разрабатываемых для Blender аддонов.

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

Читать далее «Создание переключателя Radiobutton в интерфейсе аддона Blender»

Как проверить, зарегистрирован ли оператор в API Blender

Аддон или скрипт может содержать внутри себя несколько различных операторов, и не все они могут быть зарегистрированны в системе при выполнении функции register(). Чтобы убедиться, что нужный оператор зарегистрирован в API Blender, необходимо выполнить следующую команду:

hasattr(bpy.types, bpy.ops._operator_bl_idname_.idname())

1	hasattr(bpy.types, bpy.ops._operator_bl_idname_.idname())

где:

_operator_bl_idname_ — текстовое значение свойства оператора bl_idname.

Например для оператора:

class TestOperator(bpy.types.Operator):
    bl_idname = 'test.operator'
    bl_label = 'Test operator'

    def execute(self, context):
        pass

class TestOperator(bpy.types.Operator):

bl_idname = 'test.operator'

bl_label = 'Test operator'

def execute(self, context):

pass

команда проверки его регистрации в API будет выглядить так:

hasattr(bpy.types, bpy.ops.test.operator.idname())

1	hasattr(bpy.types, bpy.ops.test.operator.idname())

Как программно проверить, зарегистрирован ли установленный в Blender аддон

Для того, чтобы установленный в Blender аддон начал работу его необходимо зарегистрировать — отметить чекбокс рядом с названием аддона в окне User Preferences — Add-ons.

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

'add-on_name' in bpy.context.user_preferences.addons

1	'add-on_name' in bpy.context.user_preferences.addons

где:

add-on_name — имя файла аддона (без расширения .py) или имя пакета аддона, если он установлен пакетом.

Отладка многофайлового аддона в Blender быстрой переустановкой

Для отладочного запуска разрабатываемого многофайлового аддона в Blender удобно использовать следующую систему. Однако описанный поход обладает одним недостатком: импортируемые в файле __init__.py модули становятся доступны только после выполнения самого файла (после того, как отработает функция register() ). Это означает, что любые обращения к импортируемым модулям до их регистрации вызовут ошибку. В большинстве случаев это не критично, однако вызовет проблемы, если в аддоне например используется наследование от класса, описанного в импортируемом модуле т.к. описание классов в модуле обрабатывается раньше инициализации аддона.

Чтобы получить больше свободы при работе с импортируемыми модулями, для отладки аддона можно использовать другой принцип — не запускать аддон непосредственно из директории разработки, а инсталлировать его в Blender и проверять работу сразу «на чистовую». Однако ручная переустановка аддона требует выполнения определенного набора действий, что излишне затрудняет подобную отладку. Решить данную проблему можно проводя переустановку аддона для тестов в автоматическом режиме.

Читать далее «Отладка многофайлового аддона в Blender быстрой переустановкой»

Как удалить и установить аддон Blender через python API

Установкой и удалением аддонов Blender можно управлять через python API. Для этого в скрипте нужно использовать следующие команды:

Деактивация аддона:

bpy.ops.wm.addon_disable(module = 'название аддона')

1	bpy.ops.wm.addon_disable(module = 'название аддона')

Удаление аддона:

bpy.ops.wm.addon_remove(module = 'название аддона')

1	bpy.ops.wm.addon_remove(module = 'название аддона')

Читать далее «Как удалить и установить аддон Blender через python API»

Редактирование свойств Custom Properties меша через API Blender

Для того, чтобы создать для выделенного меша новое свойство CustomProperties через API Blender достаточно выполнить команду:

bpy.context.active_object['property_name'] = property_value

1	bpy.context.active_object['property_name'] = property_value

где:

property_name — имя добавляемого свойства
property_value — значение, присваиваемое этому свойству

После выполнения команды новое свойство будет доступно в окне Properties панели Object подпанели Custom Properties.

Как и любое свойство объекта, созданное нами свойство обладает рядом параметров, просмотреть которые можно нажав на кнопку Edit. К этим параметрам также можно получить доступ через API.

Читать далее «Редактирование свойств Custom Properties меша через API Blender»

Работа с UV через API Blender

Доступ к активной развертке:

bpy.context.active_object.data.uv_layers.active

1	bpy.context.active_object.data.uv_layers.active

Доступ к развертке по имени:

bpy.context.active_object.data.uv_layers['UVMap']

1	bpy.context.active_object.data.uv_layers['UVMap']

Читать далее «Работа с UV через API Blender»

Создание плавающей панели в аддонах Blender

Для размещения элементов пользовательского интерфейса при разработке аддонов Blender кроме обычных панелей (N/T/Properties) и их подпанелей можно использовать и так называемые плавающие панели — появляющиеся на экране в произвольном месте при нажатии пользователем определенного сочетания клавиш или при совершении им какого-либо действия. Простейшим примером таких панелей является панель, появляющаяся при нажатии клавиши f6 сразу после добавления в сцену какого-либо объекта (shift+a).

API Blender предоставляет разработчикам возможность создавать подобные панели для своих аддонов. Рассмотрим процесс создания плавающей панели на примере всплывающего окна с сообщением типа «Messagebox».

Читать далее «Создание плавающей панели в аддонах Blender»

Активные объекты

Как обращаться через Blender Python API к активным (выделенным) объектам при написании скриптов/аддонов:

Активное окно (в котором происходит действие):

bpy.context.area.spaces.active

1	bpy.context.area.spaces.active

Активная сцена:

bpy.context.screen.scene

1	bpy.context.screen.scene

Активный (выделенный) меш:

bpy.context.active_object

1	bpy.context.active_object

Активный (выделенный) нод материала (в окне NODE_EDITOR):

bpy.context.active_object.active_material.node_tree.nodes.active

1	bpy.context.active_object.active_material.node_tree.nodes.active

Активный (выделенный) нод материала (в окне COMPOSITING):

bpy.context.scene.node_tree.nodes.active

1	bpy.context.scene.node_tree.nodes.active

Текущий текст в окне TEXT_EDITOR:

bpy.context.area.spaces.active.text.as_string()

1	bpy.context.area.spaces.active.text.as_string()

Текущая развертка (UV-Map):

bpy.context.active_object.data.uv_layers.active

1	bpy.context.active_object.data.uv_layers.active

Читать далее «Активные объекты»