本日は Blender の技術調査枠です。
Blender3.0で利用可能なpythonスクリプトを作ります。
3Dビューの選択モードを切り替える
python スクリプトから3Dビュー内の左クリックでの選択モードを切り替える方法を記事にします。
選択モードを切り替えるには wm.tool_set_by_id オペレータを利用します。
docs.blender.org
本オペレータは3Dビュー内でのみ有効です。
他のビューからオペレータを操作する場合は以下の例のように3Dビューの参照を取得する必要があります。
blender.stackexchange.com
def set_active_tool(tool_name): for area in bpy.context.screen.areas: if area.type == "VIEW_3D": override = bpy.context.copy() override["space_data"] = area.spaces[0] override["area"] = area bpy.ops.wm.tool_set_by_id(override, name=tool_name)
今回はオペレータを実行するボタンを3Dビュー内のサイドバーに配置する形でオペレータを参照しました。
これら3Dビュー内で利用可能な操作ツールは wmTool と呼ばれます。型の情報は以下を参照ください。
docs.blender.org
docs.blender.org
サンプルスクリプト
3Dビューのサイドバーに選択ツールを切り替えるボタンを追加するアドオンです。
・Addon_operator_selecttoolset.py
# 定数の定義 ADDON_COMMONNAME = "holomon_operator_selecttoolset" # bl_infoでプラグインに関する情報の定義を行う bl_info = { "name": "HoloMon Blender Addon Toolkit", # プラグイン名 "author": "HoloMon", # 制作者名 "version": (1, 0), # バージョン "blender": (3, 00, 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 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_operator_selecttoolset(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 # ボックス要素を作成する draw_box = draw_layout.box() # ボックス内に要素列(縦並びの隙間詰め)を作成する select_col = draw_box.column(align=True) # 選択方式を切り替えるボタンを配置する selectbox_prop = select_col.operator("wm.tool_set_by_id", text="ボックス選択") # 引数を指定する selectbox_prop.name = 'builtin.select_box' # 選択方式を切り替えるボタンを配置する selectcircle_prop = select_col.operator("wm.tool_set_by_id", text="サークル選択") # 引数を指定する selectcircle_prop.name = 'builtin.select_circle' # 選択方式を切り替えるボタンを配置する selectlasso_prop = select_col.operator("wm.tool_set_by_id", text="投げ縄選択") # 引数を指定する selectlasso_prop.name = 'builtin.select_lasso' # wm.tool_set_by_id は3Dビュー内でのみ有効なOperatorである点に注意する # 本アドオンの処理はサイドバーを操作した3Dビューで実行される # 登録に関する処理 # 登録対象のクラス名 regist_classes = ( HOLOMON_PT_holomon_operator_selecttoolset, ) # 作成クラスと定義の登録メソッド 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()
