OmniGraph Node omni.graph.nodes.GatherByPath

omni.graph.nodes.GatherByPath Properties

Name

Value

Version

1

Extension

omni.graph.nodes

Has State?

False

Implementation Language

C++

Default Memory Type

cpu

Generated Code Exclusions

None

uiName

Gather By Path (Prototype)

__categories

internal

Generated Class Name

OgnGatherByPathDatabase

Python Module

omni.graph.nodes

omni.graph.nodes.GatherByPath Description

Node to vectorize data by paths passed in via input. PROTOTYPE DO NOT USE. Requires GatherPrototype

omni.graph.nodes.GatherByPath Inputs

Name

Type

Default

Required?

Descripton

inputs:allAttributes

bool

True

Y

When true, all USD attributes will be gathered. Otherwise those specified by ‘attributes’ will be gathered.

__default

true

inputs:attributes

string

Y

A space-separated list of attribute names to be gathered when allAttributes is false

inputs:hydraFastPath

token

Disabled

Y

When not ‘Disabled’, will extract USD Geometry transforms into Hydra fast-path attributes. ‘World’ will add _worldPosition, _worldOrientation. ‘Local’ will add _localMatrix.

allowedTokens

Disabled,World,Local

__allowedTokens

[“Disabled”, “World”, “Local”]

__default

“Disabled”

inputs:primPaths

token[]

[]

Y

A list of Prim paths whose data should be vectorized

inputs:shouldWriteBack

bool

False

Y

Write the data back into USD if true.

uiName

Should Write Back To USD

__default

false

omni.graph.nodes.GatherByPath Outputs

Name

Type

Default

Required?

Descripton

outputs:gatherId

uint64

None

Y

The GatherId corresponding to this Gather, kInvalidGatherId if the Gather failed

outputs:gatheredPaths

token[]

None

Y

The list of gathered prim paths in gathered-order