pymel.core.animation.bufferCurve¶

bufferCurve(*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 -animationflag: 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 -animationflag can be used to override the curves uniquely identified by the multi-use -attributeflag, 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:20means 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 :10means 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:5means the 2nd, 3rd, 4th, 5th, and 6th keys of each animation curve.This command helps manage buffer curve for animated 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 keysOrObjectsDefault: 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 -sflag) in the list of attributes. Default: false. (Not valid for pasteKeycmd.)
exists / ex		bool
	Returns true if a buffer curve currently exists on the specified attribute; false otherwise.
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
hierarchy / hi		unicode
	Hierarchy expansion options. Valid values are above,below,both,and none.(Not valid for pasteKeycmd.)
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 pasteKeycommand, 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
overwrite / ov		bool
	Create a buffer curve. truemeans create a buffer curve whether or not one already existed. falsemeans if a buffer curve exists already then leave it alone. If no flag is specified, then the command defaults to -overwrite false
shape / s		bool
	Consider attributes of shapes below transforms as well, except controlPoints. Default: true. (Not valid for pasteKeycmd.)
swap / sw		bool
	For animated attributes which have buffer curves, swap the buffer curve with the current animation curve
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
useReferencedCurve / urc		bool
	In create mode, sets the buffer curve to the referenced curve. Curves which are not from file references will ignore this flag. In query mode, returns true if the selected keys are displaying their referenced curve as the buffer curve, and false if they are not. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.bufferCurve

Example:

import pymel.core as pm

# Create a buffer curve for the selected keys
pm.bufferCurve( animation='keys', overwrite=True )

# Set the referenced anim curve to the buffer curve
pm.bufferCurve( useReferencedCurve=True)

# Swap the buffer curve for the selected keys
pm.bufferCurve( animation='keys', swap=True )