vtool.maya_lib.rigs

Class Summary

Rig(description[, side])	Base class for rigs.
JointRig(description[, side])	Joint rig class adds attaching buffer chain functionality.
BufferRig(name[, side])	Extends JointRig with ability to create buffer chains.
CurveRig(description[, side])	A rig class that accepts curves instead of joints as the base structure.
PolyPlaneRig(description[, side])	A rig class that accepts curves instead of joints as the base structure.
SurfaceRig(description[, side])	A rig class that accepts curves instead of joints as the base structure.
SparseRig(description[, side])	This class create controls on joints.
SparseLocalRig(description[, side])	A sparse rig that does that connects controls locally.
ControlRig(name[, side])	Convenience for creating controls to hold blendshape sliders.
GroundRig(name[, side])	Create a ground and sub controls
FkRig(name[, side])	This is a great simple setup for appendages like fingers or arms.
FkLocalRig(name[, side])	Same as FkRig but joints get connected in instead of constrained.
FkScaleRig(name[, side])	This extends FkRig so that it can be scalable at each control.
FkCurlNoScaleRig(description[, side])	This extends FkRig with the ability to have a curl attribute.
FkCurlRig(description[, side])
SplineRibbonBaseRig(description[, side])
SimpleFkCurveRig(name[, side])
FkCurveRig(name[, side])	This extends SimpleFkCurveRig.
FkCurveLocalRig(description[, side])
IkSplineNubRig(description[, side])	This is used for the tweaker setup.
IkAppendageRig(description[, side])	This is usually used for arms or legs.
TweakLevelRig(name[, side])
TweakCurveRig(name[, side])	TweakCurveRig is good for belts or straps that need to be riveted to a surface.
LocalTweakCurveRig(name[, side])
RopeRig(name[, side])
ConvertJointToNub(name[, side])
TwistRig(name[, side])
SpineRig(description[, side])
NeckRig(description[, side])
IkLegRig(description[, side])
IkFrontLegRig(description[, side])
IkScapulaRig(description[, side])
IkBackLegRig(description[, side])
RollRig(description[, side])
FootRollRig(description[, side])
BaseFootRig(description[, side])
FootRig(description[, side])
QuadSpineRig(name[, side])
QuadFootRig(description[, side])
EyeLidCurveRig(description[, side])	Very slow.
EyeLidAimRig(description[, side])
StickyRig(description[, side])
StickyFadeRig(description[, side])
EyeRig(description[, side])
JawRig(description[, side])
LipRig(description[, side])
FaceSliders(description, side)	This requires a joint with a locator under it.
FeatherStripRig(description[, side])	New feather building class.
FeatherOnPlaneRig(description, side)

class Rig(description, side=None)

Base class for rigs.

side_left = 'L'

side_right = 'R'

side_center = 'C'

set_control_shape(shape_name)

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

set_sub_control_shape(shape_name)

Sets the look of the curve for the sub controls.

set_control_color(color)

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

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has sub controls.

set_control_size(float_value)

Sets the default size of the control curve.

set_sub_control_size(float_value)

Sets the default size of the sub control curve.

set_control_parent(parent_transform)

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

set_setup_parent(parent_transform)

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

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

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 offset the control cvs around. ‘x’, ‘y’ or ‘z’

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_sub_visibility(bool_value)

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

Parameters

bool_value (bool) –

set_connect_important(bool_value)

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

set_control_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

create()

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

delete_setup()

This will delete the setup group.

class JointRig(description, side=None)

Joint rig class adds attaching buffer chain functionality. Also, the ability to specify a joint chain for a rig.

attach_type_constraint = 0

attach_type_matrix = 1

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_joint_name_token(joint_token_string)

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

create()

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

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class BufferRig(name, side=None)

Extends JointRig with ability to create buffer chains. The buffer chain creates a duplicate chain for attaching the setup to the main chain. This allows multiple rigs to be attached to the main chain.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_buffer(bool_value, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

create()

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

delete_setup()

This will delete the setup group.

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class CurveRig(description, side=None)

A rig class that accepts curves instead of joints as the base structure.

set_curve(curve_list)

Set the curve to rig with.

Parameters

curve_list (str) – The name of a curve.

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

create()

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

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class PolyPlaneRig(description, side=None)

A rig class that accepts curves instead of joints as the base structure.

set_poly_plane(poly_plane)

Set the curve to rig with.

Args:

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

create()

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

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class SurfaceRig(description, side=None)

A rig class that accepts curves instead of joints as the base structure.

set_surface(surface_list)

Set the curve to rig with.

Parameters

curve_list (str) – The name of a curve.

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

create()

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

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class SparseRig(description, side=None)

This class create controls on joints. The controls are not interconnected. For example Fk rig, the controls have a parent/child hierarchy. Sparse rig does not have any hierarchy. This is good for a pile of leaves or tweakers on a body.

set_scalable(bool_value, keep_negative_scale_on_joint=False)

Turn off/on the ability for controls to scale the joints.

Parameters

• bool_value (bool) – Whether to open the scale attributes of the controls.

• keep_negative_scale_on_joint (bool) – TODO: Fill description.

set_respect_side(bool_value, tolerance=0.001, center_line_offset=0)

Respecting side will change the color of controls based on their position along the X coordinate. Less than x will be red. Greater than x will be blue. Inside the center axis will be yellow. This will also change the naming of the control. The end suffix letter will change to L, R or C depending on where it is in space.

Parameters

• bool_value (bool) – Whether to have the control respect side by changing name and color.

• tolerance (float) – The value a control needs to be away from the center before it has a side.

• center_line_offset (int) – TODO: Fill description.

set_match_scale(bool_value)

Match the size of the control to the scale of the joint.

Parameters

bool_value (bool) – Whether to match the control to the scale of the joint.

set_use_joint_controls(bool_value, scale_compensate=False)

set_xform_values(rotate=None, scale=None)

This is good for mirroring control behavior

set_control_to_pivot(bool_value)

This will build the control at the pivot point of the joint or transform supplied with set_joints()

set_control_to_bounding_box_center(bool_value)

set_control_to_bounding_box_bottom(bool_value)

set_control_to_bounding_box_top(bool_value)

set_follow_parent(bool_value)

set_control_compensate(bool_value)

This feeds the translation of the control into a group above using a negative offset. Good if the control is attached to a mesh that it affects using a rivet.

set_run_after_increment(function)

function will get passed the current control and current transform.

set_create_sub_control(bool_value)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class SparseLocalRig(description, side=None)

A sparse rig that does that connects controls locally. This is important for cases where the controls when parented need to move separately from the rig. For example if the setup deformation blendshapes in before a skin cluster.

set_local_constraint(bool_value)

set_local_parent(local_parent)

set_connect_local_xform(bool_value)

set_connect_local_driver(bool_value)

set_create_position_read_locators(bool_value, min_value=None, max_value=None, axis='Y')

Good to hookup of blendshapes to the translation. Weight attribute named weight if set_position_read_locators called once if called for more than one axis = weightX or weightY or weightZ

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

set_control_compensate(bool_value)

This feeds the translation of the control into a group above using a negative offset. Good if the control is attached to a mesh that it affects using a rivet.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_control_to_bounding_box_bottom(bool_value)

set_control_to_bounding_box_center(bool_value)

set_control_to_bounding_box_top(bool_value)

set_control_to_pivot(bool_value)

This will build the control at the pivot point of the joint or transform supplied with set_joints()

set_create_sub_control(bool_value)

set_follow_parent(bool_value)

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_match_scale(bool_value)

Match the size of the control to the scale of the joint.

Parameters

bool_value (bool) – Whether to match the control to the scale of the joint.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

set_respect_side(bool_value, tolerance=0.001, center_line_offset=0)

Respecting side will change the color of controls based on their position along the X coordinate. Less than x will be red. Greater than x will be blue. Inside the center axis will be yellow. This will also change the naming of the control. The end suffix letter will change to L, R or C depending on where it is in space.

Parameters

• bool_value (bool) – Whether to have the control respect side by changing name and color.

• tolerance (float) – The value a control needs to be away from the center before it has a side.

• center_line_offset (int) – TODO: Fill description.

set_run_after_increment(function)

function will get passed the current control and current transform.

set_scalable(bool_value, keep_negative_scale_on_joint=False)

Turn off/on the ability for controls to scale the joints.

Parameters

• bool_value (bool) – Whether to open the scale attributes of the controls.

• keep_negative_scale_on_joint (bool) – TODO: Fill description.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_use_joint_controls(bool_value, scale_compensate=False)

set_xform_values(rotate=None, scale=None)

This is good for mirroring control behavior

side_center = 'C'

side_left = 'L'

side_right = 'R'

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

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

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_size(float_value)

Sets the default size of the control curve.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class GroundRig(name, side=None)

Create a ground and sub controls

set_joints(joints=None)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_control_size(float_value)

Sets the default size of the control curve.

set_scalable(bool_value)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_joint_name_token(joint_token_string)

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class FkRig(name, side=None)

This is a great simple setup for appendages like fingers or arms.

set_parent(parent)

set_match_to_rotation(bool_value)

Whether to match control to the 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.

get_drivers()

Get the driver groups above the controls.

set_use_joint_controls(bool_value, scale_compensate=False)

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

set_create_sub_controls(bool_value)

Whether each fk control should have sub controls.

set_sub_control_count(int_value)

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

set_nice_sub_control_naming(bool_value)

Nice sub control naming just increments the number of the name of the next sub control. So instead 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.

use_hierarchy_to_inform_parenting(bool_value)

This will activate using the hierarchy of the joints to inform control parenting.

use_hierarchy_to_inform_color(bool_value)

This will activate using the color of the joints to inform control colors.

use_hierarchy_to_inform_naming(bool_value)

This will activate using the naming of the joints to inform control naming.

use_hierarchy_to_inform_size(bool_value)

This will activate using the radius of the joints to inform control size.

use_hierarchy_offset(size_offset=0.8, color_offset=0.7)

offsets work as a scalar where 1 does nothing and 0.8 scales down.

set_skip_joints_with_no_children(bool_value)

This will completely remove end joints from getting a control or any setup.

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class FkLocalRig(name, side=None)

Same as FkRig but joints get connected in instead of constrained. This allows the controls as a group to move separately from the joints.

set_control_scale(bool_value)

Set whether the fk setup should be scalable at each control.

set_scalable(bool_value)

Set whether the fk setup should be scalable at each control.

set_connect_local_driver(bool_value)

set_connect_local_xform(bool_value)

set_local_parent(local_parent)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(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_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_create_sub_controls(bool_value)

Whether each fk control should have sub controls.

set_hide_sub_translates(bool_value)

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_match_to_rotation(bool_value)

Whether to match control to the 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 instead 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_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

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_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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

This will completely remove end joints from getting a control or any setup.

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has sub controls.

set_sub_control_count(int_value)

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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_use_joint_controls(bool_value, scale_compensate=False)

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

side_center = 'C'

side_left = 'L'

side_right = 'R'

use_hierarchy_offset(size_offset=0.8, color_offset=0.7)

offsets work as a scalar where 1 does nothing and 0.8 scales down.

use_hierarchy_to_inform_color(bool_value)

This will activate using the color of the joints to inform control colors.

use_hierarchy_to_inform_naming(bool_value)

This will activate using the naming of the joints to inform control naming.

use_hierarchy_to_inform_parenting(bool_value)

This will activate using the hierarchy of the joints to inform control parenting.

use_hierarchy_to_inform_size(bool_value)

This will activate using the radius of the joints to inform control size.

class FkScaleRig(name, side=None)

This extends FkRig so that it can be scalable at each control.

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

create()

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

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(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_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_create_sub_controls(bool_value)

Whether each fk control should have sub controls.

set_hide_sub_translates(bool_value)

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_match_to_rotation(bool_value)

Whether to match control to the 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 instead 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_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

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_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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

This will completely remove end joints from getting a control or any setup.

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has sub controls.

set_sub_control_count(int_value)

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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_use_joint_controls(bool_value, scale_compensate=False)

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

side_center = 'C'

side_left = 'L'

side_right = 'R'

use_hierarchy_offset(size_offset=0.8, color_offset=0.7)

offsets work as a scalar where 1 does nothing and 0.8 scales down.

use_hierarchy_to_inform_color(bool_value)

This will activate using the color of the joints to inform control colors.

use_hierarchy_to_inform_naming(bool_value)

This will activate using the naming of the joints to inform control naming.

use_hierarchy_to_inform_parenting(bool_value)

This will activate using the hierarchy of the joints to inform control parenting.

use_hierarchy_to_inform_size(bool_value)

This will activate using the radius of the joints to inform control size.

class FkCurlNoScaleRig(description, side=None)

This extends FkRig with the ability to have a curl attribute. Good for fingers.

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

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) – E.g. [0], will not add curl to the control on the first joint.

set_curl_title(name)

set_create_curl(bool_value)

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

create()

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

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(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_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_create_sub_controls(bool_value)

Whether each fk control should have sub controls.

set_hide_sub_translates(bool_value)

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_match_to_rotation(bool_value)

Whether to match control to the 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 instead 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_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

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_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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

This will completely remove end joints from getting a control or any setup.

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has sub controls.

set_sub_control_count(int_value)

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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_use_joint_controls(bool_value, scale_compensate=False)

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

side_center = 'C'

side_left = 'L'

side_right = 'R'

use_hierarchy_offset(size_offset=0.8, color_offset=0.7)

offsets work as a scalar where 1 does nothing and 0.8 scales down.

use_hierarchy_to_inform_color(bool_value)

This will activate using the color of the joints to inform control colors.

use_hierarchy_to_inform_naming(bool_value)

This will activate using the naming of the joints to inform control naming.

use_hierarchy_to_inform_parenting(bool_value)

This will activate using the hierarchy of the joints to inform control parenting.

use_hierarchy_to_inform_size(bool_value)

This will activate using the radius of the joints to inform control size.

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) – E.g. [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)

set_create_curl(bool_value)

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

create()

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

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(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_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_create_sub_controls(bool_value)

Whether each fk control should have sub controls.

set_hide_sub_translates(bool_value)

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_match_to_rotation(bool_value)

Whether to match control to the 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 instead 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_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

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_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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

This will completely remove end joints from getting a control or any setup.

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has sub controls.

set_sub_control_count(int_value)

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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_use_joint_controls(bool_value, scale_compensate=False)

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

side_center = 'C'

side_left = 'L'

side_right = 'R'

use_hierarchy_offset(size_offset=0.8, color_offset=0.7)

offsets work as a scalar where 1 does nothing and 0.8 scales down.

use_hierarchy_to_inform_color(bool_value)

This will activate using the color of the joints to inform control colors.

use_hierarchy_to_inform_naming(bool_value)

This will activate using the naming of the joints to inform control naming.

use_hierarchy_to_inform_parenting(bool_value)

This will activate using the hierarchy of the joints to inform control parenting.

use_hierarchy_to_inform_size(bool_value)

This will activate using the radius of the joints to inform control size.

class SplineRibbonBaseRig(description, side=None)

set_advanced_twist(bool_value)

Whether to use spline ik top btm advanced twist.

set_stretchy(bool_value)

Whether the joints should stretch to match the spline ik.

set_stretch_on_off(bool_value)

Whether 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_bezier(bool_value)

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_ribbon_joint_aim(bool_value, up_vector=None, world_up_vector=None)

set_ribbon_overshoot_stretch(bool_value, axis=None)

set_ribbon_overshoot_stretch_axis(axis_letter)

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)

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

create()

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

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

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)

Whether 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) – Whether to wire deform the hires to the control Curve. If span count doesn’t match the control count.

set_sub_control(bool_value)

Whether to create sub controls.

set_create_sub_controls(bool_value)

Whether each fk control should have 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.

set_bezier_controls_parented(bool_value)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(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_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_advanced_twist(bool_value)

Whether to use spline ik top btm advanced twist.

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_buffer(bool_value, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_closest_y(bool_value)

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

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_create_curl(bool_value)

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_curl_title(name)

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_joint_name_token(joint_token_string)

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 instead 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_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

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_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_joint_aim(bool_value, up_vector=None, world_up_vector=None)

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_overshoot_stretch(bool_value, axis=None)

set_ribbon_overshoot_stretch_axis(axis_letter)

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) – E.g. [0], will not add curl to the control on the first joint.

set_skip_joints_with_no_children(bool_value)

This will completely remove end joints from getting a control or any setup.

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)

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

set_stretchy(bool_value)

Whether the joints should stretch to match the spline ik.

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has sub controls.

set_sub_control_count(int_value)

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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_title_description(description)

set_use_joint_controls(bool_value, scale_compensate=False)

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

side_center = 'C'

side_left = 'L'

side_right = 'R'

use_hierarchy_offset(size_offset=0.8, color_offset=0.7)

offsets work as a scalar where 1 does nothing and 0.8 scales down.

use_hierarchy_to_inform_color(bool_value)

This will activate using the color of the joints to inform control colors.

use_hierarchy_to_inform_naming(bool_value)

This will activate using the naming of the joints to inform control naming.

use_hierarchy_to_inform_parenting(bool_value)

This will activate using the hierarchy of the joints to inform control parenting.

use_hierarchy_to_inform_size(bool_value)

This will activate using the radius of the joints to inform control size.

class FkCurveRig(name, side=None)

This extends SimpleFkCurveRig. This is usually used for spine setups.

set_aim_end_vectors(bool_value)

Whether the first and last clusters should aim at the mid-controls

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(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_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_advanced_twist(bool_value)

Whether to use spline ik top btm advanced twist.

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_bezier_controls_parented(bool_value)

set_buffer(bool_value, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_closest_y(bool_value)

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

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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) – Whether to wire deform the hires to the control Curve. If span count doesn’t match the control count.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

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_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.

set_create_curl(bool_value)

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

Whether 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_curl_title(name)

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_joint_name_token(joint_token_string)

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_match_to_rotation()

Not used in FkCurve Rigs. Use set_orient_controls_to_joints instead.

set_nice_sub_control_naming(bool_value)

Nice sub control naming just increments the number of the name of the next sub control. So instead 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_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

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

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

set_orient_joint(joint)

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

Parameters

joint (str) – The name of a joint.

set_parent(parent)

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_joint_aim(bool_value, up_vector=None, world_up_vector=None)

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_overshoot_stretch(bool_value, axis=None)

set_ribbon_overshoot_stretch_axis(axis_letter)

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

This allows the setup to not have the first control.

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) – E.g. [0], will not add curl to the control on the first joint.

set_skip_joints_with_no_children(bool_value)

This will completely remove end joints from getting a control or any setup.

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)

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

set_stretchy(bool_value)

Whether the joints should stretch to match the spline ik.

set_sub_control(bool_value)

Whether to create sub controls.

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has sub controls.

set_sub_control_count(int_value)

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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_title_description(description)

set_use_joint_controls(bool_value, scale_compensate=False)

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

side_center = 'C'

side_left = 'L'

side_right = 'R'

use_hierarchy_offset(size_offset=0.8, color_offset=0.7)

offsets work as a scalar where 1 does nothing and 0.8 scales down.

use_hierarchy_to_inform_color(bool_value)

This will activate using the color of the joints to inform control colors.

use_hierarchy_to_inform_naming(bool_value)

This will activate using the naming of the joints to inform control naming.

use_hierarchy_to_inform_parenting(bool_value)

This will activate using the hierarchy of the joints to inform control parenting.

use_hierarchy_to_inform_size(bool_value)

This will activate using the radius of the joints to inform control size.

class FkCurveLocalRig(description, side=None)

set_local_parent(parent)

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

create()

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

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(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_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_advanced_twist(bool_value)

Whether to use spline ik top btm advanced twist.

set_aim_end_vectors(bool_value)

Whether the first and last clusters should aim at the mid-controls

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_bezier_controls_parented(bool_value)

set_buffer(bool_value, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_closest_y(bool_value)

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

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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) – Whether to wire deform the hires to the control Curve. If span count doesn’t match the control count.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

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_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.

set_create_curl(bool_value)

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

Whether 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_curl_title(name)

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_joint_name_token(joint_token_string)

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_match_to_rotation()

Not used in FkCurve Rigs. Use set_orient_controls_to_joints instead.

set_nice_sub_control_naming(bool_value)

Nice sub control naming just increments the number of the name of the next sub control. So instead 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_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

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

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

set_orient_joint(joint)

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

Parameters

joint (str) – The name of a joint.

set_parent(parent)

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_joint_aim(bool_value, up_vector=None, world_up_vector=None)

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_overshoot_stretch(bool_value, axis=None)

set_ribbon_overshoot_stretch_axis(axis_letter)

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

This allows the setup to not have the first control.

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) – E.g. [0], will not add curl to the control on the first joint.

set_skip_joints_with_no_children(bool_value)

This will completely remove end joints from getting a control or any setup.

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)

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

set_stretchy(bool_value)

Whether the joints should stretch to match the spline ik.

set_sub_control(bool_value)

Whether to create sub controls.

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has sub controls.

set_sub_control_count(int_value)

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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_title_description(description)

set_use_joint_controls(bool_value, scale_compensate=False)

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

side_center = 'C'

side_left = 'L'

side_right = 'R'

use_hierarchy_offset(size_offset=0.8, color_offset=0.7)

offsets work as a scalar where 1 does nothing and 0.8 scales down.

use_hierarchy_to_inform_color(bool_value)

This will activate using the color of the joints to inform control colors.

use_hierarchy_to_inform_naming(bool_value)

This will activate using the naming of the joints to inform control naming.

use_hierarchy_to_inform_parenting(bool_value)

This will activate using the hierarchy of the joints to inform control parenting.

use_hierarchy_to_inform_size(bool_value)

This will activate using the radius of the joints to inform control size.

class IkSplineNubRig(description, side=None)

This is used for the tweaker setup.

set_end_with_locator(bool_value)

Whether the end effector control should be a locator instead.

set_guide_top_btm(top_guide, btm_guide)

Set the parents for the top and btm guide controls.

set_control_shape(name)

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

set_create_middle_control(bool_value)

Whether to create the elbow control.

set_right_side_fix(bool_value, axis)

Whether to compensate for the right side joint orientation.

set_control_orient(transform)

Set the orientation of the top and btm control based on the transform.

Parameters

transform (str) – The name of a transform.

set_negate_right_scale(bool_value)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class IkAppendageRig(description, side=None)

This is usually used for arms or legs.

stretch_type_old = 0

stretch_type_lock_elbow = 1

stretch_type_lock_elbow_soft = 2

set_duplicate_chain_replace(replace_this, with_this)

set_create_twist(bool_value)

Whether to add an auto twist setup.

set_create_stretchy(bool_value)

Whether to add a stretchy setup.

set_stretch_axis(axis_letter)

What axis the stretch should scale on.

Parameters

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

set_pole_offset(value)

Get the amount that the polevector control should offset from the elbow.

Parameters

value (float) –

set_pole_angle_joints(joints)

Set which joints the pole angle is calculated from.

Parameters

joints (list) – A list of 3 joints that form a triangle.

set_right_side_fix(bool_value)

Whether to compensate for right side orientation.

set_create_ik_buffer_joint(bool_value)

Vetala creates a buffer in the ik joints at the wrist. This was to try to fix an ik offset issue when the arm stretches However, it seems this fix can cause problems, especially when it zeros out the joint orient on the wrist joint. If your hand is offsetting when you stretch the arm, try turning this off.

set_negate_right_scale(bool_value, scale_x=- 1, scale_y=- 1, scale_z=- 1)

This will negate the scale of the right side making it better mirrored for cycles.

set_orient_constrain(bool_value)

Whether the end effector control should orient constrain the ik handle. Default is True.

set_curve_type(curve_name)

set_create_sub_control(bool_value)

set_create_world_switch(bool_value)

Whether to create a world switch on the end effector control. This can be used to have the end effector control orient to world if the character is in a-pose.

set_top_control_as_locator(bool_value)

Instead of a control curve for the top control, make it a locator.

set_match_btm_to_joint(bool_value)

Whether to match orientation of the end effector control to the btm joint, or just translation. Default is True.

set_create_top_control(bool_value)

Whether to create a top control.

set_create_pole_control(bool_value)

set_pole_control_shape(curve_type_name)

set_pole_follow_transform(transform, default_value=0)

Set a transform for the pole to follow with an on/off switch on the pole control.

Parameters

• transform (str) – The name of a transform.s

• default_value (int) – TODO: Fill description.

set_control_offset_axis(axis)

This will rotate the control shape cvs 90 on the axis, helping it to align better with different joint orientations.

set_damp_name(name)

set_stretch_scale_attribute_offset(value)

set_stretch_type(stretch_type_int)

set_solver_type(solver_name)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

set_control_parent(parent_transform)

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

set_control_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class TweakLevelRig(name, side=None)

set_fk(bool_value)

set_control_count(int_control_count)

set_sub_control_count(int_control_count)

set_align_controls_to_joints(bool_value, level=- 1)

set_generate_child_joint_at_control(bool_value, prefix='bind')

This helps make the setup more flexible. Joints are created at the lowest level. This allows the controls to easily drive another setup. One use case was having a spine and a neck drive the same ribbon.

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_advanced_twist(bool_value)

Whether to use spline ik top btm advanced twist.

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_buffer(bool_value, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_closest_y(bool_value)

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

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

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_joint_name_token(joint_token_string)

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

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_joint_aim(bool_value, up_vector=None, world_up_vector=None)

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_overshoot_stretch(bool_value, axis=None)

set_ribbon_overshoot_stretch_axis(axis_letter)

set_setup_parent(parent_transform)

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

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)

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

set_stretchy(bool_value)

Whether the joints should stretch to match the spline ik.

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class TweakCurveRig(name, side=None)

TweakCurveRig is good for belts or straps that need to be riveted to a surface.

set_control_count(int_value)

set_use_ribbon(bool_value)

set_ribbon(bool_value)

set_ribbon_follicle(bool_value)

set_ribbon_offset(float_value)

set_ribbon_offset_axis(axis_letter)

set_orient_controls_to_joints(bool_value)

set_join_both_ends(bool_value)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class LocalTweakCurveRig(name, side=None)

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

create()

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

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

set_control_count(int_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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_join_both_ends(bool_value)

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_orient_controls_to_joints(bool_value)

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

set_ribbon(bool_value)

set_ribbon_follicle(bool_value)

set_ribbon_offset(float_value)

set_ribbon_offset_axis(axis_letter)

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_use_ribbon(bool_value)

side_center = 'C'

side_left = 'L'

side_right = 'R'

class RopeRig(name, side=None)

set_subdivisions(int_value)

set_division_value(int_value)

create()

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

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_curve(curve_list)

Set the curve to rig with.

Parameters

curve_list (str) – The name of a curve.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class ConvertJointToNub(name, side='C')

set_start_joint(joint)

set_end_joint(joint)

set_joints(joints)

set_create_mid_control(bool_value)

set_joint_count(count)

set_control_shape(shape_type_name)

set_control_size(size_value)

set_prefix(prefix)

set_add_sub_joints(bool_value)

set_up_object(name)

set_up_axis(axis_name)

set_control_parent(name)

set_setup_parent(name)

create()

get_control_group()

get_setup_group()

get_joints()

set_right_side_fix(bool_value, axis='x')

set_negate_right_scale(bool_value)

set_orient_to_first_transform(bool_value)

class TwistRig(name, side=None)

set_orient_example(transform)

set_control_count(int_value)

set_create_top_control(bool_value)

set_create_btm_control(bool_value)

set_top_twist_fix(bool_value)

set_btm_twist_fix(bool_value)

set_create_controls(bool_value)

set_parent_sub_joints(bool_value)

set_twist_joint_name(name)

set_rounded(bool_value)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class SpineRig(description, side=None)

set_tweak_control_count(control_count)

Set the number of sub controls

set_tweak_control_shape(curve_type)

set_tweak_control_color(color_value)

set_bottom_pivot(value)

set_bottom_control_shape(curve_type)

set_bottom_control_color(color_value)

set_create_bottom_sub_controls(bool_value)

set_top_pivot(value)

set_top_control_shape(curve_type)

set_top_control_color(color_value)

set_create_top_sub_controls(bool_value)

set_fk_control_count(control_count)

Set the number of fk controls.

set_fk_control_one_sub(bool_value)

set_fk_control_sub_color(number)

set_fk_pivots(values)

set_fk_forward(bool_value)

set_fk_control_shape(curve_type)

set_fk_control_color(color_value)

set_fk_single_control_follow(bool_value)

set_create_fk_sub_controls(bool_value)

set_orient_controls_to_joints(bool_value)

set_hold_top_joint(bool_value)

set_hold_bottom_joint(bool_value)

set_evenly_space_cvs(bool_value)

create()

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

get_tweak_controls()

get_fk_controls()

get_top_and_btm_controls()

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_advanced_twist(bool_value)

Whether to use spline ik top btm advanced twist.

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_buffer(bool_value, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_closest_y(bool_value)

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

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

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_joint_name_token(joint_token_string)

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

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_joint_aim(bool_value, up_vector=None, world_up_vector=None)

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_overshoot_stretch(bool_value, axis=None)

set_ribbon_overshoot_stretch_axis(axis_letter)

set_setup_parent(parent_transform)

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

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)

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

set_stretchy(bool_value)

Whether the joints should stretch to match the spline ik.

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class NeckRig(description, side=None)

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

create()

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

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(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_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_advanced_twist(bool_value)

Whether to use spline ik top btm advanced twist.

set_aim_end_vectors(bool_value)

Whether the first and last clusters should aim at the mid-controls

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_bezier_controls_parented(bool_value)

set_buffer(bool_value, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_closest_y(bool_value)

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

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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) – Whether to wire deform the hires to the control Curve. If span count doesn’t match the control count.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

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_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.

set_create_curl(bool_value)

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

Whether 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_curl_title(name)

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_joint_name_token(joint_token_string)

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_match_to_rotation()

Not used in FkCurve Rigs. Use set_orient_controls_to_joints instead.

set_nice_sub_control_naming(bool_value)

Nice sub control naming just increments the number of the name of the next sub control. So instead 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_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

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

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

set_orient_joint(joint)

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

Parameters

joint (str) – The name of a joint.

set_parent(parent)

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_joint_aim(bool_value, up_vector=None, world_up_vector=None)

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_overshoot_stretch(bool_value, axis=None)

set_ribbon_overshoot_stretch_axis(axis_letter)

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

This allows the setup to not have the first control.

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) – E.g. [0], will not add curl to the control on the first joint.

set_skip_joints_with_no_children(bool_value)

This will completely remove end joints from getting a control or any setup.

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)

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

set_stretchy(bool_value)

Whether the joints should stretch to match the spline ik.

set_sub_control(bool_value)

Whether to create sub controls.

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has sub controls.

set_sub_control_count(int_value)

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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_title_description(description)

set_use_joint_controls(bool_value, scale_compensate=False)

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

side_center = 'C'

side_left = 'L'

side_right = 'R'

use_hierarchy_offset(size_offset=0.8, color_offset=0.7)

offsets work as a scalar where 1 does nothing and 0.8 scales down.

use_hierarchy_to_inform_color(bool_value)

This will activate using the color of the joints to inform control colors.

use_hierarchy_to_inform_naming(bool_value)

This will activate using the naming of the joints to inform control naming.

use_hierarchy_to_inform_parenting(bool_value)

This will activate using the hierarchy of the joints to inform control parenting.

use_hierarchy_to_inform_size(bool_value)

This will activate using the radius of the joints to inform control size.

class IkLegRig(description, side=None)

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

create()

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

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

set_control_offset_axis(axis)

This will rotate the control shape cvs 90 on the axis, helping it to align better with different joint orientations.

set_control_parent(parent_transform)

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

set_control_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_create_ik_buffer_joint(bool_value)

Vetala creates a buffer in the ik joints at the wrist. This was to try to fix an ik offset issue when the arm stretches However, it seems this fix can cause problems, especially when it zeros out the joint orient on the wrist joint. If your hand is offsetting when you stretch the arm, try turning this off.

set_create_pole_control(bool_value)

set_create_stretchy(bool_value)

Whether to add a stretchy setup.

set_create_sub_control(bool_value)

set_create_top_control(bool_value)

Whether to create a top control.

set_create_twist(bool_value)

Whether to add an auto twist setup.

set_create_world_switch(bool_value)

Whether to create a world switch on the end effector control. This can be used to have the end effector control orient to world if the character is in a-pose.

set_curve_type(curve_name)

set_damp_name(name)

set_duplicate_chain_replace(replace_this, with_this)

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_match_btm_to_joint(bool_value)

Whether to match orientation of the end effector control to the btm joint, or just translation. Default is True.

set_negate_right_scale(bool_value, scale_x=- 1, scale_y=- 1, scale_z=- 1)

This will negate the scale of the right side making it better mirrored for cycles.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_orient_constrain(bool_value)

Whether the end effector control should orient constrain the ik handle. Default is True.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

set_pole_angle_joints(joints)

Set which joints the pole angle is calculated from.

Parameters

joints (list) – A list of 3 joints that form a triangle.

set_pole_control_shape(curve_type_name)

set_pole_follow_transform(transform, default_value=0)

Set a transform for the pole to follow with an on/off switch on the pole control.

Parameters

• transform (str) – The name of a transform.s

• default_value (int) – TODO: Fill description.

set_pole_offset(value)

Get the amount that the polevector control should offset from the elbow.

Parameters

value (float) –

set_right_side_fix(bool_value)

Whether to compensate for right side orientation.

set_setup_parent(parent_transform)

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

set_solver_type(solver_name)

set_stretch_axis(axis_letter)

What axis the stretch should scale on.

Parameters

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

set_stretch_scale_attribute_offset(value)

set_stretch_type(stretch_type_int)

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_top_control_as_locator(bool_value)

Instead of a control curve for the top control, make it a locator.

side_center = 'C'

side_left = 'L'

side_right = 'R'

stretch_type_lock_elbow = 1

stretch_type_lock_elbow_soft = 2

stretch_type_old = 0

class IkFrontLegRig(description, side=None)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

set_control_offset_axis(axis)

This will rotate the control shape cvs 90 on the axis, helping it to align better with different joint orientations.

set_control_parent(parent_transform)

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

set_control_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_create_ik_buffer_joint(bool_value)

Vetala creates a buffer in the ik joints at the wrist. This was to try to fix an ik offset issue when the arm stretches However, it seems this fix can cause problems, especially when it zeros out the joint orient on the wrist joint. If your hand is offsetting when you stretch the arm, try turning this off.

set_create_pole_control(bool_value)

set_create_stretchy(bool_value)

Whether to add a stretchy setup.

set_create_sub_control(bool_value)

set_create_top_control(bool_value)

Whether to create a top control.

set_create_twist(bool_value)

Whether to add an auto twist setup.

set_create_world_switch(bool_value)

Whether to create a world switch on the end effector control. This can be used to have the end effector control orient to world if the character is in a-pose.

set_curve_type(curve_name)

set_damp_name(name)

set_duplicate_chain_replace(replace_this, with_this)

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_match_btm_to_joint(bool_value)

Whether to match orientation of the end effector control to the btm joint, or just translation. Default is True.

set_negate_right_scale(bool_value, scale_x=- 1, scale_y=- 1, scale_z=- 1)

This will negate the scale of the right side making it better mirrored for cycles.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_orient_constrain(bool_value)

Whether the end effector control should orient constrain the ik handle. Default is True.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

set_pole_angle_joints(joints)

Set which joints the pole angle is calculated from.

Parameters

joints (list) – A list of 3 joints that form a triangle.

set_pole_control_shape(curve_type_name)

set_pole_follow_transform(transform, default_value=0)

Set a transform for the pole to follow with an on/off switch on the pole control.

Parameters

• transform (str) – The name of a transform.s

• default_value (int) – TODO: Fill description.

set_pole_offset(value)

Get the amount that the polevector control should offset from the elbow.

Parameters

value (float) –

set_right_side_fix(bool_value)

Whether to compensate for right side orientation.

set_setup_parent(parent_transform)

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

set_solver_type(solver_name)

set_stretch_axis(axis_letter)

What axis the stretch should scale on.

Parameters

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

set_stretch_scale_attribute_offset(value)

set_stretch_type(stretch_type_int)

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_top_control_as_locator(bool_value)

Instead of a control curve for the top control, make it a locator.

side_center = 'C'

side_left = 'L'

side_right = 'R'

stretch_type_lock_elbow = 1

stretch_type_lock_elbow_soft = 2

stretch_type_old = 0

class IkScapulaRig(description, side=None)

set_control_offset(value)

set_create_rotate_control(bool_value)

set_negate_right_scale(bool_value)

set_offset_axis(axis_letter)

set_duplicate_chain_replace(replace_this, with_this)

set_auto_arm_rotate(arm_joint, arm_rotate_axis, scapula_rotate_axis)

set_ik_aim_control_shape(curve_type)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class IkBackLegRig(description, side=None)

set_offset_control_to_locator(bool_value)

set_offset_ankle_axis(axis_letter)

set_offset_ankle_orientation(transform_example)

set_offset_control_shape(curve_type_name)

set_pole_at_knee_only(bool_value)

set_invert_twist(bool_value)

set_invert_poles(bool_value)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

set_control_offset_axis(axis)

This will rotate the control shape cvs 90 on the axis, helping it to align better with different joint orientations.

set_control_parent(parent_transform)

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

set_control_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_create_ik_buffer_joint(bool_value)

Vetala creates a buffer in the ik joints at the wrist. This was to try to fix an ik offset issue when the arm stretches However, it seems this fix can cause problems, especially when it zeros out the joint orient on the wrist joint. If your hand is offsetting when you stretch the arm, try turning this off.

set_create_pole_control(bool_value)

set_create_stretchy(bool_value)

Whether to add a stretchy setup.

set_create_sub_control(bool_value)

set_create_top_control(bool_value)

Whether to create a top control.

set_create_twist(bool_value)

Whether to add an auto twist setup.

set_create_world_switch(bool_value)

Whether to create a world switch on the end effector control. This can be used to have the end effector control orient to world if the character is in a-pose.

set_curve_type(curve_name)

set_damp_name(name)

set_duplicate_chain_replace(replace_this, with_this)

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_match_btm_to_joint(bool_value)

Whether to match orientation of the end effector control to the btm joint, or just translation. Default is True.

set_negate_right_scale(bool_value, scale_x=- 1, scale_y=- 1, scale_z=- 1)

This will negate the scale of the right side making it better mirrored for cycles.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_orient_constrain(bool_value)

Whether the end effector control should orient constrain the ik handle. Default is True.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

set_pole_angle_joints(joints)

Set which joints the pole angle is calculated from.

Parameters

joints (list) – A list of 3 joints that form a triangle.

set_pole_control_shape(curve_type_name)

set_pole_follow_transform(transform, default_value=0)

Set a transform for the pole to follow with an on/off switch on the pole control.

Parameters

• transform (str) – The name of a transform.s

• default_value (int) – TODO: Fill description.

set_pole_offset(value)

Get the amount that the polevector control should offset from the elbow.

Parameters

value (float) –

set_right_side_fix(bool_value)

Whether to compensate for right side orientation.

set_setup_parent(parent_transform)

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

set_solver_type(solver_name)

set_stretch_axis(axis_letter)

What axis the stretch should scale on.

Parameters

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

set_stretch_scale_attribute_offset(value)

set_stretch_type(stretch_type_int)

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_top_control_as_locator(bool_value)

Instead of a control curve for the top control, make it a locator.

side_center = 'C'

side_left = 'L'

side_right = 'R'

stretch_type_lock_elbow = 1

stretch_type_lock_elbow_soft = 2

stretch_type_old = 0

class RollRig(description, side=None)

duplicate_joints()

set_create_roll_controls(bool_value)

set_attribute_control(control_name)

set_attribute_control_shape(shape_name)

set_control_shape(shape_name)

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

set_add_hik(bool_value)

set_forward_roll_axis(axis_letter)

set_side_roll_axis(axis_letter)

set_top_roll_axis(axis_letter)

set_right_side_fix(bool_value)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class FootRollRig(description, side=None)

set_toe_rotate_as_locator(bool_value)

Whether the toe rotate should be a locator instead of a control. An attribute will be created on the main control to rotate the toe.

set_mirror_yaw(bool_value)

set_main_control_follow(transform)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

duplicate_joints()

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_hik(bool_value)

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

set_attribute_control(control_name)

set_attribute_control_shape(shape_name)

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

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_create_roll_controls(bool_value)

set_forward_roll_axis(axis_letter)

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

set_right_side_fix(bool_value)

set_setup_parent(parent_transform)

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

set_side_roll_axis(axis_letter)

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_top_roll_axis(axis_letter)

side_center = 'C'

side_left = 'L'

side_right = 'R'

class BaseFootRig(description, side=None)

set_main_control_follow(transform)

set_create_roll_controls(bool_value)

set_attribute_control(control_name)

set_control_shape(shape_name)

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

set_attribute_control_shape(shape_name)

set_forward_roll_axis(axis_letter)

set_side_roll_axis(axis_letter)

set_top_roll_axis(axis_letter)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class FootRig(description, side=None)

set_build_hierarchy(bool_value)

set_duplicate_chain_replace(replace_this, with_this)

set_create_ball_control(bool_value)

set_toe_rotate_as_locator(bool_value)

set_mirror_yaw(bool_value)

set_pivot_locator(locator_name)

set_pivot_locators(heel, yaw_in, yaw_out)

Set the pivots for the foot roll. These must be transforms.

Parameters

• heel (str) – Name of a transform.

• yaw_in (str) – Name of a transform.

• yaw_out (str) – Name of a transform.

set_create_foot_roll(bool_value)

set_create_ankle_roll(bool_value, axis='Z')

set_toe_rotate_axis(axis='X')

set_ik_parent(parent_name)

set_ik_leg(ik_group_name)

set_no_ball(bool_value)

set_toe_control_as_sub_control(bool_value)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

set_attribute_control(control_name)

set_attribute_control_shape(shape_name)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_create_roll_controls(bool_value)

set_forward_roll_axis(axis_letter)

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_main_control_follow(transform)

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

set_setup_parent(parent_transform)

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

set_side_roll_axis(axis_letter)

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_top_roll_axis(axis_letter)

side_center = 'C'

side_left = 'L'

side_right = 'R'

class QuadSpineRig(name, side=None)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class QuadFootRig(description, side=None)

set_add_bank(bool_value, add_back_bank=False)

set_extra_ball(joint_name)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

set_attribute_control(control_name)

set_attribute_control_shape(shape_name)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_create_ankle_roll(bool_value, axis='Z')

set_create_ball_control(bool_value)

set_create_foot_roll(bool_value)

set_create_roll_controls(bool_value)

set_duplicate_chain_replace(replace_this, with_this)

set_forward_roll_axis(axis_letter)

set_ik_leg(ik_group_name)

set_ik_parent(parent_name)

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_main_control_follow(transform)

set_mirror_yaw(bool_value)

set_no_ball(bool_value)

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

set_pivot_locator(locator_name)

set_pivot_locators(heel, yaw_in, yaw_out)

Set the pivots for the foot roll. These must be transforms.

Parameters

• heel (str) – Name of a transform.

• yaw_in (str) – Name of a transform.

• yaw_out (str) – Name of a transform.

set_setup_parent(parent_transform)

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

set_side_roll_axis(axis_letter)

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_toe_control_as_sub_control(bool_value)

set_toe_rotate_as_locator(bool_value)

set_toe_rotate_axis(axis='X')

set_top_roll_axis(axis_letter)

side_center = 'C'

side_left = 'L'

side_right = 'R'

class EyeLidCurveRig(description, side=None)

Very slow.

set_control_offset(value)

set_surface(surface_name)

set_orient(transform)

set_orient_aim(bool_value, axis='Z')

set_follow_multiply(value)

set_invert_y_value(bool_value)

create()

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

create_fade_row(joints, weight, ignore_surface=False)

create_control_follow(control, increment, weight)

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class EyeLidAimRig(description, side=None)

set_control_offset(value)

set_scale_space(value)

set_use_joint_controls(value)

set_center_locator(locator)

set_follow_multiply(value)

create()

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

create_control_follow(main_control, increment, weight)

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class StickyRig(description, side=None)

set_respect_side(bool_value, tolerance=0.001)

set_top_joints(joint_list)

set_btm_joints(joint_list)

set_top_stick_values(float_list)

set_btm_stick_values(float_list)

set_local(bool_value)

set_tweaker_space(value)

set_use_joint_controls(bool_value)

set_right_side_fix(bool_value)

create()

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

create_follow(follow_transform, increment, value)

create_zip(attribute_control, increment, start, end, end_value=1)

create_roll(control, increment, percent)

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class StickyFadeRig(description, side=None)

set_corner_match(left_transform, right_transform)

set_corner_control_shape(shape_name)

set_corner_x_space(positive, negative)

set_corner_y_space(positive, negative)

set_corner_z_space(positive, negative)

create()

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

create_follow(follow_transform, increment, value, top_follow_transform=None)

create_corner_falloff(inc, value)

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

create_roll(control, increment, percent)

create_zip(attribute_control, increment, start, end, end_value=1)

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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_btm_joints(joint_list)

set_btm_stick_values(float_list)

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_local(bool_value)

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

set_respect_side(bool_value, tolerance=0.001)

set_right_side_fix(bool_value)

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_top_joints(joint_list)

set_top_stick_values(float_list)

set_tweaker_space(value)

set_use_joint_controls(bool_value)

side_center = 'C'

side_left = 'L'

side_right = 'R'

class EyeRig(description, side=None)

set_parent(parent)

set_local_parent(local_parent)

set_extra_control(axis, value, rotate_value=25, limit=1)

set_create_fk_control(bool_value, offset_control_shape=1, control_shape=None)

set_skip_ik_control(bool_value)

set_constrain_local(bool_value)

set_aim_offset(offset=1, aim=[0, 0, 1])

This auto create the look offset, if no second joint

set_aim_up(up=[0, 1, 0])

when using aim instead of ik, customize the up axis of the aim constraint

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class JawRig(description, side=None)

set_jaw_slide_offset(value)

set_create_jaw_slide_attribute(bool_value)

set_jaw_slide_rotate_axis(axis_letter)

set_jaw_slide_translate_axis(axis_letter)

set_follow_world(bool_value)

If you need the rig to not stay at the origin but move with the rig.

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

create()

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

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(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_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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, name_for_attribute=None, name_for_node=None)

Turn off/on the creation of a buffer chain.

Parameters

• bool_value (bool) – Whether to create the buffer chain.

• name_for_attribute – Name to give an optional switch attribute

• name_for_node – name of a node the optional switch attribute lives on.

set_buffer_replace(replace_this, with_this)

set_build_hierarchy(bool_value)

set_connect_important(bool_value)

set_connect_local_driver(bool_value)

set_connect_local_xform(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_scale(bool_value)

Set whether the fk setup should be scalable at each control.

set_control_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_create_sub_controls(bool_value)

Whether each fk control should have sub controls.

set_hide_sub_translates(bool_value)

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_local_parent(local_parent)

set_match_to_rotation(bool_value)

Whether to match control to the 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 instead 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_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

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_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

set_scalable(bool_value)

Set whether the fk setup should be scalable at each control.

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

This will completely remove end joints from getting a control or any setup.

set_sub_control_color(color)

Set the color of sub controls.

set_sub_control_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has sub controls.

set_sub_control_count(int_value)

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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

set_use_joint_controls(bool_value, scale_compensate=False)

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

side_center = 'C'

side_left = 'L'

side_right = 'R'

use_hierarchy_offset(size_offset=0.8, color_offset=0.7)

offsets work as a scalar where 1 does nothing and 0.8 scales down.

use_hierarchy_to_inform_color(bool_value)

This will activate using the color of the joints to inform control colors.

use_hierarchy_to_inform_naming(bool_value)

This will activate using the naming of the joints to inform control naming.

use_hierarchy_to_inform_parenting(bool_value)

This will activate using the hierarchy of the joints to inform control parenting.

use_hierarchy_to_inform_size(bool_value)

This will activate using the radius of the joints to inform control size.

class LipRig(description, side=None)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class FaceSliders(description, side)

This requires a joint with a locator under it. if locator is: localPositionX = 0 localPositionY = 0.5 localPositionZ = 0 localScaleX = 0 localScaleY = 0.5 localScaleZ = 0 then slider works in one direction

if locator is: localPositionX = 0 localPositionY = 0 localPositionZ = 0 localScaleX = 0 localScaleY = 1 localScaleZ = 0 then slider works in both directions

if no locator or settings not detected, then default slider works in one direction

set_overdrive(overdrive_amount=1.5)

Value that the slider is allowed to go to

set_positive_negative_shape(curve_type)

create()

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

attach_type_constraint = 0

attach_type_matrix = 1

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_add_switch_shape(name_for_attribute, name_for_node=None)

Add a switch attribute, for example: ikFk

Parameters

• name_for_attribute (str) – The name to give the switch attribute upon creation. i.e. ikFk

• name_for_node (str) – The name to give the shape to be created that the attribute will live on. i.e. settings_arm_L

set_attach_joints(bool_value)

Turn off/on joint attaching.

Parameters

bool_value (bool) – Whether to attach joints.

set_attach_type(attach_type)

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

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_joint_name_token(joint_token_string)

set_joints(joints)

Set the joints that the rig should work on.

Parameters

joints (list) – Joints by name.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class FeatherStripRig(description, side='')

New feather building class. Try giving it two curves using set_curve([‘curve1’, ‘curve2’]) and see what happens. This will need an example rig to show how it works.

set_attribute_control(transform)

set_attribute_description(description)

set_feather_up_parent(parent)

set_feather_u_v_spans(u_spans, v_spans)

set_feather_count(value)

set_feather_joint_sections(value)

set_feather_tilt(value)

set_feather_lift(value)

set_feather_tangent_first_curve(bool_value)

set_curve_skin_joints(joints, distance_falloff=2)

set_curve_skin_falloff(value)

set_first_curve_skin_mesh(mesh)

set_first_curve_wrap_mesh(mesh)

set_feather_blend(feather_mesh)

set_feather_blend_top_btm(top_feather_mesh, btm_feather_mesh)

set_feather_width_scale(value)

set_feather_length_scale(value)

set_feather_length_random(min_value, max_value)

set_color(r, g, b)

add_curve_control(percent_curve1, percent_curve2)

add_skin_joint(percent_curve1, percent_curve2, parent=None)

get_tweak_joints()

get_tweak_joint_ends()

get_skin_joint_ends()

create()

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

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_curve(curve_list)

Set the curve to rig with.

Parameters

curve_list (str) – The name of a curve.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'

class FeatherOnPlaneRig(description, side)

set_guide_feather(guide_feather_geo_name)

polygon geo that represents the curve

set_feather_curve_group(feather_curve_group_name)

Group with curves in it, that represents the feather

set_feather_curve_quill(feather_curve_quill)

Curve to be the quill for feathers created on the surface.

set_main_control_offset(offset_value)

set_nucleus_name(name)

set_hair_system_name(name)

set_follow_u(bool_value)

set_feather_count(int_value)

set_combine_quills(bool_value)

set_tilt(float_value)

set_color(r, g, b)

create()

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

connect_sub_visibility(attr_name)

This connects the subVisibility attribute to the specified attribute. Good when centralizing the sub control visibility.

delete_setup()

This will delete the setup group.

get_all_controls()

Returns all controls in the setup.

get_controls(title)

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

get_sub_controls(title)

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

set_connect_important(bool_value)

set_control_color(color)

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

set_control_color_hue(value)

Using HSV this sets the hue component for the controls.

set_control_color_increment_hue(value)

Using HSV this increments (.1) or decrements (-.1) the hue component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_saturation(value)

Using HSV this increments (.1) or decrements (-.1) the saturation component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_increment_value(value)

Using HSV this increments (.1) or decrements (-.1) the value component of controls as they are created. This allows for things like FK control chains to get progressively darker/lighter.

set_control_color_saturation(value)

Using HSV this sets the saturation component for the controls.

set_control_color_value(value)

Using HSV this sets the value component for the controls.

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 offset 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_set(list_of_set_names)

This will create the sets if they don’t already exist. This will put all the controls generated under the last set name in the list

set_control_shape(shape_name)

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

set_control_size(float_value)

Sets the default size of the control curve.

set_no_last_number(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_number_in_control_name(bool_value)

By default, controls are named with a number. For example: “CNT_DEFAULT_1_L” If this is set to false, the name would become: “CNT_DEFAULT_L” This helps simplify control names especially for major controls.

set_pick_walk_parent(control_name)

Some rig classes support pick walking. When pick walking gets to the first control, it will then navigate to the control specified here.

set_poly_plane(poly_plane)

Set the curve to rig with.

Args:

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_color_hue(value)

Using HSV this sets the hue component for the sub controls.

set_sub_control_color_only(bool_value)

Makes main controls use the same color has 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 whether sub controls are visible by default after building the rig.

Parameters

bool_value (bool) –

set_switch_parent(rig_control_group)

This is used for IK/FK matching. This could be used to allow the hands to be associated with the IK/FK switching of the arm.

side_center = 'C'

side_left = 'L'

side_right = 'R'