pymel.core.animation.scaleKey

scaleKey(*args, **kwargs)

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: Any active keys, when no target objects or -attribute flags appear on the command line, orAll 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 10palmeans the key at frame 10 (PAL format).-time 1.0sec -time 15ntsc -time 20means 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 0means the first key of each animation curve. (Indices are 0-based.)-index 2 -index 5 -index 7means the 3rd, 6th, and 8th keys.-index “1:5”means the 2nd, 3rd, 4th, 5th, and 6th keys of each animation curve.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.

Flags:

Long name (short name)		Argument Types	Properties
animation (an)		unicode
	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)		unicode
	List of attributes to select
controlPoints (cp)		bool
	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.)
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”)
floatPivot (fp)		float
	Scale pivot along the x-axis for float-input animCurves
floatScale (fs)		float
	Amount of scale along the x-axis for float-input animCurves
hierarchy (hi)		unicode
	Hierarchy expansion options. Valid values are “above,” “below,” “both,” and “none.” (Not valid for “pasteKey” cmd.)
includeUpperBound (iub)		bool
	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 (index)		int
	index of a key on an animCurve
newEndFloat (nef)		float
	The end of the float range to which the float-input targets should be scaled.
newEndTime (net)		time
	The end of the time range to which the targets should be scaled.
newStartFloat (nsf)		float
	The start of the float range to which the float-input targets should be scaled.
newStartTime (nst)		time
	The start of the time range to which the time-input targets should be scaled.
scaleSpecifiedKeys (ssk)		bool
	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 commandFlag can have multiple arguments, passed either as a tuple or a list.
shape (s)		bool
	Consider attributes of shapes below transforms as well, except “controlPoints”. Default: true. (Not valid for “pasteKey” cmd.)
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”)
timePivot (tp)		time
	Scale pivot along the time-axis for time-input animCurves
timeScale (ts)		float
	Amount of scale along the time-axis for time-input animCurves
valuePivot (vp)		float
	Scale pivot along the value-axis
valueScale (vs)		float
	Amount of scale along the value-axis

Derived from mel command maya.cmds.scaleKey

Example:

import pymel.core as pm

import maya.cmds as cmds

# Scale keyframes from frame 10 to 20 of nurbsSphere1's translateX
# to fill frames 10 to 30.
#
pm.scaleKey( 'nurbsSphere1', time=(10,20), newStartTime=10, newEndTime=30, attribute='tx' )

# Scale all the animation of the active objects
# (range 0-30) to fill range 0 to 60.
#
pm.scaleKey( time=(0,30), timeScale=2, timePivot=0 )