本日は Blender の技術調査枠です。
Blender2.8で利用可能なpythonスクリプトを作ります。
プロパティの更新イベントとUI切り替え
アドオンで追加したプロパティの更新イベントと、再描画によるUIの有効無効の切り替えを行います。
このアドオンでは[Detail Settings]のチェックを入れた場合、画像フォーマットの詳細設定項目が有効化されます。
また[Detail Settings]のチェックが外れた場合は、更新イベントが走り、詳細設定項目が全てデフォルト値に戻ります。
・__init__.py
# 各種ライブラリインポート if "bpy" in locals(): import importlib if "save_project" in locals(): importlib.reload(save_image) import bpy from . import save_image # bl_infoでプラグインに関する情報の定義を行う bl_info = { "name": "HoloMon Save Image Addon", # プラグイン名 "author": "HoloMon", # 制作者名 "version": (1, 0), # バージョン "blender": (2, 80, 0), # 動作可能なBlenderバージョン "support": "TESTING", # サポートレベル "category": "3D View", # カテゴリ名 "location": "View3D > Sidebar > HoloMon", # ロケーション "description": "Addon Save Image", # 説明文 "location": "", # 機能の位置付け "warning": "", # 注意点やバグ情報 "doc_url": "", # ドキュメントURL } # 利用するタイプやメソッドのインポート import bpy from bpy.types import Operator, Panel, PropertyGroup from bpy.props import PointerProperty, BoolProperty, EnumProperty, 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_save_image(Panel): # パネルのラベル名を定義する # パネルを折りたたむパネルヘッダーに表示される bl_label = "Save Image" # クラスのIDを定義する # 命名規則は CATEGORY_PT_name bl_idname = "HOLOMON_PT_addon_save_image" # パネルを使用する領域を定義する # 利用可能な識別子は以下の通り # 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 # 要素行を作成する imageselect_row = draw_layout.row() # イメージ選択用のカスタムプロパティを配置する imageselect_row.prop(context.scene.holomon_save_image, "prop_imageslect", text='') # 要素行を作成する detailswitch_row = draw_layout.row() # 詳細設定切り替え用のカスタムプロパティを配置する detailswitch_row.prop(context.scene.holomon_save_image, "prop_detailswitch") # ボックス要素を作成する draw_box = draw_layout.box() # ボックス内に要素列を作成する box_col = draw_box.column() # Enum用に要素行を作成する(EnumPropertyを並べるにはrowとexpandを設定する) colormode_row = box_col.row(align=True) # カラーモード用カスタムプロパティを配置する colormode_row.prop(context.scene.holomon_save_image, "prop_colormode", expand=True) # Enum用に要素行を作成する(EnumPropertyを並べるにはrowとexpandを設定する) colordepth_row = box_col.row(align=True) # カラーデプス用カスタムプロパティを配置する colordepth_row.prop(context.scene.holomon_save_image, "prop_colordepth", expand=True) # 圧縮率用カスタムプロパティを配置する box_col.prop(context.scene.holomon_save_image, "prop_compression") # 詳細設定切り替え用のカスタムプロパティの有効無効を確認する if context.scene.holomon_save_image.prop_detailswitch == False: # 詳細設定が無効の場合は各詳細設定の項目を無効化する draw_box.enabled = False # 要素行を作成する button_row = draw_layout.row() # 画像保存を実行するボタンを配置する button_row.operator("holomon.save_image") # Operatorクラスの作成 # 参考URL:https://docs.blender.org/api/current/bpy.types.Operator.html class HOLOMON_OT_addon_save_image(Operator): # クラスのIDを定義する # (Blender内部で参照する際のIDに利用) bl_idname = "holomon.save_image" # クラスのラベルを定義する # (デフォルトのテキスト表示などに利用) bl_label = "SAVE IMAGE IN DIR" # クラスの説明文 # (マウスオーバー時に表示) dl_description = "Save Image 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 関数から情報が代入される # このうち、direcotry のみを指定しておくことでファイル指定はさせず、ディレクトリの指定となる directory: StringProperty( name="Directory Path", # プロパティ名 default="", # デフォルト値 maxlen=1024, # 最大文字列長 subtype='FILE_PATH', # サブタイプ description="", # 説明文 ) # filter_folderの定義を設定しておくことで一覧にディレクトリのみを表示する filter_folder: BoolProperty( default=True, # デフォルト値 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_image = context.scene.holomon_save_image.prop_imageslect # 指定中のオブジェクトを確認する if target_image == None: # オブジェクトが指定されていない場合はエラーメッセージを表示する self.report({'ERROR'}, "Nothing : target image.") return {'CANCELLED'} # カスタムプロパティから詳細設定切り替え状態を取得する target_detailswitch = context.scene.holomon_save_image.prop_detailswitch # カスタムプロパティからカラーモードを取得する target_colormode = context.scene.holomon_save_image.prop_colormode # カスタムプロパティからカラーデプスを取得する target_colordepth = context.scene.holomon_save_image.prop_colordepth # カスタムプロパティから圧縮率を取得する target_compression = context.scene.holomon_save_image.prop_compression # 詳細設定切り替え用のカスタムプロパティの有効無効を確認する if context.scene.holomon_save_image.prop_detailswitch == False: # 詳細設定が無効の場合は各詳細設定の項目を利用しない # 指定ディレクトリに画像ファイルを出力する save_image.save_image_targetdir( arg_image=target_image, arg_directory=self.directory ) else: # 詳細設定が無効の場合は各詳細設定の項目を利用する # 指定ディレクトリに画像ファイルを出力する save_image.save_image_targetdir( arg_image=target_image, arg_directory=self.directory, arg_colormode=target_colormode, arg_colordepth=target_colordepth, arg_compression=target_compression ) return {'FINISHED'} # PropertyGroupクラスの作成 # 参考URL:https://docs.blender.org/api/current/bpy.types.PropertyGroup.html class HOLOMON_addon_save_image_properties(PropertyGroup): # プロパティ設定のマニュアル # (https://docs.blender.org/api/current/bpy.props.html) # 詳細設定切り替えの更新時に実行する関数を定義する def change_detailswitch(self, context): # 詳細設定切り替え用のカスタムプロパティの有効無効を確認する if context.scene.holomon_save_image.prop_detailswitch == False: # 無効に切り替えた場合は各設定をデフォルト設定に戻す context.scene.holomon_save_image.prop_colormode = 'RGBA' context.scene.holomon_save_image.prop_colordepth = '8' context.scene.holomon_save_image.prop_compression = 15 # シーン上のパネルに表示するイメージ選択用のカスタムプロパティを定義する prop_imageslect: PointerProperty( name = "Select Image", # プロパティ名 type = bpy.types.Image, # タイプ description = "", # 説明文 ) # シーン上のパネルに表示する詳細設定切り替え用のカスタムプロパティを定義する prop_detailswitch: BoolProperty( name = "Detail Settings", # プロパティ名 default=False, # デフォルト値 description = "", # 説明文 update=change_detailswitch, # 更新時実行関数 ) # シーン上のパネルに表示するカラーモード用のカスタムプロパティを定義する prop_colormode: EnumProperty( name = "Color Mode", # プロパティ名 default='RGBA', # デフォルト値 items= [ ('BW',"BW",""), ('RGB',"RGB",""), ('RGBA',"RGBA",""), ], # 選択肢(ID,名前,説明) description = "", # 説明文 ) # シーン上のパネルに表示するカラーデプス用のカスタムプロパティを定義する prop_colordepth: EnumProperty( name = "Color Depth", # プロパティ名 default='8', # デフォルト値 items= [ ('8',"8",""), ('16',"16",""), ], # 選択肢(ID,名前,説明) description = "", # 説明文 ) # シーン上のパネルに表示する圧縮率用のカスタムプロパティを定義する prop_compression: IntProperty( name = "Image Compression", # プロパティ名 default=15, # デフォルト値 description = "", # 説明文 ) # 登録に関する処理 # 登録対象のクラス名 regist_classes = ( HOLOMON_PT_addon_save_image, HOLOMON_OT_addon_save_image, HOLOMON_addon_save_image_properties, ) # 作成クラスと定義の登録メソッド def register(): # カスタムクラスを登録する for regist_cls in regist_classes: bpy.utils.register_class(regist_cls) # シーン情報にカスタムプロパティを登録する bpy.types.Scene.holomon_save_image = PointerProperty(type=HOLOMON_addon_save_image_properties) # 作成クラスと定義の登録解除メソッド def unregister(): # シーン情報のカスタムプロパティを削除する del bpy.types.Scene.holomon_save_image # カスタムクラスを解除する for regist_cls in regist_classes: bpy.utils.unregister_class(regist_cls) # 実行時の処理 if __name__ == "__main__": # 作成クラスと定義を登録する register()
・Addon_bake_ambientocclusion_texture.py
# bpyインポート import bpy # 指定ディレクトリにテクスチャをPNG形式で保存する def save_image_targetdir(arg_image:bpy.types.Image, arg_directory:str, arg_colormode:str='RGBA', arg_colordepth:str='8', arg_compression:int=15) -> bool: """指定ディレクトリにテクスチャをPNG形式で保存する Args: arg_image (bpy.types.Image): 保存テクスチャ arg_directory (str): 指定ディレクトリ Returns: bool: 実行正否 """ # イメージの操作マニュアル # (https://docs.blender.org/api/current/bpy.types.Image.html) # イメージフォーマット設定の操作マニュアル # (https://docs.blender.org/api/current/bpy.types.ImageFormatSettings.html) # 保存ファイルパスを作成する savepath = arg_directory + "\\" + arg_image.name + ".png" # 保存ファイルパスを指定する arg_image.filepath_raw = savepath # ファイルフォーマットをPNGに設定する arg_image.file_format = 'PNG' # シーンのレンダリング設定からイメージフォーマット設定の参照を取得する scene_imagesettings = bpy.context.scene.render.image_settings # カラーフォーマットを設定する scene_imagesettings.color_mode = arg_colormode # 色深度を設定する scene_imagesettings.color_depth = arg_colordepth # 圧縮率を設定する scene_imagesettings.compression = arg_compression # シーンのレンダリング設定を利用して画像を保存する arg_image.save_render(filepath=savepath) return True
