Read Prims

Reads primitives and outputs multiple primitive in a bundle.

Installation

To use this Node, you must enable omni.graph.nodes in the Extension Manager.

Inputs

Name

Type

Description

Default

Prims (prims)

target

This input acts differently based on whether ‘useFindPrims’ is true or false. If true, it is the exact prims to be read from. If false, the prims’ descendants will be searched against all patterns and read from if matched. If no prims are connected, absolute root / will be searched instead.

Use Find Prims (useFindPrims)

bool

When true, the ‘pathPattern’ and ‘typePattern’ attribute is used as the pattern to search for the prims to read otherwise it will read the connection at the ‘prim’ attribute.

False

Prim Path Pattern (pathPattern)

string

A list of wildcard patterns used to match the prim paths 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: [‘/Cube0’, ‘/Cube1’, ‘/Box’] ‘’*’’ - match any ‘’*’ ^/Box’ - match any, but exclude ‘/Box’ ‘’*’ ^/Cube’*’’ - match any, but exclude ‘/Cube0’ and ‘/Cube1’

Prim Type Pattern (typePattern)

string

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’

Attribute Name Pattern (attrNamesToImport)

string

A list of wildcard patterns used to match the attribute names 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: [‘points’, ‘faceVertexCount’, ‘faceVertexIndices’, ‘size’] ‘’*’’ - match any ‘’*’ ^points’ - match any, but exclude ‘points’ ‘’*’ ^face’*’’ - match any, but exclude ‘faceVertexCount’ and ‘faceVertexIndices’

Time (usdTimecode)

timecode

The time at which to evaluate the transform of the USD prim. A value of NaN indicates that the default USD time stamp should be used

NaN

Compute Bounding Box (computeBoundingBox)

bool

For each primitive compute local bounding box and store them as ‘bboxMinCorner’, ‘bboxMaxCorner’ and ‘bboxTransform’ attributes.

False

Apply Skel Binding (applySkelBinding)

bool

If an input USD prim is skinnable and has the SkelBindingAPI schema applied, read skeletal data and apply SkelBinding to deform the prim. The output bundle will have additional child bundles created to hold data for the skeleton and skel animation prims if present. After evaluation, deformed points and normals will be written to the points and normals attributes, while non-deformed points and normals will be copied to the points:default and normals:default attributes.

False

Outputs

Name

Type

Description

Default

primsBundle

bundle

An output bundle containing multiple prims as children. Each child contains data attributes and two additional token attributes named sourcePrimPath and sourcePrimType which contains the path of the Prim being read