Show frames

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

Synopsis

cutKey [-animation string] [-attribute string] [-clear] [-controlPoints boolean] [-float floatrange] [-hierarchy string] [-includeUpperBound boolean] [-index uint] [-option string] [-selectKey] [-shape boolean] [-time timerange] [targetList]

cutKey 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 (see Examples).

The cutKey command cuts curve segment hierarchies from specified targets and puts them in the clipboard. The pasteKey command applies these curves to other objects.

The shape of the cut curve placed in the clipboard, and the effect of the cutKey command on the source animation curve depends on the cutKey "-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 cut) has 5 keyframes at times 10, 15, 20, 25, and 30.

TbaseKeySetCmd.h

Return value

intNumber of animation curves cut.

Related

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

Flags

animation, attribute, clear, controlPoints, float, hierarchy, includeUpperBound, index, option, selectKey, shape, time
Long name (short name) Argument types Properties
-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.)
-attribute(-at) string createmultiuse
List of attributes to select

In query mode, this flag needs a value.
-clear(-cl) create
Just remove the keyframes (i.e. do not overwrite the clipboard)
-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.
-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.
-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.
-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.)
-index(-in) uint createmultiuse
index of a key on an animCurve

In query mode, this flag needs a value.
-option(-o) string create
Option for how to perform the cutKey operation. Valid values for this flag are "keys", "curve", "curveCollapse", "curveConnect", "areaCollapse". The default cut option is: keys
-selectKey(-sl) create
Select the keyframes of curves which have had keys removed
-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.
-time(-t) timerange createmultiuse
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 be used more than once in a command.

MEL examples

// 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.

// -time 10pal means the key at frame 10 (PAL format).
// -time 1.0sec -time 15ntsc -time 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:" means all keys from time 10 (in the current time unit) onwards.
// -time ":10" means all keys up to (and including) time 10 (in the current time unit).
// -time ":" is a short form to specify all keys.
// -index 0 means the first key of each animation curve. (Indices are 0-based.)
// -index 2 -index 5 -index 7 means the 3rd, 6th, and 8th keys.
// -index "1:5" means the 2nd, 3rd, 4th, 5th, and 6th keys of each animation curve.

// Cut keyframes from frame 10 to 20 of cube1's "Translate X" attribute
//
cutKey -time "10:20" -attribute translateX -option keys cube1;

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