USD Schemas#
omniGraphSchema#
OmniGraph#
Base class for OmniGraph primitives containing the graph settings.
allowAutoInstancing#
A boolean that specifies whether or not the graph is allowed to be auto-instanced.
evaluationMode#
Token that describes under what circumstances the graph should be evaluated.
Automatic mode will evaluate the graph in Standalone mode when
no Prims having a relationship to it exist. Otherwise it will be
evaluated in Instanced mode.
Standalone mode evaluates the graph with itself as the graph
target, and ignores any Prims having relationships to the graph Prim.
Use this mode with graphs that are expected to run only once per frame
and use explicit paths to Prims on the stage.
Instanced graphs will only evaluate the graph when it is part of a
relationship from an OmniGraphAPI interface. Each Prim with a
relationship to the graph will cause a unique evaluation with the
graph target set to the path of the Prim having the relationship.
Use this mode when the graph represents an asset or template, and
parameterizes Prim paths through the use of the GraphTarget node,
variables, or similar mechanisms.
evaluator:type#
Type name for the evaluator used by the graph.
fabricCacheBacking#
Token that identifies the type of FabricCache backing used by the graph.
fileFormatVersion#
A pair of integers consisting of the major and minor versions of the file format under which the graph was saved.
pipelineStage#
Optional token which is used to indicate the role of a vector valued field. This can drive the data type in which fields are made available in a renderer or whether the vector values are to be transformed.
OmniGraphAPI#
Constructs an OmniGraphAPI on a UsdPrim.
OmniGraphNode#
Base class for OmniGraph nodes.
node:type#
Unique identifier for the name of the registered type for this node.
node:typeVersion#
Each node type is versioned for enabling backward compatibility. This value indicates which version of the node type definition was used to create this node. By convention the version numbers start at 1.
OmniGraphNodeType#
Abstract base class representing USD defined Node Types
omni:graph:categories#
The list of categories to display the node in
omni:graph:description#
Contains a description of the interfaces available on one or more OmniGraph Compute Nodes.
omni:graph:namespace#
Prefix used when registering a node type. The final name used to register a node type with OmniGraph will be the prim name prefixed with the namespace. The namespace can be used to prevent conflicts when importing node types from multiple layers.
omni:graph:uiName#
The name as it appears in the UI
OmniGraphCompoundNodeType#
Class representing USD defined Compound Node Type
omni:graph:categories#
The list of categories to display the node in
omni:graph:description#
Contains a description of the interfaces available on one or more OmniGraph Compute Nodes.
omni:graph:namespace#
Prefix used when registering a node type. The final name used to register a node type with OmniGraph will be the prim name prefixed with the namespace. The namespace can be used to prevent conflicts when importing node types from multiple layers.
omni:graph:tags#
Single value or list of value to use as tags on the node
omni:graph:uiName#
The name as it appears in the UI
OmniGraphCompoundNodeType_1#
Version 1 of the class representing USD defined Compound Node Type. Compound Node Types with this version define their inputs and outputs using the OmniGraphInputDefAPI and OmniGraphOutputDefAPI schemas on the associated graph prim.
omni:graph:categories#
The list of categories to display the node in
omni:graph:description#
Contains a description of the interfaces available on one or more OmniGraph Compute Nodes.
omni:graph:namespace#
Prefix used when registering a node type. The final name used to register a node type with OmniGraph will be the prim name prefixed with the namespace. The namespace can be used to prevent conflicts when importing node types from multiple layers.
omni:graph:tags#
Single value or list of value to use as tags on the node
omni:graph:uiName#
The name as it appears in the UI
OmniGraphCompoundNodeAPI#
API schema applied to an OmniGraphNode to indicate it is a compound container whose execution is defined by an OmniGraph.
omni:graph:compoundType#
Represents the type of the compound graph referenced by this Compound Node
OmniGraphInputDefAPI#
Multiple Apply API schema that can be applied to an OmniGraph to define an attribute definition for an input attribute. An attribute definition is a description of the attribute that will be generated when a compound node is instantiated that references this graph. The connection relationship is used to specify the promoted node attributes that will be connected from the instantiated node.
omniGraphInputDef:INSTANCE_NAME:allowedTokens#
Used only for attributes of type token and contains a list of the values that token is allowed to take.
omniGraphInputDef:INSTANCE_NAME:description#
Contains a description of the attribute. This is the value that will be applied to all attributes generated by this definition.
omniGraphInputDef:INSTANCE_NAME:literalOnly#
Indicates that the value of the attribute can only be set to a literal.
omniGraphInputDef:INSTANCE_NAME:type#
Specifies what type of data the generated attribute contains.
omniGraphInputDef:INSTANCE_NAME:uiName#
Used by the UI to present a more human-readable name for the generated attributes
omniGraphInputDef:INSTANCE_NAME:uiType#
Used to provide a hint to the property panel as to how the property should be displayed.
OmniGraphOutputDefAPI#
Multiple Apply API schema that can be applied to an OmniGraph to define an attribute definition for an output attribute. An attribute definition is a description of the attribute that will be generated when a compound node is instantiated that references this graph. The connection relationship is used to specify the promoted node attributes that will be connected from the instantiated node.
omniGraphOutputDef:INSTANCE_NAME:description#
Contains a description of the attribute. This is the value that will be applied to all attributes generated by this definition.
omniGraphOutputDef:INSTANCE_NAME:type#
Specifies what type of data the generated attribute contains.
omniGraphOutputDef:INSTANCE_NAME:uiName#
Used by the UI to present a more human-readable name for the generated attributes
omniGraphOutputDef:INSTANCE_NAME:uiType#
Used to provide a hint to the property panel as to how the property should be displayed.