MRが楽しい

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

Blender2.8で利用可能なpythonスクリプトを作る その46(コレクション内のオブジェクトの取得と移動)

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

コレクション内のオブジェクトの取得と移動

指定のオブジェクトを指定のコレクションにリンクします。
オブジェクトが他のコレクションにリンクされていた場合は解除されます。
・move_object_collections.py

# bpyインポート
import bpy

# 指定のオブジェクトを指定のコレクションにリンクする
# 他のコレクションへのリンクは解除される
def move_object_collections(arg_objectname="Default", arg_destinationname="Collection") -> bool:
    """指定のオブジェクトを指定のコレクションにリンクする
    他のコレクションへのリンクは解除される

    Args:
        arg_objectname (str, optional): 指定オブジェクト名. Defaults to "Default".
        arg_destinationname (str, optional): 移動先コレクション名. Defaults to "Collection".

    Returns:
        bool: 実行正否
    """

    # 指定オブジェクトを取得する
    # (get関数は対象が存在しない場合 None が返る)
    selectob = bpy.data.objects.get(arg_objectname)

    # 指定オブジェクトが存在するか確認する
    if selectob == None:
        # 指定オブジェクトが存在しない場合は処理しない
        return False

    # 指定コレクションを取得する
    # (get関数は対象が存在しない場合 None が返る)
    destinationcollection = bpy.data.collections.get(arg_destinationname)

    # 指定コレクションが存在するか確認する
    if destinationcollection == None:
        # 指定コレクションが存在しない場合は処理しない
        return False

    # 全てのコレクションを操作する
    for collection in bpy.data.collections:
        # コレクション内に指定オブジェクトのリンクが存在するか確認する
        checklink = collection.objects.get(selectob.name)
        if checklink != None:
            # リンクが存在する場合、そのリンクを解除する
            collection.objects.unlink(selectob)
    
    # 指定のコレクションにオブジェクトをリンクする
    destinationcollection.objects.link(selectob)

    return True


# 関数の実行例
move_object_collections(arg_objectname="Sphere", arg_destinationname="FirstCollection")

f:id:bluebirdofoz:20200701224243j:plain
f:id:bluebirdofoz:20200701224254j:plain

アドオンバージョン

上記スクリプトをアドオン化してみました。
追加されるパネルから対象のオブジェクトと移動先のコレクションを選択し、実行ボタンをクリックします。
すると、オブジェクトが指定のコレクションに移動します。
・Addon_move_object_collections.py

# bl_infoでプラグインに関する情報の定義を行う
bl_info = {
    "name": "HoloMon Move Collection Addon",         # プラグイン名
    "author": "HoloMon",                             # 制作者名
    "version": (1, 0),                               # バージョン
    "blender": (2, 80, 0),                           # 動作可能なBlenderバージョン
    "support": "TESTING",                            # サポートレベル
    "category": "3D View",                           # カテゴリ名
    "location": "View3D > Sidebar > HoloMon",        # ロケーション
    "description": "Addon Curve Check",              # 説明文
    "location": "",                                  # 機能の位置付け
    "warning": "",                                   # 注意点やバグ情報
    "doc_url": "",                                   # ドキュメントURL
}

# 利用するタイプやメソッドのインポート
import bpy
from bpy.types import Operator, Panel, PropertyGroup
from bpy.props import PointerProperty

# 継承するクラスの命名規則は以下の通り
# [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_addon_move_collection(Panel):
    # パネルのラベル名を定義する
    # パネルを折りたたむパネルヘッダーに表示される
    bl_label = "Move Collection Addon Panel"
    # クラスのIDを定義する
    # 命名規則は CATEGORY_PT_name
    bl_idname = "HOLOMON_PT_addon_move_collection"
    # パネルを使用する領域を定義する
    # 利用可能な識別子は以下の通り
    #   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'
    # パネルタイプのオプションを定義する
    # DEFAULT_CLOSED:作成時にパネルを開くか折りたたむ必要があるかを定義する。
    # HIDE_HEADER:ヘッダーを非表示するかを定義する。Falseに設定するとパネルにはヘッダーが表示される。
    # デフォルトは {'DEFAULT_CLOSED'}
    bl_options = {'DEFAULT_CLOSED'}
    # パネルの表示順番を定義する
    # 小さい番号のパネルは、大きい番号のパネルの前にデフォルトで順序付けられる
    # デフォルトは 0
    bl_order = 0
    # パネルのカテゴリ名称を定義する
    # 3Dビューポートの場合、サイドバーの名称になる
    # デフォルトは名称無し
    bl_category = "HoloMon"
 
    # 描画の定義
    def draw(self, context):
        # Operatorをボタンとして配置する
        draw_layout = self.layout
        # 要素行を作成する
        select_row = draw_layout.row()
        # オブジェクト選択用のカスタムプロパティを配置する
        select_row.prop(context.scene.holomon_movecollection, "prop_objectslect", text='')
        # 要素行を作成する
        length_row = draw_layout.row()
        # コレクション選択用のカスタムプロパティを配置する
        length_row.prop(context.scene.holomon_movecollection, "prop_collectionslect", text='')
        # 要素行を作成する
        button_row = draw_layout.row()
        # オブジェクト指定のサイズ縮小を実行するボタンを配置する
        button_row.operator("holomon.movecollection")

# Operatorクラスの作成
# 参考URL:https://docs.blender.org/api/current/bpy.types.Operator.html
class HOLOMON_OT_addon_move_collection(Operator):
    # クラスのIDを定義する
    # (Blender内部で参照する際のIDに利用)
    bl_idname = "holomon.movecollection"
    # クラスのラベルを定義する
    # (デフォルトのテキスト表示などに利用)
    bl_label = "MOVE COLLECTION"
    # クラスの説明文
    # (マウスオーバー時に表示)
    dl_description = "Move Collection Addon 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'}


    # Operator実行時の処理
    def execute(self, context):
        # カスタムプロパティから指定中のオブジェクトを取得する
        target_obj = context.scene.holomon_movecollection.prop_objectslect

        # 指定中のオブジェクトを確認する
        if target_obj == None:
            # オブジェクトが指定されていない場合はエラーメッセージを表示する
            self.report({'ERROR'}, "No objects selected.")
            return {'CANCELLED'}

        # カスタムプロパティから指定中のコレクションを取得する
        target_collection = context.scene.holomon_movecollection.prop_collectionslect

        # 指定中のオブジェクトを確認する
        if target_collection == None:
            # オブジェクトが指定されていない場合はエラーメッセージを表示する
            self.report({'ERROR'}, "No collection selected.")
            return {'CANCELLED'}

        # 指定のオブジェクトを指定のコレクションに移動する
        move_object_collections(arg_selectobj=target_obj, arg_destinationcollection=target_collection)

        return {'FINISHED'}

# PropertyGroupクラスの作成
# 参考URL:https://docs.blender.org/api/current/bpy.types.PropertyGroup.html
class HOLOMON_addon_move_collection_properties(PropertyGroup):
    # オブジェクト選択時のチェック関数を定義する
    def prop_object_select_poll(self, context, ):
        # カーブオブジェクトのみ選択可能
        if(context and context.type in ('MESH', )):
            return True
        return False

    # シーン上のパネルに表示するオブジェクト選択用のカスタムプロパティを定義する
    prop_objectslect: PointerProperty(
        name = "Select Object",         # プロパティ名
        type = bpy.types.Object,        # タイプ
        description = "",               # 説明文
        poll = prop_object_select_poll, # チェック関数
    )

    # シーン上のパネルに表示するコレクション選択用のカスタムプロパティを定義する
    prop_collectionslect: PointerProperty(
        name = "Select Object",         # プロパティ名
        type = bpy.types.Collection,    # タイプ
        description = "",               # 説明文
    )



# 登録に関する処理
# 登録対象のクラス名
regist_classes = (
    HOLOMON_PT_addon_move_collection,
    HOLOMON_OT_addon_move_collection,
    HOLOMON_addon_move_collection_properties,
)

# 作成クラスと定義の登録メソッド
def register():
    # カスタムクラスを登録する
    for regist_cls in regist_classes:
        bpy.utils.register_class(regist_cls)
    # シーン情報にカスタムプロパティを登録する
    bpy.types.Scene.holomon_movecollection = PointerProperty(type=HOLOMON_addon_move_collection_properties)

# 作成クラスと定義の登録解除メソッド
def unregister():
    # シーン情報のカスタムプロパティを削除する
    del bpy.types.Scene.holomon_movecollection
    # カスタムクラスを解除する
    for regist_cls in regist_classes:
        bpy.utils.unregister_class(regist_cls)


# 指定のオブジェクトを指定のコレクションにリンクする
# 他のコレクションへのリンクは解除される
def move_object_collections(arg_selectobj: bpy.types.Object, arg_destinationcollection: bpy.types.Collection) -> bool:
    """指定のオブジェクトを指定のコレクションにリンクする
    他のコレクションへのリンクは解除される

    Args:
        arg_selectobj (bpy.types.Object): 指定オブジェクト
        arg_destinationcollection (bpy.types.Collection): 移動先コレクション

    Returns:
        bool: 実行正否
    """

    # 指定オブジェクトが存在するか確認する
    if arg_selectobj == None:
        # 指定オブジェクトが存在しない場合は処理しない
        return False

    # 指定コレクションが存在するか確認する
    if arg_destinationcollection == None:
        # 指定コレクションが存在しない場合は処理しない
        return False

    # 全てのコレクションを操作する
    for collection in bpy.data.collections:
        # コレクション内に指定オブジェクトのリンクが存在するか確認する
        checklink = collection.objects.get(arg_selectobj.name)
        if checklink != None:
            # リンクが存在する場合、そのリンクを解除する
            collection.objects.unlink(arg_selectobj)
    
    # 指定のコレクションにオブジェクトをリンクする
    arg_destinationcollection.objects.link(arg_selectobj)

    return True


# 実行時の処理
if __name__ == "__main__":
    # 作成クラスと定義を登録する
    register()

f:id:bluebirdofoz:20200701230334j:plain