【Maya/Python】OpenMaya API2.0 の Message 系クラス内のコールバックタイミング解説 1

この記事は Maya Advent Calendar 2023 シリーズ2 の14日目の記事です。(書いたのは 12/24 ですが)

シリーズ1の前日は @9boz さんの「mayaのプレイブラストをffmpegでmp4にしてみる2」、

当日は @cr_coyote さんの「スクリプトでAnimCurveをフィルタリング！」、

翌日は @9boz さんの「Mayaで ファイルを開かずにreferenceしてるファイルを知りたい」です。

シリーズ2の翌日は @9boz さんの「mayaでボクセルっぽいものを生成」です。

今回は OpenMaya API 2.0 の Message 系クラスにある様々なコールバックのタイミングについてまとめていこうと思います。

※ Message 系のコールバック = maya.cmds にある scriptJob と似たようなもの

この記事で紹介している Message は

・MCameraMessage

・MObjectSetMessage

・MDGMessage

・MModelMessage

で、Maya 2022.5 で検証したものです。

Message 系クラスは他にもたくさんあるので、徐々に紹介できたらいいなと思い、

記事のタイトルの末尾に 1 とつけています。

近いうちに、とは思いつつ来年の Advent Calendar で書いている未来が見えますが…

ちなみに2020年に「【Maya/Python】OpenMaya API2.0 の MSceneMessage クラス内のコールバックタイミング解説」という記事も書いておりますのでご興味あればご覧下さい。

※この中で MSceneMessage の addCheck～ 系が API2.0 だとエラーになると書いていましたが、登録する関数側の書き方の問題（ return True/False を書いてなかったのがエラーの原因 ）だという事に少し前に気付いたので追記しています。

import maya.api.OpenMaya as om2

def addBeginManipulationCallbackMethod(*args):

    print(args[0]) # 対象ノードの MObject

selList = om2.MGlobal.getActiveSelectionList() # CameraShape を選択した状態
mObject = selList.getDependNode(0)

om2.MCameraMessage.addBeginManipulationCallback(mObject, addBeginManipulationCallbackMethod)

import maya.api.OpenMaya as om2

def addEndManipulationCallbackMethod(*args):

    print(args[0]) # 対象ノードの MObject

selList = om2.MGlobal.getActiveSelectionList() # CameraShape を選択した状態
mObject = selList.getDependNode(0)

om2.MCameraMessage.addEndManipulationCallback(mObject, addEndManipulationCallbackMethod)

import maya.api.OpenMaya as om2

def addSetMembersModifiedCallbackMethod(*args):

    print(args[0]) # 対象ノードの MObject

selList = om2.MGlobal.getActiveSelectionList() # Set を選択した状態
mObject = selList.getDependNode(0)

om2.MObjectSetMessage.addSetMembersModifiedCallback(mObject, addSetMembersModifiedCallbackMethod)

import maya.api.OpenMaya as om2

def addConnectionCallbackMethod(*args):

    print(args[0]) # src MPlug

    print(args[1]) # dst MPlug

    print(args[2]) # 接続されたときは True, 切断されたときは False

om2.MDGMessage.addPreConnectionCallback(addPreConnectionCallbackMethod)

import maya.api.OpenMaya as om2

def addConnectionCallbackMethod(*args):

    print(args[0]) # src MPlug

    print(args[1]) # dst MPlug

    print(args[2]) # 接続されたときは True, 切断されたときは False

om2.MDGMessage.addConnectionCallback(addConnectionCallbackMethod)

import maya.api.OpenMaya as om2

def addDelayedTimeChangeCallbackMethod(*args):

    print(args[0]) # 変更後の MTime

om2.MDGMessage.addDelayedTimeChangeCallback(addDelayedTimeChangeCallbackMethod)

import maya.api.OpenMaya as om2

def addDelayedTimeChangeRunupCallbackMethod(*args):

    print(args[0]) # 変更後の MTime

om2.MDGMessage.addDelayedTimeChangeRunupCallback(addDelayedTimeChangeRunupCallbackMethod)

時間が変更され、Dependency Graph がすべて評価されたあとに呼ばれる

import maya.api.OpenMaya as om2

def addForceUpdateCallbackMethod(*args):

    print(args[0]) # 変更後の MTime

om2.MDGMessage.addForceUpdateCallback(addForceUpdateCallbackMethod)

設定時に指定した nodeType のノードがシーンに追加されるたびに呼ばれます。
指定する nodeType は apiType ではなく, nodeType コマンドそのままでも取得できるノードタイプを文字列で指定します。
 （今回の例の場合は mesh を指定しているので mesh ノードが追加されるたび）

import maya.api.OpenMaya as om2

def addNodeAddedCallbackMethod(*args):

    print(args[0]) # 対象ノードの MObject

om2.MDGMessage.addNodeAddedCallback(addNodeAddedCallbackMethod, "mesh")

rename コマンドの uuid フラグを使って, uuid を変更したときなどに呼ばれる

import maya.api.OpenMaya as om2

def addNodeChangeUuidCheckCallbackMethod(*args):

    print(args[0]) # 適用されるかどうかの bool

    print(args[1]) # 対象ノードの MObject

    print(args[2]) # 変更後の UUID

om2.MDGMessage.addNodeChangeUuidCheckCallback(addNodeChangeUuidCheckCallbackMethod)

設定時に指定した nodeType のノードがシーンに削除されるたびに呼ばれます。
指定する nodeType は apiType ではなく, nodeType コマンドそのままでも取得できるノードタイプを文字列で指定します。
（今回の例の場合は mesh を指定しているので mesh が削除されるたび）

import maya.api.OpenMaya as om2

def addNodeRemovedCallbackMethod(*args):

    print(args[0]) # 対象ノードの MObject

om2.MDGMessage.addNodeRemovedCallback(addNodeRemovedCallbackMethod, "mesh")

時間が変更されたときに呼ばれる

import maya.api.OpenMaya as om2

def addTimeChangeCallbackMethod(*args):

    print(args[0]) # 変更後の MTime

om2.MDGMessage.addTimeChangeCallback(addTimeChangeCallbackMethod)

複製コマンドが呼ばれた後に呼ばれる（ addBeforeDuplicateCallbackMethod の後）

import maya.api.OpenMaya as om2

def addAfterDuplicateCallbackMethod(*args):

    pass

om2.MModelMessage.addAfterDuplicateCallback(addAfterDuplicateCallbackMethod)

複製コマンドが呼ばれる前に呼ばれる（ addAfterDuplicateCallbackMethod の前）

import maya.api.OpenMaya as om2

def addBeforeDuplicateCallbackMethod(*args):

    pass

om2.MModelMessage.addBeforeDuplicateCallback(addBeforeDuplicateCallbackMethod)

選択を変更したときに呼ばれる（scriptJob の SelectionChanged と同じ）

addBeforeDuplicateCallback と addAfterDuplicateCallback と一緒に実行した場合、

　①addBeforeDuplicateCallbackMethod

　②ddCallbackMethod

　③addAfterDuplicateCallbackMethod

の順に実行されます。

import maya.api.OpenMaya as om2

def addCallbackMethod(*args):

    pass

om2.MModelMessage.addCallback(om2.MModelMessage.kActiveListModified, addCallbackMethod)

第一引数で指定した dag node の MObject が Maya モデルに追加されようとするときに呼ばれる、らしいのですが、色々試しても処理の実行条件が未だにわからず…

（ご存知の方がいらっしゃったら教えて下さい）

import maya.api.OpenMaya as om2

def addNodeAddedToModelCallbackMethod(*args):

    print(args[0]) # 対象ノードの MObject

selList = om2.MGlobal.getActiveSelectionList() # 対象ノードを選択した状態
mObject = selList.getDependNode(0)

om2.MModelMessage.addNodeAddedToModelCallback(mObject, addNodeAddedToModelCallbackMethod)

第一引数で指定した dag node の MObject が Maya モデルから削除されるときに呼ばれる。

import maya.api.OpenMaya as om2

def addNodeRemovedFromModelCallbackMethod(*args):

    print(args[0]) # 対象ノードの MObject

selList = om2.MGlobal.getActiveSelectionList() # 対象ノードを選択した状態
mObject = selList.getDependNode(0)

om2.MModelMessage.addNodeRemovedFromModelCallback(mObject, addNodeRemovedFromModelCallbackMethod)