bufferCurve command

Go to: Synopsis. Return value. Flags. MEL examples.

Synopsis

bufferCurve [-animation string] [-attribute string] [-controlPoints boolean] [-exists] [-float floatrange] [-hierarchy string] [-includeUpperBound boolean] [-index uint] [-overwrite boolean] [-shape boolean] [-swap] [-time timerange] [-useReferencedCurve] animatedObject

bufferCurve is undoable, queryable, and NOT 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 helps manage buffer curve for animated objects

Return value

int

Number of buffer curves

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

Flags

animation, attribute, controlPoints, exists, float, hierarchy, includeUpperBound, index, overwrite, shape, swap, time, useReferencedCurve

Long name (short name) Argument types Properties

-attribute(-at) string

List of attributes to select

In query mode, this flag needs a value.

-hierarchy(-hi) string

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

In query mode, this flag needs a value.

-shape(-s) boolean

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

In query mode, this flag needs a value.

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

In query mode, this flag needs a value.

-index(-in) uint

index of a key on an animCurve

In query mode, this flag needs a value.

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

In query mode, this flag needs a value.

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

In query mode, this flag needs a value.

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

-overwrite(-ov) boolean

Create a buffer curve. "true" means create a buffer curve whether or not one already existed. "false" means if a buffer curve exists already then leave it alone. If no flag is specified, then the command defaults to -overwrite false

For animated attributes which have buffer curves, swap the buffer curve with the current animation curve

-useReferencedCurve(-urc)

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.

Returns true if a buffer curve currently exists on the specified attribute; false otherwise.

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.

MEL examples

// Create a buffer curve for the selected keys
bufferCurve -animation keys -overwrite true;
// Set the referenced anim curve to the buffer curve
bufferCurve -useReferencedCurve;
// Swap the buffer curve for the selected keys
bufferCurve -animation keys -swap;