本日は Blender の技術調査枠です。
Blender2.8で利用可能なpythonスクリプトを作ります。
外部ファイル指定のアドオンスクリプト
アドオンとして登録可能なサンプルスクリプトです。
追加されたパネルには外部ファイル指定の欄が表示されます。
.glb ファイルを指定して実行すると、3Dデータが読み込まれます。
・addon_fileload_sample.py
# bl_infoでプラグインに関する情報の定義を行う bl_info = { "name": "HoloMon GLB Load Addon", # プラグイン名 "author": "HoloMon", # 制作者名 "version": (1, 0), # バージョン "blender": (2, 80, 0), # 動作可能なBlenderバージョン "support": "TESTING", # サポートレベル "category": "3D View", # カテゴリ名 "location": "View3D > Sidebar > HoloMon", # ロケーション "description": "Addon GLB Load", # 説明文 "location": "", # 機能の位置付け "warning": "", # 注意点やバグ情報 "doc_url": "", # ドキュメントURL } # 利用するタイプやメソッドのインポート import bpy, os from bpy.types import Operator, Panel, PropertyGroup from bpy.props import StringProperty, 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_glb_load(Panel): # パネルのラベル名を定義する # パネルを折りたたむパネルヘッダーに表示される bl_label = "GLB Load Addon Panel" # クラスのIDを定義する # 命名規則は CATEGORY_PT_name bl_idname = "HOLOMON_PT_addon_glb_load" # パネルを使用する領域を定義する # 利用可能な識別子は以下の通り # 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 # 要素行を作成して横並び(align=True)に要素を配置する filepath_row = draw_layout.row(align=True) # 読み込んだファイルパスを表示する領域を作成する filepath_showtext = filepath_row.column() # シーン情報のカスタムプロパティの値を参照する filepath_showtext.prop(context.scene.holomon_glbload, "prop_filepath", text='') # 操作を無効化しておく filepath_showtext.enabled = False # オペレーションを実行するボタンをファイルブラウザアイコンで配置する filepath_row.operator("holomon.glbload", icon='FILEBROWSER', text='', ) # Operatorクラスの作成 # 参考URL:https://docs.blender.org/api/current/bpy.types.Operator.html class HOLOMON_OT_addon_glb_load(Operator): # クラスのIDを定義する # (Blender内部で参照する際のIDに利用) bl_idname = "holomon.glbload" # クラスのラベルを定義する # (デフォルトのテキスト表示などに利用) bl_label = "GLB LOAD" # クラスの説明文 # (マウスオーバー時に表示) dl_description = "GLB Load 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="*.glb", # デフォルト値 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): # ファイルパスをフォルダパスとファイル名に分割する filepath_folder, filepath_name = os.path.split(self.filepath) # ファイルパスをフォルダ名の名称とファイル名の拡張子に分割する filepath_nameonly, filepath_ext = os.path.splitext(filepath_name) # 拡張子が .glb か否か if(filepath_ext != '.glb'): # 拡張子が .glb でない場合はエラーメッセージを表示する self.report({'ERROR'}, "'{}' is not GLB file.".format(self.filepath)) return {'CANCELLED'} # GLBファイル読み込みを実行する addon_load_glb_target(arg_filepath=self.filepath) # カスタムプロパティにファイルパスを設定する context.scene.holomon_glbload.prop_filepath = self.filepath return {'FINISHED'} # PropertyGroupクラスの作成 # 参考URL:https://docs.blender.org/api/current/bpy.types.PropertyGroup.html class HOLOMON_addon_glb_load_properties(PropertyGroup): # シーン上のパネルに表示するファイルパスのプロパティを定義する prop_filepath: StringProperty( name = "Scene Panel Filepath", # プロパティ名 default = "", # デフォルト値 ) # 登録に関する処理 # 登録対象のクラス名 regist_classes = ( HOLOMON_PT_addon_glb_load, HOLOMON_OT_addon_glb_load, HOLOMON_addon_glb_load_properties, ) # 作成クラスと定義の登録メソッド def register(): # カスタムクラスを登録する for regist_cls in regist_classes: bpy.utils.register_class(regist_cls) # シーン情報にカスタムプロパティを登録する bpy.types.Scene.holomon_glbload = PointerProperty(type=HOLOMON_addon_glb_load_properties) # 作成クラスと定義の登録解除メソッド def unregister(): # シーン情報のカスタムプロパティを削除する del bpy.types.Scene.holomon_glbload # カスタムクラスを解除する for regist_cls in regist_classes: bpy.utils.unregister_class(regist_cls) # GLBファイル読み込みを実行する def addon_load_glb_target(arg_filepath=""): """GLBファイル読み込みを実行する Args: arg_filepath (str, optional): [description]. Defaults to "". """ # デフォルト設定でGLBファイルを読み込む bpy.ops.import_scene.gltf(filepath=arg_filepath) # 実行時の処理 if __name__ == "__main__": # 作成クラスと定義を登録する register()
