component::GetRig

Loads a rig graph and its invert graph from a packed character geometry.

On this page	Inputs Outputs
Since	21.0

Extracts and loads an APEX rig graph from a character’s packed folder structure. It normalizes the graph name, unpacks the corresponding geometry, and loads both the main rig graph and its corresponding invert graph. The invert graph is used to go from an animated skeleton input to animated controls.

This subgraph is used in all rig components to fetch the rig graph. It is the standard method for connecting rig components, in particular for the Autorig Builder workflow.

The character ports of this node are in-place ports, which means the character geometry is updated without creating a copy.

Inputs ¶


                *character:
                    Geometry

Required

The character folder structure that contains the rig graphs.


                graph_name:
                    String

The name of the rig graph to load. Automatically takes care of any leading slashes and .rig extensions. For example, Base, /Base, Base.rig, and /Base.rig all resolve to the same graph.


                graph:
                    ApexGraphHandle

If bypass is set to True, this is an existing graph to use. If bypass is set to False, this input is ignored.


                bypass:
                    Bool

If set to True, returns the graph and invert_graph inputs unchanged. This is useful for passing through preloaded graphs if you want to daisy chain multiple components together. This is done in the Autorig Builder, which significantly improves performance. If set to False, loads the graphs from the character geometry.


                invert_graph:
                    ApexGraphHandle

If bypass is set to True, this is an existing invert graph to use. If bypass is set to False, this input is ignored.

Outputs ¶


                *character:
                    Geometry

Pass-through of the input character geometry.


                graph_name:
                    String

The graph name including the leading slash and .rig extension (for example, /Base.rig).


                graph:
                    ApexGraphHandle

The rig graph loaded from the character, or the graph input if bypass is set to True.


                invert_graph:
                    ApexGraphHandle

The invert graph loaded from the character, or the invert_graph input if bypass is set to True. The invert graph is stored with the same base name as the rig graph but with a .invert extension instead of .rig.

Inputs ¶

Outputs ¶

APEX nodes