functions related to animation
| aimConstraint | Constrain an object’s orientation to point at a target object or at the average position of a number of targets. |
| animCurveEditor | Edit a characteristic of a graph editor |
| animDisplay | This command changes certain display options used by animation windows. |
| animLayer | This command creates and edits animation layers. |
| animView | This command allows you to specify the current view range within an animation editor. |
| applyTake | This command takes data in a device (refered to as a take) and converts it into a form that may be played back and reviewed. |
| autoKeyframe | With no flags, this command will set keyframes on all attributes that have been modified since an autoKeyframe -state oncommand was issued. To stop keeping track of modified attributes, use autoKeyframe -state offautoKeyframe does not create new animation curves. An attribute must have already been keyframed (with the setKeyframe command) for autoKeyframe to add new keyframes for modified attributes. You can also query the current state of autoKeyframing with autoKeyframe -query -state. |
| bakeClip | This command is used to bake clips and blends into a single clip. |
| bakeResults | This command allows the user to replace a chain of dependency nodes which define the value for an attribute with a single animation curve. |
| bakeSimulation | This command operates on a keyset. |
| bindSkin | This command binds the currently selected objects to the currently selected skeletons. |
| blendShape | This command creates a blendShape deformer, which blends in specified amounts of each target shape to the initial base shape. Each base shape is deformed by its own set of target shapes. Every target shape has an index that associates it with one of the shape weight values.In the create mode the first item on the selection list is treated as the base and the remaining inputs as targets. If the first item on the list has multiple shapes grouped beneath it, the targets must have an identical shape hierarchy. Additional base shapes can be added in edit mode using the deformers -g flag. |
| blendShapeEditor | This command creates an editor that derives from the base editor class that has controls for blendShape, control nodes. |
| blendShapePanel | This command creates a panel that derives from the base panel class that houses a blendShapeEditor. |
| blendTwoAttr | A blendTwoAttr nodes takes two inputs, and blends the values of the inputs from one to the other, into an output value. The blending of the two inputs uses a blending function, and the following formula: (1 - blendFunction) * input[0] + blendFunction * input[1] The blendTwoAttr command can be used to blend the animation of an object to transition smoothly between the animation of two other objects. When the blendTwoAttr command is issued, it creates a blendTwoAttr node on the specified attributes, and reconnects whatever was previously connected to the attributes to the new blend nodes. You may also specify which two attributes should be used to blend together. The driver is used when you want to keyframe an object after it is being animated by a blend node. The current driver index specifies which of the two blended attributes should be keyframed. |
| boneLattice | This command creates/edits/queries a boneLattice deformer. The name of the created/edited object is returned. Usually you would make use of this functionality through the higher level flexor command. |
| bufferCurve | This command operates on a keyset. |
| buildBookmarkMenu | This command handles building the dynamicBookmark menu, to show all bookmarks (sets) of a specified type (sets -text) menuName is the string returned by the menucommand. |
| buildKeyframeMenu | This command handles building the dynamicKeyframe menu, to show attributes of currently selected objects, filtered by the current manipulator. menuName is the string returned by the menucommand. The target menu will entries appended to it (and deleted from it) to always show what’s currently keyframable. |
| character | This command is used to manage the membership of a character. |
| characterMap | This command is used to create a correlation between the attributes of 2 or more characters. |
| characterOutlineEditor | This command is used to create an outliner control that lists the characters in the scene. |
| characterize | This command is used to scan a joint hierarchy for predefined joint names or labels. |
| choice | The choice command provides a mechanism for changing the inputs to an attribute based on some (usually time-based) criteria. |
| clip | This command is used to create, edit and query character clips. |
| clipEditor | Create a clip editor with the given name. |
| clipSchedule | This command is used to create, edit and query clips and blends in the Trax editor. It operates on the clipScheduler node attached to the character. In query mode, if no flags are specified, returns an array of strings in this form: (clipName,clipIndex,clipStart,clipSourceStart,clipSourceEnd,clipScale,clipPreCycle,clipPostCycle,clipHold) |
| clipSchedulerOutliner | This command creates/edits/queries a clip scheduler outliner control. |
| cluster | The cluster command creates a cluster or edits the membership of an existing cluster. |
| connectJoint | This cmd will connect two skeletons based on the selected two joints. |
| copyFlexor | This command copies an existing bone or joint flexor from one bone (joint) to another. |
| copyKey | This command operates on a keyset. |
| copySkinWeights | Command to copy or mirror the skinCluster weights accross one of the three major axes. The command can be used to mirror weights either from one surface to another or within the same surface. In query mode, return type is based on queried flag. |
| currentTime | When given a time argument (with or without the -edit flag) this command sets the current global time. |
| cutKey | This command operates on a keyset. |
| dagPose | This command is used to save and restore the matrix information for a dag hierarchy. |
| defineDataServer | Connects to the specified data servername, creating a named device which then can be attached to device handlers. |
| defineVirtualDevice | This command defines a virtual device. |
| deformer | This command creates a deformer of the specified type. |
| disconnectJoint | This command will break a skeleton at the selected joint and delete any associated handles. |
| dopeSheetEditor | Edit a characteristic of a dope sheet editor |
| dropoffLocator | This command adds one or more dropoff locators to a wire curve, one for each selected curve point. |
| effector | The effector command is used to set the name or hidden flag for the effector. |
| enableDevice | Sets (or queries) the device enable state for actions involving the device. |
| filterCurve | The filterCurve command takes a list of anim curve and filters them. Currently only a Euler filter is supported. The Euler filter demangles discontinous rotation anim curves into smooth curves. |
| findKeyframe | This command operates on a keyset. |
| flexor | This command creates a flexor. |
| flow | The flow command creates a deformation lattice to `bend’ the object that is animated along a curve of a motion path animation. |
| geometryConstraint | Constrain an object’s position based on the shape of the target surface(s) at the closest point(s) to the object. |
| getCurrentTime | get the current time as a float |
| ikHandle | The handle command is used to create, edit, and query a handle within Maya. The standard edit (-e) and query (-q) flags are used for edit and query functions. If there are 2 joints selected and neither -startJoint nor -endEffector flags are not specified, then the handle will be created from the selected joints. If a single joint is selected and neither -startJoint nor -endEffector flags are specified, then the handle will be created with the selected joint as the end-effector and the start joint will be the top of the joint chain containing the end effector. The default values of the flags are: -name ikHandle#-priority 1-weight 1.0-positionWeight 1.0-solver ikRPsolver-forceSolver on-snapHandleFlagToggle on-sticky off-createCurve true-simplifyCurve true-rootOnCurve true-twistType linear-createRootAxis false-parentCurve true-snapCurve false-numSpans 1-rootTwistMode false.These attributes can be specified in creation mode, edited in edit mode (-e) or queried in query mode (-q). |
| ikHandleDisplayScale | This action modifies and queries the current display size of ikHandle. The default display scale is 1.0. In query mode, return type is based on queried flag. |
| ikSolver | The ikSolver command is used to set the attributes for an IK Solver or create a new one. The standard edit (-e) and query (-q) flags are used for edit and query functions. |
| ikSystem | The ikSystem command is used to set the global snapping flag for handles and set the global solve flag for solvers. The standard edit (-e) and query (-q) flags are used for edit and query functions. |
| ikSystemInfo | This action modifies and queries the current ikSystem controls. In query mode, return type is based on queried flag. |
| ikfkDisplayMethod | The ikfkDisplayMethodcommand is used to specify how ik/fk blending should be shown In query mode, return type is based on queried flag. |
| insertJoint | This command will insert a new joint under the given or selected joint. |
| joint | The joint command is used to create, edit, and query, joints within Maya. (The standard edit(-e) and query(-q) flags are used for edit and query functions). If the object is not specified, the currently selected object (dag object) will be used. Multiple objects are allowed only for the edit mode. The same edit flags will be applied on all the joints selected, except for -p without -r (set joint position in the world space). An ik handle in the object list is equivalent to the list of joints the ik handle commands. When -ch/children is present, all the child joints of the specified joints, including the joints implied by possible ik handles, will also be included. In the creation mode, a new joint will be created as a child of a selected transform or starts a hierarchy by itself if no transform is selected. An ik handle will be treated as a transform in the creation mode. The default values of the arguments are: -degreeOfFreedom xyz -name Joint#-position 0 0 0 -absolute -dof xyz-scale 1.0 1.0 1.0 -scaleCompensate true -orientation 0.0 0.0 0.0 -scaleOrientation 0.0 0.0 0.0 -limitX -360 360 -limitY -360 360 -limitZ -360 360 -angleX 0.0 -angleY 0.0 -angleZ 0.0 -stiffnessX 0.0 -stiffnessY 0.0 -stiffnessZ 0.0 -limitSwitchX no -limitSwitchY no -limitSwitchZ no -rotationOrder xyz Those arguments can be specified in the creation mode, editied in the edit mode (-e), or queried in the query mode (-q). |
| jointCluster | The joint cluster command adds high-level controls to manage the cluster percentage values on a bound skin around a joint. |
| jointDisplayScale | This action modifies and queries the current display size of skelton joints. |
| jointLattice | This command creates/edits/queries a jointLattice deformer. The name of the created/edited object is returned. Usually you would make use of this functionality through the higher level flexor command. |
| keyTangent | This command operates on a keyset. |
| keyframe | This command operates on a keyset. |
| keyframeOutliner | This command creates/edits/queries a keyframe outliner control. |
| keyframeStats | All of the group commands position their individual controls in columns starting at column 1. |
| lattice | This command creates a lattice deformer that will deform the selected objects. |
| listAnimatable | This command list the animatable attributes of a node. |
| marker | The marker command creates one or two markers, on a motion path curve, at the specified time and location. |
| mirrorJoint | This command will duplicate a branch of the skeleton from the selected joint symmetrically about a plane in world space. |
| movIn | Imports a .mov file into animation curves connected to the listed attributes. |
| movOut | Exports a .mov file from the listed attributes. |
| mute | The mute command is used to disable and enable playback on a channel. |
| nonLinear | This command creates a functional deformer of the specified type that will deform the selected objects. |
| normalConstraint | Constrain an object’s orientation based on the normal of the target surface(s) at the closest point(s) to the object. |
| orientConstraint | Constrain an object’s orientation to match the orientation of the target or the average of a number of targets. |
| pairBlend | The pairBlend node allows a weighted combinations of 2 inputs to be blended together. It is created automatically when keying or constraining an attribute which is already connected.Alternatively, the pairBlend command can be used to connect a pairBlend node to connected attributes of a node. The previously existing connections are rewired to input1 of the pairBlend node. Additional connections can then be made manually to input2 of the pairBlend node. The pairBlend command can also be used to query the inputs to an existing pairBlend node. |
| parentConstraint | Constrain an object’s position and rotation so that it behaves as if it were a child of the target object(s). |
| pasteKey | The pasteKey command pastes curve segment hierarchies from the clipboard onto other objects or curves. If the object hierarchy from which the curve segments were copied or cut does not match the object hierarchy being pasted to, pasteKey will paste as much as it can match in the hierarchy. If animation from only one object is on the clipboard, it will be pasted to each of the target objects. If animation from more than one object is on the clipboard, selection list order determines what animation is pasted to which object. Valid operations include: One attribute to one or more attributes (Clipboard animation is pasted onto all target attributes.One attribute to one or more objects (Clipboard animation pasted onto target object, when attribute names match.)Many attributes to one or more objectsClipboard animation pasted onto targets when attribute names match.TbaseKeySetCmd.h The way the keyset clipboard will be pasted to the specified object’s attributes depends on the paste -optionspecified. Each of these options below will be explained using an example. For all the explanations, let us assume that there is a curve segment with 20 frames of animation on the keyset clipboard (you can put curve segments onto the clipboard using the cutKeyor copyKeycommands). We will call the animation curve that we are pasting to the target curve: pasteKey -time 5 -option insert1. Shift all keyframes on the target curve after time 5 to the right by 20 frames (to make room for the 20-frame clipboard segment). 2. Paste the 20-frame clipboard segment starting at time 5. pasteKey -time 5:25-option replace1. Remove all keys on the target curve from 5 to 25. 2. Paste the 20-frame clipboard curve at time 5. pasteKey -option replaceCompletely1. Remove all keys on the target curve. 2. Paste the 20-frame clipboard curve, preserving the clipboard curve’s original keyframe times. pasteKey -time 5 -option merge1.The clipboard curve segment will be pasted starting at time 5 for its full 20-frame range until frame 25. 2. If a keyframe on the target curve has the same time as a keyframe on the clipboard curve, it is overwritten. Otherwise, any keys that existed in the 5:25 range before the paste, will remain untouched pasteKey -time 3:10-option scaleInsert1. Shift all keyframes on the target curve after time 3 to the right by 7 frames (to clear the range 3:10 to paste in) 2. The clipboard curve segment will be scaled to fit the specified time range (i.e. the 20 frames on the clipboard will be scaled to fit into 7 frames), and then pasted into the range 3:10. pasteKey -time 3:10-option scaleReplace1. Any existing keyframes in the target curve in the range 3:10 are removed. 2. The clipboard curve segment will be scaled to fit the specified time range (i.e. the 20 frames on the clipboard will be scaled to fit into 7 frames), and then pasted into the range 3:10. pasteKey -time 3:10-option scaleMerge1. The clipboard curve segment will be scaled to fit the specified time range (i.e. the 20 frames on the clipboard will be scaled to fit into 7 frames). 2. If there are keys on the target curve at the same time as keys on the clipboard curve, they are overwritten. Otherwise, keyframes on the target curve that existed in the 3:10 range before the paste, will remain untouched. pasteKey -time 3:10-option fitInsert1. Shift all the keyframes on the target curve after time 3 to the right by 7 frames (to clear the range 3:10 to paste in) 2. The first 7 frames of the clipboard curve segment will be pasted into the range 3:10. pasteKey -time 3:10-option fitReplace1. Any existing frames in the target curve in the range 3:10 are removed. 2. The first 7 frames of the clipboard curve segment will be pasted into the range 3:10. pasteKey -time 3:10-option fitMerge1. The first 7 frames of the clipboard curve segment will be pasted into the range 3:10. 2. If there are keys on the target curve at the same time as keys on the clipboard curve, they are overwritten. Otherwise, keyframes on the target curve that existed in the 3:10 range before the paste, will remain untouched. |
| pathAnimation | The pathAnimation command constructs the necessary graph nodes and their interconnections for a motion path animation. Motion path animation requires a curve and one or more other objects. During the animation, the objects will be moved along the 3D curve or the curveOnSurface.There are two ways to specify the moving objects: by explicitly specifying their names in the command line, orby making the objects selected (interactively, or through a MEL command).Likewise, there are two ways to specify a motion curve: by explicitly specifying the name of the motion curve in the command line (i.e. using the -c curve_name option), orby selecting the moving objects first before selecting the motion curve. I.e. if the name of the motion curve is not provided in the command line, the curve will be taken to be the last selected object in the selection list.When the end time is not specified: only one keyframe will be created either at the current time, or at the specified start time. |
| percent | This command sets percent values on members of a weighted node such as a cluster or a jointCluster. With no flags specified the command sets the percent value for selected components of the specified node to the specified percent value. A dropoff from the specified percent value to 0 can be specifed from a point, plane or curve using a dropoff distance around that shape. The percent value can also be added or multiplied with existing percent values of the node components. In query mode, return type is based on queried flag. |
| play | This command starts and stops playback. |
| playbackOptions | This command sets/queries certain values associated with playback: looping style, start/end times, etc. |
| playblast | This command playblasts the current playback range. |
| pointConstraint | Constrain an object’s position to the position of the target object or to the average position of a number of targets. |
| poleVectorConstraint | Constrains the poleVector of an ikRPsolve handle to point at a target object or at the average position of a number of targets. An poleVectorConstraint takes as input one or more targetDAG transform nodes at which to aim pole vector for an IK handle using the rotate plane solver. The pole vector is adjust such that the in weighted average of the world space position target objects lies is the rotate planeof the handle. |
| pose | This command is used to create character poses. |
| readTake | This action reads a take (.mov) file to a defined device. |
| recordDevice | Starts and stops server side device recording. |
| removeJoint | This command will remove the selected joint or the joint given at the command line from the skeleton. |
| reorderDeformers | This command changes the order in which 2 deformation nodes affect the output geometry. |
| reroot | This command will reroot a skeleton. |
| retarget | This command is used to take motion from one character and retarget it to a second character of a different size. |
| rotationInterpolation | The rotationInterpolation command converts the rotation curves to the desired rotation interpolation representation. For example, an Euler-angled representation can be converted to Quaternion. In query mode, return type is based on queried flag. |
| scaleConstraint | Constrain an object’s scale to the scale of the target object or to the average scale of a number of targets. |
| scaleKey | This command operates on a keyset. |
| sculpt | This command creates/edits/queries a sculpt object deformer. |
| setCurrentTime | set the current time |
| setDrivenKeyframe | This command sets a driven keyframe. |
| setInfinity | Set the infinity type before (after) a paramCurve’s first (last) keyframe. In query mode, return type is based on queried flag. |
| setKeyPath | The setKeyPath command either creates or edits the path (a nurbs curve) based on the current position of the selected object at the current time. |
| setKeyframe | This command creates keyframes for the specified objects, or the active objects if none are specified on the command line. |
| setKeyframeBlendshapeTargetWts | This command can be used to keyframe per-point blendshape target weights. |
| simplify | This command operates on a keyset. |
| skinCluster | The skinCluster command is used for smooth skinning in maya. It binds the selected geometry to the selected joints or skeleton by means of a skinCluster node. Each point of the bound geometry can be affected by any number of joints. The extent to which each joint affects the motion of each point is regulated by a corresponding weight factor. Weight factors can be modified using the skinPercent command. The command returns the name of the new skinCluster.The skinCluster binds only a single geometry at a time. Thus, to bind multiple geometries, multiple skinCluster commands must be issued.Upon creation of a new skinCluster, the command can be used to add and remove transforms (not necessarily joints) that influence the motion of the bound skin points. The skinCluster command can also be used to adjust parameters such as the dropoff, nurbs samples, polygon smoothness on a particular influence object. Note: Any custom weights on a skin point that the influence object affects will be lost after adjusting these parameters. |
| skinPercent | This command edits and queries the weight values on members of a skinCluster node, given as the first argument. If no object components are explicitly mentioned in the command line, the current selection list is used. Note that setting multiple weights in a single invocation of this command is far more efficient than calling it once per weighted vertex. In query mode, return type is based on queried flag. |
| snapKey | This command operates on a keyset. |
| snapshot | This command can be used to create either a series of surfaces evaluated at the times specified by the command flags, or a motion trail displaying the trajectory of the object’s pivot point at the times specified.If the constructionHistory flag is true, the output shapes or motion trail will re-update when modifications are made to the animation or construction history of the original shape. When construction history is used, the forceUpdate flag can be set to false to control when the snapshot recomputes, which will typically improve performance. |
| softMod | The softMod command creates a softMod or edits the membership of an existing softMod. The command returns the name of the softMod node upon creation of a new softMod. |
| sound | Creates an audio node which can be used with UI commands such as soundControl or timeControl which support sound scrubbing and sound during playback. |
| substituteGeometry | This command can be used to replace the geometry which is already connected to deformers with a new geometry. |
| tangentConstraint | Constrain an object’s orientation based on the tangent of the target curve[s] at the closest point[s] to the object. |
| wire | This command creates a wire deformer. |
| wrinkle | The wrinkle command is used to create a network of wrinkles on a surface. |
| writeTake | This action writes a take from a device with recorded data to a take (.mov) file. |