Rig Base Class

class rig.rigBase.BaseModel(*args, **kwargs)

class rig.rigBase.RigBase(*args, **kwargs)

Base rig is the base class to be used on any rig. it contains an instance of the main classes that will be used when creating a rig. The members that contains the Base rig are the following. name_convention, an instance of the nameConvention class used to rename all elements on the rig. rig_system a class that contains the maya hierarchical structure used as base for all the systems rig_creators the functions used to create all kind of nodes on maya trough an interface that it is easy to use and standard.

property attach_points

property control_creation_kwargs

property controls

create_curve_base(*args, **kwargs)

create_node_base(*args, **kwargs): Base function for node creation, it gets as input any kind of nodes, usually this can be transforms. There is no real difference with create point base, other than create point base validates the input, and if no nodes are provided it will create them. Node base, shoud only be used with maya nodes and it is an alternative to create_point_base.

create_point_base(*args, **kwargs): Base function for rig creation, it validates the args values and turn them in to points. it creates two arrays one of objects, one of points, and one of rotation vectors

create_selection_base(**kwargs)

create_shape_base(*args, **kwargs)

property creation_points

custom_world_align(*scene_objects): This function can be used to align any object with the world paradigm which by default is x aiming front, This also takes in consideration if the object is on the right side, since controls are mirrored on Z axis.

property inputs

property joint_creation_kwargs

property joints

property outputs

rename_as_skinned_joints(nub=False, create_outputs=False)

property reset_controls

property reset_joints

property root: The root of a rig is a property that stores the transform group that whenever you want to create a parent for the rig you can move scale, or rotate this rig and all in the rig will follow. You can assign the root to what ever transform you want, but in the case you have not done this the property will return the first value stored on the reset_controls list.

set_parent(rig_object, **kwargs)

This is the standardize function to parent modules, This works in union with the properties root and tip. When you call set_parent the rig object attribute can be a rig(that inherits at some point from rigBase), or a transform. If it is a rig, the function will look for the tip on the dictionary attachments. If this has not being assigned the default value will be the first element of the list rig_reset_controls. So you can assign what ever point you want to be the driver of all the rig or let the rig find it by itself.

Parameters:

rig_object – object or rig that you expect to be the parent of the module.
output_joint_rig – The output joint rig is a specific rig to create a hierarchy of joints
create_hierarchy_joints (bool) – Flag to define if the hierarchy joints need to be created.

Returns:

setup_name_convention_node_base(*args, **kwargs): This function is used to set the name convention of all the tools on the class to match a specific transform. args only the first arg will be used to inherit the name, system and side of the name. If the name is in the name convention the tokens of the name will be used, in case it is not, the name will be made a shortName(strip all _) and will be used as the system name. Notice that there is a special system name, defined on the config, (by default is reference) which if the point belogs to this system, means that is meant to be used to create a rig and the name of the locator will be used as the system.

property tip

update_name_convention(): Updates the name convention on all the creators, and rig_system objects

property world_scale_matrix: This attribute returns an output of a maya node that contains the matrix correspondent to the world scale value of the rig. Notice that it is an attribute not a node, so should be treated as this.

property zero_joint: This property creates a zero joint that will be used for static rigs. The joint is created automatically if it doesn’t exist. :return: