Find Prims#
Finds Prims on the stage which match the given criteria
Installation#
To use this Node, you must enable omni.graph.nodes in the Extension Manager.
Inputs#
Name |
Type |
Description |
Default |
|---|---|---|---|
Prim Type Pattern (type) |
|
A list of wildcard patterns used to match the prim types that are to be imported Supported syntax of wildcard pattern: ‘’*’’ - match an arbitrary number of any characters ‘?’ - match any single character ‘^’ - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: [‘Mesh’, ‘Cone’, ‘Cube’] ‘’*’’ - match any ‘’*’ ^Mesh’ - match any, but exclude ‘Mesh’ ‘’*’ ^Cone ^Cube’ - match any, but exclude ‘Cone’ and ‘Cube’ |
|
Prim Path Pattern (pathPattern) |
|
A list of wildcard patterns used to match the prim paths Supported syntax of wildcard pattern: ‘’*’’ - match an arbitrary number of any characters ‘?’ - match any single character ‘^’ - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: [‘/Cube0’, ‘/Cube1’, ‘/Box’] ‘’*’’ - match any ‘’*’ ^/Box’ - match any, but exclude ‘/Box’ ‘’*’ ^/Cube’*’’ - match any, but exclude ‘/Cube0’ and ‘/Cube1’ |
|
Root Prim Path (rootPrimPath) |
|
Only children of the given prim will be considered. Empty will search the whole stage. |
|
Root Prim (rootPrim) |
|
Only children of the given prim will be considered. If rootPrim is specified, rootPrimPath will be ignored. |
|
Prim Name Prefix (namePrefix) |
|
Only prims with a name starting with the given prefix will be returned. |
|
Attribute Names (requiredAttributes) |
|
A space-separated list of attribute names that are required to be present on matched prims |
|
Relationship Name (requiredRelationship) |
|
The name of a relationship which must have a target specified by requiredRelationshipTarget or requiredTarget |
|
Relationship Prim Path (requiredRelationshipTarget) |
|
The path that must be a target of the requiredRelationship |
|
Relationship Prim (requiredTarget) |
|
The target of the requiredRelationship |
|
recursive |
|
False means only consider children of the root prim, True means all prims in the hierarchy |
|
ignoreSystemPrims |
|
Ignore system prims such as omni graph nodes that shouldn’t be considered during the import. |
False |
Outputs#
Name |
Type |
Description |
Default |
|---|---|---|---|
prims |
|
A list of Prim paths which match the given type |
|
primPaths |
|
A list of Prim paths as tokens which match the given type |