bakeResults

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

Synopsis

bakeResults [-animation string] [-attribute string] [-bakeOnOverrideLayer boolean] [-controlPoints boolean] [-destinationLayer string] [-disableImplicitControl boolean] [-float floatrange] [-hierarchy string] [-includeUpperBound boolean] [-index uint] [-minimizeRotation boolean] [-oversamplingRate uint] [-preserveOutsideKeys boolean] [-removeBakedAttributeFromLayer boolean] [-resolveWithoutLayer string] [-sampleBy time] [-shape boolean] [-simulation boolean] [-smart [ boolean float ]] [-sparseAnimCurveBake boolean] [-time timerange] objects

bakeResults is undoable, queryable, and 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 should be specified as a range, as shown below.

• -time "10:20" means all keys in the range from 10 to 20, inclusive, in the current time unit.
• -index "1:5" means the 2nd, 3rd, 4th, 5th, and 6th keys of each animation curve.

Return value

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

Related

Flags

Long name (short name)	Argument types	Properties
-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.)
-attribute(-at)	string
List of attributes to select In query mode, this flag needs a value.
-bakeOnOverrideLayer(-bol)	boolean
If true, all layered and baked attribute will be added as a top override layer.
-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.
-destinationLayer(-dl)	string
This flag can be used to specify an existing layer where the baked results should be stored.
-disableImplicitControl(-dic)	boolean
Whether to disable implicit control after the anim curves are obtained as the result of this command. An implicit control to an attribute is some function that affects the attribute without using an explicit dependency graph connection. The control of IK, via ik handles, is an example.
-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.
-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.
-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.)
-index(-in)	uint
index of a key on an animCurve In query mode, this flag needs a value.
-minimizeRotation(-mr)	boolean
Specify whether to minimize the local euler component from key to key during baking of rotation channels.
-oversamplingRate(-osr)	uint
Amount to samples per sampleBy period. Default is 1
-preserveOutsideKeys(-pok)	boolean
Whether to preserve keys that are outside the bake range when there are directly connected animation curves or a pairBlend node which has an animation curve as its direct input. The default (false) is to remove frames outside the bake range. If the channel that you are baking is not controlled by a single animation curve, then a new animation curve will be created with keys only in the bake range. In the case of pairBlend-driven channels, setting pok to true will retain both the pairBlend and its input animCurve. The blended values will be baked onto the animCurve and the weight of the pairBlend weight will be keyed to the animCurve during the baked range.
-removeBakedAttributeFromLayer(-ral)	boolean
If true, all baked attribute will be removed from the layer. Otherwise all layer associated with the baked attribute will be muted.
-resolveWithoutLayer(-rwl)	string
This flag can be used to specify a list of layers to be merged together during the bake process. This is a multi-use flag. Its name refers to the fact that when solving for the value to key, it determines the proper value to key on the destination layer to achieve the same result as the merged layers.
-sampleBy(-sb)	time
Amount to sample by. Default is 1.0 in current timeUnit
-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.
-simulation(-sm)	boolean
Using this flag instructs the command to preform a simulation instead of just evaluating each attribute separately over the range of time. The simulation flag is required to bake animation that that depends on the whole scene being evaluated at each time step such as dynamics. The default is false.
-smart(-sr)	[ boolean float ]
Specify whether to enable smart bake and the optional smart bake tolerance.
-sparseAnimCurveBake(-sac)	boolean
When this is true and anim curves are being baked, do not insert any keys into areas of the curve where animation is defined. And, use as few keys as possible to bake the pre and post infinity behavior. When this is false, one key will be inserted at each time step. The default is false.
-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.

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

// To replace the set of nodes controlling the animation of
// surface1.translateX with a single animation animCurve, between the
// time interval 5-44, with a sampling frequency of 2 timeUnits, use the
// following command:
   bakeResults -t "5:44" -sb 2 surface1.translateX;

// This bakes the joints on a skeleton over the time interval 1-40.
   bakeResults -t "1:40" -simulation true "joint*";