¶AdnTurbo

The AdnTurbo script is a Python script that automates the setup of an AdonisFX rig on a clean asset. It configures the following layers in sequence:

• Muscle layer
• Locators and Sensors
• Glue layer
• Fascia layer
• Fat layer
• Skin layer

Please, check this section to know more about the current limitations.

The main function to run AdnTurbo is apply_turbo, which is defined as follows:

from adn.scripts.maya.turbo import apply_turbo

def apply_turbo(
    mummy,                          # str: name or path of the skeletal mesh
    muscles,                        # str or list: muscle geometry names
    fascia=None,                    # str: fascia geometry name
    fat=None,                       # str: fat geometry name
    skin=None,                      # str: skin geometry name
    glue=True,                      # bool: enable glue layer
    glue_group_name=None,           # str: group name for glue output geometry
    create_glue_group=False,        # bool: auto-create glue_group_name if it does not exist
    locators=True,                  # bool: enable creation of locators and sensors
    locators_group_name=None,       # str: group name for locators and rivet nodes
    create_locators_group=False,    # bool: auto-create locators_group_name if it does not exist
    space_scale=1.0,                # float: simulation scale factor
    force=False,                    # bool: remove existing AdonisFX nodes
    report_data=None                # dict: collects errors and warnings
)

¶Requirements

Each layer builds upon the previous one, this means that a specific layer cannot be created unless all the previous layer inputs have been provided. This rule applies to all the layers except for Locators and Sensors, which can be enabled or disabled without affecting the building of other layers.

To configure at least the muscle layer, the following inputs are required:

• mummy: the skeletal mesh that drives the muscle simulation.
• muscles: one or more meshes representing muscles.

When these two inputs are provided, the muscle layer will be completely configured including AdonisFX locators and sensors.

To configure the downstream layers, the following inputs have to be provided:

• locators: flag indicating if locators and sensors have to be built.
• glue: flag indicating if the glue layer has to be built.
• fascia: the fascia mesh to which AdnSkin is applied. The glue input must be True for the fascia layer to be built.
• fat: the fat mesh to which AdnFat is applied. The fascia input must be provided for the fat layer to be built.
• skin: the skin mesh to which AdnSkin is applied. The fat input must be provided for the skin layer to be built.

¶Arguments

In this section we provide a brief overview of the arguments of the apply_turbo function.

¶How to use

1. Open a scene containing the geometries for all the layers to be built.

2. Create the arguments for the apply_turbo function.

mummy       = "mummy_GEO"
muscles     = ["L_deltoid_GEO", "L_bicepsBrachii_GEO", "L_brachialis_GEO", "L_triceps_GEO", ...]
locators    = True
glue        = True
fascia      = "fascia_GEO"
fat         = "fat_GEO"
skin        = "simSkin_GEO"
report_data = {"errors": [], "warnings": []}

3. Run the following command in a Python Script tab by providing the previous arguments.

from adn.scripts.maya.turbo import apply_turbo
apply_turbo(
    mummy,
    muscles,
    fascia=fascia,
    fat=fat,
    skin=skin,
    glue=glue,
    locators=locators,
    report_data=report_data
)

4. Additionally, to place the glue geometry in a specific group, specify its name via the glue_group_name argument. Likewise, to place locator and rivet nodes into their own group, use the locators_group_name argument. If the named group (for either glue or locators) does not exist, simply set the corresponding flag (i.e. create_glue_group or create_locators_group respectively) to True, and the AdnTurbo script will create it automatically.

from adn.scripts.maya.turbo import apply_turbo

mummy                 = "mummy_GEO"
muscles               = ["L_deltoid_GEO", "L_bicepsBrachii_GEO", "L_brachialis_GEO", "L_triceps_GEO", ...]
glue                  = True
glue_group_name       = "glue_GRP"
create_glue_group     = True
locators              = True
locators_group_name   = "locators_GRP"
create_locators_group = True
fascia                = "fascia_GEO"
fat                   = "fat_GEO"
skin                  = "simSkin_GEO"
report_data           = {"errors": [], "warnings": []}

apply_turbo(
    mummy,
    muscles,
    fascia=fascia,
    fat=fat,
    skin=skin,
    glue=glue,
    glue_group_name=glue_group_name,
    create_glue_group=create_glue_group,
    locators=locators,
    locators_group_name=locators_group_name,
    create_locators_group=create_locators_group,
    report_data=report_data
)

5. If something goes wrong during the execution, error and warning messages will be added to the report_data dictionary. Execute the following code to log all the information in the terminal for troubleshooting.

import logging
for err in report_data["errors"]:
    logging.error(err)
for warn in report_data["warnings"]:
    logging.warning(warn)

¶Result

As a result of executing the script by providing the geometries for all the layers, the following nodes will be created:

• An AdnMuscle for each muscle geometry with the mummy geometry as target.
• An AdonisFX locator and sensor for each AdnMuscle to drive the muscle activation.
• An AdnGlue node (including its glue output geometry) with all the muscles as inputs.
• An AdnSkin node for the fascia geometry with the mummy and glue geometries as targets.
• An AdnRelax node applied on top of the fascia AdnSkin.
• An AdnFat node for the fat geometry with the fascia geometry as base mesh.
• An AdnRelax node applied on top of the AdnFat.
• An AdnSkin node for the skin geometry.

¶Limitations

• The glue layer cannot be bypassed. This means that if the fascia argument is provided, the glue flag must be True for the script to complete successfully.
• If the force flag is set to True the script will automatically remove all the AdonisFX nodes from the scene (if any). However, other auxiliary nodes created in previous executions of the script will not be removed (i.e. glue output geometry, rivet nodes).
• The default values that the AdnTurbo script will use to configure each deformer cannot be customized.
• AdnTurbo does not support namespaces in object paths.