チュートリアル / カットシーンのデータ管理
第4回：TimeEditorを⼯夫して管理を効率化してみよう④

選択した対象クリップから、出⼒対象をたどる

前回の記事で、作成するクリップと対象ノードはmessageアトリビュート「COYOTE_ExportTargetNode」と「ExportSourceClip」で接続させました。

この接続を参照して、以下のコードで対象のクリップから出⼒対象ノードのリストが取得できます。

def getTargetNodeFromClip(clip, *args, **kwargs):
    # もしも「COYOTE_ExportTargetNode」アトリビュートがなかったら対象外クリップのため、処理スキップ
    if not cmds.attributeQuery('COYOTE_ExportTargetNode', n=clip, ex=True):
        return ''
    targetNodes = cmds.listConnections(
                                    '{}.COYOTE_ExportTargetNode'.format(clip),
                                    s=True,
                                    d=False
                                )

    # 接続元がなかったら空を返す
    if not targetNodes:
        return ''

    # ソース接続は必ず単一なので、0番目を返す
    return targetNodes[0]

TimeEditorで選択されているクリップノードの取得は、ちょっとひとクセ

TimeEditor上で選択されているクリップを取得するのはちょっと厄介。
よく⽤いられる例ですが、ls -slコマンドでtimeEditorClipノードを指定して取得する以下のようなスクリプト…

cmds.ls(sl=True, type='timeEditorClip')

…では取得できません。

試しにTimeEditor上でクリップノードを選択した状態で、以下のスクリプトを実⾏してみると、理由は明らかです。

for sel in cmds.ls(sl=True):
    print(sel)

このように、ls -slコマンドで列挙されるのはノード名ではなく、クリップのマルチアトリビュートになっています。
そのため、シンプルにlsコマンドでtypeを指定するだけではダメなんですね。

そういう場合は以下のようなコードにして、明⽰的にオブジェクトを返すように指定します。

clips = cmds.ls(sl=True, type='timeEditorClip', o=True)

こうしてスクリプトを再度実⾏してみると…

このようにTimeEditor上の選択からクリップを取得することができました。

出⼒に必要な情報をクリップから取得

次にFBXアニメーションの出⼒に必要な、アニメーションレンジの情報をクリップから取得しましょう。クリップの情報には、クリップの開始時間とクリップの⻑さが記載されています。しかし終了フレームの情報は記載がありません。

そのため、開始時間とクリップの⻑さを⾜し算して、アニメーションの終了フレームを算出する必要があります。

対象クリップからアニメーションレンジを取得する処理は以下の通りです。

def getAmimRangeFromClip(clip='', *args, **kwargs):
    startTime = cmds.getAttr('{}.clip[0].clipStart'.format(clip))
    endTime = startTime + cmds.getAttr('{}.clip[0].clipDuration'.format(clip))
    
    return (startTime, endTime)

ポイントは、「.clip[0].~~」から値を取得してくる点です。

前述のTimeEditor上でクリップを取得した際、選択されたアトリビュートが

・null1_clip.clip[0]
・null2_clip.clip[0]
・null3_clip.clip[0]…

…であった点を⾒てもわかるように、ここでのクリップ情報はマルチアトリビュートの.clip[0]上に記載されています。
カットシーンの情報管理⽬的での運⽤では、.clip[1]…以降の運⽤はしないこととし、.clip[0]から取得するようにして、処理内容をシンプルにします。

登録されているクリップをリストアップして、FBX⼀括出⼒処理

さて、ここまでは「選択したクリップに対しての処理」でしたが、今度は「登録されているすべてのクリップ」を⼀括処理させてみます。
といっても、カスタムTimeEditorに登録されたすべてのクリップを対象とするのではなく、「現在表⽰されているCompositionに登録されたクリップ」を対象にすると使いやすそうです。

comp = cmds.timeEditorComposition(q=True, act=True)

Compositionに含まれているクリップを取得する

対象のCompositionが取得できたところで、今度はそのCompositonに登録されているクリップを取得します。
クリップノードはCompositionノードにつながっているので、対象のCompositionノードから接続をたどれば簡単です。

接続をたどる処理を関数にまとめてみましょう。

def getTargetClipFromCurrentComposition(*args, **kwargs):
    # 現在のcompositonを取得
    comp = cmds.timeEditorComposition(q=True, act=True)
    # compositionに接続しているclipノードを探す
    clipNodes = cmds.listConnections(comp, s=False, d=True, type='timeEditorClip')  # 重複の削除
    clipNodes = list(set(clipNodes))

    return clipNodes

これで「登録されているすべてのクリップ」に対してもFBX出⼒処理を⾛らせることが可能になりました。

FBX出⼒機能をカスタムTimeEditorのメニューに実装する

では、ここまででまとめたFBX出⼒処理をまとめて、カスタムTimeEditorのメニューから実⾏できるようにしてみます。

クリップから対象ノードやアニメーションレンジを取得する処理や、対象のクリップを取得する処理はできているので、これらを順番に実⾏してFBX出⼒処理につなげるだけでOKです。
FBXに関するスクリプトについては以下公式ドキュメントに解説があるので、ご参照ください。
公式ドキュメント︓「FBX MEL スクリプティング」

また処理を作成する際、関数の引数にselection=True/Falseなどを指定できるようにして、「全出⼒/選択出⼒」を切り替えられるようにしたら、使いやすそうです。

クリップ上で右クリック…のポップアップメニューから実⾏できたら最⾼

では、作成したFBX出⼒処理をカスタムTimeEditorのメニューから実⾏できるようにします。

しかし…、前回の記事で追加したOutliner上のポップアップメニューに追加するのは…なんかちょっとイメージ違うなぁ…という感じ。
やっぱりTool操作をイメージすると、FBX出⼒したいクリップを選択して右クリック︕…という、この流れを崩したくないわけです。

そしたら、TimeEditor上で右クリックして出現するPopupMenuを少し調べてみましょう。前回同様、スクリプトエディタをEcho allにしてTimeEditorを右クリックしてみます。すると…

teContextMenus timeEditorPanel1TimeEd timeEditorPanel1TimeEdPopupMenu Popup;

このようなプロシージャが実⾏されていることがわかります。
どうやらプロシージャ「teContextMenus」に対して、TimeEditorPanelの名前とポップアップメニューの名前、定数の⽂字列「Popup」を渡して実⾏しているようです。

さらにこれをWhatIsコマンドでたどりソースコードを⾒てみると、

・指定されたポップアップメニューをリフレッシュ
・その時の右クリックした状況に応じて、popupMenuの内容を変えてビルド

…というようなことをしていることがわかります。

ここまでわかればもうあとは簡単で、右クリックした際に実⾏される「teContextMenus」をこちらで⽤意した関数でオーバーライドしてしまえばよさそうです。

しかし、前回同様にこちらの勝⼿な拡張によって、元々のTimeEditorの機能に不具合が出てはいけません。なので、オーバーライド⽤に⽤意する関数内で元々の処理「teContextMenus」を先に呼んでおき、最後にカスタムメニューの追加処理が⾛るようにしておけばよさそうです。

ではちょっと書いてみましょう。
まずは、ポップアップメニューにカスタムメニューを追加する処理です。

def addmenuItemToTimeEditor(menuName, *args, **kwargs): 
    """TimeEditorのポップアップメニューにmenuItemを追加する処理です"""
    # メニューをわかりやすくするために罫線を入れて区切ります。 
    cmds.menuItem( 
            l='COYOTE FBXExport', 
            d=True, 
            p=menuName 
        ) 
    cmds.menuItem( 
            l='Export All', 
            p=menuName, 
            c=lambda *args: FBXExport(selection=False) 
        ) 
    cmds.menuItem( 
            l='Expirt Selection', 
            p=menuName, 
            c=lambda *args: FBXExport(selection=True) 
        ) 

次に、プロシージャ「teContextMenus」をオーバーライドする関数です。

def teContextMenusOverride(*args, **kwargs): 
    """teContextMenusプロシージャのオーバーライド関数です 
    TimeEditorのポップアップメニューが呼ばれた直後に実⾏される関数です。 
    """ 
    # 引数からメニューの名前とTimeEditorPanelの名前を取得します。 
    menuName = args[0].split('|')[-1] 
    panelName = args[1].split('|')[-1] 
    try: 
        # 念のためTry文でエラー回避させ、後の処理が必ず実⾏されるようにします。 
        mel.eval('teContextMenus {} {} Popup;'.format(panelName, menuName)) 
    except: 
        pass 
    # カスタムメニューを追加します。 
    addmenuItemToTimeEditor(menuName) 

最後に、上記で作成した関数をTimeEditorのポップアップメニューから呼ばれる関数に登録する処理です。

def buildTimeEditorPopipMenu(*args, **kwargs): 
    """TimeEditorのポップアップメニューにオーバーライド関数をセットする処理 
    カスタムTimeEditorが呼ばれたときに実⾏する関数です。 
    """ 
    # teContextMenusをオーバーライドする関数「teContextMenusOverride」をpopupMenuに設定します。
    cmds.popupMenu( 
        'timeEditorPanel1TimeEdPopupMenu', 
        e=True, 
        pmc=teContextMenusOverride 
        )

カスタムTimeEditorを⽴ち上げる際に上記関数が実⾏されるようにしておけば、TimeEditor上のPopUpMenu の拡張もOKです。

実際に拡張した例はこんな感じです。

うん、やっぱこうでしょ︕
オペレーションとToolのデザインがうまくかみ合うと、とても気持ちがよくていいですね。

【ポイント】popupMenuコマンドのpostMenuCommandでスクリプトを実⾏させる

ここでのポイントは…

・popupMenuコマンドのpmc(postMenuCommand)フラグ(公式ヘルプ参照)
・そこで指定した関数「def teContextMenusOverride」

…です。

処理の中で、

menuName = args[0].split('|')[-1]
panelName = args[1].split('|')[-1]

mel.eval('teContextMenus {} {} Popup;'.format(panelName, menuName))

こんなふうにargsから値をとって、元々のプロシージャに値を渡しています。
実は、popupMenuのフラグpmc(postMenuCommand)で関数を実⾏すると…

・ポップアップメニューを出したGUIのパス
・対象のポップアップメニューの名前

…が関数に渡されます。

試しに…

def testOverride(*args, **kwargs):
    for arg in args:
    print(arg)

cmds.popupMenu('timeEditorPanel1TimeEdPopupMenu', e=True, pmc=testOverride)

このような関数を書いて、引数のargsの中⾝をプリントさせてみます。

TimeEditor上で右クリックしてみると…

このように、「対象メニューの名前」と「対象メニューの親の名前」のフルパスがプリントされるんですね。

TimeEditorPanelEditorの名前とポップアップメニューの名前は固有な定数なので…

・timeEditorPanel1TimeEd
・timeEditorPanel1TimeEdPopupMenu

…と直に書き込んでしまってもよかったのですが…。
しかしせっかくなら、取得して使ったほうがエレガント(?)な気がしますね。（個⼈の⾒解）