trigger.library.joint

Joint related common functions.

Attributes

AXIS_CONVERSION_DICT

JOINT_SIDE_DICT

JOINT_TYPE_DICT

log

Functions

get_joint_side(joint[, skip_errors])

Gets the joint side

get_joint_type(joint[, skip_errors])

Gets the joint type

get_rig_axes(joint)

Gets the axis information from the joint.

identify(joint, modules_dictionary)

Identify joints for Trigger

orient_joints(joint_list[, aim_axis, up_axis, ...])

Orient joints.

set_joint_side(joint, side)

Sets the Joint side

set_joint_type(joint, type_name)

Sets Trigger Joint Type

Module Contents

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

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

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

identify(joint, modules_dictionary)

Identify joints for Trigger Args:

joint: (String) Joint to query modules_dictionary: (Dictionary)

Returns: (Tuple) joint_type, limb_type, side

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:

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:

set_joint_type(joint, type_name)

Sets Trigger Joint Type Args:

joint: (String) Source Joint type_name: (String) Name of the joint

Returns: None

AXIS_CONVERSION_DICT
JOINT_SIDE_DICT
JOINT_TYPE_DICT
log