SimpleFkCurveRig

vtool.maya_lib.rigs.SimpleFkCurveRig(name[, …])
class SimpleFkCurveRig(name, side=None)
set_control_xform(vector, inc, relative=True)

This allows a control to be moved while its being created. This way all the clusters and everything are still functioning properly.

Parameters:
  • [list] (vector) – Eg [0,0,0], the amount to move the control, relative to its regular position.
  • [int] (inc) – The increment of the control. An increment of 1 would move the first control.
set_orient_joint(joint)

Set a joint to match the orientation of the controls to.

Parameters:joint (str) – The name of a joint.
set_match_to_rotation()

Not used in FkCurve Rigs. Use set_orient_controls_to_joints instead.

set_orient_controls_to_joints(bool_value)

Wether to match the control’s orientation to the nearest joint.

set_control_count(int_value, span_count=None, wire_hires=False)

Set the number of controls. Wire hires is good for having the joints follow a well defined curve while maintaining a small amount of controls.

Parameters:
  • int_value (int) – The number of controls.
  • span_count (int) – The number of spans on the curve.
  • wire_hires (bool) – Wether to wire deform the hires to the control Curve. If span count doesn’t match the control count.
set_sub_control(bool_value)

Wether to create sub controls.

set_skip_first_control(bool_value)

This allows the setup to not have the first control.

set_create_follows(bool_value)

By default the first and last controls fade influence up the sub controls of the setup. By setting this to False, the top and btm controls will no longer affect mid sub controls.

set_create_bottom_follow(bool_value)

This will cause the last control in the spine to have a follow fade on sub controls up the length of the spine. If set_create_follows is set to False this will be ignored.

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_advanced_twist(bool_value)

Wether to use spline ik top btm advanced twist.

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters:bool_value (bool) – Wether to attach joints.
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_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_closest_y(bool_value)

Wether to turn on Maya’s closest y option, which can solve flipping in some cases.

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_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_curve(curve)

Set the curve that the controls should move and the joints should follow.

set_fix_x_axis(bool_value)

This will create a duplicate chain for the spline ik, that has the x axis pointing down the joint. The new joint chain moves with the controls, and constrains the regular joint chain.

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_last_pivot_top(bool_value)

Set the last pivot on the curve to the top of the curve.

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_ribbon(bool_value)

By default the whole setup uses a spline ik. This will cause the setup to use a nurbs surface. If this is on, stretch options are ignored.

set_ribbon_buffer_group(bool_value)
set_ribbon_follicle(bool_value)
set_ribbon_offset(float_value)

Set the width of the ribbon.

set_ribbon_offset_axis(axis_letter)

Set which axis the ribbon width is offset on.

Parameters:axis_letter (str) – ‘X’,’Y’ or ‘Z’
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_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_stretch_attribute_control(node_name)
set_stretch_axis(axis_letter)

Set the axis that the joints should stretch on.

set_stretch_on_off(bool_value)

Wether to add a stretch on/off attribute. This allows the animator to turn the stretchy effect off over time.

set_stretchy(bool_value)

Wether the joints should stretch to match the spline ik.

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_title_description(description)
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’