pymel.core.animation.bakeSimulation

bakeSimulation(*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.The bakeSimulation command is obsolete. Instead, “bakeResults -simulation true” should be used. The bakeSimulation command has retained for backwards compatibility. This command allows the user to replace a chain of dependency nodes, or implicit relationship, such as those between joints and IK handles, which define the value of an attribute, with a single animation curve. Command allows the user to specify the range and frequency of sampling. Unlike the bakeResults command, this command will actually set the time of the current scene to all the times, in sequence, inside the given time interval before it sets the time back to when it is started. As a result, it may modify the scene. In query mode, return type is based on queried flag.

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
bakeOnOverrideLayer (bol)		bool
	If true, all layered and baked attributes will be added as a top override layer.
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.)
destinationLayer (dl)		unicode
	This flag can be used to specify an existing layer where the baked results should be stored.
disableImplicitControl (dic)		bool
	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”)
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
minimizeRotation (mr)		bool
	Specify whether to minimize the local euler component from key to key during baking of rotation channels.
preserveOutsideKeys (pok)		bool
	Whether to preserve keys that are outside the bake range when there are directly connected animation curves. 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.
removeBakedAttributeFromLayer (ral)		bool
	If true, all baked attributes will be removed from the layer. Otherwise all layers associated with the baked attribute will be muted.
resolveWithoutLayer (rwl)		unicode
	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)		bool
	Consider attributes of shapes below transforms as well, except “controlPoints”. Default: true. (Not valid for “pasteKey” cmd.)
simulation (sm)		bool
	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 true.
smart (sr)		bool, float
	Specify whether to enable smart bake and the optional smart bake tolerance.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
sparseAnimCurveBake (sac)		bool
	When baking anim curves, 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 behaviors. 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”)

Derived from mel command maya.cmds.bakeSimulation

Example:

import pymel.core as pm

# To replace the animation driven by an ik handle of joints,
# starting from joint1, with separate animCurves, within the
# time interval 5-44, with a sampling frequency of 2 timeUnits,
# use the following command:
#
pm.bakeSimulation( 'joint1', t=(5,44), sb=2, at=["rx","ry","rz"], hi="below" )