turret_usd

This library, turret_usd, provides a turretResolver class, which overrides USD's ArDefaultResolver. This uses the functionality provided in turret_lib to talk to a turret_server and allows custom URIs to be used within USD documents.

This is one of the projects which uses turret_lib, the other being turret_klf.

Building

We primarily support building with rez on Linux. However we do have prelimary support for windows and non-rez build systems.

For more information check out building.md

Usage

Environment Variables

turret_usd requires some environment variables to be set. These mainly depend on our rez contexts.

• PXR_PLUGINPATH_NAME=C:/Users/142738/software/turret-usd/plugin/usd
• PATH=%PATH%;C:/path/to/libzmq.dll;C:/path/to/turret-lib.dll

Windows

We only support running turret_usd on windows by having the turret_server running on a linux machine. Because of this you must specify the IP of the remote linux machine acting as a server.

• TURRET_SERVER_IP=172.22.15.55

Optional Environment Variables

• TURRET_USD_SUPPRESS_ASSET_NOT_FOUND
  • During USD stage initialisation, USD prints warnings for any missing assets that are encountered (i.e. unresolved references). When using Turret URIs to dynamically resolve USD paths regardless of if they exist (i.e. setting up multiple department layers for an asset description), many of these warnings can be generated. These warnings can actually cause a significant impact on performance in single-threaded contexts (such as Katana's render logging).
  • When this environment variable is set, turret_usd simply returns the USD file specified via the DEFAULT_USD environment variable rather than returning an empty path to the USD stage (by default an empty USD layer in this repo), suppressing these warnings. Only missing references using URIs matching Turret's schema will be suppressed, any other missing paths will still raise a warning.
• DEFAULT_USD
  • A path to a default USD file for turret_usd to return when a missing asset is encountered. Must be set when TURRET_USD_SUPPRESS_ASSET_NOT_FOUND is set.
  • By default this points to resources/DefaultUSD.usda in this repo.

Contributing

We use turret across almost every aspect of our USD pipeline and are constantly fixing bugs and finding time to improve turret more and more. We are however, very open to external pull-requests, and growing turret into a more versatile and robust piece of software with your help. Feel free to get in contact directly or through these GitHub repos. We'd love to talk!