Engine APIs (Python)

EngineRegistry

The Engine Registry Python API can be used to inspect and gain knowledge about how to use a particular engine and what its `EngineArgs`_ are.

class UsdProcessingEngine.EngineRegistry

Bases: pybind11_object

__init__() → None

describeEngine(engineName: str) → str

getAllEngineNames() → list

EngineArgsBuilder

A Wrapper to assist with creating EngineArgs. Useful for building your own custom NodeUsd Nodes.

class UsdProcessingEngine.EngineArgsBuilder(time: float = 0.0)

Bases: object

A class providing convenience for building engine args with a set time sample.

Parameters:

time (float, default: 0.0)

__init__(time: float = 0.0) → None

Initializes the convenience class.

Parameters:

time (float, default: 0.0) – The time to use when storing samples within this EngineArgBuilder. This is

used when setting values.

build() → dict[Token, dict[float, Value]]

Builds a dictionary from the data from this EngineArgsBuilder convenience class.

Returns:

dict[Token, dict[float, Value]] – Returns the internal args dict which this class is the convience for building.

keys() → list[Token]

Returns the current keys of this EngineArgsBuilder.

Return type:

list[Token]