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

Synopsis

ikHandleCtx( object , [autoPriorityH=boolean], [createCurve=boolean], [createRootAxis=boolean], [exists=boolean], [forceSolverH=boolean], [history=boolean], [image1=string], [image2=string], [image3=string], [name=string], [numSpans=int], [parentCurve=boolean], [poWeightH=float], [priorityH=int], [rootOnCurve=boolean], [rootTwistMode=boolean], [simplifyCurve=boolean], [snapCurve=boolean], [snapHandleH=boolean], [solverTypeH=string], [stickyH=string], [twistType=string], [weightH=float])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

ikHandleCtx is undoable, queryable, and editable.

The ikHandle context command (ikHandleCtx) updates parameters of ikHandle tool. The options for the tool will be set to the flags that the user specifies.

Return value

string

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

Flags

autoPriorityH, createCurve, createRootAxis, exists, forceSolverH, history, image1, image2, image3, name, numSpans, parentCurve, poWeightH, priorityH, rootOnCurve, rootTwistMode, simplifyCurve, snapCurve, snapHandleH, solverTypeH, stickyH, twistType, weightH
Long name (short name) Argument types Properties
exists(ex) boolean create
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
image1(i1) string createqueryedit
image2(i2) string createqueryedit
image3(i3) string createqueryedit
Contexts support up to three icons that represent the tool associated with the context.
history(ch) boolean create
If this is a tool command, turn the construction history on for the tool in question.
name(n) string create
If this is a tool command, name the tool appropriately.
priorityH(pH) int createqueryedit
Specifies the priority of the ikHandle.
C: The default is 1.
Q: When queried, this flag returns an int.
weightH(wH) float createqueryedit
Specifies the weight of the ikHandle.
C: The default is 1.
Q: When queried, this flag returns a float.
poWeightH(pwH) float createqueryedit
Specifies the position/orientation weight of the ikHandle.
C: The default is 1.
Q: When queried, this flag returns a float.
autoPriorityH(apH) boolean createqueryedit
Specifies that this handle's priority is assigned automatically.
C: The default is off.
Q: When queried, this flag returns an int.
solverTypeH(stH) string createqueryedit
Lists what ikSolver is being used. The ikSplineSolver may not be selected. To use an ikSplineSolver use the ikSplineHandleCtx command.
C: The default solver is the default set by the user preferences.
Q: When queried, this flag returns a string.
snapHandleH(snH) boolean createqueryedit
Specifies if the ikHandle snapping is on.
C: The default is on.
Q: When queried, this flag returns an int.
forceSolverH(fsH) boolean createqueryedit
Specifies if the ikSolver is enabled for the ikHandle.
C: The default is on.
Q: When queried, this flag returns an int.
stickyH(sH) string createqueryedit
Specifies if the ikHandle is sticky or not. Valid strings are "sticky" and "off".
C: The default is "off".
Q: When queried, this flag returns a string.
createCurve(ccv) boolean createqueryedit
Specifies if a curve should be automatically created for the ikSplineHandle. The flag is ignored in the ikHandleCtx.
C: The default is on.
Q: When queried, this flag returns an int.
simplifyCurve(scv) boolean edit
Specifies if the ikSplineHandle curve should be simplified. This flag is ignored in the ikHandleCtx.
C: The default is on.
Q: When queried, this returns an int.
rootOnCurve(roc) boolean edit
Specifies if the root is locked onto the curve of the ikSplineHandle. This flag is ignored in the ikHandleCtx.
C: The default is on.
Q: When queried, this flag returns an int.
twistType(tws) string edit
Specifies the type of interpolation to be used by the ikSplineHandle. This flag is ignored in the ikHandleCtx. The interpolation options are "linear", "easeIn", "easeOut", and "easeInOut".
C: The default is "linear".
Q: When queried, this flag returns a string.
createRootAxis(cra) boolean edit
Specifies if a root transform should automatically be created above the joints affected by the ikSplineHandle. This option is used to prevent the root flipping singularity on a motion path. This flag is ignored in the ikHandleCtx.
C: The default is off.
Q: When queried, this flag returns an int.
parentCurve(pcv) boolean edit
Specifies if the curve should automatically be parented to the parent of the first joint affected by the ikSplineHandle. The flag is ignored in the ikHandleCtx.
C: The default is on.
Q: When queried, this flag returns an int.
snapCurve(snc) boolean edit
Specifies if the curve should automatically snap to the first joint affected by the ikSplineHandle. This flag is ignored in the ikHandleCtx.
C: The default is off.
Q: When queried, this flag returns an int.
numSpans(ns) int edit
Specifies the number of spans in the automatically generated curve of the ikSplineHandle. This flag is ignored in the ikHandleCtx.
C: The default is 1.
Q: When queried, this flag returns an int.
rootTwistMode(rtm) boolean edit
Specifies whether the start joint is allowed to twist or not. If not, then the required twist is distributed over the remaining joints. This applies to all the twist types. This flag is ignored in the ikHandleCtx.
C: The default is off.
Q: When queried, this flag returns an int.
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

#    Edit an existing context to create an ikHandle with snapping on.
#
if cmds.ikHandleCtx( 'ikHandleCtx', q=True, ex=True ):
  cmds.ikHandleCtx('ikHandleCtx', e=True, snapHandleH=True)