pymel.core.context.jointCtx¶

jointCtx(*args, **kwargs)¶

The joint context command (jointCtx) updates the parameters of the joint tool. The options for the tool will be set by the flags the user specifies.

Flags:

Long Name / Short Name		Argument Types	Properties
autoJointOrient / ajo		unicode
	Specifies the joint orientation. Valid string choices are permutations of the axes; none, xyz, yzx, zxy, xzy, yxz, zyx. The first letter determines which axis is aligned with the bone.C: The default is xyz.Q: When queried, this flag returns a string.
autoPriorityH / apH		bool
	Specifies if the ikHandle’s priority is assigned automatically.C: The default is off.Q: When queried, this flag returns an int.
createIKHandle / ikh		bool
	Enables the joint tool to create an ikHandle when the tool is completed.C: The default is off.Q: When queried, this flag returns an int.
degreeOfFreedomJ / dJ		unicode
	Specifies the degrees of freedom for all of the joints created by the tool. Valid string choices are the free axes; x, y, z, xy, xz, yz, xyz, and none.C: The default is xyz.Q: When queried, this flag returns a string.
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 for the ikHandle is enabled.C: The default is on.Q: When queried, this flag returns an int.
image1 / i1		unicode
	First of three possible icons representing the tool associated with the context.
image2 / i2		unicode
	Second of three possible icons representing the tool associated with the context.
image3 / i3		unicode
	Third of three possible icons representing the tool associated with the context.
jointAutoLimits / jal		bool
	Automatically computes the joint limits based on the kind of joint created. C: The default is off.Q: When queried, this flag returns an int.
jointOrientationJ / joJ		float, float, float
	Sets the orientation of the joints created by the tool. If autoJointOrient in on, these values will be ignored.C: The default is 0 0 0.Q: When queried, this flag returns an array of three floats.
largeBoneLength / lbl		float
	Specifies the length above which bones should be assigned the largeBoneRadius.
largeBoneRadius / lbr		float
	Specifies the radius for bones whose length is above the largeBoneLength
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 on.Q: When queried, this flag returns an int.
scaleCompensateJ / scJ		bool
	Specifies if scale compensate is enabled.C: The default is on.Q: When queried, this flag returns an int.
scaleJ / sJ		float, float, float
	Sets the scale for the joints created by the tool.C: The default is 1 1 1.Q: When queried, this flag returns an array of three floats.
scaleOrientationJ / soJ		float, float, float
	Sets the current value for the scale orientation. If autoJointOrient in on, these values will be ignored.C: The default is 0 0 0.Q: When queried, this flag returns an array of three floats.
secondaryAxisOrient / sao		unicode
	Specifies the orientation of the secondary rotate axis. Valid string choices are: xup, xdown, yup, ydown, zup, zdown, none.
smallBoneLength / sbl		float
	Specifies the length below which bones should be assigned the smallBoneRadius.
smallBoneRadius / sbr		float
	Specifies the radius for bones whose length is below the smallBoneLength.
snapHandleH / snH		bool
	Sepcifies if snapping is enabled for the ikHandle. C: The default is on.Q: When queried, this flag returns an int.
solverTypeH / stH		unicode
	Sets the name of the solver to use with the ikHandle. C: The default is the solver set to the default in the user preferences.Q: When queried, this flag returns a string.
stickyH / sH		unicode
	Specifies if the ikHandle is sticky or not. If stickyis passed then the ikHandle will be sticky. If offis used then ikHandle stickiness will be turned off.C: The default is off.Q: When queried, this flag returns a string.
symmetry / sym		bool
	Automaticaly create a symmetry joint based if symmetry is on. C: The default is off.Q: When queried, this flag returns an int.
symmetryAxis / sa		unicode
	Automaticaly create a symmetry joint use x, y , z axis or combination to do the symmetry. C: The default is x.Q: When queried, this flag returns a string.
variableBoneSize / vbs		int
	Specifies whether or not variable bone length and radius settings should be used.
weightH / wH		float
	Specifies the weight of the ikHandle. The weight is relative to the other ikHandles in the scene.C: The default is 1.Q: When queried, this flag returns a float. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.jointCtx

Example:

import pymel.core as pm

#    Create a joint context that makes a ikHandle with an ikRPSolver.
#    The use the tool.
#
pm.jointCtx( 'myJointContext', createIKHandle=True, solverTypeH='ikRPsolver' )
# Result: u'myJointContext' #
pm.setToolTo( 'myJointContext' )