Go to: Return value. Related commands. Flags. Examples.

Synopsis

findKeyframe [flags] [animatedObject]

This command will return the time (in current units) of the requested key. For the relative direction methods (next, previous) if -time is NOT specified they will use current time. If the specified object is not animated the command will return the current time.

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:

Return value

time

Related commands

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

Flags

animation, attribute, controlPoints, float, hierarchy, includeUpperBound, index, shape, time, timeSlider, which

Long name (short name)[argument types]Properties
-timeSlider (-ts)
Get the next key time from the ticks displayed in the time slider. If this flag is set, then the -an/animation flag is ignored.
-which (-w) string
next | previous | first | last How to find the key
-attribute (-at) stringcreatemultiuse
List of attributes to select
-hierarchy (-hi) stringcreate
Hierarchy expansion options. Valid values are "above," "below," "both," and "none." (Not valid for "pasteKey" cmd.)
-shape (-s) booleancreate
Consider attributes of shapes below transforms as well, except "controlPoints". Default: true. (Not valid for "pasteKey" cmd.)
-controlPoints (-cp) booleancreate
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) TuInt32createmultiuse
index of a key on an animCurve
-time (-t) timeRangecreatemultiuse
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) floatRangecreatemultiuse
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) booleancreate
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) stringcreate
Where this command should get the animation to act on. Valid values are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Description for details.)
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

Examples

		// Find the next key from the current time, based upon the ticks
		// displayed within the time slider
		//
		findKeyframe -timeSlider -which next;
		// Find the next key for an object after time 25
		//
		findKeyframe -time 25 -which next nurbsCone1;