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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif
 
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
forceSolverH (fsH) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
image2 (i2) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
image3 (i3) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Contexts support up to three icons that represent the tool associated with the context.
jointAutoLimits (jal) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Specifies the length above which bones should be assigned the largeBoneRadius.
largeBoneRadius (lbr) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Specifies the radius for bones whose length is above the largeBoneLength
poWeightH (pwH) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Specifies the position/orientation weight of the ikHandle.C: The default is 1.Q: When queried, this flag returns a float.
priorityH (pH) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Specifies the priority of the ikHandle.C: The default is on.Q: When queried, this flag returns an int.
scaleCompensateJ (scJ) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Specifies if scale compensate is enabled.C: The default is on.Q: When queried, this flag returns an int.
scaleJ (sJ) float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Specifies the orientation of the secondary rotate axis. Valid string choices are: “xup”, “xdown”, “yup”, “ydown”, “zup”, “zdown”, “none”.
smallBoneLength (sbl) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Specifies the length below which bones should be assigned the smallBoneRadius.
smallBoneRadius (sbr) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

Specifies the radius for bones whose length is below the smallBoneLength.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

snapHandleH (snH) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Sepcifies if snapping is enabled for the ikHandle.C: The default is on.Q: When queried, this flag returns an int.
solverTypeH (stH) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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.

variableBoneSize (vbs) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Specifies whether or not variable bone length and radius settings should be used.
weightH (wH) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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.

Derived from mel command maya.cmds.jointCtx

Example:

import pymel.core as pm

import maya.cmds as cmds

#    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' )

Previous topic

pymel.core.context.insertKeyCtx

Next topic

pymel.core.context.keyframeRegionCurrentTimeCtx

Core

Core Modules

Other Modules

This Page