MRが楽しい

MRやVRについて学習したことを書き残す

Blender3.0で利用可能なpythonスクリプトを作る その101(現在の利用中の選択モード(wmTool)をチェックする)

本日は Blender の技術調査枠です。
Blender3.0で利用可能なpythonスクリプトを作ります。

現在の利用中の選択モード(wmTool)をチェックする

利用中の選択モード(wmTool)は from_space_view3d_mode オペレータで取得できます。
docs.blender.org
docs.blender.org

以下のように選択ツールが利用中か判定可能です。

# 現在利用中の選択モード(wmTool)を取得する
current_wmtool = context.workspace.tools.from_space_view3d_mode(context.mode)

# 取得した idname で利用中のツールを判定する
if current_wmtool.idname == "builtin.select_box":
    # ボックス選択ツールを利用中の場合
    selectbox_col.enabled = False
if current_wmtool.idname == "builtin.select_circle":
    # サークル選択ツールを利用中の場合
    selectcircle_col.enabled = False
if current_wmtool.idname == "builtin.select_lasso":
    # 投げ縄選択ツールを利用中の場合
    selectlasso_col.enabled = False

前回記事のスクリプトを修正して、対応する選択ツールを利用中の場合はボタンを無効化してみます。
bluebirdofoz.hatenablog.com

サンプルスクリプト

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()
        # ボックス内に要素列を作成する
        selectbox_col = draw_box.column()
        # 選択方式を切り替えるボタンを配置する
        selectbox_prop = selectbox_col.operator("wm.tool_set_by_id", text="ボックス選択")
        # 引数を指定する
        selectbox_prop.name = 'builtin.select_box'
        # ボックス内に要素列を作成する
        selectcircle_col = draw_box.column()
        # 選択方式を切り替えるボタンを配置する
        selectcircle_prop = selectcircle_col.operator("wm.tool_set_by_id", text="サークル選択")
        # 引数を指定する
        selectcircle_prop.name = 'builtin.select_circle'
        # ボックス内に要素列を作成する
        selectlasso_col = draw_box.column()
        # 選択方式を切り替えるボタンを配置する
        selectlasso_prop = selectlasso_col.operator("wm.tool_set_by_id", text="投げ縄選択")
        # 引数を指定する
        selectlasso_prop.name = 'builtin.select_lasso'
        # wm.tool_set_by_id は3Dビュー内でのみ有効なOperatorである点に注意する
        # 本アドオンの処理はサイドバーを操作した3Dビューで実行される
        # (https://blender.stackexchange.com/questions/135738/choose-active-tool-in-python)

        # 現在利用中のワークスペースツールを判定する
        # wmToolsアクセスのマニュアル
        # (https://docs.blender.org/api/current/bpy.types.wmTools.html)
        # (https://docs.blender.org/api/current/bpy.types.WorkSpaceTool.html)
        current_wmtool = context.workspace.tools.from_space_view3d_mode(context.mode)
        
        # 取得した idname で利用中のツールを判定する
        if current_wmtool.idname == "builtin.select_box":
            # ボックス選択ツールを利用中の場合
            selectbox_col.enabled = False
        if current_wmtool.idname == "builtin.select_circle":
            # サークル選択ツールを利用中の場合
            selectcircle_col.enabled = False
        if current_wmtool.idname == "builtin.select_lasso":
            # 投げ縄選択ツールを利用中の場合
            selectlasso_col.enabled = False

# 登録に関する処理
# 登録対象のクラス名
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()

f:id:bluebirdofoz:20220212234829j:plain
f:id:bluebirdofoz:20220212234839j:plain
f:id:bluebirdofoz:20220212234849j:plain

課題

3Dビュー左のボタンから選択ツールを選択した場合は状態が即座に反映されません。
3Dビュー内のオブジェクトやボタンをマウスオーバーした時点で状態が更新されます。
f:id:bluebirdofoz:20220212234856j:plain

以下の Depsgraph の変化を検出するハンドラでも変化の検知はできないようでした。
bluebirdofoz.hatenablog.com

ツール切り替え時のイベントの取得方法が分かれば改めて記事にします。