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

Synopsis

copyKey [flags] [objects]

This command copies curve segments's hierarchies from specified targets and puts them in the clipboard. Source curves are unchanged. The pasteKey command applies these curves to other objects.

The shape of the copied curve placed in the clipboard depends on the copyKey "-option" specified. Each of these options below will be explained using an example. For all the explanations, let us assume that the source animation curve (from which keys will be copied) has 5 keyframes at times 10, 15, 20, 25, and 30.

This command operates on a keyset. A keyset is defined as a group of keys within a specified time range on one or more animation curves.

The animation curves comprising a keyset depend on the value of the "-animation" flag:

Note that the "-animation" flag can be used to override the curves uniquely identified by the multi-use "-attribute" flag, which takes an argument of the form attributeName, such as "translateX".

Keys on animation curves are identified by either their time values or their indices. Times and indices can be given individually or as part of a list or range.

Omitting one end of a range means "go to infinity", as in the following examples:

Return value

int Number of animation curves copied.

Related commands

cutKey, pasteKey, snapKey, keyframe, keyframeStats, keyframeOutliner, scaleKey, setInfinity, keyTangent, findKeyframe

Flags

animation, attribute, clipboard, controlPoints, float, forceIndependentEulerAngles, hierarchy, includeUpperBound, index, option, shape, time

Long name (short name)[argument types]Properties
-option (-o) stringcreate
The option to use when performing the copyKey operation. Valid options are "keys," and "curve." The default copy option is: keys
-clipboard (-cb) stringcreate
Specifies the clipboard to which animation is copied. Valid clipboards are "api" and "anim". The default clipboard is: anim
-forceIndependentEulerAngles (-fea) boolcreate
Specifies that the rotation curves should always be placed on the clipboard as independent Euler Angles. The default value is false.
-attribute (-at) stringcreatemultiuse
List of attributes to select
-hierarchy (-hi) stringcreate
Hierarchy expansion options. Valid values are "above," "below," "both," and "none." (Not valid for "pasteKey" cmd.)
-shape (-s) booleancreate
Consider attributes of shapes below transforms as well, except "controlPoints". Default: true. (Not valid for "pasteKey" cmd.)
-controlPoints (-cp) booleancreate
This flag explicitly specifies whether or not to include the control points of a shape (see "-s" flag) in the list of attributes. Default: false. (Not valid for "pasteKey" cmd.)
-index (-in) TuInt32createmultiuse
index of a key on an animCurve
-time (-t) timeRangecreatemultiuse
time uniquely representing a key (or key range) on a time-based animCurve. Valid timeRanges include single values (-t 10) or a string with a lower and upper bound, separated by a colon (-t "10:20")
-float (-f) floatRangecreatemultiuse
value uniquely representing a non-time-based key (or key range) on a time-based animCurve. Valid floatRange include single values (-f 10) or a string with a lower and upper bound, separated by a colon (-f "10:20")
-includeUpperBound (-iub) booleancreate
When the -t/time or -f/float flags represent a range of keys, this flag determines whether the keys at the upper bound of the range are included in the keyset. Default value: true. This flag is only valid when the argument to the -t/time flag is a time range with a lower and upper bound. (When used with the "pasteKey" command, this flag refers only to the time range of the target curve that is replaced, when using options such as "replace," "fitReplace," or "scaleReplace." This flag has no effect on the curve pasted from the clipboard.)
-animation (-an) stringcreate
Where this command should get the animation to act on. Valid values are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Description for details.)

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

	// Copy keyframes from frame 10 to 20 of cube1's "Translate X" attribute
	//
	copyKey -time "10:20" -attribute "translateX" -option curve cube1;

	// Cut from all active objects all keys in the range 0 to 60
	//
	copyKey -time "0:60";