On this page |
This page lists the metadata that are available on graph nodes and ports.
Tags ¶
Properties ¶
Properties on graph nodes store custom information that could be used at a later point in the graph. They are stored in a dictionary attribute called properties
. You can add and modify data in the properties
dictionary using graph::UpdateNode and graph::UpdateNodeProperties. You can also filter for properties using the APEX path pattern function %properties()
in graph nodes like graph::FindNodes.
Note
Properties are only used for nodes; there are no port properties.
To view the properties on a graph node:
-
In the network view, select the node that contains the graph.
-
In the geometry spreadsheet, select Points on the top toolbar.
-
click the entry under the properties column and select Inspect to view the properties dictionary.
In addition to the custom information added by a user, the properties
dictionary can also contain predefined entries that store information on control shapes, rig parameter limits, and rig/skeleton mapping. Users can also use and modify this information. The predefined entries are:
{ control: { color: Vector3 shapeoffset: Matrix4 shapeoverride: String visibility: Int } max:<parameter_name>: Vector3 min:<parameter_name>: Vector3 max_lock:<parameter_name>: Vector3 min_lock:<parameter_name>: Vector3 mapping:<skeleton or rig>: String }
The mapping
property can be set using the APEX Map Character SOP, and the other properties can be set using the APEX Configure Controls SOP.
Property |
Type |
Description |
---|---|---|
control |
|
A dictionary that contains information on how the control looks in the viewport. |
color |
|
The color of the control. |
shapeoffset |
|
The position of the control. |
shapeoverride |
|
The shape of the control. |
visibility |
|
Whether the control is visible in the animate state. |
max, min |
|
A soft limit on the rig transform parameters. The Vector3 values are the limits on the x, y, and z values of the parameter. The user can control whether or not to enforce the limits or use the limits as a visual indicator in the animate state. See transform limits for more information. The format of the max and min properties is:
|
max_lock, min_lock |
|
A hard limit on the rig transform parameters. The Vector3 values are the limits on the x, y, and z values of the parameter. This cannot be turned off in the animate state. See transform limits for more information. The format of the max_lock and min_lock properties is:
|
mapping |
|
Specifies the mapping between rigs/skeletons to TransformObject nodes. This is useful for mapping skeleton joints to controls, or in the case where one rig drives another, mapping the controls between two rigs. This mapping information is stored on the TransformObject node. The format of the mapping property is:
|
An example of the predefined entries in the properties
dictionary:
{ "control":{ "color":[0.5,0,1], "shapeoffset":[0.3,0,0,0,0,0.3,0,0,0,0,0.3,0,0,0,0,1], "shapeoverride":"torus", "visibility":1 }, "max:t":[5, 5, 5], "min:t":[-5, -5, -5], "max_lock:t":[10, 10, 10] "min_lock:t":[-10, -10, -10], "mapping:Base.skel":"lowerarm_l" }
Attributes ¶
APEX graph geometry have the following attributes:
Name |
Class |
Type |
Description |
---|---|---|---|
|
point |
|
The name of the node. |
|
point |
|
The callback name (node type) of the node. |
|
point |
|
The color of the node. |
|
vertex |
|
The name of the port. |
|
vertex |
|
The subport name or renamed ports. |
|
vertex |
|
The index number of the port. |
|
point |
|
A dictionary of default values for the ports. |
point |
|
An array of strings that are used as identifiers for graph nodes. Tags can be matched using the APEX path pattern function |
|
point |
|
A dictionary of additional metadata on the node. Properties can be matched using the APEX path pattern function |
Callbacks ¶
There are special callback names for some of the graph elements:
Node |
Callback name |
---|---|
Graph input node |
|
Graph output node |
|
Subnet |
|
Sticky note |
|