trigger.library.joint
=====================

.. py:module:: trigger.library.joint

.. autoapi-nested-parse::

   Joint related common functions.



Attributes
----------

.. autoapisummary::

   trigger.library.joint.AXIS_CONVERSION_DICT
   trigger.library.joint.JOINT_SIDE_DICT
   trigger.library.joint.JOINT_TYPE_DICT
   trigger.library.joint.log


Functions
---------

.. autoapisummary::

   trigger.library.joint.get_joint_side
   trigger.library.joint.get_joint_type
   trigger.library.joint.get_rig_axes
   trigger.library.joint.identify
   trigger.library.joint.orient_joints
   trigger.library.joint.set_joint_side
   trigger.library.joint.set_joint_type


Module Contents
---------------

.. py:function:: get_joint_side(joint, skip_errors=True)

   Gets the joint side
   Args:
       joint: (String) Joint to be queried
       skip_errors: (Bool) If true, error will be silenced and return None

   Returns: (String) Side



.. py:function:: get_joint_type(joint, skip_errors=True)

   Gets the joint type
   Args:
       joint: (String) source joint type
       skip_errors: (Bool) If True, silently return if the type cannot be found, else throw error. Default True

   Returns: (String) joint_type



.. py:function:: get_rig_axes(joint)

   Gets the axis information from the joint.
   Args:
       joint (str): The node to look at the attributes

   Returns (tuple): up_axis, mirror_axis, spineDir



.. py:function:: identify(joint, modules_dictionary)

   Identify joints for Trigger
   Args:
       joint: (String) Joint to query
       modules_dictionary: (Dictionary)

   Returns: (Tuple) joint_type, limb_type, side



.. py:function:: orient_joints(joint_list, aim_axis=(1.0, 0.0, 0.0), up_axis=(0.0, 1.0, 0.0), world_up_axis=(0.0, 1.0, 0.0), reverse_aim=1.0, reverse_up=1.0)

   Orient joints.
   Alternative to Maya's native joint orient method
   Args:
       joint_list: (list) Joints list. Order is important.
       aim_axis: (Tuple) Aim Axis of each joint default X
       up_axis: (Tuple) Up Axis of each joint default Y
       world_up_axis: (Tuple) World up axis default Y
       reverse_aim: (int) multiplier for aim. Default 1
       reverse_up: (int) multiplier for reverseUp. Default 1

   Returns:



.. py:function:: set_joint_side(joint, side)

   Sets the Joint side
   Args:
       joint: (String) Joint to work on
       side: (String) Side value. Valid values are 'l', 'r', 'c', 'left', 'right', 'center' Not Case sensitive

   Returns:



.. py:function:: set_joint_type(joint, type_name)

   Sets Trigger Joint Type
   Args:
       joint: (String) Source Joint
       type_name: (String) Name of the joint

   Returns: None



.. py:data:: AXIS_CONVERSION_DICT

.. py:data:: JOINT_SIDE_DICT

.. py:data:: JOINT_TYPE_DICT

.. py:data:: log