UI を作成する方法 (Python API / bpy) [Blender]

お知らせ

次の項目は別ページに分割しました。

使い方

要素

label：ラベル – 文字列を表示する
separator：セパレーター
operator：オペレーターを実行するボタンを配置する
prop：プロパティを表示する

レイアウト

row：行 – 要素を横に並べる
column：列 – 要素を縦に並べる
box：ボックス – 要素を枠で囲う
split：左右に分割する

プロパティ

scale_x：X方向の拡大縮小率
scale_y：Y方向の拡大縮小率
alignment：要素の整列方法を指定する
- LEFT：左寄せ
- CENTER：中央寄せ
- RIGHT：右寄せ
alert：警告として表示する
emboss：エンボス表示の有効／無効を切り替える
active：表示がアクティブかどうかを切り替える
enabled：操作可能かどうかを切り替える

コード：

Basic UI Example (p2or) – GitHub Gist

参考：

メニューの作り方／様々なレイアウト要素の紹介 | 忘却まとめ

UI を制御する | はじめての Blender アドオン開発

How to create a custom UI? – Blender Stack Exchange

メニューを作成する

ドキュメント：

Menu | Blender Python API [Official]

メニューに項目を追加する

サブメニューを追加する。

class EXAMPLE_MT_menu(bpy.types.Menu):
    bl_label = "Example"
    bl_description = "Example Menu"

    def draw(self, context):
        layout = self.layout
        layout.operator('transform.resize')

def menu_func(self, context):
    layout = self.laytout
    layout.separator()
    layout.menu('EXAMPLE_MT_menu')

def register():
    bpy.utils.register_class(EXAMPLE_MT_menu)
    bpy.types.VIEW3D_MT_object.append(menu_func)

def def unregister():
    bpy.utils.unregister_class(EXAMPLE_MT_menu)
    bpy.types.VIEW3D_MT_object.remove(menu_func)
Code language: Python (python)

参考：

プラグインでサブメニューを作成する方法 – Qiita

UI に項目を追加 | TomoG のごちゃまぜ倉庫

サブメニューを作成する | はじめての Blender アドオン開発

メニューの追加登録候補について | nikogoli

Official keymap example does not work? – Blender Developer Talk

How to add a custom object entry to the add menu? – Blender Stack Exchange

How to add a custom menu item to the object menu? – Blender Stack Exchange

Deleting unwanted New objects in the “add Object” menu – Blender Stack Exchange

Operator docstrings displayed on buttons, not in search mode – Blender Stack Exchange

メニューを置き換える

参考：

How to delete an existing menu? – Blender Stack Exchange

ダイアログ／ポップアップを表示する

こちらのページを参照

ダイアログ／ポップアップを表示する方法 (bpy)

ドキュメント：

Dialog Box | Blender Python API [Official]

参考：

UI を制御する #3 | はじめての Blender アドオン開発

Blender でボタンが押されたときポップアップウインドウを表示する (dskjal) – GitHub Gist

Creating pop-up panels with user UI in Blender add-on | Interplanety

列／行を作成する (column / row)

ドキュメント：

User Interface Layout – Best Practice | Blender Python API [Official]

参考：

User interface elements alignment by columns | Interplanety

How do I use multiple columns in my add-on UI? – Blender Stack Exchange

vertical align of mixed panel? – Blender Stack Exchange

グリッドフロー (grid_flow / column_flow)

ドキュメント：

bpy.types.UILayout.grid_flow | Blender Python API [Official]

bpy.types.UILayout.column_flow | Blender Python API [Official]

参考：

column align – Blender Stack Exchange

Creating a row of boolean properties (with icons) aligned in a UI panel – Blender Stack Exchange

How to make the UI interractive to it’s size? – Blender Stack Exchange

Is there any way to override UILayout.prop tooltip? – Blender Stack Exchange

How to make grid_flow aligned? – Developer Forum

スプリット (split)

ドキュメント：

bpy.types.UILayout.split | Blender Python API [Official]

bpy.types.UILayout.use_property_split | Blender Python API [Official]

参考：

keeping a UIlayout box a specific width percentage – Blender Artists Community

How to control spacing/alignment of Label + Horizontal Enum Property? – Blender Stack Exchange

How to create UIList with auto-aligned three columns? – Blender Stack Exchange

プロパティ欄を作成する (prop)

必須

data：データオブジェクト
property：プロパティ名

任意

text：指定された場合、自動的に割り当てられるテキストを上書きする
text_ctxt：テキストの翻訳コンテキストを上書きする
translate：翻訳を適用する
icon：自動的に割り当てられるアイコンを上書きする
expand
slider：数値にスライダーウィジェットを用いる
toggle：真偽値にトグルウィジェットを用いる (デフォルトでは、アイコンが表示されている場合にのみトグルウィジェットを用いる)
icon_only：アイコンのみを表示する (テキストを表示しない)
event
full_event
emboss
index
icon_value：アイコン番号を整数値で指定する／自動的に割り当てられるアイコンを上書きする
invert_checkbox：チェックボックスの表示を反転する

こちらのページを参照

プロパティの使い方 (Property / bpy.props)

ドキュメント：

bpy.types.UILayout.prop | Blender Python API [Official]

オブジェクトを選択する

スポイトアイコン付きのオブジェクト選択欄を作成する。

参考：

オブジェクト指定のアドオンスクリプト | MR が楽しい

Object selection box with eye dropper – Blender Stack Exchange

Make the eyedropper tool available in add-ons via Python – Right-Click Select

ドロップダウンリストを作成する

参考：

create drop-down list in menu panel – Blender Stack Exchange

GUI を作成する

参考：

Addon のチェックボックスの追加とプロパティへのアクセス | ぬの部屋 (仮)

Interface – Code Snippets | wiki.blender.jp

アイコンを表示する

使用できるアイコンを確認する → Icon Viewer
オンラインで探す → Blendicons

ドキュメント：

UILayout.prop | Blender Python API [Official]

UILayout.label | Blender Python API [Official]

参考：

New icons for Blender 2.8x – Blender Developer Talk [Official]

2.8 Outlined / Coloured Icon Adaptation – Blender Developer Talk [Official]

Colored icons in add-on – Blender Developer Talk [Official]

New icons for Blender 2.8 – Blender Artists Community

2.8 Outlined / Coloured Icon Adaptation – Blender Artists Community

Is there a list or something available which shows the code of the Symbols of Blender – Blender Stack Exchange

How to edit 2.8 UI icons? – Blender Stack Exchange

Changing the name / icon / function of menu / pie menu / panel with a condition? – Blender Stack Exchange

Is there a way to get icon_value for the UIList using icon name from enum? – Blender Stack Exchange

material icon_value for UIList – Blender Stack Exchange

項目に色を付ける (alert)

参考：

In Python is it possible to change the background color of a property ui? – Blender Stack Exchange

項目の順序

append：最後に追加する
prepend：最初に追加する

コード：

append – bpy_types.py at 2e06c223cc – GitHub

prepend – bpy_types.py at 2e06c223cc – GitHub

_GenericUI – bpy_types.py at 2e06c223cc – GitHub

参考：

Rearranging elements of a panel – Blender Stack Exchange

How to change the order of a custom function added in the dropdown menu in the header region – Blender Stack Exchange

メニューからパイメニューを開く

オブジェクトコンテキストメニューからスナップパイメニューを開く。

import bpy

def custom_memu(self, context):
    layout = self.layout
    op = layout.operator("wm.call_menu_pie", text="Snap")
    op.name = "VIEW3D_MT_snap_pie"
    layout.separator()

def register():
    bpy.types.VIEW3D_MT_object_context_menu.prepend(custom_menu)

def unregister():
    bpy.types.VIEW3D_MT_object_context_menu.remove(custom_menu)

if __name__ == '__main__':
    register()
Code language: Python (python)