MRが楽しい

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

Blender2.9で利用可能なアドオンスクリプトを作る その2(ポリゴン数指定のリダクションを行うアドオン)

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

ポリゴン数指定のリダクションを行うアドオン

アドオンを追加すると[3Dビュー]のサイドバーから以下の設定・処理を実行できます。
f:id:bluebirdofoz:20211009220551j:plain

①.削減後の総ポリゴン(三角面)数

ポリゴン数削減後の総ポリゴン(三角面)数を指定します。

②.1メッシュ辺りの最低ポリゴン数

1メッシュ辺りの最低ポリゴン数を指定します。

③.ポリゴン数削減の実行

全メッシュを対象に指定のポリゴン数までの削減を行います。

実行例

[ビューポートオーバーレイ]から[統計]にチェックを入れて[統計]情報を表示しておくことをお奨めします。
[統計]情報には現在表示中の総ポリゴン数が表示されます。
f:id:bluebirdofoz:20211009220602j:plain

[3Dビューのシェーディング]を[ワイヤーフレーム]に変更しておくことをお奨めします。
リダクションによるポリゴン数の変化が分かり易くなります。
f:id:bluebirdofoz:20211009220611j:plain

[削減後の総ポリゴン数(三角面)]の値を変更して指定します。
f:id:bluebirdofoz:20211009220620j:plain

[1メッシュ辺りの最低ポリゴン数]の値を変更して指定します。
元からポリゴン数が少なく、リダクションすると変形してしまうオブジェクトを保護できます。
f:id:bluebirdofoz:20211009220630j:plain

指定が完了したら[ポリゴン数の削減]をクリックします。
1メッシュ辺りの最低ポリゴン数を維持しながら、全体が指定のポリゴン数になるようリダクションが実行されます。
f:id:bluebirdofoz:20211009220639j:plain

なお、最低ポリゴン数の制限により指定のポリゴン数まで削減できない場合は可能な最小のポリゴン数までリダクションします。

技術要素

本アドオンは以下の記事で紹介したアドオンを最低ポリゴン数を考慮してリダクションするように改良したものです。
bluebirdofoz.hatenablog.com

スクリプトコード

ポリゴン数指定のリダクションを行うアドオンを追加します。
・Addon_decimate_mesh.py

# 定数の定義
ADDON_TITLE = "Mesh Decimate"
ADDON_COMMONNAME = "holomon_decimate_mesh"
ADDON_OPERATOR_IDNAME = "holomon.decimate_mesh"

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

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

# 継承するクラスの命名規則は以下の通り
# [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_decimate_mesh(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 = 2
    # パネルのカテゴリ名称を定義する
    # 3Dビューポートの場合、サイドバーの名称になる
    # デフォルトは名称無し
    bl_category = "HMToolkit"
 
    # 描画の定義
    def draw(self, context):
        # Operatorをボタンとして配置する
        draw_layout = self.layout
        # 要素行を作成する
        line_row = draw_layout.row()
        # 削減後の総ポリゴン数指定用のカスタムプロパティを配置する
        line_row.prop(context.scene.holomon_decimate_mesh, "prop_targettrianglecount")
        # 要素行を作成する
        line_row = draw_layout.row()
        # 1メッシュ辺りの最低ポリゴン数指定用のカスタムプロパティを配置する
        line_row.prop(context.scene.holomon_decimate_mesh, "prop_mintrianglecount")
        # 要素行を作成する
        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_decimate_mesh(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'}

    # Operator実行時の処理
    def execute(self, context):
        # カスタムプロパティから削減後の総ポリゴン数を取得する
        targettrianglecount = context.scene.holomon_decimate_mesh.prop_targettrianglecount
        
        # 削減後の総ポリゴン数をチェックする
        if targettrianglecount <= 0:
            # 削減後の総ポリゴン数が 0 以下ならエラーメッセージを表示する
            self.report({'ERROR'}, "削減後の総ポリゴン数は 1 以上を設定して下さい")
            return {'CANCELLED'}

        # カスタムプロパティから1メッシュ辺りの最低ポリゴン数を取得する
        mintrianglecount = context.scene.holomon_decimate_mesh.prop_mintrianglecount
        
        # 全メッシュを対象に指定のポリゴン数まで削減する
        operator_result = apply_decimate_calculate(
            arg_targettrianglecount=targettrianglecount,
            arg_mintrianglecount=mintrianglecount
        )

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

        return {'FINISHED'}

# PropertyGroupクラスの作成
# 参考URL:https://docs.blender.org/api/current/bpy.types.PropertyGroup.html
class HOLOMON_PROP_holomon_decimate_mesh(PropertyGroup):
    # シーン上のパネルに表示する削減後の総ポリゴン数指定用のカスタムプロパティを定義する
    prop_targettrianglecount: IntProperty(
        name = "削減後の総ポリゴン(三角面)数",                   # プロパティ名
        default=0,                                             # デフォルト値
        description = "削減後の総ポリゴン(三角面)数を指定します", # 説明文
    )
    
    # シーン上のパネルに表示する1メッシュ辺りの最低ポリゴン数指定用のカスタムプロパティを定義する
    prop_mintrianglecount: IntProperty(
        name = "1メッシュ辺りの最低ポリゴン数",                   # プロパティ名
        default=0,                                              # デフォルト値
        description = "1メッシュ辺りの最低ポリゴン数を指定します", # 説明文
    )


# 登録に関する処理
# 登録対象のクラス名
regist_classes = (
    HOLOMON_PT_holomon_decimate_mesh,
    HOLOMON_OT_holomon_decimate_mesh,
    HOLOMON_PROP_holomon_decimate_mesh,
)

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

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


# 全メッシュを対象に指定のポリゴン数まで削減する
# 最低ポリゴン数の指定を考慮して計算を行う
def apply_decimate_calculate(arg_targettrianglecount:int=10000, arg_mintrianglecount:int=0) -> float:
    """全メッシュを対象に指定のポリゴン数まで削減する

    Keyword Arguments:
        arg_targettrianglecount {int} -- 削減後の指定ポリゴン数 (default: {10000})
        arg_mintrianglecount {int} -- オブジェクトの最低ポリゴン数 (default: {0})

    Returns:
        float -- 削減比率
    """

    # 全メッシュの総ポリゴン(三角面)数を取得する
    current_trianglecount = count_alltriangles_mesh()
    # 削減の比率を計算する
    target_ratio = 1.0
    # 指定のポリゴン数より現在のポリゴン数が多いか確認する
    if current_trianglecount > arg_targettrianglecount:
        # 指定のポリゴン数まで削減するための比率を計算する
        target_ratio = arg_targettrianglecount / current_trianglecount
    
    # 最低ポリゴン数を考慮して削減を実行した後のポリゴン数を計算する
    forecast_trianglecount = current_trianglecount

    # 予想ポリゴン数が指定のポリゴン数を下回るまで計算を繰り返す
    while forecast_trianglecount > arg_targettrianglecount:
        # ループの継続フラグ
        continue_flg = False

        # 予想ポリゴン数を 0 にリセット
        forecast_trianglecount = 0
        # シーン内の全オブジェクトデータを取得する
        for obj in bpy.context.scene.objects:
            # オブジェクトに反映する削減比率
            obj_ratio = target_ratio
            # オブジェクトのポリゴン数を取得する
            obj_trianglecount = count_triangles_mesh(obj)

            # 対象のオブジェクトが既に最低ポリゴン数を下回っていないかチェックする
            if obj_trianglecount < arg_mintrianglecount:
                # 下回っていれば対象のオブジェクトに設定する削減比率は 1 になる
                obj_ratio = 1.0
            # 削減後に指定の最低ポリゴン数を下回らないかチェックする
            elif (obj_trianglecount * target_ratio) < arg_mintrianglecount:
                # 下回るようであれば最低ポリゴン数までの削減比率を再計算する
                obj_ratio = arg_mintrianglecount / obj_trianglecount
            # 削減後にも最低ポリゴン数を下回らないオブジェクトの場合
            else:
                # 削減の余地があることをチェックする
                continue_flg = True
            
            # 削減後のポリゴン数を計算する
            after_trianglecount = obj_trianglecount * obj_ratio
            # 予想ポリゴン数に加算する(切り捨てで計算)
            forecast_trianglecount += math.floor(after_trianglecount)

        # ループの継続フラグをチェックする
        if continue_flg == False:
            # 継続しても改善が見込めない場合はループを終了する
            break

        # 予想ポリゴン数が指定のポリゴン数を上回っているなら削減比率を再調整する
        if forecast_trianglecount > arg_targettrianglecount:
            # 超過分の削減比率を計算する
            over_ratio = arg_targettrianglecount / forecast_trianglecount
            # 削減比率に乗算する
            target_ratio *= over_ratio

    # シーン内の全オブジェクトデータを取得する
    for obj in bpy.context.scene.objects:
        # オブジェクトに反映する削減比率
        obj_ratio = target_ratio
        # オブジェクトのポリゴン数を取得する
        obj_trianglecount = count_triangles_mesh(obj)
        # 対象のオブジェクトが既に最低ポリゴン数を下回っていないかチェックする
        if obj_trianglecount < arg_mintrianglecount:
            # 下回っていれば対象のオブジェクトは処理しない
            continue
        # 削減後に指定の最低ポリゴン数を下回らないかチェックする
        if (obj_trianglecount * target_ratio) < arg_mintrianglecount:
            # 下回るようであれば最低ポリゴン数までの削減比率を再計算する
            obj_ratio = arg_mintrianglecount / obj_trianglecount
        # オブジェクトを指定の比率でポリゴン削減する
        apply_decimate_mesh(arg_targetobject=obj, arg_decimateratio=obj_ratio)

    return True

# 対象オブジェクトを指定の比率でポリゴン削減する
# モディファイア追加の種類とマニュアル
# (https://docs.blender.org/api/current/bpy.ops.object.html#bpy.ops.object.gpencil_modifier_add)
def apply_decimate_mesh(arg_targetobject:bpy.types.Object, arg_decimateratio:float=1.0) -> bool:
    """対象オブジェクトを指定の比率でポリゴン削減する

    Keyword Arguments:
        arg_targetobject {bpy.types.Object} -- 対象オブジェクト
        arg_decimateratio {float} -- 削減比率 (default: {1.0})

    Returns:
        Bool -- 実行正否
    """

    # 指定オブジェクトがメッシュか確認する
    if arg_targetobject.type != 'MESH':
        # 指定オブジェクトが存在しない場合は処理しない
        return False
    # 変更オブジェクトをアクティブに変更する
    bpy.context.view_layer.objects.active = arg_targetobject
    # 「ポリゴン数削減」モディファイアを追加する
    # ポリゴン数削減モディファイアのインタフェース
    # (https://docs.blender.org/api/current/bpy.types.DecimateModifier.html)
    bpy.ops.object.modifier_add(type='DECIMATE')
    # 追加されたモディファイアを取得する
    decimate_modifier = arg_targetobject.modifiers[-1]
    # 削減の比率を設定する
    decimate_modifier.ratio = arg_decimateratio
    # 「ポリゴン数削減」モディファイアを適用する
    bpy.ops.object.modifier_apply(modifier=decimate_modifier.name)
    return True

# 指定メッシュの三角面数を取得する
def count_alltriangles_mesh() -> int:
    """全メッシュの総三角面数を取得する
    
    Keyword Arguments:

    Returns:
        int -- 三角面数(取得失敗時:0)
    """

    # 総三角面数のカウンタ
    triangles_count = 0
    # 全メッシュデータを取得する
    for obj in bpy.data.objects:
        # 三角面数を加算する
        triangles_count += count_triangles_mesh(obj)
    return triangles_count

# 指定メッシュの三角面数を取得する
def count_triangles_mesh(arg_object:bpy.types.Object) -> int:
    """指定メッシュの三角面数を取得する
    
    Keyword Arguments:
        arg_objectname {bpy.types.Object} -- 対象オブジェクト

    Returns:
        int -- 三角面数(取得失敗時:0)
    """

    # 指定オブジェクトがメッシュか確認する
    if arg_object.type != 'MESH':
        # 指定オブジェクトが存在しない場合は処理しない
        return 0
    # Meshデータを取得する
    # メッシュアクセスのマニュアル
    # (https://docs.blender.org/api/current/bpy.types.Mesh.html)
    msh = arg_object.data
    # 三角面を計算する(結果はloop_trianglesに保存される)
    msh.calc_loop_triangles()
    # 三角面数を取得する
    triangles_count = len(msh.loop_triangles)
    return triangles_count

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

f:id:bluebirdofoz:20211009220653j:plain