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

Synopsis

snapKey [-animation string] [-attribute string] [-controlPoints boolean] [-float floatrange] [-hierarchy string] [-includeUpperBound boolean] [-index uint] [-shape boolean] [-time timerange] [-timeMultiple float] [-valueMultiple float] animatedObject

snapKey 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 "snaps" all target key times and/or values so that they have times and/or values that are multiples of the specified flag arguments. If neither multiple is specified, default is time snapping with a multiple of 1.0. Note that this command will fail to move keys over other neighboring keys: a key's index will not change as a result of a snapKey operation.

TbaseKeySetCmd.h

Return value

intNumber of animation curves with keys that were not snapped because of time-snapping conflicts.

Related

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

Flags

animation, attribute, controlPoints, float, hierarchy, includeUpperBound, index, shape, time, timeMultiple, valueMultiple
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.)
-timeMultiple(-tm) float create
If this flag is present, key times will be snapped to a multiple of the specified float value.
-valueMultiple(-vm) float create
If this flag is present, key values will be snapped to a multiple of the specified float 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

// Two ways to snap all keys on nurbsSphere1 to integer values.
//
snapKey -tm 1.0 nurbsSphere1;
snapKey nurbsSphere1;
// Snap active objects' keys between times 10 and 20 so that
// they have times that are multiples of 0.5.
//
snapKey -t "10:20" -tm 0.5;
// Snap active objects' keys between times 10 and 20 so that
// they have times that are multiples of 0.5 and values that
// are multiples of 1.0.
//
snapKey -t "10:20" -tm 0.5 -vm 1.0;