Find Prims
Finds Prims on the stage which match the given criteria
Installation
To use this node enable omni.graph.nodes in the Extension Manager.
Inputs
Name |
Type |
Descripton |
Default |
|---|---|---|---|
Ignore System Prims (inputs:ignoreSystemPrims) |
|
Ignore system prims such as omni graph nodes that shouldn’t be considered during the import. |
False |
Prim Name Prefix (inputs:namePrefix) |
|
Only prims with a name starting with the given prefix will be returned. |
|
Prim Path Pattern (inputs: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’ |
|
Recursive (inputs:recursive) |
|
False means only consider children of the root prim, True means all prims in the hierarchy |
False |
Attribute Names (inputs:requiredAttributes) |
|
A space-separated list of attribute names that are required to be present on matched prims |
|
Relationship Name (inputs:requiredRelationship) |
|
The name of a relationship which must have a target specified by requiredRelationshipTarget or requiredTarget |
|
Relationship Prim Path (inputs:requiredRelationshipTarget) |
|
The path that must be a target of the requiredRelationship |
|
Relationship Prim (inputs:requiredTarget) |
|
The target of the requiredRelationship |
None |
Root Prim (inputs:rootPrim) |
|
Only children of the given prim will be considered. If rootPrim is specified, rootPrimPath will be ignored. |
None |
Root Prim Path (inputs:rootPrimPath) |
|
Only children of the given prim will be considered. Empty will search the whole stage. |
|
Prim Type Pattern (inputs: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’ |
Outputs
Name |
Type |
Descripton |
Default |
|---|---|---|---|
Prim Paths (outputs:primPaths) |
|
A list of Prim paths as tokens which match the given type |
None |
Prims (outputs:prims) |
|
A list of Prim paths which match the given type |
None |
State
Name |
Type |
Descripton |
Default |
|---|---|---|---|
Ignore System Prims (state:ignoreSystemPrims) |
|
last corresponding input seen |
None |
Input Type (state:inputType) |
|
last corresponding input seen |
None |
Name Prefix (state:namePrefix) |
|
last corresponding input seen |
None |
Path Pattern (state:pathPattern) |
|
last corresponding input seen |
None |
Recursive (state:recursive) |
|
last corresponding input seen |
None |
Required Attributes (state:requiredAttributes) |
|
last corresponding input seen |
None |
Required Relationship (state:requiredRelationship) |
|
last corresponding input seen |
None |
Required Relationship Target (state:requiredRelationshipTarget) |
|
last corresponding input seen |
None |
Required Target (state:requiredTarget) |
|
last corresponding input seen |
None |
Root Prim (state:rootPrim) |
|
last corresponding input seen |
None |
Root Prim Path (state:rootPrimPath) |
|
last corresponding input seen |
None |
Metadata
Name |
Value |
|---|---|
Unique ID |
omni.graph.nodes.FindPrims |
Version |
2 |
Extension |
omni.graph.nodes |
Has State? |
True |
Implementation Language |
C++ |
Default Memory Type |
cpu |
Generated Code Exclusions |
None |
uiName |
Find Prims |
Categories |
sceneGraph |
Generated Class Name |
OgnFindPrimsDatabase |
Python Module |
omni.graph.nodes |