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

Synopsis

pasteKey [-animation string] [-attribute string] [-clipboard string] [-connect boolean] [-controlPoints boolean] [-copies int] [-float floatRange] [-floatOffset float] [-hierarchy string] [-includeUpperBound boolean] [-index uint] [-option string] [-shape boolean] [-time timeRange] [-timeOffset time] [-valueOffset float] [objects]

pasteKey is undoable, queryable, and 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:

The pasteKey command pastes curve segment hierarchies from the clipboard onto other objects or curves. If the object hierarchy from which the curve segments were copied or cut does not match the object hierarchy being pasted to, pasteKey will paste as much as it can match in the hierarchy. If animation from only one object is on the clipboard, it will be pasted to each of the target objects. If animation from more than one object is on the clipboard, selection list order determines what animation is pasted to which object.

Valid operations include:

TbaseKeySetCmd.h

The way the keyset clipboard will be pasted to the specified object's attributes depends on the paste "-option" specified. Each of these options below will be explained using an example. For all the explanations, let us assume that there is a curve segment with 20 frames of animation on the keyset clipboard (you can put curve segments onto the clipboard using the cutKey or copyKey commands). We will call the animation curve that we are pasting to the target curve:

Flags

animation, attribute, clipboard, connect, controlPoints, copies, float, floatOffset, hierarchy, includeUpperBound, index, option, shape, time, timeOffset, valueOffset
Long name (short name) [argument types] Properties
-attribute(-at) string createmultiuse
List of attributes to select
-hierarchy(-hi) string create
Hierarchy expansion options. Valid values are "above," "below," "both," and "none." (Not valid for "pasteKey" cmd.)
-shape(-s) boolean create
Consider attributes of shapes below transforms as well, except "controlPoints". Default: true. (Not valid for "pasteKey" cmd.)
-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.)
-index(-in) uint createmultiuse
index of a key on an animCurve
-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")
-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")
-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
Valid values are "insert", "replace", "replaceCompletely", "merge", "scaleInsert," "scaleReplace", "scaleMerge", "fitInsert", "fitReplace", and "fitMerge". The default paste option is: "insert".
-clipboard(-cb) string create
Specifies the clipboard from which animation is pasted. Valid clipboards are "api" and "anim". The default clipboard is: anim
-connect(-c) boolean create
When true, connect the source curve with the destination curve's value at the paste time. (This has the effect of shifting the clipboard curve in value to connect with the destination curve.) False preserves the source curve's original keyframe values. Default is false.
-copies(-cp) int create
The number of times to paste the source curve.
-timeOffset(-to) time create
How much to offset the pasted keys in time (for time-input animation curves).
-floatOffset(-fo) float create
How much to offset the pasted keys in time (for non-time-input animation curves).
-valueOffset(-vo) float create
How much to offset the pasted keys in 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 be used more than once in a command

Return value


int The number of curves pasted

Related

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

MEL examples

// Paste keyframes onto nurbsSphere1's translateX attribute at time 10
//
pasteKey -time 10 -attribute translateX nurbsSphere1;

// Paste to all active objects, preserving the timing from the clipboard.
//
pasteKey;