本日は Blender の技術調査枠です。
Blender3.0で利用可能なpythonスクリプトを作ります。
UIボタン実行時の現在のポーズを基ににループアクションを作成する
アクションの開始と終了のポーズを同じに、中間フレームに左右反転のポーズを設定することで簡易なループアクションが作成可能です。
今回は以下のフレーム移動、ポーズの反転コピー、キーフレームの登録を利用しました。
docs.blender.org
・ポーズの反転コピー(bpy.ops.pose.paste)
docs.blender.org
・キーフレームの登録(bpy.ops.anim.keyframe_insert_menu)
docs.blender.org
またオペレータを利用するため、対象のオブジェクトがポーズモードである必要があります。
ポーズモードの判定はアクティブオブジェクトのモード変数を参照します。
・モード変数(bpy.types.Object.mode)
docs.blender.org
サンプルスクリプト
スクリプトを実行するとサイドバーに[HMToolkit -> アクションデータの編集(ポーズモードのみ)]タブが追加されます。
UI からアクションを選択して実行ボタンをクリックすると、現在のポーズを左右反転で繰り返すループアクションを作成します。
・Addon_make_loopaction.py
# 定数の定義 ADDON_TITLE = "Ａction Edit" ADDON_COMMONNAME = "holomon_action_edit" ADDON_OPERATOR_IDNAME = "holomon.action_edit" # bl_infoでプラグインに関する情報の定義を行う bl_info = { "name": ADDON_TITLE + " Addon by HoloMon", # プラグイン名 "author": "HoloMon", # 制作者名 "version": (1, 0), # バージョン "blender": (3, 00, 0), # 動作可能なBlenderバージョン "support": "TESTING", # サポートレベル "category": "3D View", # カテゴリ名 "location": "View3D > Sidebar > HoloMon", # ロケーション "description": ADDON_TITLE + "Addon", # 説明文 "location": "", # 機能の位置付け "warning": "", # 注意点やバグ情報 "doc_url": "", # ドキュメントURL } # 利用するタイプやメソッドのインポート import bpy from bpy.types import Operator, Panel, PropertyGroup from bpy.props import PointerProperty, StringProperty, 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_action_edit(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 = 0 # パネルのカテゴリ名称を定義する # 3Dビューポートの場合、サイドバーの名称になる # デフォルトは名称無し bl_category = "HMToolkit" # 描画の定義 def draw(self, context): # Operatorをボタンとして配置する draw_layout = self.layout # ボックス要素を作成する draw_box = draw_layout.box() # 要素行を作成する select_row = draw_box.row() # アクション名指定用のカスタムプロパティを配置する select_row.prop(context.scene.holomon_action_edit, "prop_makeactionname") # 要素行を作成する select_row = draw_box.row() # アクションフレーム数指定用のカスタムプロパティを配置する select_row.prop(context.scene.holomon_action_edit, "prop_makeactiontotalflame") # 要素行を作成する button_row = draw_box.row() # アクション作成を実行するボタンを配置する button_row.operator(ADDON_OPERATOR_IDNAME) # 現在のアクティブオブジェクトが「ポーズモード」かチェックする if is_posemode_object(arg_checkobject=context.view_layer.objects.active) == False: # 「ポーズモード」でない場合、ボックス要素を無効化する draw_box.enabled = False # Operatorクラスの作成 # 参考URL:https://docs.blender.org/api/current/bpy.types.Operator.html class HOLOMON_OT_holomon_action_edit(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): # カスタムプロパティから指定のアクション名を取得する target_actionname = context.scene.holomon_action_edit.prop_makeactionname # カスタムプロパティから指定のアクションフレーム数を取得する target_actiontotalflame = context.scene.holomon_action_edit.prop_makeactiontotalflame # 現在のアクティブオブジェクトを取得する activeobject = context.view_layer.objects.active # 現在のアクティブオブジェクトが「ポーズモード」かチェックする if is_posemode_object(arg_checkobject=activeobject) == False: # 「ポーズモード」でない場合はエラーメッセージを表示する self.report({'ERROR'}, "アクション作成に失敗しました") return {'CANCELLED'} # アクションデータを作成する makeaction = make_actiondata(arg_makeactionname=target_actionname) # 実行結果を確認する if makeaction == None: # 実行に失敗した場合はエラーメッセージを表示する self.report({'ERROR'}, "アクション作成に失敗しました") return {'CANCELLED'} # 指定のアクションに含まれる全カーブの最後の値を最初の値と同じにする make_result = make_loopaction( arg_targetobject=activeobject, arg_targetaction=makeaction, arg_framecount=target_actiontotalflame ) # 実行結果を確認する if make_result == None: # 実行に失敗した場合はエラーメッセージを表示する self.report({'ERROR'}, "アクション作成に失敗しました") return {'CANCELLED'} return {'FINISHED'} # PropertyGroupクラスの作成 # 参考URL:https://docs.blender.org/api/current/bpy.types.PropertyGroup.html class HOLOMON_PROP_holomon_action_edit(PropertyGroup): # シーン上のパネルに表示するアクション名指定のカスタムプロパティを定義する prop_makeactionname: StringProperty( name = "作成アクション名", # プロパティ名 default="NewAction", # デフォルト値 description = "作成するアクション名を指定します", # 説明文 ) # シーン上のパネルに表示するフレーム数指定のカスタムプロパティを定義する prop_makeactiontotalflame: IntProperty( name = "作成アクションのフレーム数", # プロパティ名 default=10, # デフォルト値 description = "作成するアクションのフレーム数を指定します", # 説明文 ) # 登録に関する処理 # 登録対象のクラス名 regist_classes = ( HOLOMON_PT_holomon_action_edit, HOLOMON_OT_holomon_action_edit, HOLOMON_PROP_holomon_action_edit, ) # 作成クラスと定義の登録メソッド def register(): # カスタムクラスを登録する for regist_cls in regist_classes: bpy.utils.register_class(regist_cls) # シーン情報にカスタムプロパティを登録する bpy.types.Scene.holomon_action_edit = PointerProperty(type=HOLOMON_PROP_holomon_action_edit) # 作成クラスと定義の登録解除メソッド def unregister(): # シーン情報のカスタムプロパティを削除する del bpy.types.Scene.holomon_action_edit # カスタムクラスを解除する for regist_cls in regist_classes: bpy.utils.unregister_class(regist_cls) # 指定のオブジェクトがポーズモードかチェックする def is_posemode_object(arg_checkobject:bpy.types.Object) -> bool: """指定のオブジェクトがポーズモードかチェックする Keyword Arguments: arg_checkobject {bpy.types.Object} -- チェック対象オブジェクト Returns: bool -- ポーズモードか否か """ # 指定オブジェクトがアーマチュアか確認する # オブジェクトタイプの一覧 # (https://docs.blender.org/api/current/bpy.types.Object.html#bpy.types.Object.type) if arg_checkobject.type != 'ARMATURE': # アーマチュアでない場合はポーズモードでないと判定する return False # オブジェクト毎のモードをチェックする # (https://docs.blender.org/api/current/bpy.types.Object.html#bpy.types.Object.mode) return ('POSE' == arg_checkobject.mode) # 指定名のアクションデータを作成する(デフォルトではフェイクユーザを設定する) def make_actiondata(arg_makeactionname:str, arg_fakeuser:bool = True) -> bpy.types.Action: """指定名のアクションデータを作成する(デフォルトではフェイクユーザを設定する) Keyword Arguments: arg_targetaction {bpy.types.Action} -- 対象アクションデータ arg_fakeuser {bool} -- フェイクユーザの設定(デフォルト:True) Returns: bool -- 実行の正否 """ # 引数のNoneチェック if arg_makeactionname == None: return None # 指定名のアクションデータを作成する # アクションコレクションの操作マニュアル # (https://docs.blender.org/api/current/bpy.types.BlendDataActions.html#bpy.types.BlendDataActions) # 同名のアクションが存在した場合、"指定名.001"の修飾子が付いたアクション名で生成される makeaction = bpy.data.actions.new(arg_makeactionname) # フェイクユーザを設定する # IDの操作マニュアル # (https://docs.blender.org/api/current/bpy.types.ID.html#bpy.types.ID.use_fake_user) makeaction.use_fake_user = arg_fakeuser return makeaction # 現在のポーズからボーン位置と回転をキーフレームに登録してループアクションを作成する def make_loopaction( arg_targetobject:bpy.types.Object, arg_targetaction:bpy.types.Action, arg_framecount:int) -> bool: """現在のポーズからボーン位置と回転をキーフレームに登録してループアクションを作成する Keyword Arguments: arg_targetobject {bpy.types.Object} -- 対象オブジェクト arg_targetaction {bpy.types.Action} -- 対象アクションデータ arg_framecount {int} -- アクションのフレーム数 Returns: bool -- 実行の正否 """ # 引数のNoneチェック if arg_targetobject == None: return False if arg_targetaction == None: return False # 指定オブジェクトがアーマチュアか確認する # オブジェクトタイプの一覧 # (https://docs.blender.org/api/current/bpy.types.Object.html#bpy.types.Object.type) if arg_targetobject.type != 'ARMATURE': # アーマチュアでない場合はボーンを選択しない return False # アクションデータを現在のアーマチュアに設定する arg_targetobject.animation_data.action = arg_targetaction # 現在のモードがポーズモードかチェックする(反転には bpy.ops.pose 関数を利用するため) is_posemode = is_posemode_object(arg_targetobject) if not is_posemode: # ポーズモードでない場合はボーンを反転しない return False # アーマチュア内の全ボーンを選択状態にする(有効状態のレイヤー内のボーンのみ対象) # アーマチュア操作のマニュアル # (https://docs.blender.org/api/current/bpy.types.Armature.html#bpy.types.Armature.bones) for bone in arg_targetobject.data.bones: # 選択状態に設定する # ボーン操作のマニュアル # (https://docs.blender.org/api/current/bpy.types.Bone.html) bone.select = True # 0 のフレーム番号を設定する bpy.context.scene.frame_set(0) # 選択中のボーンの位置・回転をキーフレームに挿入する bpy.ops.anim.keyframe_insert_menu(type='BUILTIN_KSI_LocRot') # 0 のフレームのポーズのコピーを行う bpy.ops.pose.copy() # 中間のフレーム番号を設定する bpy.context.scene.frame_set(arg_framecount / 2) # ポーズを反転して貼り付けを行う bpy.ops.pose.paste(flipped=True) # 選択中のボーンの位置・回転をキーフレームに挿入する bpy.ops.anim.keyframe_insert_menu(type='BUILTIN_KSI_LocRot') # 指定の最終フレーム番号を設定する bpy.context.scene.frame_set(arg_framecount) # ポーズを反転せず貼り付けを行う bpy.ops.pose.paste(flipped=False) # 選択中のボーンの位置・回転をキーフレームに挿入する bpy.ops.anim.keyframe_insert_menu(type='BUILTIN_KSI_LocRot') return True # 実行時の処理 if __name__ == "__main__": # 作成クラスと定義を登録する register()
