OmniGraph Node omni.graph.nodes.ReadPrimBundle

omni.graph.nodes.ReadPrimBundle Properties

Name

Value

Version

1

Extension

omni.graph.nodes

Icon

ogn/icons/omni.graph.nodes.ReadPrimBundle.svg

Has State?

True

Implementation Language

C++

Default Memory Type

cpu

Generated Code Exclusions

None

uiName

Read Prim into Bundle

__tokens

[“sourcePrimPath”, “worldMatrix”, “bboxTransform”, “bboxMinCorner”, “bboxMaxCorner”]

__categories

sceneGraph,bundle

Generated Class Name

OgnReadPrimBundleDatabase

Python Module

omni.graph.nodes

omni.graph.nodes.ReadPrimBundle Description

Exposes the authored attributes for a single Prim on the USD stage as a bundle output on this node. When this node computes it will read the latest attribute values from the target Prim into the bundle attributes. It will also expose the world matrix if available under the attribute “worldMatrix”. It can optionally compute the bounding box of the prim, and expose it under the following attributes: “bboxTransform”, “bboxMinCorner”, “bboxMaxCorner”.

omni.graph.nodes.ReadPrimBundle Inputs

Name

Type

Default

Required?

Descripton

inputs:computeBoundingBox

bool

False

Y

Compute and store local bounding box of a prim and its children.

__default

false

inputs:prim

bundle

None

The prim whose attributes are to be read

inputs:primPath

token

None

The path of the prim to be read when ‘usePath’ is true

inputs:usdTimecode

timecode

-1

Y

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

__default

-1

inputs:usePath

bool

False

Y

When true, the ‘primPath’ attribute is used as the path to the prim being read, otherwise it will read the connection at the ‘prim’ attribute

__default

false

omni.graph.nodes.ReadPrimBundle Outputs

Name

Type

Default

Required?

Descripton

outputs:primBundle

bundle

None

Y

A bundle of the source Prim attributes. In addition to the data attributes, there is a token attribute named sourcePrimPath which contains the path of the Prim being read

omni.graph.nodes.ReadPrimBundle State

Name

Type

Default

Required?

Descripton

state:target

uint64

0

Y

The path ID of the targeted prim last frame

__default

0

state:usdTimecode

timecode

-1

Y

The time at which previous run has been evaluated

__default

-1