IkBackLegRig

vtool.maya_lib.rigs.IkBackLegRig(description)

class IkBackLegRig(description, side=None)

set_offset_control_to_locator(bool_value)

create()

delete_setup()

get_control_entries(title)

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

get_sub_control_entries(title)

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

set_attach_joints(bool_value)

Turn off/on joint attaching.

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

set_auto_switch_visibility(bool_value)

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

set_buffer(bool_value)

Turn off/on the creation of a buffer chain.

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

set_build_hierarchy(bool_value)

set_control_color(color)

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

set_control_offset_axis(axis)

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

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

set_control_size(float_value)

Sets the default size of the control curve.

set_create_stretchy(bool_value)

Wether to add a stretchy setup.

set_create_sub_control(bool_value)

set_create_top_control(bool_value)

Wether to create a top control.

set_create_twist(bool_value)

Wether to add an auto twist setup.

set_create_world_switch(bool_value)

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

Set the joints that the rig should work on.

Parameters:joints (list) – Joints by name.

set_match_btm_to_joint(bool_value)

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

set_negate_right_scale(bool_value)

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

set_orient_constrain(bool_value)

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

set_pole_angle_joints(joints)

Set which joints the pole angle is calculated from.

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

set_pole_follow_transform(transform)

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

Parameters:transform (str) – The name of a transform.s

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)

Wether 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_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_sub_control_color(color)

Set the color of sub controls.

set_sub_control_shape(shape_name)

Sets the look of the curve for the sub controls.

set_sub_control_size(float_value)

Sets the default size of the sub control curve.

set_sub_visibility(bool_value)

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

Parameters:bool_value (bool) –

set_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’