keyframeRegionMoveKeyCtx

Go to: Synopsis. Return value. Flags. MEL examples.

Synopsis

keyframeRegionMoveKeyCtx [-exists] [-history boolean] [-image1 string] [-image2 string] [-image3 string] [-name string] [-option string] contextName

keyframeRegionMoveKeyCtx is undoable, queryable, and editable.

Return value

In query mode, return type is based on queried flag.

Flags

Long name (short name)	Argument types	Properties
-exists(-ex)
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
-history(-ch)	boolean
If this is a tool command, turn the construction history on for the tool in question.
-image1(-i1)	string
First of three possible icons representing the tool associated with the context.
-image2(-i2)	string
Second of three possible icons representing the tool associated with the context.
-image3(-i3)	string
Third of three possible icons representing the tool associated with the context.
-name(-n)	string
If this is a tool command, name the tool appropriately.
-option(-o)	string
Valid values are "move," "insert," "over," and "segmentOver". Specifies the keyframe -option to use. When you "move" a key, the key will not cross over (in time) any keys before or after it. When you "insert" a key, all keys before or after (depending upon the -timeChange value) will be moved an equivalent amount. When you "over" a key, the key is allowed to move to any time (as long as a key is not there already). When you "segmentOver" a set of keys (this option only has a noticeable effect when more than one key is being moved) the first key (in time) and last key define a segment (unless you specify a time range). That segment is then allowed to move over other keys, and keys will be moved to make room for the segment.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can be used more than once in a command.

MEL examples

// Create a move key context which works in insert mode
// for the dope sheet editor
//
keyframeRegionMoveKeyCtx -option insert keyframeRegionMoveKeyContext;