On this page |
The APEX path pattern syntax is a set of rules that allow you to filter and select specific elements within APEX graphs and the packed character format:
APEX graphs
APEX path patterns are used in graph nodes like graph::FindNodes and graph::FindPorts to find specific groups of nodes and ports. APEX path patterns can also be used to filter for metadata on graph nodes like tags and properties. Tags are used extensively in pre-built rig components to label and find nodes in a rig.
Packed character format
APEX path patterns are used in the Unpack Folder SOP to extract specific elements from the nested folder structure of the packed character format.
APEX path pattern syntax ¶
The rules of the APEX path pattern syntax are listed in the table below. The “hierarchy levels” mentioned refer to nested subnets (for APEX graphs) and nested folder structures (for the packed character format).
Syntax |
Description |
---|---|
|
Matches any number of characters in a name. For example, |
|
Matches any number of hierarchy levels. For example, |
|
Matches any single character. |
|
Matches any single character within the brackets. For example, |
|
Groups and attributes are put inside braces. For example, Note Pattern matching with groups and attributes are only supported for the packed character format, and not for graph elements. |
Combine patterns with |
Multiple patterns can be combined with the
|
|
Parentheses indicate the order of execution for combined patterns. For example, |
Port syntax ¶
The graph::FindPorts node can filter for graph ports using the following syntax:
<node_path>:<port_name>[in|out][<subport_name>]
-
The optional
[in]
/[out]
specifies whether the port is an input or output port on the node. -
The optional
[<subport_name>]
specifies the subport name of the variadic port<port_name>
.
For example, joint_*:xform[in][leg]
matches the subport named leg
on the input variadic port xform on any node that starts with joint_
.
Functions ¶
APEX path pattern functions perform specific filtering operations on graphs, graph nodes, and ports. Functions are not used in the packed character format.
In the APEX path pattern syntax, functions are preceded by a “%
”, and can take in multiple arguments:
%<function>(<argument1>, <argument2>, ...)
Function |
Description |
---|---|
|
Operates on nodes. Finds all the graph nodes that have ancestor connections starting with the node specified in The The As a short form, you can use Examples:
|
|
Operates on nodes. Finds the graph nodes at all subnet levels that match the callback name Wildcards can be specified in |
|
Operates on nodes. Finds all the graph nodes that have descendant connections starting with the node specified in The The As a short form, you can use Examples:
|
|
Operates on nodes and ports. Finds all the nodes/ports that have connections. |
|
Operates on nodes and ports. Finds all the nodes/ports that are promoted as an input or output (connected to the graph’s input or output node). It also finds nodes and ports in nested subnets that are promoted up the chain to the top-level graph input or output node. |
|
Operates on nodes. Properties are stored in the The value of the property can be provided as an optional second argument. |
|
Operates on nodes and ports. Tags are stored in the Port tags are stored on graph nodes in the format Wildcards can be specified in There can be multiple entries within |
|
Operates on ports. Finds all the ports that have the value type Wildcards can be specified in |