Кастомные иконки в EnumProperty в Blender

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

.blend file on Patreon

Для начала создадим класс для пользовательской панели, на которой мы в дальнейшем разместим групповой переключатель и выпадающий список.

class TEST_PT_panel(bpy.types.Panel):
    bl_idname = 'TEST_PT_panel'
    bl_label = 'TEST'
    bl_space_type = 'VIEW_3D'
    bl_region_type = 'UI'
    bl_category = 'TEST'
 
    def draw(self, context):
        // UI

class TEST_PT_panel(bpy.types.Panel):

bl_idname = 'TEST_PT_panel'

bl_label = 'TEST'

bl_space_type = 'VIEW_3D'

bl_region_type = 'UI'

bl_category = 'TEST'

def draw(self, context):

// UI

Не забудьте зарегистрировать его в Blender Python API, чтобы наша пользовательская панель отобразилась в рабочей области 3D вьюпорта, в N-панели.

bpy.utils.register_class(TEST_PT_panel)

1	bpy.utils.register_class(TEST_PT_panel)

Внутри функции draw() мы в дальнейшем определим отображение элементов нашего UI.

Но сначала создадим список для кастомных иконок и загрузим в него несколько иконок из внешних файлов.

Список наших иконок “icons” создается при помощи модуля previews из пакета bpy.utils.

from bpy.utils import previews

icons = previews.new()

from bpy.utils import previews

icons = previews.new()

Вызов метода new() нужен для инициализации списка.

Загрузим в него три иконки из внешних файлов. Каждую иконку мы будем загружать при помощи метода load(), указывая полный путь к ее файлу.

icons.load(
    name='crown',
    path='d:/crown.png',
    path_type='IMAGE'
)
icons.load(
    name='sword',
    path='d:/sword.png',
    path_type='IMAGE'
)
icons.load(
    name='gem',
    path='d:/gem.png',
    path_type='IMAGE'
)

icons.load(

name='crown',

path='d:/crown.png',

path_type='IMAGE'

)

icons.load(

name='sword',

path='d:/sword.png',

path_type='IMAGE'

)

icons.load(

name='gem',

path='d:/gem.png',

path_type='IMAGE'

)

Теперь, для того чтобы создать переключатель и выпадающий список, при помощи EnumProperty определим объект test_enum, содержащий три элемента в кортеже items.

bpy.types.WindowManager.test_enum = bpy.props.EnumProperty(
    items=(
        ('CROWN', 'Crown', '', icons['crown'].icon_id, 0),
        ('GEM', 'Gem', '', icons['gem'].icon_id, 1),
        ('SWORD', 'Sword', '', icons['sword'].icon_id, 2)
    ),
    default='CROWN'
)

bpy.types.WindowManager.test_enum = bpy.props.EnumProperty(

items=(

('CROWN', 'Crown', '', icons['crown'].icon_id, 0),

('GEM', 'Gem', '', icons['gem'].icon_id, 1),

('SWORD', 'Sword', '', icons['sword'].icon_id, 2)

default='CROWN'

)

Каждый элемент – отдельная строка в items, представляет собой упорядоченный кортеж из свойств. На четвертом месте мы указываем ссылку на соответствующую иконку из созданного нами ранее списка. Таким образом мы привязываем иконки к элементам списка.

Нам осталось лишь прописать показ объекта test_enum в функции draw() нашей пользовательской панели.

Чтобы он имел вид переключателя, нужно параметр expand установить в значение True.

def draw(self, context):
    col = self.layout.column()
    col.prop(context.window_manager, 'test_enum', expand=True)

def draw(self, context):

col = self.layout.column()

col.prop(context.window_manager, 'test_enum', expand=True)

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

И, после разделителя, тот же самый объект в виде выпадающего списка:

def draw(self, context):
    col = self.layout.column()
    col.prop(context.window_manager, 'test_enum', expand=True)
    self.layout.separator()
    self.layout.prop(context.window_manager, 'test_enum', text='DropDownList')

def draw(self, context):

col = self.layout.column()

col.prop(context.window_manager, 'test_enum', expand=True)

self.layout.separator()

self.layout.prop(context.window_manager, 'test_enum', text='DropDownList')

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