MRが楽しい

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

Blender2.9で利用可能なpythonスクリプトを作る その76(UVマップをまとめてオブジェクトを結合する)

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

UVマップをまとめてオブジェクトを結合する

UVマップをまとめてオブジェクトを結合するアドオンを追加します
具体的には以下の処理が行われます。
1.現在選択中のオブジェクトのUVマップをレンダリング設定が有効なものだけ残して削除する
2.レンダリング設定が有効なUVマップを指定のUVレイヤー名に変更する
3.選択中のオブジェクトを結合する
・Addon_uvlayerclean_jointmesh_sample.py

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

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

# 継承するクラスの命名規則は以下の通り
# [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_uvlayerclean_jointmesh(Panel):
    # パネルのラベル名を定義する
    # パネルを折りたたむパネルヘッダーに表示される
    bl_label = "UVlayerClean JointMesh Addon Panel"
    # クラスのIDを定義する
    # 命名規則は CATEGORY_PT_name
    bl_idname = "HOLOMON_PT_addon_uvlayerclean_jointmesh"
    # パネルを使用する領域を定義する
    # 利用可能な識別子は以下の通り
    #   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
        # 要素行を作成する
        uvlayername_row = draw_layout.row()
        # UVレイヤー名指定用のカスタムプロパティを配置する
        uvlayername_row.prop(context.scene.holomon_uvlayerclean_jointmesh, "prop_uvlayername", text="")
        # 要素行を作成する
        button_row = draw_layout.row()
        # オブジェクト指定のサイズ縮小を実行するボタンを配置する
        button_row.operator("holomon.uvlayerclean_jointmesh")

# Operatorクラスの作成
# 参考URL:https://docs.blender.org/api/current/bpy.types.Operator.html
class HOLOMON_OT_addon_uvlayerclean_jointmesh(Operator):
    # クラスのIDを定義する
    # (Blender内部で参照する際のIDに利用)
    bl_idname = "holomon.uvlayerclean_jointmesh"
    # クラスのラベルを定義する
    # (デフォルトのテキスト表示などに利用)
    bl_label = "UVlayerClean JointMesh"
    # クラスの説明文
    # (マウスオーバー時に表示)
    dl_description = "UVlayerClean JointMesh 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):
        # カスタムプロパティから指定中のUVレイヤー名を取得する
        uvlayer_name = context.scene.holomon_uvlayerclean_jointmesh.prop_uvlayername

        # 指定中のUVレイヤー名を確認する
        if uvlayer_name == None:
            # UVレイヤー名が指定されていない場合はエラーメッセージを表示する
            self.report({'ERROR'}, "Nothing : uvlayer name.")
            return {'CANCELLED'}

        # 指定のオブジェクトのサイズを半分にする
        joint_result = addon_uvlayerclean_jointmesh(arg_uvlayername=uvlayer_name)

        # 実行結果を確認する
        if joint_result == False:
            # 実行に失敗した場合はエラーメッセージを表示する
            self.report({'ERROR'}, "Error : missing object joint.")
            return {'CANCELLED'}

        return {'FINISHED'}

# PropertyGroupクラスの作成
# 参考URL:https://docs.blender.org/api/current/bpy.types.PropertyGroup.html
class HOLOMON_addon_uvlayerclean_jointmesh_properties(PropertyGroup):
    # シーン上のパネルに表示するUVレイヤー名指定用のカスタムプロパティを定義する
    prop_uvlayername: StringProperty(
        name = "UVLayer Name",         # プロパティ名
        default = "JointUVMap",        # デフォルト値
        maxlen = 1024,                 # 最大文字列長
        description = "",              # 説明文
    )


# 登録に関する処理
# 登録対象のクラス名
regist_classes = (
    HOLOMON_PT_addon_uvlayerclean_jointmesh,
    HOLOMON_OT_addon_uvlayerclean_jointmesh,
    HOLOMON_addon_uvlayerclean_jointmesh_properties,
)

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

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


# 選択中のメッシュオブジェクトを結合してレンダー設定がアクティブなUVマップをまとめる
def addon_uvlayerclean_jointmesh(arg_uvlayername:str) -> bool:
    """選択中のメッシュオブジェクトを結合してレンダー設定がアクティブなUVマップをまとめる

    Args:
        arg_uvlayername (str): 結合後のUVレイヤー名

    Returns:
        bool: 実行正否
    """


    # 現在選択中のオブジェクトリスト用の空リストを作成する
    select_object_list = []

    # 有効なコレクションを取得する
    collection_list = bpy.context.scene.collection.children

    # 各レイヤーコレクションを精査する
    for collection in collection_list:
        # コレクション内のオブジェクトリストを取得する
        obj_list = collection.objects
        # オブジェクトのリストを精査する
        for obj in obj_list:
            # メッシュタイプか確認する
            if(obj.type == 'MESH'):
                # 選択状態か確認する
                if obj.select_get() == True:
                    # 選択状態であればリストに追加する
                    select_object_list.append(obj)

    # 取得したオブジェクト数を確認する
    if len(select_object_list) < 1:
        # 結合対象となる選択中のオブジェクトがなければ処理しない
        return False
    
    # アクティブオブジェクトが存在するか確認する
    if bpy.context.view_layer.objects.active == None:
        # 結合先となるアクティブオブジェクトがなければ処理しない
        return False


    for select_object in select_object_list:
        # 対象オブジェクトのメッシュデータを取得する
        # メッシュデータ操作のマニュアル
        # (https://docs.blender.org/api/current/bpy.types.Mesh.html)
        meshdata = select_object.data

        # UVマップレイヤーのリストを取得する
        # UVマップレイヤーのリスト操作のマニュアル
        # (https://docs.blender.org/api/current/bpy.types.UVLoopLayers.html)
        uv_layers = meshdata.uv_layers

        # レンダー設定がアクティブなUVマップを取得する
        active_uvlayer = None

        # UVマップレイヤーを全て走査する
        # 削除処理を行うので逆順に要素を追う
        for num in range(len(uv_layers))[::-1]:
            # UVマップレイヤーを取得する
            # UVマップレイヤー操作のマニュアル
            # (https://docs.blender.org/api/current/bpy.types.MeshUVLoopLayer.html)
            uv_layer = uv_layers[num]
            # レンダー設定の有効無効を判定する
            if uv_layer.active_render:
                # レンダー設定がアクティブなUVマップの名前を変更する
                uv_layer.name = arg_uvlayername
                # レンダー設定がアクティブなUVマップを取得する
                active_uvlayer = uv_layer
            else:
                # アクティブでないUVマップは削除する
                uv_layers.remove(uv_layer)

    # 選択中のオブジェクトを結合する
    bpy.ops.object.join()

    return True


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

・実行前
f:id:bluebirdofoz:20201209221522j:plain
・実行後
f:id:bluebirdofoz:20201209221534j:plain
f:id:bluebirdofoz:20201209221545j:plain