/python/pymel/core/animation.py

https://bitbucket.org/jspatrick/emacs · Python · 7855 lines · 6779 code · 727 blank · 349 comment · 851 complexity · dda5befde114d007a2b321196b33fce8 MD5 · raw file

  1. import pymel.internal.factories as _factories
  2. import general as _general
  3. import pymel.util as _util
  4. import pymel.internal.pmcmds as cmds
  5. import pymel.versions as versions
  6. from pymel.internal.pmcmds import *
  7. def aimConstraint(*args, **kwargs):
  8. """
  9. Constrain an object's orientation to point at a target object or at the average position of a number of targets. An
  10. aimConstraint takes as input one or more targetDAG transform nodes at which to aim the single constraint objectDAG
  11. transform node. The aimConstraint orients the constrained object such that the aimVector (in the object's local
  12. coordinate system) points to the in weighted average of the world space position target objects. The upVector (again
  13. the the object's local coordinate system) is aligned in world space with the worldUpVector.
  14. Maya Bug Fix:
  15. - when queried, angle offsets would be returned in radians, not current angle unit
  16. Modifications:
  17. - added new syntax for querying the weight of a target object, by passing the constraint first::
  18. aimConstraint( 'pCube1_aimConstraint1', q=1, weight ='pSphere1' )
  19. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =['pSphere1', 'pCylinder1'] )
  20. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =[] )
  21. Flags:
  22. - aimVector : aim (float, float, float) [create,query,edit]
  23. Set the aim vector. This is the vector in local coordinates that points at the target. If not given at creation time,
  24. the default value of (1.0, 0.0, 0.0) is used.
  25. - layer : l (unicode) [create,edit]
  26. Specify the name of the animation layer where the constraint should be added.
  27. - maintainOffset : mo (bool) [create]
  28. The offset necessary to preserve the constrained object's initial rotation will be calculated and used as the offset.
  29. - name : n (unicode) [create,query,edit]
  30. Sets the name of the constraint node to the specified name. Default name is constrainedObjectName_constraintType
  31. - offset : o (float, float, float) [create,query,edit]
  32. Sets or queries the value of the offset. Default is 0,0,0.
  33. - remove : rm (bool) [edit]
  34. removes the listed target(s) from the constraint.
  35. - skip : sk (unicode) [create,edit]
  36. Specify the axis to be skipped. Valid values are x, y, zand none. During creation, noneis the default.
  37. Flag can have multiple arguments, passed either as a tuple or a list.
  38. - targetList : tl (bool) [query]
  39. Return the list of target objects.
  40. - upVector : u (float, float, float) [create,query,edit]
  41. Set local up vector. This is the vector in local coordinates that aligns with the world up vector. If not given at
  42. creation time, the default value of (0.0, 1.0, 0.0) is used.
  43. - weight : w (float) [create,query,edit]
  44. Sets the weight value for the specified target(s). If not given at creation time, the default value of 1.0 is used.
  45. - weightAliasList : wal (bool) [query]
  46. Returns the names of the attributes that control the weight of the target objects. Aliases are returned in the same
  47. order as the targets are returned by the targetList flag
  48. - worldUpObject : wuo (PyNode) [create,query,edit]
  49. Set the DAG object use for worldUpType objectand objectrotation. See worldUpType for greater detail. The default value
  50. is no up object, which is interpreted as world space.
  51. - worldUpType : wut (unicode) [create,query,edit]
  52. Set the type of the world up vector computation. The worldUpType can have one of 5 values: scene, object,
  53. objectrotation, vector, or none. If the value is scene, the upVector is aligned with the up axis of the scene and
  54. worldUpVector and worldUpObject are ignored. If the value is object, the upVector is aimed as closely as possible to the
  55. origin of the space of the worldUpObject and the worldUpVector is ignored. If the value is objectrotationthen the
  56. worldUpVector is interpreted as being in the coordinate space of the worldUpObject, transformed into world space and the
  57. upVector is aligned as closely as possible to the result. If the value is vector, the upVector is aligned with
  58. worldUpVector as closely as possible and worldUpMatrix is ignored. Finally, if the value is noneno twist calculation is
  59. performed by the constraint, with the resulting upVectororientation based previous orientation of the constrained
  60. object, and the great circlerotation needed to align the aim vector with its constraint. The default worldUpType is
  61. vector.
  62. - worldUpVector : wu (float, float, float) [create,query,edit]
  63. Set world up vector. This is the vector in world coordinates that up vector should align with. See -wut/worldUpType
  64. (below)for greater detail. If not given at creation time, the default value of (0.0, 1.0, 0.0) is used.
  65. Derived from mel command `maya.cmds.aimConstraint`
  66. """
  67. pass
  68. def animCurveEditor(*args, **kwargs):
  69. """
  70. Edit a characteristic of a graph editor
  71. Flags:
  72. - autoFit : af (unicode) [query,edit]
  73. on | off | tgl auto fit-to-view
  74. - classicMode : cm (bool) []
  75. - clipTime : ct (unicode) [query,edit]
  76. Valid values: onoffDisplay the clips with their offset and scale applied to the anim curves in the clip.
  77. - constrainDrag : cd (int) [create,query,edit]
  78. Constrains all Graph Editor animation curve drag operations to either the X-axis, the Y-axis, or to neither of those
  79. axes. Values to supply are: 0 for not constraining any axis, 1 for constraing the X-axis, or 2 for constraining the
  80. Y-axis. When used in queries, this flag returns the latter values and these values have the same interpretation as
  81. above. Note: when the shift key is pressed before dragging the animation curve, the first mouse movement will instead
  82. determine (and override) any prior set constrained axis. Flag can have multiple arguments, passed
  83. either as a tuple or a list.
  84. - control : ctl (bool) [query]
  85. Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus.
  86. Caution: It is possible, at times, for an editor to exist without a control. This flag returns NONEif no control is
  87. present.
  88. - curvesShown : cs (bool) [query]
  89. Returns a string array containing the names of the animCurve nodes currently displayed in the graph editor.
  90. - curvesShownForceUpdate : csf (bool) []
  91. - defineTemplate : dt (unicode) [create]
  92. Puts a command in a mode where any other flags and args are parsed and added to the command template specified in the
  93. argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set
  94. as the current template.
  95. - denormalizeCurvesCommand : dcc (unicode) [create,edit]
  96. Sets the script which is run to denormalize curves in the graph editor. This is intended for internal use only.
  97. - displayActiveKeyTangents : dat (unicode) [edit]
  98. on | off | tgl display tangents in the editor
  99. - displayActiveKeys : dak (unicode) [edit]
  100. on | off | tgl display tangents in the editor
  101. - displayInfinities : di (unicode) [edit]
  102. on | off | tgl display infinities in the editor
  103. - displayKeys : dk (unicode) [edit]
  104. on | off | tgl display keyframes in the editor
  105. - displayNormalized : dn (bool) [query,edit]
  106. When on, display all curves normalized to the range -1 to +1.
  107. - displayTangents : dtn (unicode) [edit]
  108. on | off | tgl display tangents in the editor
  109. - docTag : dtg (unicode) [create,query,edit]
  110. Attaches a tag to the Maya editor.
  111. - exists : ex (bool) [create]
  112. Returns true|false depending upon whether the specified object exists. Other flags are ignored.
  113. - filter : f (unicode) [create,query,edit]
  114. Specifies the name of an itemFilter object to be placed on this editor. This filters the information coming onto the
  115. main list of the editor.
  116. - forceMainConnection : fmc (unicode) [create,query,edit]
  117. Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will
  118. only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in
  119. that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the
  120. -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.
  121. - highlightConnection : hlc (unicode) [create,query,edit]
  122. Specifies the name of a selectionConnection object which the editor will synchronize with its highlight list. Not all
  123. editors have a highlight list. For those that do, it is a secondary selection list.
  124. - lockMainConnection : lck (bool) [create,edit]
  125. Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor.
  126. Further changes to the original mainConnection are ignored.
  127. - lookAt : la (unicode) [edit]
  128. all | selected | currentTime fitView helpers
  129. - mainListConnection : mlc (unicode) [create,query,edit]
  130. Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will
  131. only display items contained in the selectionConnection object.
  132. - menu : m (script) [create]
  133. Specify a script to be run when the editor is created. The function will be passed one string argument which is the new
  134. editor's name.
  135. - normalizeCurvesCommand : ncc (unicode) [create,edit]
  136. Sets the script which is run to normalize curves in the graph editor. This is intended for internal use only.
  137. - panel : pnl (unicode) [create,query]
  138. Specifies the panel that the editor belongs to. By default if an editor is created in the create callback of a scripted
  139. panel it will belong to that panel. If an editor doesn't belong to a panel it will be deleted when the window that it
  140. is in is deleted.
  141. - parent : p (unicode) [create,query,edit]
  142. Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
  143. - preSelectionHighlight : psh (bool) [query,edit]
  144. When on, the curve/key/tangent under the mouse pointer is highlighted to ease selection.
  145. - renormalizeCurves : rnc (bool) [edit]
  146. This flag causes the curve normalization factors to be recalculated.
  147. - resultSamples : rs (time) [query,edit]
  148. Specify the sampling for result curves Note: the smaller this number is, the longer it will take to update the display.
  149. - resultScreenSamples : rss (int) [query,edit]
  150. Specify the screen base result sampling for result curves. If 0, then results are sampled in time.
  151. - resultUpdate : ru (unicode) [query,edit]
  152. Valid values: interactivedelayedControls how changes to animCurves are reflected in the result curves (if results are
  153. being shown). If resultUpdate is interactive, then as interactive changes are being made to the animCurve, the result
  154. curves will be updated. If modelUpdate is delayed (which is the default setting), then result curves are updated once
  155. the final change to an animCurve has been made.
  156. - selectionConnection : slc (unicode) [create,query,edit]
  157. Specifies the name of a selectionConnection object which the editor will synchronize with its own selection list. As
  158. the user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes
  159. changes, the editor updates to show the change.
  160. - showBufferCurves : sb (unicode) [query,edit]
  161. Valid values: onofftglDisplay buffer curves.
  162. - showResults : sr (unicode) [query,edit]
  163. Valid values: onofftglDisplay result curves from expression or other non-keyed action.
  164. - showUpstreamCurves : suc (bool) [query,edit]
  165. If true, the dependency graph is searched upstream for all curves that drive the selected plugs (showing multiple curves
  166. for example in a typical driven key setup, where first the driven key curve is encountered, followed by the actual
  167. animation curve that drives the source object). If false, only the first curves encountered will be shown. Note that,
  168. even if false, multiple curves can be shown if e.g. a blendWeighted node is being used to combine multiple curves.
  169. - smoothness : s (unicode) [query,edit]
  170. Valid values: coarseroughmediumfineSpecify the display smoothness of animation curves.
  171. - snapTime : st (unicode) [query,edit]
  172. none | integer | keyframe keyframe move snap in time
  173. - snapValue : sv (unicode) [query,edit]
  174. none | integer | keyframe keyframe move snap in values
  175. - stackedCurves : sc (bool) [query,edit]
  176. Switches the display mode between normal (all curves sharing one set of axes) to stacked (each curve on its own value
  177. axis, stacked vertically).
  178. - stackedCurvesMax : scx (float) [query,edit]
  179. Sets the maximum value on the per-curve value axis when in stacked mode.
  180. - stackedCurvesMin : scm (float) [query,edit]
  181. Sets the minimum value on the per-curve value axis when in stacked mode.
  182. - stackedCurvesSpace : scs (float) [query,edit]
  183. Sets the spacing between curves when in stacked mode.
  184. - stateString : sts (bool) [query]
  185. Query only flag. Returns the MEL command that will edit an editor to match the current editor state. The returned
  186. command string uses the string variable $editorName in place of a specific name.
  187. - unParent : up (bool) [create,edit]
  188. Specifies that the editor should be removed from its layout. This cannot be used with query.
  189. - unlockMainConnection : ulk (bool) [create,edit]
  190. Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic
  191. updates.
  192. - updateMainConnection : upd (bool) [create,edit]
  193. Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
  194. - useTemplate : ut (unicode) [create]
  195. Force the command to use a command template other than the current one.
  196. Derived from mel command `maya.cmds.animCurveEditor`
  197. """
  198. pass
  199. def animDisplay(*args, **kwargs):
  200. """
  201. This command changes certain display options used by animation windows. In query mode, return type is based on queried
  202. flag.
  203. Flags:
  204. - modelUpdate : upd (unicode) [create,query,edit]
  205. Controls how changes to animCurves are propagated through the dependency graph. Valid modes are none, interactiveor
  206. delayed. If modelUpdate is nonethen changing an animCurve will not cause the model to be updated (change currentTime in
  207. order to update the model). If modelUpdate is interactive(which is the default setting), then as interactive changes
  208. are being made to the animCurve, the model will be updated. If modelUpdate is delayed, then the model is updated once
  209. the final change to an animCurve has been made. With modelUpdate set to either interactiveor delayed, changes to
  210. animCurves made via commands will also cause the model to be updated. Flag can have multiple
  211. arguments, passed either as a tuple or a list.
  212. - timeCode : tc (bool) [create,query,edit]
  213. Controls whether the animation windows (time slider, graph editor and dope sheet) use time codes in their displays.
  214. - timeCodeOffset : tco (unicode) [create,query,edit]
  215. This flag has now been deprecated. It still exists to not break legacy scripts, but it will now do nothing. See the
  216. new timeCode command to set and query timeCodes.
  217. Derived from mel command `maya.cmds.animDisplay`
  218. """
  219. pass
  220. def animLayer(*args, **kwargs):
  221. """
  222. This command creates and edits animation layers.
  223. Modifications:
  224. - returns a PyNode object for flags: (query and (root or bestLayer or parent))
  225. - returns a list of PyNode objects for flags: (query and (children or attribute or bestAnimLayer or animCurves or baseAnimCurves or blendNodes or affectedLayers or parent))
  226. Flags:
  227. - addSelectedObjects : aso (bool) [create,query,edit]
  228. Adds selected object(s) to the layer.
  229. - affectedLayers : afl (bool) [query]
  230. Return the layers that the currently selected object(s) are members of
  231. - animCurves : anc (bool) [create,query,edit]
  232. In query mode returns the anim curves associated with this layer
  233. - attribute : at (unicode) [create,query,edit]
  234. Adds a specific attribute on a object to the layer.
  235. - baseAnimCurves : bac (bool) [create,query,edit]
  236. In query mode returns the base layer anim curves associated with this layer, if any.
  237. - bestAnimLayer : blr (bool) [create,query,edit]
  238. In query mode returns the best anim layers for keying for the selected objects. If used in conjunction with -at, will
  239. return the best anim layers for keying for the specific plugs (attributes) specified.
  240. - bestLayer : bl (bool) [query]
  241. Return the layer that will be keyed for specified attribute.
  242. - blendNodes : bld (bool) [create,query,edit]
  243. In query mode returns the blend nodes associated with this layer
  244. - children : c (unicode) [query]
  245. Get the list of children layers. return value is a string array.
  246. - collapse : col (bool) [create,query,edit]
  247. Determine if a layer is collapse in the layer editor.
  248. - copy : cp (unicode) [edit]
  249. Copy from layer.
  250. - copyAnimation : ca (unicode) [create,edit]
  251. copy animation from specified layer to destination layer, only animation that are on attribute layered by both layer
  252. that are concerned.
  253. - copyNoAnimation : cna (unicode) [edit]
  254. Copy from layer without the animation curves.
  255. - excludeBoolean : ebl (bool) [create,query,edit]
  256. When adding selected object(s) to the layer, excludes any boolean attributes.
  257. - excludeDynamic : edn (bool) [create,query,edit]
  258. When adding selected object(s) to the layer, excludes any dynamic attributes.
  259. - excludeEnum : een (bool) [create,query,edit]
  260. When adding selected object(s) to the layer, excludes any enum attributes.
  261. - excludeRotate : ert (bool) [create,query,edit]
  262. When adding selected object(s) to the layer, exclude the rotate attribute.
  263. - excludeScale : esc (bool) [create,query,edit]
  264. When adding selected object(s) to the layer, exclude the scale attribute.
  265. - excludeTranslate : etr (bool) [create,query,edit]
  266. When adding selected object(s) to the layer, excludes the translate attribute.
  267. - excludeVisibility : evs (bool) [create,query,edit]
  268. When adding selected object(s) to the layer, exclude the visibility attribute.
  269. - exists : ex (bool) [query]
  270. Determine if an layer exists.
  271. - extractAnimation : ea (unicode) [create,edit]
  272. transfer animation from specified layer to destination layer, only animation that are on attribute layered by both layer
  273. that are concerned.
  274. - findCurveForPlug : fcv (unicode) [edit]
  275. - forceUIRebuild : fur (bool) [create]
  276. rebuilds the animation layers user interface. Flag can have multiple arguments,
  277. passed either as a tuple or a list.
  278. - forceUIRefresh : uir (bool) [create]
  279. refreshes the animation layers user interface.
  280. - layeredPlug : lp (unicode) [query]
  281. returns the plug on the blend node corresponding to the specified layer
  282. - lock : l (bool) [create,query,edit]
  283. Set the lock state of the specified layer. A locked layer can not receive key. Default is false.
  284. - moveLayerAfter : mva (unicode) [edit]
  285. Move layer after the specified layer
  286. - moveLayerBefore : mvb (unicode) [edit]
  287. Move layer before the specified layer
  288. - mute : m (bool) [create,query,edit]
  289. Set the mute state of the specified layer. Default is false.
  290. - override : o (bool) [create,query,edit]
  291. Set the overide state of the specified layer. Default is false.
  292. - parent : p (unicode) [create,query,edit]
  293. Set the parent of the specified layer. Default is the animation layer root.
  294. - passthrough : pth (bool) [create,query,edit]
  295. Set the passthrough state of the specified layer. Default is true.
  296. - preferred : prf (bool) [create,query,edit]
  297. Determine if a layer is a preferred layer, the best layer algorithm will try to set keyframe in preferred layer first.
  298. - removeAllAttributes : raa (bool) [edit]
  299. Remove all objects from layer.
  300. - removeAttribute : ra (unicode) [edit]
  301. Remove object from layer.
  302. - root : r (unicode) [query]
  303. Return the base layer if it exist
  304. - selected : sel (bool) [create,query,edit]
  305. Determine if a layer is selected, a selected layer will be show in the timecontrol, graph editor.
  306. - solo : s (bool) [create,query,edit]
  307. Set the solo state of the specified layer. Default is false.
  308. - weight : w (float) [create,query,edit]
  309. Set the weight of the specified layer between 0.0 and 1.0. Default is 1.
  310. - writeBlendnodeDestinations : wbd (bool) [edit]
  311. In edit mode writes the destination plugs of the blend nodes that belong to the layer into the blend node. This is used
  312. for layer import/export purposes and is not for general use.
  313. Derived from mel command `maya.cmds.animLayer`
  314. """
  315. pass
  316. def animView(*args, **kwargs):
  317. """
  318. This command allows you to specify the current view range within an animation editor. In query mode, return type is
  319. based on queried flag.
  320. Flags:
  321. - endTime : et (time) []
  322. End time to display within the editor
  323. - maxValue : max (float) []
  324. Upper value to display within the editor
  325. - minValue : min (float) []
  326. Lower value to display within the editor
  327. - nextView : nv (bool) [edit]
  328. Switches to the next view. Flag can have multiple arguments, passed either as a tuple or a list.
  329. - previousView : pv (bool) [edit]
  330. Switches to the previous view.
  331. - startTime : st (time) []
  332. Start time to display within the editor
  333. Derived from mel command `maya.cmds.animView`
  334. """
  335. pass
  336. def applyTake(*args, **kwargs):
  337. """
  338. This command takes data in a device (refered to as a take) and converts it into a form that may be played back and
  339. reviewed. The take can either be imported through the readTake action, or recorded by the recordDevice action. The take
  340. is either converted into animation curves or if the -preview flag is used, into blendDevice nodes. The command looks for
  341. animation curves attached to the target attributes of a device attachment. If animation curves exist, the take is pasted
  342. over the existing curves. If the curves do not exist, new animation curves are created. If devices are not specified,
  343. all of the devices with take data and that are enabled for applyTake, will have their data applied. See also:
  344. recordDevice, enableDevice, readTake, writeTake
  345. Flags:
  346. - channel : c (unicode) [create]
  347. This flag overrides the set channel enable value. If a channel is specified, it will be enabled. C: The default is all
  348. applyTake enabled channels for the device(s).
  349. - device : d (unicode) [create]
  350. Specifies which device contains the take. C: The default is all applyTake enabled devices.
  351. - filter : f (unicode) [create]
  352. This flag specifies the filters to use during the applyTake. If this flag is used multiple times, the ordering of the
  353. filters is from left to right. C: The default is no filters.
  354. - preview : p (bool) [create]
  355. Applies the take to blendDevice nodes attached to the target attributes connected to the device attachments. Animation
  356. curves attached to the attributes will not be altered, but for the time that preview data is defined, the preview data
  357. will be the data used during playback. C: The default is to not preview.
  358. - recurseChannel : rc (bool) [create]
  359. When this flag is used, the children of the channel(s) specified by -c/channel are also applied. C: The default is all
  360. of the enabled channels.
  361. - reset : r (bool) [create]
  362. Resets the blendDevice nodes affected by -preview. The preview data is removed and if animation curves exist, they are
  363. used during playback. Flag can have multiple arguments, passed either as a tuple or a list.
  364. - specifyChannel : sc (bool) [create]
  365. This flag is used with -c/channel flag. When used, applyTake will only work on the channels listed with the -c/channel
  366. flag. C: The default is all of the enabled channels.
  367. - startTime : st (time) [create]
  368. The default start time for a take is determined at record time. The startTime option sets the starting time of the take
  369. in the current animation units. C: The default is the first time stamp of the take. If a time stamp does not exist for
  370. the take, 0 is used.
  371. Derived from mel command `maya.cmds.applyTake`
  372. """
  373. pass
  374. def autoKeyframe(*args, **kwargs):
  375. """
  376. With no flags, this command will set keyframes on all attributes that have been modified since an autoKeyframe -state
  377. oncommand was issued. To stop keeping track of modified attributes, use autoKeyframe -state offautoKeyframe does not
  378. create new animation curves. An attribute must have already been keyframed (with the setKeyframe command) for
  379. autoKeyframe to add new keyframes for modified attributes. You can also query the current state of autoKeyframing with
  380. autoKeyframe -query -state.
  381. Flags:
  382. - characterOption : co (unicode) [create,query,edit]
  383. Valid options are: standard, all. Dictates whether when auto-keying characters the auto-key works as usual or whether it
  384. keys all of the character attributes. Default is standard. Flag can have multiple arguments,
  385. passed either as a tuple or a list.
  386. - noReset : nr (bool) []
  387. - state : st (bool) [create,query,edit]
  388. turns on/off remembering of modified attributes
  389. Derived from mel command `maya.cmds.autoKeyframe`
  390. """
  391. pass
  392. def bakeClip(*args, **kwargs):
  393. """
  394. This command is used to bake clips and blends into a single clip.
  395. Flags:
  396. - blend : b (int, int) [create]
  397. Specify the indicies of the clips being blended.
  398. - clipIndex : ci (int) [create]
  399. Specify the index of the clip to bake.
  400. - keepOriginals : k (bool) [create]
  401. Keep original clips in the trax editor and place the merged clip into the visor. The default is to schedule the merged
  402. clip, and to keep the original clips in the visor. Flag can have multiple
  403. arguments, passed either as a tuple or a list.
  404. - name : n (unicode) [create]
  405. Specify the name of the new clip to create.
  406. Derived from mel command `maya.cmds.bakeClip`
  407. """
  408. pass
  409. def bakeResults(*args, **kwargs):
  410. """
  411. This command allows the user to replace a chain of dependency nodes which define the value for an attribute with a
  412. single animation curve. Command allows the user to specify the range and frequency of sampling. This command operates on
  413. a keyset. A keyset is defined as a group of keys within a specified time range on one or more animation curves. The
  414. animation curves comprising a keyset depend on the value of the -animationflag: keysOrObjects: Any active keys, when no
  415. target objects or -attribute flags appear on the command line, orAll animation curves connected to all keyframable
  416. attributes of objects specified as the command line's targetList, when there are no active keys.keys: Only act on active
  417. keys or tangents. If there are no active keys or tangents, don't do anything. objects: Only act on specified objects.
  418. If there are no objects specified, don't do anything. Note that the -animationflag can be used to override the curves
  419. uniquely identified by the multi-use -attributeflag, which takes an argument of the form attributeName, such as
  420. translateX. Keys on animation curves are identified by either their time values or their indices. Times and indices
  421. should be specified as a range, as shown below. -time 10:20means all keys in the range from 10 to 20, inclusive, in the
  422. current time unit.-index 1:5means the 2nd, 3rd, 4th, 5th, and 6th keys of each animation curve.
  423. Flags:
  424. - animation : an (unicode) [create]
  425. Where this command should get the animation to act on. Valid values are objects,keys,and keysOrObjectsDefault:
  426. keysOrObjects.(See Description for details.)
  427. - attribute : at (unicode) [create]
  428. List of attributes to select
  429. - bakeOnOverrideLayer : bol (bool) [create]
  430. If true, all layered and baked attribute will be added as a top override layer. Flag can have multiple
  431. arguments, passed either as a tuple or a list.
  432. - controlPoints : cp (bool) [create]
  433. This flag explicitly specifies whether or not to include the control points of a shape (see -sflag) in the list of
  434. attributes. Default: false. (Not valid for pasteKeycmd.)
  435. - destinationLayer : dl (unicode) []
  436. - disableImplicitControl : dic (bool) [create]
  437. Whether to disable implicit control after the anim curves are obtained as the result of this command. An implicit
  438. control to an attribute is some function that affects the attribute without using an explicit dependency graph
  439. connection. The control of IK, via ik handles, is an example.
  440. - float : f (floatrange) [create]
  441. value uniquely representing a non-time-based key (or key range) on a time-based animCurve. Valid floatRange include
  442. single values (-f 10) or a string with a lower and upper bound, separated by a colon (-f 10:20
  443. - hierarchy : hi (unicode) [create]
  444. Hierarchy expansion options. Valid values are above,below,both,and none.(Not valid for pasteKeycmd.)
  445. - includeUpperBound : iub (bool) [create]
  446. When the -t/time or -f/float flags represent a range of keys, this flag determines whether the keys at the upper bound
  447. of the range are included in the keyset. Default value: true. This flag is only valid when the argument to the -t/time
  448. flag is a time range with a lower and upper bound. (When used with the pasteKeycommand, this flag refers only to the
  449. time range of the target curve that is replaced, when using options such as replace,fitReplace,or scaleReplace.This flag
  450. has no effect on the curve pasted from the clipboard.)
  451. - index : index (int) [create]
  452. index of a key on an animCurve
  453. - minimizeRotation : mr (unicode) []
  454. - preserveOutsideKeys : pok (bool) [create]
  455. Whether to preserve keys that are outside the bake range when there are directly connected animation curves or a
  456. pairBlend node which has an animation curve as its direct input. The default (false) is to remove frames outside the
  457. bake range. If the channel that you are baking is not controlled by a single animation curve, then a new animation
  458. curve will be created with keys only in the bake range. In the case of pairBlend-driven channels, setting pok to true
  459. will retain both the pairBlend and its input animCurve. The blended values will be baked onto the animCurve and the
  460. weight of the pairBlend weight will be keyed to the animCurve during the baked range.
  461. - removeBakedAttributeFromLayer : ral (bool) [create]
  462. If true, all baked attribute will be removed from the layer. Otherwise all layer associated with the baked attribute
  463. will be muted.
  464. - resolveWithoutLayer : rwl (unicode) []
  465. - sampleBy : sb (time) [create]
  466. Amount to sample by. Default is 1.0 in current timeUnit
  467. - shape : s (bool) [create]
  468. Consider attributes of shapes below transforms as well, except controlPoints. Default: true. (Not valid for
  469. pasteKeycmd.)
  470. - simulation : sm (bool) [create]
  471. Using this flag instructs the command to preform a simulation instead of just evaluating each attribute separately over
  472. the range of time. The simulation flag is required to bake animation that that depends on the whole scene being
  473. evaluated at each time step such as dynamics. The default is false.
  474. - smart : sr ([, <type 'bool'>, <type 'float'>, ]) []
  475. - sparseAnimCurveBake : sac (bool) [create]
  476. When this is true and anim curves are being baked, do not insert any keys into areas of the curve where animation is
  477. defined. And, use as few keys as possible to bake the pre and post infinity behavior. When this is false, one key will
  478. be inserted at each time step. The default is false.
  479. - time : t (timerange) [create]
  480. time uniquely representing a key (or key range) on a time-based animCurve. Valid timeRanges include single values (-t
  481. 10) or a string with a lower and upper bound, separated by a colon (-t 10:20
  482. Derived from mel command `maya.cmds.bakeResults`
  483. """
  484. pass
  485. def bakeSimulation(*args, **kwargs):
  486. """
  487. This command operates on a keyset. A keyset is defined as a group of keys within a specified time range on one or more
  488. animation curves. The animation curves comprising a keyset depend on the value of the -animationflag: keysOrObjects: Any
  489. active keys, when no target objects or -attribute flags appear on the command line, orAll animation curves connected to
  490. all keyframable attributes of objects specified as the command line's targetList, when there are no active keys.keys:
  491. Only act on active keys or tangents. If there are no active keys or tangents, don't do anything. objects: Only act on
  492. specified objects. If there are no objects specified, don't do anything. Note that the -animationflag can be used to
  493. override the curves uniquely identified by the multi-use -attributeflag, which takes an argument of the form
  494. attributeName, such as translateX. Keys on animation curves are identified by either their time values or their indices.
  495. Times and indices can be given individually or as part of a list or range. -time 10palmeans the key at frame 10 (PAL
  496. format).-time 1.0sec -time 15ntsc -time 20means the keys at time 1.0 second, frame 15 (in NTSC format), and time 20 (in
  497. the currently defined global time unit).-time 10:20means all keys in the range from 10 to 20, inclusive, in the current
  498. time unit.Omitting one end of a range means go to infinity, as in the following examples: -time 10:means all keys from
  499. time 10 (in the current time unit) onwards.-time :10means all keys up to (and including) time 10 (in the current time
  500. unit).-time :is a short form to specify all keys.-index 0means the first key of each animation curve. (Indices are
  501. 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
  502. of each animation curve.The bakeSimulation command is obsolete. Instead, bakeResults -simulation trueshould be used.
  503. The bakeSimulation command has retained for backwards compatibility. This command allows the user to replace a chain of
  504. dependency nodes, or implicit relationship, such as those between joints and IK handles, which define the value of an
  505. attribute, with a single animation curve. Command allows the user to specify the range and frequency of sampling. Unlike
  506. the bakeResults command, this command will actually set the time of the current scene to all the times, in sequence,
  507. inside the given time interval before it sets the time back to when it is started. As a result, it may modify the scene.
  508. In query mode, return type is based on queried flag.
  509. Flags:
  510. - animation : an (unicode) [create]
  511. Where this command should get the animation to act on. Valid values are objects,keys,and keysOrObjectsDefault:
  512. keysOrObjects.(See Description for details.)
  513. - attribute : at (unicode) [create]
  514. List of attributes to select
  515. - bakeOnOverrideLayer : bol (bool) []
  516. - controlPoints : cp (bool) [create]
  517. This flag explicitly specifies whether or not to include the control points of a shape (see -sflag) in the list of
  518. attributes. Default: false. (Not valid for pasteKeycmd.)
  519. - destinationLayer : dl (unicode) []
  520. - disableImplicitControl : dic (bool) [create]
  521. Whether to disable implicit control after the anim curves are obtained as the result of this command. An implicit
  522. control to an attribute is some function that affects the attribute without using an explicit dependency graph
  523. connection. The control of IK, via ik handles, is an example.
  524. - float : f (floatrange) [create]
  525. value uniquely representing a non-time-based key (or key range) on a time-based animCurve. Valid floatRange include
  526. single values (-f 10) or a string with a lower and upper bound, separated by a colon (-f 10:20
  527. - hierarchy : hi (unicode) [create]
  528. Hierarchy expansion options. Valid values are above,below,both,and none.(Not valid for pasteKeycmd.)
  529. - includeUpperBound : iub (bool) [create]
  530. When the -t/time or -f/float flags represent a range of keys, this flag determines whether the keys at the upper bound
  531. of the range are included in the keyset. Default value: true. This flag is only valid when the argument to the -t/time
  532. flag is a time range with a lower and upper bound. (When used with the pasteKeycommand, this flag refers only to the
  533. time range of the target curve that is replaced, when using options such as replace,fitReplace,or scaleReplace.This flag
  534. has no effect on the curve pasted from the clipboard.)
  535. - index : index (int) [create]
  536. index of a key on an animCurve
  537. - minimizeRotation : mr (unicode) []
  538. - preserveOutsideKeys : pok (bool) [create]
  539. Whether to preserve keys that are outside the bake range when there are directly connected animation curves. The
  540. default (false) is to remove frames outside the bake range. If the channel that you are baking is not controlled by a
  541. single animation curve, then a new animation curve will be created with keys only in the bake range.
  542. - removeBakedAttributeFromLayer : ral (bool) []
  543. - resolveWithoutLayer : rwl (unicode) []
  544. - sampleBy : sb (time) [create]
  545. Amount to sample by. Default is 1.0 in current timeUnit
  546. - shape : s (bool) [create]
  547. Consider attributes of shapes below transforms as well, except controlPoints. Default: true. (Not valid for
  548. pasteKeycmd.)
  549. - simulation : sm (bool) [create]
  550. Using this flag instructs the command to preform a simulation instead of just evaluating each attribute separately over
  551. the range of time. The simulation flag is required to bake animation that that depends on the whole scene being
  552. evaluated at each time step such as dynamics. The default is true.
  553. - smart : sr ([, <type 'bool'>, <type 'float'>, ]) []
  554. - sparseAnimCurveBake : sac (bool) [create]
  555. When baking anim curves, do not insert any keys into areas of the curve where animation is defined. And, use as few
  556. keys as possible to bake the pre and post infinity behaviors. When this is false, one key will be inserted at each time
  557. step. The default is false. Flag can have multiple arguments, passed either as a tuple or a
  558. list.
  559. - time : t (timerange) [create]
  560. time uniquely representing a key (or key range) on a time-based animCurve. Valid timeRanges include single values (-t
  561. 10) or a string with a lower and upper bound, separated by a colon (-t 10:20
  562. Derived from mel command `maya.cmds.bakeSimulation`
  563. """
  564. pass
  565. def bindSkin(*args, **kwargs):
  566. """
  567. This command binds the currently selected objects to the currently selected skeletons. Shapes which can be bound are:
  568. meshes, nurbs curves, nurbs surfaces, lattices, subdivision surfaces, and API shapes. Multiple shapes and multiple
  569. skeletons can be bound at once by selecting them or specifying them on the command line. Selection order is not
  570. important.The skin is bound using the so-called rigidbind, in which the components are rigidly attached to the closest
  571. bone in the skeleton. Flexors can later be added to the skeleton to smooth out the skinning around joints.The skin(s)
  572. can be bound either to the entire skeleton hierarchy of the selected joint(s), or to only the selected joints. The
  573. entire hierarchy is the default. The -tsb/-toSelectedBones flag allows binding to only the selected bones.This command
  574. can also be used to detach the skin from the skeleton. Detaching the skin is useful in a variety of situations, such as:
  575. inserting additional bones, deleting bones, changing the bind position of the skeleton or skin, or simply getting rid of
  576. the skinning nodes altogether. The options to use when detaching the skin depend on how much of the skinning info you
  577. want to get rid of. Namely: (1) -delete or -unbind: remove all skinning nodes, (2) -unbindKeepHistory: remove the
  578. skinning sets, but keep the weights, (3) -disable: disable the skinning but keep the skinning sets and the weights.
  579. Flags:
  580. - byClosestPoint : bcp (bool) [create]
  581. bind each point in the object to the segment closest to the point. The byClosestPoint and byPartition flags are mutually
  582. exclusive. The byClosestPoint flag is the default.
  583. - byPartition : bp (bool) [create]
  584. bind each group in the partition to the segment closest to the group's centroid. A partition must be specified with the
  585. -p/-partition flag
  586. - colorJoints : cj (bool) [create]
  587. In bind mode, this flag assigns colors to the joints based on the colors assigned to the joint's skin set. In delete and
  588. unlock mode, this flag removes the colors from joints that are no longer bound as skin. In disable and unbindKeepHistory
  589. mode, this flag does nothing.
  590. - delete : d (bool) [create]
  591. Detach the skin on the selected skeletons and remove all bind- related construction history.
  592. - doNotDescend : dnd (bool) [create]
  593. Do not descend to shapes that are parented below the selected object(s). Bind only the selected objects.
  594. - enable : en (bool) [create]
  595. Enable or disable a bind that has been disabled on the selected skeletons. To enable the bind on selected bones only,
  596. select the bones and use the -tsb flag with the -en flag. This flag is used when you want to temporarily disable the
  597. bind without losing the set information or the weight information of the skinning, for example if you want to modify the
  598. bindPose.
  599. - name : n (unicode) [create]
  600. This flag is obsolete. Flag can have multiple arguments, passed either as a tuple or a list.
  601. - partition : p (unicode) [create]
  602. Specify a partition to bind by. This is only valid when used with the -bp/-byPartition flag.
  603. - toAll : ta (bool) [create]
  604. objects will be bound to the entire selected skeletons. Even bones with zero influence will be bound, whereas the
  605. toSkeleton will only bind non-zero influences.
  606. - toSelectedBones : tsb (bool) [create]
  607. objects will be bound to the selected bones only.
  608. - toSkeleton : ts (bool) [create]
  609. objects will be bound to the selected skeletons. The toSkeleton, toAll and toSelectedBones flags are mutually exclusive.
  610. The toSkeleton flag is the default.
  611. - unbind : ub (bool) [create]
  612. unbind the selected objects. They will no longer move with the skeleton. Any bindSkin history that is no longer used
  613. will be deleted.
  614. - unbindKeepHistory : ubk (bool) [create]
  615. unbind the selected objects. They will no longer move with the skeleton. However, existing weights on the skin will be
  616. kept for use the next time the skin is bound. This option is appropriate if you want to modify the skeleton without
  617. losing the weighting information on the skin.
  618. - unlock : ul (bool) [create]
  619. unlock the selected objects. Since bindSkin will no longer give normal results if bound objects are moved away from the
  620. skeleton, bindSkin locks translate, rotate and scale. This command unlocks the selected objects translate, rotate and
  621. scale.
  622. Derived from mel command `maya.cmds.bindSkin`
  623. """
  624. pass
  625. def blendShape(*args, **kwargs):
  626. """
  627. This command creates a blendShape deformer, which blends in specified amounts of each target shape to the initial base
  628. shape. Each base shape is deformed by its own set of target shapes. Every target shape has an index that associates it
  629. with one of the shape weight values.In the create mode the first item on the selection list is treated as the base and
  630. the remaining inputs as targets. If the first item on the list has multiple shapes grouped beneath it, the targets must
  631. have an identical shape hierarchy. Additional base shapes can be added in edit mode using the deformers -g flag.
  632. Flags:
  633. - after : af (bool) [create,edit]
  634. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  635. flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape
  636. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  637. - afterReference : ar (bool) []
  638. - before : bf (bool) [create,edit]
  639. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  640. flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape
  641. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  642. - deformerTools : dt (bool) [query]
  643. Returns the name of the deformer tool objects (if any) as string string ...
  644. - envelope : en (float) [create,query,edit]
  645. Set the envelope value for the deformer, controlling how much of the total deformation gets applied. Default is 1.0.
  646. - exclusive : ex (unicode) [create,query]
  647. Puts the deformation set in a deform partition.
  648. - frontOfChain : foc (bool) [create,edit]
  649. This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and
  650. skin nodes in the shape's history (but not ahead of existing tweak nodes). The input to the deformer will be the
  651. upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the
  652. downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and
  653. edit mode if the deformer has no geometry added yet).
  654. - geometry : g (unicode) [query,edit]
  655. The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is
  656. also specified. When queried, this flag returns string string string ...
  657. - geometryIndices : gi (bool) []
  658. - ignoreSelected : ignoreSelected (bool) [create]
  659. Tells the command to not deform objects on the current selection list
  660. - inBetween : ib (bool) [create,edit]
  661. Indicate that the specified target should serve as an inbetween. An inbetween target is one that serves as an
  662. intermediate target between the base shape and another target.
  663. - name : n (unicode) [create]
  664. Used to specify the name of the node being created
  665. - normalizationGroups : ng (bool) []
  666. - origin : o (unicode) [create]
  667. blendShape will be performed with respect to the world by default. Valid values are worldand local. The local flag will
  668. cause the blend shape to be performed with respect to the shape's local origin. Flag can have multiple
  669. arguments, passed either as a tuple or a list.
  670. - parallel : par (bool) [create,edit]
  671. Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is
  672. inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry
  673. added yet).
  674. - prune : pr (bool) [edit]
  675. Removes any points not being deformed by the deformer in its current configuration from the deformer set.
  676. - remove : rm (bool) [edit]
  677. Specifies that objects listed after the -g flag should be removed from this deformer.
  678. - split : sp (bool) [create,edit]
  679. Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing
  680. chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
  681. - target : t (unicode, int, unicode, float) [create,query,edit]
  682. Set target object as the index target shape for the base shape base object. The full influence of target shape takes
  683. effect when its shape weight is targetValue. Parameter list: string: the base objectint: indexstring: the target
  684. objectdouble: target value
  685. - topologyCheck : tc (bool) [create]
  686. Set the state of checking for a topology match between the shapes being blended. Default is on.
  687. - weight : w (int, float) [create,query,edit]
  688. Set the weight value (second parameter) at index (first parameter).
  689. - weightCount : wc (int) [create,query,edit]
  690. Set the number of shape weight values.
  691. Derived from mel command `maya.cmds.blendShape`
  692. """
  693. pass
  694. def blendShapeEditor(*args, **kwargs):
  695. """
  696. This command creates an editor that derives from the base editor class that has controls for blendShape, control nodes.
  697. Flags:
  698. - control : ctl (bool) [query]
  699. Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus.
  700. Caution: It is possible, at times, for an editor to exist without a control. This flag returns NONEif no control is
  701. present.
  702. - defineTemplate : dt (unicode) [create]
  703. Puts a command in a mode where any other flags and args are parsed and added to the command template specified in the
  704. argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set
  705. as the current template.
  706. - docTag : dtg (unicode) [create,query,edit]
  707. Attaches a tag to the Maya editor.
  708. - exists : ex (bool) [create]
  709. Returns true|false depending upon whether the specified object exists. Other flags are ignored.
  710. - filter : f (unicode) [create,query,edit]
  711. Specifies the name of an itemFilter object to be placed on this editor. This filters the information coming onto the
  712. main list of the editor.
  713. - forceMainConnection : fmc (unicode) [create,query,edit]
  714. Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will
  715. only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in
  716. that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the
  717. -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.
  718. - highlightConnection : hlc (unicode) [create,query,edit]
  719. Specifies the name of a selectionConnection object which the editor will synchronize with its highlight list. Not all
  720. editors have a highlight list. For those that do, it is a secondary selection list.
  721. - lockMainConnection : lck (bool) [create,edit]
  722. Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor.
  723. Further changes to the original mainConnection are ignored.
  724. - mainListConnection : mlc (unicode) [create,query,edit]
  725. Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will
  726. only display items contained in the selectionConnection object.
  727. - panel : pnl (unicode) [create,query]
  728. Specifies the panel that the editor belongs to. By default if an editor is created in the create callback of a scripted
  729. panel it will belong to that panel. If an editor doesn't belong to a panel it will be deleted when the window that it
  730. is in is deleted.
  731. - parent : p (unicode) [create,query,edit]
  732. Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
  733. - selectionConnection : slc (unicode) [create,query,edit]
  734. Specifies the name of a selectionConnection object which the editor will synchronize with its own selection list. As
  735. the user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes
  736. changes, the editor updates to show the change.
  737. - stateString : sts (bool) [query]
  738. Query only flag. Returns the MEL command that will edit an editor to match the current editor state. The returned
  739. command string uses the string variable $editorName in place of a specific name.
  740. - targetControlList : tcl (bool) [query]
  741. - targetList : tl (bool) [query]
  742. Flag can have multiple arguments, passed either as a tuple or a list.
  743. - unParent : up (bool) [create,edit]
  744. Specifies that the editor should be removed from its layout. This cannot be used with query.
  745. - unlockMainConnection : ulk (bool) [create,edit]
  746. Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic
  747. updates.
  748. - updateMainConnection : upd (bool) [create,edit]
  749. Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
  750. - useTemplate : ut (unicode) [create]
  751. Force the command to use a command template other than the current one.
  752. - verticalSliders : vs (bool) [create,query,edit]
  753. Derived from mel command `maya.cmds.blendShapeEditor`
  754. """
  755. pass
  756. def blendShapePanel(*args, **kwargs):
  757. """
  758. This command creates a panel that derives from the base panel class that houses a blendShapeEditor.
  759. Flags:
  760. - blendShapeEditor : be (bool) [query]
  761. Query only flag that returns the name of an editor to be associated with the panel. Flag can have
  762. multiple arguments, passed either as a tuple or a list.
  763. - control : ctl (bool) [query]
  764. Returns the top level control for this panel. Usually used for getting a parent to attach popup menus. CAUTION: panels
  765. may not have controls at times. This flag can return if no control is present.
  766. - copy : cp (unicode) [edit]
  767. Makes this panel a copy of the specified panel. Both panels must be of the same type.
  768. - createString : cs (bool) []
  769. - defineTemplate : dt (unicode) [create]
  770. Puts a command in a mode where any other flags and args are parsed and added to the command template specified in the
  771. argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set
  772. as the current template.
  773. - docTag : dtg (unicode) [create,query,edit]
  774. Attaches a tag to the maya panel.
  775. - editString : es (bool) []
  776. - exists : ex (bool) [create]
  777. Returns true|false depending upon whether the specified object exists. Other flags are ignored.
  778. - init : init (bool) [create,edit]
  779. Initializes the panel's default state. This is usually done automatically on file -new and file -open.
  780. - isUnique : iu (bool) [query]
  781. Returns true if only one instance of this panel type is allowed.
  782. - label : l (unicode) [query,edit]
  783. Specifies the user readable label for the panel.
  784. - menuBarVisible : mbv (bool) [create,query,edit]
  785. Controls whether the menu bar for the panel is displayed.
  786. - needsInit : ni (bool) [query,edit]
  787. (Internal) On Edit will mark the panel as requiring initialization. Query will return whether the panel is marked for
  788. initialization. Used during file -new and file -open.
  789. - parent : p (unicode) [create]
  790. Specifies the parent layout for this panel.
  791. - popupMenuProcedure : pmp (script) [query,edit]
  792. Specifies the procedure called for building the panel's popup menu(s). The default value is buildPanelPopupMenu. The
  793. procedure should take one string argument which is the panel's name.
  794. - replacePanel : rp (unicode) [edit]
  795. Will replace the specifed panel with this panel. If the target panel is within the same layout it will perform a swap.
  796. - tearOff : to (bool) [query,edit]
  797. Will tear off this panel into a separate window with a paneLayout as the parent of the panel. When queried this flag
  798. will return if the panel has been torn off into its own window.
  799. - tearOffCopy : toc (unicode) [create]
  800. Will create this panel as a torn of copy of the specified source panel.
  801. - unParent : up (bool) [edit]
  802. Specifies that the panel should be removed from its layout. This (obviously) cannot be used with query.
  803. - useTemplate : ut (unicode) [create]
  804. Force the command to use a command template other than the current one.
  805. Derived from mel command `maya.cmds.blendShapePanel`
  806. """
  807. pass
  808. def blendTwoAttr(*args, **kwargs):
  809. """
  810. A blendTwoAttr nodes takes two inputs, and blends the values of the inputs from one to the other, into an output value.
  811. The blending of the two inputs uses a blending function, and the following formula: (1 - blendFunction) \* input[0] +
  812. blendFunction \* input[1] The blendTwoAttr command can be used to blend the animation of an object to transition
  813. smoothly between the animation of two other objects. When the blendTwoAttr command is issued, it creates a blendTwoAttr
  814. node on the specified attributes, and reconnects whatever was previously connected to the attributes to the new blend
  815. nodes. You may also specify which two attributes should be used to blend together. The driver is used when you want to
  816. keyframe an object after it is being animated by a blend node. The current driver index specifies which of the two
  817. blended attributes should be keyframed.
  818. Flags:
  819. - attribute : at (unicode) [create]
  820. A list of attributes for the selected nodes for which a blendTwoAttr node will be created.
  821. - attribute0 : at0 (PyNode) [create,query,edit]
  822. The attribute that should be connected to the first input of the new blendTwoAttr node. When queried, it returns a
  823. string.
  824. - attribute1 : at1 (PyNode) [create,query,edit]
  825. The attribute that should be connected to the second input of the new blendTwoAttr node. When queried, it returns a
  826. string.
  827. - blender : bl (PyNode) [create,query,edit]
  828. The blender attribute. This is the attribute that will be connected to the newly created blendTwoAttr node(s) blender
  829. attribute. This attribute controls how much of each of the two attributes to use in the blend. If this flag is not
  830. specified, a new animation curve is created whose value goes from 1 to 0 throughout the time range specified by the -t
  831. flag. If -t is not specified, an abrupt change from the value of the first to the value of the second attribute will
  832. occur at the current time when this command is issued.
  833. - controlPoints : cp (bool) [create]
  834. Explicitly specify whether or not to include the control points of a shape (see -sflag) in the list of attributes.
  835. Default: false. Flag can have multiple arguments, passed either as a tuple or a list.
  836. - driver : d (int) [create,query,edit]
  837. The index of the driver attribute for this blend node (0 or 1) When queried, it returns an integer.
  838. - name : n (unicode) [create,query]
  839. name for the new blend node(s)
  840. - shape : s (bool) [create]
  841. Consider all attributes of shapes below transforms as well, except controlPoints. Default: true
  842. - time : t (timerange) [create]
  843. The time range between which the blending between the 2 attributes should occur. If a single time is specified, then the
  844. blend will cause an abrupt change from the first to the second attribute at that time. If a range is specified, a
  845. smooth blending will occur over that time range. The default is to make a sudden transition at the current time.
  846. Derived from mel command `maya.cmds.blendTwoAttr`
  847. """
  848. pass
  849. def boneLattice(*args, **kwargs):
  850. """
  851. This command creates/edits/queries a boneLattice deformer. The name of the created/edited object is returned. Usually
  852. you would make use of this functionality through the higher level flexor command.
  853. Flags:
  854. - after : af (bool) [create,edit]
  855. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  856. flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape
  857. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  858. - afterReference : ar (bool) []
  859. - before : bf (bool) [create,edit]
  860. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  861. flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape
  862. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  863. - bicep : bi (float) [create,query,edit]
  864. Affects the bulging of lattice points on the inside of the bend. Positive/negative values cause the points to bulge
  865. outwards/inwards. Default value is 0.0. When queried, this flag returns a float.
  866. - deformerTools : dt (bool) [query]
  867. Returns the name of the deformer tool objects (if any) as string string ...
  868. - exclusive : ex (unicode) [create,query]
  869. Puts the deformation set in a deform partition.
  870. - frontOfChain : foc (bool) [create,edit]
  871. This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and
  872. skin nodes in the shape's history (but not ahead of existing tweak nodes). The input to the deformer will be the
  873. upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the
  874. downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and
  875. edit mode if the deformer has no geometry added yet).
  876. - geometry : g (unicode) [query,edit]
  877. The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is
  878. also specified. When queried, this flag returns string string string ...
  879. - geometryIndices : gi (bool) []
  880. - ignoreSelected : ignoreSelected (bool) [create]
  881. Tells the command to not deform objects on the current selection list
  882. - joint : j (unicode) [create,query,edit]
  883. Specifies which joint will be used to drive the bulging behaviors.
  884. - lengthIn : li (float) [create,query,edit]
  885. Affects the location of lattice points along the upper half of the bone. Positive/negative values cause the points to
  886. move away/towards the center of the bone. Changing this parameter also modifies the regions affected by the creasing,
  887. rounding and width parameters. Default value is 0.0. When queried, this flag returns a float.
  888. - lengthOut : lo (float) [create,query,edit]
  889. Affects the location of lattice points along the lower half of the bone. Positive/negative values cause the points to
  890. move away/towards the center of the bone. Changing this parameter also modifies the regions affected by the creasing,
  891. rounding and width parameters. Default value is 0.0. When queried, this flag returns a float.
  892. - name : n (unicode) [create]
  893. Used to specify the name of the node being created
  894. - parallel : par (bool) [create,edit]
  895. Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is
  896. inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry
  897. added yet).
  898. - prune : pr (bool) [edit]
  899. Removes any points not being deformed by the deformer in its current configuration from the deformer set.
  900. - remove : rm (bool) [edit]
  901. Specifies that objects listed after the -g flag should be removed from this deformer.
  902. - split : sp (bool) [create,edit]
  903. Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing
  904. chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
  905. - transform : t (unicode) [create]
  906. Specifies which dag node is being used to rigidly transform the lattice which this node is going to deform. If this
  907. flag is not specified an identity matrix will be assumed. Flag can have multiple arguments, passed
  908. either as a tuple or a list.
  909. - tricep : tr (float) [create,query,edit]
  910. Affects the bulging of lattice points on the outside of the bend. Positive/negative values cause the points to bulge
  911. outwards/inwards. Default value is 0.0. When queried, this flag returns a float.
  912. - widthLeft : wl (float) [create,query,edit]
  913. Affects the bulging of lattice points on the left side of the bend. Positive/negative values cause the points to bulge
  914. outwards/inwards. Default value is 0.0. When queried, this flag returns a float.
  915. - widthRight : wr (float) [create,query,edit]
  916. Affects the bulging of lattice points on the right side of the bend. Positive/negative values cause the points to bulge
  917. outwards/inwards. Default value is 0.0. When queried, this flag returns a float.
  918. Derived from mel command `maya.cmds.boneLattice`
  919. """
  920. pass
  921. def bufferCurve(*args, **kwargs):
  922. """
  923. This command operates on a keyset. A keyset is defined as a group of keys within a specified time range on one or more
  924. animation curves. The animation curves comprising a keyset depend on the value of the -animationflag: keysOrObjects: Any
  925. active keys, when no target objects or -attribute flags appear on the command line, orAll animation curves connected to
  926. all keyframable attributes of objects specified as the command line's targetList, when there are no active keys.keys:
  927. Only act on active keys or tangents. If there are no active keys or tangents, don't do anything. objects: Only act on
  928. specified objects. If there are no objects specified, don't do anything. Note that the -animationflag can be used to
  929. override the curves uniquely identified by the multi-use -attributeflag, which takes an argument of the form
  930. attributeName, such as translateX. Keys on animation curves are identified by either their time values or their indices.
  931. Times and indices can be given individually or as part of a list or range. -time 10palmeans the key at frame 10 (PAL
  932. format).-time 1.0sec -time 15ntsc -time 20means the keys at time 1.0 second, frame 15 (in NTSC format), and time 20 (in
  933. the currently defined global time unit).-time 10:20means all keys in the range from 10 to 20, inclusive, in the current
  934. time unit.Omitting one end of a range means go to infinity, as in the following examples: -time 10:means all keys from
  935. time 10 (in the current time unit) onwards.-time :10means all keys up to (and including) time 10 (in the current time
  936. unit).-time :is a short form to specify all keys.-index 0means the first key of each animation curve. (Indices are
  937. 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
  938. of each animation curve.This command helps manage buffer curve for animated objects
  939. Flags:
  940. - animation : an (unicode) [create]
  941. Where this command should get the animation to act on. Valid values are objects,keys,and keysOrObjectsDefault:
  942. keysOrObjects.(See Description for details.)
  943. - attribute : at (unicode) [create]
  944. List of attributes to select
  945. - controlPoints : cp (bool) [create]
  946. This flag explicitly specifies whether or not to include the control points of a shape (see -sflag) in the list of
  947. attributes. Default: false. (Not valid for pasteKeycmd.)
  948. - exists : ex (bool) [create]
  949. Returns true if a buffer curve currently exists on the specified attribute; false otherwise. Flag
  950. can have multiple arguments, passed either as a tuple or a list.
  951. - float : f (floatrange) [create]
  952. value uniquely representing a non-time-based key (or key range) on a time-based animCurve. Valid floatRange include
  953. single values (-f 10) or a string with a lower and upper bound, separated by a colon (-f 10:20
  954. - hierarchy : hi (unicode) [create]
  955. Hierarchy expansion options. Valid values are above,below,both,and none.(Not valid for pasteKeycmd.)
  956. - includeUpperBound : iub (bool) [create]
  957. When the -t/time or -f/float flags represent a range of keys, this flag determines whether the keys at the upper bound
  958. of the range are included in the keyset. Default value: true. This flag is only valid when the argument to the -t/time
  959. flag is a time range with a lower and upper bound. (When used with the pasteKeycommand, this flag refers only to the
  960. time range of the target curve that is replaced, when using options such as replace,fitReplace,or scaleReplace.This flag
  961. has no effect on the curve pasted from the clipboard.)
  962. - index : index (int) [create]
  963. index of a key on an animCurve
  964. - overwrite : ov (bool) [create]
  965. Create a buffer curve. truemeans create a buffer curve whether or not one already existed. falsemeans if a buffer
  966. curve exists already then leave it alone. If no flag is specified, then the command defaults to -overwrite false
  967. - shape : s (bool) [create]
  968. Consider attributes of shapes below transforms as well, except controlPoints. Default: true. (Not valid for
  969. pasteKeycmd.)
  970. - swap : sw (bool) [create]
  971. for animated attributes which have buffer curves, swap the buffer curve with the current animation curve
  972. - time : t (timerange) [create]
  973. time uniquely representing a key (or key range) on a time-based animCurve. Valid timeRanges include single values (-t
  974. 10) or a string with a lower and upper bound, separated by a colon (-t 10:20
  975. Derived from mel command `maya.cmds.bufferCurve`
  976. """
  977. pass
  978. def buildBookmarkMenu(*args, **kwargs):
  979. """
  980. This command handles building the dynamicBookmark menu, to show all bookmarks (sets) of a specified type (sets -text)
  981. menuName is the string returned by the menucommand.
  982. Flags:
  983. - editor : ed (unicode) [create]
  984. Name of the editor which this menu belongs to Flag can have multiple arguments, passed either as a
  985. tuple or a list.
  986. - type : typ (unicode) [create]
  987. Type of bookmark (sets -text) to display
  988. Derived from mel command `maya.cmds.buildBookmarkMenu`
  989. """
  990. pass
  991. def buildKeyframeMenu(*args, **kwargs):
  992. """
  993. This command handles building the dynamicKeyframe menu, to show attributes of currently selected objects, filtered by
  994. the current manipulator. menuName is the string returned by the menucommand. The target menu will entries appended to it
  995. (and deleted from it) to always show what's currently keyframable.
  996. Derived from mel command `maya.cmds.buildKeyframeMenu`
  997. """
  998. pass
  999. def character(*args, **kwargs):
  1000. """
  1001. This command is used to manage the membership of a character. Characters are a type of set that gathers together the
  1002. attributes of a node or nodes that a user wishes to animate as a single entity.
  1003. Flags:
  1004. - addElement : add (PyNode) [edit]
  1005. Adds the list of items to the given character. If some of the items cannot be added to the character because they are
  1006. in another character, the command will fail. When another character is passed to to -addElement, is is added as a sub
  1007. character. When a node is passed in, it is expanded into its keyable attributes, which are then added to the character.
  1008. - characterPlug : cp (bool) [query]
  1009. Returns the plug on the character that corresponds to the specified character member.
  1010. - clear : cl (PyNode) [edit]
  1011. An operation which removes all items from the given character.
  1012. - empty : em (bool) [create]
  1013. Indicates that the character to be created should be empty. (i.e. it ignores any arguments identifying objects to be
  1014. added to the character.
  1015. - excludeDynamic : ed (bool) [create]
  1016. When creating the character, exclude dynamic attributes.
  1017. - excludeRotate : er (bool) [create]
  1018. When creating the character, exclude rotate attributes from transform-type nodes.
  1019. - excludeScale : es (bool) [create]
  1020. When creating the character, exclude scale attributes from transform-type nodes.
  1021. - excludeTranslate : et (bool) [create]
  1022. When creating the character, exclude translate attributes from transform-type nodes. For example, if your character
  1023. contains joints only, perhaps you only want to include rotations in the character.
  1024. - excludeVisibility : ev (bool) [create]
  1025. When creating the character, exclude visibility attribute from transform-type nodes.
  1026. - flatten : fl (PyNode) [edit]
  1027. An operation that flattens the structure of the given character. That is, any characters contained by the given
  1028. character will be replaced by its members so that the character no longer contains other characters but contains the
  1029. other characters' members.
  1030. - forceElement : fe (PyNode) [edit]
  1031. For use in edit mode only. Forces addition of the items to the character. If the items are in another character which is
  1032. in the character partition, the items will be removed from the other character in order to keep the characters in the
  1033. character partition mutually exclusive with respect to membership.
  1034. - include : include (PyNode) [edit]
  1035. Adds the list of items to the given character. If some of the items cannot be added to the character, a warning will be
  1036. issued. This is a less strict version of the -add/addElement operation.
  1037. - intersection : int (PyNode) [query]
  1038. An operation that returns a list of items which are members of all the character in the list. In general, characters
  1039. should be mutually exclusive.
  1040. - isIntersecting : ii (PyNode) [query]
  1041. An operation which tests whether or not the characters in the list have common members. In general, characters should
  1042. be mutually exclusive, so this should always return false.
  1043. - isMember : im (PyNode) [query]
  1044. An operation which tests whether or not all the given items are members of the given character.
  1045. - library : lib (bool) [query]
  1046. Returns the clip library associated with this character, if there is one. A clip library will only exist if you have
  1047. created clips on your character.
  1048. - memberIndex : mi (int) [query]
  1049. Returns the memberIndex of the specified character member if used after the query flag. Or if used before the query
  1050. flag, returns the member that corresponds to the specified index.
  1051. - name : n (unicode) [create]
  1052. Assigns string as the name for a new character. Valid for operations that create a new character.
  1053. - noWarnings : nw (bool) [create]
  1054. Indicates that warning messages should not be reported such as when trying to add an invalid item to a character. (used
  1055. by UI)
  1056. - nodesOnly : no (bool) [query]
  1057. This flag modifies the results of character membership queries. When listing the attributes (e.g. sphere1.tx) contained
  1058. in the character, list only the nodes. Each node will only be listed once, even if more than one attribute or component
  1059. of the node exists in the character.
  1060. - offsetNode : ofs (bool) [query]
  1061. Returns the name of the characterOffset node used to add offsets to the root of the character. Flag
  1062. can have multiple arguments, passed either as a tuple or a list.
  1063. - remove : rm (PyNode) [edit]
  1064. Removes the list of items from the given character.
  1065. - root : rt (unicode) [create]
  1066. Specifies the transform node which will act as the root of the character being created. This creates a characterOffset
  1067. node in addition to the character node, which can be used to add offsets to the character to change the direction of the
  1068. character's animtion without inserting additional nodes in its hierarchy.
  1069. - scheduler : sc (bool) [query]
  1070. Returns the scheduler associated with this character, if there is one. A scheduler will only exist if you have created
  1071. clips on your character.
  1072. - split : sp (PyNode) [create]
  1073. Produces a new set with the list of items and removes each item in the list of items from the given set.
  1074. - subtract : sub (PyNode) [query]
  1075. An operation between two characters which returns the members of the first character that are not in the second
  1076. character. In general, characters should be mutually exclusive.
  1077. - text : t (unicode) [create,query,edit]
  1078. Defines an annotation string to be stored with the character.
  1079. - union : un (PyNode) [query]
  1080. An operation that returns a list of all the members of all characters listed.
  1081. - userAlias : ua (PyNode) [query]
  1082. Returns the user defined alias for the given attribute on the character or and empty string if there is not one.
  1083. Characters automatically alias the attributes where character animation data is stored. A user alias will exist when
  1084. the automatic aliases are overridden using the aliasAttr command.
  1085. Derived from mel command `maya.cmds.character`
  1086. """
  1087. pass
  1088. def characterMap(*args, **kwargs):
  1089. """
  1090. This command is used to create a correlation between the attributes of 2 or more characters.
  1091. Flags:
  1092. - mapAttr : ma (unicode, unicode) [create,query,edit]
  1093. In query mode, this flag can be used to query the mapping stored by the specified map node. It returns an array of
  1094. strings. In non-query mode, this flag can be used to create a mapping between the specified character members. Any
  1095. previous mapping on the attributes is removed in favor of the newly specified mapping.
  1096. - mapMethod : mm (unicode) [create]
  1097. This is is valid in create mode only. It specifies how the mapping should be done. Valid options are: byNodeName,
  1098. byAttrName, and byAttrOrder. byAttrOrderis the default. The flags mean the following: byAttrOrdermaps using the order
  1099. that the character stores the attributes internally, byAttrNameuses the attribute name to find a correspondence,
  1100. byNodeNameuses the node name \*and\* the attribute name to find a correspondence.
  1101. - mapNode : mn (unicode, unicode) [create,query]
  1102. This flag can be used to map all the attributes on the source node to their matching attributes on the destination node.
  1103. - mapping : m (unicode) [query]
  1104. This flag is valid in query mode only. It must be used before the query flag with a string argument. It is used for
  1105. querying the mapping for a particular attribute. A string array is returned.
  1106. - proposedMapping : pm (bool) [query]
  1107. This flag is valid in query mode only. It is used to get an array of the mapping that the character map would prvide if
  1108. called with the specified characters and the (optional) specified mappingMethod. If a character map exists on the
  1109. characters, the map is not affected by the query operation. A string array is returned.
  1110. - unmapAttr : ua (unicode, unicode) [create,edit]
  1111. This flag can be used to unmap the mapping stored by the specified map node.
  1112. - unmapNode : umn (unicode, unicode) [create]
  1113. This flag can be used to unmap all the attributes on the source node to their matching attributes on the destination
  1114. node. Note that mapped attributes which do not have matching names, will not be unmapped.
  1115. Flag can have multiple arguments, passed either as a tuple or a list.
  1116. Derived from mel command `maya.cmds.characterMap`
  1117. """
  1118. pass
  1119. def characterize(*args, **kwargs):
  1120. """
  1121. This command is used to scan a joint hierarchy for predefined joint names or labels. If the required joints are found,
  1122. human IK effectors will be created to control the skeleton using full-body IK. Alternatively, you can manually create
  1123. all of the components required for fullbody IK, and use this command to hook them up. Fullbody IK needs 3 major
  1124. components: the user input skeleton (sk), the fk skeleton on which keys are set (fk) and the hik effectors (ik).
  1125. Together fk and ik provide parameters to the fullbody IK engine, which solves for the output and plots it onto sk. This
  1126. command usage is used internally by Maya when importing data from fbx files, but is not generally recommended. Note that
  1127. a minimum set of required joint names or joint labels must be found in order for the characterize command to succeed.
  1128. Please refer to the Maya documentation for details on properly naming or labeling your skeleton. The skeleton should
  1129. also be z-facing, with its y-axis up, its left hand parallel to positive x-axis and right hand parallel to negative
  1130. x-axis. END_COMMENT
  1131. Flags:
  1132. - activatePivot : apv (bool) [edit]
  1133. Activates a pivot that has been properly placed. After activating this new pivot, you will now be able to rotate and
  1134. translate about this pivot. A pivot behaves in all ways the same as an effector (it IS an effector, except that it is
  1135. offset from the normal position of the effector to allow one to rotate about a different point.
  1136. - addAuxEffector : aae (bool) [edit]
  1137. Adds an auxilliary (secondary) effector to an existing effector.
  1138. - addFloorContactPlane : afp (bool) [edit]
  1139. Adds a floor contact plane to one of the hands or feet. With this plane, you will be able to adjust the floor contact
  1140. height. Select a hand or foot effector and then issue the characterize command with this flag.
  1141. - addMissingEffectors : ame (bool) [edit]
  1142. This flag tells the characterize command to look for any effectors that can be added to the skeleton. For example, if
  1143. the user has deleted some effectors or added fingers to an existing skeleton, characterize -e -addMissingEffectorscan be
  1144. used to restore them.
  1145. - attributeFromHIKProperty : ahk (unicode) [query]
  1146. Query for the attribute name associated with a MotionBuilder property.
  1147. - attributeFromHIKPropertyMode : mhk (unicode) [query]
  1148. Query for the attribute name associated with a MotionBuilder property mode.
  1149. - autoActivateBodyPart : aab (bool) [query,edit]
  1150. Query or change whether auto activation of character nodes representing body parts should be enabled.
  1151. - changePivotPlacement : cpp (bool) [edit]
  1152. Reverts a pivot back into pivot placement mode. A pivot that is in placement mode will not participate in full body
  1153. manipulation until it has been activated with the -activatePivot flag.
  1154. - effectors : ef (unicode) [create]
  1155. Specify the effectors to be used by human IK by providing 2 pieces of information for each effector: 1) the partial
  1156. path of the effector and 2) the name of the full body effector this represents. 1) and 2) are to be separated by white
  1157. space, and multiple entries separated by ,. Normally, the effectors are automatically created. This flag is for
  1158. advanced users only.
  1159. - fkSkeleton : fk (unicode) [create,edit]
  1160. Specify the fk skeleton to be used by human IK by providing 2 pieces of information for each joint of the FK skeleton:
  1161. 1) the partial path of the joint and 2) the name of the full body joint this represents. 1) and 2) are to be separated
  1162. by white space, and multiple entries separated by ,. Normally, the fk control skeleton is automatically created. This
  1163. flag is for advanced users only.
  1164. - name : nm (unicode) [create]
  1165. At characterization (FBIK creation) time, use this flag to name your FBIK character. This will affect the name of the
  1166. hikHandle node and the control rig will be put into a namespace that matches the name of your character. If you do not
  1167. specify the character name, a default one will be used. At the moment edit and query of the character name is not
  1168. supported. Flag can have multiple arguments, passed either as a tuple or a list.
  1169. - pinHandFeet : phf (bool) [create]
  1170. When the character is first being characterized, pin the hands and feet by default.
  1171. - placeNewPivot : pnp (bool) [edit]
  1172. Creates a new pivot and puts it into placement mode. Note that you will not be able to do full body manipulation about
  1173. this pivot until you have activated it with the -activatePivot flag. A pivot behaves in all ways the same as an effector
  1174. (it IS an effector, except that it is offset from the normal position of the effector to allow one to rotate about a
  1175. different point). A new pivot created with this flag allow you to adjust the offset interactively before activating it.
  1176. - posture : pos (unicode) [create]
  1177. Specifies the posture of the character. Valid options are bipedand quadruped. The default is biped.
  1178. - sourceSkeleton : sk (unicode) [create,edit]
  1179. This flag can be used to characterize a skeleton that has not been named or labelled according to the FBIK guidelines.
  1180. It specifies the association between the actual joint names and the expected FBIK joint names. The format of the string
  1181. is as follows: For each joint that the user wants to involve in the solve: 1) the partial path of the joint and 2) the
  1182. name of the full body joint this represents. 1) and 2) are to be separated by white space, and multiple entries
  1183. separated by ,.
  1184. - stancePose : sp (unicode) [create,query]
  1185. Specify the default stance pose to be used by human IK. The stance pose is specified by providing 2 pieces of
  1186. information for each joint involved in the solve: 1) the partial path to the joint and 2) 9 numbers representing
  1187. translation rotation and scale. 1) and 2) are to be separated by white space, and multiple entries separated by ,.
  1188. Normally, the stance pose is taken from the selected skeleton. This flag is for advanced users only.
  1189. - type : typ (unicode) [create]
  1190. Specifies the technique used by the characterization to identify the joint type. Valid options are labeland name. When
  1191. labelis used, the joints must be labelled using the guidelines described in the Maya documentation. When name is used,
  1192. the joint names must follow the naming conventions described in the Maya documentation. The default is name. This flag
  1193. cannot be used in conjunction with the sourceSkeleton flag.
  1194. Derived from mel command `maya.cmds.characterize`
  1195. """
  1196. pass
  1197. def choice(*args, **kwargs):
  1198. """
  1199. The choice command provides a mechanism for changing the inputs to an attribute based on some (usually time-based)
  1200. criteria. For example, an object could be animated from frames 1 to 30 by a motion path, then from frames 30 to 50 it
  1201. follows keyframe animation, and after frame 50 it returns to the motion path. Or, a revolve surface could change its
  1202. input curve depending on some transform's rotation value.The choice command creates a choice node (if one does not
  1203. already exist) on all specified attributes of the selected objects. If the attribute was already connected to something,
  1204. that something is now reconnected to the i'th index of the choice node's input (or the next available input if the
  1205. -in/index flag is not specified). If a source attribute is specified, then that attribute is connected to the choice
  1206. node's i'th input instead.The choice node operates by using the value of its selector attribute to determine which of
  1207. its input attributes to pass through to its output. The input attributes can be of any type. For example, if the
  1208. selector attribute was connected by an animation curve with keyframes at (1,1), (30,2) and (50,1), then that would mean
  1209. that the choice node would pass on the data from input[1] from time 1 to 30, and after time 50, and the data from
  1210. input[2] between times 30 and 50.This command returns the names of the created or modified choice nodes, and if a
  1211. keyframe was added to the animation curve, it specifies the index (or value on the animation curve).
  1212. Flags:
  1213. - attribute : at (unicode) [create]
  1214. specifies the attributes onto which choice node(s) should be created. The default is all keyable attributes of the given
  1215. objects. Note that although this flag is not queryable, it can be used to qualify which attributes of the given objects
  1216. to query.
  1217. - controlPoints : cp (bool) [create]
  1218. Explicitly specify whether or not to include the control points of a shape (see -sflag) in the list of attributes.
  1219. Default: false. Flag can have multiple arguments, passed either as a tuple or a list.
  1220. - index : index (int) [create,query]
  1221. specifies the multi-input index of the choice node to connect the source attribute to. When queried, returns a list of
  1222. integers one per specified -t/time that indicates the multi-index of the choice node to use at that time.
  1223. - name : n (unicode) [create,query]
  1224. the name to give to any newly created choice node(s). When queried, returns a list of strings.
  1225. - selector : sl (PyNode) [create,query]
  1226. specifies the attribute to be used as the choice node's selector. The value of the selector at a given time determines
  1227. which of the choice node's multi-indices should be used as the output of the choice node at that time. This flag is only
  1228. editable (it cannot be specified at creation time). When queried, returns a list of strings.
  1229. - shape : s (bool) [create]
  1230. Consider all attributes of shapes below transforms as well, except controlPoints. Default: true
  1231. - sourceAttribute : sa (PyNode) [create]
  1232. specifies the attribute to connect to the choice node that will be selected at the given time(s) specified by -t/time.
  1233. - time : t (time) [create]
  1234. specifies the time at which the choice should use the given source attribute, or the currently connected attribute if
  1235. source attribute is not specified. The default is the curren time. Note that although this flag is not queryable, it can
  1236. be used to qualify the times at which to query the other attributes.
  1237. Derived from mel command `maya.cmds.choice`
  1238. """
  1239. pass
  1240. def clip(*args, **kwargs):
  1241. """
  1242. This command is used to create, edit and query character clips.
  1243. Flags:
  1244. - absolute : abs (bool) [create]
  1245. This flag is now deprecated. Use aa/allAbsolute, ar/allRelative, ra/rotationsAbsolute, or da/defaultAbsolute instead.
  1246. This flag controls whether the clip follows its keyframe values or whether they are offset by a value to maintain a
  1247. smooth path. Default is true.
  1248. - absoluteRotations : abr (bool) [create]
  1249. This flag is now deprecated. Use aa/allAbsolute, ar/allRelative, ra/rotationsAbsolute, or da/defaultAbsolute instead.
  1250. If true, this overrides the -absolute flag so that rotation channels are always calculated with absolute offsets. This
  1251. allows you to have absolute offsets on rotations and relative offsets on all other channels.
  1252. - active : a (unicode) [query,edit]
  1253. Query or edit the active clip. This flag is not valid in create mode. Making a clip active causes its animCurves to be
  1254. hooked directly to the character attributes in addition to being attached to the clip library node. This makes it easier
  1255. to access the animCurves if you want to edit, delete or add additional animCruves to the clip.
  1256. - addTrack : at (bool) []
  1257. This flag is now obsolete. Use the insertTrack flag on the clipSchedule command instead.
  1258. - allAbsolute : aa (bool) [create]
  1259. Set all channels to be calculated with absolute offsets. This flag cannot be used in conjunction with the
  1260. ar/allRelative, ra/rotationsAbsolute or da/defaultAbsolute flags.
  1261. - allClips : ac (bool) [query]
  1262. This flag is used to query all the clips in the scene. Nodes of type animClipthat are storing poses, are not returned by
  1263. this command.
  1264. - allRelative : ar (bool) [create]
  1265. Set all channels to be calculated with relative offsets. This flag cannot be used in conjunction with the
  1266. aa/allAbsolute, ra/rotationsAbsolute or da/defaultAbsolute flags.
  1267. - allSourceClips : asc (bool) [query]
  1268. This flag is used to query all the source clips in the scene. Nodes of type animClipthat are storing poses or clip
  1269. instances, are not returned by this command.
  1270. - animCurveRange : acr (bool) [create]
  1271. This flag can be used at the time you create the clip instead of the startTime and endTime flags. It specifies that you
  1272. want the range of the clip to span the range of keys in the clips associated animCurves.
  1273. - character : ch (bool) [query]
  1274. This is a query only flag which operates on the specified clip. It returns the names of any characters that a clip is
  1275. associated with.
  1276. - constraint : cn (bool) [create]
  1277. This creates a clip out of any constraints on the character. The constraint will be moved off of the character and into
  1278. the clip, so that it is only active for the duration of the clip, and its value can be scaled/offset/cycled according to
  1279. the clip attributes.
  1280. - copy : c (bool) [create,query]
  1281. This flag is used to copy a clip or clips to the clipboard. It should be used in conjunction with the name flag to copy
  1282. the named clips on the specified character and its subcharacters. In query mode, this flag allows you to query what, if
  1283. anything, has been copied into the clip clipboard.
  1284. - defaultAbsolute : da (bool) [create]
  1285. Sets all top-level channels except rotations in the clip to relative, and the remaining channels to absolute. This is
  1286. the default during clip creation if no offset flag is specified. This flag cannot be used in conjunction with the
  1287. aa/allAbsolute, ar/allRelative, or ra/rotationsAbsolute flags.
  1288. - duplicate : d (bool) [query]
  1289. Duplicate the clip specified by the name flag. The start time of the new clip should be specified with the startTime
  1290. flag.
  1291. - endTime : end (time) [create,query,edit]
  1292. Specify the clip end
  1293. - expression : ex (bool) [create]
  1294. This creates a clip out of any expressions on the character. The expression will be moved off of the character and into
  1295. the clip, so that it is only active for the duration of the clip, and its value can be scaled/offset/cycled according to
  1296. the clip attributes. Flag can have multiple arguments, passed either as a tuple or a
  1297. list.
  1298. - ignoreSubcharacters : ignoreSubcharacters (bool) [create]
  1299. During clip creation, duplication and isolation, subcharacters are included by default. If you want to create a clip on
  1300. the top level character only, or you want to duplicate the clip on the top level character without including
  1301. subCharacters, use the ignoreSubcharacters flag.
  1302. - isolate : i (bool) [create]
  1303. This flag should be used in conjunction with the name flag to specify that a clip or clips should be copied to a new
  1304. clip library. The most common use of this flag is for export, when you want to only export certain clips from the
  1305. character, without exporting all of the clips.
  1306. - leaveOriginal : lo (bool) [create]
  1307. This flag is used when creating a clip to specify that the animation curves should be copied to the clip library, and
  1308. left on the character.
  1309. - mapMethod : mm (unicode) [create]
  1310. This is is valid with the paste and pasteInstance flags only. It specifies how the mapping should be done. Valid options
  1311. are: byNodeName, byAttrName, byCharacterMap, byAttrOrder, byMapOrAttrNameand byMapOrNodeName. byAttrNameis the default.
  1312. The flags mean the following: byAttrOrdermaps using the order that the character stores the attributes internally,
  1313. byAttrNameuses the attribute name to find a correspondence, byNodeNameuses the node name \*and\* the attribute name to
  1314. find a correspondence, byCharacterMapuses the existing characterMap node to do the mapping. byMapOrAttrNameuses a
  1315. character map if one exists, otherwise uses the attribute name. byMapOrNodeNameuses a character map if one exists,
  1316. otherwise uses the attribute name.
  1317. - name : n (unicode) [create,query]
  1318. In create mode, specify the clip name. In query mode, return a list of all the clips. In duplicate mode, specify the
  1319. clip to be duplicated. In copy mode, specify the clip to be copied. This flag is multi-use, but multiple use is only
  1320. supported with the copy flag. For use during create and with all other flags, only the first instance of the name flag
  1321. will be utilized. In query mode, this flag can accept a value.
  1322. - newName : nn (unicode) [create]
  1323. Rename a clip. Must be used in conjunction with the clip name flag, which is used to specify the clip to be renamed.
  1324. - paste : p (bool) [create]
  1325. This flag is used to paste a clip or clips from the clipboard to a character. Clips are added to the clipboard using the
  1326. c/copy flag.
  1327. - pasteInstance : pi (bool) [create]
  1328. This flag is used to paste an instance of a clip or clips from the clipboard to a character. Unlike the p/paste flag,
  1329. which duplicates the animCurves from the original source clip, the pi/pasteInstance flag shares the animCurves from the
  1330. source clip.
  1331. - remove : rm (bool) [query]
  1332. Remove the clip specified by the name flag. The clip will be permanently removed from the library and deleted from any
  1333. times where it has been scheduled.
  1334. - removeTrack : rt (bool) [create]
  1335. This flag is now obsolete. Use removeTrack flag on the clipSchedule command instead.
  1336. - rotationsAbsolute : ra (bool) [create]
  1337. Set all channels except rotations to be calculated with relative offsets. Rotation channels will be calculated with
  1338. absolute offsets. This flag cannot be used in conjunction with the aa/allAbsolute, ar/allRelative or da/defaultAbsolute
  1339. flags.
  1340. - scheduleClip : sc (bool) [create]
  1341. This flag is used when creating a clip to specify whether or not the clip should immediately be scheduled at the current
  1342. time. If the clip is not scheduled, the clip will be placed in the library for future use, but will not be placed on the
  1343. timeline. This flag is for use only when creating a new clip or duplicating an existing. The default is true.
  1344. - sourceClipName : scn (bool) [query]
  1345. This flag is for query only. It returns the name of the source clip that controls an instanced clip.
  1346. - split : sp (time) [create,edit]
  1347. Split an existing clip into two clips. The split occurs around the specified time.
  1348. - startTime : s (time) [create,query,edit]
  1349. Specify the clip start
  1350. - useChannel : uc (unicode) [create]
  1351. Specify which channels should be acted on. This flag is valid only in conjunction with clip creation, and the isolate
  1352. flag. The specified channels must be members of the character.
  1353. Derived from mel command `maya.cmds.clip`
  1354. """
  1355. pass
  1356. def clipEditor(*args, **kwargs):
  1357. """
  1358. Create a clip editor with the given name.
  1359. Flags:
  1360. - allTrackHeights : th (int) []
  1361. OBSOLETE flag. Use clipStyle instead.
  1362. - autoFit : af (unicode) [query,edit]
  1363. on | off | tgl auto fit-to-view
  1364. - characterOutline : co (unicode) []
  1365. - clipDropCmd : cd (unicode) [edit]
  1366. Command executed when clip node is dropped on the TraX editor
  1367. - clipStyle : cs (int) [query,edit]
  1368. Set/return the clip track style in the specified editor. Default is 2. Valid values are 1-3.
  1369. - control : ctl (bool) [query]
  1370. Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus.
  1371. Caution: It is possible, at times, for an editor to exist without a control. This flag returns NONEif no control is
  1372. present.
  1373. - defineTemplate : dt (unicode) [create]
  1374. Puts a command in a mode where any other flags and args are parsed and added to the command template specified in the
  1375. argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set
  1376. as the current template.
  1377. - deleteCmd : dc (unicode) [edit]
  1378. Command executed when backspacekey is pressed
  1379. - deselectAll : da (bool) [edit]
  1380. Deselect all clips and blends in the editor.
  1381. - displayActiveKeyTangents : dat (unicode) [edit]
  1382. on | off | tgl display tangents in the editor
  1383. - displayActiveKeys : dak (unicode) [edit]
  1384. on | off | tgl display tangents in the editor
  1385. - displayInfinities : di (unicode) [edit]
  1386. on | off | tgl display infinities in the editor
  1387. - displayKeys : dk (unicode) [edit]
  1388. on | off | tgl display keyframes in the editor
  1389. - displayTangents : dtn (unicode) [edit]
  1390. on | off | tgl display tangents in the editor
  1391. - docTag : dtg (unicode) [create,query,edit]
  1392. Attaches a tag to the Maya editor.
  1393. - exists : ex (bool) [create]
  1394. Returns true|false depending upon whether the specified object exists. Other flags are ignored.
  1395. - filter : f (unicode) [create,query,edit]
  1396. Specifies the name of an itemFilter object to be placed on this editor. This filters the information coming onto the
  1397. main list of the editor.
  1398. - forceMainConnection : fmc (unicode) [create,query,edit]
  1399. Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will
  1400. only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in
  1401. that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the
  1402. -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.
  1403. - frameAll : fa (bool) [edit]
  1404. Frame view around all clips in the editor.
  1405. - frameRange : fr (float, float) [query,edit]
  1406. The editor's current frame range.
  1407. - highlightConnection : hlc (unicode) [create,query,edit]
  1408. Specifies the name of a selectionConnection object which the editor will synchronize with its highlight list. Not all
  1409. editors have a highlight list. For those that do, it is a secondary selection list.
  1410. - highlightedBlend : hb (unicode, unicode) [query]
  1411. Returns the highlighted blend, listed as scheduler and index
  1412. - highlightedClip : hc (unicode, unicode) [query]
  1413. Returns the highlighted clip, listed as scheduler and index
  1414. - listAllCharacters : lac (bool) [edit]
  1415. List all characters in the editor and outliner.
  1416. - listCurrentCharacters : lc (bool) [edit]
  1417. List only the characters in the editor and outliner.
  1418. - lockMainConnection : lck (bool) [create,edit]
  1419. Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor.
  1420. Further changes to the original mainConnection are ignored.
  1421. - lookAt : la (unicode) [edit]
  1422. all | selected | currentTime fitView helpers
  1423. - mainListConnection : mlc (unicode) [create,query,edit]
  1424. Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will
  1425. only display items contained in the selectionConnection object.
  1426. - manageSequencer : ms (bool) [create,query,edit]
  1427. Sets/returns whether the clip editor should manage sequencer nodes. If so, animation clips and characters are not
  1428. represented. Flag can have multiple arguments, passed either as a tuple or a list.
  1429. - menuContext : mc (unicode) [query]
  1430. Returns a string array denoting the type of data object the cursor is over. Returned values are: timeSlider nothing
  1431. track, track index, character node name, group name clip, clip node name
  1432. - panel : pnl (unicode) [create,query]
  1433. Specifies the panel that the editor belongs to. By default if an editor is created in the create callback of a scripted
  1434. panel it will belong to that panel. If an editor doesn't belong to a panel it will be deleted when the window that it
  1435. is in is deleted.
  1436. - parent : p (unicode) [create,query,edit]
  1437. Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
  1438. - selectBlend : sb (unicode, unicode, unicode) [query,edit]
  1439. Select the blends specified by the scheduler name and the indicies of the two clips used in the blend. When queried, a
  1440. string containing the scheduler name and the two clip indicies for all of the selected blends is returned.
  1441. - selectClip : sc (unicode, unicode) [query,edit]
  1442. Selects the clip specified by the scheduler name and the clip index. When queried, a string containing the scheduler and
  1443. clip index of all of the selected clips is returned.
  1444. - selectionConnection : slc (unicode) [create,query,edit]
  1445. Specifies the name of a selectionConnection object which the editor will synchronize with its own selection list. As
  1446. the user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes
  1447. changes, the editor updates to show the change.
  1448. - snapTime : st (unicode) [query,edit]
  1449. none | integer | keyframe keyframe move snap in time
  1450. - snapValue : sv (unicode) [query,edit]
  1451. none | integer | keyframe keyframe move snap in values
  1452. - stateString : sts (bool) [query]
  1453. Query only flag. Returns the MEL command that will edit an editor to match the current editor state. The returned
  1454. command string uses the string variable $editorName in place of a specific name.
  1455. - unParent : up (bool) [create,edit]
  1456. Specifies that the editor should be removed from its layout. This cannot be used with query.
  1457. - unlockMainConnection : ulk (bool) [create,edit]
  1458. Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic
  1459. updates.
  1460. - updateMainConnection : upd (bool) [create,edit]
  1461. Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
  1462. - useTemplate : ut (unicode) [create]
  1463. Force the command to use a command template other than the current one.
  1464. Derived from mel command `maya.cmds.clipEditor`
  1465. """
  1466. pass
  1467. def clipSchedule(*args, **kwargs):
  1468. """
  1469. This command is used to create, edit and query clips and blends in the Trax editor. It operates on the clipScheduler
  1470. node attached to the character. In query mode, if no flags are specified, returns an array of strings in this form:
  1471. (clipName,clipIndex,clipStart,clipSourceStart,clipSourceEnd,clipScale,clipPreCycle,clipPostCycle,clipHold)
  1472. Flags:
  1473. - absolute : abs (bool) [query,edit]
  1474. This flag is now deprecated. Use aa/allAbsolute, ar/allRelative, ra/rotationsAbsolute, or da/defaultAbsolute instead.
  1475. This flag controls whether the clip follows its keyframe values or whether they are offset by a value to maintain a
  1476. smooth path.
  1477. - absoluteRotations : abr (bool) [query,edit]
  1478. This flag is now deprecated. Use aa/allAbsolute, ar/allRelative, ra/rotationsAbsolute, or da/defaultAbsolute instead.
  1479. If true, this overrides the abs/absolute flag so that rotation channels are always calculated with absolute offsets.
  1480. This allows you to have absolute offsets on rotations and relative offsets on all other channels.
  1481. - allAbsolute : aa (bool) [edit]
  1482. Set all channels to be calculated with absolute offsets. This flag cannot be used in conjunction with the
  1483. ar/allRelative, ra/rotationsAbsolute or da/defaultAbsolute flags.
  1484. - allRelative : ar (bool) [edit]
  1485. Set all channels to be calculated with relative offsets. This flag cannot be used in conjunction with the
  1486. aa/allAbsolute, ra/rotationsAbsolute or da/defaultAbsolute flags.
  1487. - blend : b (int, int) [create,query]
  1488. This flag is used to blend two clips, whose indices are provided as flag arguments.
  1489. - blendNode : bn (int, int) [query]
  1490. This query only flag list all of the blend nodes associated with the blend defined by the two clip indices. This flag
  1491. returns a string array. In query mode, this flag can accept a value.
  1492. - blendUsingNode : bun (unicode) [create]
  1493. This flag is used if you want to blend using an existing blend node. It is used in conjunction with the blend flag. The
  1494. blend flag specifies the clip indices for the blend. The name of an existing animBlend node should be supplied supplied
  1495. as an argument for the blendUsingNode flag.
  1496. - character : ch (bool) [query]
  1497. This flag is used to query which characters this scheduler controls. It returns an array of strings.
  1498. - clipIndex : ci (int) [create,query]
  1499. Specify the index of the clip to schedule. In query mode, returns an array of strings in this form:
  1500. (clipName,index,start,sourceStart,sourceEnd,scale,preCycle,postCycle) In query mode, this flag can accept a value.
  1501. - cycle : c (float) [create,query]
  1502. This flag is now obsolete. Use the postCycle flag instead.
  1503. - defaultAbsolute : da (bool) [edit]
  1504. Sets all top-level channels except rotations in the clip to relative, and the remaining channels to absolute. This is
  1505. the default during clip creation if no offset flag is specified. This flag cannot be used in conjunction with the
  1506. aa/allAbsolute, ar/allRelative, or ra/rotationsAbsolute flags.
  1507. - enable : en (bool) [create,query]
  1508. This flag is used to enable or disable a clip. It must be used in conjunction with the ci/clipIndex flag. The specified
  1509. clip will be enabled or disabled.
  1510. - group : grp (bool) [create]
  1511. This flag is used to add (true) or remove (false) a list of clips (specified with groupIndex) into a group.
  1512. - groupIndex : gri (int) [create]
  1513. This flag specifies a multiple number of clips to be added or removed from a group.
  1514. Flag can have multiple arguments, passed either as a tuple or a list.
  1515. - groupName : gn (unicode) [create,query]
  1516. This flag is used to specify the group that should be added to. If no group by that name exists and new group is
  1517. created with that name. By default if this is not specified a new group will be created.
  1518. - hold : ph (time) [create,query]
  1519. Specify how long to hold the last value of the clip after its normal or cycled end.
  1520. - insertTrack : it (int) [create]
  1521. This flag is used to insert a new empty track at the track index specified.
  1522. - instance : instance (unicode) [create]
  1523. Create an instanced copy of the named clip. An instanced clip is one that is linked to an original clip. Thus, changes
  1524. to the animation curve of the original curve will also modify all instanced clips. The name of the instanced clip is
  1525. returned as a string.
  1526. - listCurves : lc (bool) [create,query]
  1527. This flag is used to list the animation curves associated with a clip. It should be used in conjunction with the
  1528. clipIndex flag, which specifies the clip of interest.
  1529. - listPairs : lp (bool) [query]
  1530. This query only flag returns a string array containing the channels in a character that are used by a clip and the names
  1531. of the animation curves that drive the channels. Each string in the string array consists of the name of a channel, a
  1532. space, and the name of the animation curve animating that channel. This flag must be used with the ci/clipIndex flag.
  1533. - lock : l (bool) [query,edit]
  1534. This flag specifies whether clips on a track are to be locked or not. Must be used in conjuction with the track flag.
  1535. - mute : m (bool) [query,edit]
  1536. This flag specifies whether clips on a track are to be muted or not. Must be used in conjuction with the track flag.
  1537. - name : n (unicode) [create,query]
  1538. This flag is used to query the name of the clip node associated with the specified clip index, or to specify the name of
  1539. the instanced clip during instancing. In query mode, this flag can accept a value.
  1540. - postCycle : poc (float) [create,query]
  1541. Specify the number of times to repeat the clip after its normal end.
  1542. - preCycle : prc (float) [create,query]
  1543. Specify the number of times to repeat the clip before its normal start.
  1544. - remove : rm (bool) [create]
  1545. This flag is used to remove a clip from the timeline. It must be used in conjunction with the ci/clipIndex flag. The
  1546. specified clip will be removed from the timeline, but will still exist in the library and any instanced clips will
  1547. remain in the timeline. To permanently remove a clip from the scene, the clip command should be used instead.
  1548. - removeBlend : rb (int, int) [create]
  1549. This flag is used to remove an existing blend between two clips, whose indices are provided as flag arguments.
  1550. - removeEmptyTracks : ret (bool) [create]
  1551. This flag is used to remove all tracks that have no clips.
  1552. - removeTrack : rt (int) [create]
  1553. This flag is used to remove the track with the specified index. The track must have no clips on it before it can be
  1554. removed.
  1555. - rotationsAbsolute : ra (bool) [edit]
  1556. Set all channels except rotations to be calculated with relative offsets. Rotation channels will be calculated with
  1557. absolute offsets. This flag cannot be used in conjunction with the aa/allAbsolute, ar/allRelative or da/defaultAbsolute
  1558. flags.
  1559. - scale : sc (float) [create,query]
  1560. Specify the amount to scale the clip. Values must be greater than 0.
  1561. - shift : sh (int) [create]
  1562. This flag allows multiple clips to be shifted by a certain number of tracks and works in conjunction with the shiftIndex
  1563. flag. The flag specifies the number of tracks to shift the associated clips. Positive values shift the clips down an
  1564. negative values shift the clips up.
  1565. - shiftIndex : shi (int) [create]
  1566. This flag allows multiple clips to be shifted by a certain number of tracks and works in conjunction with the
  1567. shiftAmount flag. The flag specifies the index of the clip to shift. This flag can be used multiple times on the
  1568. command line to specify a number of clips to shift.
  1569. - solo : so (bool) [query,edit]
  1570. This flag specifies whether clips on a track are to be soloed or not. Must be used in conjuction with the track flag.
  1571. - sourceClipName : scn (bool) [create,query]
  1572. This flag is used to query the name of the source clip node associated with the specified clip index.
  1573. - sourceEnd : se (time) [create,query]
  1574. Specify where to end in the source clip's animation curves
  1575. - sourceStart : ss (time) [create,query]
  1576. Specify where to start in the source clip's animation curves
  1577. - start : s (time) [create,query]
  1578. Specify the placement of the start of the clip
  1579. - track : t (int) [create,query]
  1580. Specify the track to operate on. For example, which track to place a clip on, which track to mute/lock/solo. In query
  1581. mode, it may be used in conjuction with the clipIndex flag to return the track number of a clip, where track 1 is the
  1582. first track of the character. In query mode, this flag can accept a value.
  1583. - weight : w (float) [create,query]
  1584. This flag is used in to set or query the weight of the clip associated with the specified clip index.
  1585. - weightStyle : ws (int) [create,query]
  1586. This flag is used to set or query the weightStyle attribute of the clip associated with the specified clip index.
  1587. Derived from mel command `maya.cmds.clipSchedule`
  1588. """
  1589. pass
  1590. def clipSchedulerOutliner(*args, **kwargs):
  1591. """
  1592. This command creates/edits/queries a clip scheduler outliner control.
  1593. Flags:
  1594. - annotation : ann (unicode) [create,query,edit]
  1595. Annotate the control with an extra string value.
  1596. - backgroundColor : bgc (float, float, float) [create,query,edit]
  1597. The background color of the control. The arguments correspond to the red, green, and blue color components. Each
  1598. component ranges in value from 0.0 to 1.0. When setting backgroundColor, the background is automatically enabled, unless
  1599. enableBackground is also specified with a false value.
  1600. - clipScheduler : cs (unicode) [edit]
  1601. Name of the clip scheduler for which to display information. Flag can have multiple arguments,
  1602. passed either as a tuple or a list.
  1603. - defineTemplate : dt (unicode) [create]
  1604. Puts a command in a mode where any other flags and args are parsed and added to the command template specified in the
  1605. argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set
  1606. as the current template.
  1607. - docTag : dtg (unicode) [create,query,edit]
  1608. Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt
  1609. render/multiLister/createNode/material
  1610. - dragCallback : dgc (script) [create,edit]
  1611. Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form:
  1612. global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that
  1613. is transferred to the drop site. By convention the first string in the array describes the user settable message type.
  1614. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers
  1615. CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT. In Python, it is similar,
  1616. but there are two ways to specify the callback. The recommended way is to pass a Python function object as the
  1617. argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The
  1618. values of these arguments are the same as those for the MEL version above. The other way to specify the callback in
  1619. Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the
  1620. standard Python format operator. The format values are passed in a dictionary with the keys dragControl, x, y,
  1621. modifiers. The dragControlvalue is a string and the other values are integers (eg the callback string could be print
  1622. '%(dragControl)s %(x)d %(y)d %(modifiers)d'
  1623. - dropCallback : dpc (script) [create,edit]
  1624. Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the
  1625. callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int
  1626. $y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs
  1627. array describes the user defined message type. Controls that are application defined drop sites may ignore the callback.
  1628. $type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify
  1629. the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python
  1630. callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of
  1631. these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to
  1632. specify a string to be executed. In that case, the string will have the values substituted into it via the standard
  1633. Python format operator. The format values are passed in a dictionary with the keys dragControl, dropControl, messages,
  1634. x, y, type. The dragControlvalue is a string and the other values are integers (eg the callback string could be print
  1635. '%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d'
  1636. - enable : en (bool) [create,query,edit]
  1637. The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and
  1638. the control will appear dimmed or greyed-out indicating it is disabled.
  1639. - enableBackground : ebg (bool) [create,query,edit]
  1640. Enables the background color of the control.
  1641. - exists : ex (bool) [create]
  1642. Returns true|false depending upon whether the specified object exists. Other flags are ignored.
  1643. - fullPathName : fpn (unicode) [query]
  1644. Return the full path name of the widget, which includes all the parents
  1645. - height : h (int) [create,query,edit]
  1646. The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
  1647. - isObscured : io (bool) [query]
  1648. Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if
  1649. it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control's
  1650. window is invisible or iconified.
  1651. - manage : m (bool) [create,query,edit]
  1652. Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All
  1653. controls are created managed by default.
  1654. - numberOfPopupMenus : npm (bool) [query]
  1655. Return the number of popup menus attached to this control.
  1656. - parent : p (unicode) [create,query]
  1657. The parent layout for this control.
  1658. - popupMenuArray : pma (bool) [query]
  1659. Return the names of all the popup menus attached to this control.
  1660. - preventOverride : po (bool) [create,query,edit]
  1661. If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
  1662. - useTemplate : ut (unicode) [create]
  1663. Force the command to use a command template other than the current one.
  1664. - visible : vis (bool) [create,query,edit]
  1665. The visible state of the control. A control is created visible by default. Note that a control's actual appearance is
  1666. also dependent on the visible state of its parent layout(s).
  1667. - visibleChangeCommand : vcc (script) [create,query,edit]
  1668. Command that gets executed when visible state of the control changes.
  1669. - width : w (int) [create,query,edit]
  1670. The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
  1671. Derived from mel command `maya.cmds.clipSchedulerOutliner`
  1672. """
  1673. pass
  1674. def cluster(*args, **kwargs):
  1675. """
  1676. The cluster command creates a cluster or edits the membership of an existing cluster. The command returns the name of
  1677. the cluster node upon creation of a new cluster. After creating a cluster, the cluster's weights can be modified using
  1678. the percent command or the set editor window.
  1679. Flags:
  1680. - after : af (bool) [create,edit]
  1681. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  1682. flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape
  1683. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  1684. - afterReference : ar (bool) [edit]
  1685. - before : bf (bool) [create,edit]
  1686. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  1687. flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape
  1688. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  1689. - bindState : bs (bool) [create]
  1690. When turned on, this flag adds in a compensation to ensure the clustered objects preserve their spatial position when
  1691. clustered. This is required to prevent the geometry from jumping at the time the cluster is created in situations when
  1692. the cluster transforms at cluster time are not identity.
  1693. - deformerTools : dt (bool) [query]
  1694. Returns the name of the deformer tool objects (if any) as string string ...
  1695. - envelope : en (float) [create,query,edit]
  1696. Set the envelope value for the deformer. Default is 1.0
  1697. - exclusive : ex (unicode) [create,query]
  1698. Puts the deformation set in a deform partition.
  1699. - frontOfChain : foc (bool) [create,edit]
  1700. This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and
  1701. skin nodes in the shape's history (but not ahead of existing tweak nodes). The input to the deformer will be the
  1702. upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the
  1703. downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and
  1704. edit mode if the deformer has no geometry added yet).
  1705. - geometry : g (unicode) [query,edit]
  1706. The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is
  1707. also specified. When queried, this flag returns string string string ...
  1708. - geometryIndices : gi (bool) [query]
  1709. - ignoreSelected : ignoreSelected (bool) [create]
  1710. Tells the command to not deform objects on the current selection list
  1711. - name : n (unicode) [create]
  1712. Used to specify the name of the node being created
  1713. - parallel : par (bool) [create,edit]
  1714. Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is
  1715. inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry
  1716. added yet).
  1717. - prune : pr (bool) [edit]
  1718. Removes any points not being deformed by the deformer in its current configuration from the deformer set.
  1719. - relative : rel (bool) [create]
  1720. Enable relative mode for the cluster. In relative mode, Only the transformations directly above the cluster are used by
  1721. the cluster. Default is off.
  1722. - remove : rm (bool) [edit]
  1723. Specifies that objects listed after the -g flag should be removed from this deformer.
  1724. - resetGeometry : rg (bool) [edit]
  1725. Reset the geometry matrices for the objects being deformed by the cluster. This flag is used to get rid of undesirable
  1726. effects that happen if you scale an object that is deformed by a cluster. Flag can have
  1727. multiple arguments, passed either as a tuple or a list.
  1728. - split : sp (bool) [create,edit]
  1729. Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing
  1730. chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
  1731. - weightedNode : wn (unicode, unicode) [create,query,edit]
  1732. Transform node in the DAG above the cluster to which all percents are applied. The second DAGobject specifies the
  1733. descendent of the first DAGobject from where the transformation matrix is evaluated. Default is the cluster handle.
  1734. Derived from mel command `maya.cmds.cluster`
  1735. """
  1736. pass
  1737. def connectJoint(*args, **kwargs):
  1738. """
  1739. This cmd will connect two skeletons based on the selected two joints. The first selected joint can be made a child of
  1740. the parent of the second selected joint or a child of the second selected joint, depending on the flags used. Note1: The
  1741. first selected joint must be the root of a skeleton. The second selected joint must have a parent. Note2: If a joint
  1742. name is specified in the cmd line, it is used as the child and the first selected joint will be the parent. If no joint
  1743. name is given at the cmd line, two joints must be selected.
  1744. Flags:
  1745. - connectMode : cm (bool) [create]
  1746. The first selected joint will be parented under the parent of the second selected joint. Flag
  1747. can have multiple arguments, passed either as a tuple or a list.
  1748. - parentMode : pm (bool) [create]
  1749. The first selected joint will be parented under the second selected joint. Both joints will be in the active
  1750. list(selection list).
  1751. Derived from mel command `maya.cmds.connectJoint`
  1752. """
  1753. pass
  1754. def copyDeformerWeights(*args, **kwargs):
  1755. """
  1756. Command to copy or mirror the deformer weights accross one of the three major axes. The command can be used to mirror
  1757. weights either from one surface to another or within the same surface.
  1758. Flags:
  1759. - destinationDeformer : dd (unicode) [create,query,edit]
  1760. Specify the deformer used by the destination shape
  1761. - destinationShape : ds (unicode) [create,query,edit]
  1762. Specify the destination deformed shape
  1763. - mirrorInverse : mi (bool) [create,query,edit]
  1764. Values are mirrored from the positive side to the negative. If this flag is used then the direction is inverted.
  1765. - mirrorMode : mm (unicode) [create,query,edit]
  1766. The mirrorMode flag defines the plane of mirroring (XY, YZ, or XZ) when the mirror flag is used. The default plane is
  1767. XY.
  1768. - noMirror : nm (bool) [create,query,edit]
  1769. When the no mirror flag is used, the weights are copied instead of mirrored.
  1770. - smooth : sm (bool) [create,query,edit]
  1771. When the smooth flag is used, the weights are smoothly interpolated between the closest vertices, instead of assigned
  1772. from the single closest.
  1773. - sourceDeformer : sd (unicode) [create,query,edit]
  1774. Specify the deformer whose weights should be mirrored. When queried, returns the deformers used by the source shapes.
  1775. - sourceShape : ss (unicode) [create,query,edit]
  1776. Specify the source deformed shape
  1777. - surfaceAssociation : sa (unicode) [create,query,edit]
  1778. The surfaceAssociation flag controls how the weights are transferred between the surfaces: closestPoint, rayCast, or
  1779. closestComponent. The default is closestComponent.
  1780. - uvSpace : uv (unicode, unicode) [create,query,edit]
  1781. The uvSpace flag indicates that the weight transfer should occur in UV space, based on the source and destination UV
  1782. sets specified. Flag can have multiple arguments, passed either as a tuple or a
  1783. list.
  1784. Derived from mel command `maya.cmds.copyDeformerWeights`
  1785. """
  1786. pass
  1787. def copyFlexor(*args, **kwargs):
  1788. """
  1789. This command copies an existing bone or joint flexor from one bone (joint) to another. The attributes of the flexor and
  1790. their connections as well as any tweaks in on the latticeFfd are copied from the original to the new flexor. If the
  1791. selected bone (joint) appears to be a mirror reflection of the bone (joint) of the existing flexor then the transform of
  1792. the ffd lattice group gets reflected to the new bone (joint). The arguments for the command are the name of the ffd
  1793. Lattice and the name of the destination joint. If they are not specified at the command line, they will be picked up
  1794. from the current selection list.
  1795. Derived from mel command `maya.cmds.copyFlexor`
  1796. """
  1797. pass
  1798. def copyKey(*args, **kwargs):
  1799. """
  1800. This command operates on a keyset. A keyset is defined as a group of keys within a specified time range on one or more
  1801. animation curves. The animation curves comprising a keyset depend on the value of the -animationflag: keysOrObjects: Any
  1802. active keys, when no target objects or -attribute flags appear on the command line, orAll animation curves connected to
  1803. all keyframable attributes of objects specified as the command line's targetList, when there are no active keys.keys:
  1804. Only act on active keys or tangents. If there are no active keys or tangents, don't do anything. objects: Only act on
  1805. specified objects. If there are no objects specified, don't do anything. Note that the -animationflag can be used to
  1806. override the curves uniquely identified by the multi-use -attributeflag, which takes an argument of the form
  1807. attributeName, such as translateX. Keys on animation curves are identified by either their time values or their indices.
  1808. Times and indices can be given individually or as part of a list or range. -time 10palmeans the key at frame 10 (PAL
  1809. format).-time 1.0sec -time 15ntsc -time 20means the keys at time 1.0 second, frame 15 (in NTSC format), and time 20 (in
  1810. the currently defined global time unit).-time 10:20means all keys in the range from 10 to 20, inclusive, in the current
  1811. time unit.Omitting one end of a range means go to infinity, as in the following examples: -time 10:means all keys from
  1812. time 10 (in the current time unit) onwards.-time :10means all keys up to (and including) time 10 (in the current time
  1813. unit).-time :is a short form to specify all keys.-index 0means the first key of each animation curve. (Indices are
  1814. 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
  1815. of each animation curve.This command copies curve segments's hierarchies from specified targets and puts them in the
  1816. clipboard. Source curves are unchanged. The pasteKey command applies these curves to other objects.The shape of the
  1817. copied curve placed in the clipboard depends on the copyKey -optionspecified. Each of these options below will be
  1818. explained using an example. For all the explanations, let us assume that the source animation curve (from which keys
  1819. will be copied) has 5 keyframes at times 10, 15, 20, 25, and 30. copyKey -t 12:22-option keysA 5-frame animation curve
  1820. with one key at 15 and another key at 20 is placed into the keyset clipboard.copyKey -t 12:22-option curveA 10-frame
  1821. animation is placed into the clipboard. The curve contains the original source-curve keys at times 15 and 20, as well as
  1822. new keys inserted at times 12 and 22 to preserve the shape of the curve at the given time segment.TbaseKeySetCmd.h
  1823. Flags:
  1824. - animation : an (unicode) [create]
  1825. Where this command should get the animation to act on. Valid values are objects,keys,and keysOrObjectsDefault:
  1826. keysOrObjects.(See Description for details.)
  1827. - attribute : at (unicode) [create]
  1828. List of attributes to select
  1829. - clipboard : cb (unicode) [create]
  1830. Specifies the clipboard to which animation is copied. Valid clipboards are apiand anim. The default clipboard is: anim
  1831. - controlPoints : cp (bool) [create]
  1832. This flag explicitly specifies whether or not to include the control points of a shape (see -sflag) in the list of
  1833. attributes. Default: false. (Not valid for pasteKeycmd.)
  1834. - float : f (floatrange) [create]
  1835. value uniquely representing a non-time-based key (or key range) on a time-based animCurve. Valid floatRange include
  1836. single values (-f 10) or a string with a lower and upper bound, separated by a colon (-f 10:20
  1837. - forceIndependentEulerAngles : fea (bool) [create]
  1838. Specifies that the rotation curves should always be placed on the clipboard as independent Euler Angles. The default
  1839. value is false. Flag can have multiple arguments, passed either as a tuple or a list.
  1840. - hierarchy : hi (unicode) [create]
  1841. Hierarchy expansion options. Valid values are above,below,both,and none.(Not valid for pasteKeycmd.)
  1842. - includeUpperBound : iub (bool) [create]
  1843. When the -t/time or -f/float flags represent a range of keys, this flag determines whether the keys at the upper bound
  1844. of the range are included in the keyset. Default value: true. This flag is only valid when the argument to the -t/time
  1845. flag is a time range with a lower and upper bound. (When used with the pasteKeycommand, this flag refers only to the
  1846. time range of the target curve that is replaced, when using options such as replace,fitReplace,or scaleReplace.This flag
  1847. has no effect on the curve pasted from the clipboard.)
  1848. - index : index (int) [create]
  1849. index of a key on an animCurve
  1850. - option : o (unicode) [create]
  1851. The option to use when performing the copyKey operation. Valid options are keys,and curve.The default copy option is:
  1852. keys
  1853. - shape : s (bool) [create]
  1854. Consider attributes of shapes below transforms as well, except controlPoints. Default: true. (Not valid for
  1855. pasteKeycmd.)
  1856. - time : t (timerange) [create]
  1857. time uniquely representing a key (or key range) on a time-based animCurve. Valid timeRanges include single values (-t
  1858. 10) or a string with a lower and upper bound, separated by a colon (-t 10:20
  1859. Derived from mel command `maya.cmds.copyKey`
  1860. """
  1861. pass
  1862. def copySkinWeights(*args, **kwargs):
  1863. """
  1864. Command to copy or mirror the skinCluster weights accross one of the three major axes. The command can be used to
  1865. mirror weights either from one surface to another or within the same surface. In query mode, return type
  1866. is based on queried flag.
  1867. Flags:
  1868. - destinationSkin : ds (unicode) [create,query,edit]
  1869. Specify the destination skin shape
  1870. - influenceAssociation : ia (unicode) [create,query,edit]
  1871. The influenceAssociation flag controls how the influences on the source and target skins are matched up. The flag can be
  1872. included multiple times to specify multiple association schemes that will be invoked one after the other until all
  1873. influences have been matched up. Supported values are closestJoint, closestBone, label, name, oneToOne. The default is
  1874. closestJoint.
  1875. - mirrorInverse : mi (bool) [create,query,edit]
  1876. Values are mirrored from the positive side to the negative. If this flag is used then the direction is inverted.
  1877. - mirrorMode : mm (unicode) [create,query,edit]
  1878. The mirrorMode flag defines the plane of mirroring (XY, YZ, or XZ) when the mirror flag is used. The default plane is
  1879. XY.
  1880. - noBlendWeight : nbw (bool) [create,query,edit]
  1881. When the no blend flag is used, the blend weights on the skin cluster will not be copied across to the destination.
  1882. Flag can have multiple arguments, passed either as a tuple or a list.
  1883. - noMirror : nm (bool) [create,query,edit]
  1884. When the no mirror flag is used, the weights are copied instead of mirrored.
  1885. - normalize : nr (bool) [create,query,edit]
  1886. Normalize the skin weights.
  1887. - sampleSpace : spa (int) [create,query,edit]
  1888. Selects which space the attribute transfer is performed in. 0 is world space, 1 is model space. The default is world
  1889. space.
  1890. - smooth : sm (bool) [create,query,edit]
  1891. When the smooth flag is used, the weights are smoothly interpolated between the closest vertices, instead of assigned
  1892. from the single closest.
  1893. - sourceSkin : ss (unicode) [create,query,edit]
  1894. Specify the source skin shape
  1895. - surfaceAssociation : sa (unicode) [create,query,edit]
  1896. The surfaceAssociation flag controls how the weights are transferred between the surfaces: closestPoint, rayCast, or
  1897. closestComponent. The default is closestComponent.
  1898. - uvSpace : uv (unicode, unicode) [create,query,edit]
  1899. The uvSpace flag indicates that the weight transfer should occur in UV space, based on the source and destination UV
  1900. sets specified.
  1901. Derived from mel command `maya.cmds.copySkinWeights`
  1902. """
  1903. pass
  1904. def currentTime(*args, **kwargs):
  1905. """
  1906. When given a time argument (with or without the -edit flag) this command sets the current global time. The model
  1907. updates and displays at the new time, unless -update offis present on the command line.
  1908. Modifications:
  1909. - if no args are provided, the command returns the current time
  1910. Flags:
  1911. - update : u (bool) [create]
  1912. change the current time, but do not update the world. Default value is true. Flag can have multiple
  1913. arguments, passed either as a tuple or a list.
  1914. Derived from mel command `maya.cmds.currentTime`
  1915. """
  1916. pass
  1917. def curveRGBColor(*args, **kwargs):
  1918. """
  1919. This command creates, changes or removes custom curve colors, which are used to draw the curves in the Graph Editor. The
  1920. custom curve names may contain the wildcards ?, which marches a single character, and \*, which matches any number of
  1921. characters. These colors are part of the UI and not part of the saved data for a model. This command is not undoable.
  1922. Flags:
  1923. - hueSaturationValue : hsv (bool) [create,query]
  1924. Indicates that rgb values are really hsv values. Flag can have multiple arguments, passed
  1925. either as a tuple or a list.
  1926. - list : l (bool) [create]
  1927. Writes out a list of all curve color names and their values.
  1928. - listNames : ln (bool) [create]
  1929. Returns an array of all curve color names.
  1930. - remove : r (bool) [create]
  1931. Removes the named curve color.
  1932. - resetToFactory : rf (bool) [create]
  1933. Resets all the curve colors to their factory defaults.
  1934. - resetToSaved : rs (bool) [create]
  1935. Resets all the curve colors to their saved values.
  1936. Derived from mel command `maya.cmds.curveRGBColor`
  1937. """
  1938. pass
  1939. def cutKey(*args, **kwargs):
  1940. """
  1941. This command operates on a keyset. A keyset is defined as a group of keys within a specified time range on one or more
  1942. animation curves. The animation curves comprising a keyset depend on the value of the -animationflag: keysOrObjects: Any
  1943. active keys, when no target objects or -attribute flags appear on the command line, orAll animation curves connected to
  1944. all keyframable attributes of objects specified as the command line's targetList, when there are no active keys.keys:
  1945. Only act on active keys or tangents. If there are no active keys or tangents, don't do anything. objects: Only act on
  1946. specified objects. If there are no objects specified, don't do anything. Note that the -animationflag can be used to
  1947. override the curves uniquely identified by the multi-use -attributeflag, which takes an argument of the form
  1948. attributeName, such as translateX. Keys on animation curves are identified by either their time values or their indices.
  1949. Times and indices can be given individually or as part of a list or range. -time 10palmeans the key at frame 10 (PAL
  1950. format).-time 1.0sec -time 15ntsc -time 20means the keys at time 1.0 second, frame 15 (in NTSC format), and time 20 (in
  1951. the currently defined global time unit).-time 10:20means all keys in the range from 10 to 20, inclusive, in the current
  1952. time unit.Omitting one end of a range means go to infinity, as in the following examples: -time 10:means all keys from
  1953. time 10 (in the current time unit) onwards.-time :10means all keys up to (and including) time 10 (in the current time
  1954. unit).-time :is a short form to specify all keys.-index 0means the first key of each animation curve. (Indices are
  1955. 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
  1956. of each animation curve.The cutKey command cuts curve segment hierarchies from specified targets and puts them in the
  1957. clipboard. The pasteKey command applies these curves to other objects.The shape of the cut curve placed in the
  1958. clipboard, and the effect of the cutKey command on the source animation curve depends on the cutKey -optionspecified.
  1959. Each of these options below will be explained using an example. For all the explanations, let us assume that the source
  1960. animation curve (from which keys will be cut) has 5 keyframes at times 10, 15, 20, 25, and 30.TbaseKeySetCmd.h cutKey -t
  1961. 12:22-option keysKeyframes at times 15 and 20 are removed. All other keys are unchanged.A 5-frame animation curve is
  1962. placed into the keyset clipboard.cutKey -t 12:22-option keysCollapseKeyframes at times 15 and 20 are removed. Shift all
  1963. keys after time 20 to the left by 5 frames, preserving all their values.A 5-frame animation curve is placed into the
  1964. keyset clipboard.cutKey -t 12:22-option keysConnectKeyframes at times 15 and 20 are removed. Shift all keys after time
  1965. 20 to the left by 5 frames, and place the key that used to be at time 25 at the value of the key that used to be at time
  1966. 15.A 5-frame animation curve is placed into the keyset clipboard.cutKey -t 12:22-option curveKeyframes at times 15 and
  1967. 20 are removed. Keys are inserted at times 12 and 22.A 10-frame animation curve is placed into the keyset
  1968. clipboard.cutKey -t 12:22-option curveCollapseKeyframes at times 15 and 20 are removed. Keys are inserted at times 12
  1969. and 22. Shift all keys from time 22 to the left by 10 frames, preserving their values.A 10-frame animation curve is
  1970. placed into the keyset clipboard.cutKey -t 12:22-option curveConnectKeyframes at times 15 and 20 are removed. Keys are
  1971. inserted at times 12 and 22. Shift all keys from time 22 to the left by 10 frames, and replace the key inserted at time
  1972. 12 with the newly inserted key at time 22.A 10-frame animation curve is placed into the keyset clipboard.cutKey -t
  1973. 12:22-option areaCollapseKeyframes at times 15 and 20 are removed. Shift all keys from time 22 to the left by 10 frames,
  1974. preserving their values.A 10-frame animation curve is placed into the keyset clipboard.
  1975. Flags:
  1976. - animation : an (unicode) [create]
  1977. Where this command should get the animation to act on. Valid values are objects,keys,and keysOrObjectsDefault:
  1978. keysOrObjects.(See Description for details.)
  1979. - attribute : at (unicode) [create]
  1980. List of attributes to select
  1981. - clear : cl (bool) [create]
  1982. Just remove the keyframes (i.e. do not overwrite the clipboard)
  1983. - controlPoints : cp (bool) [create]
  1984. This flag explicitly specifies whether or not to include the control points of a shape (see -sflag) in the list of
  1985. attributes. Default: false. (Not valid for pasteKeycmd.)
  1986. - float : f (floatrange) [create]
  1987. value uniquely representing a non-time-based key (or key range) on a time-based animCurve. Valid floatRange include
  1988. single values (-f 10) or a string with a lower and upper bound, separated by a colon (-f 10:20
  1989. - hierarchy : hi (unicode) [create]
  1990. Hierarchy expansion options. Valid values are above,below,both,and none.(Not valid for pasteKeycmd.)
  1991. - includeUpperBound : iub (bool) [create]
  1992. When the -t/time or -f/float flags represent a range of keys, this flag determines whether the keys at the upper bound
  1993. of the range are included in the keyset. Default value: true. This flag is only valid when the argument to the -t/time
  1994. flag is a time range with a lower and upper bound. (When used with the pasteKeycommand, this flag refers only to the
  1995. time range of the target curve that is replaced, when using options such as replace,fitReplace,or scaleReplace.This flag
  1996. has no effect on the curve pasted from the clipboard.)
  1997. - index : index (int) [create]
  1998. index of a key on an animCurve
  1999. - option : o (unicode) [create]
  2000. Option for how to perform the cutKey operation. Valid values for this flag are keys, curve, curveCollapse,
  2001. curveConnect, areaCollapse. The default cut option is: keys
  2002. - selectKey : sl (bool) [create]
  2003. Select the keyframes of curves which have had keys removed Flag can have multiple arguments,
  2004. passed either as a tuple or a list.
  2005. - shape : s (bool) [create]
  2006. Consider attributes of shapes below transforms as well, except controlPoints. Default: true. (Not valid for
  2007. pasteKeycmd.)
  2008. - time : t (timerange) [create]
  2009. time uniquely representing a key (or key range) on a time-based animCurve. Valid timeRanges include single values (-t
  2010. 10) or a string with a lower and upper bound, separated by a colon (-t 10:20
  2011. Derived from mel command `maya.cmds.cutKey`
  2012. """
  2013. pass
  2014. def dagPose(*args, **kwargs):
  2015. """
  2016. This command is used to save and restore the matrix information for a dag hierarchy. Specifically, the data stored will
  2017. restore the translate, rotate, scale, scale pivot, rotate pivot, rotation order, and (for joints) joint order for all
  2018. the objects on the hierarchy. Data for other attributes is not stored by this command. This command can also be used to
  2019. store a bindPose for an object. When you skin an object, a dagPose is automatically created for the skin.
  2020. Flags:
  2021. - addToPose : a (bool) [create]
  2022. Allows adding the selected items to the dagPose.
  2023. - atPose : ap (bool) [query]
  2024. Query whether the hierarchy is at same position as the pose. Names of hierarchy members that are not at the pose
  2025. position will be returned. An empty return list indicates that the hierarchy is at the pose.
  2026. - bindPose : bp (bool) [create,query]
  2027. Used to specify the bindPose for the selected hierarchy. Each hierarchy can have only a single bindPose, which is saved
  2028. automatically at the time of a skin bind. The bindPose is used when adding influence objects, binding new skins, or
  2029. adding flexors. Take care when modifying the bindPose with the -rs/-reset or -rm/-remove flags, since if the bindPose is
  2030. ill-defined it can cause problems with subsequent skinning operations.
  2031. - g : g (bool) [create]
  2032. This flag can be used in conjunction with the restore flag to signal that the members of the pose should be restored to
  2033. the global pose. The global pose means not only is each object locally oriented with respect to its parents, it is also
  2034. in the same global position that it was at when the pose was saved. If a hierarchy's parenting has been changed since
  2035. the time that the pose was saved, you may have trouble reaching the global pose.
  2036. - members : m (bool) [query]
  2037. Query the members of the specified pose. The pose should be specified using the selection list, the -bp/-bindPose or the
  2038. -n/-name flag.
  2039. - name : n (unicode) [create,query]
  2040. Specify the name of the pose. This can be used during create, restore, reset, remove, and query operations to specify
  2041. the pose to be created or acted upon.
  2042. - remove : rm (bool) [create]
  2043. Remove the selected joints from the specified pose.
  2044. - reset : rs (bool) [create]
  2045. Reset the pose on the selected joints. If you are resetting pose data for a bindPose, take care. It is appropriate to
  2046. use the -rs/-reset flag if a joint has been reparented and/or appears to be exactly at the bindPose. However, a bindPose
  2047. that is much different from the exact bindPose can cause problems with subsequent skinning operations.
  2048. - restore : r (bool) [create]
  2049. Restore the hierarchy to a saved pose. To specify the pose, select the pose node, or use the -bp/-bindPose or -n/-name
  2050. flag.
  2051. - save : s (bool) [create]
  2052. Save a dagPose for the selected dag hierarchy. The name of the new pose will be returned.
  2053. - selection : sl (bool) [create,query]
  2054. Whether or not to store a pose for all items in the hierarchy, or for only the selected items.
  2055. - worldParent : wp (bool) [create]
  2056. Indicates that the selected pose member should be recalculated as if it is parented to the world. This is typically used
  2057. when you plan to reparent the object to world as the next operation. Flag can have multiple
  2058. arguments, passed either as a tuple or a list.
  2059. Derived from mel command `maya.cmds.dagPose`
  2060. """
  2061. pass
  2062. def defineDataServer(*args, **kwargs):
  2063. """
  2064. Connects to the specified data servername, creating a named device which then can be attached to device handlers. When
  2065. the device is defined, it queries queries the server for data axis information. The CapChannelspresent are represented
  2066. as axis in form channelName.usagefor scalar channels and channelName.componentfor compound channels. See
  2067. listInputDeviceAxesto list axis names. Note that undoing defineDataServer -d myDevice-s myServerdoes not break the
  2068. connection with the data server until it cannot be redone. Executing any other command (sphere for example) will cause
  2069. this to occur. Similarly, the command defineDataServer -d myDevice-u does not break the connection with the data server
  2070. until it cannot be undone. Either flushUndo, or the 'defineDataServer' command fallingoff the end of the undo queue
  2071. causes this to occur, and the connection. to be broken. No return value.
  2072. Flags:
  2073. - device : d (unicode) [create]
  2074. specified the device name to be given to the server connection. device name must be unique or the command fails.
  2075. - server : s (unicode) [create]
  2076. specifies the name of the server with which the define device connects, and can be specifiied in two ways name-- the
  2077. name of the server socketServer names of the form nameconnect to the server socket on the localhost corresponding to
  2078. name. If namedoes not begin with /, then /tmp/nameis used. This is the default behavior of most servers. If namebegins
  2079. with /, namedenotes the full path to the socket. host:service- a udp service on the specified host.The servicecan be any
  2080. one of a udp service name,a port number,or a named service of tcpmux,and they are found in that order. If hostis
  2081. omitted, the localhost is used. In any case, if the server cannot be found, the device is not defined (created) and the
  2082. command fails.
  2083. - undefine : u (bool) [create]
  2084. undefines (destroys) the dataServer device, closing the connection with the server. Flag can have
  2085. multiple arguments, passed either as a tuple or a list.
  2086. Derived from mel command `maya.cmds.defineDataServer`
  2087. """
  2088. pass
  2089. def defineVirtualDevice(*args, **kwargs):
  2090. """
  2091. This command defines a virtual device. Virtual devices act like real devices and are useful to manipulate/playback data
  2092. when an command device is not connected to the computer. In query mode, return type is based on queried flag.
  2093. Flags:
  2094. - axis : ax (int) [create]
  2095. Specifies the axis number of the channel. All children have their axis number determined by their parent's axis number
  2096. and the width of the parent channel. If this flag is not used, the order of the channel determines the axis number.
  2097. - channel : c (unicode) [create]
  2098. After a -create is started, channels may be added to the device definition. The channel string wil be the name of the
  2099. channel being added to the device. The -channel flag must also be accompanied by the -usage flag and optionally by the
  2100. -axis flag.
  2101. - clear : cl (bool) [create]
  2102. The -clear option will end a device definition and throw away any defined channels.
  2103. - create : cr (bool) [create]
  2104. Start defining a virtual device. If a device is currently being defined, the -create flag will produce an error.
  2105. - device : d (unicode) [create]
  2106. The -device flag ends the device definition. All of the channels between the -create flag and the -device flag are added
  2107. to the specified device. If that device already exists, the command will fail and the device should be redefined with
  2108. another device name. To see the currently defined devices, use the listInputDevices command. The -device flag is also
  2109. used with -undefine to undefine a virtual device.
  2110. - parent : p (unicode) [create]
  2111. Specified the parent channel of the channel being defined. If the channel does not exist, or is an incompatible type,
  2112. the command will fail.
  2113. - undefine : u (bool) [create]
  2114. Undefines the device specified with the -device flag.
  2115. - usage : use (unicode) [create]
  2116. The -usage option is required for every -channel flag. It describes what usage type the defined channel is. The usage
  2117. types are: unknownscalarposrotposRotquaternionposQuaternionrotXYZrotYZXrotZXYrotXZYrotYXZrotZYXposRotXYZposRotYZXposRotZ
  2118. XYposRotXZYposRotXZYposRotZYXposXposYposZrotXrotYrotZFlag can have multiple arguments, passed either as a tuple or a
  2119. list.
  2120. Derived from mel command `maya.cmds.defineVirtualDevice`
  2121. """
  2122. pass
  2123. def deformer(*args, **kwargs):
  2124. """
  2125. This command creates a deformer of the specified type. The deformer will deform the selected objects.
  2126. Flags:
  2127. - after : af (bool) [create,edit]
  2128. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  2129. flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape
  2130. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  2131. - afterReference : ar (bool) []
  2132. - before : bf (bool) [create,edit]
  2133. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  2134. flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape
  2135. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  2136. - deformerTools : dt (bool) [query]
  2137. Returns the name of the deformer tool objects (if any) as string string ...
  2138. - exclusive : ex (unicode) [create,query]
  2139. Puts the deformation set in a deform partition.
  2140. - frontOfChain : foc (bool) [create,edit]
  2141. This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and
  2142. skin nodes in the shape's history (but not ahead of existing tweak nodes). The input to the deformer will be the
  2143. upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the
  2144. downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and
  2145. edit mode if the deformer has no geometry added yet).
  2146. - geometry : g (unicode) [query,edit]
  2147. The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is
  2148. also specified. When queried, this flag returns string string string ...
  2149. - geometryIndices : gi (bool) []
  2150. - ignoreSelected : ignoreSelected (bool) [create]
  2151. Tells the command to not deform objects on the current selection list
  2152. - name : n (unicode) [create]
  2153. Used to specify the name of the node being created
  2154. - parallel : par (bool) [create,edit]
  2155. Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is
  2156. inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry
  2157. added yet).
  2158. - prune : pr (bool) [edit]
  2159. Removes any points not being deformed by the deformer in its current configuration from the deformer set.
  2160. - remove : rm (bool) [edit]
  2161. Specifies that objects listed after the -g flag should be removed from this deformer.
  2162. - split : sp (bool) [create,edit]
  2163. Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing
  2164. chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
  2165. - type : typ (unicode) [create]
  2166. Specify the type of deformer to create. This flag is required in create mode. Typically the type should specify a loaded
  2167. plugin deformer. This command should typically not be used to create one of the standard deformers such as sculpt,
  2168. lattice, blendShape, wire and cluster, since they have their own customized commands which perform useful specialized
  2169. functionality. Flag can have multiple arguments, passed either as a tuple or a list.
  2170. Derived from mel command `maya.cmds.deformer`
  2171. """
  2172. pass
  2173. def deformerWeights(*args, **kwargs):
  2174. """
  2175. Command to import and export the deformer weights to simple XML file. The Weight data is store in a per vertex fashion
  2176. and reference into a point cloud of vertex data coming from the input geometry of the the deformer. For example a
  2177. cluster deformer would have the following information: On import the weights are then maped back to the given deformer
  2178. based on the method.
  2179. Flags:
  2180. - defaultValue : dv (float) []
  2181. - deformer : df (unicode) [create,query,edit]
  2182. Specify the deformer whose weights should be exported or imported.
  2183. - export : ex (bool) [create,query,edit]
  2184. Export the given deformer
  2185. - ignoreName : ig (bool) [create,query,edit]
  2186. Ignore the names of the layers on import, just use the order of the layers instead. This can be used for case that joint
  2187. names have been changed. Leaving it on only name that match on import will be write to the deformer.
  2188. Flag can have multiple arguments, passed either as a tuple or a list.
  2189. - im : im (bool) [create,query,edit]
  2190. Import the given file to place weight on the listed deformer. See the method flag for details on the weights will be
  2191. mapped to the destination deformer.
  2192. - method : m (unicode) [create,query,edit]
  2193. Set the method for find the weight of a given vertex on import. indexmethod uses the vertex index to map the weights
  2194. onto the object. This is used when the object share the same topology as the exported data. nearestmethod find the
  2195. nearest vertex in the imported data set and set the weight value to that value. This is best used when mapping a higher
  2196. resolution mesh to a lower resolution. barycentricmethod is only support with polygon meshes. It finds the nearest
  2197. triangle of the target geometry and rescales the weights by how close the source point is the the vertices. This is
  2198. normally used with course mesh being mapped to a high resolution mesh. Note that the geometry being used is not the
  2199. shape node but rather the incoming geometry to the deformer. In the case of a skin cluster this would be that bind pose.
  2200. - path : p (unicode) [create,query,edit]
  2201. The path to the given file. Default to the current project.
  2202. - positionTolerance : pt (float) []
  2203. - shape : sh (unicode) [create,query,edit]
  2204. Specify the source deformed shape. CURRENTLY NOT SUPPORTED!
  2205. - weightTolerance : wt (float) []
  2206. - worldSpace : ws (bool) []
  2207. Derived from mel command `maya.cmds.deformerWeights`
  2208. """
  2209. pass
  2210. def deviceManager(*args, **kwargs):
  2211. """
  2212. This command queriers the internal device manager for information on attached devices. In query mode, return
  2213. type is based on queried flag.
  2214. Flags:
  2215. - attachment : att (bool) [query]
  2216. Returns the plugs that a device and axis are attached to. Expects the -deviceIndex and axisIndex to be used in
  2217. conjunction.
  2218. - axisCoordChanges : acc (bool) [query]
  2219. Returns whether the axis coordinate changes. Expects the -deviceIndex and -axisIndex flags to be used in conjunction.
  2220. Flag can have multiple arguments, passed either as a tuple or a list.
  2221. - axisIndex : axi (int) [create,query,edit]
  2222. Used usually in conjunction with other flags, to indicate the index of the axis.
  2223. - axisName : axn (bool) [query]
  2224. Returns the name of the axis. Expects the -deviceIndex and -axisIndex flags to be used in conjunction.
  2225. - axisOffset : axo (bool) [query]
  2226. Returns the offset of the axis. Expects the -deviceIndex and -axisIndex flags to be used in conjunction.
  2227. - axisScale : axs (bool) [query]
  2228. Returns the scale of the axis. Expects the -deviceIndex and -axisIndex flags to be used in conjunction.
  2229. - deviceIndex : dvi (int) [create,query,edit]
  2230. Used usually in conjunction with other flags, to indicate the index of the device.
  2231. - deviceNameFromIndex : dni (int) [query]
  2232. Returns the name of the device with the given index.
  2233. - numAxis : nax (bool) [query]
  2234. Returns the number of axis this device has. Expects the -deviceIndex flag to be used.
  2235. - numDevices : ndv (bool) [query]
  2236. Returns the number of devices currently attached.
  2237. Derived from mel command `maya.cmds.deviceManager`
  2238. """
  2239. pass
  2240. def disconnectJoint(*args, **kwargs):
  2241. """
  2242. This command will break a skeleton at the selected joint and delete any associated handles.
  2243. Flags:
  2244. - attachHandleMode : ahm (bool) [create]
  2245. This flag is obsolete and no longer supported. Flag can have multiple arguments, passed either as a
  2246. tuple or a list.
  2247. - deleteHandleMode : dhm (bool) [create]
  2248. Delete the handle on the associated joint.
  2249. Derived from mel command `maya.cmds.disconnectJoint`
  2250. """
  2251. pass
  2252. def dopeSheetEditor(*args, **kwargs):
  2253. """
  2254. Edit a characteristic of a dope sheet editor
  2255. Flags:
  2256. - autoFit : af (unicode) [query,edit]
  2257. on | off | tgl auto fit-to-view
  2258. - control : ctl (bool) [query]
  2259. Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus.
  2260. Caution: It is possible, at times, for an editor to exist without a control. This flag returns NONEif no control is
  2261. present.
  2262. - defineTemplate : dt (unicode) [create]
  2263. Puts a command in a mode where any other flags and args are parsed and added to the command template specified in the
  2264. argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set
  2265. as the current template.
  2266. - displayActiveKeyTangents : dat (unicode) [edit]
  2267. on | off | tgl display tangents in the editor
  2268. - displayActiveKeys : dak (unicode) [edit]
  2269. on | off | tgl display tangents in the editor
  2270. - displayInfinities : di (unicode) [edit]
  2271. on | off | tgl display infinities in the editor
  2272. - displayKeys : dk (unicode) [edit]
  2273. on | off | tgl display keyframes in the editor
  2274. - displayTangents : dtn (unicode) [edit]
  2275. on | off | tgl display tangents in the editor
  2276. - docTag : dtg (unicode) [create,query,edit]
  2277. Attaches a tag to the Maya editor.
  2278. - exists : ex (bool) [create]
  2279. Returns true|false depending upon whether the specified object exists. Other flags are ignored.
  2280. - filter : f (unicode) [create,query,edit]
  2281. Specifies the name of an itemFilter object to be placed on this editor. This filters the information coming onto the
  2282. main list of the editor.
  2283. - forceMainConnection : fmc (unicode) [create,query,edit]
  2284. Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will
  2285. only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in
  2286. that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the
  2287. -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.
  2288. - hierarchyBelow : hb (bool) [query,edit]
  2289. display animation for objects hierarchically
  2290. - highlightConnection : hlc (unicode) [create,query,edit]
  2291. Specifies the name of a selectionConnection object which the editor will synchronize with its highlight list. Not all
  2292. editors have a highlight list. For those that do, it is a secondary selection list.
  2293. - lockMainConnection : lck (bool) [create,edit]
  2294. Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor.
  2295. Further changes to the original mainConnection are ignored.
  2296. - lookAt : la (unicode) [edit]
  2297. all | selected | currentTime fitView helpers
  2298. - mainListConnection : mlc (unicode) [create,query,edit]
  2299. Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will
  2300. only display items contained in the selectionConnection object.
  2301. - outliner : o (unicode) [query,edit]
  2302. the name of the outliner which is associated with the dope sheet
  2303. - panel : pnl (unicode) [create,query]
  2304. Specifies the panel that the editor belongs to. By default if an editor is created in the create callback of a scripted
  2305. panel it will belong to that panel. If an editor doesn't belong to a panel it will be deleted when the window that it
  2306. is in is deleted.
  2307. - parent : p (unicode) [create,query,edit]
  2308. Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
  2309. - selectionConnection : slc (unicode) [create,query,edit]
  2310. Specifies the name of a selectionConnection object which the editor will synchronize with its own selection list. As
  2311. the user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes
  2312. changes, the editor updates to show the change.
  2313. - selectionWindow : sel (float, float, float, float) [query,edit]
  2314. The selection area specified as left, right, bottom, top respectively. Flag can have multiple
  2315. arguments, passed either as a tuple or a list.
  2316. - showScene : sc (bool) [query,edit]
  2317. display the scene summary object
  2318. - showSummary : ss (bool) [query,edit]
  2319. display the summary object
  2320. - showTicks : stk (bool) [query,edit]
  2321. display per animation tick divider in channel
  2322. - snapTime : st (unicode) [query,edit]
  2323. none | integer | keyframe keyframe move snap in time
  2324. - snapValue : sv (unicode) [query,edit]
  2325. none | integer | keyframe keyframe move snap in values
  2326. - stateString : sts (bool) [query]
  2327. Query only flag. Returns the MEL command that will edit an editor to match the current editor state. The returned
  2328. command string uses the string variable $editorName in place of a specific name.
  2329. - unParent : up (bool) [create,edit]
  2330. Specifies that the editor should be removed from its layout. This cannot be used with query.
  2331. - unlockMainConnection : ulk (bool) [create,edit]
  2332. Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic
  2333. updates.
  2334. - updateMainConnection : upd (bool) [create,edit]
  2335. Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
  2336. - useTemplate : ut (unicode) [create]
  2337. Force the command to use a command template other than the current one.
  2338. Derived from mel command `maya.cmds.dopeSheetEditor`
  2339. """
  2340. pass
  2341. def dropoffLocator(*args, **kwargs):
  2342. """
  2343. This command adds one or more dropoff locators to a wire curve, one for each selected curve point. The dropoff locators
  2344. can be used to provide localized tuning of the wire deformation about the curve point. The arguments are two floats, the
  2345. envelope and percentage, followed by the wire node name and then by the curve point(s).
  2346. Derived from mel command `maya.cmds.dropoffLocator`
  2347. """
  2348. pass
  2349. def effector(*args, **kwargs):
  2350. """
  2351. The effector command is used to set the name or hidden flag for the effector. The standard edit (-e) and query (-q)
  2352. flags are used for edit and query functions.
  2353. Flags:
  2354. - hide : hi (bool) [create,query,edit]
  2355. Specifies whether to hide drawing of effector if attached to a handle. Flag can have multiple
  2356. arguments, passed either as a tuple or a list.
  2357. - name : n (unicode) [create,query,edit]
  2358. Specifies the name of the effector.
  2359. Derived from mel command `maya.cmds.effector`
  2360. """
  2361. pass
  2362. def enableDevice(*args, **kwargs):
  2363. """
  2364. Sets (or queries) the device enable state for actions involving the device. -monitoraffects all assignInputDevice and
  2365. attachDeviceAttr actions for the named device-recordcontrols if the device is recorded (by default) by a recordDevice
  2366. action-apply channelName [channelName ... ]controls if data from the device channel is applied (by default) by
  2367. applyTake to the param curves attached to the named channel.Disabling a channel for applyTake cause applyTake to ignore
  2368. the enable state of all childchannels -- treating them as disabled. In query mode, return type is based on queried flag.
  2369. Flags:
  2370. - apply : a (bool) [create,query]
  2371. enable/disable applyTakefor the specified channel(s) Flag can have multiple arguments, passed
  2372. either as a tuple or a list.
  2373. - device : d (unicode) [create,query]
  2374. specifies the device to change
  2375. - enable : en (bool) [create,query]
  2376. enable (or disable) monitor/record/apply
  2377. - monitor : m (bool) [create,query]
  2378. enables/disables visible update for the device (default)
  2379. - record : rec (bool) [create,query]
  2380. enable/disable recordDevicedevice recording
  2381. Derived from mel command `maya.cmds.enableDevice`
  2382. """
  2383. pass
  2384. def filterCurve(*args, **kwargs):
  2385. """
  2386. The filterCurve command takes a list of anim curve and filters them. Currently only a Euler filter is supported.
  2387. The Euler filter demangles discontinous rotation anim curves into smooth curves.
  2388. Flags:
  2389. - endTime : e (time) [create]
  2390. Specify the end time of the section to filter. If not specified, the last key of the animation curve is used to define
  2391. the end time. Flag can have multiple arguments, passed either as a tuple or a list.
  2392. - filter : f (unicode) [create]
  2393. Specifies the filter type to use. The avalible filters are euler, simplify, and resample. By default euler is used.
  2394. - kernel : ker (unicode) [create]
  2395. The resample kernel is a decimation resampling filter used to resample dense data. It works on the keyframes and may not
  2396. produce the desired results when used with sparse data. The resample filter converts from either uniform or non-uniform
  2397. timestep input data samples to the specified uniform timeStep. Various time domain filters are available and are
  2398. specified with the kernel flag which selects the resampling kernel applied to the keyframes on the animation curves.
  2399. Kernel ValuesclosestClosest sample to output timestamplirpLinear interpolation between closest samplesboxBox filter:
  2400. moving averagetriangleTriangle filter: (1 - |x|) weighted moving averagegaussian2Gaussian2 Filter: (2^(-2x\*x))
  2401. weighted moving averagegaussian4Gaussian4 Filter: (2^(-4x\*x)) weighted moving averageThis filter is onlytargeted at
  2402. decimation resampling -- interpolation resampling is basically unsupported. If your output framerate is much higher
  2403. than your input frame rate (approximate, as the input timestep is not assumed to be regular) the lirp and triangle will
  2404. interpolate (usually) and the rest will either average, or use the closest sample (depending on the phase and frequency
  2405. of the input). However this mode of operation may not give the expected result.
  2406. - maxTimeStep : mxs (float) [create]
  2407. Simplify filter.
  2408. - minTimeStep : mns (float) [create]
  2409. Simplify filter.
  2410. - period : per (float) [create]
  2411. Resample filter
  2412. - startTime : s (time) [create]
  2413. Specify the start time to filter. If not specified, then the first key in the animation curve is used to get the start
  2414. time.
  2415. - timeTolerance : tto (float) [create]
  2416. Simplify filter.
  2417. - tolerance : tol (float) [create]
  2418. Simplify filter.
  2419. Derived from mel command `maya.cmds.filterCurve`
  2420. """
  2421. pass
  2422. def findKeyframe(*args, **kwargs):
  2423. """
  2424. This command operates on a keyset. A keyset is defined as a group of keys within a specified time range on one or more
  2425. animation curves. The animation curves comprising a keyset depend on the value of the -animationflag: keysOrObjects: Any
  2426. active keys, when no target objects or -attribute flags appear on the command line, orAll animation curves connected to
  2427. all keyframable attributes of objects specified as the command line's targetList, when there are no active keys.keys:
  2428. Only act on active keys or tangents. If there are no active keys or tangents, don't do anything. objects: Only act on
  2429. specified objects. If there are no objects specified, don't do anything. Note that the -animationflag can be used to
  2430. override the curves uniquely identified by the multi-use -attributeflag, which takes an argument of the form
  2431. attributeName, such as translateX. Keys on animation curves are identified by either their time values or their indices.
  2432. Times and indices can be given individually or as part of a list or range. -time 10palmeans the key at frame 10 (PAL
  2433. format).-time 1.0sec -time 15ntsc -time 20means the keys at time 1.0 second, frame 15 (in NTSC format), and time 20 (in
  2434. the currently defined global time unit).-time 10:20means all keys in the range from 10 to 20, inclusive, in the current
  2435. time unit.Omitting one end of a range means go to infinity, as in the following examples: -time 10:means all keys from
  2436. time 10 (in the current time unit) onwards.-time :10means all keys up to (and including) time 10 (in the current time
  2437. unit).-time :is a short form to specify all keys.-index 0means the first key of each animation curve. (Indices are
  2438. 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
  2439. of each animation curve.This command will return the time (in current units) of the requested key. For the relative
  2440. direction methods (next, previous) if -time is NOT specified they will use current time. If the specified object is not
  2441. animated the command will return the current time.
  2442. Flags:
  2443. - animation : an (unicode) [create]
  2444. Where this command should get the animation to act on. Valid values are objects,keys,and keysOrObjectsDefault:
  2445. keysOrObjects.(See Description for details.)
  2446. - attribute : at (unicode) [create]
  2447. List of attributes to select
  2448. - controlPoints : cp (bool) [create]
  2449. This flag explicitly specifies whether or not to include the control points of a shape (see -sflag) in the list of
  2450. attributes. Default: false. (Not valid for pasteKeycmd.)
  2451. - curve : c (bool) [create]
  2452. Return a list of the existing curves driving the selected object or attributes. The which, index, floatRange, timeRange,
  2453. and includeUpperBound flags are ignored when this flag is used. Flag can have multiple
  2454. arguments, passed either as a tuple or a list.
  2455. - float : f (floatrange) [create]
  2456. value uniquely representing a non-time-based key (or key range) on a time-based animCurve. Valid floatRange include
  2457. single values (-f 10) or a string with a lower and upper bound, separated by a colon (-f 10:20
  2458. - hierarchy : hi (unicode) [create]
  2459. Hierarchy expansion options. Valid values are above,below,both,and none.(Not valid for pasteKeycmd.)
  2460. - includeUpperBound : iub (bool) [create]
  2461. When the -t/time or -f/float flags represent a range of keys, this flag determines whether the keys at the upper bound
  2462. of the range are included in the keyset. Default value: true. This flag is only valid when the argument to the -t/time
  2463. flag is a time range with a lower and upper bound. (When used with the pasteKeycommand, this flag refers only to the
  2464. time range of the target curve that is replaced, when using options such as replace,fitReplace,or scaleReplace.This flag
  2465. has no effect on the curve pasted from the clipboard.)
  2466. - index : index (int) [create]
  2467. index of a key on an animCurve
  2468. - shape : s (bool) [create]
  2469. Consider attributes of shapes below transforms as well, except controlPoints. Default: true. (Not valid for
  2470. pasteKeycmd.)
  2471. - time : t (timerange) [create]
  2472. time uniquely representing a key (or key range) on a time-based animCurve. Valid timeRanges include single values (-t
  2473. 10) or a string with a lower and upper bound, separated by a colon (-t 10:20
  2474. - timeSlider : ts (bool) [create]
  2475. Get the next key time from the ticks displayed in the time slider. If this flag is set, then the -an/animation flag is
  2476. ignored.
  2477. - which : w (unicode) [create]
  2478. next | previous | first | last How to find the key
  2479. Derived from mel command `maya.cmds.findKeyframe`
  2480. """
  2481. pass
  2482. def flexor(*args, **kwargs):
  2483. """
  2484. This command creates a flexor. A flexor a deformer plus a set of driving attributes. For example, a flexor might be a
  2485. sculpt object that is driven by a joint's x rotation and a cube's y position.
  2486. Flags:
  2487. - atBones : ab (bool) [create]
  2488. Add a flexor at bones. Flexor will be added at each of the selected bones, or at all bones in the selected skeleton if
  2489. the -ts flag is also specified.
  2490. - atJoints : aj (bool) [create]
  2491. Add a flexor at joints. Flexor will be added at each of the selected joints, or at all joints in the selected skeleton
  2492. if the -ts flag is specified.
  2493. - deformerCommand : dc (unicode) [create]
  2494. String representing underlying deformer command string.
  2495. - list : l (bool) [query]
  2496. List all possible types of flexors. Query mode only.
  2497. - name : n (unicode) [create]
  2498. This flag is obsolete. Flag can have multiple arguments, passed either as a tuple or a list.
  2499. - noScale : ns (bool) [create]
  2500. Do not auto-scale the flexor to the size of the nearby geometry.
  2501. - toSkeleton : ts (bool) [create]
  2502. Specifies that flexors will be added to the entire skeleton rather than just to the selected joints/bones. This flag is
  2503. used in conjunction with the -ab and -aj flags.
  2504. - type : typ (unicode) [create]
  2505. Specifies which type of flexor. To see list of valid types, use the flexor -query -listcommand.
  2506. Derived from mel command `maya.cmds.flexor`
  2507. """
  2508. pass
  2509. def flow(*args, **kwargs):
  2510. """
  2511. The flow command creates a deformation lattice to `bend' the object that is animated along a curve of a motion path
  2512. animation. The motion path animation has to have the follow option set to be on.
  2513. Flags:
  2514. - divisions : dv (int, int, int) [query]
  2515. This flag specifies the number of lattice slices in x,y,z.The default values are 2 5 2.When queried, it returns the
  2516. TuInt32 TuInt32 TuInt32
  2517. - localCompute : lc (bool) [query]
  2518. This flag specifies whether or not to have local control over the object deformation.Default value: is on when the
  2519. lattice is around the curve, and is off when the lattice is around the object. When queried, it returns a boolean
  2520. - localDivisions : ld (int, int, int) [query]
  2521. This flag specifies the extent of the region of effect.Default values are 2 2 2.When queried, it returns the TuInt32
  2522. TuInt32 TuInt32
  2523. - objectCentered : oc (bool) [query]
  2524. This flag specifies whether to create the lattice around the selected object at its center, or to create the lattice
  2525. around the curve.Default value is true.When queried, it returns a booleanFlag can have multiple arguments, passed either
  2526. as a tuple or a list.
  2527. Derived from mel command `maya.cmds.flow`
  2528. """
  2529. pass
  2530. def geometryConstraint(*args, **kwargs):
  2531. """
  2532. Constrain an object's position based on the shape of the target surface(s) at the closest point(s) to the object. A
  2533. geometryConstraint takes as input one or more surface shapes (the targets) and a DAG transform node (the object). The
  2534. geometryConstraint position constrained object such object lies on the surface of the target with the greatest weight
  2535. value. If two targets have the same weight value then the one with the lowest index is chosen.
  2536. Maya Bug Fix:
  2537. - when queried, angle offsets would be returned in radians, not current angle unit
  2538. Modifications:
  2539. - added new syntax for querying the weight of a target object, by passing the constraint first::
  2540. aimConstraint( 'pCube1_aimConstraint1', q=1, weight ='pSphere1' )
  2541. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =['pSphere1', 'pCylinder1'] )
  2542. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =[] )
  2543. Flags:
  2544. - layer : l (unicode) [create,edit]
  2545. Specify the name of the animation layer where the constraint should be added. Flag can have multiple
  2546. arguments, passed either as a tuple or a list.
  2547. - name : n (unicode) [create,query,edit]
  2548. Sets the name of the constraint node to the specified name. Default name is constrainedObjectName_constraintType
  2549. - remove : rm (bool) [edit]
  2550. removes the listed target(s) from the constraint.
  2551. - targetList : tl (bool) [query]
  2552. Return the list of target objects.
  2553. - weight : w (float) [create,query,edit]
  2554. Sets the weight value for the specified target(s). If not given at creation time, the default value of 1.0 is used.
  2555. - weightAliasList : wal (bool) [query]
  2556. Returns the names of the attributes that control the weight of the target objects. Aliases are returned in the same
  2557. order as the targets are returned by the targetList flag
  2558. Derived from mel command `maya.cmds.geometryConstraint`
  2559. """
  2560. pass
  2561. def getCurrentTime():
  2562. """
  2563. get the current time as a float
  2564. """
  2565. pass
  2566. def ikHandle(*args, **kwargs):
  2567. """
  2568. The handle command is used to create, edit, and query a handle within Maya. The standard edit (-e) and query (-q) flags
  2569. are used for edit and query functions. If there are 2 joints selected and neither -startJoint nor -endEffector flags are
  2570. not specified, then the handle will be created from the selected joints. If a single joint is selected and neither
  2571. -startJoint nor -endEffector flags are specified, then the handle will be created with the selected joint as the end-
  2572. effector and the start joint will be the top of the joint chain containing the end effector. The default values of the
  2573. flags are: -name ikHandle#-priority 1-weight 1.0-positionWeight 1.0-solver ikRPsolver-forceSolver on-
  2574. snapHandleFlagToggle on-sticky off-createCurve true-simplifyCurve true-rootOnCurve true-twistType linear-createRootAxis
  2575. false-parentCurve true-snapCurve false-numSpans 1-rootTwistMode false.These attributes can be specified in creation
  2576. mode, edited in edit mode (-e) or queried in query mode (-q).
  2577. Modifications:
  2578. - returns a PyNode object for flags: (query and endEffector)
  2579. - returns a list of PyNode objects for flags: (query and jointList)
  2580. Flags:
  2581. - autoPriority : ap (bool) [edit]
  2582. Specifies that this handle's priority is assigned automatically. The assigned priority will be based on the hierarchy
  2583. distance from the root of the skeletal chain to the start joint of the handle.
  2584. - connectEffector : ce (bool) [create,edit]
  2585. This option is set to true as default, meaning that end-effector translate is connected with the endJoint translate.
  2586. - createCurve : ccv (bool) [create]
  2587. Specifies if a curve should automatically be created for the ikSplineHandle.
  2588. - createRootAxis : cra (bool) [create]
  2589. Specifies if a root transform should automatically be created above the joints affected by the ikSplineHandle. This
  2590. option is used to prevent the root flipping singularity on a motion path.
  2591. - curve : c (PyNode) [create,query,edit]
  2592. Specifies the curve to be used by the ikSplineHandle. Joints will be moved to align with this curve. This flag is
  2593. mandatory if you use the -freezeJoints option.
  2594. - disableHandles : dh (bool) [edit]
  2595. set given handles to full fk (ikBlend attribute = 0.0)
  2596. - enableHandles : eh (bool) [edit]
  2597. set given handles to full ik (ikBlend attribute = 1.0)
  2598. - endEffector : ee (unicode) [create,query,edit]
  2599. Specifies the end-effector of the handle's joint chain. The end effector may be specified with a joint or an end-
  2600. effector. If a joint is specified, an end-effector will be created at the same position as the joint and this new end-
  2601. effector will be used as the end-effector.
  2602. - exists : ex (unicode) [edit]
  2603. Indicates if the specified handle exists or not.
  2604. - forceSolver : fs (bool) [create,query,edit]
  2605. Forces the solver to be used everytime. It could also be known as animSticky. So, after you set the first key the handle
  2606. is sticky.
  2607. - freezeJoints : fj (bool) [create,edit]
  2608. Forces the curve, specfied by -curve option, to align itself along the existing joint chain. When false, or unspecified,
  2609. the joints will be moved to positions along the specified curve.
  2610. - jointList : jl (bool) [query]
  2611. Returns the list of joints that the handle is manipulating.
  2612. - name : n (unicode) [create,query,edit]
  2613. Specifies the name of the handle.
  2614. - numSpans : ns (int) [create]
  2615. Specifies the number of spans in the automatically generated curve of the ikSplineHandle.
  2616. - parentCurve : pcv (bool) [create]
  2617. Specifies if the curve should automatically be parented to the parent of the first joint affected by the ikSplineHandle.
  2618. - positionWeight : pw (float) [create,query,edit]
  2619. Specifies the position/orientation weight of a handle. This is used to compute the distancebetween the goal position and
  2620. the end-effector position. A positionWeight of 1.0 computes the distance as the distance between positions only and
  2621. ignores the orientations. A positionWeight of 0.0 computes the distance as the distance between the orientations only
  2622. and ignores the positions. A positionWeight of 0.5 attempts to weight the distances equally but cannot actually compute
  2623. this due to unit differences. Because there is no way to add linear units and angular units.
  2624. - priority : p (int) [create,query,edit]
  2625. Sets the priority of the handle. Logically, all handles with a lower number priority are solved before any handles with
  2626. a higher numbered priority. (All handles of priority 1 are solved before any handles of priority 2 and so on.) Handle
  2627. priorities must be ] 0.
  2628. - rootOnCurve : roc (bool) [create,query,edit]
  2629. Specifies if the root is locked onto the curve of the ikSplineHandle.
  2630. - rootTwistMode : rtm (bool) [create,query,edit]
  2631. Specifies whether the start joint is allowed to twist or not. If not, then the required twist is distributed over the
  2632. remaining joints. This applies to all the twist types. Flag can have multiple arguments, passed
  2633. either as a tuple or a list.
  2634. - setupForRPsolver : srp (bool) [edit]
  2635. If the flag is set and ikSolver is ikRPsolver, call RPRotateSetup for the new ikHandle. It is for ikRPsolver only.
  2636. - simplifyCurve : scv (bool) [create]
  2637. Specifies if the ikSplineHandle curve should be simplified.
  2638. - snapCurve : snc (bool) [create]
  2639. Specifies if the curve should automatically snap to the first joint affected by the ikSplineHandle.
  2640. - snapHandleFlagToggle : shf (bool) [create,query,edit]
  2641. Specifies that the handle position should be snapped to the end-effector position if the end-effector is moved by the
  2642. user. Setting this flag on allows you to use forward kinematics to pose or adjust your skeleton and then to animate it
  2643. with inverse kinematics.
  2644. - snapHandleToEffector : see (bool) [edit]
  2645. All handles are immediately moved so that the handle position and orientation matches the end-effector position and
  2646. orientation.
  2647. - solver : sol (unicode) [create,query,edit]
  2648. Specifies the solver. The complete list of available solvers may not be known until run-time because some of the
  2649. solvers may be implemented as plug-ins. Currently the only valid solver are ikRPsolver, ikSCsolver and ikSplineSolver.
  2650. - startJoint : sj (unicode) [create,query,edit]
  2651. Specifies the start joint of the handle's joint chain.
  2652. - sticky : s (unicode) [create,query,edit]
  2653. Specifies that this handle is sticky. Valid values are off, sticky, superSticky. Sticky handles are solved when the
  2654. skeleton is being manipulated interactively. If a character has sticky feet, the solver will attempt to keep them in
  2655. the same position as the user moves the character's root. If they were not sticky, they would move along with the root.
  2656. - twistType : tws (unicode) [create,query,edit]
  2657. Specifies the type of interpolation to be used by the ikSplineHandle. The interpolation options are linear, easeIn,
  2658. easeOut, and easeInOut.
  2659. - weight : w (float) [create,query,edit]
  2660. Specifies the handles weight in error calculations. The weight only applies when handle goals are in conflict and
  2661. cannot be solved simultaneously. When this happens, a solution is computed that weights the distancefrom each goal to
  2662. the solution by the handle's weight and attempts to minimize this value. The weight must be ]= 0.
  2663. Derived from mel command `maya.cmds.ikHandle`
  2664. """
  2665. pass
  2666. def ikHandleDisplayScale(*args, **kwargs):
  2667. """
  2668. This action modifies and queries the current display size of ikHandle. The default display scale is 1.0. In query mode,
  2669. return type is based on queried flag.
  2670. Flags:
  2671. Derived from mel command `maya.cmds.ikHandleDisplayScale`
  2672. """
  2673. pass
  2674. def ikSolver(*args, **kwargs):
  2675. """
  2676. The ikSolver command is used to set the attributes for an IK Solver or create a new one. The standard edit (-e) and
  2677. query (-q) flags are used for edit and query functions.
  2678. Flags:
  2679. - epsilon : ep (float) [create,query,edit]
  2680. max error
  2681. - maxIterations : mxi (int) [create,query,edit]
  2682. Sets the max iterations for a solution
  2683. - name : n (unicode) [create,query,edit]
  2684. Name of solver
  2685. - solverType : st (unicode) [create,query,edit]
  2686. valid solverType (only ikSystem knows what is valid) for creation of a new solver (required) Flag
  2687. can have multiple arguments, passed either as a tuple or a list.
  2688. Derived from mel command `maya.cmds.ikSolver`
  2689. """
  2690. pass
  2691. def ikSystem(*args, **kwargs):
  2692. """
  2693. The ikSystem command is used to set the global snapping flag for handles and set the global solve flag for solvers. The
  2694. standard edit (-e) and query (-q) flags are used for edit and query functions.
  2695. Flags:
  2696. - allowRotation : ar (bool) [query,edit]
  2697. Set true to allow rotation of an ik handle with keys set on translation. Flag can have multiple
  2698. arguments, passed either as a tuple or a list.
  2699. - autoPriority : ap (bool) [edit]
  2700. set autoPriority for all ikHandles
  2701. - autoPriorityMC : apm (bool) [edit]
  2702. set autoPriority for all multiChain handles
  2703. - autoPrioritySC : aps (bool) [edit]
  2704. set autoPriority for all singleChain handles
  2705. - list : ls (int, int) [query,edit]
  2706. returns the solver execution order when in query mode(list of strings) changes execution order when in edit mode (int
  2707. old position, int new position)
  2708. - snap : sn (bool) [query,edit]
  2709. Set global snapping
  2710. - solve : sol (bool) [query,edit]
  2711. Set global solve
  2712. - solverTypes : st (bool) [query]
  2713. returns a list of valid solverTypes ( query only )
  2714. Derived from mel command `maya.cmds.ikSystem`
  2715. """
  2716. pass
  2717. def ikSystemInfo(*args, **kwargs):
  2718. """
  2719. This action modifies and queries the current ikSystem controls. In query mode, return type is based on
  2720. queried flag.
  2721. Flags:
  2722. - globalSnapHandle : gsh (bool) [create,query]
  2723. If this flag is off, all ikHandles will not be snapped. Flag can have multiple arguments, passed
  2724. either as a tuple or a list.
  2725. Derived from mel command `maya.cmds.ikSystemInfo`
  2726. """
  2727. pass
  2728. def ikfkDisplayMethod(*args, **kwargs):
  2729. """
  2730. The ikfkDisplayMethodcommand is used to specify how ik/fk blending should be shown In query mode,
  2731. return type is based on queried flag.
  2732. Flags:
  2733. - display : d (unicode) [create,query]
  2734. Specify how ik/fk blending should be shown when the handle is selected. Possible choices are none(do not display any
  2735. blending), ik(only show ik),fk(only show fk), and ikfk(show both ik and fk).
  2736. Flag can have multiple arguments, passed either as a tuple or a list.
  2737. Derived from mel command `maya.cmds.ikfkDisplayMethod`
  2738. """
  2739. pass
  2740. def insertJoint(*args, **kwargs):
  2741. """
  2742. This command will insert a new joint under the given or selected joint. If the given joint has child joints, they will
  2743. be reparented under the new inserted joint. The given joint(or selected joint) should not have skin attached. The
  2744. command works on the selected joint. No options or flags are necessary.
  2745. Derived from mel command `maya.cmds.insertJoint`
  2746. """
  2747. pass
  2748. def joint(*args, **kwargs):
  2749. """
  2750. The joint command is used to create, edit, and query, joints within Maya. (The standard edit(-e) and query(-q) flags are
  2751. used for edit and query functions). If the object is not specified, the currently selected object (dag object) will be
  2752. used. Multiple objects are allowed only for the edit mode. The same edit flags will be applied on all the joints
  2753. selected, except for -p without -r (set joint position in the world space). An ik handle in the object list is
  2754. equivalent to the list of joints the ik handle commands. When -ch/children is present, all the child joints of the
  2755. specified joints, including the joints implied by possible ik handles, will also be included. In the creation mode, a
  2756. new joint will be created as a child of a selected transform or starts a hierarchy by itself if no transform is
  2757. selected. An ik handle will be treated as a transform in the creation mode. The default values of the arguments are:
  2758. -degreeOfFreedom xyz -name Joint#-position 0 0 0 -absolute -dof xyz-scale 1.0 1.0 1.0 -scaleCompensate true -orientation
  2759. 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
  2760. -angleZ 0.0 -stiffnessX 0.0 -stiffnessY 0.0 -stiffnessZ 0.0 -limitSwitchX no -limitSwitchY no -limitSwitchZ no
  2761. -rotationOrder xyz Those arguments can be specified in the creation mode, editied in the edit mode (-e), or queried in
  2762. the query mode (-q).
  2763. Maya Bug Fix:
  2764. - when queried, limitSwitch*, stiffness*, and angle* flags returned lists, each with one value, instead
  2765. of single values. Values are now properly unpacked
  2766. Flags:
  2767. - absolute : a (bool) [create,query,edit]
  2768. The joint center position is in absolute world coordinates. (This is the default.)
  2769. - angleX : ax (float) [create,query,edit]
  2770. Set the x-axis angle. When queried, this flag returns a float.
  2771. - angleY : ay (float) [create,query,edit]
  2772. Set the y-axis angle. When queried, this flag returns a float.
  2773. - angleZ : az (float) [create,query,edit]
  2774. Set the z-axis angle. When queried, this flag returns a float.
  2775. - assumePreferredAngles : apa (bool) [edit]
  2776. Meaningful only in the edit mode. It sets the joint angles to the corresponding preferred angles.
  2777. - automaticLimits : al (bool) [create]
  2778. Meaningful only in edit mode. It sets the joint to appropriate hinge joint with joint limits. It modifies the joint only
  2779. if (a) it connects exactly to two joints (one parent, one child), (b) it does not lie on the line drawn between the two
  2780. connected joints, and the plane it forms with the two connected joints is perpendicular to one of its rotation axes.
  2781. - children : ch (bool) [edit]
  2782. It tells the command to apply all the edit options not only to the selected joints, but also to their descendent joints
  2783. in the DAG.
  2784. - component : co (bool) [create,edit]
  2785. Use with the -position switch to position the joint relative to its parent (like -relative) but to compute new positions
  2786. for all children joints so their world coordinate positions do not change.
  2787. - degreeOfFreedom : dof (unicode) [create,query,edit]
  2788. Specifies the degrees of freedom for the IK. Valid strings consist of non-duplicate letters from x, y, and z. The
  2789. letters in the string indicate what rotations are to be used by IK. The order a letter appear in the string does not
  2790. matter. Examples are x, yz, xyz. When queried, this flag returns a string. Modifying dof will change the locking state
  2791. of the corresponding rotation attributes. The rule is: if an rotation is turned into a dof, it will be unlocked if it is
  2792. currently locked. When it is turned into a non-dof, it will be locked if it is not currently locked.
  2793. - exists : ex (unicode) [query]
  2794. Does the named joint exist? When queried, this flag returns a boolean.
  2795. - limitSwitchX : lsx (bool) [create,query,edit]
  2796. Use the limit the x-axis rotation? When queried, this flag returns a boolean.
  2797. - limitSwitchY : lsy (bool) [create,query,edit]
  2798. Use the limit the y-axis rotation? When queried, this flag returns a boolean.
  2799. - limitSwitchZ : lsz (bool) [create,query,edit]
  2800. Use the Limit the z-axis rotation? When queried, this flag returns a boolean.
  2801. - limitX : lx (float, float) [create,query,edit]
  2802. Set lower and upper limits on the x-axis of rotation. Also turns on the joint limit. When queried, this flag returns 2
  2803. floats.
  2804. - limitY : ly (float, float) [create,query,edit]
  2805. Set lower and upper limits on the y-axis of rotation. Also turns on the joint limit. When queried, this flag returns 2
  2806. floats.
  2807. - limitZ : lz (float, float) [create,query,edit]
  2808. Set lower and upper limits on the z-axis of rotation. Also turns on the joint limit. When queried, this flag returns 2
  2809. floats.
  2810. - name : n (unicode) [create,query,edit]
  2811. Specifies the name of the joint. When queried, this flag returns a string.
  2812. - orientJoint : oj (unicode) [edit]
  2813. The argument can be one of the following strings: xyz, yzx, zxy, zyx, yxz, xzy, none. It modifies the joint orientation
  2814. and scale orientation so that the axis indicated by the first letter in the argument will be aligned with the vector
  2815. from this joint to its first child joint. For example, if the argument is xyz, the x-axis will point towards the child
  2816. joint. The alignment of the remaining two joint orient axes are dependent on whether or not the
  2817. -sao/-secondaryAxisOrient flag is used. If the -sao flag is used, see the documentation for that flag for how the
  2818. remaining axes are aligned. In the absence of a user specification for the secondary axis orientation, the rotation axis
  2819. indicated by the last letter in the argument will be aligned with the vector perpendicular to first axis and the vector
  2820. from this joint to its parent joint. The remaining axis is aligned according the right hand rule. If the argument is
  2821. none, the joint orientation will be set to zero and its effect to the hierarchy below will be offset by modifying the
  2822. scale orientation. The flag will be ignored if: A. the joint has non-zero rotations when the argument is not none. B.
  2823. the joint does not have child joint, or the distance to the child joint is zero when the argument is not none. C. either
  2824. flag -o or -so is set.
  2825. - orientation : o (float, float, float) [create,query,edit]
  2826. The joint orientation. When queried, this flag returns 3 floats.
  2827. - position : p (float, float, float) [create,query,edit]
  2828. Specifies the position of the center of the joint. This position may be relative to the joint's parent or in absolute
  2829. world coordinates (see -r and -a below). When queried, this flag returns 3 floats.
  2830. - radius : rad (float) [create,query,edit]
  2831. Specifies the joint radius.
  2832. - relative : r (bool) [create,query,edit]
  2833. The joint center position is relative to the joint's parent.
  2834. - rotationOrder : roo (unicode) [create,query,edit]
  2835. The rotation order of the joint. The argument can be one of the following strings: xyz, yzx, zxy, zyx, yxz, xzy.
  2836. - scale : s (float, float, float) [create,query,edit]
  2837. Scale of the joint. When queried, this flag returns 3 floats.
  2838. - scaleCompensate : sc (bool) [create,query,edit]
  2839. It sets the scaleCompenstate attribute of the joint to the given argument. When this is true, the scale of the parent
  2840. joint will be compensated before any rotation of this joint is applied, so that the bone to the joint is scaled but not
  2841. the bones to its child joints. When queried, this flag returns an boolean.
  2842. - scaleOrientation : so (float, float, float) [create,query,edit]
  2843. Set the orientation of the coordinate axes for scaling. When queried, this flag returns 3 floats.
  2844. - secondaryAxisOrient : sao (unicode) [edit]
  2845. The argument can be one of the following strings: xup, xdown, yup, ydown, zup, zdown, none. This flag is used in
  2846. conjunction with the -oj/orientJoint flag. It specifies the scene axis that the second axis should align with. For
  2847. example, a flag combination of -oj yzx -sao yupwould result in the y-axis pointing down the bone, the z-axis oriented
  2848. with the scene's positive y-axis, and the x-axis oriented according to the right hand rule.
  2849. - setPreferredAngles : spa (bool) [edit]
  2850. Meaningful only in the edit mode. It sets the preferred angles to the current joint angles.
  2851. - stiffnessX : stx (float) [create,query,edit]
  2852. Set the stiffness (from 0 to 100.0) for x-axis. When queried, this flag returns a float.
  2853. - stiffnessY : sty (float) [create,query,edit]
  2854. Set the stiffness (from 0 to 100.0) for y-axis. When queried, this flag returns a float.
  2855. - stiffnessZ : stz (float) [create,query,edit]
  2856. Set the stiffness (from 0 to 100.0) for z-axis. When queried, this flag returns a float.
  2857. - zeroScaleOrient : zso (bool) [edit]
  2858. It sets the scale orientation to zero and compensate the change by modifing the translation and joint orientation for
  2859. joint or rotation for general transform of all its child transformations. The flag will be ignored if the flag -so is
  2860. set. Flag can have multiple arguments, passed either as a tuple or a list.
  2861. Derived from mel command `maya.cmds.joint`
  2862. """
  2863. pass
  2864. def jointCluster(*args, **kwargs):
  2865. """
  2866. The joint cluster command adds high-level controls to manage the cluster percentage values on a bound skin around a
  2867. joint. JointClusters are one way to create smooth bending behaviour on skin when joints rotate. . a ----
  2868. aboveBound . ____________a_________ . a \ . Joint1 a Joint2 .
  2869. _____________a_______ \ . a \ \ b --- belowBound . a \ \ b .
  2870. \ b . \ b \ . b\ \ . b \ Joint3
  2871. CVs/vertices between Joint1 and aaaaa (aboveBound) receive only translation/rotation/scale from Joint1. CVs vertices
  2872. between aaaa and bbbb transition between translation/rotatation/scale from Joint1 and Joint2. CV2 beyand bbbbb (below
  2873. bound) receive only translation/ rotation scale from Joint3.
  2874. Flags:
  2875. - aboveBound : ab (float) [create,query,edit]
  2876. Specifies the where the drop-off begins in the direction of the bone above the joint. A value of 100 indicates the
  2877. entire length of the bone. The default value is 10.
  2878. - aboveCluster : ac (bool) [query]
  2879. Returns the name of the cluster associated with the bone above this joint.
  2880. - aboveDropoffType : adt (unicode) [create,query,edit]
  2881. Specifies the type of percentage drop-off in the direction of the bone above this joint. Valid values are linear,
  2882. exponential, sineand none. Default is linear.
  2883. - aboveValue : av (float) [create,query,edit]
  2884. Specifies the drop-off percentage of the joint cluster in the direction of the bone above the cluster. A value of 100
  2885. indicates the entire length of the bone. The default value is 50.
  2886. - belowBound : bb (float) [create,query,edit]
  2887. Specifies where the drop-off ends in the direction of the bone below the joint. A value of 100 indicates the entire
  2888. length of the bone. The default value is 10.
  2889. - belowCluster : bc (bool) [query]
  2890. Returns the name of the cluster associated with this joint.
  2891. - belowDropoffType : bdt (unicode) [create,query,edit]
  2892. Specifies the type of type of percentage drop-off in the direction of the bone below this joint. Valid values are
  2893. linear, exponential, sineand none. Default is linear.
  2894. - belowValue : bv (float) [create,query,edit]
  2895. Specifies the drop-off percentage of the joint cluster in the direction of the joint below the cluster. A value of 100
  2896. indicates the entire length of the bone. The default value is 50.
  2897. - deformerTools : dt (bool) [query]
  2898. Used to query for the helper nodes associated with the jointCluster.
  2899. - joint : j (unicode) [create]
  2900. Specifies the joint that the cluster should act about.
  2901. - name : n (unicode) [create]
  2902. This flag is obsolete. Flag can have multiple arguments, passed either as a tuple or a list.
  2903. Derived from mel command `maya.cmds.jointCluster`
  2904. """
  2905. pass
  2906. def jointDisplayScale(*args, **kwargs):
  2907. """
  2908. This action modifies and queries the current display size of skelton joints. The joint display size is controlled by a
  2909. scale factor; scale factor 1 puts the display size to its default, which is 1 in diameter. With the plain format, the
  2910. float argument is the factor with respect to the default size. When -a/absolute is used, the float argument refers to
  2911. the actual diameter of the joint display size. In query mode, return type is based on queried flag.
  2912. Flags:
  2913. - absolute : a (bool) [create,query]
  2914. Interpret the float argument as the actual display size as opposed to the scale factor.
  2915. - ikfk : ik (bool) [create,query]
  2916. Set the display size of ik/fk skeleton joints. Flag can have multiple arguments, passed either as a
  2917. tuple or a list.
  2918. Derived from mel command `maya.cmds.jointDisplayScale`
  2919. """
  2920. pass
  2921. def jointLattice(*args, **kwargs):
  2922. """
  2923. This command creates/edits/queries a jointLattice deformer. The name of the created/edited object is returned. Usually
  2924. you would make use of this functionality through the higher level flexor command.
  2925. Flags:
  2926. - after : af (bool) [create,edit]
  2927. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  2928. flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape
  2929. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  2930. - afterReference : ar (bool) []
  2931. - before : bf (bool) [create,edit]
  2932. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  2933. flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape
  2934. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  2935. - creasing : cr (float) [create,query,edit]
  2936. Affects the bulging of lattice points on the inside of the bend. Positive/negative values cause the points to bulge
  2937. outwards/inwards. Default value is 0.0. When queried, this flag returns a float.
  2938. - deformerTools : dt (bool) [query]
  2939. Returns the name of the deformer tool objects (if any) as string string ...
  2940. - exclusive : ex (unicode) [create,query]
  2941. Puts the deformation set in a deform partition.
  2942. - frontOfChain : foc (bool) [create,edit]
  2943. This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and
  2944. skin nodes in the shape's history (but not ahead of existing tweak nodes). The input to the deformer will be the
  2945. upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the
  2946. downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and
  2947. edit mode if the deformer has no geometry added yet).
  2948. - geometry : g (unicode) [query,edit]
  2949. The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is
  2950. also specified. When queried, this flag returns string string string ...
  2951. - geometryIndices : gi (bool) []
  2952. - ignoreSelected : ignoreSelected (bool) [create]
  2953. Tells the command to not deform objects on the current selection list
  2954. - joint : j (unicode) [create]
  2955. Specifies the joint which will be used to drive the bulging behaviours.
  2956. - lengthIn : li (float) [create,query,edit]
  2957. Affects the location of lattice points on the parent bone. Positive/negative values cause the points to move
  2958. away/towards the joint. Changing this parameter also modifies the regions affected by the creasing, rounding and width
  2959. parameters. Default value is 0.0. When queried, this flag returns a float.
  2960. - lengthOut : lo (float) [create,query,edit]
  2961. Affects the location of lattice points on the child bone. Positive/negative values cause the points to move away/towards
  2962. the joint. Changing this parameter also modifies the regions affected by the creasing, rounding and width parameters.
  2963. Default value is 0.0. When queried, this flag returns a float.
  2964. - lowerBindSkin : lb (unicode) [create]
  2965. Specifies the node which is performing the bind skin operation on the geometry associated with the lower bone.
  2966. Flag can have multiple arguments, passed either as a tuple or a list.
  2967. - lowerTransform : lt (unicode) [create]
  2968. Specifies which dag node is being used to rigidly transform the lower part of the lattice which this node is going to
  2969. deform. If this flag is not specified an identity matrix will be assumed.
  2970. - name : n (unicode) [create]
  2971. Used to specify the name of the node being created
  2972. - parallel : par (bool) [create,edit]
  2973. Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is
  2974. inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry
  2975. added yet).
  2976. - prune : pr (bool) [edit]
  2977. Removes any points not being deformed by the deformer in its current configuration from the deformer set.
  2978. - remove : rm (bool) [edit]
  2979. Specifies that objects listed after the -g flag should be removed from this deformer.
  2980. - rounding : ro (float) [create,query,edit]
  2981. Affects the bulging of lattice points on the outside of the bend. Positive/negative values cause the points to bulge
  2982. outwards/inwards. Default value is 0.0. When queried, this flag returns a float.
  2983. - split : sp (bool) [create,edit]
  2984. Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing
  2985. chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
  2986. - upperBindSkin : ub (unicode) [create]
  2987. Specifies the node which is performing the bind skin operation on the geometry associated with the upper bone.
  2988. - upperTransform : ut (unicode) [create]
  2989. Specifies which dag node is being used to rigidly transform the upper part of the lattice which this node is going to
  2990. deform. If this flag is not specified an identity matrix will be assumed.
  2991. - widthLeft : wl (float) [create,query,edit]
  2992. Affects the bulging of lattice points on the left side of the bend. Positive/negative values cause the points to bulge
  2993. outwards/inwards. Default value is 0.0. When queried, this flag returns a float.
  2994. - widthRight : wr (float) [create,query,edit]
  2995. Affects the bulging of lattice points on the right side of the bend. Positive/negative values cause the points to bulge
  2996. outwards/inwards. Default value is 0.0. When queried, this flag returns a float.
  2997. Derived from mel command `maya.cmds.jointLattice`
  2998. """
  2999. pass
  3000. def keyTangent(*args, **kwargs):
  3001. """
  3002. This command operates on a keyset. A keyset is defined as a group of keys within a specified time range on one or more
  3003. animation curves. The animation curves comprising a keyset depend on the value of the -animationflag: keysOrObjects: Any
  3004. active keys, when no target objects or -attribute flags appear on the command line, orAll animation curves connected to
  3005. all keyframable attributes of objects specified as the command line's targetList, when there are no active keys.keys:
  3006. Only act on active keys or tangents. If there are no active keys or tangents, don't do anything. objects: Only act on
  3007. specified objects. If there are no objects specified, don't do anything. Note that the -animationflag can be used to
  3008. override the curves uniquely identified by the multi-use -attributeflag, which takes an argument of the form
  3009. attributeName, such as translateX. Keys on animation curves are identified by either their time values or their indices.
  3010. Times and indices can be given individually or as part of a list or range. -time 10palmeans the key at frame 10 (PAL
  3011. format).-time 1.0sec -time 15ntsc -time 20means the keys at time 1.0 second, frame 15 (in NTSC format), and time 20 (in
  3012. the currently defined global time unit).-time 10:20means all keys in the range from 10 to 20, inclusive, in the current
  3013. time unit.Omitting one end of a range means go to infinity, as in the following examples: -time 10:means all keys from
  3014. time 10 (in the current time unit) onwards.-time :10means all keys up to (and including) time 10 (in the current time
  3015. unit).-time :is a short form to specify all keys.-index 0means the first key of each animation curve. (Indices are
  3016. 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
  3017. of each animation curve.This command edits or queries tangent properties of keyframes in a keyset. It is also used to
  3018. edit or query the default tangent type of newly created keyframes (see the setKeyframe command for more information on
  3019. how to override this default). Tangents help manage the shape of the animation curve and affect the interpolation
  3020. between keys. The tangent angle specifies the direction the curve will take as it leaves (or enters) a key. The tangent
  3021. weight specifies how much influence the tangent angle has on the curve before the curve starts towards the next key.
  3022. Maya internally represents tangents as x and y values. Refer to the API documentation for MFnAnimCurve for a
  3023. description of the relationship between tangent angle and weight and the internal x and y values.
  3024. Flags:
  3025. - absolute : a (bool) [create,edit]
  3026. Changes to tangent positions are NOT relative to the current position.
  3027. - animation : an (unicode) [create]
  3028. Where this command should get the animation to act on. Valid values are objects,keys,and keysOrObjectsDefault:
  3029. keysOrObjects.(See Description for details.)
  3030. - attribute : at (unicode) [create]
  3031. List of attributes to select
  3032. - controlPoints : cp (bool) [create]
  3033. This flag explicitly specifies whether or not to include the control points of a shape (see -sflag) in the list of
  3034. attributes. Default: false. (Not valid for pasteKeycmd.)
  3035. - float : f (floatrange) [create]
  3036. value uniquely representing a non-time-based key (or key range) on a time-based animCurve. Valid floatRange include
  3037. single values (-f 10) or a string with a lower and upper bound, separated by a colon (-f 10:20
  3038. - g : g (bool) [create]
  3039. Required for all operations on the global tangent type. The global tangent type is used by the setKeyframe command when
  3040. tangent types have not been specifically applied, except in combination with flags such as 'i/insert' which preserve the
  3041. shape of the curve. It is also used when keys are set from the menu. The only flags that can appear on a keyTangent
  3042. command with the 'g/global' flag are 'itt/inTangentType', 'ott/outTangentType' and 'wt/weightedTangents'.
  3043. - hierarchy : hi (unicode) [create]
  3044. Hierarchy expansion options. Valid values are above,below,both,and none.(Not valid for pasteKeycmd.)
  3045. - inAngle : ia (float) [create,query,edit]
  3046. New value for the angle of the in-tangent. Returns a float[] when queried.
  3047. - inTangentType : itt (unicode) [create,query,edit]
  3048. Specify the in-tangent type. Valid values are spline,linear,fast,slow,flat,step,stepnext,fixed,clamped,and
  3049. plateau.Returns a string[] when queried.
  3050. - inWeight : iw (float) [create,query,edit]
  3051. New value for the weight of the in-tangent. Returns a float[] when queried.
  3052. - includeUpperBound : iub (bool) [create]
  3053. When the -t/time or -f/float flags represent a range of keys, this flag determines whether the keys at the upper bound
  3054. of the range are included in the keyset. Default value: true. This flag is only valid when the argument to the -t/time
  3055. flag is a time range with a lower and upper bound. (When used with the pasteKeycommand, this flag refers only to the
  3056. time range of the target curve that is replaced, when using options such as replace,fitReplace,or scaleReplace.This flag
  3057. has no effect on the curve pasted from the clipboard.)
  3058. - index : index (int) [create]
  3059. index of a key on an animCurve
  3060. - ix : ix (float) [create,query,edit]
  3061. New value for the x-component of the in-tangent. This is a unit independent representation of the tangent component.
  3062. Returns a float[] when queried.
  3063. - iy : iy (float) [create,query,edit]
  3064. New value for the y-component of the in-tangent. This is a unit independent representation of the tangent component.
  3065. Returns a float[] when queried.
  3066. - lock : l (bool) [create,query,edit]
  3067. Lock a tangent so in and out tangents move together. Returns an int[] when queried.
  3068. - outAngle : oa (float) [create,query,edit]
  3069. New value for the angle of the out-tangent. Returns a float[] when queried.
  3070. - outTangentType : ott (unicode) [create,query,edit]
  3071. Specify the out-tangent type. Valid values are spline,linear,fast,slow,flat,step,stepnext,fixed,clamped,and
  3072. plateau.Returns a string[] when queried.
  3073. - outWeight : ow (float) [create,query,edit]
  3074. New value for the weight of the out-tangent. Returns a float[] when queried.
  3075. - ox : ox (float) [create,query,edit]
  3076. New value for the x-component of the out-tangent. This is a unit independent representation of the tangent component.
  3077. Returns a float[] when queried.
  3078. - oy : oy (float) [create,query,edit]
  3079. New value for the y-component of the out-tangent. This is a unit independent representation of the tangent component.
  3080. Returns a float[] when queried.
  3081. - relative : r (bool) [create,edit]
  3082. Changes to tangent positions are relative to the current position.
  3083. - shape : s (bool) [create]
  3084. Consider attributes of shapes below transforms as well, except controlPoints. Default: true. (Not valid for
  3085. pasteKeycmd.)
  3086. - stepAttributes : sa (bool) [create,edit]
  3087. The setKeyframe command will automatically set tangents for boolean and enumerated attributes to step. This flag
  3088. mirrors this behavior for the keyTangent command. When set to false, tangents for these attributes will not be edited.
  3089. When set to true (the default) tangents for these attributes will be edited. Flag can have multiple
  3090. arguments, passed either as a tuple or a list.
  3091. - time : t (timerange) [create]
  3092. time uniquely representing a key (or key range) on a time-based animCurve. Valid timeRanges include single values (-t
  3093. 10) or a string with a lower and upper bound, separated by a colon (-t 10:20
  3094. - weightLock : wl (bool) [create,query,edit]
  3095. Lock the weight of a tangent so it is fixed. Returns an int[] when queried. Note: weightLock is only obeyed within the
  3096. graph editor. It is not obeyed when -inWeight/-outWeight are issued from a command.
  3097. - weightedTangents : wt (bool) [create,query,edit]
  3098. Specify whether or not the tangents on the animCurve are weighted Note: switching a curve from weightedTangents true to
  3099. false and back to true again will not preserve fixed tangents properly. Use undo instead.
  3100. Derived from mel command `maya.cmds.keyTangent`
  3101. """
  3102. pass
  3103. def keyframe(*args, **kwargs):
  3104. """
  3105. This command operates on a keyset. A keyset is defined as a group of keys within a specified time range on one or more
  3106. animation curves. The animation curves comprising a keyset depend on the value of the -animationflag: keysOrObjects: Any
  3107. active keys, when no target objects or -attribute flags appear on the command line, orAll animation curves connected to
  3108. all keyframable attributes of objects specified as the command line's targetList, when there are no active keys.keys:
  3109. Only act on active keys or tangents. If there are no active keys or tangents, don't do anything. objects: Only act on
  3110. specified objects. If there are no objects specified, don't do anything. Note that the -animationflag can be used to
  3111. override the curves uniquely identified by the multi-use -attributeflag, which takes an argument of the form
  3112. attributeName, such as translateX. Keys on animation curves are identified by either their time values or their indices.
  3113. Times and indices can be given individually or as part of a list or range. -time 10palmeans the key at frame 10 (PAL
  3114. format).-time 1.0sec -time 15ntsc -time 20means the keys at time 1.0 second, frame 15 (in NTSC format), and time 20 (in
  3115. the currently defined global time unit).-time 10:20means all keys in the range from 10 to 20, inclusive, in the current
  3116. time unit.Omitting one end of a range means go to infinity, as in the following examples: -time 10:means all keys from
  3117. time 10 (in the current time unit) onwards.-time :10means all keys up to (and including) time 10 (in the current time
  3118. unit).-time :is a short form to specify all keys.-index 0means the first key of each animation curve. (Indices are
  3119. 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
  3120. of each animation curve.This command edits the time and/or value of keys of specified objects and/or parameter curves
  3121. Unless otherwise specified by the -query flag, the command defaults to editing keyframes.
  3122. Modifications:
  3123. - returns an empty list when the result is None
  3124. - if both valueChange and timeChange are queried, the result will be a list of (time,value) pairs
  3125. Flags:
  3126. - absolute : a (bool) [create]
  3127. Move amounts are absolute.
  3128. - adjustBreakdown : abd (bool) [create]
  3129. When false, moving keys will not preserve breakdown timing, when true (the default) breakdowns will be adjusted to
  3130. preserve their timing relationship.
  3131. - animation : an (unicode) [create]
  3132. Where this command should get the animation to act on. Valid values are objects,keys,and keysOrObjectsDefault:
  3133. keysOrObjects.(See Description for details.)
  3134. - attribute : at (unicode) [create]
  3135. List of attributes to select
  3136. - breakdown : bd (bool) [create,query,edit]
  3137. Sets the breakdown state for the key. Returns an integer. Default is false. The breakdown state of a key cannot be
  3138. set in the same command as it is moved (i.e., via the -tc or -fc flags).
  3139. - controlPoints : cp (bool) [create]
  3140. This flag explicitly specifies whether or not to include the control points of a shape (see -sflag) in the list of
  3141. attributes. Default: false. (Not valid for pasteKeycmd.)
  3142. - eval : ev (bool) [create,query]
  3143. Returns the value(s) of the animCurves when evaluated (without regard to input connections) at the times given by the
  3144. -t/time or -f/float flags. Cannot be used in combination with other query flags, and cannot be used with time ranges
  3145. (-t 5:10). When no -t or -f flags appear on the command line, the evals are queried at the current time. Query returns
  3146. a float[].
  3147. - float : f (floatrange) [create]
  3148. value uniquely representing a non-time-based key (or key range) on a time-based animCurve. Valid floatRange include
  3149. single values (-f 10) or a string with a lower and upper bound, separated by a colon (-f 10:20
  3150. - floatChange : fc (float) [create,query,edit]
  3151. How much (with -relative) or where (with -absolute) to move keys (on non-time-input animation curves) along the x
  3152. (float) axis. Returns float[] when queried.
  3153. - hierarchy : hi (unicode) [create]
  3154. Hierarchy expansion options. Valid values are above,below,both,and none.(Not valid for pasteKeycmd.)
  3155. - includeUpperBound : iub (bool) [create]
  3156. When the -t/time or -f/float flags represent a range of keys, this flag determines whether the keys at the upper bound
  3157. of the range are included in the keyset. Default value: true. This flag is only valid when the argument to the -t/time
  3158. flag is a time range with a lower and upper bound. (When used with the pasteKeycommand, this flag refers only to the
  3159. time range of the target curve that is replaced, when using options such as replace,fitReplace,or scaleReplace.This flag
  3160. has no effect on the curve pasted from the clipboard.)
  3161. - index : index (timeRange) [create]
  3162. index of a key on an animCurve
  3163. - indexValue : iv (bool) [create,query]
  3164. Query-only flag that returns an int for the key's index.
  3165. - keyframeCount : kc (bool) [create,query]
  3166. Returns an int for the number of keys found for the targets.
  3167. - lastSelected : lsl (bool) [create,query]
  3168. When used in queries, this flag returns requested values for the last selected key. Flag can have
  3169. multiple arguments, passed either as a tuple or a list.
  3170. - name : n (bool) [create,query]
  3171. Returns the names of animCurves of specified nodes, attributes or keys.
  3172. - option : o (unicode) [create,edit]
  3173. Valid values are move,insert,over,and segmentOver.When you movea key, the key will not cross over (in time) any keys
  3174. before or after it. When you inserta key, all keys before or after (depending upon the -timeChange value) will be moved
  3175. an equivalent amount. When you overa key, the key is allowed to move to any time (as long as a key is not there
  3176. already). When you segmentOvera set of keys (this option only has a noticeable effect when more than one key is being
  3177. moved) the first key (in time) and last key define a segment (unless you specify a time range). That segment is then
  3178. allowed to move over other keys, and keys will be moved to make room for the segment.
  3179. - relative : r (bool) [create]
  3180. Move amounts are relative to a key's current position.
  3181. - selected : sl (bool) [create,query]
  3182. When used in queries, this flag returns requested values for any active keys.
  3183. - shape : s (bool) [create]
  3184. Consider attributes of shapes below transforms as well, except controlPoints. Default: true. (Not valid for
  3185. pasteKeycmd.)
  3186. - tickDrawSpecial : tds (bool) [create,edit]
  3187. Sets the special drawing state for this key when it is drawn as a tick in the timeline.
  3188. - time : t (timerange) [create]
  3189. time uniquely representing a key (or key range) on a time-based animCurve. Valid timeRanges include single values (-t
  3190. 10) or a string with a lower and upper bound, separated by a colon (-t 10:20
  3191. - timeChange : tc (time) [create,query,edit]
  3192. How much (with -relative) or where (with -absolute) to move keys (on time-input animation curves) along the x (time)
  3193. axis. Returns float[] when queried.
  3194. - valueChange : vc (float) [create,query,edit]
  3195. How much (with -relative) or where (with -absolute) to move keys along the y (value) axis. Returns float[] when queried.
  3196. Derived from mel command `maya.cmds.keyframe`
  3197. """
  3198. pass
  3199. def keyframeOutliner(*args, **kwargs):
  3200. """
  3201. This command creates/edits/queries a keyframe outliner control.
  3202. Flags:
  3203. - animCurve : ac (unicode) [edit]
  3204. Name of the animation curve for which to display keyframes.
  3205. - annotation : ann (unicode) [create,query,edit]
  3206. Annotate the control with an extra string value.
  3207. - backgroundColor : bgc (float, float, float) [create,query,edit]
  3208. The background color of the control. The arguments correspond to the red, green, and blue color components. Each
  3209. component ranges in value from 0.0 to 1.0. When setting backgroundColor, the background is automatically enabled, unless
  3210. enableBackground is also specified with a false value.
  3211. - defineTemplate : dt (unicode) [create]
  3212. Puts a command in a mode where any other flags and args are parsed and added to the command template specified in the
  3213. argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set
  3214. as the current template.
  3215. - display : dsp (unicode) [query,edit]
  3216. narrow | wide What columns to display. When narrow, time and value will be displayed, when widetangent information will
  3217. be displayed as well Flag can have multiple arguments, passed either as a tuple or a list.
  3218. - docTag : dtg (unicode) [create,query,edit]
  3219. Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt
  3220. render/multiLister/createNode/material
  3221. - dragCallback : dgc (script) [create,edit]
  3222. Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form:
  3223. global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that
  3224. is transferred to the drop site. By convention the first string in the array describes the user settable message type.
  3225. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers
  3226. CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT. In Python, it is similar,
  3227. but there are two ways to specify the callback. The recommended way is to pass a Python function object as the
  3228. argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The
  3229. values of these arguments are the same as those for the MEL version above. The other way to specify the callback in
  3230. Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the
  3231. standard Python format operator. The format values are passed in a dictionary with the keys dragControl, x, y,
  3232. modifiers. The dragControlvalue is a string and the other values are integers (eg the callback string could be print
  3233. '%(dragControl)s %(x)d %(y)d %(modifiers)d'
  3234. - dropCallback : dpc (script) [create,edit]
  3235. Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the
  3236. callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int
  3237. $y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs
  3238. array describes the user defined message type. Controls that are application defined drop sites may ignore the callback.
  3239. $type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify
  3240. the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python
  3241. callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of
  3242. these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to
  3243. specify a string to be executed. In that case, the string will have the values substituted into it via the standard
  3244. Python format operator. The format values are passed in a dictionary with the keys dragControl, dropControl, messages,
  3245. x, y, type. The dragControlvalue is a string and the other values are integers (eg the callback string could be print
  3246. '%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d'
  3247. - enable : en (bool) [create,query,edit]
  3248. The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and
  3249. the control will appear dimmed or greyed-out indicating it is disabled.
  3250. - enableBackground : ebg (bool) [create,query,edit]
  3251. Enables the background color of the control.
  3252. - exists : ex (bool) [create]
  3253. Returns true|false depending upon whether the specified object exists. Other flags are ignored.
  3254. - fullPathName : fpn (unicode) [query]
  3255. Return the full path name of the widget, which includes all the parents
  3256. - height : h (int) [create,query,edit]
  3257. The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
  3258. - isObscured : io (bool) [query]
  3259. Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if
  3260. it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control's
  3261. window is invisible or iconified.
  3262. - manage : m (bool) [create,query,edit]
  3263. Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All
  3264. controls are created managed by default.
  3265. - numberOfPopupMenus : npm (bool) [query]
  3266. Return the number of popup menus attached to this control.
  3267. - parent : p (unicode) [create,query]
  3268. The parent layout for this control.
  3269. - popupMenuArray : pma (bool) [query]
  3270. Return the names of all the popup menus attached to this control.
  3271. - preventOverride : po (bool) [create,query,edit]
  3272. If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
  3273. - useTemplate : ut (unicode) [create]
  3274. Force the command to use a command template other than the current one.
  3275. - visible : vis (bool) [create,query,edit]
  3276. The visible state of the control. A control is created visible by default. Note that a control's actual appearance is
  3277. also dependent on the visible state of its parent layout(s).
  3278. - visibleChangeCommand : vcc (script) [create,query,edit]
  3279. Command that gets executed when visible state of the control changes.
  3280. - width : w (int) [create,query,edit]
  3281. The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
  3282. Derived from mel command `maya.cmds.keyframeOutliner`
  3283. """
  3284. pass
  3285. def keyframeStats(*args, **kwargs):
  3286. """
  3287. All of the group commands position their individual controls in columns starting at column 1. The layout of each
  3288. control (ie. column) can be customized using the -cw/columnWidth, -co/columnOffset, -cat/columnAttach, -cal/columnAlign,
  3289. and -adj/adjustableColumnflags. By default, columns are left aligned with no offset and are 100 pixels wide. Only one
  3290. column in any group can be adjustable. This command creates, edits, queries a keyframe stats control.
  3291. Flags:
  3292. - adjustableColumn : adj (int) [create,edit]
  3293. Specifies which column has an adjustable size that changes with the sizing of the layout. The column value is a 1-based
  3294. index. You may also specify 0 to turn off the previous adjustable column.
  3295. - adjustableColumn2 : ad2 (int) [create,edit]
  3296. Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not
  3297. exactly two columns.
  3298. - adjustableColumn3 : ad3 (int) [create,edit]
  3299. Specifies that the column has an adjustable size that changes with the size of the parent layout. Ignored if there is
  3300. not exactly three columns.
  3301. - adjustableColumn4 : ad4 (int) [create,edit]
  3302. Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not
  3303. exactly four columns.
  3304. - adjustableColumn5 : ad5 (int) [create,edit]
  3305. Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not
  3306. exactly five columns.
  3307. - adjustableColumn6 : ad6 (int) [create,edit]
  3308. Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not
  3309. exactly six columns.
  3310. - animEditor : ae (unicode) [query,edit]
  3311. The name of the animation editor which is associated with the control
  3312. - annotation : ann (unicode) [create,query,edit]
  3313. Annotate the control with an extra string value.
  3314. - backgroundColor : bgc (float, float, float) [create,query,edit]
  3315. The background color of the control. The arguments correspond to the red, green, and blue color components. Each
  3316. component ranges in value from 0.0 to 1.0. When setting backgroundColor, the background is automatically enabled, unless
  3317. enableBackground is also specified with a false value.
  3318. - classicMode : cm (bool) []
  3319. - columnAlign : cal (int, unicode) [create,edit]
  3320. Arguments are : column number, alignment type. Possible alignments are: left | right | center. Specifies alignment type
  3321. for the specified column.
  3322. - columnAlign2 : cl2 (unicode, unicode) [create,edit]
  3323. Sets the text alignment of both columns. Ignored if there is not exactly two columns. Valid values are left, right, and
  3324. center.
  3325. - columnAlign3 : cl3 (unicode, unicode, unicode) [create,edit]
  3326. Sets the text alignment for all 3 columns. Ignored if there is not exactly 3 columns. Valid values are left, right, and
  3327. center.
  3328. - columnAlign4 : cl4 (unicode, unicode, unicode, unicode) [create,edit]
  3329. Sets the text alignment for all 4 columns. Ignored if there is not exactly 4 columns. Valid values are left, right, and
  3330. center.
  3331. - columnAlign5 : cl5 (unicode, unicode, unicode, unicode, unicode) [create,edit]
  3332. Sets the text alignment for all 5 columns. Ignored if there is not exactly 5 columns. Valid values are left, right, and
  3333. center.
  3334. - columnAlign6 : cl6 (unicode, unicode, unicode, unicode, unicode, unicode) [create,edit]
  3335. Sets the text alignment for all 6 columns. Ignored if there is not exactly 6 columns. Valid values are left, right, and
  3336. center.
  3337. - columnAttach : cat (int, unicode, int) [create,edit]
  3338. Arguments are : column number, attachment type, and offset. Possible attachments are: left | right | both. Specifies
  3339. column attachment types and offets.
  3340. - columnAttach2 : ct2 (unicode, unicode) [create,edit]
  3341. Sets the attachment type of both columns. Ignored if there is not exactly two columns. Valid values are left, right,
  3342. and both.
  3343. - columnAttach3 : ct3 (unicode, unicode, unicode) [create,edit]
  3344. Sets the attachment type for all 3 columns. Ignored if there is not exactly 3 columns. Valid values are left, right,
  3345. and both.
  3346. - columnAttach4 : ct4 (unicode, unicode, unicode, unicode) [create,edit]
  3347. Sets the attachment type for all 4 columns. Ignored if there is not exactly 4 columns. Valid values are left, right,
  3348. and both.
  3349. - columnAttach5 : ct5 (unicode, unicode, unicode, unicode, unicode) [create,edit]
  3350. Sets the attachment type for all 5 columns. Ignored if there is not exactly 5 columns. Valid values are left, right,
  3351. and both.
  3352. - columnAttach6 : ct6 (unicode, unicode, unicode, unicode, unicode, unicode) [create,edit]
  3353. Sets the attachment type for all 6 columns. Ignored if there is not exactly 6 columns. Valid values are left, right,
  3354. and both.
  3355. - columnOffset2 : co2 (int, int) [create,edit]
  3356. This flag is used in conjunction with the -columnAttach2 flag. If that flag is not used then this flag will be ignored.
  3357. It sets the offset for the two columns. The offsets applied are based on the attachments specified with the
  3358. -columnAttach2 flag. Ignored if there is not exactly two columns.
  3359. - columnOffset3 : co3 (int, int, int) [create,edit]
  3360. This flag is used in conjunction with the -columnAttach3 flag. If that flag is not used then this flag will be ignored.
  3361. It sets the offset for the three columns. The offsets applied are based on the attachments specified with the
  3362. -columnAttach3 flag. Ignored if there is not exactly three columns.
  3363. - columnOffset4 : co4 (int, int, int, int) [create,edit]
  3364. This flag is used in conjunction with the -columnAttach4 flag. If that flag is not used then this flag will be ignored.
  3365. It sets the offset for the four columns. The offsets applied are based on the attachments specified with the
  3366. -columnAttach4 flag. Ignored if there is not exactly four columns.
  3367. - columnOffset5 : co5 (int, int, int, int, int) [create,edit]
  3368. This flag is used in conjunction with the -columnAttach5 flag. If that flag is not used then this flag will be ignored.
  3369. It sets the offset for the five columns. The offsets applied are based on the attachments specified with the
  3370. -columnAttach5 flag. Ignored if there is not exactly five columns.
  3371. - columnOffset6 : co6 (int, int, int, int, int, int) [create,edit]
  3372. This flag is used in conjunction with the -columnAttach6 flag. If that flag is not used then this flag will be ignored.
  3373. It sets the offset for the six columns. The offsets applied are based on the attachments specified with the
  3374. -columnAttach6 flag. Ignored if there is not exactly six columns.
  3375. - columnWidth : cw (int, int) [create,edit]
  3376. Arguments are : column number, column width. Sets the width of the specified column where the first parameter specifies
  3377. the column (1 based index) and the second parameter specifies the width.
  3378. - columnWidth1 : cw1 (int) [create,edit]
  3379. Sets the width of the first column. Ignored if there is not exactly one column.
  3380. - columnWidth2 : cw2 (int, int) [create,edit]
  3381. Sets the column widths of both columns. Ignored if there is not exactly two columns.
  3382. - columnWidth3 : cw3 (int, int, int) [create,edit]
  3383. Sets the column widths for all 3 columns. Ignored if there is not exactly 3 columns.
  3384. - columnWidth4 : cw4 (int, int, int, int) [create,edit]
  3385. Sets the column widths for all 4 columns. Ignored if there is not exactly 4 columns.
  3386. - columnWidth5 : cw5 (int, int, int, int, int) [create,edit]
  3387. Sets the column widths for all 5 columns. Ignored if there is not exactly 5 columns.
  3388. - columnWidth6 : cw6 (int, int, int, int, int, int) [create,edit]
  3389. Sets the column widths for all 6 columns. Ignored if there is not exactly 6 columns.
  3390. - defineTemplate : dt (unicode) [create]
  3391. Puts a command in a mode where any other flags and args are parsed and added to the command template specified in the
  3392. argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set
  3393. as the current template.
  3394. - docTag : dtg (unicode) [create,query,edit]
  3395. Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt
  3396. render/multiLister/createNode/material
  3397. - dragCallback : dgc (script) [create,edit]
  3398. Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form:
  3399. global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that
  3400. is transferred to the drop site. By convention the first string in the array describes the user settable message type.
  3401. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers
  3402. CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT. In Python, it is similar,
  3403. but there are two ways to specify the callback. The recommended way is to pass a Python function object as the
  3404. argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The
  3405. values of these arguments are the same as those for the MEL version above. The other way to specify the callback in
  3406. Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the
  3407. standard Python format operator. The format values are passed in a dictionary with the keys dragControl, x, y,
  3408. modifiers. The dragControlvalue is a string and the other values are integers (eg the callback string could be print
  3409. '%(dragControl)s %(x)d %(y)d %(modifiers)d'
  3410. - dropCallback : dpc (script) [create,edit]
  3411. Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the
  3412. callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int
  3413. $y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs
  3414. array describes the user defined message type. Controls that are application defined drop sites may ignore the callback.
  3415. $type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify
  3416. the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python
  3417. callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of
  3418. these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to
  3419. specify a string to be executed. In that case, the string will have the values substituted into it via the standard
  3420. Python format operator. The format values are passed in a dictionary with the keys dragControl, dropControl, messages,
  3421. x, y, type. The dragControlvalue is a string and the other values are integers (eg the callback string could be print
  3422. '%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d'
  3423. - enable : en (bool) [create,query,edit]
  3424. The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and
  3425. the control will appear dimmed or greyed-out indicating it is disabled.
  3426. - enableBackground : ebg (bool) [create,query,edit]
  3427. Enables the background color of the control.
  3428. - exists : ex (bool) [create]
  3429. Returns true|false depending upon whether the specified object exists. Other flags are ignored.
  3430. - fullPathName : fpn (unicode) [query]
  3431. Return the full path name of the widget, which includes all the parents
  3432. - height : h (int) [create,query,edit]
  3433. The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
  3434. - isObscured : io (bool) [query]
  3435. Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if
  3436. it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control's
  3437. window is invisible or iconified.
  3438. - manage : m (bool) [create,query,edit]
  3439. Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All
  3440. controls are created managed by default.
  3441. - numberOfPopupMenus : npm (bool) [query]
  3442. Return the number of popup menus attached to this control.
  3443. - parent : p (unicode) [create,query]
  3444. The parent layout for this control.
  3445. - popupMenuArray : pma (bool) [query]
  3446. Return the names of all the popup menus attached to this control.
  3447. - precision : pre (int) [query,edit]
  3448. Controls the number of digits to the right of the decimal point that will be displayed for float-valued channels.
  3449. Default is 3. Queried, returns an int.
  3450. - preventOverride : po (bool) [create,query,edit]
  3451. If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
  3452. - rowAttach : rat (int, unicode, int) [create,edit]
  3453. Arguments are : column, attachment type, offset. Possible attachments are: top | bottom | both. Specifies attachment
  3454. types and offsets for the entire row.
  3455. - timeAnnotation : tan (unicode) [create,query,edit]
  3456. Annotate the time field with an extra string value.
  3457. - useTemplate : ut (unicode) [create]
  3458. Force the command to use a command template other than the current one.
  3459. - valueAnnotation : van (unicode) [create,query,edit]
  3460. Annotate the value field with an extra string value. Flag can have multiple arguments, passed
  3461. either as a tuple or a list.
  3462. - visible : vis (bool) [create,query,edit]
  3463. The visible state of the control. A control is created visible by default. Note that a control's actual appearance is
  3464. also dependent on the visible state of its parent layout(s).
  3465. - visibleChangeCommand : vcc (script) [create,query,edit]
  3466. Command that gets executed when visible state of the control changes.
  3467. - width : w (int) [create,query,edit]
  3468. The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
  3469. Derived from mel command `maya.cmds.keyframeStats`
  3470. """
  3471. pass
  3472. def lattice(*args, **kwargs):
  3473. """
  3474. This command creates a lattice deformer that will deform the selected objects. If the object centered flag is used, the
  3475. initial lattice will fit around the selected objects. The lattice will be selected when the command is completed. The
  3476. lattice deformer has an associated base lattice. Only objects which are contained by the base lattice will be deformed
  3477. by the lattice.
  3478. Flags:
  3479. - after : af (bool) [create,edit]
  3480. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  3481. flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape
  3482. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  3483. - afterReference : ar (bool) []
  3484. - before : bf (bool) [create,edit]
  3485. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  3486. flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape
  3487. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  3488. - commonParent : cp (bool) [create]
  3489. Group the base lattice and the deformed lattice under a common transform. This means that you can resize the lattice
  3490. without affecting the deformation by resizing the common transform.
  3491. - deformerTools : dt (bool) [query]
  3492. Returns the name of the deformer tool objects (if any) as string string ...
  3493. - divisions : dv (int, int, int) [create,query,edit]
  3494. Set the number of lattice slices in x, y, z. Default is 2, 5, 2. When queried, this flag returns float float float. When
  3495. you change the number of divisions, any tweaking or animation of lattice points must be redone.
  3496. - dualBase : db (bool) [create]
  3497. Create a special purpose ffd deformer node which accepts 2 base lattices. The default is off which results in the
  3498. creation of a normal ffd deformer node. Intended for internal usage only. Flag can have multiple
  3499. arguments, passed either as a tuple or a list.
  3500. - exclusive : ex (unicode) [create,query]
  3501. Puts the deformation set in a deform partition.
  3502. - freezeMapping : fm (bool) [create,query,edit]
  3503. The base position of the geometries points is fixed at the time this flag is set. When mapping is frozen, moving the
  3504. geometry with respect to the lattice will not cause the deformation to be recomputed.
  3505. - frontOfChain : foc (bool) [create,edit]
  3506. This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and
  3507. skin nodes in the shape's history (but not ahead of existing tweak nodes). The input to the deformer will be the
  3508. upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the
  3509. downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and
  3510. edit mode if the deformer has no geometry added yet).
  3511. - geometry : g (unicode) [query,edit]
  3512. The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is
  3513. also specified. When queried, this flag returns string string string ...
  3514. - geometryIndices : gi (bool) []
  3515. - ignoreSelected : ignoreSelected (bool) [create]
  3516. Tells the command to not deform objects on the current selection list
  3517. - latticeReset : lr (bool) [edit]
  3518. Reset the lattice to match its base position. This will undo any deformations that the lattice is causing. The lattice
  3519. will only deform points that are enclosed within the lattice's reset (base) position.
  3520. - ldivisions : ldv (int, int, int) [create,query,edit]
  3521. Set the number of local lattice slices in x, y, z.
  3522. - name : n (unicode) [create]
  3523. Used to specify the name of the node being created
  3524. - objectCentered : oc (bool) [create]
  3525. Centers the lattice around the selected object(s) or components. Default is off which centers the lattice at the origin.
  3526. - outsideFalloffDistance : ofd (float) [create]
  3527. Set the falloff distance used when the setting for transforming points outside of the base lattice is set to 2. The
  3528. distance value is a positive number which specifies the size of the falloff distance as a multiple of the base lattice
  3529. size, thus a value of 1.0 specifies that only points up to the base lattice width/height/depth away are transformed. A
  3530. value of 0.0 is equivalent to an outsideLattice value of 0 (i.e. no points outside the base lattice are transformed). A
  3531. huge value is equivalent to transforming an outsideLattice value of 1 (i.e. all points are transformed).
  3532. - outsideLattice : ol (int) [create]
  3533. Set the mode describing how points outside the base lattice are transformed. 0 (the default) specifies that no outside
  3534. points are transformed. 1 specifies that all outside points are transformed, and 2 specifies that only those outside
  3535. points which fall within the falloff distance(see the -ofd/outsideFalloffDistance flag) are transformed. When querying,
  3536. the current setting for the lattice is returned.
  3537. - parallel : par (bool) [create,edit]
  3538. Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is
  3539. inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry
  3540. added yet).
  3541. - position : pos (float, float, float) [create]
  3542. Used to specify the position of the newly created lattice.
  3543. - prune : pr (bool) [edit]
  3544. Removes any points not being deformed by the deformer in its current configuration from the deformer set.
  3545. - remove : rm (bool) [edit]
  3546. Specifies that objects listed after the -g flag should be removed from this deformer.
  3547. - removeTweaks : rt (bool) [edit]
  3548. Remove any lattice deformations caused by moving lattice points. Translations/rotations and scales on the lattice itself
  3549. are not removed.
  3550. - rotation : ro (float, float, float) [create]
  3551. Used to specify the initial rotation of the newly created lattice.
  3552. - scale : s (float, float, float) [create]
  3553. Used to specify the initial scale of the newly created lattice.
  3554. - split : sp (bool) [create,edit]
  3555. Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing
  3556. chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
  3557. Derived from mel command `maya.cmds.lattice`
  3558. """
  3559. pass
  3560. def listAnimatable(*args, **kwargs):
  3561. """
  3562. This command list the animatable attributes of a node. Command flags allow filtering by the current manipulator, or
  3563. node type.
  3564. Modifications:
  3565. - returns an empty list when the result is None
  3566. - returns wrapped classes
  3567. Flags:
  3568. - active : act (bool) [create]
  3569. This flag is obsolete and no longer supported.
  3570. - manip : m (bool) [create]
  3571. Return only those attributes affected by the current manip. If there is no manip active and any other flags are
  3572. specified, output is the same as if the -manipflag were not present.
  3573. - manipHandle : mh (bool) [create]
  3574. Return only those attributes affected by the current manip handle. If there is no manip handle active and any other
  3575. flags are specified, output is the same as if the -manipHandleflag were not present.
  3576. - shape : s (bool) [create]
  3577. This flag is obsolete and no longer supported. Flag can have multiple arguments, passed either as a
  3578. tuple or a list.
  3579. - type : typ (bool) [create]
  3580. Instead of returning attributes, Return the types of nodes that are currently animatable.
  3581. Derived from mel command `maya.cmds.listAnimatable`
  3582. """
  3583. pass
  3584. def marker(*args, **kwargs):
  3585. """
  3586. The marker command creates one or two markers, on a motion path curve, at the specified time and location. The optionnal
  3587. string argument is the parent object name.One can specify -pm -omoption to create both, a position marker and an
  3588. orientation marker.Since there is only one keyframe for each marker of the same type, no more than one marker of the
  3589. same type with the same time value can exist.The default marker type is the position marker. The default time is the
  3590. current time.
  3591. Flags:
  3592. - attach : a (bool) [create]
  3593. This flag specifies to attach the selected 3D position markers to their parent geometry.
  3594. - detach : d (bool) [create]
  3595. This flag specifies to detach the selected position markers from their parent geometry to the 3D space.
  3596. Flag can have multiple arguments, passed either as a tuple or a list.
  3597. - frontTwist : ft (float) [query]
  3598. This flag specifies the amount of twist angle about the front vector for the marker.Default is 0.When queried, this flag
  3599. returns a angle.
  3600. - orientationMarker : om (bool) [query]
  3601. This flag specifies creation of an orientation marker.Default is not set..When queried, this flag returns a boolean.
  3602. - positionMarker : pm (bool) [query]
  3603. This flag specifies creation of a position marker.Default is set.When queried, this flag returns a boolean.
  3604. - sideTwist : st (float) [query]
  3605. This flag specifies the amount of twist angle about the side vector for the marker.Default is 0.When queried, this flag
  3606. returns a angle.
  3607. - time : t (time) [query]
  3608. This flag specifies the time for the marker.Default is the current time.When queried, this flag returns a time.
  3609. - upTwist : ut (float) [query]
  3610. This flag specifies the amount of twist angle about the up vector for the marker.Default is 0.When queried, this flag
  3611. returns a angle.
  3612. - valueU : u (float) [query]
  3613. This flag specifies the location of the position marker w.r.t. the parent geometry u parameterization.Default is the
  3614. value at current time.When queried, this flag returns a linear.
  3615. Derived from mel command `maya.cmds.marker`
  3616. """
  3617. pass
  3618. def mirrorJoint(*args, **kwargs):
  3619. """
  3620. This command will duplicate a branch of the skeleton from the selected joint symmetrically about a plane in world space.
  3621. There are three mirroring modes(xy-, yz-, xz-plane).
  3622. Flags:
  3623. - mirrorBehavior : mb (bool) [create]
  3624. The mirrorBehavior flag is used to specify that when performing the mirror, the joint orientation axes should be
  3625. mirrored such that equal rotations on the original and mirrored joints will place the skeleton in a mirrored position
  3626. (symmetric across the mirroring plane). Thus, animation curves from the original joints can be copied to the mirrored
  3627. side to produce a similar (but symmetric) behavior. When mirrorBehavior is not specified, the joint orientation on the
  3628. mirrored side will be identical to the source side.
  3629. - mirrorXY : mxy (bool) [create]
  3630. mirror skeleton from the selected joint about xy-plane in world space.
  3631. - mirrorXZ : mxz (bool) [create]
  3632. mirror skeleton from the selected joint about xz-plane in world space.
  3633. - mirrorYZ : myz (bool) [create]
  3634. mirror skeleton from the selected joint about yz-plane in world space.
  3635. - searchReplace : sr (unicode, unicode) [create]
  3636. After performing the mirror, rename the new joints by searching the name for the first specified string and replacing it
  3637. with the second specified string. Flag can have multiple arguments, passed either as a tuple or a
  3638. list.
  3639. Derived from mel command `maya.cmds.mirrorJoint`
  3640. """
  3641. pass
  3642. def movIn(*args, **kwargs):
  3643. """
  3644. Imports a .mov file into animation curves connected to the listed attributes. The attribute must be writable, since an
  3645. animation curve will be created and connected to the attribute. If an animation curve already is connected to the
  3646. attribute, the imported data is pasted onto that curve. The starting time used for the .mov file importation is the
  3647. current time when the command is executed. Valid attribute types are numeric attributes; time attributes; linear
  3648. attributes; angular attributes; compound attributes made of the types listed previously; and multi attributes composed
  3649. of the types listed previously. If an unsuppoted attribute type is requested, the command will fail and no data will be
  3650. imported. It is important that your user units are set to the same units used in the .mov file, otherwise linear and
  3651. angular values will be incorrect. To export a .mov file, use the movOut command.
  3652. Flags:
  3653. - file : f (unicode) [create]
  3654. The name of the .mov file. If no extension is used, a .mov will be added.
  3655. - startTime : st (time) [create]
  3656. The default start time for importing the .mov file is the current time. The startTime option sets the starting time for
  3657. the .mov data in the current time unit. Flag can have multiple arguments, passed either as a tuple or
  3658. a list.
  3659. Derived from mel command `maya.cmds.movIn`
  3660. """
  3661. pass
  3662. def movOut(*args, **kwargs):
  3663. """
  3664. Exports a .mov file from the listed attributes. Valid attribute types are numeric attributes; time attributes; linear
  3665. attributes; angular attributes; compound attributes made of the types listed previously; and multi attributes composed
  3666. of the types listed previously. Length, angle, and time values will be written to the file in the user units. If an
  3667. unsupported attribute type is requested, the action will fail. The .mov file may be read back into Maya using the movIn
  3668. command.
  3669. Flags:
  3670. - comment : c (bool) [create]
  3671. If true, the attributes written to the .mov file will be listed in a commented section at the top of the .mov file. The
  3672. default is false.
  3673. - file : f (unicode) [create]
  3674. The name of the .mov file. If no extension is used, a .mov will be added.
  3675. - precision : pre (int) [create]
  3676. Sets the number of digits to the right of the decimal place in the .mov file.C: The default is 6.
  3677. Flag can have multiple arguments, passed either as a tuple or a list.
  3678. - time : t (timerange) [create]
  3679. The time range to save as a .mov file. The default is the current time range.
  3680. Derived from mel command `maya.cmds.movOut`
  3681. """
  3682. pass
  3683. def movieInfo(*args, **kwargs):
  3684. """
  3685. movieInfo provides a mechanism for querying information about movi files.
  3686. Flags:
  3687. - frameCount : f (bool) [create]
  3688. Query the number of frames in the movie file
  3689. - height : h (bool) [create]
  3690. Query the height of the movie Flag can have multiple arguments, passed either as a
  3691. tuple or a list.
  3692. - width : w (bool) [create]
  3693. Query the width of the movie
  3694. Derived from mel command `maya.cmds.movieInfo`
  3695. """
  3696. pass
  3697. def mute(*args, **kwargs):
  3698. """
  3699. The mute command is used to disable and enable playback on a channel. When a channel is muted, it retains the value that
  3700. it was at prior to being muted.
  3701. Flags:
  3702. - disable : d (bool) [create]
  3703. Disable muting on the channels
  3704. - force : f (bool) [create]
  3705. Forceable disable of muting on the channels. If there are keys on the mute channel, the animation and mute node will
  3706. both be removed. If this flag is not set, then mute nodes with animation will only be disabled.
  3707. Flag can have multiple arguments, passed either as a tuple or a list.
  3708. Derived from mel command `maya.cmds.mute`
  3709. """
  3710. pass
  3711. def nonLinear(*args, **kwargs):
  3712. """
  3713. This command creates a functional deformer of the specified type that will deform the selected objects. The deformer
  3714. consists of three nodes: The deformer driver that gets connected to the history of the selected objects, the deformer
  3715. handle transform that controls position and orientation of the axis of the deformation and the deformer handle that
  3716. maintains the deformation parameters. The type of the deformer handle shape created depends on the specified type of the
  3717. deformer. The deformer handle will be positioned at the center of the selected objects' bounding box and oriented to
  3718. match the orientation of the leading object in the selection list. The deformer handle transform will be selected when
  3719. the command is completed. The nonLinear command has some flags which are specific to the nonLinear type specified with
  3720. the -type flag. The flags correspond to the primary keyable attributes related to the specific type of nonLinear node.
  3721. For example, if the type is bend, then the flags -curvature, -lowBoundand -highBoundmay be used to initialize, edit or
  3722. query those attribute values on the bend node. Examples of this are covered in the example section below.
  3723. Flags:
  3724. - after : af (bool) [create,edit]
  3725. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  3726. flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape
  3727. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  3728. - afterReference : ar (bool) []
  3729. - autoParent : ap (bool) [create]
  3730. Parents the deformer handle under the selected object's transform. This flag is valid only when a single object is
  3731. selected.
  3732. - before : bf (bool) [create,edit]
  3733. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  3734. flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape
  3735. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  3736. - commonParent : cp (bool) [create]
  3737. Creates a new transform and parents the selected object and the deformer handle under it. This flag is valid only when
  3738. a single object is selected.
  3739. - defaultScale : ds (bool) [create]
  3740. Sets the scale of the deformation handle to 1. By default the deformation handle is scaled to the match the largest
  3741. dimension of the selected objects' bounding box. [deformerFlags] The attributes of the deformer handle shape can be set
  3742. upon creation, edited and queried as normal flags using either the long or the short attribute name. e.g.
  3743. Flag can have multiple arguments, passed either as a tuple or a list.
  3744. - deformerTools : dt (bool) [query]
  3745. Returns the name of the deformer tool objects (if any) as string string ...
  3746. - exclusive : ex (unicode) [create,query]
  3747. Puts the deformation set in a deform partition.
  3748. - frontOfChain : foc (bool) [create,edit]
  3749. This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and
  3750. skin nodes in the shape's history (but not ahead of existing tweak nodes). The input to the deformer will be the
  3751. upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the
  3752. downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and
  3753. edit mode if the deformer has no geometry added yet).
  3754. - geometry : g (unicode) [query,edit]
  3755. The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is
  3756. also specified. When queried, this flag returns string string string ...
  3757. - geometryIndices : gi (bool) []
  3758. - ignoreSelected : ignoreSelected (bool) [create]
  3759. Tells the command to not deform objects on the current selection list
  3760. - name : n (unicode) [create]
  3761. Used to specify the name of the node being created
  3762. - parallel : par (bool) [create,edit]
  3763. Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is
  3764. inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry
  3765. added yet).
  3766. - prune : pr (bool) [edit]
  3767. Removes any points not being deformed by the deformer in its current configuration from the deformer set.
  3768. - remove : rm (bool) [edit]
  3769. Specifies that objects listed after the -g flag should be removed from this deformer.
  3770. - split : sp (bool) [create,edit]
  3771. Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing
  3772. chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
  3773. - type : typ (unicode) [create]
  3774. Specifies the type of deformation. The current valid deformation types are: bend, twist, squash, flare, sine and wave
  3775. Derived from mel command `maya.cmds.nonLinear`
  3776. """
  3777. pass
  3778. def normalConstraint(*args, **kwargs):
  3779. """
  3780. Constrain an object's orientation based on the normal of the target surface(s) at the closest point(s) to the object. A
  3781. normalConstraint takes as input one or more surface shapes (the targets) and a DAG transform node (the object). The
  3782. normalConstraint orients the constrained object such that the aimVector (in the object's local coordinate system) aligns
  3783. in world space to combined normal vector. The upVector (again the the object's local coordinate system) is aligned in
  3784. world space with the worldUpVector. The combined normal vector is a weighted average of the normal vector for each
  3785. target surface at the point closest to the constrained object.
  3786. Maya Bug Fix:
  3787. - when queried, angle offsets would be returned in radians, not current angle unit
  3788. Modifications:
  3789. - added new syntax for querying the weight of a target object, by passing the constraint first::
  3790. aimConstraint( 'pCube1_aimConstraint1', q=1, weight ='pSphere1' )
  3791. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =['pSphere1', 'pCylinder1'] )
  3792. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =[] )
  3793. Flags:
  3794. - aimVector : aim (float, float, float) [create,query,edit]
  3795. Set the aim vector. This is the vector in local coordinates that points at the target. If not given at creation time,
  3796. the default value of (1.0, 0.0, 0.0) is used.
  3797. - layer : l (unicode) [create,edit]
  3798. Specify the name of the animation layer where the constraint should be added.
  3799. - name : n (unicode) [create,query,edit]
  3800. Sets the name of the constraint node to the specified name. Default name is constrainedObjectName_constraintType
  3801. - remove : rm (bool) [edit]
  3802. removes the listed target(s) from the constraint.
  3803. - targetList : tl (bool) [query]
  3804. Return the list of target objects.
  3805. - upVector : u (float, float, float) [create,query,edit]
  3806. Set local up vector. This is the vector in local coordinates that aligns with the world up vector. If not given at
  3807. creation time, the default value of (0.0, 1.0, 0.0) is used.
  3808. - weight : w (float) [create,query,edit]
  3809. Sets the weight value for the specified target(s). If not given at creation time, the default value of 1.0 is used.
  3810. - weightAliasList : wal (bool) [query]
  3811. Returns the names of the attributes that control the weight of the target objects. Aliases are returned in the same
  3812. order as the targets are returned by the targetList flag
  3813. - worldUpObject : wuo (PyNode) [create,query,edit]
  3814. Set the DAG object use for worldUpType objectand objectrotation. See worldUpType for greater detail. The default value
  3815. is no up object, which is interpreted as world space.
  3816. - worldUpType : wut (unicode) [create,query,edit]
  3817. Set the type of the world up vector computation. The worldUpType can have one of 5 values: scene, object,
  3818. objectrotation, vector, or none. If the value is scene, the upVector is aligned with the up axis of the scene and
  3819. worldUpVector and worldUpObject are ignored. If the value is object, the upVector is aimed as closely as possible to the
  3820. origin of the space of the worldUpObject and the worldUpVector is ignored. If the value is objectrotationthen the
  3821. worldUpVector is interpreted as being in the coordinate space of the worldUpObject, transformed into world space and the
  3822. upVector is aligned as closely as possible to the result. If the value is vector, the upVector is aligned with
  3823. worldUpVector as closely as possible and worldUpMatrix is ignored. Finally, if the value is noneno twist calculation is
  3824. performed by the constraint, with the resulting upVectororientation based previous orientation of the constrained
  3825. object, and the great circlerotation needed to align the aim vector with its constraint. The default worldUpType is
  3826. vector. Flag can have multiple arguments, passed either as a tuple or a list.
  3827. - worldUpVector : wu (float, float, float) [create,query,edit]
  3828. Set world up vector. This is the vector in world coordinates that up vector should align with. See -wut/worldUpType
  3829. (below)for greater detail. If not given at creation time, the default value of (0.0, 1.0, 0.0) is used.
  3830. Derived from mel command `maya.cmds.normalConstraint`
  3831. """
  3832. pass
  3833. def orientConstraint(*args, **kwargs):
  3834. """
  3835. Constrain an object's orientation to match the orientation of the target or the average of a number of targets. An
  3836. orientConstraint takes as input one or more targetDAG transform nodes to control the orientation of the single
  3837. constraint objectDAG transform The orientConstraint orients the constrained object to match the weighted average of the
  3838. target world space orientations.
  3839. Maya Bug Fix:
  3840. - when queried, angle offsets would be returned in radians, not current angle unit
  3841. Modifications:
  3842. - added new syntax for querying the weight of a target object, by passing the constraint first::
  3843. aimConstraint( 'pCube1_aimConstraint1', q=1, weight ='pSphere1' )
  3844. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =['pSphere1', 'pCylinder1'] )
  3845. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =[] )
  3846. Flags:
  3847. - createCache : cc (float, float) [edit]
  3848. This flag is used to generate an animation curve that serves as a cache for the constraint. The two arguments define the
  3849. start and end frames. The cache is useful if the constraint has multiple targets and the constraint's interpolation
  3850. type is set to no flip. The no flipmode prevents flipping during playback, but the result is dependent on the previous
  3851. frame. Therefore in order to consistently get the same result on a specific frame, a cache must be generated. This flag
  3852. creates the cache and sets the constraint's interpolation type to cache. If a cache exists already, it will be deleted
  3853. and replaced with a new cache.
  3854. - deleteCache : dc (bool) [edit]
  3855. Delete an existing interpolation cache. Flag can have multiple arguments, passed either as a tuple or
  3856. a list.
  3857. - layer : l (unicode) [create,edit]
  3858. Specify the name of the animation layer where the constraint should be added.
  3859. - maintainOffset : mo (bool) [create]
  3860. The offset necessary to preserve the constrained object's initial orientation will be calculated and used as the offset.
  3861. - name : n (unicode) [create,query,edit]
  3862. Sets the name of the constraint node to the specified name. Default name is constrainedObjectName_constraintType
  3863. - offset : o (float, float, float) [create,query,edit]
  3864. Sets or queries the value of the offset. Default is 0,0,0.
  3865. - remove : rm (bool) [edit]
  3866. removes the listed target(s) from the constraint.
  3867. - skip : sk (unicode) [create,edit]
  3868. Specify the axis to be skipped. Valid values are x, y, zand none. The default value in create mode is none. This flag is
  3869. multi-use.
  3870. - targetList : tl (bool) [query]
  3871. Return the list of target objects.
  3872. - weight : w (float) [create,query,edit]
  3873. Sets the weight value for the specified target(s). If not given at creation time, the default value of 1.0 is used.
  3874. - weightAliasList : wal (bool) [query]
  3875. Returns the names of the attributes that control the weight of the target objects. Aliases are returned in the same
  3876. order as the targets are returned by the targetList flag
  3877. Derived from mel command `maya.cmds.orientConstraint`
  3878. """
  3879. pass
  3880. def pairBlend(*args, **kwargs):
  3881. """
  3882. The pairBlend node allows a weighted combinations of 2 inputs to be blended together. It is created automatically when
  3883. keying or constraining an attribute which is already connected.Alternatively, the pairBlend command can be used to
  3884. connect a pairBlend node to connected attributes of a node. The previously existing connections are rewired to input1 of
  3885. the pairBlend node. Additional connections can then be made manually to input2 of the pairBlend node. The pairBlend
  3886. command can also be used to query the inputs to an existing pairBlend node.
  3887. Flags:
  3888. - attribute : at (unicode) [create]
  3889. The name of the attribute(s) which the blend will drive. This flag is required when creating the blend.
  3890. - input1 : i1 (bool) [query]
  3891. Returns a string array of the node(s) connected to input 1.
  3892. - input2 : i2 (bool) [query]
  3893. Returns a string array of the node(s) connected to input 2. Flag can have multiple
  3894. arguments, passed either as a tuple or a list.
  3895. - node : nd (unicode) [create]
  3896. The name of the node which the blend will drive. This flag is required when creating the blend.
  3897. Derived from mel command `maya.cmds.pairBlend`
  3898. """
  3899. pass
  3900. def parentConstraint(*args, **kwargs):
  3901. """
  3902. Constrain an object's position and rotation so that it behaves as if it were a child of the target object(s). In the
  3903. case of multiple targets, the overall position and rotation of the constrained object is the weighted average of each
  3904. target's contribution to the position and rotation of the object. A parentConstraint takes as input one or more
  3905. targetDAG transform nodes at which to position and rotate the single constraint objectDAG transform node. The
  3906. parentConstraint positions and rotates the constrained object at the weighted average of the world space position,
  3907. rotation and scale target objects.
  3908. Maya Bug Fix:
  3909. - when queried, angle offsets would be returned in radians, not current angle unit
  3910. Modifications:
  3911. - added new syntax for querying the weight of a target object, by passing the constraint first::
  3912. aimConstraint( 'pCube1_aimConstraint1', q=1, weight ='pSphere1' )
  3913. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =['pSphere1', 'pCylinder1'] )
  3914. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =[] )
  3915. Flags:
  3916. - createCache : cc (float, float) [edit]
  3917. This flag is used to generate an animation curve that serves as a cache for the constraint. The two arguments define the
  3918. start and end frames. The cache is useful if the constraint has multiple targets and the constraint's interpolation
  3919. type is set to no flip. The no flipmode prevents flipping during playback, but the result is dependent on the previous
  3920. frame. Therefore in order to consistently get the same result on a specific frame, a cache must be generated. This flag
  3921. creates the cache and sets the constraint's interpolation type to cache. If a cache exists already, it will be deleted
  3922. and replaced with a new cache.
  3923. - deleteCache : dc (bool) [edit]
  3924. Delete an existing interpolation cache. Flag can have multiple arguments, passed either as a tuple or
  3925. a list.
  3926. - layer : l (unicode) [create,edit]
  3927. Specify the name of the animation layer where the constraint should be added.
  3928. - maintainOffset : mo (bool) [create]
  3929. If this flag is specified the position and rotation of the constrained object will be maintained.
  3930. - name : n (unicode) [create,query,edit]
  3931. Sets the name of the constraint node to the specified name. Default name is constrainedObjectName_constraintType
  3932. - remove : rm (bool) [edit]
  3933. removes the listed target(s) from the constraint.
  3934. - skipRotate : sr (unicode) [create]
  3935. Causes the axis specified not to be considered when constraining rotation. Valid arguments are x, y, zand none.
  3936. - skipTranslate : st (unicode) [create]
  3937. Causes the axis specified not to be considered when constraining translation. Valid arguments are x, y, zand none.
  3938. - targetList : tl (bool) [query]
  3939. Return the list of target objects.
  3940. - weight : w (float) [create,query,edit]
  3941. Sets the weight value for the specified target(s). If not given at creation time, the default value of 1.0 is used.
  3942. - weightAliasList : wal (bool) [query]
  3943. Returns the names of the attributes that control the weight of the target objects. Aliases are returned in the same
  3944. order as the targets are returned by the targetList flag
  3945. Derived from mel command `maya.cmds.parentConstraint`
  3946. """
  3947. pass
  3948. def pasteKey(*args, **kwargs):
  3949. """
  3950. The pasteKey command pastes curve segment hierarchies from the clipboard onto other objects or curves. If the object
  3951. hierarchy from which the curve segments were copied or cut does not match the object hierarchy being pasted to, pasteKey
  3952. will paste as much as it can match in the hierarchy. If animation from only one object is on the clipboard, it will be
  3953. pasted to each of the target objects. If animation from more than one object is on the clipboard, selection list order
  3954. determines what animation is pasted to which object. Valid operations include: One attribute to one or more attributes
  3955. (Clipboard animation is pasted onto all target attributes.One attribute to one or more objects (Clipboard animation
  3956. pasted onto target object, when attribute names match.)Many attributes to one or more objectsClipboard animation pasted
  3957. onto targets when attribute names match.TbaseKeySetCmd.h The way the keyset clipboard will be pasted to the specified
  3958. object's attributes depends on the paste -optionspecified. Each of these options below will be explained using an
  3959. example. For all the explanations, let us assume that there is a curve segment with 20 frames of animation on the keyset
  3960. clipboard (you can put curve segments onto the clipboard using the cutKeyor copyKeycommands). We will call the animation
  3961. curve that we are pasting to the target curve: pasteKey -time 5 -option insert1. Shift all keyframes on the target curve
  3962. after time 5 to the right by 20 frames (to make room for the 20-frame clipboard segment). 2. Paste the 20-frame
  3963. clipboard segment starting at time 5. pasteKey -time 5:25-option replace1. Remove all keys on the target curve from 5 to
  3964. 25. 2. Paste the 20-frame clipboard curve at time 5. pasteKey -option replaceCompletely1. Remove all keys on the target
  3965. curve. 2. Paste the 20-frame clipboard curve, preserving the clipboard curve's original keyframe times. pasteKey -time 5
  3966. -option merge1.The clipboard curve segment will be pasted starting at time 5 for its full 20-frame range until frame 25.
  3967. 2. If a keyframe on the target curve has the same time as a keyframe on the clipboard curve, it is overwritten.
  3968. Otherwise, any keys that existed in the 5:25 range before the paste, will remain untouched pasteKey -time 3:10-option
  3969. scaleInsert1. Shift all keyframes on the target curve after time 3 to the right by 7 frames (to clear the range 3:10 to
  3970. paste in) 2. The clipboard curve segment will be scaled to fit the specified time range (i.e. the 20 frames on the
  3971. clipboard will be scaled to fit into 7 frames), and then pasted into the range 3:10. pasteKey -time 3:10-option
  3972. scaleReplace1. Any existing keyframes in the target curve in the range 3:10 are removed. 2. The clipboard curve segment
  3973. will be scaled to fit the specified time range (i.e. the 20 frames on the clipboard will be scaled to fit into 7
  3974. frames), and then pasted into the range 3:10. pasteKey -time 3:10-option scaleMerge1. The clipboard curve segment will
  3975. 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.
  3976. If there are keys on the target curve at the same time as keys on the clipboard curve, they are overwritten. Otherwise,
  3977. keyframes on the target curve that existed in the 3:10 range before the paste, will remain untouched. pasteKey -time
  3978. 3:10-option fitInsert1. Shift all the keyframes on the target curve after time 3 to the right by 7 frames (to clear the
  3979. range 3:10 to paste in) 2. The first 7 frames of the clipboard curve segment will be pasted into the range 3:10.
  3980. pasteKey -time 3:10-option fitReplace1. Any existing frames in the target curve in the range 3:10 are removed. 2. The
  3981. first 7 frames of the clipboard curve segment will be pasted into the range 3:10. pasteKey -time 3:10-option fitMerge1.
  3982. 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
  3983. curve at the same time as keys on the clipboard curve, they are overwritten. Otherwise, keyframes on the target curve
  3984. that existed in the 3:10 range before the paste, will remain untouched.
  3985. Flags:
  3986. - animation : an (unicode) [create]
  3987. Where this command should get the animation to act on. Valid values are objects,keys,and keysOrObjectsDefault:
  3988. keysOrObjects.(See Description for details.) Flag can have multiple arguments, passed either as a
  3989. tuple or a list.
  3990. - attribute : at (unicode) [create]
  3991. List of attributes to select
  3992. - clipboard : cb (unicode) [create]
  3993. Specifies the clipboard from which animation is pasted. Valid clipboards are apiand anim. The default clipboard is:
  3994. anim
  3995. - connect : c (bool) [create]
  3996. When true, connect the source curve with the destination curve's value at the paste time. (This has the effect of
  3997. shifting the clipboard curve in value to connect with the destination curve.) False preserves the source curve's
  3998. original keyframe values. Default is false.
  3999. - copies : cp (int) [create]
  4000. The number of times to paste the source curve.
  4001. - float : f (floatrange) [create]
  4002. value uniquely representing a non-time-based key (or key range) on a time-based animCurve. Valid floatRange include
  4003. single values (-f 10) or a string with a lower and upper bound, separated by a colon (-f 10:20
  4004. - floatOffset : fo (float) [create]
  4005. How much to offset the pasted keys in time (for non-time-input animation curves).
  4006. - includeUpperBound : iub (bool) [create]
  4007. When the -t/time or -f/float flags represent a range of keys, this flag determines whether the keys at the upper bound
  4008. of the range are included in the keyset. Default value: true. This flag is only valid when the argument to the -t/time
  4009. flag is a time range with a lower and upper bound. (When used with the pasteKeycommand, this flag refers only to the
  4010. time range of the target curve that is replaced, when using options such as replace,fitReplace,or scaleReplace.This flag
  4011. has no effect on the curve pasted from the clipboard.)
  4012. - index : index (int) [create]
  4013. index of a key on an animCurve
  4014. - option : o (unicode) [create]
  4015. Valid values are insert, replace, replaceCompletely, merge, scaleInsert,scaleReplace, scaleMerge, fitInsert, fitReplace,
  4016. and fitMerge. The default paste option is: insert.
  4017. - time : t (timerange) [create]
  4018. time uniquely representing a key (or key range) on a time-based animCurve. Valid timeRanges include single values (-t
  4019. 10) or a string with a lower and upper bound, separated by a colon (-t 10:20
  4020. - timeOffset : to (time) [create]
  4021. How much to offset the pasted keys in time (for time-input animation curves).
  4022. - valueOffset : vo (float) [create]
  4023. How much to offset the pasted keys in value.
  4024. Derived from mel command `maya.cmds.pasteKey`
  4025. """
  4026. pass
  4027. def pathAnimation(*args, **kwargs):
  4028. """
  4029. The pathAnimation command constructs the necessary graph nodes and their interconnections for a motion path animation.
  4030. Motion path animation requires a curve and one or more other objects. During the animation, the objects will be moved
  4031. along the 3D curve or the curveOnSurface.There are two ways to specify the moving objects: by explicitly specifying
  4032. their names in the command line, orby making the objects selected (interactively, or through a MEL command).Likewise,
  4033. there are two ways to specify a motion curve: by explicitly specifying the name of the motion curve in the command line
  4034. (i.e. using the -c curve_name option), orby selecting the moving objects first before selecting the motion curve. I.e.
  4035. if the name of the motion curve is not provided in the command line, the curve will be taken to be the last selected
  4036. object in the selection list.When the end time is not specified: only one keyframe will be created either at the current
  4037. time, or at the specified start time.
  4038. Flags:
  4039. - bank : b (bool) [query]
  4040. If on, enable alignment of the up axis of the moving object(s) to the curvature of the path geometry.Default is
  4041. false.When queried, this flag returns a boolean.
  4042. - bankScale : bs (float) [query]
  4043. This flag specifies a factor to scale the amount of bank angle.Default is 1.0When queried, this flag returns a float.
  4044. - bankThreshold : bt (float) [query]
  4045. This flag specifies the limit of the bank angle.Default is 90 degreesWhen queried, this flag returns an angle.
  4046. - curve : c (unicode) [query]
  4047. This flag specifies the name of the curve for the path.Default is NONEWhen queried, this flag returns a string.
  4048. - endTimeU : etu (time) [query]
  4049. This flag specifies the ending time of the animation for the u parameter.Default is NONE.When queried, this flag returns
  4050. a time. Flag can have multiple arguments, passed either as a tuple or a list.
  4051. - endU : eu (float) [query]
  4052. This flag specifies the ending value of the u parameterization for the animation.Default is the end parameterization
  4053. value of the curve.When queried, this flag returns a linear.
  4054. - follow : f (bool) [query]
  4055. If on, enable alignment of the front axis of the moving object(s).Default is false.When queried, this flag returns a
  4056. boolean.
  4057. - followAxis : fa (unicode) [query]
  4058. This flag specifies which object local axis to be aligned to the tangent of the path curve.Default is yWhen queried,
  4059. this flag returns a string.
  4060. - fractionMode : fm (bool) [query]
  4061. If on, evaluation on the path is based on the fraction of length of the path curve.Default is false.When queried, this
  4062. flag returns a boolean.
  4063. - inverseFront : inverseFront (bool) [query]
  4064. This flag specifies whether or not to align the front axis of the moving object(s) to the opposite direction of the
  4065. tangent vector of the path geometry.Default is false.When queried, this flag returns a boolean.
  4066. - inverseUp : iu (bool) [query]
  4067. This flag specifies whether or not to align the up axis of the moving object(s) to the opposite direction of the normal
  4068. vector of the path geometry.Default is false.When queried, this flag returns a boolean.
  4069. - name : n (unicode) [query]
  4070. This flag specifies the name for the new motion path node. (instead of the default name)When queried, this flag returns
  4071. a string.
  4072. - startTimeU : stu (time) [query]
  4073. This flag specifies the starting time of the animation for the u parameter.Default is the the current time.When queried,
  4074. this flag returns a time.
  4075. - startU : su (float) [query]
  4076. This flag specifies the starting value of the u parameterization for the animation.Default is the start parameterization
  4077. value of the curve.When queried, this flag returns a linear.
  4078. - upAxis : ua (unicode) [query]
  4079. This flag specifies which object local axis to be aligned a computed up direction.Default is zWhen queried, this flag
  4080. returns a string.
  4081. - useNormal : un (bool) [create,query,edit]
  4082. This flag is now obsolete. Use -wut/worldUpType instead.
  4083. - worldUpObject : wuo (PyNode) [create,query,edit]
  4084. Set the DAG object to use for worldUpType objectand objectrotation. See -wut/worldUpType for greater detail. The default
  4085. value is no up object, which is interpreted as world space.
  4086. - worldUpType : wut (unicode) [create,query,edit]
  4087. Set the type of the world up vector computation. The worldUpType can have one of 5 values: scene, object,
  4088. objectrotation, vector, or normal. If the value is scene, the upVector is aligned with the up axis of the scene and
  4089. worldUpVector and worldUpObject are ignored. If the value is object, the upVector is aimed as closely as possible to the
  4090. origin of the space of the worldUpObject and the worldUpVector is ignored. If the value is objectrotationthen the
  4091. worldUpVector is interpreted as being in the coordinate space of the worldUpObject, transformed into world space and the
  4092. upVector is aligned as closely as possible to the result. If the value is vector, the upVector is aligned with
  4093. worldUpVector as closely as possible and worldUpObject is ignored. Finally, if the value is normalthe upVector is
  4094. aligned to the path geometry. The default worldUpType is vector.
  4095. - worldUpVector : wu (float, float, float) [create,query,edit]
  4096. Set world up vector. This is the vector in world coordinates that up vector should align with. See -wut/worldUpType for
  4097. greater detail. If not given at creation time, the default value of (0.0, 1.0, 0.0) is used.
  4098. Derived from mel command `maya.cmds.pathAnimation`
  4099. """
  4100. pass
  4101. def percent(*args, **kwargs):
  4102. """
  4103. This command sets percent values on members of a weighted node such as a cluster or a jointCluster. With no flags
  4104. specified the command sets the percent value for selected components of the specified node to the specified percent
  4105. value. A dropoff from the specified percent value to 0 can be specifed from a point, plane or curve using a dropoff
  4106. distance around that shape. The percent value can also be added or multiplied with existing percent values of the node
  4107. components. In query mode, return type is based on queried flag.
  4108. Flags:
  4109. - addPercent : ap (bool) [create]
  4110. Add the percent value specified with the -v flag to the existing percent values
  4111. - dropoffAxis : dax (float, float, float) [create]
  4112. Specifies the axis along which to dropoff the percent value, starting from the dropoffPosition.
  4113. - dropoffCurve : dc (unicode) [create]
  4114. Specifies the curve around which to dropoff the percent value.
  4115. - dropoffDistance : dds (float) [create]
  4116. Specifies the dropoff distance from the point, plane or curve that was specified using the -dp -dax or -dc flags.
  4117. - dropoffPosition : dp (float, float, float) [create]
  4118. Specifies the point around which to dropoff the percent value.
  4119. - dropoffType : dt (unicode) [create]
  4120. Specifies the type of dropoff. Used in conjunction with the -dp, -dax or -dc flags. Default is linear. Valid values are:
  4121. linear, sine, exponential, linearSquared, none.
  4122. - multiplyPercent : mp (bool) [create]
  4123. Multiply the percent value specified with the -v flag with existing percent values Flag can have
  4124. multiple arguments, passed either as a tuple or a list.
  4125. - value : v (float) [create,query]
  4126. The percent value to be applied. The default is 1. In query mode, returns an array of doubles corresponding to the
  4127. weights of the selected object components.
  4128. Derived from mel command `maya.cmds.percent`
  4129. """
  4130. pass
  4131. def play(*args, **kwargs):
  4132. """
  4133. This command starts and stops playback. In order to change the frame range of playback, see the playbackOptions command.
  4134. In query mode, return type is based on queried flag.
  4135. Flags:
  4136. - forward : f (bool) [create,query]
  4137. When true, play back the animation from the currentTime to the maximum of the playback range. When false, play back from
  4138. the currentTime to the minimum of the playback range. When queried, returns an int.
  4139. - playSound : ps (bool) [create,query]
  4140. Specify whether or not sound should be used during playback Flag can have multiple arguments,
  4141. passed either as a tuple or a list.
  4142. - record : rec (bool) [create,query]
  4143. enable the recording system and start one playback loop
  4144. - sound : s (unicode) [create,query]
  4145. Specify the sound node to be used during playback
  4146. - state : st (bool) [create,query]
  4147. start or stop playing back
  4148. - wait : w (bool) [create]
  4149. Wait till completion before returning control to command Window.
  4150. Derived from mel command `maya.cmds.play`
  4151. """
  4152. pass
  4153. def playbackOptions(*args, **kwargs):
  4154. """
  4155. This command sets/queries certain values associated with playback: looping style, start/end times, etc. Only commands
  4156. modifying the -minTime/maxTime, the -animationStartTime/animationEndTime, or the -by value are undoable.
  4157. Flags:
  4158. - animationEndTime : aet (time) [create,query,edit]
  4159. Sets the end time of the animation. Query returns a float.
  4160. - animationStartTime : ast (time) [create,query,edit]
  4161. Sets the start time of the animation. Query returns a float.
  4162. - by : by (float) [create,query,edit]
  4163. Increment between times viewed during playback. (Default 1.0) Flag can have multiple arguments,
  4164. passed either as a tuple or a list.
  4165. - framesPerSecond : fps (bool) [create,query]
  4166. Queries the actual playback rate. Query returns a float.
  4167. - loop : l (unicode) [create,query,edit]
  4168. Controls if and how playback repeats. Valid values are once,continuous,and oscillate.Query returns string.
  4169. - maxPlaybackSpeed : mps (float) [create,query,edit]
  4170. Sets the desired maximum playback speed. Query returns a float. The maxPlaybackSpeed is only used by Maya when your
  4171. playbackSpeed is 0 (play every frame). The maxPlaybackSpeed will clamp the maximum playback rate to prevent it from
  4172. going more than a certain amount. A maxPlaybackSpeed of 0 will give free (unclamped) playback.
  4173. - maxTime : max (time) [create,query,edit]
  4174. Sets the end of the playback time range. Query returns a float.
  4175. - minTime : min (time) [create,query,edit]
  4176. Sets the start of the playback time range. Query returns a float.
  4177. - playbackSpeed : ps (float) [create,query,edit]
  4178. Sets the desired playback speed. Query returns a float.
  4179. - view : v (unicode) [create,query,edit]
  4180. Controls how many modelling views update during playback. Valid values are alland active. Query returns a string.
  4181. Derived from mel command `maya.cmds.playbackOptions`
  4182. """
  4183. pass
  4184. def playblast(*args, **kwargs):
  4185. """
  4186. This command playblasts the current playback range. Sound is optional.
  4187. Flags:
  4188. - activeEditor : ae (bool) [create]
  4189. This flag will return the current model editor that would be used for playblast. It does not invoke playblast itself.
  4190. - cameraSetup : cs (unicode, unicode) [create]
  4191. Information about camera setup. The first string defines a camera setup MEL procedure. The camera setup procedure will
  4192. be invoked before executing a playblast. The second string argument which is used as a camera identifier and is appended
  4193. to the root file name to specify the final output file name(s). The command will fail there is not a pair of strings
  4194. supplied to the argument.
  4195. - clearCache : cc (bool) [create]
  4196. When true, all previous temporary playblast files will be deleted before the new playblast files are created. Any
  4197. playblast files that were explicitly given a name by the user will not be deleted. All remaining temporary playblast
  4198. files will be deleted when the application quits regardless of whether this flag was set.
  4199. - combineSound : csd (bool) [create]
  4200. Combine the trax sounds into a single track. This might force a resampling of the sound if the sound paramters don't
  4201. match up. Flag can have multiple arguments, passed either as a tuple or a list.
  4202. - completeFilename : cf (unicode) [create]
  4203. When set, this string specifies the exact name of the output image. In contrast with the -f/filename flag,
  4204. -cf/completeFilename does not append any frame number or extension string at the end of the filename. Additionally,
  4205. playblast will not delete the image from disk after it is displayed. This flag should not be used in conjunction with
  4206. -f/filename.
  4207. - compression : c (unicode) [create]
  4208. Specify the compression to use for the movie file. Use the command `playblast -options` command to launch a dialog to
  4209. determine wich setting are avalible for a given platform.
  4210. - endTime : et (time) [create]
  4211. Specify the end time of the playblast. Default is the end time of the playback range displayed in the Time Slider.
  4212. Overridden by -frame.
  4213. - filename : f (unicode) [create]
  4214. The filename to use for the output of this playblast. If the file already exists, a confirmation box will be displayed
  4215. if playblast is performed interactively. If playblast is executed from the command line and the file already exists, it
  4216. will abort.
  4217. - forceOverwrite : fo (bool) [create]
  4218. Overwrite existing playblast files which may have the the same name as the one specified with the -fflag
  4219. - format : fmt (unicode) [create]
  4220. The format of the output of this playblast. Valid values and their meanings:-- movieThis will result in the defaulting
  4221. movie format on a given platform On Windows, the out is AVI format and the player is Microsoft Media Player. On Mac OSX,
  4222. the output is of type QuickTime and the player is QuickTime. On Unix, this option outputs SGI's movie format and sets
  4223. the default viewing command to movieplayer. The resulting file is named according to the -fflag, if specified.-- aviSet
  4224. the format to use avi as the output format. Only supported on Windows. -- qtQuickTime. Supported on all platforms but 64
  4225. bit windows. -- sgiUse the older sgi format. -- imageoutputs a sequence of image files and sets the viewing command to
  4226. the application specified in the preferences by the user. If no application is specified, it sets viewing command to
  4227. fcheck. The image format will be the Output Format specified using Render-RenderGlobals. The resulting files use the
  4228. value of the -fflag as a prefix, with an appended frame number, as in myFile.0007.iffThe default value of the
  4229. -fmt/format flag is movie.
  4230. - frame : fr (time) [create]
  4231. List of frames to blast. One frame specified per flag. The frames can be specifed in any order but will be output in an
  4232. ordered sequence. When specified this flag will override any start/end range
  4233. - framePadding : fp (int) [create]
  4234. Number of zeros used to pad file name. Typically set to 4 to support fcheck.
  4235. - height : h (int) [create]
  4236. Height of the final image. This value will be clamped if larger than the width of the active window.Windows: If not
  4237. using fcheck, the width and height must each be divisible by 4.
  4238. - indexFromZero : ifz (bool) [create]
  4239. Output frames starting with file.0000.ext and incrementing by one. Typically frames use the Maya time as their frame
  4240. number. This option can only be used for frame based output formats.
  4241. - offScreen : os (bool) [create]
  4242. When set, this toggle allow playblast to use an offscreen buffer to render the view. This allows playblast to work when
  4243. the application is iconified, or obscured. This flag is only supported on Linux.
  4244. - options : o (bool) [create]
  4245. Brings up a dialog for setting playblast options, and does not run the playblast.
  4246. - percent : p (int) [create]
  4247. Percentage of current view size to use during blasting. Accepted values are integers between 10 and 100. All other
  4248. values are clamped to be within this range. A value of 25 means 1/4 of the current view size; a value of 50 means
  4249. half the current view size; a value of 100 means full size. (Default is 50.)
  4250. - quality : qlt (int) [create]
  4251. Specify the compression quality factor to use for the movie file. Value should be in the 0-100 range
  4252. - rawFrameNumbers : rfn (bool) [create]
  4253. Playblast typically numbers its frames sequentially, starting at zero. This flag will override the default action and
  4254. frames will be numbered using the actual frames specified by the -frame or -startFrame/-endFrame flags.
  4255. - replaceAudioOnly : rao (bool) [create]
  4256. When set, this string dictates that only the audio will be replaced when the scene is re-playblasted.
  4257. - replaceEndTime : ret (time) [create]
  4258. Specify the end time of a replayblast of an existing playblast. Default is the start time of the playback range
  4259. displayed in the Time Slider. Overridden by -frame.
  4260. - replaceFilename : rf (bool) [create]
  4261. When set, this string specifies the name of an input playblast file which will have frames replaced according to the
  4262. replace start and end times.
  4263. - replaceStartTime : rst (time) [create]
  4264. Specify the start time of a replayblast of an existing playblast. Default is the start time of the playback range
  4265. displayed in the Time Slider. Overridden by -frame.
  4266. - sequenceTime : sqt (bool) [create]
  4267. Use sequence time
  4268. - showOrnaments : orn (bool) [create]
  4269. Sets whether or not model view ornaments (e.g. the axis icon) should be displayed
  4270. - sound : s (unicode) [create]
  4271. Specify the sound node to be used during playblast
  4272. - startTime : st (time) [create]
  4273. Specify the start time of the playblast. Default is the start time of the playback range displayed in the Time Slider.
  4274. Overridden by -frame.
  4275. - useTraxSounds : uts (bool) []
  4276. - viewer : v (bool) [create]
  4277. Specify whether a viewer should be launched for the playblast. Default is true. Runs fcheckwhen -fmt is image. The
  4278. player for movie files depends on the OS: Windows uses Microsoft Media Player, Irix uses movieplayer, OSX uses
  4279. QuickTime.
  4280. - width : w (int) [create]
  4281. Width of the final image. This value will be clamped if larger than the width of the active window.Windows: If not using
  4282. fcheck, the width and height must each be divisible by 4.
  4283. - widthHeight : wh (int, int) [create]
  4284. Final image's width and height. Values larger than the dimensions of the active window are clamped. A width and height
  4285. of 0 means to use the window's current size.Windows: If not using fcheck, the width and height must each be divisible by
  4286. 4.
  4287. Derived from mel command `maya.cmds.playblast`
  4288. """
  4289. pass
  4290. def pointConstraint(*args, **kwargs):
  4291. """
  4292. Constrain an object's position to the position of the target object or to the average position of a number of targets. A
  4293. pointConstraint takes as input one or more targetDAG transform nodes at which to position the single constraint
  4294. objectDAG transform node. The pointConstraint positions the constrained object at the weighted average of the world
  4295. space position target objects.
  4296. Maya Bug Fix:
  4297. - when queried, angle offsets would be returned in radians, not current angle unit
  4298. Modifications:
  4299. - added new syntax for querying the weight of a target object, by passing the constraint first::
  4300. aimConstraint( 'pCube1_aimConstraint1', q=1, weight ='pSphere1' )
  4301. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =['pSphere1', 'pCylinder1'] )
  4302. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =[] )
  4303. Flags:
  4304. - layer : l (unicode) [create,edit]
  4305. Specify the name of the animation layer where the constraint should be added.
  4306. - maintainOffset : mo (bool) [create]
  4307. The offset necessary to preserve the constrained object's initial position will be calculated and used as the offset.
  4308. - name : n (unicode) [create,query,edit]
  4309. Sets the name of the constraint node to the specified name. Default name is constrainedObjectName_constraintType
  4310. - offset : o (float, float, float) [create,query,edit]
  4311. Sets or queries the value of the offset. Default is 0,0,0.
  4312. - remove : rm (bool) [edit]
  4313. removes the listed target(s) from the constraint.
  4314. - skip : sk (unicode) [create,edit]
  4315. Specify the axis to be skipped. Valid values are x, y, zand none. During creation, noneis the default. This flag is
  4316. multi-use. Flag can have multiple arguments, passed either as a tuple or a list.
  4317. - targetList : tl (bool) [query]
  4318. Return the list of target objects.
  4319. - weight : w (float) [create,query,edit]
  4320. Sets the weight value for the specified target(s). If not given at creation time, the default value of 1.0 is used.
  4321. - weightAliasList : wal (bool) [query]
  4322. Returns the names of the attributes that control the weight of the target objects. Aliases are returned in the same
  4323. order as the targets are returned by the targetList flag
  4324. Derived from mel command `maya.cmds.pointConstraint`
  4325. """
  4326. pass
  4327. def pointOnPolyConstraint(*args, **kwargs):
  4328. """
  4329. Constrain an object's position to the position of the target object or to the average position of a number of targets. A
  4330. pointOnPolyConstraint takes as input one or more targetDAG transform nodes at which to position the single constraint
  4331. objectDAG transform node. The pointOnPolyConstraint positions the constrained object at the weighted average of the
  4332. world space position target objects.
  4333. Maya Bug Fix:
  4334. - when queried, angle offsets would be returned in radians, not current angle unit
  4335. Modifications:
  4336. - added new syntax for querying the weight of a target object, by passing the constraint first::
  4337. aimConstraint( 'pCube1_aimConstraint1', q=1, weight ='pSphere1' )
  4338. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =['pSphere1', 'pCylinder1'] )
  4339. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =[] )
  4340. Flags:
  4341. - layer : l (unicode) [create,edit]
  4342. Specify the name of the animation layer where the constraint should be added.
  4343. - maintainOffset : mo (bool) [create]
  4344. The offset necessary to preserve the constrained object's initial position will be calculated and used as the offset.
  4345. - name : n (unicode) [create,query,edit]
  4346. Sets the name of the constraint node to the specified name. Default name is constrainedObjectName_constraintType
  4347. - offset : o (float, float, float) [create,query,edit]
  4348. Sets or queries the value of the offset. Default is 0,0,0.
  4349. - remove : rm (bool) [edit]
  4350. removes the listed target(s) from the constraint.
  4351. - skip : sk (unicode) [create,edit]
  4352. Specify the axis to be skipped. Valid values are x, y, zand none. During creation, noneis the default. This flag is
  4353. multi-use. Flag can have multiple arguments, passed either as a tuple or a list.
  4354. - targetList : tl (bool) [query]
  4355. Return the list of target objects.
  4356. - weight : w (float) [create,query,edit]
  4357. Sets the weight value for the specified target(s). If not given at creation time, the default value of 1.0 is used.
  4358. - weightAliasList : wal (bool) [query]
  4359. Returns the names of the attributes that control the weight of the target objects. Aliases are returned in the same
  4360. order as the targets are returned by the targetList flag
  4361. Derived from mel command `maya.cmds.pointOnPolyConstraint`
  4362. """
  4363. pass
  4364. def poleVectorConstraint(*args, **kwargs):
  4365. """
  4366. Constrains the poleVector of an ikRPsolve handle to point at a target object or at the average position of a number of
  4367. targets. An poleVectorConstraint takes as input one or more targetDAG transform nodes at which to aim pole vector for an
  4368. IK handle using the rotate plane solver. The pole vector is adjust such that the in weighted average of the world space
  4369. position target objects lies is the rotate planeof the handle.
  4370. Maya Bug Fix:
  4371. - when queried, angle offsets would be returned in radians, not current angle unit
  4372. Modifications:
  4373. - added new syntax for querying the weight of a target object, by passing the constraint first::
  4374. aimConstraint( 'pCube1_aimConstraint1', q=1, weight ='pSphere1' )
  4375. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =['pSphere1', 'pCylinder1'] )
  4376. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =[] )
  4377. Flags:
  4378. - layer : l (unicode) [create,edit]
  4379. Specify the name of the animation layer where the constraint should be added. Flag can have multiple
  4380. arguments, passed either as a tuple or a list.
  4381. - name : n (unicode) [create,query,edit]
  4382. Sets the name of the constraint node to the specified name. Default name is constrainedObjectName_constraintType
  4383. - remove : rm (bool) [edit]
  4384. removes the listed target(s) from the constraint.
  4385. - targetList : tl (bool) [query]
  4386. Return the list of target objects.
  4387. - weight : w (float) [create,query,edit]
  4388. Sets the weight value for the specified target(s). If not given at creation time, the default value of 1.0 is used.
  4389. - weightAliasList : wal (bool) [query]
  4390. Returns the names of the attributes that control the weight of the target objects. Aliases are returned in the same
  4391. order as the targets are returned by the targetList flag
  4392. Derived from mel command `maya.cmds.poleVectorConstraint`
  4393. """
  4394. pass
  4395. def pose(*args, **kwargs):
  4396. """
  4397. This command is used to create character poses.
  4398. Flags:
  4399. - allPoses : ap (bool) [query]
  4400. This flag is used to query all the poses in the scene. Flag can have multiple
  4401. arguments, passed either as a tuple or a list.
  4402. - apply : a (bool) [create]
  4403. This flag is used in conjunction with the name flag to specify a pose should be applied to the character.
  4404. - name : n (unicode) [create,query]
  4405. In create mode, specify the pose name. In query mode, return a list of all the poses for the character. In apply mode,
  4406. specify the pose to be applied.
  4407. Derived from mel command `maya.cmds.pose`
  4408. """
  4409. pass
  4410. def readTake(*args, **kwargs):
  4411. """
  4412. This action reads a take (.mov) file to a defined device. See also: writeTake, applyTake
  4413. Flags:
  4414. - angle : a (unicode) [create]
  4415. Sets the angular unit used in the take. Valid strings are deg, degree, rad, and radian. C: The default is the current
  4416. user angular unit.
  4417. - device : d (unicode) [create]
  4418. Specifies the device into which the take data is read. This is a required argument.
  4419. - frequency : f (float) [create]
  4420. The timestamp is ignored and the specified frequency is used. If timeStamp data is not in the .mov file, the
  4421. -noTimestamp flag should also be used. This flag resample, instead the data is assumed to be at the specified frequency.
  4422. C: If the take file does not use time stamps, the default frequency is 60Hz. Flag can have
  4423. multiple arguments, passed either as a tuple or a list.
  4424. - linear : l (unicode) [create]
  4425. Sets the linear unit used in the take. Valid strings are mm, millimeter, cm, centimeter, m, meter, km, kilometer, in,
  4426. inch, ft, foot, yd, yard, mi, and mile. C: The default is the current user linear unit.
  4427. - noTime : nt (bool) [create]
  4428. Specifies if the take (.mov) file contains time stamps. C: The default is to assume time stamps are part of the take
  4429. file.
  4430. - take : t (unicode) [create]
  4431. Reads the specified take file. It is safest to pass the full path to the flag.
  4432. Derived from mel command `maya.cmds.readTake`
  4433. """
  4434. pass
  4435. def recordDevice(*args, **kwargs):
  4436. """
  4437. Starts and stops server side device recording. The data is recorded at the device rate. Once recorded, the data may be
  4438. brought into Maya with the applyTake command. See also: enableDevice, applyTake, readTake, writeTake In query mode,
  4439. return type is based on queried flag.
  4440. Flags:
  4441. - cleanup : c (bool) [create]
  4442. Removes the recorded data from the device. Flag can have multiple arguments, passed either as a
  4443. tuple or a list.
  4444. - data : da (bool) [query]
  4445. Specifies if the device has recorded data. If the device is recording at the time of query, the flag will return false.
  4446. Q: When queried, this flag returns an int.
  4447. - device : d (unicode) [create]
  4448. Specifies which device(s) to start record recording. The listed device(s) will start recording regardless of their
  4449. record enable state. C: The default is to start recording all devices that are record enabled.
  4450. - duration : dr (int) [create,query]
  4451. Duration (in seconds) of the recording. When the duration expires, the device will still be in a recording state and
  4452. must be told to stop recording. C: The default is 60. Q: When queried, this flag returns an int.
  4453. - playback : p (bool) [create,query]
  4454. If any attribute is connected to an animation curve, the animation curve will play back while recording the device(s)
  4455. including any animation curves attached to attributes being recorded. C: The default is false. Q: When queried, this
  4456. flag returns an int.
  4457. - state : st (bool) [create,query]
  4458. Start or stop device recording. C: The default is true. Q: When queried, this flag returns an int.
  4459. - wait : w (bool) [create]
  4460. If -p/playback specified, wait until playback completion before returning control to the user. This flag is ignored if
  4461. -p is not used.
  4462. Derived from mel command `maya.cmds.recordDevice`
  4463. """
  4464. pass
  4465. def removeJoint(*args, **kwargs):
  4466. """
  4467. This command will remove the selected joint or the joint given at the command line from the skeleton. The given(or
  4468. selected) joint should not be the root joint of the skeleton, and not have skin attached. The command works on the
  4469. given(or selected) joint. No options or flags are necessary.
  4470. Derived from mel command `maya.cmds.removeJoint`
  4471. """
  4472. pass
  4473. def reorderDeformers(*args, **kwargs):
  4474. """
  4475. This command changes the order in which 2 deformation nodes affect the output geometry. The first string argument is the
  4476. name of deformer1, the second is deformer2, followed by the list of objects they deform. It inserts deformer2 before
  4477. deformer1. Currently supported deformer nodes include: sculpt, cluster, jointCluster, lattice, wire, jointLattice,
  4478. boneLattice, blendShape.
  4479. Flags:
  4480. - name : n (unicode) [create]
  4481. This flag is obsolete and is not used. Flag can have multiple arguments, passed either as a tuple or
  4482. a list.
  4483. Derived from mel command `maya.cmds.reorderDeformers`
  4484. """
  4485. pass
  4486. def reroot(*args, **kwargs):
  4487. """
  4488. This command will reroot a skeleton. The selected joint or the given joint at the command line will be the new root
  4489. of the skeleton. All ikHandles passing through the selected joint or above it will be deleted. The given(or selected)
  4490. joint should not have skin attached. The command works on the given or selected joint. No options or flags are
  4491. necessary.
  4492. Derived from mel command `maya.cmds.reroot`
  4493. """
  4494. pass
  4495. def retarget(*args, **kwargs):
  4496. """
  4497. This command is used to take motion from one character and retarget it to a second character of a different size.
  4498. Flags:
  4499. - endFrame : end (int) [create]
  4500. Specify the retargeting end frame. Default is 10.
  4501. - lowerBody : lb (unicode) [create]
  4502. Specify the desired retargeting technique for the lower body. Valid options are: jointRotationsOnly,
  4503. scaledFootPlacementand absoluteFootPlacement. Default is scaledFootPlacement.
  4504. - lowerScale : ls (unicode) [create]
  4505. Specify the way scale is calculated for the lower body. Valid techniques are: hipToFoot, hipToToe, overallHeight, and
  4506. other. This option is used when the lowerBody flag is set to anything other than jointRotationsOnly. Default is
  4507. hipToFoot. When otheris used, the lowerScaleFactor flag should be used to specify the scale factor.
  4508. - lowerScaleFactor : lsf (float) [create]
  4509. Specify the scale factor for the lower body. This option is only used when the lowerScale is set to other.
  4510. - maintainOffset : mo (bool) [create]
  4511. When this flag is used, the root of the target character will stay the same distance from the source as at the rest
  4512. pose.
  4513. - restPoseFrame : rpf (int) [create]
  4514. The retargeting solution takes the rest pose of the characters into consideration. For example, one character may be
  4515. bowlegged with respect to the other in the rest pose. When retargeting animation from the bowlegged character to the
  4516. non-bowlegged character, the solution will take the rest pose into account so that the target character will receive the
  4517. walk animation without the bowlegged aspects of the walk. The user has 2 options for specifying a restPose: specifying a
  4518. frame number at which the rest pose is defined, or defining a retargeting rest pose using the Retargeting-SetRestPose
  4519. menu item. If you use a frame number for the rest pose, the best practice is to use a frame that does not lie within the
  4520. range of frames being retargeted. This allows you to retarget without wiping out the rest pose.
  4521. Flag can have multiple arguments, passed either as a tuple or a list.
  4522. - scaleHandsFrom : shf (unicode) [create]
  4523. Specify where the arms are scaled from. Valid arguments are: shoulder, rootand origin. This option is only used when the
  4524. upperBody flag is set to scaledHandPlacement. Defaults is shoulder.
  4525. - startFrame : s (int) [create]
  4526. Specify the retargeting start frame. Default is 0.
  4527. - upperBody : ub (unicode) [create]
  4528. Specify the desired retargeting technique for the upper body. Valid techniques are: jointRotationsOnly,
  4529. scaledHandPlacement, absoluteHandPlacementand maintainHandDistance. Default is jointRotationsOnly.
  4530. - upperScale : us (unicode) [create]
  4531. Specify the way scale is calculated for the upper body. Valid techniques are: shoulderToWrist, shoulderToHand,
  4532. followLower, and other. This option is used when the upperBody flag is set to anything other than jointRotationsOnly.
  4533. Defaults is shoulderToHand. When otheris used, the upperScaleFactor flag should be used to specify the scale factor.
  4534. - upperScaleFactor : usf (float) [create]
  4535. Specify the scale factor for the upper body. This option is used when the upperScale is set to other.
  4536. - useExistingKeys : uek (bool) [create]
  4537. When this flag is used, the existing keys on the target are used as a hint to help guide the retargeting solution. This
  4538. option sometimes allows the solver to narrow in on a better solution.
  4539. Derived from mel command `maya.cmds.retarget`
  4540. """
  4541. pass
  4542. def rotationInterpolation(*args, **kwargs):
  4543. """
  4544. The rotationInterpolation command converts the rotation curves to the desired rotation interpolation
  4545. representation. For example, an Euler-angled representation can be converted to Quaternion. In
  4546. query mode, return type is based on queried flag.
  4547. Flags:
  4548. - convert : c (unicode) [create,query]
  4549. Specifies the rotation interpolation mode for the curves after converting. Possible choices are none(unsynchronized
  4550. Euler-angled curves which are compatible with pre-4.0 Maya curves), euler(Euler-angled curves with keyframes kept
  4551. synchronized), quaternion(quaternion curves with keyframes kept synchronized, but the exact interpolation depends on
  4552. individual tangents), quaternionSlerp(applies quaternion slerp interpolation to the curve, ignoring tangent settings),
  4553. quaternionSquad(applied cubic interpolation to the curve in quaternion space, ignoring tangent settings)
  4554. Flag can have multiple arguments, passed either as a tuple or a list.
  4555. Derived from mel command `maya.cmds.rotationInterpolation`
  4556. """
  4557. pass
  4558. def scaleConstraint(*args, **kwargs):
  4559. """
  4560. Constrain an object's scale to the scale of the target object or to the average scale of a number of targets. A
  4561. scaleConstraint takes as input one or more targetDAG transform nodes to which to scale the single constraint objectDAG
  4562. transform node. The scaleConstraint scales the constrained object at the weighted geometric mean of the world space
  4563. target scale factors.
  4564. Maya Bug Fix:
  4565. - when queried, angle offsets would be returned in radians, not current angle unit
  4566. Modifications:
  4567. - added new syntax for querying the weight of a target object, by passing the constraint first::
  4568. aimConstraint( 'pCube1_aimConstraint1', q=1, weight ='pSphere1' )
  4569. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =['pSphere1', 'pCylinder1'] )
  4570. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =[] )
  4571. Flags:
  4572. - layer : l (unicode) [create,edit]
  4573. Specify the name of the animation layer where the constraint should be added.
  4574. - maintainOffset : mo (bool) [create]
  4575. The offset necessary to preserve the constrained object's initial scale will be calculated and used as the offset.
  4576. - name : n (unicode) [create,query,edit]
  4577. Sets the name of the constraint node to the specified name. Default name is constrainedObjectName_constraintType
  4578. - offset : o (float, float, float) [create,query,edit]
  4579. Sets or queries the value of the offset. Default is 1,1,1.
  4580. - remove : rm (bool) [edit]
  4581. removes the listed target(s) from the constraint.
  4582. - skip : sk (unicode) [create,edit]
  4583. Specify the axis to be skipped. Valid values are x, y, zand none. During creation, noneis the default. This flag is
  4584. multi-use. Flag can have multiple arguments, passed either as a tuple or a list.
  4585. - targetList : tl (bool) [query]
  4586. Return the list of target objects.
  4587. - weight : w (float) [create,query,edit]
  4588. Sets the weight value for the specified target(s). If not given at creation time, the default value of 1.0 is used.
  4589. - weightAliasList : wal (bool) [query]
  4590. Returns the names of the attributes that control the weight of the target objects. Aliases are returned in the same
  4591. order as the targets are returned by the targetList flag
  4592. Derived from mel command `maya.cmds.scaleConstraint`
  4593. """
  4594. pass
  4595. def scaleKey(*args, **kwargs):
  4596. """
  4597. This command operates on a keyset. A keyset is defined as a group of keys within a specified time range on one or more
  4598. animation curves. The animation curves comprising a keyset depend on the value of the -animationflag: keysOrObjects: Any
  4599. active keys, when no target objects or -attribute flags appear on the command line, orAll animation curves connected to
  4600. all keyframable attributes of objects specified as the command line's targetList, when there are no active keys.keys:
  4601. Only act on active keys or tangents. If there are no active keys or tangents, don't do anything. objects: Only act on
  4602. specified objects. If there are no objects specified, don't do anything. Note that the -animationflag can be used to
  4603. override the curves uniquely identified by the multi-use -attributeflag, which takes an argument of the form
  4604. attributeName, such as translateX. Keys on animation curves are identified by either their time values or their indices.
  4605. Times and indices can be given individually or as part of a list or range. -time 10palmeans the key at frame 10 (PAL
  4606. format).-time 1.0sec -time 15ntsc -time 20means the keys at time 1.0 second, frame 15 (in NTSC format), and time 20 (in
  4607. the currently defined global time unit).-time 10:20means all keys in the range from 10 to 20, inclusive, in the current
  4608. time unit.Omitting one end of a range means go to infinity, as in the following examples: -time 10:means all keys from
  4609. time 10 (in the current time unit) onwards.-time :10means all keys up to (and including) time 10 (in the current time
  4610. unit).-time :is a short form to specify all keys.-index 0means the first key of each animation curve. (Indices are
  4611. 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
  4612. of each animation curve.This command takes keyframes at (or within) the specified times (or time ranges) and scales
  4613. them. If no times are specified, the scale is applied to active keyframes or (if no keys are active) all keys of active
  4614. objects.
  4615. Flags:
  4616. - animation : an (unicode) [create]
  4617. Where this command should get the animation to act on. Valid values are objects,keys,and keysOrObjectsDefault:
  4618. keysOrObjects.(See Description for details.)
  4619. - attribute : at (unicode) [create]
  4620. List of attributes to select
  4621. - controlPoints : cp (bool) [create]
  4622. This flag explicitly specifies whether or not to include the control points of a shape (see -sflag) in the list of
  4623. attributes. Default: false. (Not valid for pasteKeycmd.)
  4624. - float : f (floatrange) [create]
  4625. value uniquely representing a non-time-based key (or key range) on a time-based animCurve. Valid floatRange include
  4626. single values (-f 10) or a string with a lower and upper bound, separated by a colon (-f 10:20
  4627. - floatPivot : fp (float) [create]
  4628. Scale pivot along the x-axis for float-input animCurves
  4629. - floatScale : fs (float) [create]
  4630. Amount of scale along the x-axis for float-input animCurves
  4631. - hierarchy : hi (unicode) [create]
  4632. Hierarchy expansion options. Valid values are above,below,both,and none.(Not valid for pasteKeycmd.)
  4633. - includeUpperBound : iub (bool) [create]
  4634. When the -t/time or -f/float flags represent a range of keys, this flag determines whether the keys at the upper bound
  4635. of the range are included in the keyset. Default value: true. This flag is only valid when the argument to the -t/time
  4636. flag is a time range with a lower and upper bound. (When used with the pasteKeycommand, this flag refers only to the
  4637. time range of the target curve that is replaced, when using options such as replace,fitReplace,or scaleReplace.This flag
  4638. has no effect on the curve pasted from the clipboard.)
  4639. - index : index (int) [create]
  4640. index of a key on an animCurve
  4641. - newEndFloat : nef (float) [create]
  4642. The end of the float range to which the float-input targets should be scaled.
  4643. - newEndTime : net (time) [create]
  4644. The end of the time range to which the targets should be scaled.
  4645. - newStartFloat : nsf (float) [create]
  4646. The start of the float range to which the float-input targets should be scaled.
  4647. - newStartTime : nst (time) [create]
  4648. The start of the time range to which the time-input targets should be scaled.
  4649. - scaleSpecifiedKeys : ssk (bool) [create]
  4650. Determines if only the specified keys are affected by the scale. If false, other keys may be adjusted with the scale.
  4651. The default is true. Flag can have multiple arguments, passed either as a tuple or a list.
  4652. - shape : s (bool) [create]
  4653. Consider attributes of shapes below transforms as well, except controlPoints. Default: true. (Not valid for
  4654. pasteKeycmd.)
  4655. - time : t (timerange) [create]
  4656. time uniquely representing a key (or key range) on a time-based animCurve. Valid timeRanges include single values (-t
  4657. 10) or a string with a lower and upper bound, separated by a colon (-t 10:20
  4658. - timePivot : tp (time) [create]
  4659. Scale pivot along the time-axis for time-input animCurves
  4660. - timeScale : ts (float) [create]
  4661. Amount of scale along the time-axis for time-input animCurves
  4662. - valuePivot : vp (float) [create]
  4663. Scale pivot along the value-axis
  4664. - valueScale : vs (float) [create]
  4665. Amount of scale along the value-axis
  4666. Derived from mel command `maya.cmds.scaleKey`
  4667. """
  4668. pass
  4669. def sculpt(*args, **kwargs):
  4670. """
  4671. This command creates/edits/queries a sculpt object deformer. By default for creation mode an implicit sphere will be
  4672. used as the sculpting object if no sculpt tool is specified. The name of the created/edited object is returned.
  4673. Flags:
  4674. - after : af (bool) [create,edit]
  4675. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  4676. flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape
  4677. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  4678. - afterReference : ar (bool) []
  4679. - before : bf (bool) [create,edit]
  4680. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  4681. flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape
  4682. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  4683. - deformerTools : dt (bool) [query]
  4684. Returns the name of the deformer tool objects (if any) as string string ...
  4685. - dropoffDistance : dds (float) [create,query,edit]
  4686. Specifies the distance from the surface of the sculpt object at which the sculpt object produces no deformation effect.
  4687. Default is 1.0. When queried, this flag returns a float.
  4688. - dropoffType : drt (unicode) [create,query,edit]
  4689. Specifies how the deformation effect drops off from maximum effect at the surface of the sculpt object to no effect at
  4690. dropoff distance limit. Valid values are: linear | none. Default is linear. When queried, this flag returns a string.
  4691. - exclusive : ex (unicode) [create,query]
  4692. Puts the deformation set in a deform partition.
  4693. - frontOfChain : foc (bool) [create,edit]
  4694. This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and
  4695. skin nodes in the shape's history (but not ahead of existing tweak nodes). The input to the deformer will be the
  4696. upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the
  4697. downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and
  4698. edit mode if the deformer has no geometry added yet).
  4699. - geometry : g (unicode) [query,edit]
  4700. The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is
  4701. also specified. When queried, this flag returns string string string ...
  4702. - geometryIndices : gi (bool) []
  4703. - groupWithLocator : gwl (bool) [create]
  4704. Groups the sculptor and its locator together under a single transform. Default is off.
  4705. - ignoreSelected : ignoreSelected (bool) [create]
  4706. Tells the command to not deform objects on the current selection list
  4707. - insideMode : im (unicode) [create,query,edit]
  4708. Specifies how the deformation algorithm deals with points that are inside the sculpting primitve. The choices are: ring
  4709. | even. The default is even. When queried, this flag returns a string. Ring mode will tend to produce a contour like
  4710. ring of points around the sculpt object as it passes through an object while even mode will try to spread the points out
  4711. as evenly as possible across the surface of the sculpt object.
  4712. - maxDisplacement : mxd (float) [create,query,edit]
  4713. Defines the maximum amount the sculpt object may move a point on an object which it is deforming. Default is 1.0. When
  4714. queried, this flag returns a float.
  4715. - mode : m (unicode) [create,query,edit]
  4716. Specifies which deformation algorithm the sculpt object should use. The choices are: flip | project | stretch. The
  4717. default is stretch. When queried, this flag returns a string.
  4718. - name : n (unicode) [create]
  4719. Used to specify the name of the node being created
  4720. - objectCentered : oc (bool) [create]
  4721. Places the sculpt and locator in the center of the bounding box of the selected object(s) or components. Default is off
  4722. which centers the sculptor and locator at the origin.
  4723. - parallel : par (bool) [create,edit]
  4724. Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is
  4725. inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry
  4726. added yet).
  4727. - prune : pr (bool) [edit]
  4728. Removes any points not being deformed by the deformer in its current configuration from the deformer set.
  4729. - remove : rm (bool) [edit]
  4730. Specifies that objects listed after the -g flag should be removed from this deformer.
  4731. - sculptTool : st (unicode) [create]
  4732. Use the specified NURBS object as the sculpt tool instead of the default implicit sphere. Flag
  4733. can have multiple arguments, passed either as a tuple or a list.
  4734. - split : sp (bool) [create,edit]
  4735. Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing
  4736. chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
  4737. Derived from mel command `maya.cmds.sculpt`
  4738. """
  4739. pass
  4740. def sequenceManager(*args, **kwargs):
  4741. """
  4742. The sequenceManager command manages sequences, shots, and their related scenes. In query mode, return
  4743. type is based on queried flag.
  4744. Flags:
  4745. - addSequencerAudio : asa (unicode) [create]
  4746. Add an audio clip to the sequencer by specifying a filename
  4747. - attachSequencerAudio : ata (unicode) [create]
  4748. Add an audio clip to the sequencer by specifying an audio node
  4749. - currentShot : cs (unicode) [query]
  4750. Returns the shot that is being used at the current sequence time.
  4751. - currentTime : ct (time) [create,query]
  4752. Set the current sequence time
  4753. - listSequencerAudio : lsa (unicode) [create]
  4754. List the audio clips added to the sequencer Flag can have multiple arguments,
  4755. passed either as a tuple or a list.
  4756. - listShots : lsh (bool) []
  4757. - modelPanel : mp (unicode) [create,query]
  4758. Sets a dedicated modelPanel to be used as the panel that the sequencer will control.
  4759. - node : nd (unicode) [query]
  4760. Returns the SequenceManager node, of which there is only ever one.
  4761. - writableSequencer : ws (unicode) [query]
  4762. Get the writable sequencer node. Create it if it doesn't exist.
  4763. Derived from mel command `maya.cmds.sequenceManager`
  4764. """
  4765. pass
  4766. def setCurrentTime(time):
  4767. """
  4768. set the current time
  4769. """
  4770. pass
  4771. def setDrivenKeyframe(*args, **kwargs):
  4772. """
  4773. This command sets a driven keyframe. A driven keyframe is similar to a regular keyframe. However, while a standard
  4774. keyframe always has an x-axis of time in the graph editor, for a drivenkeyframe the user may choose any attribute as the
  4775. x-axis of the graph editor. For example, you can keyframe the emission of a faucet so that so that it emits whenever the
  4776. faucet handle is rotated around y. The faucet emission in this example is called the driven attribute. The handle
  4777. rotation is called the driver. Once you have used setDrivenKeyframe to set up the relationship between the emission and
  4778. the rotation, you can go to the graph editor and modify the relationship between the attributes just as you would modify
  4779. the animation curve on any keyframed object. In the case of an attribute driven by a single driver, the dependency graph
  4780. is connected like this: driver attribute ---animCurve ---driven attribute You can set driven keyframes with more than a
  4781. single driver. The effects of the multiple drivers are combined together by a blend node.
  4782. Flags:
  4783. - attribute : at (unicode) [create]
  4784. Attribute name to set keyframes on.
  4785. - controlPoints : cp (bool) [create]
  4786. Explicitly specify whether or not to include the control points of a shape (see -sflag) in the list of attributes.
  4787. Default: false.
  4788. - currentDriver : cd (unicode) [create,query]
  4789. Set the driver to be used for the current driven keyframe to the attribute passed as an argument.
  4790. - driven : dn (bool) [query]
  4791. Returns list of driven attributes for the selected item.
  4792. - driver : dr (bool) [query]
  4793. Returns list of available drivers for the attribute.
  4794. - driverValue : dv (float) [create]
  4795. Value of the driver to use for this keyframe. Default value is the current value.
  4796. - hierarchy : hi (unicode) [create]
  4797. Controls the objects this command acts on, relative to the specified (or active) target objects. Valid values are
  4798. above,below,both,and none.Default is hierarchy -query
  4799. - inTangentType : itt (unicode) [create]
  4800. The in tangent type for keyframes set by this command. Valid values are spline, linear, fast, slow, flat, stepped, step
  4801. next, fixed, clampedand plateau. Default is keyTangent -q -g -inTangentType
  4802. - insert : i (bool) [create]
  4803. Insert keys at the given time(s) and preserve the shape of the animation curve(s). Note: the tangent type on inserted
  4804. keys will be fixed so that the curve shape can be preserved.
  4805. - insertBlend : ib (bool) [create]
  4806. If true, a pairBlend node will be inserted for channels that have nodes other than animCurves driving them, so that such
  4807. channels can have blended animation. If false, these channels will not have keys inserted. If the flag is not specified,
  4808. the blend will be inserted based on the global preference for blending animation.
  4809. - outTangentType : ott (unicode) [create]
  4810. The out tangent type for keyframes set by this command. Valid values are spline, linear, fast, slow, flat, stepped, step
  4811. next, fixed, clampedand plateau. Default is keyTangent -q -g -outTangentType
  4812. - shape : s (bool) [create]
  4813. Consider attributes of shapes below transforms as well, except controlPoints. Default: true
  4814. - value : v (float) [create]
  4815. Value to set the keyframe at. Default is the current value. Flag can have multiple arguments,
  4816. passed either as a tuple or a list.
  4817. Derived from mel command `maya.cmds.setDrivenKeyframe`
  4818. """
  4819. pass
  4820. def setInfinity(*args, **kwargs):
  4821. """
  4822. Set the infinity type before (after) a paramCurve's first (last) keyframe. In query mode, return type is based on
  4823. queried flag.
  4824. Flags:
  4825. - attribute : at (unicode) [create]
  4826. List of attributes to select
  4827. - controlPoints : cp (bool) [create]
  4828. This flag explicitly specifies whether or not to include the control points of a shape (see -sflag) in the list of
  4829. attributes. Default: false. (Not valid for pasteKeycmd.)
  4830. - hierarchy : hi (unicode) [create]
  4831. Hierarchy expansion options. Valid values are above,below,both,and none.(Not valid for pasteKeycmd.)
  4832. - postInfinite : poi (unicode) [create,query]
  4833. Set the infinity type after a paramCurve's last keyframe. Valid values are constant, linear, cycle, cycleRelative,
  4834. oscillate. Flag can have multiple arguments, passed either as a tuple or a list.
  4835. - preInfinite : pri (unicode) [create,query]
  4836. Set the infinity type before a paramCurve's first keyframe. Valid values are constant, linear, cycle, cycleRelative,
  4837. oscillate.
  4838. - shape : s (bool) [create]
  4839. Consider attributes of shapes below transforms as well, except controlPoints. Default: true. (Not valid for
  4840. pasteKeycmd.)
  4841. Derived from mel command `maya.cmds.setInfinity`
  4842. """
  4843. pass
  4844. def setKeyPath(*args, **kwargs):
  4845. """
  4846. The setKeyPath command either creates or edits the path (a nurbs curve) based on the current position of the selected
  4847. object at the current time.
  4848. Derived from mel command `maya.cmds.setKeyPath`
  4849. """
  4850. pass
  4851. def setKeyframe(*args, **kwargs):
  4852. """
  4853. This command creates keyframes for the specified objects, or the active objects if none are specified on the command
  4854. line. The default time for the new keyframes is the current time. Override this behavior with the -tflag on the command
  4855. line. The default value for the keyframe is the current value of the attribute for which a keyframe is set. Override
  4856. this behavior with the -vflag on the command line. When setting keyframes on animation curves that do not have timeas an
  4857. input attribute (ie, they are unitless animation curves), use -f/-floatto specify the unitless value at which to set a
  4858. keyframe. The -time and -float flags may be combined in one command. This command sets up Dependency Graph relationships
  4859. for proper evaluation of a given attribute at a given time.
  4860. Flags:
  4861. - animLayer : al (unicode) [create]
  4862. Specifies that the new key should be placed in the specified animation layer. Note that if the objects being keyframed
  4863. are not already part of the layer, this flag will be ignored.
  4864. - attribute : at (unicode) [create]
  4865. Attribute name to set keyframes on.
  4866. - breakdown : bd (bool) [create,query,edit]
  4867. Sets the breakdown state for the key. Default is false
  4868. - clip : c (unicode) [create]
  4869. Specifies that the new key should be placed in the specified clip. Note that if the objects being keyframed are not
  4870. already part of the clip, this flag will be ignored.
  4871. - controlPoints : cp (bool) [create]
  4872. Explicitly specify whether or not to include the control points of a shape (see -sflag) in the list of attributes.
  4873. Default: false.
  4874. - dirtyDG : dd (bool) []
  4875. - float : f (float) [create]
  4876. Float time at which to set a keyframe on float-based animation curves.
  4877. - hierarchy : hi (unicode) [create]
  4878. Controls the objects this command acts on, relative to the specified (or active) target objects. Valid values are
  4879. above,below,both,and none.Default is hierarchy -query
  4880. - identity : id (bool) [create]
  4881. Sets an identity key on an animation layer. An identity key is one that nullifies the effect of the anim layer. This
  4882. flag has effect only when the attribute being keyed is being driven by animation layers. Flag can have
  4883. multiple arguments, passed either as a tuple or a list.
  4884. - inTangentType : itt (unicode) [create]
  4885. The in tangent type for keyframes set by this command. Valid values are spline, linear, fast, slow, flat, stepped, step
  4886. next, fixed, clampedand plateau. Default is keyTangent -q -g -inTangentType
  4887. - insert : i (bool) [create]
  4888. Insert keys at the given time(s) and preserve the shape of the animation curve(s). Note: the tangent type on inserted
  4889. keys will be fixed so that the curve shape can be preserved.
  4890. - insertBlend : ib (bool) [create]
  4891. If true, a pairBlend node will be inserted for channels that have nodes other than animCurves driving them, so that such
  4892. channels can have blended animation. If false, these channels will not have keys inserted. If the flag is not specified,
  4893. the blend will be inserted based on the global preference for blending animation.
  4894. - minimizeRotation : mr (bool) [create]
  4895. For rotations, ensures that the key that is set is a minimum distance away from the previous key. Default is false
  4896. - noResolve : nr (bool) []
  4897. - outTangentType : ott (unicode) [create]
  4898. The out tangent type for keyframes set by this command. Valid values are spline, linear, fast, slow, flat, stepped, step
  4899. next, fixed, clampedand plateau. Default is keyTangent -q -g -outTangentType
  4900. - shape : s (bool) [create]
  4901. Consider attributes of shapes below transforms as well, except controlPoints. Default: true
  4902. - time : t (time) [create]
  4903. Time at which to set a keyframe on time-based animation curves.
  4904. - useCurrentLockedWeights : lw (bool) []
  4905. - value : v (float) [create]
  4906. Value at which to set the keyframe. Using the value flag will not cause the keyed attribute to change to the specified
  4907. value until the scene re-evaluates. Therefore, if you want the attribute to update to the new value immediately, use the
  4908. setAttr command in addition to setting the key.
  4909. Derived from mel command `maya.cmds.setKeyframe`
  4910. """
  4911. pass
  4912. def setKeyframeBlendshapeTargetWts(*args, **kwargs):
  4913. """
  4914. This command can be used to keyframe per-point blendshape target weights. It operates on the currently selected objects
  4915. as follows. When the base object is selected, then the target weights are keyed for all targets. When only target shapes
  4916. are selected, then the weights for thoses targets are keyframed.
  4917. Derived from mel command `maya.cmds.setKeyframeBlendshapeTargetWts`
  4918. """
  4919. pass
  4920. def shot(*args, **kwargs):
  4921. """
  4922. Use this command to create a shot node or manipulate that node.
  4923. Flags:
  4924. - audio : aud (unicode) [create,query,edit]
  4925. Specify the audio clip for this shot. Audio can be linked to a shot to allow playback of specific sounds when that shot
  4926. is being displayed in the Sequencer. Refer to the shot node's documentation for details on how audio is used by shots
  4927. and the Sequencer.
  4928. - clip : cl (unicode) [create,query,edit]
  4929. The clip associated with this shot. This clip will be posted to the currentCamera's imagePlane. Refer to the shot
  4930. node's documentation for details on how cameras are used by shots and the Sequencer.
  4931. - clipDuration : cd (time) [create,query,edit]
  4932. Length of clip. This is used for the display of the clip indicator bar in the Sequencer.
  4933. - clipOpacity : co (float) [create,query,edit]
  4934. Opacity for the shot's clip, this value is assigned to the currentCamera's imagePlane. Refer to the shot node's
  4935. documentation for details on how cameras are used by shots and the Sequencer.
  4936. - clipSyncState : css (bool) [create,query,edit]
  4937. The viewport synchronization status of the clip associated with this shot. Return values are, 0 = no clip associated
  4938. with this shot 1 = clip is fully in sync with viewport, and frames are 1:1 with sequencer 2 = clip is partially in sync
  4939. with viewport, movie may be scaled to match sequencer 3 = clip not in sync with viewport (i.e. could have
  4940. scale/time/camera differences)
  4941. - clipZeroOffset : czo (time) [create,query,edit]
  4942. Specify which time of the clip corresponds to the beginning of the shot. This is used to properly align splitted clips.
  4943. - copy : c (bool) [create,query,edit]
  4944. This flag is used to copy a shot to the clipboard. In query mode, this flag allows you to query what, if anything, has
  4945. been copied into the shot clipboard.
  4946. - currentCamera : cc (unicode) [create,query,edit]
  4947. The camera associated with this shot. Refer to the shot node's documentation for details on how cameras are used by
  4948. shots and the Sequencer.
  4949. - determineTrack : dt (bool) [query,edit]
  4950. Determines an available track for the shot. Returns a new track number or the existing track number if the current
  4951. track is available. Flag can have multiple arguments, passed either as a tuple
  4952. or a list.
  4953. - endTime : et (time) [create,query,edit]
  4954. The shot end time in the Maya timeline. Changing the startTime will extend the duration of a shot.
  4955. - favorite : fav (bool) [create,query,edit]
  4956. Make the shot a favorite. This is a UI indicator only to streamline navigation in the Sequencer panel
  4957. - linkAudio : la (unicode) [create,query,edit]
  4958. Specify an audio clip to link to this shot. Any currently linked audio will be unlinked.
  4959. - lock : lck (bool) [create,query,edit]
  4960. Lock a specific shot. This is different than locking an entire track, which is done via the shotTrack command
  4961. - mute : m (bool) [create,query,edit]
  4962. Mute a specific shot. This is different than muting an entire track, which is done via the shotTrack command
  4963. - paste : p (bool) [create,query,edit]
  4964. This flag is used to paste a shot or shots from the clipboard to the sequence timeline. Shots are added to the clipboard
  4965. using the c/copy flag.
  4966. - pasteInstance : pi (bool) [create,query,edit]
  4967. This flag is used to paste an instance of a shot or shots from the clipboard to the sequence timeline. Unlike the
  4968. p/paste flag, which duplicates the camera and image plane from the original source shot, the pi/pasteInstance flag
  4969. shares the camera and image plane from the source shot. The audio node is duplicated.
  4970. - postHoldTime : pst (time) [create,query,edit]
  4971. Specify the time length to append to the shot in the sequence timeline. This repeats the last frame of the shot, in
  4972. sequence time, over the specified duration.
  4973. - preHoldTime : prt (time) [create,query,edit]
  4974. Specify the time length to prepend to the shot in the sequence timeline. This repeats the first frame of the shot, in
  4975. sequence time, over the specified duration.
  4976. - scale : s (float) [create,query,edit]
  4977. Specify an amount to scale the Maya frame range of the shot. This will affect the sequenceEndFrame, leaving the
  4978. sequenceStartFrame unchanged.
  4979. - sequenceDuration : sqd (time) [query,edit]
  4980. Return the sequence duration of the shot, which will include the holds and scale. This flag can only be queried.
  4981. - sequenceEndTime : set (time) [create,query,edit]
  4982. The shot end in the sequence timeline. Changing the endTime of a shot will scale it in sequence time.
  4983. - sequenceStartTime : sst (time) [create,query,edit]
  4984. The shot start in the sequence timeline. Changing the startTime of a shot will shift it in sequence time.
  4985. - shotName : sn (unicode) [create,query,edit]
  4986. Specify a user-defined name for this shot. This allows the assignment of names that are not valid as node names within
  4987. Maya. Whenever the shotName attribute is defined its value is used in the UI.
  4988. - sourceDuration : sd (time) [query,edit]
  4989. Return the number of source frames in the shot. This flag can only be queried.
  4990. - startTime : st (time) [create,query,edit]
  4991. The shot start time in the Maya timeline. Changing the startTime will extend the duration of a shot.
  4992. - track : trk (int) [query,edit]
  4993. Specify the track in which this shot resides.
  4994. - unlinkAudio : ula (bool) [query,edit]
  4995. COMMENT Unlinks any currently linked audio.
  4996. Derived from mel command `maya.cmds.shot`
  4997. """
  4998. pass
  4999. def shotRipple(*args, **kwargs):
  5000. """
  5001. When Ripple Edit Mode is enabled, neighboring shots to the shot that gets manipulated are moved in sequence time to
  5002. either make way or close up gaps corresponding to that node's editing. Given some parameters about the shot edit that
  5003. just took place, this command will choose which other shots to move, and move them the appropriate amounts If no shot
  5004. name is provided, the command will attempt to use the first selected shot. In query mode, return type is
  5005. based on queried flag.
  5006. Flags:
  5007. - deleted : d (bool) [create,query,edit]
  5008. Specify whether this ripple edit is due to a shot deletion Flag can have multiple
  5009. arguments, passed either as a tuple or a list.
  5010. - endDelta : ed (time) [create,query,edit]
  5011. Specify the change in the end time in frames
  5012. - endTime : et (time) [create,query,edit]
  5013. Specify the initial shot end time in the sequence timeline.
  5014. - startDelta : sd (time) [create,query,edit]
  5015. Specify the change in the start time in frames
  5016. - startTime : st (time) [create,query,edit]
  5017. Specify the initial shot start time in the sequence timeline.
  5018. Derived from mel command `maya.cmds.shotRipple`
  5019. """
  5020. pass
  5021. def simplify(*args, **kwargs):
  5022. """
  5023. This command operates on a keyset. A keyset is defined as a group of keys within a specified time range on one or more
  5024. animation curves. The animation curves comprising a keyset depend on the value of the -animationflag: keysOrObjects: Any
  5025. active keys, when no target objects or -attribute flags appear on the command line, orAll animation curves connected to
  5026. all keyframable attributes of objects specified as the command line's targetList, when there are no active keys.keys:
  5027. Only act on active keys or tangents. If there are no active keys or tangents, don't do anything. objects: Only act on
  5028. specified objects. If there are no objects specified, don't do anything. Note that the -animationflag can be used to
  5029. override the curves uniquely identified by the multi-use -attributeflag, which takes an argument of the form
  5030. attributeName, such as translateX. Keys on animation curves are identified by either their time values or their indices.
  5031. Times and indices can be given individually or as part of a list or range. -time 10palmeans the key at frame 10 (PAL
  5032. format).-time 1.0sec -time 15ntsc -time 20means the keys at time 1.0 second, frame 15 (in NTSC format), and time 20 (in
  5033. the currently defined global time unit).-time 10:20means all keys in the range from 10 to 20, inclusive, in the current
  5034. time unit.Omitting one end of a range means go to infinity, as in the following examples: -time 10:means all keys from
  5035. time 10 (in the current time unit) onwards.-time :10means all keys up to (and including) time 10 (in the current time
  5036. unit).-time :is a short form to specify all keys.-index 0means the first key of each animation curve. (Indices are
  5037. 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
  5038. of each animation curve.This command will simplify (reduce the number of keyframes) an animation curve.
  5039. Flags:
  5040. - animation : an (unicode) [create]
  5041. Where this command should get the animation to act on. Valid values are objects,keys,and keysOrObjectsDefault:
  5042. keysOrObjects.(See Description for details.)
  5043. - attribute : at (unicode) [create]
  5044. List of attributes to select
  5045. - controlPoints : cp (bool) [create]
  5046. This flag explicitly specifies whether or not to include the control points of a shape (see -sflag) in the list of
  5047. attributes. Default: false. (Not valid for pasteKeycmd.)
  5048. - float : f (floatrange) [create]
  5049. value uniquely representing a non-time-based key (or key range) on a time-based animCurve. Valid floatRange include
  5050. single values (-f 10) or a string with a lower and upper bound, separated by a colon (-f 10:20
  5051. - floatTolerance : ft (float) [create]
  5052. Specify the x-axis tolerance (defaults to 0.05) for float-input animCurves such as those created by Set Driven Keyframe.
  5053. This flag is ignored on animCurves driven by time. Higher floatTolerance values will result in sparser keys which may
  5054. less accurately represent the initial curve.
  5055. - hierarchy : hi (unicode) [create]
  5056. Hierarchy expansion options. Valid values are above,below,both,and none.(Not valid for pasteKeycmd.)
  5057. - includeUpperBound : iub (bool) [create]
  5058. When the -t/time or -f/float flags represent a range of keys, this flag determines whether the keys at the upper bound
  5059. of the range are included in the keyset. Default value: true. This flag is only valid when the argument to the -t/time
  5060. flag is a time range with a lower and upper bound. (When used with the pasteKeycommand, this flag refers only to the
  5061. time range of the target curve that is replaced, when using options such as replace,fitReplace,or scaleReplace.This flag
  5062. has no effect on the curve pasted from the clipboard.)
  5063. - index : index (int) [create]
  5064. index of a key on an animCurve
  5065. - shape : s (bool) [create]
  5066. Consider attributes of shapes below transforms as well, except controlPoints. Default: true. (Not valid for
  5067. pasteKeycmd.)
  5068. - time : t (timerange) [create]
  5069. time uniquely representing a key (or key range) on a time-based animCurve. Valid timeRanges include single values (-t
  5070. 10) or a string with a lower and upper bound, separated by a colon (-t 10:20
  5071. - timeTolerance : tt (time) [create]
  5072. Specify the x-axis tolerance (defaults to 0.05 seconds) for time-input animCurves. This flag is ignored on animCurves
  5073. driven by floats. Higher time tolerance values will result in sparser keys which may less accurately represent the
  5074. initial curve.
  5075. - valueTolerance : vt (float) [create]
  5076. Specify the value tolerance (defaults to 0.01) Flag can have multiple arguments, passed either as a
  5077. tuple or a list.
  5078. Derived from mel command `maya.cmds.simplify`
  5079. """
  5080. pass
  5081. def skinCluster(*args, **kwargs):
  5082. """
  5083. The skinCluster command is used for smooth skinning in maya. It binds the selected geometry to the selected joints or
  5084. skeleton by means of a skinCluster node. Each point of the bound geometry can be affected by any number of joints. The
  5085. extent to which each joint affects the motion of each point is regulated by a corresponding weight factor. Weight
  5086. factors can be modified using the skinPercent command. The command returns the name of the new skinCluster.The
  5087. skinCluster binds only a single geometry at a time. Thus, to bind multiple geometries, multiple skinCluster commands
  5088. must be issued.Upon creation of a new skinCluster, the command can be used to add and remove transforms (not necessarily
  5089. joints) that influence the motion of the bound skin points. The skinCluster command can also be used to adjust
  5090. parameters such as the dropoff, nurbs samples, polygon smoothness on a particular influence object. Note: Any custom
  5091. weights on a skin point that the influence object affects will be lost after adjusting these parameters.
  5092. Modifications:
  5093. - returns a list of PyNode objects for flags: (query and (geometry or deformerTools or influence or weightedInfluence))
  5094. Flags:
  5095. - addInfluence : ai (unicode) [edit]
  5096. The specified transform or joint will be added to the list of transforms that influence the bound geometry. The maximum
  5097. number of influences will be observed and only the weights of the cv's that the specified transform effects will change.
  5098. This flag is multi-use.
  5099. - addToSelection : ats (bool) [edit]
  5100. When used in conjunction with the selectInfluenceVerts flag, causes the vertices afftected by the influence to be added
  5101. to the current selection, without first de-selecting other vertices.
  5102. - after : af (bool) [create,edit]
  5103. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  5104. flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape
  5105. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  5106. - afterReference : ar (bool) [edit]
  5107. - baseShape : bsh (unicode) [edit]
  5108. This flag can be used in conjunction with the -addInfluence flag to specify the shape that will be used as the base
  5109. shape when an influence object with geometry is added to the skinCluster. If the flag is not used then the command will
  5110. make a copy of the influence object's shape and use that as a base shape.
  5111. - before : bf (bool) [create,edit]
  5112. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  5113. flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape
  5114. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  5115. - deformerTools : dt (bool) [query]
  5116. Returns the name of the deformer tool objects (if any) as string string ...
  5117. - dropoffRate : dr (float) [create,query,edit]
  5118. Sets the rate at which the influence of a transform drops as the distance from that transform increases. The valid range
  5119. is between 0.1 and 10.0. In Create mode it sets the dropoff rate for all the bound joints. In Edit mode the flag is
  5120. used together with the inf/influence flag to set the dropoff rate of a particular influence. Note: When the flag is
  5121. used in Edit mode, any custom weights on the skin points the given transform influences will be lost.
  5122. - exclusive : ex (unicode) [create,query]
  5123. Puts the deformation set in a deform partition.
  5124. - forceNormalizeWeights : fnw (bool) [edit]
  5125. If the normalization mode is none or post, it is possible (indeed likely) for the weights in the skin cluster to no
  5126. longer add up to 1. This flag forces all weights to add back to 1 again.
  5127. - frontOfChain : foc (bool) [create,edit]
  5128. This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and
  5129. skin nodes in the shape's history (but not ahead of existing tweak nodes). The input to the deformer will be the
  5130. upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the
  5131. downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and
  5132. edit mode if the deformer has no geometry added yet).
  5133. - geometry : g (unicode) [query,edit]
  5134. The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is
  5135. also specified. When queried, this flag returns string string string ...
  5136. - geometryIndices : gi (bool) [query]
  5137. - ignoreBindPose : ibp (bool) [create,edit]
  5138. This flag is deprecated and no longer used. It will be ignored if used.
  5139. - ignoreHierarchy : ih (bool) [create,edit]
  5140. Disregard the place of the joints in the skeleton hierarchy when computing the closest joints that influence a point of
  5141. the geometry.
  5142. - ignoreSelected : ignoreSelected (bool) [create]
  5143. Tells the command to not deform objects on the current selection list
  5144. - influence : inf (unicode) [query,edit]
  5145. This flag specifies the influence object that will be used for the current edit operation. In query mode, returns a
  5146. string array of the influence objects (joints and transform). In query mode, this flag can accept a value.
  5147. - lockWeights : lw (bool) [query,edit]
  5148. Lock the weights of the specified influence object to their current value or to the value specified by the -weight flag.
  5149. - maximumInfluences : mi (int) [create,query,edit]
  5150. Sets the maximum number of transforms that can influence a point (have non-zero weight for the point) when the
  5151. skinCluster is first created or a new influence is added. Note: When this flag is used in Edit mode any custom weights
  5152. will be lost and new weights will be reassigned to the whole skin.
  5153. - moveJointsMode : mjm (bool) [edit]
  5154. If set to true, puts the skin into a mode where joints can be moved without modifying the skinning. If set to false,
  5155. takes the skin out of move joints mode.
  5156. - name : n (unicode) [create]
  5157. Used to specify the name of the node being created
  5158. - normalizeWeights : nw (int) [create,query,edit]
  5159. This flag set the normalization mode. 0 - none, 2 - interactive, 3 - post (default) Interactive normalization makes sure
  5160. the weights on the influences add up to 1.0, always. Everytime a weight is changed, the weights are automatically
  5161. normalized. This may make it difficult to perform weighting operations, as the normalization may interfere with the
  5162. weights the user has set. Post normalization leaves the weights the user has set as is, and only normalizes the weights
  5163. at the moment it is needed (by dividing by the sum of the weights). This makes it easier for users to weight their
  5164. skins.
  5165. - nurbsSamples : ns (int) [create,edit]
  5166. Sets the number of sample points that will be used along an influence curve or in each direction on an influence NURBS
  5167. surface to influence the bound skin. The more the sample points the more closely the skin follows the influence NURBS
  5168. curve/surface.
  5169. - obeyMaxInfluences : omi (bool) [create,query,edit]
  5170. When true, the skinCluster will continue to enforce the maximum influences each time the user modifies the weight, so
  5171. that any given point is only weighted by the number of influences in the skinCluster's maximumInfluences attribute.
  5172. - parallel : par (bool) [create,edit]
  5173. Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is
  5174. inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry
  5175. added yet).
  5176. - polySmoothness : ps (float) [create,edit]
  5177. This flag controls how accurately the skin control points follow a given polygon influence object. The higher the value
  5178. of polySmoothnmess the more rounded the deformation resulting from a polygonal influence object will be.
  5179. - prune : pr (bool) [edit]
  5180. Removes any points not being deformed by the deformer in its current configuration from the deformer set.
  5181. - remove : rm (bool) [edit]
  5182. Specifies that objects listed after the -g flag should be removed from this deformer.
  5183. - removeFromSelection : rfs (bool) [edit]
  5184. When used in conjunction with the selectInfluenceVerts flag, causes the vertices afftected by the influence to be
  5185. removed from the current selection.
  5186. - removeInfluence : ri (unicode) [edit]
  5187. Remove the specified transform or joint from the list of transforms that influence the bound geometry The weights for
  5188. the affected points are renormalized. This flag is multi-use.
  5189. - removeUnusedInfluence : rui (bool) [create]
  5190. If this flag is set to true then transform or joint whose weights are all zero (they have no effect) will not be bound
  5191. to the geometry. Having this option set will help speed-up the playback of animation.
  5192. - selectInfluenceVerts : siv (unicode) [edit]
  5193. Given the name of a transform, this will select the verts or control points being influenced by this transform, so users
  5194. may visualize which vertices are being influenced by the transform.
  5195. - skinMethod : sm (int) [create,query,edit]
  5196. This flag set the skinning method. 0 - classical linear skinning (default). 1 - dual quaternion (volume preserving), 2 -
  5197. a weighted blend between the two.
  5198. - smoothWeights : sw (float) [edit]
  5199. This flag is used to detect sudden jumps in skin weight values, which often indicates bad weighting, and then smooth out
  5200. those jaggies in skin weights. The argument is the error tolerance ranging from 0 to 1. A value of 1 means that the
  5201. algorithm will smooth a vertex only if there is a 100% change in weight values from its neighbors. The recommended
  5202. default to use is 0.5 (50% change in weight value from the neighbors).
  5203. - smoothWeightsMaxIterations : swi (int) [edit]
  5204. This flag is valid only with the smooth weights flag. It is possible that not all the vertices detected as needing
  5205. smoothing can be smoothed in 1 iteration (because all of their neighbors also have bad weighting and need to be
  5206. smoothed). With more iterations, more vertices can be smoothed. This flag controls the maximum number of iterations the
  5207. algorithm will attempt to smooth weights. The default is 2 for this flag.
  5208. - split : sp (bool) [create,edit]
  5209. Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing
  5210. chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
  5211. - toSelectedBones : tsb (bool) [create]
  5212. geometry will be bound to the selected bones only.
  5213. - toSkeletonAndTransforms : tst (bool) [create]
  5214. geometry will be bound to the skeleton and any transforms in the hierarchy
  5215. - unbind : ub (bool) [edit]
  5216. Unbinds the geometry from the skinCluster and deletes the skinCluster node
  5217. - unbindKeepHistory : ubk (bool) [edit]
  5218. Unbinds the geometry from the skinCluster, but keeps the skinCluster node so that its weights can be used when the skin
  5219. is rebound. To rebind, use the skinCluster command.
  5220. - useGeometry : ug (bool) [edit]
  5221. When adding an influence to a skinCluster, use the geometry parented under the influence transform to determine the
  5222. weight dropoff of that influence.
  5223. - volumeBind : vb (float) [create]
  5224. Creates a volume bind node and attaches it to the new skin cluster node. This node holds hull geometry parameters for a
  5225. volume based weighting system. This system is used in interactive skinning. The value passed will determine the minimum
  5226. weight value when initializing the volume. The volume in be increase to enclose all the vertices that are above this
  5227. value.
  5228. - volumeType : vt (int) [create]
  5229. Defines the initial shape of the binding volume (see volumeBind). 0 - Default (currently set to a capsule) 1 - Capsule,
  5230. 2 - Cylinder. Flag can have multiple arguments, passed either as a tuple or a list.
  5231. - weight : wt (float) [edit]
  5232. This flag is only valid in conjunction with the -addInfluence flag. It sets the weight for the influence object that is
  5233. being added.
  5234. - weightedInfluence : wi (bool) [query]
  5235. This flag returns a string array of the influence objects (joints and transform) that have non-zero weighting.
  5236. Derived from mel command `maya.cmds.skinCluster`
  5237. """
  5238. pass
  5239. def skinPercent(*args, **kwargs):
  5240. """
  5241. This command edits and queries the weight values on members of a skinCluster node, given as the first argument. If no
  5242. object components are explicitly mentioned in the command line, the current selection list is used. Note that setting
  5243. multiple weights in a single invocation of this command is far more efficient than calling it once per weighted vertex.
  5244. In query mode, return type is based on queried flag.
  5245. Flags:
  5246. - ignoreBelow : ib (float) [query]
  5247. Limits the output of the -value and -transform queries to the entries whose weight values are over the specified limit.
  5248. This flag has to be used before the -query flag.
  5249. - normalize : nrm (bool) [create]
  5250. If set, the weights not assigned by the -transformValue flag are normalized so that the sum of the all weights for the
  5251. selected object component add up to 1. The default is on. NOTE: The skinCluster has a normalizeWeights attribute which
  5252. when set to OFF overrides this attribute! If the skinCluster.normalizeWeights attribute is OFF, you must set it to
  5253. Interactive in order to normalize weights using the skinPercent command.
  5254. - pruneWeights : prw (float) [create]
  5255. Sets to zero any weight smaller than the given value for all the selected components. To use this command to set all the
  5256. weights to zero, you must turn the -normalize flag offor the skinCluster node will normalize the weights to sum to one
  5257. after pruning them. Weights for influences with a true value on their Hold Weightsattribute will not be pruned.
  5258. Flag can have multiple arguments, passed either as a tuple or a list.
  5259. - relative : r (bool) [create]
  5260. Used with -transformValue to specify a relative setting of values. If -relative is true, the value passed to -tv is
  5261. added to the previous value. Otherwise, it replaces the previous value.
  5262. - resetToDefault : rtd (bool) [create]
  5263. Sets the weights of the selected components to their default values, overwriting any custom weights.
  5264. - transform : t (unicode) [query]
  5265. If used after the -query flag (without an argument) the command returns an array of strings corresponding to the names
  5266. of the transforms influencing the selected object components. If used before the -query flag (with a transform name),
  5267. the command returns the weight of the selected object component corresponding to the given transform. The command will
  5268. return an average weight if several components have been selected. In query mode, this flag can accept a value.
  5269. - transformMoveWeights : tmw (unicode) []
  5270. - transformValue : tv (unicode, float) [create]
  5271. Accepts a pair consisting of a transform name and a value and assigns that value as the weight of the selected object
  5272. components corresponding to the given transform.
  5273. - value : v (bool) [query]
  5274. Returns an array of doubles corresponding to the joint weights for the selected object component.
  5275. - zeroRemainingInfluences : zri (bool) [create]
  5276. If set, the weights not assigned by the -transformValue flag are set to 0. The default is off.
  5277. Derived from mel command `maya.cmds.skinPercent`
  5278. """
  5279. pass
  5280. def snapKey(*args, **kwargs):
  5281. """
  5282. This command operates on a keyset. A keyset is defined as a group of keys within a specified time range on one or more
  5283. animation curves. The animation curves comprising a keyset depend on the value of the -animationflag: keysOrObjects: Any
  5284. active keys, when no target objects or -attribute flags appear on the command line, orAll animation curves connected to
  5285. all keyframable attributes of objects specified as the command line's targetList, when there are no active keys.keys:
  5286. Only act on active keys or tangents. If there are no active keys or tangents, don't do anything. objects: Only act on
  5287. specified objects. If there are no objects specified, don't do anything. Note that the -animationflag can be used to
  5288. override the curves uniquely identified by the multi-use -attributeflag, which takes an argument of the form
  5289. attributeName, such as translateX. Keys on animation curves are identified by either their time values or their indices.
  5290. Times and indices can be given individually or as part of a list or range. -time 10palmeans the key at frame 10 (PAL
  5291. format).-time 1.0sec -time 15ntsc -time 20means the keys at time 1.0 second, frame 15 (in NTSC format), and time 20 (in
  5292. the currently defined global time unit).-time 10:20means all keys in the range from 10 to 20, inclusive, in the current
  5293. time unit.Omitting one end of a range means go to infinity, as in the following examples: -time 10:means all keys from
  5294. time 10 (in the current time unit) onwards.-time :10means all keys up to (and including) time 10 (in the current time
  5295. unit).-time :is a short form to specify all keys.-index 0means the first key of each animation curve. (Indices are
  5296. 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
  5297. of each animation curve.This command snapsall target key times and/or values so that they have times and/or values that
  5298. are multiples of the specified flag arguments. If neither multiple is specified, default is time snapping with a
  5299. multiple of 1.0. Note that this command will fail to move keys over other neighboring keys: a key's index will not
  5300. change as a result of a snapKey operation.TbaseKeySetCmd.h
  5301. Flags:
  5302. - animation : an (unicode) [create]
  5303. Where this command should get the animation to act on. Valid values are objects,keys,and keysOrObjectsDefault:
  5304. keysOrObjects.(See Description for details.)
  5305. - attribute : at (unicode) [create]
  5306. List of attributes to select
  5307. - controlPoints : cp (bool) [create]
  5308. This flag explicitly specifies whether or not to include the control points of a shape (see -sflag) in the list of
  5309. attributes. Default: false. (Not valid for pasteKeycmd.)
  5310. - float : f (floatrange) [create]
  5311. value uniquely representing a non-time-based key (or key range) on a time-based animCurve. Valid floatRange include
  5312. single values (-f 10) or a string with a lower and upper bound, separated by a colon (-f 10:20
  5313. - hierarchy : hi (unicode) [create]
  5314. Hierarchy expansion options. Valid values are above,below,both,and none.(Not valid for pasteKeycmd.)
  5315. - includeUpperBound : iub (bool) [create]
  5316. When the -t/time or -f/float flags represent a range of keys, this flag determines whether the keys at the upper bound
  5317. of the range are included in the keyset. Default value: true. This flag is only valid when the argument to the -t/time
  5318. flag is a time range with a lower and upper bound. (When used with the pasteKeycommand, this flag refers only to the
  5319. time range of the target curve that is replaced, when using options such as replace,fitReplace,or scaleReplace.This flag
  5320. has no effect on the curve pasted from the clipboard.)
  5321. - index : index (int) [create]
  5322. index of a key on an animCurve
  5323. - shape : s (bool) [create]
  5324. Consider attributes of shapes below transforms as well, except controlPoints. Default: true. (Not valid for
  5325. pasteKeycmd.)
  5326. - time : t (timerange) [create]
  5327. time uniquely representing a key (or key range) on a time-based animCurve. Valid timeRanges include single values (-t
  5328. 10) or a string with a lower and upper bound, separated by a colon (-t 10:20
  5329. - timeMultiple : tm (float) [create]
  5330. If this flag is present, key times will be snapped to a multiple of the specified float value.
  5331. - valueMultiple : vm (float) [create]
  5332. If this flag is present, key values will be snapped to a multiple of the specified float value. Flag
  5333. can have multiple arguments, passed either as a tuple or a list.
  5334. Derived from mel command `maya.cmds.snapKey`
  5335. """
  5336. pass
  5337. def snapshot(*args, **kwargs):
  5338. """
  5339. This command can be used to create either a series of surfaces evaluated at the times specified by the command flags, or
  5340. a motion trail displaying the trajectory of the object's pivot point at the times specified.If the constructionHistory
  5341. flag is true, the output shapes or motion trail will re-update when modifications are made to the animation or
  5342. construction history of the original shape. When construction history is used, the forceUpdate flag can be set to false
  5343. to control when the snapshot recomputes, which will typically improve performance.
  5344. Flags:
  5345. - constructionHistory : ch (bool) [create,query]
  5346. update with changes to original geometry
  5347. - endTime : et (time) [create,query,edit]
  5348. time to stop copying target geometry Default: 10.0
  5349. - increment : i (time) [create,query,edit]
  5350. time increment between copies Default: 1.0
  5351. - motionTrail : mt (bool) [create]
  5352. Rather than create a series of surfaces, create a motion trail displaying the location of the object's pivot point at
  5353. the specified time steps. Default is false. Flag can have multiple arguments, passed either as a
  5354. tuple or a list.
  5355. - name : n (unicode) [create,query,edit]
  5356. the name of the snapshot node. Query returns string.
  5357. - startTime : st (time) [create,query,edit]
  5358. time to begin copying target geometry Default: 1.0
  5359. - update : u (unicode) [create,query,edit]
  5360. This flag can only be used if the snapshot has constructionHistory. It sets the snapshot node's update value. The update
  5361. value controls whether the snapshot updates on demand (most efficient), when keyframes change (efficient), or whenever
  5362. any history changes (least efficient). Valid values are demand, animCurve, always. Default: always
  5363. Derived from mel command `maya.cmds.snapshot`
  5364. """
  5365. pass
  5366. def softMod(*args, **kwargs):
  5367. """
  5368. The softMod command creates a softMod or edits the membership of an existing softMod. The command returns the name of
  5369. the softMod node upon creation of a new softMod.
  5370. Flags:
  5371. - after : af (bool) [create,edit]
  5372. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  5373. flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape
  5374. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  5375. - afterReference : ar (bool) [edit]
  5376. - before : bf (bool) [create,edit]
  5377. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  5378. flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape
  5379. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  5380. - bindState : bs (bool) [create]
  5381. Specifying this flag adds in a compensation to ensure the softModed objects preserve their spatial position when
  5382. softModed. This is required to prevent the geometry from jumping at the time the softMod is created in situations when
  5383. the softMod transforms at softMod time are not identity.
  5384. - curveInterpolation : ci (int) [create]
  5385. Ramp interpolation corresponding to the specified curvePoint position. Integer values of 0-3 are valid, corresponding to
  5386. none, linear, smoothand splinerespectively. This flag may only be used in conjunction with the curvePoint and curveValue
  5387. flag. Flag can have multiple arguments, passed either as a tuple or a list.
  5388. - curvePoint : cp (float) [create]
  5389. Position of ramp value on normalized 0-1 scale. This flag may only be used in conjunction with the curveInterpolation
  5390. and curveValue flags.
  5391. - curveValue : cv (float) [create]
  5392. Ramp value corresponding to the specified curvePoint position. This flag may only be used in conjunction with the
  5393. curveInterpolation and curvePoint flags.
  5394. - deformerTools : dt (bool) [query]
  5395. Returns the name of the deformer tool objects (if any) as string string ...
  5396. - envelope : en (float) [create,query,edit]
  5397. Set the envelope value for the deformer. Default is 1.0
  5398. - exclusive : ex (unicode) [create,query]
  5399. Puts the deformation set in a deform partition.
  5400. - falloffAroundSelection : fas (bool) [create]
  5401. Falloff will be calculated around any selected components
  5402. - falloffBasedOnX : fbx (bool) [create]
  5403. Falloff will be calculated using the X component.
  5404. - falloffBasedOnY : fby (bool) [create]
  5405. Falloff will be calculated using the Y component.
  5406. - falloffBasedOnZ : fbz (bool) [create]
  5407. Falloff will be calculated using the Z component.
  5408. - falloffCenter : fc (float, float, float) [create]
  5409. Set the falloff center point of the softMod.
  5410. - falloffMasking : fm (bool) [create]
  5411. Deformation will be restricted to selected components
  5412. - falloffMode : fom (int) [create]
  5413. Set the falloff method used for the softMod.
  5414. - falloffRadius : fr (float) [create]
  5415. Set the falloff radius of the softMod.
  5416. - frontOfChain : foc (bool) [create,edit]
  5417. This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and
  5418. skin nodes in the shape's history (but not ahead of existing tweak nodes). The input to the deformer will be the
  5419. upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the
  5420. downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and
  5421. edit mode if the deformer has no geometry added yet).
  5422. - geometry : g (unicode) [query,edit]
  5423. The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is
  5424. also specified. When queried, this flag returns string string string ...
  5425. - geometryIndices : gi (bool) [query]
  5426. - ignoreSelected : ignoreSelected (bool) [create]
  5427. Tells the command to not deform objects on the current selection list
  5428. - name : n (unicode) [create]
  5429. Used to specify the name of the node being created
  5430. - parallel : par (bool) [create,edit]
  5431. Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is
  5432. inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry
  5433. added yet).
  5434. - prune : pr (bool) [edit]
  5435. Removes any points not being deformed by the deformer in its current configuration from the deformer set.
  5436. - relative : rel (bool) [create]
  5437. Enable relative mode for the softMod. In relative mode, Only the transformations directly above the softMod are used by
  5438. the softMod. Default is off.
  5439. - remove : rm (bool) [edit]
  5440. Specifies that objects listed after the -g flag should be removed from this deformer.
  5441. - resetGeometry : rg (bool) [edit]
  5442. Reset the geometry matrices for the objects being deformed by the softMod. This flag is used to get rid of undesirable
  5443. effects that happen if you scale an object that is deformed by a softMod.
  5444. - split : sp (bool) [create,edit]
  5445. Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing
  5446. chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
  5447. - weightedNode : wn (unicode, unicode) [create,query,edit]
  5448. Transform node in the DAG above the softMod to which all percents are applied. The second node specifies the descendent
  5449. of the first node from where the transformation matrix is evaluated. Default is the softMod handle.
  5450. Derived from mel command `maya.cmds.softMod`
  5451. """
  5452. pass
  5453. def sound(*args, **kwargs):
  5454. """
  5455. Creates an audio node which can be used with UI commands such as soundControl or timeControl which support sound
  5456. scrubbing and sound during playback.
  5457. Flags:
  5458. - endTime : et (time) [create,query,edit]
  5459. Time at which to end the sound.
  5460. - file : f (unicode) [create,query,edit]
  5461. Name of sound file.
  5462. - length : l (bool) [query]
  5463. The length (in the current time unit) of the sound.
  5464. - mute : m (bool) [create,query,edit]
  5465. Mute the audio clip. Flag can have multiple arguments, passed either as a tuple or a list.
  5466. - name : n (unicode) [create,query,edit]
  5467. Name to give the resulting audio node.
  5468. - offset : o (time) [create,query,edit]
  5469. Time at which to start the sound.
  5470. - sourceEnd : se (time) [create,query,edit]
  5471. Time offset from the start of the sound file at which to end the sound.
  5472. - sourceStart : ss (time) [create,query,edit]
  5473. Time offset from the start of the sound file at which to start the sound.
  5474. Derived from mel command `maya.cmds.sound`
  5475. """
  5476. pass
  5477. def substituteGeometry(*args, **kwargs):
  5478. """
  5479. This command can be used to replace the geometry which is already connected to deformers with a new geometry. The
  5480. weights on the old geometry will be retargeted to the new geometry.
  5481. Flags:
  5482. - disableNonSkinDeformers : dnd (bool) [create]
  5483. This flag controls the state of deformers other than skin deformers after the substitution has taken place. If the flag
  5484. is true then non-skin deformer nodes are left in a disabled state at the completion of the command. Default value is
  5485. false.
  5486. - newGeometryToLayer : ngl (bool) [create]
  5487. Create a new layer for the new geometry.
  5488. - oldGeometryToLayer : ogl (bool) [create]
  5489. Create a new layer and move the old geometry to this layer
  5490. - reWeightDistTolerance : wdt (float) [create]
  5491. Specify the distance tolerance value to be used for retargeting weights. While transferring weights the command tries to
  5492. find the corresponding vertices by overlapping the geometries with all deformers disabled. Sometimes this results in
  5493. selection of unrelated vertices. (Example when a hole in the old geometry has been filled with new vertices in the new
  5494. geometry.) This distance tolerance value is used to detect this kind of faults and either ignore these cases or to vary
  5495. algorithm to find more corresponding vertices. Flag can have multiple arguments,
  5496. passed either as a tuple or a list.
  5497. - retainOldGeometry : rog (bool) [create]
  5498. A copy of the old geometry should be retained
  5499. Derived from mel command `maya.cmds.substituteGeometry`
  5500. """
  5501. pass
  5502. def tangentConstraint(*args, **kwargs):
  5503. """
  5504. Constrain an object's orientation based on the tangent of the target curve[s] at the closest point[s] to the object. A
  5505. tangentConstraint takes as input one or more NURBS curves (the targets) and a DAG transform node (the object). The
  5506. tangentConstraint orients the constrained object such that the aimVector (in the object's local coordinate system)
  5507. aligns in world space to combined tangent vector. The upVector (again the the object's local coordinate system) is
  5508. aligned in world space with the worldUpVector. The combined tangent vector is a weighted average of the tangent vector
  5509. for each target curve at the point closest to the constrained object.
  5510. Maya Bug Fix:
  5511. - when queried, angle offsets would be returned in radians, not current angle unit
  5512. Modifications:
  5513. - added new syntax for querying the weight of a target object, by passing the constraint first::
  5514. aimConstraint( 'pCube1_aimConstraint1', q=1, weight ='pSphere1' )
  5515. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =['pSphere1', 'pCylinder1'] )
  5516. aimConstraint( 'pCube1_aimConstraint1', q=1, weight =[] )
  5517. Flags:
  5518. - aimVector : aim (float, float, float) [create,query,edit]
  5519. Set the aim vector. This is the vector in local coordinates that points at the target. If not given at creation time,
  5520. the default value of (1.0, 0.0, 0.0) is used.
  5521. - layer : l (unicode) [create,edit]
  5522. Specify the name of the animation layer where the constraint should be added.
  5523. - name : n (unicode) [create,query,edit]
  5524. Sets the name of the constraint node to the specified name. Default name is constrainedObjectName_constraintType
  5525. - remove : rm (bool) [edit]
  5526. removes the listed target(s) from the constraint.
  5527. - targetList : tl (bool) [query]
  5528. Return the list of target objects.
  5529. - upVector : u (float, float, float) [create,query,edit]
  5530. Set local up vector. This is the vector in local coordinates that aligns with the world up vector. If not given at
  5531. creation time, the default value of (0.0, 1.0, 0.0) is used.
  5532. - weight : w (float) [create,query,edit]
  5533. Sets the weight value for the specified target(s). If not given at creation time, the default value of 1.0 is used.
  5534. - weightAliasList : wal (bool) [query]
  5535. Returns the names of the attributes that control the weight of the target objects. Aliases are returned in the same
  5536. order as the targets are returned by the targetList flag
  5537. - worldUpObject : wuo (PyNode) [create,query,edit]
  5538. Set the DAG object use for worldUpType objectand objectrotation. See worldUpType for greater detail. The default value
  5539. is no up object, which is interpreted as world space.
  5540. - worldUpType : wut (unicode) [create,query,edit]
  5541. Set the type of the world up vector computation. The worldUpType can have one of 5 values: scene, object,
  5542. objectrotation, vector, or none. If the value is scene, the upVector is aligned with the up axis of the scene and
  5543. worldUpVector and worldUpObject are ignored. If the value is object, the upVector is aimed as closely as possible to the
  5544. origin of the space of the worldUpObject and the worldUpVector is ignored. If the value is objectrotationthen the
  5545. worldUpVector is interpreted as being in the coordinate space of the worldUpObject, transformed into world space and the
  5546. upVector is aligned as closely as possible to the result. If the value is vector, the upVector is aligned with
  5547. worldUpVector as closely as possible and worldUpMatrix is ignored. Finally, if the value is noneno twist calculation is
  5548. performed by the constraint, with the resulting upVectororientation based previous orientation of the constrained
  5549. object, and the great circlerotation needed to align the aim vector with its constraint. The default worldUpType is
  5550. vector. Flag can have multiple arguments, passed either as a tuple or a list.
  5551. - worldUpVector : wu (float, float, float) [create,query,edit]
  5552. Set world up vector. This is the vector in world coordinates that up vector should align with. See -wut/worldUpType
  5553. (below)for greater detail. If not given at creation time, the default value of (0.0, 1.0, 0.0) is used.
  5554. Derived from mel command `maya.cmds.tangentConstraint`
  5555. """
  5556. pass
  5557. def volumeBind(*args, **kwargs):
  5558. """
  5559. Command for creating and editing volume binding nodes. The node is use for storing volume data to define skin weighting
  5560. data.
  5561. Flags:
  5562. - influence : inf (bool) [query,edit]
  5563. Edit or Query the list of influences connected to the skin cluster. Flag can have multiple
  5564. arguments, passed either as a tuple or a list.
  5565. - name : n (unicode) []
  5566. Derived from mel command `maya.cmds.volumeBind`
  5567. """
  5568. pass
  5569. def wire(*args, **kwargs):
  5570. """
  5571. This command creates a wire deformer. In the create mode the selection list is treated as the object(s) to be deformed,
  5572. Wires are specified with the -w flag. Each wire can optionally have a holder which helps define the the regon of the
  5573. object that is affected by the deformer.
  5574. Flags:
  5575. - after : af (bool) [create,edit]
  5576. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  5577. flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape
  5578. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  5579. - afterReference : ar (bool) []
  5580. - before : bf (bool) [create,edit]
  5581. If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this
  5582. flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape
  5583. has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
  5584. - crossingEffect : ce (float) [create,query,edit]
  5585. Set the amount of convolution effect. Varies from fully convolved at 0 to a simple additive effect at 1 (which is what
  5586. you get with the filter off). Default is 0. This filter should make its way into all blend nodes that deal with
  5587. combining effects from multiple sources.
  5588. - deformerTools : dt (bool) [query]
  5589. Returns the name of the deformer tool objects (if any) as string string ...
  5590. - dropoffDistance : dds (int, float) [create,query,edit]
  5591. Set the dropoff distance (second parameter) for the wire at index (first parameter).
  5592. - envelope : en (float) [create,query,edit]
  5593. Set the envelope value for the deformer. Default is 1.0
  5594. - exclusive : ex (unicode) [create,query]
  5595. Puts the deformation set in a deform partition.
  5596. - frontOfChain : foc (bool) [create,edit]
  5597. This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and
  5598. skin nodes in the shape's history (but not ahead of existing tweak nodes). The input to the deformer will be the
  5599. upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the
  5600. downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and
  5601. edit mode if the deformer has no geometry added yet).
  5602. - geometry : g (unicode) [query,edit]
  5603. The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is
  5604. also specified. When queried, this flag returns string string string ...
  5605. - geometryIndices : gi (bool) []
  5606. - groupWithBase : gw (bool) [create]
  5607. Groups the wire with the base wire so that they can easily be moved together to create a ripple effect. Default is
  5608. false. Flag can have multiple arguments, passed either as a tuple or a list.
  5609. - holder : ho (int, unicode) [create,query,edit]
  5610. Set the specified curve or surface (second parameter as a holder for the wire at index (first parameter).
  5611. - ignoreSelected : ignoreSelected (bool) [create]
  5612. Tells the command to not deform objects on the current selection list
  5613. - localInfluence : li (float) [create,query,edit]
  5614. Set the local control a wire has with respect to other wires irrespective of whether it is deforming the surface. Varies
  5615. from no local effect at 0 to full local control at 1. Default is 0.
  5616. - name : n (unicode) [create]
  5617. Used to specify the name of the node being created
  5618. - parallel : par (bool) [create,edit]
  5619. Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is
  5620. inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry
  5621. added yet).
  5622. - prune : pr (bool) [edit]
  5623. Removes any points not being deformed by the deformer in its current configuration from the deformer set.
  5624. - remove : rm (bool) [edit]
  5625. Specifies that objects listed after the -g flag should be removed from this deformer.
  5626. - split : sp (bool) [create,edit]
  5627. Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing
  5628. chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
  5629. - wire : w (unicode) [create,query,edit]
  5630. Specify or query the wire curve name.
  5631. - wireCount : wc (int) [create,query,edit]
  5632. Set the number of wires.
  5633. Derived from mel command `maya.cmds.wire`
  5634. """
  5635. pass
  5636. def wrinkle(*args, **kwargs):
  5637. """
  5638. The wrinkle command is used to create a network of wrinkles on a surface. It automatically creates a network of wrinkle
  5639. curves that control a wire deformer. The wrinkle curves are attached to a cluster deformer.
  5640. Flags:
  5641. - axis : ax (float, float, float) [create]
  5642. Specifies the plane of the wrinkle.
  5643. - branchCount : brc (int) [create]
  5644. Specifies the number of branches per wrinkle. Default is 2.
  5645. - branchDepth : bd (int) [create]
  5646. Specifies the depth of the branching. Default is 0.
  5647. - center : ct (float, float, float) [create]
  5648. Specifies the center of the wrinkle.
  5649. - crease : cr (unicode) [create]
  5650. Specifies an existing curve to serve as the wrinkle. Flag can have multiple arguments, passed
  5651. either as a tuple or a list.
  5652. - dropoffDistance : dds (float) [create]
  5653. Specifies the dropoff distance around the center.
  5654. - envelope : en (float) [create]
  5655. The envelope globally attenuates the amount of deformation. Default is 1.0.
  5656. - randomness : rnd (float) [create]
  5657. Amount of randomness. Default is 0.2.
  5658. - style : st (unicode) [create]
  5659. Specifies the wrinkle style. Valid values are radialor tangential
  5660. - thickness : th (float) [create]
  5661. Wrinkle thickness. Default is 1.0.
  5662. - uvSpace : uv (float, float, float, float, float) [create]
  5663. 1/2 length, 1/2 breadth, rotation angle, center u, v definition of a patch in uv space where the wrinkle is to be
  5664. constructed.
  5665. - wrinkleCount : wc (int) [create]
  5666. Specifies the number of wrinkle lines to be generated. Default is 3.
  5667. - wrinkleIntensity : wi (float) [create]
  5668. Increasing the intensity makes it more wrinkly. Default is 0.5.
  5669. Derived from mel command `maya.cmds.wrinkle`
  5670. """
  5671. pass
  5672. def writeTake(*args, **kwargs):
  5673. """
  5674. This action writes a take from a device with recorded data to a take (.mov) file. The writeTake action can also write
  5675. the virtual definition of a device. See also: recordDevice, readTake, defineVirtualDevice
  5676. Flags:
  5677. - angle : a (unicode) [create]
  5678. Sets the angular unit used in the take. Valid strings are [deg|degree|rad|radian]. C: The default is the current user
  5679. angular unit.
  5680. - device : d (unicode) [create]
  5681. Specifies the device that contains the take. This is a required argument. If the device does not contain a take, the
  5682. action will fail.
  5683. - linear : l (unicode) [create]
  5684. Sets the linear unit used in the take. Valid strings are
  5685. [mm|millimeter|cm|centimeter|m|meter|km|kilometer|in|inch|ft|foot|yd|yard|mi|mile] C: The default is the current user
  5686. linear unit. Flag can have multiple arguments, passed either as a tuple or a list.
  5687. - noTime : nt (bool) [create]
  5688. The take (.mov) file will not contain time stamps. C: The default is to put time stamps in the take file.
  5689. - precision : pre (int) [create]
  5690. Sets the number of digits to the right of the decimal place in the take file.C: The default is 6.
  5691. - take : t (unicode) [create]
  5692. Write out the take to a file with the specified name.
  5693. - virtualDevice : vd (unicode) [create]
  5694. Writes out the virtual device definition to a mel script with the specified file name.
  5695. Derived from mel command `maya.cmds.writeTake`
  5696. """
  5697. pass
  5698. contstraintCmdName = None