pymel.core.animation.setKeyframe

setKeyframe(*args, **kwargs)

This command creates keyframes for the specified objects, or the active objects if none are specified on the command line. The default time for the new keyframes is the current time. Override this behavior with the -tflag on the command line. The default value for the keyframe is the current value of the attribute for which a keyframe is set. Override this behavior with the -vflag on the command line. When setting keyframes on animation curves that do not have timeas an input attribute (ie, they are unitless animation curves), use -f/-floatto specify the unitless value at which to set a keyframe. The -time and -float flags may be combined in one command. This command sets up Dependency Graph relationships for proper evaluation of a given attribute at a given time.

Flags:

• animLayer : al (unicode) [create]

  Specifies that the new key should be placed in the specified animation layer. Note that if the objects being keyframed are not already part of the layer, this flag will be ignored.

• attribute : at (unicode) [create]

  Attribute name to set keyframes on.

• breakdown : bd (bool) [create,query,edit]

  Sets the breakdown state for the key. Default is false

• clip : c (unicode) [create]

  Specifies that the new key should be placed in the specified clip. Note that if the objects being keyframed are not already part of the clip, this flag will be ignored.

• controlPoints : cp (bool) [create]

  Explicitly specify whether or not to include the control points of a shape (see -sflag) in the list of attributes. Default: false.

• dirtyDG : dd (bool) []

• float : f (float) [create]

  Float time at which to set a keyframe on float-based animation curves.

• hierarchy : hi (unicode) [create]

  Controls the objects this command acts on, relative to the specified (or active) target objects. Valid values are above,below,both,and none.Default is hierarchy -query

• identity : id (bool) [create]

  Sets an identity key on an animation layer. An identity key is one that nullifies the effect of the anim layer. This flag has effect only when the attribute being keyed is being driven by animation layers. Flag can have multiple arguments, passed either as a tuple or a list.

• inTangentType : itt (unicode) [create]

  The in tangent type for keyframes set by this command. Valid values are spline, linear, fast, slow, flat, stepped, step next, fixed, clampedand plateau. Default is keyTangent -q -g -inTangentType

• insert : i (bool) [create]

  Insert keys at the given time(s) and preserve the shape of the animation curve(s). Note: the tangent type on inserted keys will be fixed so that the curve shape can be preserved.

• insertBlend : ib (bool) [create]

  If true, a pairBlend node will be inserted for channels that have nodes other than animCurves driving them, so that such channels can have blended animation. If false, these channels will not have keys inserted. If the flag is not specified, the blend will be inserted based on the global preference for blending animation.

• minimizeRotation : mr (bool) [create]

  For rotations, ensures that the key that is set is a minimum distance away from the previous key. Default is false

• outTangentType : ott (unicode) [create]

  The out tangent type for keyframes set by this command. Valid values are spline, linear, fast, slow, flat, stepped, step next, fixed, clampedand plateau. Default is keyTangent -q -g -outTangentType

• shape : s (bool) [create]

  Consider attributes of shapes below transforms as well, except controlPoints. Default: true

• time : t (time) [create]

  Time at which to set a keyframe on time-based animation curves.

• value : v (float) [create]

  Value at which to set the keyframe. Using the value flag will not cause the keyed attribute to change to the specified value until the scene re-evaluates. Therefore, if you want the attribute to update to the new value immediately, use the setAttr command in addition to setting the key.

Derived from mel command maya.cmds.setKeyframe