MRが楽しい

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

Blender3.0で利用可能なpythonスクリプトを作る その111(アクションデータをUIから選択して最初と最後の状態を同じにする)

本日は Blender の技術調査枠です。
Blender3.0で利用可能なpythonスクリプトを作ります。

アクションデータをUIから選択する

現在プロジェクトに含まれるアクションデータの一覧を UI で表示するには EnumProperty を利用します。
docs.blender.org

アクションデータを以下の4つの情報を持つアイテム型に変換することで EnumProperty の選択肢として表示できます。
・ID
・名称
・アイコン
・説明
docs.blender.org

    # アクションデータの選択肢の生成関数
    def prop_actiondata_select_items(self, context):
        # アイテムの一覧
        items = []

        # アクションデータを全て走査する
        for index, actiondata in enumerate(bpy.data.actions):
            # アクションデータの名称を取得する
            # Actionアクセスのマニュアル
            # (https://docs.blender.org/api/current/bpy.types.Action.html)
            action_name = actiondata.name

            # 選択肢(ID,名前,説明)を作成する
            # EnumPropertyの選択肢要素のマニュアル
            # (https://docs.blender.org/api/current/bpy.props.html#bpy.props.EnumProperty)
            action_item = (action_name, action_name, '', 'ACTION', index)

            # 選択肢を一覧に追加する
            items.append(action_item)

        return items

アクションデータの最初と最後の状態を同じにする

アクションデータにはアクションの動きを示すカーブデータが含まれています。
カーブデータ内の全キーフレームをチェックして最初と最後の値を同じにすることでループ時に違和感のないアクションデータを作成できます。
docs.blender.org
docs.blender.org

サンプルスクリプト

スクリプトを実行するとサイドバーに[HMToolkit -> アクションデータの編集]タブが追加されます。
UI からアクションを選択して実行ボタンをクリックすると、指定アクション内に含まれる全てのカーブデータの最初と最後の値が同じ値に更新されます。
・Addon_action_edit.py

# 定数の定義
ADDON_TITLE = "Action 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, EnumProperty

# 継承するクラスの命名規則は以下の通り
# [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
        # 要素行を作成する
        select_row = draw_layout.row()
        # オブジェクト選択用のカスタムプロパティを配置する
        select_row.prop(context.scene.holomon_action_edit, "prop_actionselect", text='')
        # 要素行を作成する
        button_row = draw_layout.row()
        # オブジェクト指定のサイズ縮小を実行するボタンを配置する
        button_row.operator(ADDON_OPERATOR_IDNAME)

# 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_action = context.scene.holomon_action_edit.prop_actionselect
        
        # 指定中のアクションデータを確認する
        if target_action == None:
            # アクションデータが指定されていない場合はエラーメッセージを表示する
            self.report({'ERROR'}, "No objects selected.")
            return {'CANCELLED'}

        # 指定のアクションに含まれる全カーブの最後の値を最初の値と同じにする
        update_keyframe_startend_samevalue(arg_actionname=target_action.name)

        return {'FINISHED'}

# PropertyGroupクラスの作成
# 参考URL:https://docs.blender.org/api/current/bpy.types.PropertyGroup.html
class HOLOMON_PROP_holomon_action_edit(PropertyGroup):
    # アクションデータの選択肢の生成関数
    def prop_actiondata_select_items(self, context):
        # アイテムの一覧
        items = []

        # アクションデータを全て走査する
        for index, actiondata in enumerate(bpy.data.actions):
            # アクションデータの名称を取得する
            # Actionアクセスのマニュアル
            # (https://docs.blender.org/api/current/bpy.types.Action.html)
            action_name = actiondata.name

            # 選択肢(ID,名前,説明)を作成する
            # EnumPropertyの選択肢要素のマニュアル
            # (https://docs.blender.org/api/current/bpy.props.html#bpy.props.EnumProperty)
            action_item = (action_name, action_name, '', 'ACTION', index)

            # 選択肢を一覧に追加する
            items.append(action_item)

        return items

    # シーン上のパネルに表示するUVSelect選択用のカスタムプロパティを定義する
    prop_actionselect: EnumProperty(
        name = "Select Action",               # プロパティ名
        items = prop_actiondata_select_items, # 一覧アイテム
        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 update_keyframe_startend_samevalue(arg_actionname:str) -> bool:
    """指定のアクションに含まれる全カーブの最後の値を最初の値と同じにする

    Keyword Arguments:
        arg_actionname {str} -- 指定アクション名

    Returns:
        bool -- 実行成否
    """

    # 指定名のアクションを取得する
    target_action = bpy.data.actions.get(arg_actionname)    
    if target_action == None:
        return False

    # 全てのカーブデータを走査する
    # FCurvesアクセスのマニュアル
    # (https://docs.blender.org/api/current/bpy.types.ActionFCurves.html)
    for target_curve in target_action.fcurves:
        # キーフレームの数を取得する
        keyframecount = len(target_curve.keyframe_points)

        # キーフレームの数が 2 つ以上か
        if keyframecount > 1:
            # キーフレームの最初の値を取得する
            # Keyframeアクセスのマニュアル
            # (https://docs.blender.org/api/current/bpy.types.Keyframe.html)
            firstvalue = target_curve.keyframe_points[0].co[1]

            # 最後の値を最初の値で上書きする
            target_curve.keyframe_points[keyframecount - 1].co[1] = firstvalue

            # 更新したキーフレームに合わせてカーブを更新する
            target_curve.update()

    return True

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

f:id:bluebirdofoz:20220310235044j:plain
f:id:bluebirdofoz:20220310235052j:plain