APEX Rigscript Component geometry node

Procedurally build an autorig script for deferred rig building

On this page	Parameters Rig Advanced Component Parameters Inputs Outputs
Since	20.0

This feature is still under development. The current functionality is unfinished and subject to change, and may have thin or no documentation. Please bear this in mind when using it.

This node procedurally builds up an autorig script (APEX graph) using autorig components. This autorig script can be used as a template a condence a fully procedural rig build down to the execution of that given template. It can also be used to create higherlevel rig components from lower level rig component. The rig script is in a a way the recipe describing how you got with the given components of your rig to the given rig result.

Parameters ¶

Component Source

Choose of the list of current available autorig components. When “Use Third Input” is selected, then the autorig compont script from the second input is used instead.

Component File

The file path of the autorig component being used. This parameter is automatically populated when using the Component Source menu.

Component Output File

When Component Source is set to “Use Second Input”, this specifies an output file path for Save to Disk.

Save to Disk

Saves the component rig script to Component Output File. Updates to the layout of your component parameters on your current node will be stored as metadata on the given component script geometry as well. The current parameter values of the SOP node will be used as default parm values for the component stored component script. NOTE

If you store the component script under $HIP/apexcomponents/, or $HIP/apexcomponents/ or $HOME/apexcomponents/ it will be automatically picked up by the dropdown of Component Source making it easy for entry level users to use components without being exposed to the graph directly.

Rig ¶

Rig Source

Operation to perform should a rig element of the character be added or modified.

Add or Update

Add/update the rig in the packed folder input geometry specified by Name. If no rig exists, one will be created if possible.

From Input

This will pick up the behavior defined from an upstream APEX Autorig Component node.

Add or Replace

Add/replace the rig into the packed folder input geometry specified by Name.

Name

Name of the packed folder primitive from the input geometry that we want to define as the current rig to operate on.

Advanced ¶

Parm Source

Source of settings to use for the component script input parameters.

Component

Use the parameters from this node.

Node

Use the parms dictionary from another SOP node’s Path and Attribute Name.

Path

Path to a SOP node to use for the Parm Source.

Attribute Name

Name of a dictionary attribute to use for the Parm Source.

Component Parameters ¶

This section contains parameters specific to the current autorig component being used. Depending on the component source that section of the parameter inferface will change. The parameters are derived from the parameter inputs of the component script graph. So the Autorig Component serves as a interfaced to configure component script inputs.

Reload Setup Parms

Update the parameters in this section to the current component.

Promoted Parms

Set of rig parameters to promote from the component on the rig script to be modified.

Parm

Name of the rigscript parameter

Alias

Alias to use for the promoted rigscript parameter

Inputs ¶

RigScript

The modified rig script being constructed.

CharacterStream

The APEX Character geometry stream to modify.

ComponentScript

The geometry containing an APEX graph to invoke for building the rig. This is typically the RigScript output of a chain of APEX Rigscript Component nodes.

Outputs ¶