jointCtx

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

Synopsis

jointCtx( [object] , [autoJointOrient=string], [autoPriorityH=boolean], [createIKHandle=boolean], [degreeOfFreedomJ=string], [exists=boolean], [forceSolverH=boolean], [image1=string], [image2=string], [image3=string], [jointAutoLimits=boolean], [jointOrientationJ=[angle, angle, angle]], [largeBoneLength=float], [largeBoneRadius=float], [poWeightH=float], [priorityH=int], [scaleCompensateJ=boolean], [scaleJ=[float, float, float]], [scaleOrientationJ=[angle, angle, angle]], [secondaryAxisOrient=string], [smallBoneLength=float], [smallBoneRadius=float], [snapHandleH=boolean], [solverTypeH=string], [stickyH=string], [variableBoneSize=int], [weightH=float])

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

jointCtx is undoable, queryable, and editable.

Return value

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

Flags

Long name (short name)	Argument types	Properties
exists(ex)	boolean
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
image1(i1)	string
image2(i2)	string
image3(i3)	string
Contexts support up to three icons that represent the tool associated with the context.
autoJointOrient(ajo)	string
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.
secondaryAxisOrient(sao)	string
Specifies the orientation of the secondary rotate axis. Valid string choices are: "xup", "xdown", "yup", "ydown", "zup", "zdown", "none".
degreeOfFreedomJ(dJ)	string
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.
jointAutoLimits(jal)	boolean
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)	[angle, angle, angle]
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.
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.
scaleCompensateJ(scJ)	boolean
Specifies if scale compensate is enabled. C: The default is on. Q: When queried, this flag returns an int.
scaleOrientationJ(soJ)	[angle, angle, angle]
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.
createIKHandle(ikh)	boolean
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.
forceSolverH(fsH)	boolean
Specifies if the ikSolver for the ikHandle is enabled. C: The default is on. Q: When queried, this flag returns an int.
autoPriorityH(apH)	boolean
Specifies if the ikHandle's priority is assigned automatically. C: The default is off. Q: When queried, this flag returns an int.
priorityH(pH)	int
Specifies the priority of the ikHandle. 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.
stickyH(sH)	string
Specifies if the ikHandle is sticky or not. If "sticky" is passed then the ikHandle will be sticky. If "off" is used then ikHandle stickiness will be turned off. C: The default is "off". Q: When queried, this flag returns a string.
snapHandleH(snH)	boolean
Sepcifies if snapping is enabled for the ikHandle. C: The default is on. Q: When queried, this flag returns an int.
solverTypeH(stH)	string
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.
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.
variableBoneSize(vbs)	int
Specifies whether or not variable bone length and radius settings should be used.
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
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.

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

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