PoseManager

vtool.maya_lib.corrective.PoseManager()

Convenience for working with poses.

class PoseManager

Convenience for working with poses.

is_pose(name)

Check if name matches the name of a pose.

Parameters:name (str) – Check if the node at name is a pose. Returns:bool

is_pose_mesh_in_sculpt(index, pose_name)

get_pose_instance(pose_name)

Get the instance of a pose.

Parameters:pose_name (str) – The name of a pose. Returns:The instance of the pose at the pose type. Return type:object

get_poses(all_descendents=False)

Get the poses under the pose_gr

Returns:The names of poses. Return type:list

get_pose_control(name)

Get the control of a pose.

Parameters:name (str) – The name of a pose. Returns:The name of the pose. Return type:str

get_pose_type(name)

set_pose_group(pose_gr_name)

Set the pose group to work with.

Parameters:pose_gr_name (str) – The name of a pose group.

set_weights_to_zero()

Set all poses in the pose_gr to zero.

set_default_pose()

Set the default control pose. This is the control pose the rig should revert to by default.

set_pose_to_default()

Set the control pose to the default pose. This is handy for resetting control positions after going to a pose.

set_pose(pose)

Set the control pose to the a pose. This is handy for returning a character to the pose it was sculpted in.

Parameters:pose (str) – The name of a pose.

set_pose_data(pose)

Set the pose data from the control values. This is handy for making sure a character can get back into pose before sculpting it.

Parameters:pose (str) – The name of a pose.

set_poses(pose_list)

Not in use. This was the beginning of a combo system. It proved difficult to extrapulate a combo pose from multiple poses.

Parameters:pose_list (list) – A list of pose names.

create_pose(pose_type, name=None)

Create a pose.

Parameters:

• pose_type (str) – The name of a pose type.
• name (str) – The name for the pose.

Returns:

The name of the new pose.

Return type:

str

create_cone_pose(*args, **kwargs)

Create a cone pose.

Parameters:name (str) – The name for the pose. Returns:The name of the pose. Return type:str

create_no_reader_pose(*args, **kwargs)

Create a no reader pose.

Parameters:name (str) – The name for the pose. Returns:The name of the pose. Return type:str

create_combo_pose(name=None)

Create a combo pose.

Parameters:name (str) – The name for the pose. Returns:The name of the pose. Return type:str

create_timeline_pose(*args, **kwargs)

Create a no timeline pose.

Parameters:name (str) – The name for the pose. Returns:The name of the pose. Return type:str

create_group_pose(name=None)

Create a group pose.

Parameters:name (str) – The name for the pose. Returns:The name of the pose. Return type:str

reset_pose(*args, **kwargs)

update_pose_meshes(*args, **kwargs)

update_pose(*args, **kwargs)

revert_pose_vertex(*args, **kwargs)

rename_pose(*args, **kwargs)

add_mesh_to_pose(*args, **kwargs)

visibility_off(pose_name)

Change the visibility of the pose meshes.

Parameters:pose_name (str) – The name of a pose.

toggle_visibility(target_mesh, pose_name, view_only=False)

Toggle the visibility of the sculpt mesh.

Parameters:

• target_mesh (str) – The name of a mesh affected by the pose.
• pose_name (str) – The name of a pose.
• view_only (bool) – Wether to calculate its delta when turning visibility off, or just turn visibility off.

delete_pose(*args, **kwargs)

Delete a pose by name.

Parameters:name (str) – The name of a pose.

detach_poses()

Detach poses from the pose_gr and the rig.

attach_poses(poses=None)

Attach poses to the pose_gr and the rig.

create_pose_blends(poses=None)

Refresh the deltas on poses. By default do it to all poses under the pose_gr.

Parameters:poses (args) – The names of poses.

mirror_pose(name)

Mirror a pose to a corresponding R side pose.

For example

If pose name = pose_arm_L, there must be a corresponding pose_arm_R. The pose at pose_arm_R must be a mirrored pose of pose_arm_L.

Parameters:name (str) – The name of a left side pose.