Go to: Synopsis. Return value. Related. Flags. MEL examples.

Synopsis

copyKey [-animLayer string] [-animation string] [-attribute string] [-clipboard string] [-controlPoints boolean] [-float floatrange] [-forceIndependentEulerAngles boolean] [-hierarchy string] [-includeUpperBound boolean] [-index uint] [-option string] [-shape boolean] [-time timerange] [objects]

copyKey is undoable, NOT queryable, and NOT editable.

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: 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. TbaseKeySetCmd.h

Return value

int Number of animation curves copied.

Related

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

Flags

animLayer, animation, attribute, clipboard, controlPoints, float, forceIndependentEulerAngles, hierarchy, includeUpperBound, index, option, shape, time
Long name (short name) Argument types Properties
-attribute(-at) string createmultiuse
List of attributes to select

In query mode, this flag needs a value.
-hierarchy(-hi) string create
Hierarchy expansion options. Valid values are "above," "below," "both," and "none." (Not valid for "pasteKey" cmd.)

In query mode, this flag needs a value.
-shape(-s) boolean create
Consider attributes of shapes below transforms as well, except "controlPoints". Default: true. (Not valid for "pasteKey" cmd.)

In query mode, this flag needs a value.
-controlPoints(-cp) boolean create
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.)

In query mode, this flag needs a value.
-index(-in) uint createmultiuse
index of a key on an animCurve

In query mode, this flag needs a value.
-time(-t) timerange createmultiuse
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")

In query mode, this flag needs a value.
-float(-f) floatrange createmultiuse
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")

In query mode, this flag needs a value.
-includeUpperBound(-iub) boolean create
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) string create
Where this command should get the animation to act on. Valid values are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Description for details.)
-option(-o) string create
The option to use when performing the copyKey operation. Valid options are "keys," and "curve." The default copy option is: keys
-clipboard(-cb) string create
Specifies the clipboard to which animation is copied. Valid clipboards are "api" and "anim". The default clipboard is: anim
-forceIndependentEulerAngles( -fea) boolean create
Specifies that the rotation curves should always be placed on the clipboard as independent Euler Angles. The default value is false.
-animLayer(-al) string create
Specifies that the keys getting copied should come from this specified animation layer. If no keys on the object exist on this layer, then no keys are copied.
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.

MEL 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";