Go to: Synopsis. Return value. Related. Flags. Python examples.
copyKey(
[objects]
, [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])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
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:
-
keysOrObjects:
- Any active keys, when no target objects or -attribute
flags appear on the command line, or
- All animation curves connected to all keyframable
attributes of objects specified as the command line's
targetList, when there are no active keys.
-
keys:
Only act on active keys or tangents.
If there are no active keys or tangents, don't do anything.
-
objects:
Only act on specified objects. If there are no objects specified, don't
do anything.
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 (see 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.
- copyKey -t "12:22" -option keys
- A 5-frame animation curve with one key at 15 and another key at 20
is placed into the keyset clipboard.
- copyKey -t "12:22" -option curve
- A 10-frame animation is placed into the clipboard. The curve
contains the original source-curve keys at times 15 and 20, as well
as new keys inserted at times 12 and 22 to preserve the shape of the
curve at the given time segment.
TbaseKeySetCmd.h
| int | Number of animation curves copied. |
cutKey, findKeyframe, keyTangent, keyframe, keyframeOutliner, keyframeStats, pasteKey, scaleKey, setInfinity, snapKey
animLayer, animation, attribute, clipboard, controlPoints, float, forceIndependentEulerAngles, hierarchy, includeUpperBound, index, option, shape, time
| Long name (short name) |
Argument types |
Properties |
|
animLayer(al)
|
string
|
|
|
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.
|
|
animation(an)
|
string
|
|
|
Where this command should get the animation to act
on. Valid values are "objects," "keys," and
"keysOrObjects" Default: "keysOrObjects." (See
Description for details.)
|
|
attribute(at)
|
string
|
|
|
List of attributes to select
In query mode, this flag needs a value.
|
|
clipboard(cb)
|
string
|
|
|
Specifies the clipboard to which animation is copied.
Valid clipboards are "api" and "anim". The default clipboard
is: anim
|
|
controlPoints(cp)
|
boolean
|
|
|
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.
|
|
float(f)
|
floatrange
|
|
|
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.
|
|
forceIndependentEulerAngles(fea)
|
boolean
|
|
|
Specifies that the rotation curves should always be placed on the
clipboard as independent Euler Angles. The default value is false.
|
|
hierarchy(hi)
|
string
|
|
|
Hierarchy expansion options. Valid values are "above,"
"below," "both," and "none." (Not valid for "pasteKey" cmd.)
In query mode, this flag needs a value.
|
|
includeUpperBound(iub)
|
boolean
|
|
|
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.)
|
|
index(index)
|
uint
|
|
|
index of a key on an animCurve
In query mode, this flag needs a value.
|
|
option(o)
|
string
|
|
|
The option to use when performing the copyKey operation.
Valid options are "keys," and "curve." The default copy option
is: keys
|
|
shape(s)
|
boolean
|
|
|
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.
|
|
time(t)
|
timerange
|
|
|
time uniquely representing a key (or key
range) on a time-based animCurve. See the code
examples below on how to format for a single
frame or frame ranges.
In query mode, this flag needs a value.
|
|
|
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.
|
import maya.cmds as cmds
# Keys on animation curves are identified by either
# their time values or their indices. Times and indices can
# be given as a range or list of ranges.
# time=('10pal','10pal') means the key at frame 10 (PAL format).
# time=[('1.0sec','1.0sec'),('15ntsc','15ntsc'),(20,20)] means the keys at time 1.0 second, frame 15 (in NTSC format), and time 20 (in the currently defined global time unit).
# time=(10,20) means all keys in the range from 10 to 20, inclusive, in the current time unit.
# Omitting one end of a range means "go to infinity", as in the following examples:
# time=(10,None) means all keys from time 10 (in the current time unit) onwards.
# time=(10,) means the same as (10,10)
# time=(0,10) means all keys up to (and including) time 10 (in the current time unit).
# time=(None,None) is a short form to specify all keys.
# index=(0,0) means the first key of each animation curve. (Indices are 0-based.)
# index=[(2,2),(5,5),(7,7)] means the 3rd, 6th, and 8th keys.
# index=(1,5) means the 2nd, 3rd, 4th, 5th, and 6th keys of each animation curve.
# Copy keyframes from frame 10 to 20 of cube1's "Translate X" attribute
#
cmds.copyKey( 'cube1', time=(10,20), attribute='translateX', option="curve" )
# Copy from all active objects all keys in the range 0 to 60
#
cmds.copyKey( time=(0,60) )