SplineRibbonBaseRig

vtool.maya_lib.rigs.SplineRibbonBaseRig(…)

class SplineRibbonBaseRig(description, side=None)

set_advanced_twist(bool_value)

Wether to use spline ik top btm advanced twist.

set_stretchy(bool_value)

Wether the joints should stretch to match the spline ik.

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_stretch_axis(axis_letter)

Set the axis that the joints should stretch on.

set_stretch_attribute_control(node_name)

set_curve(curve)

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

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_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_ribbon_follicle(bool_value)

set_ribbon_buffer_group(bool_value)

set_last_pivot_top(bool_value)

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

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

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

create()

Create the rig. Set commands must be set before running this.

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_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_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_joints(joints)

Set the joints that the rig should work on.

Parameters:joints (list) – Joints by name.

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’