selectKey command

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

Synopsis

selectKey( [targetList] , [addTo=boolean], [animation=string], [attribute=string], [clear=boolean], [controlPoints=boolean], [float=floatRange], [hierarchy=string], [inTangent=boolean], [includeUpperBound=boolean], [index=uint], [keyframe=boolean], [outTangent=boolean], [remove=boolean], [replace=boolean], [shape=boolean], [time=timeRange], [toggle=boolean], [unsnappedKeys=float])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

selectKey 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:

keysOrObjects:
1. Any active keys, when no target objects or -attribute flags appear on the command line, or
2. 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.

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

This command places keyframes and/or keyframe tangents on the active list.

Return value

int The number of curves on which keys were selected (or deselcted).

In query mode, return type is based on queried flag.

select, selectMode, selectPref, selectPriority, selectType, selectedNodes

Flags

addTo, animation, attribute, clear, controlPoints, float, hierarchy, inTangent, includeUpperBound, index, keyframe, outTangent, remove, replace, shape, time, toggle, unsnappedKeys

Long name (short name) argument types Properties

attribute(at) string

List of attributes to select

hierarchy(hi) string

Hierarchy expansion options. Valid values are "above," "below," "both," and "none." (Not valid for "pasteKey" cmd.)

shape(s) boolean

Consider attributes of shapes below transforms as well, except "controlPoints". Default: true. (Not valid for "pasteKey" cmd.)

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

index(index) uint

index of a key on an animCurve

time(t) timeRange

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

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

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

Where this command should get the animation to act on. Valid values are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Description for details.)

keyframe(k) boolean

select only keyframes (cannot be combined with -in/-out)

inTangent(it) boolean

Select in-tangents of keyframes in the specified time range

outTangent(ot) boolean

Select out-tangents of keyframes in the specified time range

addTo(add) boolean

Add to the current selection of keyframes/tangents

remove(rm) boolean

Remove from the current selection of keyframes/tangents

replace(r) boolean

Replace the current selection of keyframes/tangents

toggle(tgl) boolean

Toggle the picked state of the specified keyset

clear(cl) boolean

Remove all keyframes and tangents from the active list.

unsnappedKeys(uk) float

Select only keys that have times that are not a multiple of the specified numeric 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.

Python examples

import maya.cmds as cmds

# Select all translateX keyframes on nurbsSphere1 in the range 10 to 20.
#
cmds.selectKey( 'nurbsSphere1', time=(10,20), attribute='translateX' )

# select all the animation of the active objects, range 0-30
#
cmds.selectKey( time=(0,30) )