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

Synopsis

retimeKeyCtx( contextName , [exists=boolean], [history=boolean], [image1=string], [image2=string], [image3=string], [moveByFrame=int], [name=string], [snapOnFrame=boolean])

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

retimeKeyCtx is undoable, queryable, and editable.

This command creates a context which may be used to scale keyframes within the graph editor using the retime tool.

Return value

string

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

Flags

exists, history, image1, image2, image3, moveByFrame, name, snapOnFrame
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.
history(ch) boolean create
If this is a tool command, turn the construction history on for the tool in question.
image1(i1) string createqueryedit
First of three possible icons representing the tool associated with the context.
image2(i2) string createqueryedit
Second of three possible icons representing the tool associated with the context.
image3(i3) string createqueryedit
Third of three possible icons representing the tool associated with the context.
moveByFrame(mbf) int edit
Move the selected retime bar by the specified number of frames
name(n) string create
If this is a tool command, name the tool appropriately.
snapOnFrame(sof) boolean queryedit
When set, the retime markers will snap on frames as they are moved.

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 manipulator style scale key context for the graph editor
#
cmds.retimeKeyCtx( 'retimeKeyContext' )