FkCurlRig

vtool.maya_lib.rigs.FkCurlRig(description[, …])

class FkCurlRig(description, side=None)

set_curl_axis(axis_letter)

Set the axis that the curl should rotate on.

Parameters:axis_letter (str) – ‘X’,’Y’,’Z’

set_curl_description(description)

The attribute name for the curl slider.

Parameters:attribute_name (str) – The name of the curl slider attribute.

set_skip_increments(increments)

You can skip increments so they don’t get affected by the curl. Each increment corresponds to a joint set in set_joints

Parameters:increments (list) – Eg. [0], will not add curl to the control on the first joint.

set_curl_skip_incrment(increments)

set_attribute_control(control_name)

Set the control that the curl slider should live on.

Parameters:control_name (str) – The name of a control.

set_attribute_name(attribute_name)

The attribute name for the curl slider.

Parameters:attribute_name (str) – The name of the curl slider attribute.

set_curl_title(name)

create()

delete_setup()

get_control_entries(title)

Get entries for every control. For example, title could be “xform”. It would return all the xform nodes.

get_drivers()

Get the driver groups above the controls.

get_sub_control_entries(title)

Get entries for every sub control. For example, title could be “xform”. It would return all the xform nodes.

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters:bool_value (bool) – Wether to attach joints.

set_auto_switch_visibility(bool_value)

When attaching more than one joint chain. This will attach the control group visibility to the switch attribute on the first joint.

set_buffer(bool_value)

Turn off/on the creation of a buffer chain.

Parameters:bool_value (bool) – Wehter to create the buffer chain.

set_build_hierarchy(bool_value)

set_control_color(color)

Set the color of the control based on an integer value.

set_control_offset_axis(axis_letter)

This sets the axis that the control curve cvs will offset to. This happens by rotating the control in 90 degrees on the axi. This is good for lining up the control cvs to a different axis than its default.

Parameters:axis_letter (str) – The letter of the axis to offste the control cvs around. ‘x’, ‘y’ or ‘z’

set_control_parent(parent_transform)

Sets the parent of the control group for this rig. This usually should get run after create.

set_control_shape(shape_name)

Sets the look of the controls, based on predifined names.

set_control_size(float_value)

Sets the default size of the control curve.

set_create_sub_controls(bool_value)

Wether each fk control should have sub controls.

set_hide_sub_translates(bool_value)

set_joints(joints)

Set the joints that the rig should work on.

Parameters:joints (list) – Joints by name.

set_match_to_rotation(bool_value)

Wether to match control to closest joint orientation or not. If not just match to translate. Control stays oriented to world. Default is True. This is only used in Fk rigs not FkCurve rigs.

set_nice_sub_control_naming(bool_value)

Nice sub control naming just increments the number of the name of the next sub control. So insteado of CNT_SUB_THING_1_C and CNT_SUB_THING_SUB_1_C as the names, names are: CNT_SUB_THING_1_C and CNT_SUB_THING_2_C This may not be desirable in every case.

set_offset_rotation(value_list)

This will offset the controls by the rotation vector. Ex. [0,90,0] will rotate the xform group of the control 90 degrees on the Y axis.

set_offset_rotation_at_inc(inc, value_list)

This will offset the controls by the rotation vector. Ex. [0,90,0] will rotate the xform group of the control 90 degrees on the Y axis. Inc starts at 0. 0 is the first control.

set_parent(parent)

set_setup_parent(parent_transform)

Sets the parent of the setup group for this rig. This usually should get run after create.

set_skip_controls(increment_list)

Set which increments are skipped.

Parameters:increment_list (list) – A list of integers. [0] will skip the first increment, [0,1] will skip the first 2 increments.

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_shape(shape_name)

Sets the look of the curve for the sub controls.

set_sub_control_size(float_value)

Sets the default size of the sub control curve.

set_sub_visibility(bool_value)

This controls wether sub controls are visible by default after building the rig.

Parameters:bool_value (bool) –

set_use_joint_controls(bool_value, scale_compensate=False)

Wether to make the controls have a joint as their base transform node.

side_center = ‘C’

side_left = ‘L’

side_right = ‘R’