ControlRig

vtool.maya_lib.rigs.ControlRig(name[, side])

Convenience for creating controls to hold blendshape sliders.

class ControlRig(name, side=None)

Convenience for creating controls to hold blendshape sliders.

set_transforms(transforms)

Set transforms where controls should be created.

set_control_count_per_transform(int_value)

Set the number of controls per transform.

set_control_shape(index, shape_name)

Set the control shape at the index. Corresponds to set_control_count_per_transform.

set_control_description(index, description)

Set the description of the control at the index. Corresponds to set_control_count_per_transform.

set_only_translate_channels(bool_value)

set_no_channels(bool_value)

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_sub_control_entries(title)

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

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_size(float_value)

Sets the default size of the control curve.

set_setup_parent(parent_transform)

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

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) –

side_center = ‘C’

side_left = ‘L’

side_right = ‘R’