Go to: Return value. Related commands. Flags. Examples.

Synopsis

setDrivenKeyframe [flags] [objects]

This command sets a driven keyframe. A driven keyframe is similar to a regular keyframe. However, while a standard keyframe always has an x-axis of time in the graph editor, for a drivenkeyframe the user may choose any attribute as the x-axis of the graph editor.

For example, you can keyframe the emission of a faucet so that so that it emits whenever the faucet handle is rotated around y. The faucet emission in this example is called the driven attribute. The handle rotation is called the driver. Once you have used setDrivenKeyframe to set up the relationship between the emission and the rotation, you can go to the graph editor and modify the relationship between the attributes just as you would modify the animation curve on any keyframed object.

In the case of an attribute driven by a single driver, the dependency graph is connected like this:

driver attribute ---> animCurve ---> driven attribute

You can set driven keyframes with more than a single driver. The effects of the multiple drivers are combined together by a blend node.

Return value

int Number of keyframes set.

Related commands

autoKeyframe, setKeyframe, findKeyframe, setKeyPath

Flags

attribute, controlPoints, currentDriver, driven, driver, driverValue, hierarchy, inTangentType, insert, insertBlend, outTangentType, shape, value

Long name (short name)[argument types]Properties
-currentDriver (-cd) attributequerycreate
Set the driver to be used for the current driven keyframe.
-driver (-dr) query
Returns list of available drivers for the attribute.
-driven (-dn) query
Returns list of driven attributes for the selected item.
-driverValue (-dv) valuecreatemultiuse
Value of the driver to use for this keyframe. Default value is the current value.
-value (-v) create
Value to set the keyframe at. Default is the current value.
-attribute (-at) stringcreatemultiuse
Attribute name to set keyframes on.
-insert (-i) create
Insert keys at the given time(s) and preserve the shape of the animation curve(s).
-inTangentType (-itt) stringcreate
The in tangent type for keyframes set by this command. Valid values are "spline," "linear," "fast," "slow," "flat," "step," and "clamped." Default is "keyTangent -q -g -inTangentType"
-outTangentType (-ott) stringcreate
The out tangent type for keyframes set by this command. Valid values are "spline," "linear," "fast," "slow," "flat," "step," and "clamped." Default is "keyTangent -q -g -outTangentType"
-hierarchy (-hi) stringcreate
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"
-shape (-s) booleancreate
Consider attributes of shapes below transforms as well, except "controlPoints". Default: true
-controlPoints (-cp) booleancreate
Explicitly specify whether or not to include the control points of a shape (see "-s" flag) in the list of attributes. Default: false.
-insertBlend (-ib) booleancreate
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.
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

Examples


 // To set the keyframe on the selected object's translateX based on
 // curve1's rotateZ:
	setDrivenKeyframe -at translateX -cd curve1.rz;

 // To set the keyframe on surface1.tx based on the value of curve1.rz:
	setDrivenKeyframe -cd curve1.rz surface1.tx;

 // To query the current driver of surface1.tx:
	setDrivenKeyframe -q -cd surface1.tx;

 // To query the available drivers of surface1.tx:
	setDrivenKeyframe -q -dr surface1.tx;