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

Synopsis

scaleKey [flags] [objects]

This command takes keyframes at (or within) the specified times (or time ranges) and scales them. If no times are specified, the scale is applied to active keyframes or (if no keys are active) all keys of active objects.

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

int Number of curves on which scale was performed

Related commands

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

Flags

animation, attribute, controlPoints, float, floatPivot, floatScale, hierarchy, includeUpperBound, index, newEndFloat, newEndTime, newStartFloat, newStartTime, scaleSpecifiedKeys, shape, time, timePivot, timeScale, valuePivot, valueScale

Long name (short name)[argument types]Properties
-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.)
-timeScale (-ts) floatcreate
Amount of scale along the time-axis for time-input animCurves
-floatScale (-fs) floatcreate
Amount of scale along the x-axis for float-input animCurves
-valueScale (-vs) floatcreate
Amount of scale along the value-axis
-timePivot (-tp) timecreate
Scale pivot along the time-axis for time-input animCurves
-floatPivot (-fp) floatcreate
Scale pivot along the x-axis for float-input animCurves
-valuePivot (-vp) floatcreate
Scale pivot along the value-axis
-newStartTime (-nst) timecreate
The start of the time range to which the time-input targets should be scaled.
-newEndTime (-net) timecreate
The end of the time range to which the targets should be scaled.
-newStartFloat (-nsf) floatcreate
The start of the float range to which the float-input targets should be scaled.
-newEndFloat (-nef) floatcreate
The end of the float range to which the float-input targets should be scaled.
-scaleSpecifiedKeys (-ssk) boolcreate
Determines if only the specified keys are affected by the scale. If false, other keys may be adjusted with the scale. The default is true.

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

	// Scale keyframes from frame 10 to 20 of nurbsSphere1's translateX
	// to fill frames 10 to 30.
	//
	scaleKey -time "10:20" -newStartTime 10 -newEndTime 30 -attribute tx nurbsSphere1;
	
	// Scale all the animation of the active objects
	// (range 0-30) to fill range 0 to 60.
	//
	scaleKey -time "0:30" -timeScale 2 -timePivot 0;