本日は Blender の技術調査枠です。
Blender2.9で利用可能なpythonスクリプトを作ります。
ダイアログを表示する
Python からダイアログを表示するには invoke_props_dialog 関数を呼び出します。
draw 関数で呼び出すダイアログのレイアウトを変更することでカスタマイズしたダイアログを表示できます。
docs.blender.org
例えば以下のようなダイアログの呼び出しクラスを定義することができます。
class HOLOMON_OT_holomon_dialog_show(Operator): # クラスのIDを定義する # (Blender内部で参照する際のIDに利用) bl_idname = "holomon.dialog_show" # クラスのラベルを定義する # (デフォルトのテキスト表示などに利用) bl_label = "ダイアログの表示" # クラスの説明文 # (マウスオーバー時に表示) bl_description = "ダイアログを表示します" # クラスの属性 # 以下の属性を設定できる # REGISTER : Operatorを情報ウィンドウに表示し、やり直しツールバーパネルをサポートする # UNDO : 元に戻すイベントをプッシュする（Operatorのやり直しに必要） # UNDO_GROUPED : Operatorの繰り返しインスタンスに対して単一の取り消しイベントをプッシュする # BLOCKING : 他の操作がマウスポインタ―を使用できないようにブロックする # MACRO : Operatorがマクロであるかどうかを確認するために使用する # GRAB_CURSOR : 継続的な操作が有効な場合にオペレーターがマウスポインターの動きを参照して、操作を有効にする # GRAB_CURSOR_X : マウスポインターのX軸の動きのみを参照する # GRAB_CURSOR_Y : マウスポインターのY軸の動きのみを参照する # PRESET : Operator設定を含むプリセットボタンを表示する # INTERNAL : 検索結果からOperatorを削除する # 参考URL:https://docs.blender.org/api/current/bpy.types.Operator.html#bpy.types.Operator.bl_options bl_options = {'REGISTER', 'UNDO'} # ダイアログのレイアウト def draw(self, context): layout = self.layout # 表示テキストの追加 layout.label(text="テスト表示のダイアログです") # 呼び出し時の処理 def invoke(self, context, event): # ダイアログの呼び出し return context.window_manager.invoke_props_dialog(self) # Operator実行時の処理 def execute(self, context): # 本ダイアログでは[OK]ボタンクリック時に情報を処理しない return {'FINISHED'}
サンプルコード
サンプルコードとしてカスタマイズしたダイアログを表示するボタンを追加する以下のアドオンスクリプトを作成しました。
・Addon_dialog_show.py
# 定数の定義 ADDON_COMMONNAME = "holomon_dialog_show" ADDON_OPERATOR_IDNAME = "holomon.dialog_show" # bl_infoでプラグインに関する情報の定義を行う bl_info = { "name": "HoloMon Blender Addon Toolkit", # プラグイン名 "author": "HoloMon", # 制作者名 "version": (1, 2), # バージョン "blender": (2, 90, 0), # 動作可能なBlenderバージョン "support": "TESTING", # サポートレベル(OFFICIAL,COMMUNITY,TESTING) "category": "3D View", # カテゴリ名 "location": "View3D > Sidebar > HMToolkit", # ロケーション "description": "テストアドオン", # 説明文 "location": "", # 機能の位置付け "warning": "", # 注意点やバグ情報 "doc_url": "", # ドキュメントURL } # 利用するタイプやメソッドのインポート import bpy from bpy.types import Operator, Panel # 継承するクラスの命名規則は以下の通り # [A-Z][A-Z0-9_]*_(継承クラスごとの識別子)_[A-Za-z0-9_]+ # クラスごとの識別子は以下の通り # bpy.types.Operator OT # bpy.types.Panel PT # bpy.types.Header HT # bpy.types.MENU MT # bpy.types.UIList UL # Panelクラスの作成 # 参考URL:https://docs.blender.org/api/current/bpy.types.Panel.html class HOLOMON_PT_holomon_dialog_show(Panel): # パネルのラベル名を定義する # パネルを折りたたむパネルヘッダーに表示される bl_label = "表示画面のカスタマイズ" # クラスのIDを定義する # 命名規則は CATEGORY_PT_name bl_idname = "HOLOMON_PT_" + ADDON_COMMONNAME # パネルを使用する領域を定義する # 利用可能な識別子は以下の通り # EMPTY：無し # VIEW_3D：3Dビューポート # IMAGE_EDITOR：UV/画像エディター # NODE_EDITOR：ノードエディター # SEQUENCE_EDITOR：ビデオシーケンサー # CLIP_EDITOR：ムービークリップエディター # DOPESHEET_EDITOR：ドープシート # GRAPH_EDITOR：グラフエディター # NLA_EDITOR：非線形アニメーション # TEXT_EDITOR：テキストエディター # CONSOLE：Pythonコンソール # INFO：情報、操作のログ、警告、エラーメッセージ # TOPBAR：トップバー # STATUSBAR：ステータスバー # OUTLINER：アウトライナ # PROPERTIES：プロパティ # FILE_BROWSER：ファイルブラウザ # PREFERENCES：設定 bl_space_type = 'VIEW_3D' # パネルが使用される領域を定義する # 利用可能な識別子は以下の通り # ['WINDOW'、 'HEADER'、 'CHANNELS'、 'TEMPORARY'、 'UI'、 # 'TOOLS'、 'TOOL_PROPS'、 'PREVIEW'、 'HUD'、 'NAVIGATION_BAR'、 # 'EXECUTE'、 'FOOTER'の列挙型、 'TOOL_HEADER'] bl_region_type = 'UI' # パネルタイプのオプションをset型で定義する # DEFAULT_CLOSED：作成時にパネルを開くか折りたたむ必要があるかを定義する。 # HIDE_HEADER：ヘッダーを非表示するかを定義する。Falseに設定するとパネルにはヘッダーが表示される。 # デフォルトはオプション無し bl_options = set() # パネルの表示順番を定義する # 小さい番号のパネルは、大きい番号のパネルの前にデフォルトで順序付けられる # デフォルトは 0 bl_order = 0 # パネルのカテゴリ名称を定義する # 3Dビューポートの場合、サイドバーの名称になる # デフォルトは名称無し bl_category = "HMToolkit" # 描画の定義 def draw(self, context): # Operatorをボタンとして配置する draw_layout = self.layout # 要素行を作成する line_row = draw_layout.row() # 処理を実行するボタンを配置する line_row.operator(ADDON_OPERATOR_IDNAME) # Operatorクラスの作成 # 参考URL:https://docs.blender.org/api/current/bpy.types.Operator.html class HOLOMON_OT_holomon_dialog_show(Operator): # クラスのIDを定義する # (Blender内部で参照する際のIDに利用) bl_idname = ADDON_OPERATOR_IDNAME # クラスのラベルを定義する # (デフォルトのテキスト表示などに利用) bl_label = "ダイアログの表示" # クラスの説明文 # (マウスオーバー時に表示) bl_description = "ダイアログを表示します" # クラスの属性 # 以下の属性を設定できる # REGISTER : Operatorを情報ウィンドウに表示し、やり直しツールバーパネルをサポートする # UNDO : 元に戻すイベントをプッシュする（Operatorのやり直しに必要） # UNDO_GROUPED : Operatorの繰り返しインスタンスに対して単一の取り消しイベントをプッシュする # BLOCKING : 他の操作がマウスポインタ―を使用できないようにブロックする # MACRO : Operatorがマクロであるかどうかを確認するために使用する # GRAB_CURSOR : 継続的な操作が有効な場合にオペレーターがマウスポインターの動きを参照して、操作を有効にする # GRAB_CURSOR_X : マウスポインターのX軸の動きのみを参照する # GRAB_CURSOR_Y : マウスポインターのY軸の動きのみを参照する # PRESET : Operator設定を含むプリセットボタンを表示する # INTERNAL : 検索結果からOperatorを削除する # 参考URL:https://docs.blender.org/api/current/bpy.types.Operator.html#bpy.types.Operator.bl_options bl_options = {'REGISTER', 'UNDO'} # ダイアログのレイアウト def draw(self, context): layout = self.layout # 表示テキストの追加 layout.label(text="テスト表示のダイアログです") # 呼び出し時の処理 def invoke(self, context, event): # ダイアログの呼び出し return context.window_manager.invoke_props_dialog(self) # Operator実行時の処理 def execute(self, context): # 本ダイアログでは[OK]ボタンクリック時に情報を処理しない return {'FINISHED'} # 登録に関する処理 # 登録対象のクラス名 regist_classes = ( HOLOMON_PT_holomon_dialog_show, HOLOMON_OT_holomon_dialog_show, ) # 作成クラスと定義の登録メソッド def register(): # カスタムクラスを登録する for regist_cls in regist_classes: bpy.utils.register_class(regist_cls) # 作成クラスと定義の登録解除メソッド def unregister(): # カスタムクラスを解除する for regist_cls in regist_classes: bpy.utils.unregister_class(regist_cls) # エディター実行時の処理 if __name__ == "__main__": # 作成クラスと定義を登録する register()
