コマンド プラグインの基本クラスと関数

コマンド プラグインで共有される特定の基本要素があります。

基本クラス

すべてのコマンド プラグインは、次のクラスを使用する必要があります。

クラス 用途
MFnPlugin Maya プラグイン関数セット。これはプラグインの作成時に常に必要です。
MPxCommand ベース コマンド プラグインのプロキシ クラスです。すべてのコマンド プラグインがこのクラスを拡張する必要があります。
MSyntax コマンドに渡されるフラグと引数の指定に使用します。
MArgDatabase コマンドに渡すフラグ、引数、オブジェクトの MArgList を解析するために使用します。

基本的な関数とメソッド

すべてのコマンド プラグインは、creator()doIt()initializePlugin()uninitializePlugin() を実装する必要があります。これらのすべての関数とメソッドは、Maya によって異なる時間に呼び出されます。

関数またはメソッド 説明
creator() コマンドをインスタンス化します。creator() はコードに実装する必要があるグローバル関数です。
doIt() コマンドのアクションを実行します。コマンドを初めて実行するときに、一度だけ呼び出されます。doItI()MPxCommand のメンバーであり、コード内でオーバーライドする必要があります。詳細については、「doIt() メソッドと redoIt() メソッド」を参照してください。
redoIt() コマンドのアクションを実行します。コマンドを初めて実行する場合を除き、コマンドを実行するたびに呼び出されます。redoItI()MPxCommand のメンバーであり、コード内でオーバーライドする必要があります。詳細については、「doIt() メソッドと redoIt() メソッド」を参照してください。
undoIt() コマンド操作を元に戻します。undoItI()MPxCommand のメンバーであり、コード内でオーバーライドする必要があります。詳細については、「取り消し可能なコマンド」を参照してください。
isUndoable() コマンドを元に戻すことができるかどうかを示し、そのアクションを Maya の元に戻す待ち行列に追加する必要があることを示します。isUndoable()MPxCommand のメンバーです。既定では false が返されます。コマンドを元に戻すことができる場合に true を返すには、コード内でオーバーライドする必要があります。詳細については、「取り消し可能なコマンド」を参照してください。
addMenuItem() Maya メニュー項目にコマンドをアタッチします。addMenuItem()MFnPlugin のメンバーであり、initializePlugin() で呼び出されます。
removeMenuItem() Maya メニューからコマンドのメニュー項目を除去します。removeMenuItem()MFnPlugin のメンバーであり、uninitializePlugin() で呼び出されます。
initializePlugin() プラグインが Maya にロードされるときに呼び出されます。プラグインを登録します。initializePlugin() は、コードに実装する必要があるグローバル関数です。詳細については、「プラグイン エントリ ポイント」を参照してください。
uninitializePlugin() プラグインが Maya からアンロードされるときに呼び出されます。プラグインを登録解除します。uninitializePlugin() はコードに実装する必要があるグローバル関数です。詳細については、「プラグイン エントリ ポイント」を参照してください。