Controls

class AnimControlAction

Bases: BuildAction

Configure a node to be used as an animation control.

get_min_api_version(): Override to return the minimum Maya api version required for this BuildAction. This compares against cmds.about(api=True).

run(): Perform the main functionality of this build action. Attribute values can be accessed using self.myAttr.

validate(): Validate that the animation control is named, and it’s scales are frozen.

class AnimControlContextSubMenu(menu: PulseNodeContextMenu, is_only_submenu: bool)

Bases: PulseNodeContextSubMenu

Context menu for working with animation controls.

build_menu_items(): Build the menu items for this utility

classmethod should_build_sub_menu(menu) → bool

Return true if this submenu should be built for a node

Parameters:: menu (PulseNodeContextMenu) – The parent context menu, containing a reference to the hit node

class ShowAllControlsAction

Bases: BuildAction

Adds an attribute to a node that allows overriding the visibility of all anim controls to be showing. Should be added after all Anim Control actions, and usually on the root control.

run(): Perform the main functionality of this build action. Attribute values can be accessed using self.myAttr.

class FootControlAction

Bases: BuildAction

Create a classic attribute-driven foot roll and tilt control.

run(): Perform the main functionality of this build action. Attribute values can be accessed using self.myAttr.

class FootControlContextSubMenu(menu: PulseNodeContextMenu, is_only_submenu: bool)

Bases: PulseNodeContextSubMenu

Context menu for working with foot controls

build_menu_items(): Build the menu items for this utility

classmethod should_build_sub_menu(menu) → bool

Return true if this submenu should be built for a node

Parameters:: menu (PulseNodeContextMenu) – The parent context menu, containing a reference to the hit node

class MagicFeetAction

Bases: BuildAction

Allows controlling foot rotation, blending pivots between toe, heel and ankle.

create_matrix_blend(mtx_a, mtx_b, blend_attr, name)

Create a util node to blend between two matrices.

Parameters:

mtx_a (Attribute) – Matrix attribute to use when blend_attr is 0
mtx_b (Attribute) – Matrix attribute to use when blend_attr is 1
blend_attr (Attribute) – Float attribute to blend between the matrices
name (str) – The name of the new node

Returns:

The blended output attr of the node that was created

run(): Perform the main functionality of this build action. Attribute values can be accessed using self.myAttr.

class MagicHandsAction

Bases: BuildAction

Controls all fingers of a hand using individual rotate axes for quick posing.

run(): Perform the main functionality of this build action. Attribute values can be accessed using self.myAttr.

validate(): Validate this build action. Can be implemented in subclasses to check the action’s attribute values and raise BuildActionErrors if anything is invalid.

class SetAttributeDefaultsAction

Bases: BuildAction

Set the default attribute values on animation controls, so they can be reset easily using Resetter.

run(): Perform the main functionality of this build action. Attribute values can be accessed using self.myAttr.

validate(): Validate this build action. Can be implemented in subclasses to check the action’s attribute values and raise BuildActionErrors if anything is invalid.