pymel.core.context.ikHandleCtx

ikHandleCtx(*args, **kwargs)

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.

Flags:

Long name (short name)		Argument Types	Properties
autoPriorityH (apH)		bool
	Specifies that this handle’s priority is assigned automatically.C: The default is off.Q: When queried, this flag returns an int.
createCurve (ccv)		bool
	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.
createRootAxis (cra)		bool
	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.
exists (ex)		bool
	Returns true or false depending upon whether the specified object exists. Other flags are ignored.
forceSolverH (fsH)		bool
	Specifies if the ikSolver is enabled for the ikHandle.C: The default is on.Q: When queried, this flag returns an int.
history (ch)		bool
	If this is a tool command, turn the construction history on for the tool in question.
image1 (i1)		unicode
image2 (i2)		unicode
image3 (i3)		unicode
	Contexts support up to three icons that represent the tool associated with the context.
name (n)		unicode
	If this is a tool command, name the tool appropriately.
numSpans (ns)		int
	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.
parentCurve (pcv)		bool
	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.
poWeightH (pwH)		float
	Specifies the position/orientation weight of the ikHandle.C: The default is 1.Q: When queried, this flag returns a float.
priorityH (pH)		int
	Specifies the priority of the ikHandle.C: The default is 1.Q: When queried, this flag returns an int.
rootOnCurve (roc)		bool
	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.
rootTwistMode (rtm)		bool
	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 commandFlag can have multiple arguments, passed either as a tuple or a list.
simplifyCurve (scv)		bool
	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.
snapCurve (snc)		bool
	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.
snapHandleH (snH)		bool
	Specifies if the ikHandle snapping is on.C: The default is on.Q: When queried, this flag returns an int.
solverTypeH (stH)		unicode
	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.
stickyH (sH)		unicode
	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.
twistType (tws)		unicode
	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.
weightH (wH)		float
	Specifies the weight of the ikHandle.C: The default is 1.Q: When queried, this flag returns a float.

Derived from mel command maya.cmds.ikHandleCtx

Example:

import pymel.core as pm

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