undoInfo

ジャンプ先: 概要. 戻り値. 関連. フラグ. MEL 例.

概要

undoInfo [-chunkName string] [-closeChunk] [-infinity boolean] [-length uint] [-openChunk] [-printQueue] [-printRedoQueue] [-redoName string] [-redoQueueEmpty] [-state boolean] [-stateWithoutFlush boolean] [-undoName string] [-undoQueueEmpty]

undoInfo は、取り消し可能、照会可能、および編集不可能です。

照会モードでは、フラグ(照会フラグ以外)を使用しないで呼び出された場合、このコマンドは現在、元に戻す待ち行列にある項目数を返します。

戻り値

照会モードでは、戻り値のタイプは照会されたフラグに基づきます。

関連

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
-chunkName(-cn)	string
チャンクを開くときに、元に戻す、またはやり直す目的でチャンクを識別するために使用される名前を設定します。
-closeChunk(-cck)
以前、openChunk により開かれたチャンクを閉じます。チャンクのクローズがコールされると、チャンク内の元に戻すことができる操作はすべて、単一の元に戻す操作として元に戻されます。この機能の使用には注意が必要です。このコマンドを不適切に使用すると、元に戻す待ち行列が状態不良になることがあります。
-infinity(-in)	boolean
待ち行列の長さ(取り消しできる回数)を無限にします。
-length(-l)	uint
元に戻す待ち行列の項目の最大数を指定します。infinity フラグを使用すると、このフラグはオーバーライドされます。
-openChunk(-ock)
チャンクを開きます。このコール後、元に戻すことができる操作はすべて、チャンクのクローズがコールされるまで、新しく開かれたチャンクに入るようになります。チャンクのクローズがコールされると、チャンク内の元に戻すことができる操作はすべて、単一の元に戻す操作として元に戻されます。この機能の使用には注意が必要です。このコマンドを不適切に使用すると、元に戻す待ち行列が状態不良になることがあります。
-printQueue(-pq)
元に戻す待ち行列の内容をスクリプト エディタに出力します。
-printRedoQueue(-prq)
やり直し待ち行列の内容をスクリプト エディタに出力します。
-redoName(-rn)	string
やり直されるものがあれば、その名前を返します。
-redoQueueEmpty(-rqe)
再実行の待ち行列が空であれば、true を返します。待ち行列に再実行するコマンドが 1 つでもあれば、false を返します。
-state(-st)	boolean
元に戻す/再実行のオンとオフを切り替えます。
-stateWithoutFlush(-swf)	boolean
待ち行列の内容を消去せずに、undo/redo のオンとオフを切り替えます。この機能の使用には注意が必要です。stateWithoutFlush を無効にして破壊的な操作を実行し、再びこのフラグを有効にした場合、破壊的操作を遡って元に戻す操作を実行しても、元に戻す操作はシーンの以前の状態を正しく再構築できないため、結果が不安定になる恐れがあります。
-undoName(-un)	string
元に戻す対象取り消しされるものがあれば、その名前を返します。
-undoQueueEmpty(-uqe)
元に戻す待ち行列が空であれば、true を返します。待ち行列に元に戻すコマンドが 1 つでもあれば、false を返します。

フラグはコマンドの作成モードで表示できます	フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます	コマンド内でフラグを複数回使用できます。

MEL 例

// Turn undo on, with an infinite queue length
undoInfo -state on -infinity on;
// Turn undo on, with a queue length of 200
undoInfo -state on -infinity off -length 200;
// Turn undo off
undoInfo -state off;
// Query the queue length
undoInfo -q -length;
// Print the contents of the undo queue.
undoInfo -q -pq;
// Query the number of items currently on the queue.
undoInfo -q;