IkHandle

class cgp_maya_utils.scene.IkHandle(name)

Bases: cgp_maya_utils.scene.Transform

node object that manipulates an ikHandle node

classmethod create(startJoint, endJoint, solverType=None, connections=None, attributeValues=None, name=None, **__)

create an ik handle

Parameters:
  • startJoint (str or cgp_maya_utils.scene.Joint) – start joint of the ik handle
  • endJoint (str or cgp_maya_utils.scene.Joint) – end joint of the ik handle
  • solverType (str) – type of solver of the ik handle - default is cgp_maya_utils.constants.Solver.IK_RP_SOLVER
  • connections (list[tuple[str]]) – connections to set on the ikHandle
  • attributeValues (dict) – attribute values to set on the ikHandle node
  • name (str) – name of the node
Returns:

the created ik handle

Return type:

cgp_maya_utils.scene.IkHandle

data(worldSpace=False)

data necessary to store the ik handle node on disk and/or recreate it from scratch

Parameters:worldSpace (bool) – True : ikHandle transforms are in worldSpace - False : ikHandle transforms in local
Returns:the data of the ik handle
Return type:dict
effector()

the effector of the ik handle

Returns:the effector of the ik handle
Return type:cgp_maya_utils.scene.IkEffector
endJoint()

the end joint of the ik handle

Returns:the end joint of the ik handle
Return type:cgp_maya_utils.scene.Joint
setSolver(solverType)

set the solver of the ik handle

Parameters:solverType (str) – type of solver to set
startJoint()

the start joint of the ik handle

Returns:the start joint
Return type:cgp_maya_utils.scene.Joint