本日は Blender の技術調査枠です。
Blender2.8で利用可能なpythonスクリプトを作ります。
ファイル出力の指定
[MATERIAL COLOR BAKE]のボタンをクリックすると、ファイルダイアログが開きます。
指定のblendファイル名で出力先を指定すると、変換処理後のプロジェクトを自動で出力します。
更に指定先のディレクトリに、作成した画像をPNG形式で出力します。
アドオンは以下の変換処理を行います。
1.指定オブジェクトの全てのマテリアルカラーを1つの画像テクスチャにベイクします。
2.対象オブジェクトのマテリアルを全て削除します。
3.ベイクした画像テクスチャを設定したプリンシプルBSDFのマテリアルを設定します。
・Addon_convert_materialcolor_texture.py
# bl_infoでプラグインに関する情報の定義を行う bl_info = { "name": "HoloMon Material Color Bake Addon", # プラグイン名 "author": "HoloMon", # 制作者名 "version": (1, 0), # バージョン "blender": (2, 80, 0), # 動作可能なBlenderバージョン "support": "TESTING", # サポートレベル "category": "3D View", # カテゴリ名 "location": "View3D > Sidebar > HoloMon", # ロケーション "description": "Addon Material Color Bake", # 説明文 "location": "", # 機能の位置付け "warning": "", # 注意点やバグ情報 "doc_url": "", # ドキュメントURL } # 利用するタイプやメソッドのインポート import bpy from bpy.types import Operator, Panel, PropertyGroup from bpy.props import PointerProperty, IntProperty, 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_material_color_bake(Panel): # パネルのラベル名を定義する # パネルを折りたたむパネルヘッダーに表示される bl_label = "Material Color Bake" # クラスのIDを定義する # 命名規則は CATEGORY_PT_name bl_idname = "HOLOMON_PT_addon_material_color_bake" # パネルを使用する領域を定義する # 利用可能な識別子は以下の通り # 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_material_color_bake, "prop_objectslect", text='') # 要素行を作成する length_row = draw_layout.row() # テクスチャ名指定用のカスタムプロパティを配置する length_row.prop(context.scene.holomon_material_color_bake, "prop_texturename") # 要素行を作成する length_row = draw_layout.row() # テクスチャサイズ指定用のカスタムプロパティを配置する length_row.prop(context.scene.holomon_material_color_bake, "prop_texturesize") # 要素行を作成する length_row = draw_layout.row() # ベイク余白指定用のカスタムプロパティを配置する length_row.prop(context.scene.holomon_material_color_bake, "prop_bakemargin") # 要素行を作成する button_row = draw_layout.row() # マテリアルベイクを実行するボタンを配置する button_row.operator("holomon.material_color_bake") # Operatorクラスの作成 # 参考URL:https://docs.blender.org/api/current/bpy.types.Operator.html class HOLOMON_OT_addon_material_color_bake(Operator): # クラスのIDを定義する # (Blender内部で参照する際のIDに利用) bl_idname = "holomon.material_color_bake" # クラスのラベルを定義する # (デフォルトのテキスト表示などに利用) bl_label = "MATERIAL COLOR BAKE" # クラスの説明文 # (マウスオーバー時に表示) dl_description = "Material Color Bake 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'} # ファイル指定のプロパティを定義する # filepath, filename, directory の名称のプロパティを用意しておくと # window_manager.fileselect_add 関数から情報が代入される filepath: StringProperty( name="File Path", # プロパティ名 default="", # デフォルト値 maxlen=1024, # 最大文字列長 subtype='FILE_PATH', # サブタイプ description="", # 説明文 ) filename: StringProperty( name="File Name", # プロパティ名 default="", # デフォルト値 maxlen=1024, # 最大文字列長 description="", # 説明文 ) directory: StringProperty( name="Directory Path", # プロパティ名 default="", # デフォルト値 maxlen=1024, # 最大文字列長 subtype='FILE_PATH', # サブタイプ description="", # 説明文 ) # 読み込みの拡張子を指定する # filter_glob を指定しておくと window_manager.fileselect_add が拡張子をフィルタする filter_glob: StringProperty( default="*.blend", # デフォルト値 options={'HIDDEN'}, # オプション設定 ) # 実行時イベント def invoke(self, context, event): # ファイルエクスプローラーを表示する # 参考URL:https://docs.blender.org/api/current/bpy.types.WindowManager.html#bpy.types.WindowManager.fileselect_add context.window_manager.fileselect_add(self) return {'RUNNING_MODAL'} # Operator実行時の処理 def execute(self, context): # カスタムプロパティから指定中のオブジェクトを取得する target_object = context.scene.holomon_material_color_bake.prop_objectslect # 指定中のオブジェクトを確認する if target_object == None: # オブジェクトが指定されていない場合はエラーメッセージを表示する self.report({'ERROR'}, "Nothing : target object.") return {'CANCELLED'} # カスタムプロパティから指定中のテクスチャ名を取得する texture_name = context.scene.holomon_material_color_bake.prop_texturename # 指定中のテクスチャ名を確認する if texture_name == None: # テクスチャ名が指定されていない場合はエラーメッセージを表示する self.report({'ERROR'}, "Nothing : texture name.") return {'CANCELLED'} # カスタムプロパティから指定中のテクスチャサイズを取得する texture_size = context.scene.holomon_material_color_bake.prop_texturesize # 指定中のテクスチャサイズを確認する if texture_size < 1: # 適切なテクスチャサイズが指定されていない場合はエラーメッセージを表示する self.report({'ERROR'}, "Nothing : texture size.") return {'CANCELLED'} # カスタムプロパティから指定中のベイク余白を取得する bake_margin = context.scene.holomon_material_color_bake.prop_bakemargin # 指定中のテクスチャサイズを確認する if bake_margin < 0: # 適切なテクスチャサイズが指定されていない場合はエラーメッセージを表示する self.report({'ERROR'}, "Nothing : bake margin.") return {'CANCELLED'} # 指定オブジェクトの全てのマテリアルカラーを画像テクスチャにベイクする bake_image = bake_materialcolor_texture( arg_object=target_object, arg_texturename=texture_name, arg_texturesize=texture_size, arg_bakemargin=bake_margin ) # 指定オブジェクトのマテリアルを作成テクスチャのシンプルなプリンシプルBSDFマテリアルのみとする replace_material_textureBSDF(arg_object=target_object, arg_texture=bake_image) # 指定ディレクトリに作成した画像ファイルを出力する save_image_targetdir(arg_image=bake_image, arg_directory=self.directory) # 画像の参照と統一マテリアルを生成したプロジェクトを別名ファイルとして保存する bpy.ops.wm.save_as_mainfile(filepath=self.filepath) return {'FINISHED'} # PropertyGroupクラスの作成 # 参考URL:https://docs.blender.org/api/current/bpy.types.PropertyGroup.html class HOLOMON_addon_material_color_bake_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_texturename: StringProperty( name="Texture Name", # プロパティ名 default="BakeTexture", # デフォルト値 maxlen=1024, # 最大文字列長 description="", # 説明文 ) # シーン上のパネルに表示するテクスチャサイズ指定用のカスタムプロパティを定義する prop_texturesize: IntProperty( name = "Texture Size", # プロパティ名 default=2048, # デフォルト値 description = "", # 説明文 ) # シーン上のパネルに表示するベイク余白用のカスタムプロパティを定義する prop_bakemargin: IntProperty( name = "Bake Margin", # プロパティ名 default=16, # デフォルト値 description = "", # 説明文 ) # 登録に関する処理 # 登録対象のクラス名 regist_classes = ( HOLOMON_PT_addon_material_color_bake, HOLOMON_OT_addon_material_color_bake, HOLOMON_addon_material_color_bake_properties, ) # 作成クラスと定義の登録メソッド def register(): # カスタムクラスを登録する for regist_cls in regist_classes: bpy.utils.register_class(regist_cls) # シーン情報にカスタムプロパティを登録する bpy.types.Scene.holomon_material_color_bake = PointerProperty(type=HOLOMON_addon_material_color_bake_properties) # 作成クラスと定義の登録解除メソッド def unregister(): # シーン情報のカスタムプロパティを削除する del bpy.types.Scene.holomon_material_color_bake # カスタムクラスを解除する for regist_cls in regist_classes: bpy.utils.unregister_class(regist_cls) # 指定オブジェクトの全てのマテリアルカラーを画像テクスチャにベイクする def bake_materialcolor_texture(arg_object:bpy.types.Object, arg_texturename:str="BakeTexture", arg_texturesize:int=2048, arg_bakemargin:int=0) -> bpy.types.Image: """指定オブジェクトの全てのマテリアルカラーを画像テクスチャにベイクする Args: arg_object (bpy.types.Object): 指定オブジェクト arg_texturename (str, optional): 作成テクスチャ名. Defaults to "BakeTexture". arg_texturesize (int, optional): 作成テクスチャサイズ(px). Defaults to 2048. arg_bakemargin (int, optional): ベイク余白(px). Defaults to 0. Returns: bpy.types.Image: 作成テクスチャの参照 """ # 参照の保存用変数 name_mapping = {} # 追加する画像ノード名を定義する texturenode_name = "ForBakeTextureNode" # 新規テクスチャを作成して参照を取得する bake_image = make_new_image( arg_texturename=arg_texturename, arg_texturesize=arg_texturesize ) # 指定オブジェクトのマテリアルリストを取得する for material_slot in arg_object.material_slots: # スロットのマテリアルを取得する target_material = material_slot.material # マテリアルが割り当てられているか if target_material == None: continue # 参照マテリアルをノード使用に変更する use_material_node(target_material) # 新規テクスチャを参照する画像ノードを追加する add_node = add_node_image( arg_material=target_material, arg_image=bake_image ) # 作成ノードの参照を保存する name_mapping[texturenode_name + target_material.name] = add_node # 指定の画像ノードを選択状態に設定する select_node_target( arg_material=target_material, arg_node=name_mapping[texturenode_name + target_material.name] ) # 指定オブジェクトの「カラー」をベイクする bake_diffuse_coloronly( arg_object=arg_object, arg_bakemargin=arg_bakemargin, arg_GPUuse=True ) # 指定オブジェクトのマテリアルリストを取得する for material_slot in arg_object.material_slots: # スロットのマテリアルを取得する target_material = material_slot.material # マテリアルが割り当てられているか if target_material == None: continue # 追加した画像ノードを削除する delete_node_target( arg_material=target_material, arg_node=name_mapping[texturenode_name + target_material.name] ) return bake_image # 新規画像を作成する def make_new_image(arg_texturename:str="BakeTexture", arg_texturesize:int=2048) -> bpy.types.Image: """新規画像を作成する Args: arg_texturename (str, optional): 作成テクスチャ名. Defaults to "BakeTexture". arg_texturesize (int, optional): 作成テクスチャサイズ. Defaults to 2048. Returns: bpy.types.Image: 作成画像の参照 """ # 新規画像を作成する newimage = bpy.data.images.new( name=arg_texturename, width=arg_texturesize, height=arg_texturesize, alpha=True ) return newimage # 対象マテリアルのノードを有効化する def use_material_node(arg_material:bpy.types.Material): """対象マテリアルのノードを有効化する Args: arg_material (bpy.types.Material): 対象マテリアル """ # マテリアル操作のマニュアル # (https://docs.blender.org/api/current/bpy.types.Material.html) # ノードが無効な場合、有効化する if arg_material.use_nodes == False: arg_material.use_nodes = True return # 対象マテリアルに指定テクスチャを参照する画像ノードを追加する def add_node_image(arg_material:bpy.types.Material, arg_image:bpy.types.Image) -> bpy.types.Node: """対象マテリアルに指定テクスチャを参照する画像ノードを追加する Args: arg_material (bpy.types.Material): 対象マテリアル arg_image (bpy.types.Image): 指定テクスチャ Returns: bpy.types.Node: 作成ノードの参照 """ # ノード操作のマニュアル # (https://docs.blender.org/api/current/bpy.types.Node.html) # ターゲットマテリアルのノード参照を取得 mat_nodes = arg_material.node_tree.nodes # テクスチャノードの追加 texture_node = mat_nodes.new(type="ShaderNodeTexImage") # テクスチャノードに指定画像を設定する texture_node.image = arg_image return texture_node # 対象マテリアルの指定ノードのみを選択状態する def select_node_target(arg_material:bpy.types.Material, arg_node:bpy.types.Node): """対象マテリアルの指定ノードのみを選択状態する Args: arg_material (bpy.types.Material): 対象マテリアル arg_node (bpy.types.Node): 指定ノード """ # ノード操作のマニュアル # (https://docs.blender.org/api/current/bpy.types.Node.html) # ノードリスト操作のマニュアル # (https://docs.blender.org/api/current/bpy.types.Nodes.html) # ターゲットマテリアルのノード参照を取得 mat_nodes = arg_material.node_tree.nodes # 全てのノードの選択状態を解除する for mat_node in mat_nodes: # 選択状態を解除する mat_node.select = False # 指定ノードを選択状態にする arg_node.select = True # 指定ノードをアクティブにする mat_nodes.active = arg_node return # 指定オブジェクトのカラー情報のみをベイクする def bake_diffuse_coloronly(arg_object:bpy.types.Object, arg_bakemargin:int=0, arg_GPUuse:bool=False): """指定オブジェクトのカラー情報のみをベイクする Args: arg_object (bpy.types.Object): 指定オブジェクト arg_bakemargin (int, optional): ベイク余白. Defaults to 0. arg_GPUuse (bool, optional): GPU利用指定. Defaults to False. """ # 全てのオブジェクトを非選択状態にする for obj in bpy.context.scene.objects: # 選択状態を解除する obj.select_set(False) # 指定オブジェクトを選択状態にする arg_object.select_set(True) # 指定オブジェクトをアクティブにする bpy.context.view_layer.objects.active = arg_object # レンダリングエンジンを CYCLES に切り替える bpy.context.scene.render.engine = 'CYCLES' # GPUの利用有無を確認する if arg_GPUuse == True: # 利用設定ならGPUの設定を行う bpy.data.scenes["Scene"].cycles.device = 'GPU' # CUDAを選択する bpy.context.preferences.addons['cycles'].preferences.compute_device_type = 'CUDA' # デバイスの一覧を取得する for devices in bpy.context.preferences.addons['cycles'].preferences.get_devices(): for device in devices: # デバイスタイプがCUDAならば利用対象とする if device.type == 'CUDA': print("利用可能なGPUを検出しました:" + device.name) device.use = True # render.bake の設定項目を予め設定する bake_setting = bpy.context.scene.render.bake # ベイクの影響から直接照明を無効化する bake_setting.use_pass_direct = False # ベイクの影響から間接照明を無効化する bake_setting.use_pass_indirect = False # ベイクの影響からカラーを有効化する bake_setting.use_pass_color = True # ディフューズタイプのベイクを実行する # ベイクの種類 # ('COMBINED', 'AO', 'SHADOW', 'NORMAL', 'UV', 'ROUGHNESS', # 'EMIT', 'ENVIRONMENT', 'DIFFUSE', 'GLOSSY', 'TRANSMISSION') # (render.bake 以外の設定は引数で指定する必要あり) bpy.ops.object.bake(type='DIFFUSE', margin=arg_bakemargin) return # 対象マテリアルの指定ノードを削除する def delete_node_target(arg_material:bpy.types.Material, arg_node:bpy.types.Node): """対象マテリアルの指定ノードを削除する Args: arg_material (bpy.types.Material): 対象マテリアル arg_node (bpy.types.Node): 指定ノード """ # ノード操作のマニュアル # (https://docs.blender.org/api/current/bpy.types.Node.html) # ターゲットマテリアルのノード参照を取得 mat_nodes = arg_material.node_tree.nodes # ノードを削除する mat_nodes.remove(arg_node) return # 指定オブジェクトのマテリアルを指定テクスチャのシンプルなプリンシプルBSDFマテリアルのみとする def replace_material_textureBSDF(arg_object:bpy.types.Object, arg_texture:bpy.types.Image) -> bool: """[summary] Args: arg_object (bpy.types.Object): [description] arg_texture (bpy.types.Image): [description] Returns: bool: [description] """ # 指定オブジェクトの全マテリアルを削除する is_alldel = delete_material_all(arg_object=arg_object) # 実行正否を確認する if is_alldel == False: # 削除に失敗した場合は処理しない return False # 指定テクスチャを参照するシンプルなBSDFマテリアルを作成する texture_mat = add_material_textureBSDF(arg_object=arg_object, arg_texture=arg_texture) # マテリアルを作成できたか確認する if texture_mat == None: # 作成に失敗した場合は実行失敗を返す return False return True # 指定オブジェクトのマテリアルを全て削除する def delete_material_all(arg_object:bpy.types.Object) -> bool: """指定オブジェクトのマテリアルを全て削除する Args: arg_object (bpy.types.Object): 指定オブジェクト arg_materialname (str, optional): 作成マテリアル名. Defaults to "DefaultMaterial". Returns: bool: 実行正否 """ # 指定オブジェクトがメッシュオブジェクトか確認する if arg_object.type != 'MESH': # メッシュオブジェクトでない場合は処理しない return False # 対象オブジェクトのメッシュデータを取得する # メッシュデータ操作のマニュアル # (https://docs.blender.org/api/current/bpy.types.Mesh.html) meshdata = arg_object.data # メッシュのマテリアルを全て削除する while len(meshdata.materials) > 0: # IDMaterial操作のマニュアル # (https://docs.blender.org/api/current/bpy.types.IDMaterials.html) meshdata.materials.pop(index=-1) return True # 指定オブジェクトに指定テクスチャのシンプルなプリンシプルBSDFマテリアルを作成する def add_material_textureBSDF(arg_object:bpy.types.Object, arg_texture:bpy.types.Image) -> bpy.types.Material: """指定オブジェクトに指定テクスチャのシンプルなプリンシプルBSDFマテリアルを作成する Args: arg_object (bpy.types.Object): 指定オブジェクト arg_texture (bpy.types.Image): 指定テクスチャ Returns: bpy.types.Material: 作成マテリアルの参照 """ # 新規マテリアルを作成する new_material = bpy.data.materials.new("TextureMaterial") # メッシュデータの参照を取得する meshdata = arg_object.data # メッシュのマテリアルを追加する meshdata.materials.append(new_material) # 追加したマテリアルスロットを取得する add_matslot = arg_object.material_slots[-1] # ノードを使用する new_material.use_nodes = True # 新規マテリアルのノード参照を取得する mat_nodes = new_material.node_tree.nodes # マテリアル内の全ノードを走査する for delete_node in mat_nodes: # 一旦全てのノードを削除する mat_nodes.remove(delete_node) # テクスチャノードの追加 texture_node = mat_nodes.new(type='ShaderNodeTexImage') # テクスチャノードに新規画像を設定する texture_node.image = arg_texture # プリンシプルBSDFノードを追加する bsdf_node = mat_nodes.new(type='ShaderNodeBsdfPrincipled') # 出力ノードを追加する output_node = mat_nodes.new(type='ShaderNodeOutputMaterial') # ターゲットマテリアルのノードリンク参照を取得する mat_link = new_material.node_tree.links # テクスチャノードのカラーとプリンシプルBSDFノードのベースカラーを接続する mat_link.new(texture_node.outputs[0], bsdf_node.inputs[0]) # プリンシプルBSDFのシェーダ出力と出力ノードのサーフェスを接続する mat_link.new(bsdf_node.outputs[0], output_node.inputs[0]) return new_material # 指定ディレクトリにテクスチャをPNG形式で保存する def save_image_targetdir(arg_image:bpy.types.Image, arg_directory:str) -> bool: """指定ディレクトリにテクスチャをPNG形式で保存する Args: arg_image (bpy.types.Image): 保存テクスチャ arg_directory (str): 指定ディレクトリ Returns: bool: 実行正否 """ # 保存ファイルパスを作成する savepath = arg_directory + "\\" + arg_image.name + ".png" # 保存ファイルパスを指定する arg_image.filepath_raw = savepath # ファイルフォーマットをPNGに設定する arg_image.file_format = 'PNG' # 画像を保存する arg_image.save() return True # 実行時の処理 if __name__ == "__main__": # 作成クラスと定義を登録する register()
