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

Synopsis

keyframeRegionDirectKeyCtx( contextName , [exists=boolean], [history=boolean], [image1=string], [image2=string], [image3=string], [name=string], [option=string])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

keyframeRegionDirectKeyCtx is undoable, queryable, and editable.

This command creates a context which may be used to directly manipulate keyframes within the dope sheet editor

Return value

string

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

Flags

exists, history, image1, image2, image3, name, option
Long name (short name) Argument types Properties
exists(ex) boolean create
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
image1(i1) string createqueryedit
image2(i2) string createqueryedit
image3(i3) string createqueryedit
Contexts support up to three icons that represent the tool associated with the context.
history(ch) boolean create
If this is a tool command, turn the construction history on for the tool in question.
name(n) string create
If this is a tool command, name the tool appropriately.
option(o) string create
Valid values are "move," "insert," "over," and "segmentOver." 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 have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# Create a direct key context for the dope sheet editor
#
cmds.keyframeRegionDirectKeyCtx( 'keyframeRegionDirectKeyContext' )