Upload 253 files

1_0_0_48.md

@@ -0,0 +1,56 @@
+
+
+1.00.48 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.00.48
+
+ 
+
+# 1.00.48
+
+Release Date: Feb 2021
+
+## New Features
+
+News tab – shows the latest information about Omniverse
+Show Nucleus Web on the collaboration tab
+Improved keyboard navigation and accessibility
+Update info for installed apps and connectors automatically when the library tab is opened
+Improved the drag area for the main window
+Remove failed installers from the installation queue automatically
+Added a button to clear the search input
+Added a button to open logs location
+Allow users to copy notification text
+Hide Launcher when started with the system
+Change the bell color to red if notifications contain errors
+Added a header for error notifications
+Added a link to show open-source licenses used in the launcher
+Create a user session in System Monitor after Nucleus is installed
+Show loading indicators and errors on the startup window
+
+## Improvements
+
+Fixed installation controls were not clickable
+Ignore OS errors during the installation cancel
+Fixed problems with loading internal launcher settings
+Fixed problems with initialization during the authentication
+Fixed a bug where users went back in collaboration tab and saw ‘null’ instead of a data path
+Fixed a bug where users got redirected to a broken Nucleus page when clicked on a notification
+Fixed left spacing in component details on the exchange tab
+Fixed issues with invalid usernames specified during the installation of the collaboration service
+Fixed users were not prompted to select data paths or install Cache
+Fixed previous Cache versions were not deleted automatically after updates
+Fixed the launch button on the library tab displaying “Up to date” when update is available
+Fixed “Cancel” button was visible when installing components
+Fixed text overflow in the installation progress
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_0_42.md

@@ -0,0 +1,28 @@
+
+
+1.0.42 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.0.42
+
+ 
+
+# 1.0.42
+
+Release Date: Jan 2021
+
+Added News section to display content from Omniverse News in the launcher
+Fixed collecting hardware info on Linux when lshw returns an array
+Add a login session in System Monitor when Nucleus is installed
+Moved all licenses to PACKAGE-LICENSES folder, added a LICENSES link to the about dialog
+Fixed user was not prompted to select data paths or install Cache
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_0_50.md

@@ -0,0 +1,31 @@
+
+
+1.0.50 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.0.50
+
+ 
+
+# 1.0.50
+
+Release Date: March 2021
+
+## Fixed
+
+Catch unexpected Starfleet responses and return the error that tells users to log in.
+Fixed licenses link not working on Linux.
+
+## Removed
+
+Remove debug noise in logs from the auto-updater.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_1_2.md

@@ -0,0 +1,65 @@
+
+
+1.1.2 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.1.2
+
+ 
+
+# 1.1.2
+
+Release Date: March 2021
+
+## Spotlight Features
+
+New “Learn Tab” available in launcher lets you get quick and immediate “in-launcher” access to our video learning portal.  From Introductory content for the beginner to highly focused deep dives for the experienced, Omniverse Learning Videos are now just a click away.
+
+## New Capabilities
+
+Show available updates for components on the exchange tab.
+Show component versions in the list view on the exchange tab.
+Added omniverse-launcher://exit command to close the launcher.
+Register a custom protocol handler on Linux automatically.
+HTTP API to get the current authentication info.
+HTTP API to get a list of installed components and their settings.
+Added Learn tab.
+Added new options to group and sort content on the exchange tab.
+Added the list view for components on the exchange tab.
+Use omniverse-launcher:// custom protocol to accept commands from other apps.
+Added the telemetry service for events from external applications.
+
+## Fixed/Altered
+
+Changed the aspect ratio of images used in component cards to be 16:9.
+Fixed focusing the search bar automatically when nothing was typed in the input.
+Fixed reinstalling components that were marked as installed after a restart.
+Changed the gap between cards on the Exchange tab using the grid view.
+Fixed refreshing News and Learn pages when users click on the header tabs.
+Fixed News and Learn links to load webpages without headers and footers.
+Fixed the scrollbar on the Exchange tab not working correctly when dragged with a mouse.
+Fixed clicking area for the notification bell.
+Fixed Nucleus showing up in the library.
+Fixed “Uninstall” button position in component settings dialog.
+Fixed the search input losing focus after typing.
+Fixed losing the search filters after selecting a card on the exchange tab.
+Changed how content is structured and searched on the exchange tab – moved Apps and Connectors categories to the left menu.
+Improved the load speed and performance on the exchange tab.
+Show placeholder in the installation queue if no downloads are queued.
+Load messages displayed in the footer from the server.
+Match the font size used for links in the settings dialog.
+Updated links on Collaboration tab.
+Fixed extracting files from zip archives with a read-only flag on Windows.
+Fixed error that crashed browser page and didn’t let users log in.
+Fixed showing invalid error messages in the exchange tab when Starfleet returns unexpected response body.
+Fixed expiration of the authentication token.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_2_8.md

@@ -0,0 +1,92 @@
+
+
+1.2.8 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.2.8
+
+ 
+
+# 1.2.8
+
+Release Date: Aug 2021
+
+## Spotlight Features
+
+Previous Versions
+Users can now install previous version of Omniverse via a new and improved interface.
+
+Easy Links
+When opening files for the first time from a linked location, launcher now confirms the app to load with.
+
+Users can also set the default app manually in settings.
+
+## Added
+
+Allow to customize system requirements for installable components.
+Display a notification when applications are successfully uninstalled.
+Added a smooth transition animation for the library tab.
+Added thin packaging support - allows splitting large components into smaller packages that can be reused.
+Added “Exit” button to the user menu.
+Support installing previous versions of applications and connectors.
+Added new dialog to select the default application used to open Omniverse links.
+Support markdown for component description.
+Show an error message on startup if Launcher can’t read the library database file.
+
+## Changed
+
+Scale side menu on the exchange tab based on the screen size.
+Updated Starfleet integration to use name instead of preferred_username.
+Renamed Download Launcher button to Download Enterprise Launcher
+Display “News” tab inside of Launcher.
+Use thumbnail images on the exchange tab to optimize page load time.
+Disable Launch button for three seconds after click to prevent launching apps multiple times.
+Display an error when iframes can’t load the external web page.
+Update privacy settings on a new login.
+Renamed “Collaboration” tab to “Nucleus”.
+Updated “News” and “Learn” links to hide the website header.
+Support tables and headers for component description via Markdown and HTML.
+Changed the inactive tab color on the library tab.
+Made Launcher errors more readable.
+“News” and “Learn” tabs open a web browser now instead of showing these pages in iframes.
+
+## Fixed
+
+Fixed issues where users could install or update the same app more than once.
+Fixed resizing of the main window at the top.
+Fixed issues with scrolling the exchange tab when the featured section is available.
+Fixed showing the main window on system startup (Launcher will be hidden in the system tray).
+Ignore system errors when Launcher removes installed components.
+Fixed an issue when users could not change their current account without a reboot.
+Fixed race condition when users rapidly click on the installer pause button multiple times.
+Fixed an issue with installers not queueing up in the correct order.
+Fixed missing vendor prefix for desktop files on Linux to register a custom protocol handler.
+Fixed issues with floating carousel images for featured components.
+Preserve unknown fields in privacy.toml file.
+Invalidate cached HTTP responses on a startup.
+Fixed issues with cached URLs for loading applications and their versions.
+Fixed installing previous versions of applications that don’t support side-by-side installations.
+Fixed thin package installer did not create intermediate folders for installed packages.
+Refresh auth tokens when external apps query /auth endpoint.
+Fixed displaying loading state on the Nucleus tab if Nucleus installer fails.
+Fixed issue with components not been marked as installed.
+Fixed sorting of exchange components in the left menu.
+Fixed displaying hidden components on the library tab after installation.
+Allow Launcher to start without downloading the GDPR agreement if it’s accepted already.
+Fixed running applications that require the finalize script after install.
+Fixed running applications that require the finalize script after install.
+
+## Removed
+
+Launcher Cleanup tool disabled from running during uninstall/reinstall in Windows.
+Removed OS and Video Driver from system requirements.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_3_3.md

@@ -0,0 +1,42 @@
+
+
+1.3.3 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.3.3
+
+ 
+
+# 1.3.3
+
+Release Date: Oct 2021
+
+## Added
+
+Added the OS version to com.nvidia.omniverse.launcher.session telemetry event.
+Added the locale to com.nvidia.omniverse.launcher.session telemetry event.
+Added “Developer” and “Publisher” fields to component details.
+Show “Welcome to Omniverse” page on the first launch.
+Support installing the Enterprise Launcher to a shared location on Linux.
+
+## Fixed
+
+Fixed an issue where “Add Connector” button was pointing to the wrong location on the Exchange tab.
+Fixed an issue where the default Omniverse app was not reset after its last version is uninstalled.
+Fixed an issue where the startup component didn’t react on the background authentication.
+Fixed an issue where installers that were initiated from the library tab ignored the current queue and started a download immediately.
+Fixed Japanese translations.
+Fixed an issue that caused a delay for queuing new installers.
+Fixed an issue where components were added to the library before they were registered by scripts.
+Fixed an issue where component platforms were determined incorrectly if thin packaging is used.
+Fixed an issue where installers used incorrect path with the latest component version instead of the specified version.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_3_4.md

@@ -0,0 +1,34 @@
+
+
+1.3.4 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.3.4
+
+ 
+
+# 1.3.4
+
+Release Date: Oct 2021
+
+## Added
+
+Show the installation date for apps displayed on the library tab.
+Added “Collect debug info” button to the settings dialog to prepare a tarball with logs and configuration files.
+Show “External link” button for third-party components on the detailed page.
+
+## Fixed
+
+Fixed an issue where links on the “Learn” tab didn’t work after watching a video.
+Fixed showing the latest component version instead of the currently installed version on the library tab.
+Fixed an issue with dangling installers in the queue.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_4_0.md

@@ -0,0 +1,37 @@
+
+
+1.4.0 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.4.0
+
+ 
+
+# 1.4.0
+
+Release Date: Nov 2022
+
+## Changed
+
+Added retries for downloading EULA and GDPR agreements.
+
+## Fixed
+
+Fixed an issue with scrolling the left menu on the exchange tab.
+Fixed an issue where Launcher dialogs were displayed behind the exchange view after navigation.
+Fixed an issue where thin packages could not install correctly if the file system had dangling symlinks.
+Remove all unused packages on the startup.
+Fixed an issue where failed updates changed the latest registered app version in the library.
+Fixed an issue where scheduling two installers could not finish the download if authentication needs to be refreshed.
+Fixed an issue with collecting hardware info on Windows 11.
+Fixed sending multiple simultaneous session events.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_5_1.md

@@ -0,0 +1,39 @@
+
+
+1.5.1 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.5.1
+
+ 
+
+# 1.5.1
+
+Release Date: Jan 2022
+
+## Added
+
+Launcher can now pull notifications from the server. This can be used to send important messages to users instead of displaying them in the toolbar.
+
+## Changed
+
+Changed colors for messages displayed in the bottom toolbar (white for regular text and blue for links instead of yellow).
+
+## Fixed
+
+Escape desktop entry path on Linux for opening custom protocol links.
+Fixed an issue where News and Learn tabs were refreshed when Launcher lost or regained focus.
+Increased the default window size to fit the cache path in the Launcher settings.
+Raise an error when users try to install components that are already installed.
+Raise an error when users try to launch components that are not installed.
+Fixed an issue where some packages couldn’t be moved to the right location by offline installer.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_5_3.md

@@ -0,0 +1,34 @@
+
+
+1.5.3 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.5.3
+
+ 
+
+# 1.5.3
+
+Release Date: March 2022
+
+## Added
+
+Added a check argument for omniverse-launcher://install command that manages throwing an error in case the same component is already installed.
+Support external links for third-party content.
+
+## Fixed
+
+Fixed an issue where downloaded zip archives were not removed when the installer is cancelled.
+Improved Italian localization.
+Fixed an issue where licenses were required for third-party content.
+Fixed an issue where problematic components could crash the application.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_5_4.md

@@ -0,0 +1,30 @@
+
+
+1.5.4 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.5.4
+
+ 
+
+# 1.5.4
+
+Release Date: April 2022
+
+## Fixed
+
+Fixed an issue where users couldn’t change configured paths in Launcher.
+Fixed Italian translations.
+Fixed an issue where Launcher couldn’t be started if System Monitor is installed but missing on disk.
+Fixed an issue where connector updates were started immediately instead of being queued on the library tab.
+Fixed an issue where components couldn’t be found by full names and tags on the Exchange tab.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_5_5.md

@@ -0,0 +1,30 @@
+
+
+1.5.5 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.5.5
+
+ 
+
+# 1.5.5
+
+Release Date: June 2022
+
+## Fixed
+
+Fixed an issue related to refreshing the session when installing new apps after desktop comes out of sleep mode.
+Fixed an issue where connectors displayed in the library were enlarged.
+Fixed an issue related to a blank error when Launcher is started without internet connection.
+Fixed an issue where “Data collection and use” did not reset the language on dialog cancel.
+Fixed an issue where trailing slashes were omitted when Launcher opened omniverse:// links.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_5_7.md

@@ -0,0 +1,35 @@
+
+
+1.5.7 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.5.7
+
+ 
+
+# 1.5.7
+
+Release Date: May 2023
+
+## Added
+
+Added new controls for changing the current language on the login screen.
+Added the Extensions content type in the Exchange.
+
+## Fixed
+
+Fixed an issue where the close icon closed Launcher instead of hiding it to the system tray.
+Removed the crash reporter logging when using custom protocol commands.
+Fixed an issue that caused a crash when Launcher failed to collect hardware info.
+Fixed an issue where connectors were sometimes duplicated after the installation.
+Fixed an issue where “Add connector” button on the Library tab opened a blank page.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_6_1.md

@@ -0,0 +1,47 @@
+
+
+1.6.10 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.6.10
+
+ 
+
+# 1.6.10
+
+Release Date: Sept 2022
+
+## Added
+
+Integrated Navigator filesystem directly into the Nucleus tab.
+Added “Show in folder” option for downloaded files in Navigator.
+Extension installation.
+/open command for opening files with installed applications.
+Added links for Nucleus Cache in the library.
+Display an icon for external packages on the Exchange tab.
+Added new UI for Omniverse Drive 2.
+Added Ukrainian language translations to locale.
+
+## Fixed
+
+Updated dependencies to address minor potential security vulnerabilities.
+Improved error reporting when files are used by other processes.
+Fixed an issue where pressing Enter closed modal dialogs.
+Fixed selecting all notifications when users click on the notification bell.
+Fixed “Invalid time value” error displayed for some OS locales on startup.
+Fixed an issue where Launcher displayed dates in different formats on the Library tab.
+Fixed scrolling the language selection in the settings displayed during the first installation.
+Fixed triggering Google Translate dialog on the login result page.
+Fixed displaying user settings and notifications behind Nucleus installation dialog.
+Fixed an issue where Launcher couldn’t download new updates after the first downloaded patch.
+Fixed translations.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_7_1.md

@@ -0,0 +1,28 @@
+
+
+1.7.1 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.7.1
+
+ 
+
+# 1.7.1
+
+Release Date: Dec 2022
+
+## Added
+
+Renamed Enterprise Launcher to IT Managed Launcher.
+Added new UI elements on Exchange cards to filter releases by release channel. A release is classified as Alpha, Beta, Release, or Enterprise, depending on its maturity and stability. If an Alpha or Beta release is selected, a banner appears on the main image to emphasize the relative risk of that release. Alpha or Beta releases may not be feature complete or fully stable. Versions classified as Release (also known as GA or General Availability) are feature complete and stable. Release versions that are supported for Enterprise customers appear in the Enterprise list.
+Added /settings HTTP API for GET requests for the Launcher settings.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_8_11.md

@@ -0,0 +1,38 @@
+
+
+1.8.11 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.8.11
+
+ 
+
+# 1.8.11
+
+Release Date: July 2023
+
+## Changed
+
+Updated Nucleus tab with Navigator 3.3.2.
+Display “Install” button for new versions in the setting menu on the Library tab.
+Extend omniverse-launcher://launch command to support custom launch scripts.
+
+## Fixed
+
+Fixed an issue where users were unable to exit from Launcher via UI when not authenticated.
+Fixed incorrect links displayed in GDPR/EULA error.
+Add retries for pulling component versions during installations.
+Fixed an issue where Launcher raised an error during installation if installed package printed too many messages.
+Amend Italian and Korean translation strings.
+Fixed the beta banner displayed with the carousel.
+Fixed an issue where Launcher didn’t remember command line arguments specified for AppImage.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_8_2.md

@@ -0,0 +1,27 @@
+
+
+1.8.2 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.8.2
+
+ 
+
+# 1.8.2
+
+Release Date: Dec 2022
+
+## Added
+
+Added new UI elements on Exchange cards to filter releases by release channel. A release is classified as Alpha, Beta, Release, or Enterprise, depending on its maturity and stability. If an Alpha or Beta release is selected, a banner appears on the main image to emphasize the relative risk of that release. Alpha or Beta releases may not be feature complete or fully stable. Versions classified as Release (also known as GA or General Availability) are feature complete and stable. Release versions that are supported for Enterprise customers appear in the Enterprise list.
+Added release classification labels and Beta banner (when applicable) to the Library tab.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_8_7.md

@@ -0,0 +1,32 @@
+
+
+1.8.7 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.8.7
+
+ 
+
+# 1.8.7
+
+Release Date: May 2023
+
+## Added
+
+Show Nucleus update version on the Nucleus tab.
+Added a Data Opt-In checkbox allowing users to opt-in and opt-out of data collection.
+Display Cache version in the library.
+
+## Fixed
+
+Updated Nucleus tab with Navigator 3.3.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_9_10.md

@@ -0,0 +1,56 @@
+
+
+1.9.10 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.9.10
+
+ 
+
+# 1.9.10
+
+Release Date: Jan 2024
+
+## Added
+
+Anonymize telemetry events when users opt out of data collection.
+Support feature targeting by OS, Launcher version, build or user profile.
+Update Nucleus Navigator to 3.3.4.
+Support silent launch for custom protocol commands.
+
+## Changed
+
+Enabled “Newest” sorting for the Exchange tab by default.
+
+## Fixed
+
+Fixed an issue where Launcher did not bring its main window to the front when Launcher opened a second instance.
+Fixed an issue where Launcher closed the application when its main window was closed from the taskbar.
+Fixed an issue where Launcher installation might hang before running installation scripts.
+Fixed an issue where Hub settings represented incorrect information in the UI.
+Fixed an issue where Navigator did not refresh its server list after Nucleus installation.
+Fixed an issue where Nucleus installation was displayed on top of other UI elements.
+Fixed an issue where closing the main window in IT Managed Launcher closed the entire application.
+Fixed a crash in IT Managed Launcher when a user opens a Nucleus tab without internet connection.
+Users are now redirected to the library page when Nucleus is uninstalled in IT Managed Launcher.
+Fixed an issue with the version drop-down arrow displayed incorrectly.
+Validated email input on the login screen.
+Fixed an issue where the email field was not updated in privacy.toml after users sign in.
+Fixed an incorrect error translation for Czech language.
+Fixed an issue where the dialog close icon was not clickable when the scroll bar was displayed.
+Fixed an issue where the uninstall notification did not include the component version.
+Fixed an issue where Launcher could not register the first Nucleus account.
+
+## Security
+
+Fix for CVE-2023-45133.
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_9_11.md

@@ -0,0 +1,38 @@
+
+
+1.9.11 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.9.11
+
+ 
+
+# 1.9.11
+
+Release Date: April 2024
+
+# Fixed
+
+Fixed an issue where Launcher was minimized to the system tray instead of exiting when users clicked on Exit option in user settings menu.
+Fixed a race condition that could cause settings reset. [OM-118568]
+Fixed gallery positioning for content packs. [OM-118695]
+Fixed beta banner positioning on the Exchange tab. [OM-119105]
+Fixed an issue on the Hub page settings that caused showing “infinity” in disk chart for Linux. [HUB-965]
+Fixed cache size max validations on Hub page settings tab. [OM-119136]
+Fixed cache size decimal points validations on Hub page settings tab. [OM-119335]
+Fixed Hub Total Disk Space chart to not allow available disk space to become negative. [HUB-966]
+Fixed an issue on the Hub page settings that caused showing “infinity” in disk chart for Linux. [HUB-965]
+Fixed an issue on the Hub page settings that cause cache size not to be displayed. [HUB-960]
+Fixed an issue on the Hub page settings preventing editing Cleanup Threshold. [OM-119137]
+Fixed Hub page settings chart drive/mount detection size based on cache path. [HUB-970]
+Replace Omniverse Beta license agreement text with NVIDIA License and add license agreement link in the About dialog. [OM-120991]
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

1_9_8.md

@@ -0,0 +1,82 @@
+
+
+1.9.8 — Omniverse Launcher latest documentation
+
+Omniverse Launcher
+
+ »
+Omniverse Launcher »
+Release Notes »
+1.9.8
+
+ 
+
+# 1.9.8
+
+Release Date: Nov 2023
+
+## Added
+
+Featured Collections section added to the Exchange tab.
+Collection Side Nav expanded by default in Exchange tab.
+Pass proxy settings to launched applications with OMNI_PROXY_SERVER environment variable.
+Add custom UI for Omniverse Hub app.
+Add window titles for News and Learn tabs.
+Block user navigation on the Nucleus tab if Navigator tasks are active.
+Support displaying server notifications until a specific date.
+Support sending server notifications for specific platforms or Launcher versions.
+Add splash notifications displayed as a modal dialog.
+
+## Changed
+
+Update Nucleus Navigator to 3.3.3.
+Updated the UI for collection menu on the Exchange tab.
+Updated the suggestion for installing the default Omniverse application.
+Updated IT Managed Web Launcher Documentation tab to be a link to online omniverse documentation.
+Changed the default page to Library for IT Managed Launcher.
+Updated the look for featured collections.
+Updated the look for the side menu on the Exchange tab (only display categories).
+
+## Fixed
+
+Display an error when user tries to delete version that is not installed.
+Fixed an issue that displayed an Update button for installed connectors and apps in IT Managed Launcher.
+Fixed an issue where “New” badges were displayed incorrectly for IT Managed Launcher.
+Fixed displaying duplicate connectors after installing with IT Managed Launcher.
+Fixed displaying a spinner for connectors page in IT Managed Launcher.
+Fixed displaying applications and connectors on the Library tab after calling omniverse-launcher://uninstall command.
+Fixed an issue when uninstall notification was not shown if triggered by omniverse-launcher://uninstall command.
+Fixed an issue where filtering content by collections that do not exist could crash the application.
+Fixed an issue where tags were not displayed for components on the Exchange tab.
+Fixed displaying regular notifications instead of errors if installer returned an empty error message.
+Fixed displaying Cache installation suggestion in IT Managed Launcher.
+Fixed an issue with webview links not opening in a browser window.
+Fixed an issue where IT Managed Launcher didn’t work without internet connection.
+Fixed an issue where custom protocol commands args were persisted to Linux .desktop files.
+Fixed an issue where Collaboration packages were not displayed on the Enterprise portal.
+Disable bringing IT Managed Launcher in front of other apps when custom protocol commands are used.
+Fixed issues with focusing input elements inside modal dialogs.
+Fixed an issue where login result page opened Launcher or brought it in front of other applications.
+Fixed opening Nucleus settings from the menu on the Nucleus tab.
+Fixed incorrect coloring for the beta banner.
+Fixed an issue where buttons and pagination controls could be scrolled in the version dialog.
+Fixed an issue where autostart registry keys were kept after uninstall.
+Fixed the color for the name displayed in the channel dropdown.
+Fixed an issue where Launcher API wasn’t hosted on 127.0.0.1.
+Fixed an issue where users could not close modal dialogs.
+Fixed an issue where the beta overlay was displayed compressed sometimes.
+Fixed an issue where UI and Navigator logs were not being saved to a log file.
+Fixed an issue blocking custom protocol commands on Ubuntu.
+Use 127.0.0.1 address for registering new account during Nucleus installation.
+
+## Security
+
+Fix for CVE-2023-5217
+Fix for CVE-2023-4863
+Fix for CVE-2023-44270
+
+© Copyright 2023-2024, NVIDIA.
+      Last updated on Apr 15, 2024.
+      
+
+

Ar.md

@@ -0,0 +1,446 @@
+
+
+Ar module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+Ar module
+
+ 
+
+# Ar module
+
+Summary: The Ar (Asset Resolution) library is responsible for querying, reading, and writing asset data.
+
+Classes:
+
+DefaultResolver
+Default asset resolution implementation used when no plugin implementation is provided.
+
+DefaultResolverContext
+Resolver context object that specifies a search path to use during asset resolution.
+
+Notice
+
+ResolvedPath
+Represents a resolved asset path.
+
+Resolver
+Interface for the asset resolution system.
+
+ResolverContext
+An asset resolver context allows clients to provide additional data to the resolver for use during resolution.
+
+ResolverContextBinder
+Helper object for managing the binding and unbinding of ArResolverContext objects with the asset resolver.
+
+ResolverScopedCache
+Helper object for managing asset resolver cache scopes.
+
+Timestamp
+Represents a timestamp for an asset.
+
+class pxr.Ar.DefaultResolver
+Default asset resolution implementation used when no plugin
+implementation is provided.
+In order to resolve assets specified by relative paths, this resolver
+implements a simple”search path”scheme. The resolver will anchor the
+relative path to a series of directories and return the first absolute
+path where the asset exists.
+The first directory will always be the current working directory. The
+resolver will then examine the directories specified via the following
+mechanisms (in order):
+
+The currently-bound ArDefaultResolverContext for the calling
+thread
+ArDefaultResolver::SetDefaultSearchPath
+The environment variable PXR_AR_DEFAULT_SEARCH_PATH. This is
+expected to be a list of directories delimited by the platform’s
+standard path separator.
+
+ArDefaultResolver supports creating an ArDefaultResolverContext via
+ArResolver::CreateContextFromString by passing a list of directories
+delimited by the platform’s standard path separator.
+Methods:
+
+SetDefaultSearchPath
+classmethod SetDefaultSearchPath(searchPath) -> None
+
+static SetDefaultSearchPath()
+classmethod SetDefaultSearchPath(searchPath) -> None
+Set the default search path that will be used during asset resolution.
+This must be called before the first call to ArGetResolver. The
+specified paths will be searched in addition to, and before paths
+specified via the environment variable PXR_AR_DEFAULT_SEARCH_PATH
+
+Parameters
+searchPath (list[str]) – 
+
+class pxr.Ar.DefaultResolverContext
+Resolver context object that specifies a search path to use during
+asset resolution. This object is intended for use with the default
+ArDefaultResolver asset resolution implementation; see documentation
+for that class for more details on the search path resolution
+algorithm.
+Example usage:
+ArDefaultResolverContext ctx({"/Local/Models", "/Installed/Models"});
+{
+    // Bind the context object:
+    ArResolverContextBinder binder(ctx);
+
+   // While the context is bound, all calls to ArResolver::Resolve
+   // (assuming ArDefaultResolver is the underlying implementation being
+   // used) will include the specified paths during resolution.
+   std::string resolvedPath = resolver.Resolve("ModelName/File.txt")
+}
+
+// Once the context is no longer bound (due to the ArResolverContextBinder
+// going out of scope), its search path no longer factors into asset
+// resolution.
+
+Methods:
+
+GetSearchPath()
+Return this context's search path.
+
+GetSearchPath() → list[str]
+Return this context’s search path.
+
+class pxr.Ar.Notice
+Classes:
+
+ResolverChanged
+
+ResolverNotice
+
+class ResolverChanged
+Methods:
+
+AffectsContext
+
+AffectsContext()
+
+class ResolverNotice
+
+class pxr.Ar.ResolvedPath
+Represents a resolved asset path.
+Methods:
+
+GetPathString()
+Return the resolved path held by this object as a string.
+
+GetPathString() → str
+Return the resolved path held by this object as a string.
+
+class pxr.Ar.Resolver
+Interface for the asset resolution system. An asset resolver is
+responsible for resolving asset information (including the asset’s
+physical path) from a logical path.
+See ar_implementing_resolver for information on how to customize asset
+resolution behavior by implementing a subclass of ArResolver. Clients
+may use ArGetResolver to access the configured asset resolver.
+Methods:
+
+CanWriteAssetToPath(resolvedPath, whyNot)
+Returns true if an asset may be written to the given resolvedPath , false otherwise.
+
+CreateContextFromString(contextStr)
+Return an ArResolverContext created from the primary ArResolver implementation using the given contextStr .
+
+CreateContextFromStrings(contextStrs)
+Return an ArResolverContext created by combining the ArResolverContext objects created from the given contextStrs .
+
+CreateDefaultContext()
+Return an ArResolverContext that may be bound to this resolver to resolve assets when no other context is explicitly specified.
+
+CreateDefaultContextForAsset(assetPath)
+Return an ArResolverContext that may be bound to this resolver to resolve the asset located at assetPath or referenced by that asset when no other context is explicitly specified.
+
+CreateIdentifier(assetPath, anchorAssetPath)
+Returns an identifier for the asset specified by assetPath .
+
+CreateIdentifierForNewAsset(assetPath, ...)
+Returns an identifier for a new asset specified by assetPath .
+
+GetAssetInfo(assetPath, resolvedPath)
+Returns an ArAssetInfo populated with additional metadata (if any) about the asset at the given assetPath .
+
+GetCurrentContext()
+Returns the asset resolver context currently bound in this thread.
+
+GetExtension(assetPath)
+Returns the file extension for the given assetPath .
+
+GetModificationTimestamp(assetPath, resolvedPath)
+Returns an ArTimestamp representing the last time the asset at assetPath was modified.
+
+IsContextDependentPath(assetPath)
+Returns true if assetPath is a context-dependent path, false otherwise.
+
+RefreshContext(context)
+Refresh any caches associated with the given context.
+
+Resolve(assetPath)
+Returns the resolved path for the asset identified by the given assetPath if it exists.
+
+ResolveForNewAsset(assetPath)
+Returns the resolved path for the given assetPath that may be used to create a new asset.
+
+CanWriteAssetToPath(resolvedPath, whyNot) → bool
+Returns true if an asset may be written to the given resolvedPath
+, false otherwise.
+If this function returns false and whyNot is not nullptr , it
+may be filled with an explanation.
+
+Parameters
+
+resolvedPath (ResolvedPath) – 
+whyNot (str) – 
+
+CreateContextFromString(contextStr) → ResolverContext
+Return an ArResolverContext created from the primary ArResolver
+implementation using the given contextStr .
+
+Parameters
+contextStr (str) – 
+
+CreateContextFromString(uriScheme, contextStr) -> ResolverContext
+Return an ArResolverContext created from the ArResolver registered for
+the given uriScheme using the given contextStr .
+An empty uriScheme indicates the primary resolver and is
+equivalent to CreateContextFromString(string).
+If no resolver is registered for uriScheme , returns an empty
+ArResolverContext.
+
+Parameters
+
+uriScheme (str) – 
+contextStr (str) – 
+
+CreateContextFromStrings(contextStrs) → ResolverContext
+Return an ArResolverContext created by combining the ArResolverContext
+objects created from the given contextStrs .
+contextStrs is a list of pairs of strings. The first element in
+the pair is the URI scheme for the ArResolver that will be used to
+create the ArResolverContext from the second element in the pair. An
+empty URI scheme indicates the primary resolver.
+For example:
+ArResolverContext ctx = ArGetResolver().CreateContextFromStrings(
+   { {"", "context str 1"},
+     {"my_scheme", "context str 2"} });
+
+This will use the primary resolver to create an ArResolverContext
+using the string”context str 1”and use the resolver registered for
+the”my_scheme”URI scheme to create an ArResolverContext using”context
+str 2”. These contexts will be combined into a single
+ArResolverContext and returned.
+If no resolver is registered for a URI scheme in an entry in
+contextStrs , that entry will be ignored.
+
+Parameters
+contextStrs (list[tuple[str, str]]) – 
+
+CreateDefaultContext() → ResolverContext
+Return an ArResolverContext that may be bound to this resolver to
+resolve assets when no other context is explicitly specified.
+The returned ArResolverContext will contain the default context
+returned by the primary resolver and all URI resolvers.
+
+CreateDefaultContextForAsset(assetPath) → ResolverContext
+Return an ArResolverContext that may be bound to this resolver to
+resolve the asset located at assetPath or referenced by that asset
+when no other context is explicitly specified.
+The returned ArResolverContext will contain the default context for
+assetPath returned by the primary resolver and all URI resolvers.
+
+Parameters
+assetPath (str) – 
+
+CreateIdentifier(assetPath, anchorAssetPath) → str
+Returns an identifier for the asset specified by assetPath .
+If anchorAssetPath is not empty, it is the resolved asset path
+that assetPath should be anchored to if it is a relative path.
+
+Parameters
+
+assetPath (str) – 
+anchorAssetPath (ResolvedPath) – 
+
+CreateIdentifierForNewAsset(assetPath, anchorAssetPath) → str
+Returns an identifier for a new asset specified by assetPath .
+If anchorAssetPath is not empty, it is the resolved asset path
+that assetPath should be anchored to if it is a relative path.
+
+Parameters
+
+assetPath (str) – 
+anchorAssetPath (ResolvedPath) – 
+
+GetAssetInfo(assetPath, resolvedPath) → ArAssetInfo
+Returns an ArAssetInfo populated with additional metadata (if any)
+about the asset at the given assetPath .
+resolvedPath is the resolved path computed for the given
+assetPath .
+
+Parameters
+
+assetPath (str) – 
+resolvedPath (ResolvedPath) – 
+
+GetCurrentContext() → ResolverContext
+Returns the asset resolver context currently bound in this thread.
+ArResolver::BindContext, ArResolver::UnbindContext
+
+GetExtension(assetPath) → str
+Returns the file extension for the given assetPath .
+The returned extension does not include a”.”at the beginning.
+
+Parameters
+assetPath (str) – 
+
+GetModificationTimestamp(assetPath, resolvedPath) → Timestamp
+Returns an ArTimestamp representing the last time the asset at
+assetPath was modified.
+resolvedPath is the resolved path computed for the given
+assetPath . If a timestamp cannot be retrieved, return an invalid
+ArTimestamp.
+
+Parameters
+
+assetPath (str) – 
+resolvedPath (ResolvedPath) – 
+
+IsContextDependentPath(assetPath) → bool
+Returns true if assetPath is a context-dependent path, false
+otherwise.
+A context-dependent path may result in different resolved paths
+depending on what asset resolver context is bound when Resolve is
+called. Assets located at the same context-dependent path may not be
+the same since those assets may have been loaded from different
+resolved paths. In this case, the assets’resolved paths must be
+consulted to determine if they are the same.
+
+Parameters
+assetPath (str) – 
+
+RefreshContext(context) → None
+Refresh any caches associated with the given context.
+If doing so would invalidate asset paths that had previously been
+resolved, an ArNotice::ResolverChanged notice will be sent to inform
+clients of this.
+
+Parameters
+context (ResolverContext) – 
+
+Resolve(assetPath) → ResolvedPath
+Returns the resolved path for the asset identified by the given
+assetPath if it exists.
+If the asset does not exist, returns an empty ArResolvedPath.
+
+Parameters
+assetPath (str) – 
+
+ResolveForNewAsset(assetPath) → ResolvedPath
+Returns the resolved path for the given assetPath that may be used
+to create a new asset.
+If such a path cannot be computed for assetPath , returns an empty
+ArResolvedPath.
+Note that an asset might or might not already exist at the returned
+resolved path.
+
+Parameters
+assetPath (str) – 
+
+class pxr.Ar.ResolverContext
+An asset resolver context allows clients to provide additional data to
+the resolver for use during resolution. Clients may provide this data
+via context objects of their own (subject to restrictions below). An
+ArResolverContext is simply a wrapper around these objects that allows
+it to be treated as a single type. Note that an ArResolverContext may
+not hold multiple context objects with the same type.
+A client-defined context object must provide the following:
+
+Default and copy constructors
+operator<
+operator==
+An overload for size_t hash_value(const T&)
+
+Note that the user may define a free function:
+std::string ArGetDebugString(const Context & ctx); (Where Context is
+the type of the user’s path resolver context.)
+This is optional; a default generic implementation has been
+predefined. This function should return a string representation of the
+context to be utilized for debugging purposes(such as in TF_DEBUG
+statements).
+The ArIsContextObject template must also be specialized for this
+object to declare that it can be used as a context object. This is to
+avoid accidental use of an unexpected object as a context object. The
+AR_DECLARE_RESOLVER_CONTEXT macro can be used to do this as a
+convenience.
+AR_DECLARE_RESOLVER_CONTEXT
+ArResolver::BindContext
+ArResolver::UnbindContext
+ArResolverContextBinder
+Methods:
+
+Get()
+Returns pointer to the context object of the given type held in this resolver context.
+
+GetDebugString()
+Returns a debug string representing the contained context objects.
+
+IsEmpty()
+Returns whether this resolver context is empty.
+
+Get() → ContextObj
+Returns pointer to the context object of the given type held in this
+resolver context.
+Returns None if this resolver context is not holding an object of the
+requested type.
+
+GetDebugString() → str
+Returns a debug string representing the contained context objects.
+
+IsEmpty() → bool
+Returns whether this resolver context is empty.
+
+class pxr.Ar.ResolverContextBinder
+Helper object for managing the binding and unbinding of
+ArResolverContext objects with the asset resolver.
+Asset Resolver Context Operations
+
+class pxr.Ar.ResolverScopedCache
+Helper object for managing asset resolver cache scopes.
+A scoped resolution cache indicates to the resolver that results of
+calls to Resolve should be cached for a certain scope. This is
+important for performance and also for consistency  it ensures that
+repeated calls to Resolve with the same parameters will return the
+same result.
+Scoped Resolution Cache
+
+class pxr.Ar.Timestamp
+Represents a timestamp for an asset. Timestamps are represented by
+Unix time, the number of seconds elapsed since 00:00:00 UTC 1/1/1970.
+Methods:
+
+GetTime()
+Return the time represented by this timestamp as a double.
+
+IsValid()
+Return true if this timestamp is valid, false otherwise.
+
+GetTime() → float
+Return the time represented by this timestamp as a double.
+If this timestamp is invalid, issue a coding error and return a quiet
+NaN value.
+
+IsValid() → bool
+Return true if this timestamp is valid, false otherwise.
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

CameraUtil.md

@@ -0,0 +1,156 @@
+
+
+CameraUtil module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+CameraUtil module
+
+ 
+
+# CameraUtil module
+
+Summary: Camera Utilities
+
+Camera utilities.
+Classes:
+
+ConformWindowPolicy
+
+Framing
+Framing information.
+
+ScreenWindowParameters
+Given a camera object, compute parameters suitable for setting up RenderMan.
+
+class pxr.CameraUtil.ConformWindowPolicy
+Methods:
+
+GetValueFromName
+
+Attributes:
+
+allValues
+
+static GetValueFromName()
+
+allValues = (CameraUtil.MatchVertically, CameraUtil.MatchHorizontally, CameraUtil.Fit, CameraUtil.Crop, CameraUtil.DontConform)
+
+class pxr.CameraUtil.Framing
+Framing information. That is information determining how the filmback
+plane of a camera maps to the pixels of the rendered image
+(displayWindow together with pixelAspectRatio and window policy) and
+what pixels of the image will be filled by the renderer (dataWindow).
+The concepts of displayWindow and dataWindow are similar to the ones
+in OpenEXR, including that the x- and y-axis of the coordinate system
+point left and down, respectively.
+In fact, these windows mean the same here and in OpenEXR if the
+displayWindow has the same aspect ratio (when accounting for the
+pixelAspectRatio) as the filmback plane of the camera has (that is the
+ratio of the horizontalAperture to verticalAperture of, e.g., Usd’s
+Camera or GfCamera).
+In particular, overscan can be achieved by making the dataWindow
+larger than the displayWindow.
+If the aspect ratios differ, a window policy is applied to the
+displayWindow to determine how the pixels correspond to the filmback
+plane. One such window policy is to take the largest rect that fits
+(centered) into the displayWindow and has the camera’s aspect ratio.
+For example, if the displayWindow and dataWindow are the same and both
+have an aspect ratio smaller than the camera, the image is created by
+enlarging the camera frustum slightly in the bottom and top direction.
+When using the AOVs, the render buffer size is determined
+independently from the framing info. However, the dataWindow is
+supposed to be contained in the render buffer rect (in particular, the
+dataWindow cannot contain pixels withs negative coordinates - this
+restriction does not apply if, e.g., hdPrman circumvents AOVs and
+writes directly to EXR). In other words, unlike in OpenEXR, the rect
+of pixels for which we allocate storage can differ from the rect the
+renderer fills with data (dataWindow).
+For example, an application can set the render buffer size to match
+the widget size but use a dataWindow and displayWindow that only fills
+the render buffer horizontally to have slates at the top and bottom.
+Methods:
+
+ApplyToProjectionMatrix(projectionMatrix, ...)
+Given the projectionMatrix computed from a camera, applies the framing.
+
+IsValid()
+Is display and data window non-empty.
+
+Attributes:
+
+dataWindow
+
+displayWindow
+
+pixelAspectRatio
+
+ApplyToProjectionMatrix(projectionMatrix, windowPolicy) → Matrix4d
+Given the projectionMatrix computed from a camera, applies the
+framing.
+To obtain a correct result, a rasterizer needs to use the resulting
+projection matrix and set the viewport to the data window.
+
+Parameters
+
+projectionMatrix (Matrix4d) – 
+windowPolicy (ConformWindowPolicy) – 
+
+IsValid() → bool
+Is display and data window non-empty.
+
+property dataWindow
+
+property displayWindow
+
+property pixelAspectRatio
+
+class pxr.CameraUtil.ScreenWindowParameters
+Given a camera object, compute parameters suitable for setting up
+RenderMan.
+Attributes:
+
+fieldOfView
+float
+
+screenWindow
+Vec4d
+
+zFacingViewMatrix
+Matrix4d
+
+property fieldOfView
+float
+The field of view.
+More precisely, the full angle perspective field of view (in degrees)
+between screen space coordinates (-1,0) and (1,0). Give these
+parameters to RiProjection as parameter after”perspective”.
+
+Type
+type
+
+property screenWindow
+Vec4d
+The vector (left, right, bottom, top) defining the rectangle in the
+image plane.
+Give these parameters to RiScreenWindow.
+
+Type
+type
+
+property zFacingViewMatrix
+Matrix4d
+Returns the inverse of the transform for a camera that is y-Up and
+z-facing (vs the OpenGL camera that is (-z)-facing).
+Write this transform with RiConcatTransform before RiWorldBegin.
+
+Type
+type
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

Garch.md

@@ -0,0 +1,43 @@
+
+
+Garch module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+Garch module
+
+ 
+
+# Garch module
+
+Summary: GL Architecture
+
+garch
+Classes:
+
+GLPlatformDebugContext
+Platform specific context (e.g.
+
+class pxr.Garch.GLPlatformDebugContext
+Platform specific context (e.g. X11/GLX) which supports debug output.
+Methods:
+
+makeCurrent()
+
+Attributes:
+
+expired
+True if this object has expired, False otherwise.
+
+makeCurrent() → None
+
+property expired
+True if this object has expired, False otherwise.
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

GeomUtil.md

@@ -0,0 +1,455 @@
+
+
+GeomUtil module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+GeomUtil module
+
+ 
+
+# GeomUtil module
+
+Summary: The GeomUtil module contains utilities to help image common geometry.
+
+Utilities to help image common geometry.
+Classes:
+
+CapsuleMeshGenerator
+This class provides an implementation for generating topology and point positions on a capsule.
+
+ConeMeshGenerator
+This class provides an implementation for generating topology and point positions on a cone of a given radius and height.
+
+CuboidMeshGenerator
+This class provides an implementation for generating topology and point positions on a rectangular cuboid given the dimensions along the X, Y and Z axes.
+
+CylinderMeshGenerator
+This class provides an implementation for generating topology and point positions on a cylinder with a given radius and height.
+
+SphereMeshGenerator
+This class provides an implementation for generating topology and point positions on a sphere with a given radius.
+
+class pxr.GeomUtil.CapsuleMeshGenerator
+This class provides an implementation for generating topology and
+point positions on a capsule.
+The simplest form takes a radius and height and is a cylinder capped
+by two hemispheres that is centered at the origin. The generated
+capsule is made up of circular cross-sections in the XY plane. Each
+cross-section has numRadial segments. Successive cross-sections for
+each of the hemispheres are generated at numCapAxial locations along
+the Z and -Z axes respectively. The height is aligned with the Z axis
+and represents the height of just the cylindrical portion.
+An optional transform may be provided to GeneratePoints to orient the
+capsule as necessary (e.g., whose height is along the Y axis).
+An additional overload of GeneratePoints is provided to specify
+different radii and heights for the bottom and top caps, as well as
+the sweep angle for the capsule about the +Z axis. When the sweep is
+less than 360 degrees, the generated geometry is not closed.
+Usage:
+const size_t numRadial = 4, numCapAxial = 4;
+const size_t numPoints =
+    GeomUtilCapsuleMeshGenerator::ComputeNumPoints(numRadial, numCapAxial);
+const float radius = 1, height = 2;
+
+MyPointContainer<GfVec3f> points(numPoints);
+
+GeomUtilCapsuleMeshGenerator::GeneratePoints(
+    points.begin(), numRadial, numCapAxial, radius, height);
+
+Methods:
+
+ComputeNumPoints
+classmethod ComputeNumPoints(numRadial, numCapAxial, closedSweep) -> int
+
+GeneratePoints
+classmethod GeneratePoints(iter, numRadial, numCapAxial, radius, height, framePtr) -> None
+
+GenerateTopology
+classmethod GenerateTopology(numRadial, numCapAxial, closedSweep) -> MeshTopology
+
+Attributes:
+
+minNumCapAxial
+
+minNumRadial
+
+static ComputeNumPoints()
+classmethod ComputeNumPoints(numRadial, numCapAxial, closedSweep) -> int
+
+Parameters
+
+numRadial (int) – 
+numCapAxial (int) – 
+closedSweep (bool) – 
+
+static GeneratePoints()
+classmethod GeneratePoints(iter, numRadial, numCapAxial, radius, height, framePtr) -> None
+
+Parameters
+
+iter (PointIterType) – 
+numRadial (int) – 
+numCapAxial (int) – 
+radius (ScalarType) – 
+height (ScalarType) – 
+framePtr (Matrix4d) – 
+
+GeneratePoints(iter, numRadial, numCapAxial, bottomRadius, topRadius, height, bottomCapHeight, topCapHeight, sweepDegrees, framePtr) -> None
+
+Parameters
+
+iter (PointIterType) – 
+numRadial (int) – 
+numCapAxial (int) – 
+bottomRadius (ScalarType) – 
+topRadius (ScalarType) – 
+height (ScalarType) – 
+bottomCapHeight (ScalarType) – 
+topCapHeight (ScalarType) – 
+sweepDegrees (ScalarType) – 
+framePtr (Matrix4d) – 
+
+GeneratePoints(iter, arg2) -> None
+
+Parameters
+
+iter (PointIterType) – 
+arg2 – 
+
+static GenerateTopology()
+classmethod GenerateTopology(numRadial, numCapAxial, closedSweep) -> MeshTopology
+
+Parameters
+
+numRadial (int) – 
+numCapAxial (int) – 
+closedSweep (bool) – 
+
+minNumCapAxial = 1
+
+minNumRadial = 3
+
+class pxr.GeomUtil.ConeMeshGenerator
+This class provides an implementation for generating topology and
+point positions on a cone of a given radius and height.
+The cone is made up of circular cross-sections in the XY plane and is
+centered at the origin. Each cross-section has numRadial segments. The
+height is aligned with the Z axis, with the base of the object at Z =
+-h/2 and apex at Z = h/2.
+An optional transform may be provided to GeneratePoints to orient the
+cone as necessary (e.g., whose height is along the Y axis).
+An additional overload of GeneratePoints is provided to specify the
+sweep angle for the cone about the +Z axis. When the sweep is less
+than 360 degrees, the generated geometry is not closed.
+Usage:
+const size_t numRadial = 8;
+const size_t numPoints =
+    GeomUtilConeMeshGenerator::ComputeNumPoints(numRadial);
+const float radius = 1, height = 2;
+
+MyPointContainer<GfVec3f> points(numPoints);
+
+GeomUtilConeMeshGenerator::GeneratePoints(
+    points.begin(), numRadial, radius, height);
+
+Methods:
+
+ComputeNumPoints
+classmethod ComputeNumPoints(numRadial, closedSweep) -> int
+
+GeneratePoints
+classmethod GeneratePoints(iter, numRadial, radius, height, framePtr) -> None
+
+GenerateTopology
+classmethod GenerateTopology(numRadial, closedSweep) -> MeshTopology
+
+Attributes:
+
+minNumRadial
+
+static ComputeNumPoints()
+classmethod ComputeNumPoints(numRadial, closedSweep) -> int
+
+Parameters
+
+numRadial (int) – 
+closedSweep (bool) – 
+
+static GeneratePoints()
+classmethod GeneratePoints(iter, numRadial, radius, height, framePtr) -> None
+
+Parameters
+
+iter (PointIterType) – 
+numRadial (int) – 
+radius (ScalarType) – 
+height (ScalarType) – 
+framePtr (Matrix4d) – 
+
+GeneratePoints(iter, numRadial, radius, height, sweepDegrees, framePtr) -> None
+
+Parameters
+
+iter (PointIterType) – 
+numRadial (int) – 
+radius (ScalarType) – 
+height (ScalarType) – 
+sweepDegrees (ScalarType) – 
+framePtr (Matrix4d) – 
+
+GeneratePoints(iter, arg2) -> None
+
+Parameters
+
+iter (PointIterType) – 
+arg2 – 
+
+static GenerateTopology()
+classmethod GenerateTopology(numRadial, closedSweep) -> MeshTopology
+
+Parameters
+
+numRadial (int) – 
+closedSweep (bool) – 
+
+minNumRadial = 3
+
+class pxr.GeomUtil.CuboidMeshGenerator
+This class provides an implementation for generating topology and
+point positions on a rectangular cuboid given the dimensions along the
+X, Y and Z axes.
+The generated cuboid is centered at the origin.
+An optional transform may be provided to GeneratePoints to orient the
+cuboid as necessary.
+Usage:
+const size_t numPoints =
+    GeomUtilCuboidMeshGenerator::ComputeNumPoints();
+const float l = 5, b = 4, h = 3;
+
+MyPointContainer<GfVec3f> points(numPoints);
+
+GeomUtilCuboidMeshGenerator::GeneratePoints(
+    points.begin(), l, b, h);
+
+Methods:
+
+ComputeNumPoints
+classmethod ComputeNumPoints() -> int
+
+GeneratePoints
+classmethod GeneratePoints(iter, xLength, yLength, zLength, framePtr) -> None
+
+GenerateTopology
+classmethod GenerateTopology() -> MeshTopology
+
+static ComputeNumPoints()
+classmethod ComputeNumPoints() -> int
+
+static GeneratePoints()
+classmethod GeneratePoints(iter, xLength, yLength, zLength, framePtr) -> None
+
+Parameters
+
+iter (PointIterType) – 
+xLength (ScalarType) – 
+yLength (ScalarType) – 
+zLength (ScalarType) – 
+framePtr (Matrix4d) – 
+
+GeneratePoints(iter, arg2) -> None
+
+Parameters
+
+iter (PointIterType) – 
+arg2 – 
+
+static GenerateTopology()
+classmethod GenerateTopology() -> MeshTopology
+
+class pxr.GeomUtil.CylinderMeshGenerator
+This class provides an implementation for generating topology and
+point positions on a cylinder with a given radius and height.
+The cylinder is made up of circular cross-sections in the XY plane and
+is centered at the origin. Each cross-section has numRadial segments.
+The height is aligned with the Z axis, with the base at Z = -h/2.
+An optional transform may be provided to GeneratePoints to orient the
+cone as necessary (e.g., whose height is along the Y axis).
+An additional overload of GeneratePoints is provided to specify
+different radii for the bottom and top discs of the cylinder and a
+sweep angle for cylinder about the +Z axis. When the sweep is less
+than 360 degrees, the generated geometry is not closed.
+Setting one radius to 0 in order to get a cone is inefficient and
+could result in artifacts. Clients should use
+GeomUtilConeMeshGenerator instead. Usage:
+const size_t numRadial = 8;
+const size_t numPoints =
+    GeomUtilCylinderMeshGenerator::ComputeNumPoints(numRadial);
+const float radius = 1, height = 2;
+
+MyPointContainer<GfVec3f> points(numPoints);
+
+GeomUtilCylinderMeshGenerator::GeneratePoints(
+    points.begin(), numRadial, radius, height);
+
+Methods:
+
+ComputeNumPoints
+classmethod ComputeNumPoints(numRadial, closedSweep) -> int
+
+GeneratePoints
+classmethod GeneratePoints(iter, numRadial, radius, height, framePtr) -> None
+
+GenerateTopology
+classmethod GenerateTopology(numRadial, closedSweep) -> MeshTopology
+
+Attributes:
+
+minNumRadial
+
+static ComputeNumPoints()
+classmethod ComputeNumPoints(numRadial, closedSweep) -> int
+
+Parameters
+
+numRadial (int) – 
+closedSweep (bool) – 
+
+static GeneratePoints()
+classmethod GeneratePoints(iter, numRadial, radius, height, framePtr) -> None
+
+Parameters
+
+iter (PointIterType) – 
+numRadial (int) – 
+radius (ScalarType) – 
+height (ScalarType) – 
+framePtr (Matrix4d) – 
+
+GeneratePoints(iter, numRadial, bottomRadius, topRadius, height, sweepDegrees, framePtr) -> None
+
+Parameters
+
+iter (PointIterType) – 
+numRadial (int) – 
+bottomRadius (ScalarType) – 
+topRadius (ScalarType) – 
+height (ScalarType) – 
+sweepDegrees (ScalarType) – 
+framePtr (Matrix4d) – 
+
+GeneratePoints(iter, arg2) -> None
+
+Parameters
+
+iter (PointIterType) – 
+arg2 – 
+
+static GenerateTopology()
+classmethod GenerateTopology(numRadial, closedSweep) -> MeshTopology
+
+Parameters
+
+numRadial (int) – 
+closedSweep (bool) – 
+
+minNumRadial = 3
+
+class pxr.GeomUtil.SphereMeshGenerator
+This class provides an implementation for generating topology and
+point positions on a sphere with a given radius.
+The sphere is made up of circular cross-sections in the XY plane and
+is centered at the origin. Each cross-section has numRadial segments.
+Successive cross-sections are generated at numAxial locations along
+the Z axis, with the bottom of the sphere at Z = -r and top at Z = r.
+An optional transform may be provided to GeneratePoints to orient the
+sphere as necessary (e.g., cross-sections in the YZ plane).
+An additional overload of GeneratePoints is provided to specify a
+sweep angle for the sphere about the +Z axis. When the sweep is less
+than 360 degrees, the generated geometry is not closed.
+Usage:
+const size_t numRadial = 4, numAxial = 4;
+const size_t numPoints =
+    GeomUtilSphereMeshGenerator::ComputeNumPoints(numRadial, numAxial);
+const float radius = 5;
+
+MyPointContainer<GfVec3f> points(numPoints);
+
+GeomUtilSphereMeshGenerator::GeneratePoints(
+    points.begin(), numRadial, numAxial, radius);
+
+Methods:
+
+ComputeNumPoints
+classmethod ComputeNumPoints(numRadial, numAxial, closedSweep) -> int
+
+GeneratePoints
+classmethod GeneratePoints(iter, numRadial, numAxial, radius, framePtr) -> None
+
+GenerateTopology
+classmethod GenerateTopology(numRadial, numAxial, closedSweep) -> MeshTopology
+
+Attributes:
+
+minNumAxial
+
+minNumRadial
+
+static ComputeNumPoints()
+classmethod ComputeNumPoints(numRadial, numAxial, closedSweep) -> int
+
+Parameters
+
+numRadial (int) – 
+numAxial (int) – 
+closedSweep (bool) – 
+
+static GeneratePoints()
+classmethod GeneratePoints(iter, numRadial, numAxial, radius, framePtr) -> None
+
+Parameters
+
+iter (PointIterType) – 
+numRadial (int) – 
+numAxial (int) – 
+radius (ScalarType) – 
+framePtr (Matrix4d) – 
+
+GeneratePoints(iter, numRadial, numAxial, radius, sweepDegrees, framePtr) -> None
+
+Parameters
+
+iter (PointIterType) – 
+numRadial (int) – 
+numAxial (int) – 
+radius (ScalarType) – 
+sweepDegrees (ScalarType) – 
+framePtr (Matrix4d) – 
+
+GeneratePoints(iter, arg2) -> None
+
+Parameters
+
+iter (PointIterType) – 
+arg2 – 
+
+static GenerateTopology()
+classmethod GenerateTopology(numRadial, numAxial, closedSweep) -> MeshTopology
+
+Parameters
+
+numRadial (int) – 
+numAxial (int) – 
+closedSweep (bool) – 
+
+minNumAxial = 2
+
+minNumRadial = 3
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

Glf.md

@@ -0,0 +1,477 @@
+
+
+Glf module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+Glf module
+
+ 
+
+# Glf module
+
+Summary: The Glf module contains Utility classes for OpenGL output.
+
+glf
+Classes:
+
+DrawTarget
+A class representing a GL render target with mutliple image attachments.
+
+GLQueryObject
+Represents a GL query object in Glf
+
+SimpleLight
+
+SimpleMaterial
+
+Texture
+Represents a texture object in Glf.
+
+class pxr.Glf.DrawTarget
+A class representing a GL render target with mutliple image
+attachments.
+A DrawTarget is essentially a custom render pass into which several
+arbitrary variables can be output into. These can later be used as
+texture samplers by GLSL shaders.
+The DrawTarget maintains a map of named attachments that correspond to
+GL_TEXTURE_2D mages. By default, DrawTargets also create a depth
+component that is used both as a depth buffer during the draw pass,
+and can later be accessed as a regular GL_TEXTURE_2D data. Stencils
+are also available (by setting the format to GL_DEPTH_STENCIL and the
+internalFormat to GL_DEPTH24_STENCIL8)
+Methods:
+
+AddAttachment(name, format, type, internalFormat)
+Add an attachment to the DrawTarget.
+
+Bind()
+Binds the framebuffer.
+
+Unbind()
+Unbinds the framebuffer.
+
+WriteToFile(name, filename, viewMatrix, ...)
+Write the Attachment buffer to an image file (debugging).
+
+Attributes:
+
+expired
+True if this object has expired, False otherwise.
+
+AddAttachment(name, format, type, internalFormat) → None
+Add an attachment to the DrawTarget.
+
+Parameters
+
+name (str) – 
+format (GLenum) – 
+type (GLenum) – 
+internalFormat (GLenum) – 
+
+Bind() → None
+Binds the framebuffer.
+
+Unbind() → None
+Unbinds the framebuffer.
+
+WriteToFile(name, filename, viewMatrix, projectionMatrix) → bool
+Write the Attachment buffer to an image file (debugging).
+
+Parameters
+
+name (str) – 
+filename (str) – 
+viewMatrix (Matrix4d) – 
+projectionMatrix (Matrix4d) – 
+
+property expired
+True if this object has expired, False otherwise.
+
+class pxr.Glf.GLQueryObject
+Represents a GL query object in Glf
+Methods:
+
+Begin(target)
+Begin query for the given target target has to be one of GL_SAMPLES_PASSED, GL_ANY_SAMPLES_PASSED, GL_ANY_SAMPLES_PASSED_CONSERVATIVE, GL_PRIMITIVES_GENERATED GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN GL_TIME_ELAPSED, GL_TIMESTAMP.
+
+BeginPrimitivesGenerated()
+equivalent to Begin(GL_PRIMITIVES_GENERATED).
+
+BeginSamplesPassed()
+equivalent to Begin(GL_SAMPLES_PASSED).
+
+BeginTimeElapsed()
+equivalent to Begin(GL_TIME_ELAPSED).
+
+End()
+End query.
+
+GetResult()
+Return the query result (synchronous) stalls CPU until the result becomes available.
+
+GetResultNoWait()
+Return the query result (asynchronous) returns 0 if the result hasn't been available.
+
+Begin(target) → None
+Begin query for the given target target has to be one of
+GL_SAMPLES_PASSED, GL_ANY_SAMPLES_PASSED,
+GL_ANY_SAMPLES_PASSED_CONSERVATIVE, GL_PRIMITIVES_GENERATED
+GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN GL_TIME_ELAPSED,
+GL_TIMESTAMP.
+
+Parameters
+target (GLenum) – 
+
+BeginPrimitivesGenerated() → None
+equivalent to Begin(GL_PRIMITIVES_GENERATED).
+The number of primitives sent to the rasterizer by the scoped drawing
+command will be returned.
+
+BeginSamplesPassed() → None
+equivalent to Begin(GL_SAMPLES_PASSED).
+The number of samples that pass the depth test for all drawing
+commands within the scope of the query will be returned.
+
+BeginTimeElapsed() → None
+equivalent to Begin(GL_TIME_ELAPSED).
+The time that it takes for the GPU to execute all of the scoped
+commands will be returned in nanoseconds.
+
+End() → None
+End query.
+
+GetResult() → int
+Return the query result (synchronous) stalls CPU until the result
+becomes available.
+
+GetResultNoWait() → int
+Return the query result (asynchronous) returns 0 if the result hasn’t
+been available.
+
+class pxr.Glf.SimpleLight
+Attributes:
+
+ambient
+None
+
+attenuation
+None
+
+diffuse
+None
+
+hasShadow
+None
+
+id
+
+isCameraSpaceLight
+None
+
+isDomeLight
+None
+
+position
+None
+
+shadowBias
+None
+
+shadowBlur
+None
+
+shadowIndexEnd
+None
+
+shadowIndexStart
+None
+
+shadowMatrices
+None
+
+shadowResolution
+None
+
+specular
+None
+
+spotCutoff
+None
+
+spotDirection
+None
+
+spotFalloff
+None
+
+transform
+None
+
+property ambient
+None
+
+type : Vec4f
+
+Type
+type
+
+property attenuation
+None
+
+type : Vec3f
+
+Type
+type
+
+property diffuse
+None
+
+type : Vec4f
+
+Type
+type
+
+property hasShadow
+None
+
+Type
+type
+
+property id
+
+property isCameraSpaceLight
+None
+
+type : bool
+
+Type
+type
+
+property isDomeLight
+None
+
+type : bool
+
+Type
+type
+
+property position
+None
+
+type : Vec4f
+
+Type
+type
+
+property shadowBias
+None
+
+type : float
+
+Type
+type
+
+property shadowBlur
+None
+
+type : float
+
+Type
+type
+
+property shadowIndexEnd
+None
+
+type : int
+
+Type
+type
+
+property shadowIndexStart
+None
+
+type : int
+
+Type
+type
+
+property shadowMatrices
+None
+
+type : list[Matrix4d]
+
+Type
+type
+
+property shadowResolution
+None
+
+type : int
+
+Type
+type
+
+property specular
+None
+
+type : Vec4f
+
+Type
+type
+
+property spotCutoff
+None
+
+type : float
+
+Type
+type
+
+property spotDirection
+None
+
+type : Vec3f
+
+Type
+type
+
+property spotFalloff
+None
+
+type : float
+
+Type
+type
+
+property transform
+None
+
+type : Matrix4d
+
+Type
+type
+
+class pxr.Glf.SimpleMaterial
+Attributes:
+
+ambient
+None
+
+diffuse
+None
+
+emission
+None
+
+shininess
+None
+
+specular
+None
+
+property ambient
+None
+
+type : Vec4f
+
+Type
+type
+
+property diffuse
+None
+
+type : Vec4f
+
+Type
+type
+
+property emission
+None
+
+type : Vec4f
+
+Type
+type
+
+property shininess
+None
+
+type : float
+
+Type
+type
+
+property specular
+None
+
+type : Vec4f
+
+Type
+type
+
+class pxr.Glf.Texture
+Represents a texture object in Glf.
+A texture is typically defined by reading texture image data from an
+image file but a texture might also represent an attachment of a draw
+target.
+Methods:
+
+GetTextureMemoryAllocated
+classmethod GetTextureMemoryAllocated() -> int
+
+Attributes:
+
+magFilterSupported
+bool
+
+memoryRequested
+None
+
+memoryUsed
+int
+
+minFilterSupported
+bool
+
+static GetTextureMemoryAllocated()
+classmethod GetTextureMemoryAllocated() -> int
+static reporting function
+
+property magFilterSupported
+bool
+
+Type
+type
+
+property memoryRequested
+None
+Specify the amount of memory the user wishes to allocate to the
+texture.
+
+type : int
+Amount of memory the user wishes to allocate to the texture.
+
+Type
+type
+
+property memoryUsed
+int
+Amount of memory used to store the texture.
+
+Type
+type
+
+property minFilterSupported
+bool
+
+Type
+type
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

Kind.md

@@ -0,0 +1,122 @@
+
+
+Kind module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+Kind module
+
+ 
+
+# Kind module
+
+Summary: The Kind library provides a runtime-extensible taxonomy known as “kinds”. Useful for classifying scenegraph objects.
+
+Python bindings for libKind
+Classes:
+
+Registry
+A singleton that holds known kinds and information about them.
+
+Tokens
+
+class pxr.Kind.Registry
+A singleton that holds known kinds and information about them. See
+Kind Overview for a description of why kind exists, what the builtin
+registered kinds are, and how to extend the core kinds.
+
+## KindRegistry Threadsafty
+
+KindRegistry serves performance-critical clients that operate under
+the stl threading model, and therefore itself follows that model in
+order to avoid locking during HasKind() and IsA() queries.
+To make this robust, KindRegistry exposes no means to mutate the
+registry. All extensions must be accomplished via plugInfo.json files,
+which are consumed once during the registry initialization (See
+Extending the KindRegistry)
+Methods:
+
+GetAllKinds
+classmethod GetAllKinds() -> list[str]
+
+GetBaseKind
+classmethod GetBaseKind(kind) -> str
+
+HasKind
+classmethod HasKind(kind) -> bool
+
+IsA
+classmethod IsA(derivedKind, baseKind) -> bool
+
+Attributes:
+
+expired
+True if this object has expired, False otherwise.
+
+static GetAllKinds()
+classmethod GetAllKinds() -> list[str]
+Return an unordered vector of all kinds known to the registry.
+
+static GetBaseKind()
+classmethod GetBaseKind(kind) -> str
+Return the base kind of the given kind.
+If there is no base, the result will be an empty token. Issues a
+coding error if kind is unknown to the registry.
+
+Parameters
+kind (str) – 
+
+static HasKind()
+classmethod HasKind(kind) -> bool
+Test whether kind is known to the registry.
+
+Parameters
+kind (str) – 
+
+static IsA()
+classmethod IsA(derivedKind, baseKind) -> bool
+Test whether derivedKind is the same as baseKind or has it as a
+base kind (either directly or indirectly).
+It is not required that derivedKind or baseKind be known to the
+registry: if they are unknown but equal, IsA will return true ;
+otherwise if either is unknown, we will simply return false.
+Therefore this method will not raise any errors.
+
+Parameters
+
+derivedKind (str) – 
+baseKind (str) – 
+
+property expired
+True if this object has expired, False otherwise.
+
+class pxr.Kind.Tokens
+Attributes:
+
+assembly
+
+component
+
+group
+
+model
+
+subcomponent
+
+assembly = 'assembly'
+
+component = 'component'
+
+group = 'group'
+
+model = 'model'
+
+subcomponent = 'subcomponent'
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

Ndr.md

@@ -0,0 +1,849 @@
+
+
+Ndr module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+Ndr module
+
+ 
+
+# Ndr module
+
+Summary: The Ndr (Node Definition Registry) provides a node-domain-agmostic framework for registering and querying information about nodes.
+
+Python bindings for libNdr
+Classes:
+
+DiscoveryPlugin
+Interface for discovery plugins.
+
+DiscoveryPluginContext
+A context for discovery.
+
+DiscoveryPluginList
+
+DiscoveryUri
+Struct for holding a URI and its resolved URI for a file discovered by NdrFsHelpersDiscoverFiles.
+
+Node
+Represents an abstract node.
+
+NodeDiscoveryResult
+Represents the raw data of a node, and some other bits of metadata, that were determined via a NdrDiscoveryPlugin .
+
+NodeList
+
+Property
+Represents a property (input or output) that is part of a NdrNode instance.
+
+Registry
+The registry provides access to node information."Discovery Plugins"are responsible for finding the nodes that should be included in the registry.
+
+Version
+
+VersionFilter
+
+class pxr.Ndr.DiscoveryPlugin
+Interface for discovery plugins.
+Discovery plugins, like the name implies, find nodes. Where the plugin
+searches is up to the plugin that implements this interface. Examples
+of discovery plugins could include plugins that look for nodes on the
+filesystem, another that finds nodes in a cloud service, and another
+that searches a local database. Multiple discovery plugins that search
+the filesystem in specific locations/ways could also be created. All
+discovery plugins are executed as soon as the registry is
+instantiated.
+These plugins simply report back to the registry what nodes they found
+in a generic way. The registry doesn’t know much about the innards of
+the nodes yet, just that the nodes exist. Understanding the nodes is
+the responsibility of another set of plugins defined by the
+NdrParserPlugin interface.
+Discovery plugins report back to the registry via
+NdrNodeDiscoveryResult s. These are small, lightweight classes
+that contain the information for a single node that was found during
+discovery. The discovery result only includes node information that
+can be gleaned pre-parse, so the data is fairly limited; to see
+exactly what’s included, and what is expected to be populated, see the
+documentation for NdrNodeDiscoveryResult .
+
+## How to Create a Discovery Plugin
+
+There are three steps to creating a discovery plugin:
+
+Implement the discovery plugin interface, NdrDiscoveryPlugin
+Register your new plugin with the registry. The registration
+macro must be called in your plugin’s implementation file:
+
+ NDR_REGISTER_DISCOVERY_PLUGIN(YOUR_DISCOVERY_PLUGIN_CLASS_NAME)
+
+This macro is available in discoveryPlugin.h.
+
+  - In the same folder as your plugin, create a ``plugInfo.json``
+    file. This file must be formatted like so, substituting
+    ``YOUR_LIBRARY_NAME`` , ``YOUR_CLASS_NAME`` , and
+    ``YOUR_DISPLAY_NAME`` :
+
+{
+    "Plugins": [{
+        "Type": "module",
+        "Name": "YOUR_LIBRARY_NAME",
+        "Root": "@PLUG_INFO_ROOT@",
+        "LibraryPath": "@PLUG_INFO_LIBRARY_PATH@",
+        "ResourcePath": "@PLUG_INFO_RESOURCE_PATH@",
+        "Info": {
+            "Types": {
+                "YOUR_CLASS_NAME" : {
+                    "bases": ["NdrDiscoveryPlugin"],
+                    "displayName": "YOUR_DISPLAY_NAME"
+                }
+            }
+        }
+    }]
+}
+
+The NDR ships with one discovery plugin, the
+_NdrFilesystemDiscoveryPlugin . Take a look at NDR’s plugInfo.json
+file for example values for YOUR_LIBRARY_NAME ,
+YOUR_CLASS_NAME , and YOUR_DISPLAY_NAME . If multiple
+discovery plugins exist in the same folder, you can continue adding
+additional plugins under the Types key in the JSON. More detailed
+information about the plugInfo.json format can be found in the
+documentation for the plug module (in pxr/base).
+Methods:
+
+DiscoverNodes(arg1)
+Finds and returns all nodes that the implementing plugin should be aware of.
+
+GetSearchURIs()
+Gets the URIs that this plugin is searching for nodes in.
+
+Attributes:
+
+expired
+True if this object has expired, False otherwise.
+
+DiscoverNodes(arg1) → NdrNodeDiscoveryResultVec
+Finds and returns all nodes that the implementing plugin should be
+aware of.
+
+Parameters
+arg1 (Context) – 
+
+GetSearchURIs() → NdrStringVec
+Gets the URIs that this plugin is searching for nodes in.
+
+property expired
+True if this object has expired, False otherwise.
+
+class pxr.Ndr.DiscoveryPluginContext
+A context for discovery.
+Discovery plugins can use this to get a limited set of non-local
+information without direct coupling between plugins.
+Methods:
+
+GetSourceType(discoveryType)
+Returns the source type associated with the discovery type.
+
+Attributes:
+
+expired
+True if this object has expired, False otherwise.
+
+GetSourceType(discoveryType) → str
+Returns the source type associated with the discovery type.
+This may return an empty token if there is no such association.
+
+Parameters
+discoveryType (str) – 
+
+property expired
+True if this object has expired, False otherwise.
+
+class pxr.Ndr.DiscoveryPluginList
+Methods:
+
+append
+
+extend
+
+append()
+
+extend()
+
+class pxr.Ndr.DiscoveryUri
+Struct for holding a URI and its resolved URI for a file discovered by
+NdrFsHelpersDiscoverFiles.
+Attributes:
+
+resolvedUri
+
+uri
+
+property resolvedUri
+
+property uri
+
+class pxr.Ndr.Node
+Represents an abstract node. Describes information like the name of
+the node, what its inputs and outputs are, and any associated
+metadata.
+In almost all cases, this class will not be used directly. More
+specialized nodes can be created that derive from NdrNode ; those
+specialized nodes can add their own domain-specific data and methods.
+Methods:
+
+GetContext()
+Gets the context of the node.
+
+GetFamily()
+Gets the name of the family that the node belongs to.
+
+GetIdentifier()
+Return the identifier of the node.
+
+GetInfoString()
+Gets a string with basic information about this node.
+
+GetInput(inputName)
+Get an input property by name.
+
+GetInputNames()
+Get an ordered list of all the input names on this node.
+
+GetMetadata()
+All metadata that came from the parse process.
+
+GetName()
+Gets the name of the node.
+
+GetOutput(outputName)
+Get an output property by name.
+
+GetOutputNames()
+Get an ordered list of all the output names on this node.
+
+GetResolvedDefinitionURI()
+Gets the URI to the resource that provided this node's definition.
+
+GetResolvedImplementationURI()
+Gets the URI to the resource that provides this node's implementation.
+
+GetSourceCode()
+Returns the source code for this node.
+
+GetSourceType()
+Gets the type of source that this node originated from.
+
+GetVersion()
+Return the version of the node.
+
+IsValid()
+Whether or not this node is valid.
+
+GetContext() → str
+Gets the context of the node.
+The context is the context that the node declares itself as having
+(or, if a particular node does not declare a context, it will be
+assigned a default context by the parser).
+As a concrete example from the Sdr module, a shader with a
+specific source type may perform different duties vs. another shader
+with the same source type. For example, one shader with a source type
+of SdrArgsParser::SourceType may declare itself as having a
+context of’pattern’, while another shader of the same source type may
+say it is used for lighting, and thus has a context of’light’.
+
+GetFamily() → str
+Gets the name of the family that the node belongs to.
+An empty token will be returned if the node does not belong to a
+family.
+
+GetIdentifier() → NdrIdentifier
+Return the identifier of the node.
+
+GetInfoString() → str
+Gets a string with basic information about this node.
+Helpful for things like adding this node to a log.
+
+GetInput(inputName) → Property
+Get an input property by name.
+nullptr is returned if an input with the given name does not
+exist.
+
+Parameters
+inputName (str) – 
+
+GetInputNames() → NdrTokenVec
+Get an ordered list of all the input names on this node.
+
+GetMetadata() → NdrTokenMap
+All metadata that came from the parse process.
+Specialized nodes may isolate values in the metadata (with possible
+manipulations and/or additional parsing) and expose those values in
+their API.
+
+GetName() → str
+Gets the name of the node.
+
+GetOutput(outputName) → Property
+Get an output property by name.
+nullptr is returned if an output with the given name does not
+exist.
+
+Parameters
+outputName (str) – 
+
+GetOutputNames() → NdrTokenVec
+Get an ordered list of all the output names on this node.
+
+GetResolvedDefinitionURI() → str
+Gets the URI to the resource that provided this node’s definition.
+Could be a path to a file, or some other resource identifier. This URI
+should be fully resolved.
+NdrNode::GetResolvedImplementationURI()
+
+GetResolvedImplementationURI() → str
+Gets the URI to the resource that provides this node’s implementation.
+Could be a path to a file, or some other resource identifier. This URI
+should be fully resolved.
+NdrNode::GetResolvedDefinitionURI()
+
+GetSourceCode() → str
+Returns the source code for this node.
+This will be empty for most nodes. It will be non-empty only for the
+nodes that are constructed using NdrRegistry::GetNodeFromSourceCode()
+, in which case, the source code has not been parsed (or even
+compiled) yet.
+An unparsed node with non-empty source-code but no properties is
+considered to be invalid. Once the node is parsed and the relevant
+properties and metadata are extracted from the source code, the node
+becomes valid.
+NdrNode::IsValid
+
+GetSourceType() → str
+Gets the type of source that this node originated from.
+Note that this is distinct from GetContext() , which is the type
+that the node declares itself as having.
+As a concrete example from the Sdr module, several shader parsers
+exist and operate on different types of shaders. In this scenario,
+each distinct type of shader (OSL, Args, etc) is considered a
+different source, even though they are all shaders. In addition, the
+shaders under each source type may declare themselves as having a
+specific context (shaders can serve different roles). See
+GetContext() for more information on this.
+
+GetVersion() → Version
+Return the version of the node.
+
+IsValid() → bool
+Whether or not this node is valid.
+A node that is valid indicates that the parser plugin was able to
+successfully parse the contents of this node.
+Note that if a node is not valid, some data like its name, URI, source
+code etc. could still be available (data that was obtained during the
+discovery process). However, other data that must be gathered from the
+parsing process will NOT be available (eg, inputs and outputs).
+
+class pxr.Ndr.NodeDiscoveryResult
+Represents the raw data of a node, and some other bits of metadata,
+that were determined via a NdrDiscoveryPlugin .
+Attributes:
+
+blindData
+
+discoveryType
+
+family
+
+identifier
+
+metadata
+
+name
+
+resolvedUri
+
+sourceCode
+
+sourceType
+
+subIdentifier
+
+uri
+
+version
+
+property blindData
+
+property discoveryType
+
+property family
+
+property identifier
+
+property metadata
+
+property name
+
+property resolvedUri
+
+property sourceCode
+
+property sourceType
+
+property subIdentifier
+
+property uri
+
+property version
+
+class pxr.Ndr.NodeList
+Methods:
+
+append
+
+extend
+
+append()
+
+extend()
+
+class pxr.Ndr.Property
+Represents a property (input or output) that is part of a NdrNode
+instance.
+A property must have a name and type, but may also specify a host of
+additional metadata. Instances can also be queried to determine if
+another NdrProperty instance can be connected to it.
+In almost all cases, this class will not be used directly. More
+specialized properties can be created that derive from NdrProperty
+; those specialized properties can add their own domain-specific data
+and methods.
+Methods:
+
+CanConnectTo(other)
+Determines if this property can be connected to the specified property.
+
+GetArraySize()
+Gets this property's array size.
+
+GetDefaultValue()
+Gets this property's default value associated with the type of the property.
+
+GetInfoString()
+Gets a string with basic information about this property.
+
+GetMetadata()
+All of the metadata that came from the parse process.
+
+GetName()
+Gets the name of the property.
+
+GetType()
+Gets the type of the property.
+
+GetTypeAsSdfType()
+Converts the property's type from GetType() into a SdfValueTypeName .
+
+IsArray()
+Whether this property's type is an array type.
+
+IsConnectable()
+Whether this property can be connected to other properties.
+
+IsDynamicArray()
+Whether this property's array type is dynamically-sized.
+
+IsOutput()
+Whether this property is an output.
+
+CanConnectTo(other) → bool
+Determines if this property can be connected to the specified
+property.
+
+Parameters
+other (Property) – 
+
+GetArraySize() → int
+Gets this property’s array size.
+If this property is a fixed-size array type, the array size is
+returned. In the case of a dynamically-sized array, this method
+returns the array size that the parser reports, and should not be
+relied upon to be accurate. A parser may report -1 for the array size,
+for example, to indicate a dynamically-sized array. For types that are
+not a fixed-size array or dynamic array, this returns 0.
+
+GetDefaultValue() → VtValue
+Gets this property’s default value associated with the type of the
+property.
+GetType()
+
+GetInfoString() → str
+Gets a string with basic information about this property.
+Helpful for things like adding this property to a log.
+
+GetMetadata() → NdrTokenMap
+All of the metadata that came from the parse process.
+
+GetName() → str
+Gets the name of the property.
+
+GetType() → str
+Gets the type of the property.
+
+GetTypeAsSdfType() → NdrSdfTypeIndicator
+Converts the property’s type from GetType() into a
+SdfValueTypeName .
+Two scenarios can result: an exact mapping from property type to Sdf
+type, and an inexact mapping. In the first scenario, the first element
+in the pair will be the cleanly-mapped Sdf type, and the second
+element, a TfToken, will be empty. In the second scenario, the Sdf
+type will be set to Token to indicate an unclean mapping, and the
+second element will be set to the original type returned by
+GetType() .
+GetDefaultValueAsSdfType
+
+IsArray() → bool
+Whether this property’s type is an array type.
+
+IsConnectable() → bool
+Whether this property can be connected to other properties.
+If this returns true , connectability to a specific property can
+be tested via CanConnectTo() .
+
+IsDynamicArray() → bool
+Whether this property’s array type is dynamically-sized.
+
+IsOutput() → bool
+Whether this property is an output.
+
+class pxr.Ndr.Registry
+The registry provides access to node information.”Discovery
+Plugins”are responsible for finding the nodes that should be included
+in the registry.
+Discovery plugins are found through the plugin system. If additional
+discovery plugins need to be specified, a client can pass them to
+SetExtraDiscoveryPlugins() .
+When the registry is first told about the discovery plugins, the
+plugins will be asked to discover nodes. These plugins will generate
+NdrNodeDiscoveryResult instances, which only contain basic
+metadata. Once the client asks for information that would require the
+node’s contents to be parsed (eg, what its inputs and outputs are),
+the registry will begin the parsing process on an as-needed basis. See
+NdrNodeDiscoveryResult for the information that can be retrieved
+without triggering a parse.
+Some methods in this module may allow for a”family”to be provided. A
+family is simply a generic grouping which is optional.
+Methods:
+
+GetAllNodeSourceTypes()
+Get a sorted list of all node source types that may be present on the nodes in the registry.
+
+GetNodeByIdentifier(identifier, ...)
+Get the node with the specified identifier , and an optional sourceTypePriority list specifying the set of node SOURCE types (see NdrNode::GetSourceType() ) that should be searched.
+
+GetNodeByIdentifierAndType(identifier, ...)
+Get the node with the specified identifier and sourceType .
+
+GetNodeByName(name, sourceTypePriority, filter)
+Get the node with the specified name.
+
+GetNodeByNameAndType(name, sourceType, filter)
+A convenience wrapper around GetNodeByName() .
+
+GetNodeFromAsset(asset, metadata, ...)
+Parses the given asset , constructs a NdrNode from it and adds it to the registry.
+
+GetNodeFromSourceCode(sourceCode, ...)
+Parses the given sourceCode string, constructs a NdrNode from it and adds it to the registry.
+
+GetNodeIdentifiers(family, filter)
+Get the identifiers of all the nodes that the registry is aware of.
+
+GetNodeNames(family)
+Get the names of all the nodes that the registry is aware of.
+
+GetNodesByFamily(family, filter)
+Get all nodes from the registry, optionally restricted to the nodes that fall under a specified family and/or the default version.
+
+GetNodesByIdentifier(identifier)
+Get all nodes matching the specified identifier (multiple nodes of the same identifier, but different source types, may exist).
+
+GetNodesByName(name, filter)
+Get all nodes matching the specified name.
+
+GetSearchURIs()
+Get the locations where the registry is searching for nodes.
+
+SetExtraDiscoveryPlugins(plugins)
+Allows the client to set any additional discovery plugins that would otherwise NOT be found through the plugin system.
+
+SetExtraParserPlugins(pluginTypes)
+Allows the client to set any additional parser plugins that would otherwise NOT be found through the plugin system.
+
+GetAllNodeSourceTypes() → NdrTokenVec
+Get a sorted list of all node source types that may be present on the
+nodes in the registry.
+Source types originate from the discovery process, but there is no
+guarantee that the discovered source types will also have a registered
+parser plugin. The actual supported source types here depend on the
+parsers that are available. Also note that some parser plugins may not
+advertise a source type.
+See the documentation for NdrParserPlugin and
+NdrNode::GetSourceType() for more information.
+
+GetNodeByIdentifier(identifier, sourceTypePriority) → Node
+Get the node with the specified identifier , and an optional
+sourceTypePriority list specifying the set of node SOURCE types
+(see NdrNode::GetSourceType() ) that should be searched.
+If no sourceTypePriority is specified, the first encountered node with
+the specified identifier will be returned (first is arbitrary) if
+found.
+If a sourceTypePriority list is specified, then this will iterate
+through each source type and try to find a node matching by
+identifier. This is equivalent to calling
+NdrRegistry::GetNodeByIdentifierAndType for each source type until a
+node is found.
+Nodes of the same identifier but different source type can exist in
+the registry. If a node’Foo’with source types’abc’and’xyz’exist in the
+registry, and you want to make sure the’abc’version is fetched before
+the’xyz’version, the priority list would be specified as
+[‘abc’,’xyz’]. If the’abc’version did not exist in the registry, then
+the’xyz’version would be returned.
+Returns nullptr if a node matching the arguments can’t be found.
+
+Parameters
+
+identifier (NdrIdentifier) – 
+sourceTypePriority (NdrTokenVec) – 
+
+GetNodeByIdentifierAndType(identifier, sourceType) → Node
+Get the node with the specified identifier and sourceType .
+If there is no matching node for the sourceType, nullptr is returned.
+
+Parameters
+
+identifier (NdrIdentifier) – 
+sourceType (str) – 
+
+GetNodeByName(name, sourceTypePriority, filter) → Node
+Get the node with the specified name.
+An optional priority list specifies the set of node SOURCE types (
+NdrNode::GetSourceType() ) that should be searched and in what order.
+Optionally, a filter can be specified to consider just the default
+versions of nodes matching name (the default) or all versions of
+the nodes.
+GetNodeByIdentifier() .
+
+Parameters
+
+name (str) – 
+sourceTypePriority (NdrTokenVec) – 
+filter (VersionFilter) – 
+
+GetNodeByNameAndType(name, sourceType, filter) → Node
+A convenience wrapper around GetNodeByName() .
+Instead of providing a priority list, an exact type is specified, and
+nullptr is returned if a node with the exact identifier and type
+does not exist.
+Optionally, a filter can be specified to consider just the default
+versions of nodes matching name (the default) or all versions of
+the nodes.
+
+Parameters
+
+name (str) – 
+sourceType (str) – 
+filter (VersionFilter) – 
+
+GetNodeFromAsset(asset, metadata, subIdentifier, sourceType) → Node
+Parses the given asset , constructs a NdrNode from it and adds it
+to the registry.
+Nodes created from an asset using this API can be looked up by the
+unique identifier and sourceType of the returned node, or by URI,
+which will be set to the unresolved asset path value.
+metadata contains additional metadata needed for parsing and
+compiling the source code in the file pointed to by asset
+correctly. This metadata supplements the metadata available in the
+asset and overrides it in cases where there are key collisions.
+subidentifier is optional, and it would be used to indicate a
+particular definition in the asset file if the asset contains multiple
+node definitions.
+sourceType is optional, and it is only needed to indicate a
+particular type if the asset file is capable of representing a node
+definition of multiple source types.
+Returns a valid node if the asset is parsed successfully using one of
+the registered parser plugins.
+
+Parameters
+
+asset (AssetPath) – 
+metadata (NdrTokenMap) – 
+subIdentifier (str) – 
+sourceType (str) – 
+
+GetNodeFromSourceCode(sourceCode, sourceType, metadata) → Node
+Parses the given sourceCode string, constructs a NdrNode from it
+and adds it to the registry.
+The parser to be used is determined by the specified sourceType .
+Nodes created from source code using this API can be looked up by the
+unique identifier and sourceType of the returned node.
+metadata contains additional metadata needed for parsing and
+compiling the source code correctly. This metadata supplements the
+metadata available in sourceCode and overrides it cases where
+there are key collisions.
+Returns a valid node if the given source code is parsed successfully
+using the parser plugins that is registered for the specified
+sourceType .
+
+Parameters
+
+sourceCode (str) – 
+sourceType (str) – 
+metadata (NdrTokenMap) – 
+
+GetNodeIdentifiers(family, filter) → NdrIdentifierVec
+Get the identifiers of all the nodes that the registry is aware of.
+This will not run the parsing plugins on the nodes that have been
+discovered, so this method is relatively quick. Optionally,
+a”family”name can be specified to only get the identifiers of nodes
+that belong to that family and a filter can be specified to get just
+the default version (the default) or all versions of the node.
+
+Parameters
+
+family (str) – 
+filter (VersionFilter) – 
+
+GetNodeNames(family) → NdrStringVec
+Get the names of all the nodes that the registry is aware of.
+This will not run the parsing plugins on the nodes that have been
+discovered, so this method is relatively quick. Optionally,
+a”family”name can be specified to only get the names of nodes that
+belong to that family.
+
+Parameters
+family (str) – 
+
+GetNodesByFamily(family, filter) → NdrNodeConstPtrVec
+Get all nodes from the registry, optionally restricted to the nodes
+that fall under a specified family and/or the default version.
+Note that this will parse all nodes that the registry is aware of
+(unless a family is specified), so this may take some time to run the
+first time it is called.
+
+Parameters
+
+family (str) – 
+filter (VersionFilter) – 
+
+GetNodesByIdentifier(identifier) → NdrNodeConstPtrVec
+Get all nodes matching the specified identifier (multiple nodes of the
+same identifier, but different source types, may exist).
+If no nodes match the identifier, an empty vector is returned.
+
+Parameters
+identifier (NdrIdentifier) – 
+
+GetNodesByName(name, filter) → NdrNodeConstPtrVec
+Get all nodes matching the specified name.
+Only nodes matching the specified name will be parsed. Optionally, a
+filter can be specified to get just the default version (the default)
+or all versions of the node. If no nodes match an empty vector is
+returned.
+
+Parameters
+
+name (str) – 
+filter (VersionFilter) – 
+
+GetSearchURIs() → NdrStringVec
+Get the locations where the registry is searching for nodes.
+Depending on which discovery plugins were used, this may include non-
+filesystem paths.
+
+SetExtraDiscoveryPlugins(plugins) → None
+Allows the client to set any additional discovery plugins that would
+otherwise NOT be found through the plugin system.
+Runs the discovery process for the specified plugins immediately.
+Note that this method cannot be called after any nodes in the registry
+have been parsed (eg, through GetNode*()), otherwise an error will
+result.
+
+Parameters
+plugins (DiscoveryPluginRefPtrVec) – 
+
+SetExtraDiscoveryPlugins(pluginTypes) -> None
+Allows the client to set any additional discovery plugins that would
+otherwise NOT be found through the plugin system.
+Runs the discovery process for the specified plugins immediately.
+Note that this method cannot be called after any nodes in the registry
+have been parsed (eg, through GetNode*()), otherwise an error will
+result.
+
+Parameters
+pluginTypes (list[Type]) – 
+
+SetExtraParserPlugins(pluginTypes) → None
+Allows the client to set any additional parser plugins that would
+otherwise NOT be found through the plugin system.
+Note that this method cannot be called after any nodes in the registry
+have been parsed (eg, through GetNode*()), otherwise an error will
+result.
+
+Parameters
+pluginTypes (list[Type]) – 
+
+class pxr.Ndr.Version
+Methods:
+
+GetAsDefault()
+Return an equal version marked as default.
+
+GetMajor()
+Return the major version number or zero for an invalid version.
+
+GetMinor()
+Return the minor version number or zero for an invalid version.
+
+GetStringSuffix()
+Return the version as a identifier suffix.
+
+IsDefault()
+Return true iff this version is marked as default.
+
+GetAsDefault() → Version
+Return an equal version marked as default.
+It’s permitted to mark an invalid version as the default.
+
+GetMajor() → int
+Return the major version number or zero for an invalid version.
+
+GetMinor() → int
+Return the minor version number or zero for an invalid version.
+
+GetStringSuffix() → str
+Return the version as a identifier suffix.
+
+IsDefault() → bool
+Return true iff this version is marked as default.
+
+class pxr.Ndr.VersionFilter
+Methods:
+
+GetValueFromName
+
+Attributes:
+
+allValues
+
+static GetValueFromName()
+
+allValues = (Ndr.VersionFilterDefaultOnly, Ndr.VersionFilterAllVersions)
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

Pcp.md

@@ -0,0 +1,1659 @@
+
+
+Pcp module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+Pcp module
+
+ 
+
+# Pcp module
+
+Summary: The PrimCache Population module implements core scenegraph composition semantics - behaviors informally referred to as Layering & Referencing.
+
+Classes:
+
+ArcType
+
+Cache
+PcpCache is the context required to make requests of the Pcp composition algorithm and cache the results.
+
+Dependency
+Description of a dependency.
+
+DependencyType
+
+DynamicFileFormatDependencyData
+Contains the necessary information for storing a prim index's dependency on dynamic file format arguments and determining if a field change affects the prim index.
+
+ErrorArcCycle
+Arcs between PcpNodes that form a cycle.
+
+ErrorArcPermissionDenied
+Arcs that were not made between PcpNodes because of permission restrictions.
+
+ErrorBase
+Base class for all error types.
+
+ErrorCapacityExceeded
+Exceeded the capacity for composition arcs at a single site.
+
+ErrorInconsistentAttributeType
+Attributes that have specs with conflicting definitions.
+
+ErrorInconsistentAttributeVariability
+Attributes that have specs with conflicting variability.
+
+ErrorInconsistentPropertyType
+Properties that have specs with conflicting definitions.
+
+ErrorInvalidAssetPath
+Invalid asset paths used by references or payloads.
+
+ErrorInvalidAssetPathBase
+
+ErrorInvalidExternalTargetPath
+Invalid target or connection path in some scope that points to an object outside of that scope.
+
+ErrorInvalidInstanceTargetPath
+Invalid target or connection path authored in an inherited class that points to an instance of that class.
+
+ErrorInvalidPrimPath
+Invalid prim paths used by references or payloads.
+
+ErrorInvalidReferenceOffset
+References or payloads that use invalid layer offsets.
+
+ErrorInvalidSublayerOffset
+Sublayers that use invalid layer offsets.
+
+ErrorInvalidSublayerOwnership
+Sibling layers that have the same owner.
+
+ErrorInvalidSublayerPath
+Asset paths that could not be both resolved and loaded.
+
+ErrorInvalidTargetPath
+Invalid target or connection path.
+
+ErrorMutedAssetPath
+Muted asset paths used by references or payloads.
+
+ErrorOpinionAtRelocationSource
+Opinions were found at a relocation source path.
+
+ErrorPrimPermissionDenied
+Layers with illegal opinions about private prims.
+
+ErrorPropertyPermissionDenied
+Layers with illegal opinions about private properties.
+
+ErrorSublayerCycle
+Layers that recursively sublayer themselves.
+
+ErrorTargetPathBase
+Base class for composition errors related to target or connection paths.
+
+ErrorTargetPermissionDenied
+Paths with illegal opinions about private targets.
+
+ErrorType
+
+ErrorUnresolvedPrimPath
+Asset paths that could not be both resolved and loaded.
+
+InstanceKey
+A PcpInstanceKey identifies instanceable prim indexes that share the same set of opinions.
+
+LayerStack
+Represents a stack of layers that contribute opinions to composition.
+
+LayerStackIdentifier
+Arguments used to identify a layer stack.
+
+LayerStackSite
+A site specifies a path in a layer stack of scene description.
+
+MapExpression
+An expression that yields a PcpMapFunction value.
+
+MapFunction
+A function that maps values from one namespace (and time domain) to another.
+
+NodeRef
+PcpNode represents a node in an expression tree for compositing scene description.
+
+PrimIndex
+PcpPrimIndex is an index of the all sites of scene description that contribute opinions to a specific prim, under composition semantics.
+
+PropertyIndex
+PcpPropertyIndex is an index of all sites in scene description that contribute opinions to a specific property, under composition semantics.
+
+Site
+A site specifies a path in a layer stack of scene description.
+
+class pxr.Pcp.ArcType
+Methods:
+
+GetValueFromName
+
+Attributes:
+
+allValues
+
+static GetValueFromName()
+
+allValues = (Pcp.ArcTypeRoot, Pcp.ArcTypeInherit, Pcp.ArcTypeRelocate, Pcp.ArcTypeVariant, Pcp.ArcTypeReference, Pcp.ArcTypePayload, Pcp.ArcTypeSpecialize)
+
+class pxr.Pcp.Cache
+PcpCache is the context required to make requests of the Pcp
+composition algorithm and cache the results.
+Because the algorithms are recursive  making a request typically makes
+other internal requests to solve subproblems  caching subproblem
+results is required for reasonable performance, and so this cache is
+the only entrypoint to the algorithms.
+There is a set of parameters that affect the composition results:
+
+variant fallbacks: per named variant set, an ordered list of
+fallback values to use when composing a prim that defines a variant
+set but does not specify a selection
+payload inclusion set: an SdfPath set used to identify which
+prims should have their payloads included during composition; this is
+the basis for explicit control over the”working set”of composition
+file format target: the file format target that Pcp will request
+when opening scene description layers
+“USD mode”configures the Pcp composition algorithm to provide
+only a custom, lighter subset of the full feature set, as needed by
+the Universal Scene Description system
+There are a number of different computations that can be requested.
+These include computing a layer stack from a PcpLayerStackIdentifier,
+computing a prim index or prim stack, and computing a property index.
+
+Methods:
+
+ComputeAttributeConnectionPaths(...)
+Compute the attribute connection paths for the attribute at attributePath into paths .
+
+ComputeLayerStack(identifier, allErrors)
+Returns the layer stack for identifier if it exists, otherwise creates a new layer stack for identifier .
+
+ComputePrimIndex(primPath, allErrors)
+Compute and return a reference to the cached result for the prim index for the given path.
+
+ComputePropertyIndex(propPath, allErrors)
+Compute and return a reference to the cached result for the property index for the given path.
+
+ComputeRelationshipTargetPaths(...)
+Compute the relationship target paths for the relationship at relationshipPath into paths .
+
+FindAllLayerStacksUsingLayer(layer)
+Returns every computed & cached layer stack that includes layer .
+
+FindPrimIndex(primPath)
+Returns a pointer to the cached computed prim index for the given path, or None if it has not been computed.
+
+FindPropertyIndex(propPath)
+Returns a pointer to the cached computed property index for the given path, or None if it has not been computed.
+
+FindSiteDependencies(siteLayerStack, ...)
+Returns dependencies on the given site of scene description, as discovered by the cached index computations.
+
+GetDynamicFileFormatArgumentDependencyData(...)
+Returns the dynamic file format dependency data object for the prim index with the given primIndexPath .
+
+GetLayerStackIdentifier()
+Get the identifier of the layerStack used for composition.
+
+GetMutedLayers()
+Returns the list of canonical identifiers for muted layers in this cache.
+
+GetUsedLayers()
+Returns set of all layers used by this cache.
+
+GetUsedLayersRevision()
+Return a number that can be used to determine whether or not the set of layers used by this cache may have changed or not.
+
+GetVariantFallbacks()
+Get the list of fallbacks to attempt to use when evaluating variant sets that lack an authored selection.
+
+HasAnyDynamicFileFormatArgumentDependencies()
+Returns true if any prim index in this cache has a dependency on a dynamic file format argument field.
+
+HasRootLayerStack(layerStack)
+Return true if this cache's root layer stack is layerStack , false otherwise.
+
+IsInvalidAssetPath(resolvedAssetPath)
+Returns true if resolvedAssetPath was used by a prim (e.g.
+
+IsInvalidSublayerIdentifier(identifier)
+Returns true if identifier was used as a sublayer path in a layer stack but did not identify a valid layer.
+
+IsLayerMuted(layerIdentifier)
+Returns true if the layer specified by layerIdentifier is muted in this cache, false otherwise.
+
+IsPayloadIncluded(path)
+Return true if the payload is included for the given path.
+
+IsPossibleDynamicFileFormatArgumentField(field)
+Returns true if the given field is the name of a field that was composed while generating dynamic file format arguments for any prim index in this cache.
+
+PrintStatistics()
+Prints various statistics about the data stored in this cache.
+
+Reload(changes)
+Reload the layers of the layer stack, except session layers and sublayers of session layers.
+
+RequestLayerMuting(layersToMute, ...)
+Request layers to be muted or unmuted in this cache.
+
+RequestPayloads(pathsToInclude, ...)
+Request payloads to be included or excluded from composition.
+
+SetVariantFallbacks(map, changes)
+Set the list of fallbacks to attempt to use when evaluating variant sets that lack an authored selection.
+
+UsesLayerStack(layerStack)
+Return true if layerStack is used by this cache in its composition, false otherwise.
+
+Attributes:
+
+fileFormatTarget
+str
+
+layerStack
+LayerStack
+
+ComputeAttributeConnectionPaths(attributePath, paths, localOnly, stopProperty, includeStopProperty, deletedPaths, allErrors) → None
+Compute the attribute connection paths for the attribute at
+attributePath into paths .
+If localOnly is true then this will compose attribute
+connections from local nodes only. If stopProperty is not None
+then this will stop composing attribute connections at
+stopProperty , including stopProperty iff
+includeStopProperty is true . If not None ,
+deletedPaths will be populated with connection paths whose
+deletion contributed to the computed result. allErrors will
+contain any errors encountered while performing this operation.
+
+Parameters
+
+attributePath (Path) – 
+paths (list[SdfPath]) – 
+localOnly (bool) – 
+stopProperty (Spec) – 
+includeStopProperty (bool) – 
+deletedPaths (list[SdfPath]) – 
+allErrors (list[PcpError]) – 
+
+ComputeLayerStack(identifier, allErrors) → LayerStack
+Returns the layer stack for identifier if it exists, otherwise
+creates a new layer stack for identifier .
+This returns None if identifier is invalid (i.e. its root
+layer is None ). allErrors will contain any errors encountered
+while creating a new layer stack. It’ll be unchanged if the layer
+stack already existed.
+
+Parameters
+
+identifier (LayerStackIdentifier) – 
+allErrors (list[PcpError]) – 
+
+ComputePrimIndex(primPath, allErrors) → PrimIndex
+Compute and return a reference to the cached result for the prim index
+for the given path.
+allErrors will contain any errors encountered while performing
+this operation.
+
+Parameters
+
+primPath (Path) – 
+allErrors (list[PcpError]) – 
+
+ComputePropertyIndex(propPath, allErrors) → PropertyIndex
+Compute and return a reference to the cached result for the property
+index for the given path.
+allErrors will contain any errors encountered while performing
+this operation.
+
+Parameters
+
+propPath (Path) – 
+allErrors (list[PcpError]) – 
+
+ComputeRelationshipTargetPaths(relationshipPath, paths, localOnly, stopProperty, includeStopProperty, deletedPaths, allErrors) → None
+Compute the relationship target paths for the relationship at
+relationshipPath into paths .
+If localOnly is true then this will compose relationship
+targets from local nodes only. If stopProperty is not None
+then this will stop composing relationship targets at stopProperty
+, including stopProperty iff includeStopProperty is true .
+If not None , deletedPaths will be populated with target paths
+whose deletion contributed to the computed result. allErrors will
+contain any errors encountered while performing this operation.
+
+Parameters
+
+relationshipPath (Path) – 
+paths (list[SdfPath]) – 
+localOnly (bool) – 
+stopProperty (Spec) – 
+includeStopProperty (bool) – 
+deletedPaths (list[SdfPath]) – 
+allErrors (list[PcpError]) – 
+
+FindAllLayerStacksUsingLayer(layer) → list[PcpLayerStackPtr]
+Returns every computed & cached layer stack that includes layer .
+
+Parameters
+layer (Layer) – 
+
+FindPrimIndex(primPath) → PrimIndex
+Returns a pointer to the cached computed prim index for the given
+path, or None if it has not been computed.
+
+Parameters
+primPath (Path) – 
+
+FindPropertyIndex(propPath) → PropertyIndex
+Returns a pointer to the cached computed property index for the given
+path, or None if it has not been computed.
+
+Parameters
+propPath (Path) – 
+
+FindSiteDependencies(siteLayerStack, sitePath, depMask, recurseOnSite, recurseOnIndex, filterForExistingCachesOnly) → list[PcpDependency]
+Returns dependencies on the given site of scene description, as
+discovered by the cached index computations.
+depMask
+specifies what classes of dependency to include; see
+PcpDependencyFlags for details recurseOnSite
+includes incoming dependencies on children of sitePath recurseOnIndex
+extends the result to include all PcpCache child indexes below
+discovered results filterForExistingCachesOnly
+filters the results to only paths representing computed prim and
+property index caches; otherwise a recursively-expanded result can
+include un-computed paths that are expected to depend on the site
+
+Parameters
+
+siteLayerStack (LayerStack) – 
+sitePath (Path) – 
+depMask (PcpDependencyFlags) – 
+recurseOnSite (bool) – 
+recurseOnIndex (bool) – 
+filterForExistingCachesOnly (bool) – 
+
+FindSiteDependencies(siteLayer, sitePath, depMask, recurseOnSite, recurseOnIndex, filterForExistingCachesOnly) -> list[PcpDependency]
+Returns dependencies on the given site of scene description, as
+discovered by the cached index computations.
+This method overload takes a site layer rather than a layer stack. It
+will check every layer stack using that layer, and apply any relevant
+sublayer offsets to the map functions in the returned
+PcpDependencyVector.
+See the other method for parameter details.
+
+Parameters
+
+siteLayer (Layer) – 
+sitePath (Path) – 
+depMask (PcpDependencyFlags) – 
+recurseOnSite (bool) – 
+recurseOnIndex (bool) – 
+filterForExistingCachesOnly (bool) – 
+
+GetDynamicFileFormatArgumentDependencyData(primIndexPath) → DynamicFileFormatDependencyData
+Returns the dynamic file format dependency data object for the prim
+index with the given primIndexPath .
+This will return an empty dependency data if either there is no cache
+prim index for the path or if the prim index has no dynamic file
+formats that it depends on.
+
+Parameters
+primIndexPath (Path) – 
+
+GetLayerStackIdentifier() → LayerStackIdentifier
+Get the identifier of the layerStack used for composition.
+
+GetMutedLayers() → list[str]
+Returns the list of canonical identifiers for muted layers in this
+cache.
+See documentation on RequestLayerMuting for more details.
+
+GetUsedLayers() → SdfLayerHandleSet
+Returns set of all layers used by this cache.
+
+GetUsedLayersRevision() → int
+Return a number that can be used to determine whether or not the set
+of layers used by this cache may have changed or not.
+For example, if one calls GetUsedLayers() and saves the
+GetUsedLayersRevision() , and then later calls GetUsedLayersRevision()
+again, if the number is unchanged, then GetUsedLayers() is guaranteed
+to be unchanged as well.
+
+GetVariantFallbacks() → PcpVariantFallbackMap
+Get the list of fallbacks to attempt to use when evaluating variant
+sets that lack an authored selection.
+
+HasAnyDynamicFileFormatArgumentDependencies() → bool
+Returns true if any prim index in this cache has a dependency on a
+dynamic file format argument field.
+
+HasRootLayerStack(layerStack) → bool
+Return true if this cache’s root layer stack is layerStack , false
+otherwise.
+This is functionally equivalent to comparing against the result of
+GetLayerStack() , but does not require constructing a TfWeakPtr or any
+refcount operations.
+
+Parameters
+layerStack (LayerStack) – 
+
+HasRootLayerStack(layerStack) -> bool
+This is an overloaded member function, provided for convenience. It
+differs from the above function only in what argument(s) it accepts.
+
+Parameters
+layerStack (LayerStack) – 
+
+IsInvalidAssetPath(resolvedAssetPath) → bool
+Returns true if resolvedAssetPath was used by a prim (e.g.
+in a reference) but did not resolve to a valid asset. This is
+functionally equivalent to examining the values in the map returned by
+GetInvalidAssetPaths, but more efficient.
+
+Parameters
+resolvedAssetPath (str) – 
+
+IsInvalidSublayerIdentifier(identifier) → bool
+Returns true if identifier was used as a sublayer path in a layer
+stack but did not identify a valid layer.
+This is functionally equivalent to examining the values in the vector
+returned by GetInvalidSublayerIdentifiers, but more efficient.
+
+Parameters
+identifier (str) – 
+
+IsLayerMuted(layerIdentifier) → bool
+Returns true if the layer specified by layerIdentifier is muted in
+this cache, false otherwise.
+If layerIdentifier is relative, it is assumed to be relative to
+this cache’s root layer. See documentation on RequestLayerMuting for
+more details.
+
+Parameters
+layerIdentifier (str) – 
+
+IsLayerMuted(anchorLayer, layerIdentifier, canonicalMutedLayerIdentifier) -> bool
+Returns true if the layer specified by layerIdentifier is muted in
+this cache, false otherwise.
+If layerIdentifier is relative, it is assumed to be relative to
+anchorLayer . If canonicalMutedLayerIdentifier is supplied, it
+will be populated with the canonical identifier of the muted layer if
+this function returns true. See documentation on RequestLayerMuting
+for more details.
+
+Parameters
+
+anchorLayer (Layer) – 
+layerIdentifier (str) – 
+canonicalMutedLayerIdentifier (str) – 
+
+IsPayloadIncluded(path) → bool
+Return true if the payload is included for the given path.
+
+Parameters
+path (Path) – 
+
+IsPossibleDynamicFileFormatArgumentField(field) → bool
+Returns true if the given field is the name of a field that was
+composed while generating dynamic file format arguments for any prim
+index in this cache.
+
+Parameters
+field (str) – 
+
+PrintStatistics() → None
+Prints various statistics about the data stored in this cache.
+
+Reload(changes) → None
+Reload the layers of the layer stack, except session layers and
+sublayers of session layers.
+This will also try to load sublayers in this cache’s layer stack that
+could not be loaded previously. It will also try to load any
+referenced or payloaded layer that could not be loaded previously.
+Clients should subsequently Apply() changes to use any now-
+valid layers.
+
+Parameters
+changes (PcpChanges) – 
+
+RequestLayerMuting(layersToMute, layersToUnmute, changes, newLayersMuted, newLayersUnmuted) → None
+Request layers to be muted or unmuted in this cache.
+Muted layers are ignored during composition and do not appear in any
+layer stacks. The root layer of this stage may not be muted;
+attempting to do so will generate a coding error. If the root layer of
+a reference or payload layer stack is muted, the behavior is as if the
+muted layer did not exist, which means a composition error will be
+generated.
+A canonical identifier for each layer in layersToMute will be
+computed using ArResolver::CreateIdentifier using the cache’s root
+layer as the anchoring asset. Any layer encountered during composition
+with the same identifier will be considered muted and ignored.
+Note that muting a layer will cause this cache to release all
+references to that layer. If no other client is holding on to
+references to that layer, it will be unloaded. In this case, if there
+are unsaved edits to the muted layer, those edits are lost.  Since
+anonymous layers are not serialized, muting an anonymous layer will
+cause that layer and its contents to be lost in this case.
+If changes is not nullptr , it is adjusted to reflect the
+changes necessary to see the change in muted layers. Otherwise, those
+changes are applied immediately.
+newLayersMuted and newLayersUnmuted contains the pruned vector
+of layers which are muted or unmuted by this call to
+RequestLayerMuting.
+
+Parameters
+
+layersToMute (list[str]) – 
+layersToUnmute (list[str]) – 
+changes (PcpChanges) – 
+newLayersMuted (list[str]) – 
+newLayersUnmuted (list[str]) – 
+
+RequestPayloads(pathsToInclude, pathsToExclude, changes) → None
+Request payloads to be included or excluded from composition.
+pathsToInclude
+is a set of paths to add to the set for payload inclusion.
+pathsToExclude
+is a set of paths to remove from the set for payload inclusion.
+changes
+if not None , is adjusted to reflect the changes necessary to see
+the change in payloads; otherwise those changes are applied
+immediately.
+If a path is listed in both pathsToInclude and pathsToExclude, it will
+be treated as an inclusion only.
+
+Parameters
+
+pathsToInclude (SdfPathSet) – 
+pathsToExclude (SdfPathSet) – 
+changes (PcpChanges) – 
+
+SetVariantFallbacks(map, changes) → None
+Set the list of fallbacks to attempt to use when evaluating variant
+sets that lack an authored selection.
+If changes is not None then it’s adjusted to reflect the
+changes necessary to see the change in standin preferences, otherwise
+those changes are applied immediately.
+
+Parameters
+
+map (PcpVariantFallbackMap) – 
+changes (PcpChanges) – 
+
+UsesLayerStack(layerStack) → bool
+Return true if layerStack is used by this cache in its
+composition, false otherwise.
+
+Parameters
+layerStack (LayerStack) – 
+
+property fileFormatTarget
+str
+Returns the file format target this cache is configured for.
+
+Type
+type
+
+property layerStack
+LayerStack
+Get the layer stack for GetLayerStackIdentifier() .
+Note that this will neither compute the layer stack nor report errors.
+So if the layer stack has not been computed yet this will return
+None . Use ComputeLayerStack() if you need to compute the layer
+stack if it hasn’t been computed already and/or get errors caused by
+computing the layer stack.
+
+Type
+type
+
+class pxr.Pcp.Dependency
+Description of a dependency.
+Attributes:
+
+indexPath
+
+mapFunc
+
+sitePath
+
+property indexPath
+
+property mapFunc
+
+property sitePath
+
+class pxr.Pcp.DependencyType
+Methods:
+
+GetValueFromName
+
+Attributes:
+
+allValues
+
+static GetValueFromName()
+
+allValues = (Pcp.DependencyTypeNone, Pcp.DependencyTypeRoot, Pcp.DependencyTypePurelyDirect, Pcp.DependencyTypePartlyDirect, Pcp.DependencyTypeDirect, Pcp.DependencyTypeAncestral, Pcp.DependencyTypeVirtual, Pcp.DependencyTypeNonVirtual, Pcp.DependencyTypeAnyNonVirtual, Pcp.DependencyTypeAnyIncludingVirtual)
+
+class pxr.Pcp.DynamicFileFormatDependencyData
+Contains the necessary information for storing a prim index’s
+dependency on dynamic file format arguments and determining if a field
+change affects the prim index. This data structure does not store the
+prim index or its path itself and is expected to be the data in some
+other data structure that maps prim indexes to its dependencies.
+Methods:
+
+CanFieldChangeAffectFileFormatArguments(...)
+Given a field name and the changed field values in oldAndNewValues this return whether this change can affect any of the file format arguments generated by any of the contexts stored in this dependency.
+
+GetRelevantFieldNames()
+Returns a list of field names that were composed for any of the dependency contexts that were added to this dependency.
+
+IsEmpty()
+Returns whether this dependency data is empty.
+
+CanFieldChangeAffectFileFormatArguments(fieldName, oldValue, newValue) → bool
+Given a field name and the changed field values in
+oldAndNewValues this return whether this change can affect any of
+the file format arguments generated by any of the contexts stored in
+this dependency.
+
+Parameters
+
+fieldName (str) – 
+oldValue (VtValue) – 
+newValue (VtValue) – 
+
+GetRelevantFieldNames() → str.Set
+Returns a list of field names that were composed for any of the
+dependency contexts that were added to this dependency.
+
+IsEmpty() → bool
+Returns whether this dependency data is empty.
+
+class pxr.Pcp.ErrorArcCycle
+Arcs between PcpNodes that form a cycle.
+
+class pxr.Pcp.ErrorArcPermissionDenied
+Arcs that were not made between PcpNodes because of permission
+restrictions.
+
+class pxr.Pcp.ErrorBase
+Base class for all error types.
+Attributes:
+
+errorType
+
+property errorType
+
+class pxr.Pcp.ErrorCapacityExceeded
+Exceeded the capacity for composition arcs at a single site.
+
+class pxr.Pcp.ErrorInconsistentAttributeType
+Attributes that have specs with conflicting definitions.
+
+class pxr.Pcp.ErrorInconsistentAttributeVariability
+Attributes that have specs with conflicting variability.
+
+class pxr.Pcp.ErrorInconsistentPropertyType
+Properties that have specs with conflicting definitions.
+
+class pxr.Pcp.ErrorInvalidAssetPath
+Invalid asset paths used by references or payloads.
+
+class pxr.Pcp.ErrorInvalidAssetPathBase
+
+class pxr.Pcp.ErrorInvalidExternalTargetPath
+Invalid target or connection path in some scope that points to an
+object outside of that scope.
+
+class pxr.Pcp.ErrorInvalidInstanceTargetPath
+Invalid target or connection path authored in an inherited class that
+points to an instance of that class.
+
+class pxr.Pcp.ErrorInvalidPrimPath
+Invalid prim paths used by references or payloads.
+
+class pxr.Pcp.ErrorInvalidReferenceOffset
+References or payloads that use invalid layer offsets.
+
+class pxr.Pcp.ErrorInvalidSublayerOffset
+Sublayers that use invalid layer offsets.
+
+class pxr.Pcp.ErrorInvalidSublayerOwnership
+Sibling layers that have the same owner.
+
+class pxr.Pcp.ErrorInvalidSublayerPath
+Asset paths that could not be both resolved and loaded.
+
+class pxr.Pcp.ErrorInvalidTargetPath
+Invalid target or connection path.
+
+class pxr.Pcp.ErrorMutedAssetPath
+Muted asset paths used by references or payloads.
+
+class pxr.Pcp.ErrorOpinionAtRelocationSource
+Opinions were found at a relocation source path.
+
+class pxr.Pcp.ErrorPrimPermissionDenied
+Layers with illegal opinions about private prims.
+
+class pxr.Pcp.ErrorPropertyPermissionDenied
+Layers with illegal opinions about private properties.
+
+class pxr.Pcp.ErrorSublayerCycle
+Layers that recursively sublayer themselves.
+
+class pxr.Pcp.ErrorTargetPathBase
+Base class for composition errors related to target or connection
+paths.
+
+class pxr.Pcp.ErrorTargetPermissionDenied
+Paths with illegal opinions about private targets.
+
+class pxr.Pcp.ErrorType
+Methods:
+
+GetValueFromName
+
+Attributes:
+
+allValues
+
+static GetValueFromName()
+
+allValues = (Pcp.ErrorType_ArcCycle, Pcp.ErrorType_ArcPermissionDenied, Pcp.ErrorType_IndexCapacityExceeded, Pcp.ErrorType_ArcCapacityExceeded, Pcp.ErrorType_ArcNamespaceDepthCapacityExceeded, Pcp.ErrorType_InconsistentPropertyType, Pcp.ErrorType_InconsistentAttributeType, Pcp.ErrorType_InconsistentAttributeVariability, Pcp.ErrorType_InternalAssetPath, Pcp.ErrorType_InvalidPrimPath, Pcp.ErrorType_InvalidAssetPath, Pcp.ErrorType_InvalidInstanceTargetPath, Pcp.ErrorType_InvalidExternalTargetPath, Pcp.ErrorType_InvalidTargetPath, Pcp.ErrorType_InvalidReferenceOffset, Pcp.ErrorType_InvalidSublayerOffset, Pcp.ErrorType_InvalidSublayerOwnership, Pcp.ErrorType_InvalidSublayerPath, Pcp.ErrorType_InvalidVariantSelection, Pcp.ErrorType_OpinionAtRelocationSource, Pcp.ErrorType_PrimPermissionDenied, Pcp.ErrorType_PropertyPermissionDenied, Pcp.ErrorType_SublayerCycle, Pcp.ErrorType_TargetPermissionDenied, Pcp.ErrorType_UnresolvedPrimPath)
+
+class pxr.Pcp.ErrorUnresolvedPrimPath
+Asset paths that could not be both resolved and loaded.
+
+class pxr.Pcp.InstanceKey
+A PcpInstanceKey identifies instanceable prim indexes that share the
+same set of opinions. Instanceable prim indexes with equal instance
+keys are guaranteed to have the same opinions for name children and
+properties beneath those name children. They are NOT guaranteed to
+have the same opinions for direct properties of the prim indexes
+themselves.
+
+class pxr.Pcp.LayerStack
+Represents a stack of layers that contribute opinions to composition.
+Each PcpLayerStack is identified by a PcpLayerStackIdentifier. This
+identifier contains all of the parameters needed to construct a layer
+stack, such as the root layer, session layer, and path resolver
+context.
+PcpLayerStacks are constructed and managed by a
+Pcp_LayerStackRegistry.
+Attributes:
+
+expired
+True if this object has expired, False otherwise.
+
+identifier
+LayerStackIdentifier
+
+incrementalRelocatesSourceToTarget
+SdfRelocatesMap
+
+incrementalRelocatesTargetToSource
+SdfRelocatesMap
+
+layerOffsets
+
+layerTree
+LayerTree
+
+layers
+list[SdfLayerRefPtr]
+
+localErrors
+list[PcpError]
+
+mutedLayers
+set[str]
+
+pathsToPrimsWithRelocates
+list[SdfPath]
+
+relocatesSourceToTarget
+SdfRelocatesMap
+
+relocatesTargetToSource
+SdfRelocatesMap
+
+property expired
+True if this object has expired, False otherwise.
+
+property identifier
+LayerStackIdentifier
+Returns the identifier for this layer stack.
+
+Type
+type
+
+property incrementalRelocatesSourceToTarget
+SdfRelocatesMap
+Returns incremental relocation source-to-target mapping for this layer
+stack.
+This map contains the individual relocation entries found across all
+layers in this layer stack; it does not combine ancestral entries with
+descendant entries. For instance, if this layer stack contains
+relocations { /A: /B} and { /A/C: /A/D}, this map will contain { /A:
+/B} and { /A/C: /A/D}.
+
+Type
+type
+
+property incrementalRelocatesTargetToSource
+SdfRelocatesMap
+Returns incremental relocation target-to-source mapping for this layer
+stack.
+See GetIncrementalRelocatesTargetToSource for more details.
+
+Type
+type
+
+property layerOffsets
+
+property layerTree
+LayerTree
+Returns the layer tree representing the structure of this layer stack.
+
+Type
+type
+
+property layers
+list[SdfLayerRefPtr]
+Returns the layers in this layer stack in strong-to-weak order.
+Note that this is only the local layer stack  it does not include
+any layers brought in by references inside prims.
+
+Type
+type
+
+property localErrors
+list[PcpError]
+Return the list of errors local to this layer stack.
+
+Type
+type
+
+property mutedLayers
+set[str]
+Returns the set of layers that were muted in this layer stack.
+
+Type
+type
+
+property pathsToPrimsWithRelocates
+list[SdfPath]
+Returns a list of paths to all prims across all layers in this layer
+stack that contained relocates.
+
+Type
+type
+
+property relocatesSourceToTarget
+SdfRelocatesMap
+Returns relocation source-to-target mapping for this layer stack.
+This map combines the individual relocation entries found across all
+layers in this layer stack; multiple entries that affect a single prim
+will be combined into a single entry. For instance, if this layer
+stack contains relocations { /A: /B} and { /A/C: /A/D}, this map will
+contain { /A: /B} and { /B/C: /B/D}. This allows consumers to go from
+unrelocated namespace to relocated namespace in a single step.
+
+Type
+type
+
+property relocatesTargetToSource
+SdfRelocatesMap
+Returns relocation target-to-source mapping for this layer stack.
+See GetRelocatesSourceToTarget for more details.
+
+Type
+type
+
+class pxr.Pcp.LayerStackIdentifier
+Arguments used to identify a layer stack.
+Objects of this type are immutable.
+Attributes:
+
+pathResolverContext
+
+rootLayer
+
+sessionLayer
+
+property pathResolverContext
+
+property rootLayer
+
+property sessionLayer
+
+class pxr.Pcp.LayerStackSite
+A site specifies a path in a layer stack of scene description.
+Attributes:
+
+layerStack
+
+path
+
+property layerStack
+
+property path
+
+class pxr.Pcp.MapExpression
+An expression that yields a PcpMapFunction value.
+Expressions comprise constant values, variables, and operators applied
+to sub-expressions. Expressions cache their computed values
+internally. Assigning a new value to a variable automatically
+invalidates the cached values of dependent expressions. Common
+(sub-)expressions are automatically detected and shared.
+PcpMapExpression exists solely to support efficient incremental
+handling of relocates edits. It represents a tree of the namespace
+mapping operations and their inputs, so we can narrowly redo the
+computation when one of the inputs changes.
+Methods:
+
+AddRootIdentity()
+Return a new expression representing this expression with an added (if necessary) mapping from</>to</>.
+
+Compose(f)
+Create a new PcpMapExpression representing the application of f's value, followed by the application of this expression's value.
+
+Constant
+classmethod Constant(constValue) -> MapExpression
+
+Evaluate()
+Evaluate this expression, yielding a PcpMapFunction value.
+
+Identity
+classmethod Identity() -> MapExpression
+
+Inverse()
+Create a new PcpMapExpression representing the inverse of f.
+
+MapSourceToTarget(path)
+Map a path in the source namespace to the target.
+
+MapTargetToSource(path)
+Map a path in the target namespace to the source.
+
+Attributes:
+
+isIdentity
+bool
+
+isNull
+bool
+
+timeOffset
+LayerOffset
+
+AddRootIdentity() → MapExpression
+Return a new expression representing this expression with an added (if
+necessary) mapping from</>to</>.
+
+Compose(f) → MapExpression
+Create a new PcpMapExpression representing the application of f’s
+value, followed by the application of this expression’s value.
+
+Parameters
+f (MapExpression) – 
+
+static Constant()
+classmethod Constant(constValue) -> MapExpression
+Create a new constant.
+
+Parameters
+constValue (Value) – 
+
+Evaluate() → Value
+Evaluate this expression, yielding a PcpMapFunction value.
+The computed result is cached. The return value is a reference to the
+internal cached value. The cache is automatically invalidated as
+needed.
+
+static Identity()
+classmethod Identity() -> MapExpression
+Return an expression representing PcpMapFunction::Identity() .
+
+static Inverse() → MapExpression
+Create a new PcpMapExpression representing the inverse of f.
+
+MapSourceToTarget(path) → Path
+Map a path in the source namespace to the target.
+If the path is not in the domain, returns an empty path.
+
+Parameters
+path (Path) – 
+
+MapTargetToSource(path) → Path
+Map a path in the target namespace to the source.
+If the path is not in the co-domain, returns an empty path.
+
+Parameters
+path (Path) – 
+
+property isIdentity
+bool
+Return true if the evaluated map function is the identity function.
+For identity, MapSourceToTarget() always returns the path unchanged.
+
+Type
+type
+
+property isNull
+bool
+Return true if this is a null expression.
+
+Type
+type
+
+property timeOffset
+LayerOffset
+The time offset of the mapping.
+
+Type
+type
+
+class pxr.Pcp.MapFunction
+A function that maps values from one namespace (and time domain) to
+another. It represents the transformation that an arc such as a
+reference arc applies as it incorporates values across the arc.
+Take the example of a reference arc, where a source path</Model>is
+referenced as a target path,</Model_1>. The source path</Model>is the
+source of the opinions; the target path</Model_1>is where they are
+incorporated in the scene. Values in the model that refer to paths
+relative to</Model>must be transformed to be relative
+to</Model_1>instead. The PcpMapFunction for the arc provides this
+service.
+Map functions have a specific domain, or set of values they can
+operate on. Any values outside the domain cannot be mapped. The domain
+precisely tracks what areas of namespace can be referred to across
+various forms of arcs.
+Map functions can be chained to represent a series of map operations
+applied in sequence. The map function represent the cumulative effect
+as efficiently as possible. For example, in the case of a chained
+reference from</Model>to</Model>to</Model>to</Model_1>, this is
+effectively the same as a mapping directly from</Model>to</Model_1>.
+Representing the cumulative effect of arcs in this way is important
+for handling larger scenes efficiently.
+Map functions can be inverted. Formally, map functions are
+bijections (one-to-one and onto), which ensures that they can be
+inverted. Put differently, no information is lost by applying a map
+function to set of values within its domain; they retain their
+distinct identities and can always be mapped back.
+One analogy that may or may not be helpful: In the same way a
+geometric transform maps a model’s points in its rest space into the
+world coordinates for a particular instance, a PcpMapFunction maps
+values about a referenced model into the composed scene for a
+particular instance of that model. But rather than translating and
+rotating points, the map function shifts the values in namespace (and
+time).
+Methods:
+
+Compose(f)
+Compose this map over the given map function.
+
+ComposeOffset(newOffset)
+Compose this map function over a hypothetical map function that has an identity path mapping and offset .
+
+GetInverse()
+Return the inverse of this map function.
+
+Identity
+classmethod Identity() -> MapFunction
+
+IdentityPathMap
+classmethod IdentityPathMap() -> PathMap
+
+MapSourceToTarget(path)
+Map a path in the source namespace to the target.
+
+MapTargetToSource(path)
+Map a path in the target namespace to the source.
+
+Attributes:
+
+isIdentity
+bool
+
+isIdentityPathMapping
+bool
+
+isNull
+bool
+
+sourceToTargetMap
+PathMap
+
+timeOffset
+LayerOffset
+
+Compose(f) → MapFunction
+Compose this map over the given map function.
+The result will represent the application of f followed by the
+application of this function.
+
+Parameters
+f (MapFunction) – 
+
+ComposeOffset(newOffset) → MapFunction
+Compose this map function over a hypothetical map function that has an
+identity path mapping and offset .
+This is equivalent to building such a map function and invoking
+Compose() , but is faster.
+
+Parameters
+newOffset (LayerOffset) – 
+
+GetInverse() → MapFunction
+Return the inverse of this map function.
+This returns a true inverse inv: for any path p in this function’s
+domain that it maps to p’, inv(p’) ->p.
+
+static Identity()
+classmethod Identity() -> MapFunction
+Construct an identity map function.
+
+static IdentityPathMap()
+classmethod IdentityPathMap() -> PathMap
+Returns an identity path mapping.
+
+MapSourceToTarget(path) → Path
+Map a path in the source namespace to the target.
+If the path is not in the domain, returns an empty path.
+
+Parameters
+path (Path) – 
+
+MapTargetToSource(path) → Path
+Map a path in the target namespace to the source.
+If the path is not in the co-domain, returns an empty path.
+
+Parameters
+path (Path) – 
+
+property isIdentity
+bool
+Return true if the map function is the identity function.
+The identity function has an identity path mapping and time offset.
+
+Type
+type
+
+property isIdentityPathMapping
+bool
+Return true if the map function uses the identity path mapping.
+If true, MapSourceToTarget() always returns the path unchanged.
+However, this map function may have a non-identity time offset.
+
+Type
+type
+
+property isNull
+bool
+Return true if this map function is the null function.
+For a null function, MapSourceToTarget() always returns an empty path.
+
+Type
+type
+
+property sourceToTargetMap
+PathMap
+The set of path mappings, from source to target.
+
+Type
+type
+
+property timeOffset
+LayerOffset
+The time offset of the mapping.
+
+Type
+type
+
+class pxr.Pcp.NodeRef
+PcpNode represents a node in an expression tree for compositing scene
+description.
+A node represents the opinions from a particular site. In addition, it
+may have child nodes, representing nested expressions that are
+composited over/under this node.
+Child nodes are stored and composited in strength order.
+Each node holds information about the arc to its parent. This captures
+both the relative strength of the sub-expression as well as any value-
+mapping needed, such as to rename opinions from a model to use in a
+particular instance.
+Methods:
+
+CanContributeSpecs()
+Returns true if this node is allowed to contribute opinions for composition, false otherwise.
+
+GetDepthBelowIntroduction()
+Return the number of levels of namespace this node's site is below the level at which it was introduced by an arc.
+
+GetIntroPath()
+Get the path that introduced this node.
+
+GetOriginRootNode()
+Walk up to the root origin node for this node.
+
+GetPathAtIntroduction()
+Returns the path for this node's site when it was introduced.
+
+GetRootNode()
+Walk up to the root node of this expression.
+
+IsDueToAncestor()
+
+IsRootNode()
+Returns true if this node is the root node of the prim index graph.
+
+Attributes:
+
+arcType
+ArcType
+
+children
+
+hasSpecs
+None
+
+hasSymmetry
+None
+
+isCulled
+bool
+
+isInert
+bool
+
+isRestricted
+bool
+
+layerStack
+LayerStack
+
+mapToParent
+MapExpression
+
+mapToRoot
+MapExpression
+
+namespaceDepth
+int
+
+origin
+
+parent
+
+path
+Path
+
+permission
+Permission
+
+siblingNumAtOrigin
+int
+
+site
+LayerStackSite
+
+CanContributeSpecs() → bool
+Returns true if this node is allowed to contribute opinions for
+composition, false otherwise.
+
+GetDepthBelowIntroduction() → int
+Return the number of levels of namespace this node’s site is below the
+level at which it was introduced by an arc.
+
+GetIntroPath() → Path
+Get the path that introduced this node.
+Specifically, this is the path the parent node had at the level of
+namespace where this node was added as a child. For a root node, this
+returns the absolute root path. See also GetDepthBelowIntroduction() .
+
+GetOriginRootNode() → NodeRef
+Walk up to the root origin node for this node.
+This is the very first node that caused this node to be added to the
+graph. For instance, the root origin node of an implied inherit is the
+original inherit node.
+
+GetPathAtIntroduction() → Path
+Returns the path for this node’s site when it was introduced.
+
+GetRootNode() → NodeRef
+Walk up to the root node of this expression.
+
+IsDueToAncestor() → bool
+
+IsRootNode() → bool
+Returns true if this node is the root node of the prim index graph.
+
+property arcType
+ArcType
+Returns the type of arc connecting this node to its parent node.
+
+Type
+type
+
+property children
+
+property hasSpecs
+None
+Returns true if this node has opinions authored for composition, false
+otherwise.
+
+Type
+type
+
+property hasSymmetry
+None
+Get/set whether this node provides any symmetry opinions, either
+directly or from a namespace ancestor.
+
+Type
+type
+
+property isCulled
+bool
+
+Type
+type
+
+property isInert
+bool
+
+Type
+type
+
+property isRestricted
+bool
+
+Type
+type
+
+property layerStack
+LayerStack
+Returns the layer stack for the site this node represents.
+
+Type
+type
+
+property mapToParent
+MapExpression
+Returns mapping function used to translate paths and values from this
+node to its parent node.
+
+Type
+type
+
+property mapToRoot
+MapExpression
+Returns mapping function used to translate paths and values from this
+node directly to the root node.
+
+Type
+type
+
+property namespaceDepth
+int
+Returns the absolute namespace depth of the node that introduced this
+node.
+Note that this does not count any variant selections.
+
+Type
+type
+
+property origin
+
+property parent
+
+property path
+Path
+Returns the path for the site this node represents.
+
+Type
+type
+
+property permission
+Permission
+
+type : None
+Get/set the permission for this node.
+This indicates whether specs on this node can be accessed from other
+nodes.
+
+Type
+type
+
+property siblingNumAtOrigin
+int
+Returns this node’s index among siblings with the same arc type at
+this node’s origin.
+
+Type
+type
+
+property site
+LayerStackSite
+Get the site this node represents.
+
+Type
+type
+
+class pxr.Pcp.PrimIndex
+PcpPrimIndex is an index of the all sites of scene description that
+contribute opinions to a specific prim, under composition semantics.
+PcpComputePrimIndex() builds an index (“indexes”) the given prim site.
+At any site there may be scene description values expressing arcs that
+represent instructions to pull in further scene description.
+PcpComputePrimIndex() recursively follows these arcs, building and
+ordering the results.
+Methods:
+
+ComposeAuthoredVariantSelections()
+Compose the authored prim variant selections.
+
+ComputePrimChildNames(nameOrder, ...)
+Compute the prim child names for the given path.
+
+ComputePrimPropertyNames(nameOrder)
+Compute the prim property names for the given path.
+
+DumpToDotGraph(filename, ...)
+Dump the prim index in dot format to the file named filename .
+
+DumpToString(includeInheritOriginInfo, ...)
+Dump the prim index contents to a string.
+
+GetNodeProvidingSpec(primSpec)
+Returns the node that brings opinions from primSpec into this prim index.
+
+GetSelectionAppliedForVariantSet(variantSet)
+Return the variant selection applied for the named variant set.
+
+IsInstanceable()
+Returns true if this prim index is instanceable.
+
+IsValid()
+Return true if this index is valid.
+
+PrintStatistics()
+Prints various statistics about this prim index.
+
+Attributes:
+
+hasAnyPayloads
+
+localErrors
+list[PcpError]
+
+primStack
+
+rootNode
+NodeRef
+
+ComposeAuthoredVariantSelections() → SdfVariantSelectionMap
+Compose the authored prim variant selections.
+These are the variant selections expressed in scene description. Note
+that these selections may not have actually been applied, if they are
+invalid.
+This result is not cached, but computed each time.
+
+ComputePrimChildNames(nameOrder, prohibitedNameSet) → None
+Compute the prim child names for the given path.
+errors will contain any errors encountered while performing this
+operation.
+
+Parameters
+
+nameOrder (list[TfToken]) – 
+prohibitedNameSet (PcpTokenSet) – 
+
+ComputePrimPropertyNames(nameOrder) → None
+Compute the prim property names for the given path.
+errors will contain any errors encountered while performing this
+operation. The nameOrder vector must not contain any duplicate
+entries.
+
+Parameters
+nameOrder (list[TfToken]) – 
+
+DumpToDotGraph(filename, includeInheritOriginInfo, includeMaps) → None
+Dump the prim index in dot format to the file named filename .
+See Dump(...) for information regarding arguments.
+
+Parameters
+
+filename (str) – 
+includeInheritOriginInfo (bool) – 
+includeMaps (bool) – 
+
+DumpToString(includeInheritOriginInfo, includeMaps) → str
+Dump the prim index contents to a string.
+If includeInheritOriginInfo is true , output for implied
+inherit nodes will include information about the originating inherit
+node. If includeMaps is true , output for each node will
+include the mappings to the parent and root node.
+
+Parameters
+
+includeInheritOriginInfo (bool) – 
+includeMaps (bool) – 
+
+GetNodeProvidingSpec(primSpec) → NodeRef
+Returns the node that brings opinions from primSpec into this prim
+index.
+If no such node exists, returns an invalid PcpNodeRef.
+
+Parameters
+primSpec (PrimSpec) – 
+
+GetNodeProvidingSpec(layer, path) -> NodeRef
+Returns the node that brings opinions from the Sd prim spec at
+layer and path into this prim index.
+If no such node exists, returns an invalid PcpNodeRef.
+
+Parameters
+
+layer (Layer) – 
+path (Path) – 
+
+GetSelectionAppliedForVariantSet(variantSet) → str
+Return the variant selection applied for the named variant set.
+If none was applied, this returns an empty string. This can be
+different from the authored variant selection; for example, if the
+authored selection is invalid.
+
+Parameters
+variantSet (str) – 
+
+IsInstanceable() → bool
+Returns true if this prim index is instanceable.
+Instanceable prim indexes with the same instance key are guaranteed to
+have the same set of opinions, but may not have local opinions about
+name children.
+PcpInstanceKey
+
+IsValid() → bool
+Return true if this index is valid.
+A default-constructed index is invalid.
+
+PrintStatistics() → None
+Prints various statistics about this prim index.
+
+property hasAnyPayloads
+
+property localErrors
+list[PcpError]
+Return the list of errors local to this prim.
+
+Type
+type
+
+property primStack
+
+property rootNode
+NodeRef
+Returns the root node of the prim index graph.
+
+Type
+type
+
+class pxr.Pcp.PropertyIndex
+PcpPropertyIndex is an index of all sites in scene description that
+contribute opinions to a specific property, under composition
+semantics.
+Attributes:
+
+localErrors
+list[PcpError]
+
+localPropertyStack
+
+propertyStack
+
+property localErrors
+list[PcpError]
+Return the list of errors local to this property.
+
+Type
+type
+
+property localPropertyStack
+
+property propertyStack
+
+class pxr.Pcp.Site
+A site specifies a path in a layer stack of scene description.
+Attributes:
+
+layerStack
+
+path
+
+property layerStack
+
+property path
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

PhysicsSchemaTools.md

@@ -0,0 +1,422 @@
+
+
+PhysicsSchemaTools module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+PhysicsSchemaTools module
+
+ 
+
+# PhysicsSchemaTools module
+
+Summary: Omniverse-specific: The Physics Schema Tools provides tools for the representation of physics properties and behaviors in a 3D scene, such as gravity, collisions, and rigid body dynamics.
+
+Classes:
+
+Path(*args, **kwargs)
+PurePath subclass that can make system calls.
+
+Functions:
+
+addActor
+
+addBoxCollisionShape
+
+addCollisionShape
+
+addDensity
+
+addDisplayColor
+
+addGroundPlane
+
+addGroundTriMesh
+
+addOrientation
+
+addPhysicsScene
+
+addPosition
+
+addRigidBody
+
+addRigidBox
+
+addRigidBoxForInstancing
+
+addRigidCapsule
+
+addRigidCone
+
+addRigidCylinder
+
+addRigidSphere
+
+addVelocity
+
+createMesh
+
+createMeshBox
+
+createMeshCapsule
+
+createMeshCylinder
+
+createMeshSphere
+
+createMeshSquare
+
+decodeSdfPath
+
+encodeSdfPath
+
+getMassSpaceInertia
+
+intToSdfPath
+
+sdfPathToInt
+
+class pxr.PhysicsSchemaTools.Path(*args, **kwargs)
+PurePath subclass that can make system calls.
+Path represents a filesystem path but unlike PurePath, also offers
+methods to do system calls on path objects. Depending on your system,
+instantiating a Path will return either a PosixPath or a WindowsPath
+object. You can also instantiate a PosixPath or WindowsPath directly,
+but cannot instantiate a WindowsPath on a POSIX system or vice versa.
+Methods:
+
+absolute()
+Return an absolute version of this path.
+
+chmod(mode, *[, follow_symlinks])
+Change the permissions of the path, like os.chmod().
+
+cwd()
+Return a new path pointing to the current working directory (as returned by os.getcwd()).
+
+exists()
+Whether this path exists.
+
+expanduser()
+Return a new path with expanded ~ and ~user constructs (as returned by os.path.expanduser)
+
+glob(pattern)
+Iterate over this subtree and yield all existing files (of any kind, including directories) matching the given relative pattern.
+
+group()
+Return the group name of the file gid.
+
+hardlink_to(target)
+Make this path a hard link pointing to the same file as target.
+
+home()
+Return a new path pointing to the user's home directory (as returned by os.path.expanduser('~')).
+
+is_block_device()
+Whether this path is a block device.
+
+is_char_device()
+Whether this path is a character device.
+
+is_dir()
+Whether this path is a directory.
+
+is_fifo()
+Whether this path is a FIFO.
+
+is_file()
+Whether this path is a regular file (also True for symlinks pointing to regular files).
+
+is_mount()
+Check if this path is a POSIX mount point
+
+is_socket()
+Whether this path is a socket.
+
+is_symlink()
+Whether this path is a symbolic link.
+
+iterdir()
+Iterate over the files in this directory.
+
+lchmod(mode)
+Like chmod(), except if the path points to a symlink, the symlink's permissions are changed, rather than its target's.
+
+link_to(target)
+Make the target path a hard link pointing to this path.
+
+lstat()
+Like stat(), except if the path points to a symlink, the symlink's status information is returned, rather than its target's.
+
+mkdir([mode, parents, exist_ok])
+Create a new directory at this given path.
+
+open([mode, buffering, encoding, errors, ...])
+Open the file pointed by this path and return a file object, as the built-in open() function does.
+
+owner()
+Return the login name of the file owner.
+
+read_bytes()
+Open the file in bytes mode, read it, and close the file.
+
+read_text([encoding, errors])
+Open the file in text mode, read it, and close the file.
+
+readlink()
+Return the path to which the symbolic link points.
+
+rename(target)
+Rename this path to the target path.
+
+replace(target)
+Rename this path to the target path, overwriting if that path exists.
+
+resolve([strict])
+Make the path absolute, resolving all symlinks on the way and also normalizing it (for example turning slashes into backslashes under Windows).
+
+rglob(pattern)
+Recursively yield all existing files (of any kind, including directories) matching the given relative pattern, anywhere in this subtree.
+
+rmdir()
+Remove this directory.
+
+samefile(other_path)
+Return whether other_path is the same or not as this file (as returned by os.path.samefile()).
+
+stat(*[, follow_symlinks])
+Return the result of the stat() system call on this path, like os.stat() does.
+
+symlink_to(target[, target_is_directory])
+Make this path a symlink pointing to the target path.
+
+touch([mode, exist_ok])
+Create this file with the given access mode, if it doesn't exist.
+
+unlink([missing_ok])
+Remove this file or link.
+
+write_bytes(data)
+Open the file in bytes mode, write to it, and close the file.
+
+write_text(data[, encoding, errors, newline])
+Open the file in text mode, write to it, and close the file.
+
+absolute()
+Return an absolute version of this path.  This function works
+even if the path doesn’t point to anything.
+No normalization is done, i.e. all ‘.’ and ‘..’ will be kept along.
+Use resolve() to get the canonical path to a file.
+
+chmod(mode, *, follow_symlinks=True)
+Change the permissions of the path, like os.chmod().
+
+classmethod cwd()
+Return a new path pointing to the current working directory
+(as returned by os.getcwd()).
+
+exists()
+Whether this path exists.
+
+expanduser()
+Return a new path with expanded ~ and ~user constructs
+(as returned by os.path.expanduser)
+
+glob(pattern)
+Iterate over this subtree and yield all existing files (of any
+kind, including directories) matching the given relative pattern.
+
+group()
+Return the group name of the file gid.
+
+hardlink_to(target)
+Make this path a hard link pointing to the same file as target.
+Note the order of arguments (self, target) is the reverse of os.link’s.
+
+classmethod home()
+Return a new path pointing to the user’s home directory (as
+returned by os.path.expanduser(‘~’)).
+
+is_block_device()
+Whether this path is a block device.
+
+is_char_device()
+Whether this path is a character device.
+
+is_dir()
+Whether this path is a directory.
+
+is_fifo()
+Whether this path is a FIFO.
+
+is_file()
+Whether this path is a regular file (also True for symlinks pointing
+to regular files).
+
+is_mount()
+Check if this path is a POSIX mount point
+
+is_socket()
+Whether this path is a socket.
+
+is_symlink()
+Whether this path is a symbolic link.
+
+iterdir()
+Iterate over the files in this directory.  Does not yield any
+result for the special paths ‘.’ and ‘..’.
+
+lchmod(mode)
+Like chmod(), except if the path points to a symlink, the symlink’s
+permissions are changed, rather than its target’s.
+
+link_to(target)
+Make the target path a hard link pointing to this path.
+Note this function does not make this path a hard link to target,
+despite the implication of the function and argument names. The order
+of arguments (target, link) is the reverse of Path.symlink_to, but
+matches that of os.link.
+Deprecated since Python 3.10 and scheduled for removal in Python 3.12.
+Use hardlink_to() instead.
+
+lstat()
+Like stat(), except if the path points to a symlink, the symlink’s
+status information is returned, rather than its target’s.
+
+mkdir(mode=511, parents=False, exist_ok=False)
+Create a new directory at this given path.
+
+open(mode='r', buffering=-1, encoding=None, errors=None, newline=None)
+Open the file pointed by this path and return a file object, as
+the built-in open() function does.
+
+owner()
+Return the login name of the file owner.
+
+read_bytes()
+Open the file in bytes mode, read it, and close the file.
+
+read_text(encoding=None, errors=None)
+Open the file in text mode, read it, and close the file.
+
+readlink()
+Return the path to which the symbolic link points.
+
+rename(target)
+Rename this path to the target path.
+The target path may be absolute or relative. Relative paths are
+interpreted relative to the current working directory, not the
+directory of the Path object.
+Returns the new Path instance pointing to the target path.
+
+replace(target)
+Rename this path to the target path, overwriting if that path exists.
+The target path may be absolute or relative. Relative paths are
+interpreted relative to the current working directory, not the
+directory of the Path object.
+Returns the new Path instance pointing to the target path.
+
+resolve(strict=False)
+Make the path absolute, resolving all symlinks on the way and also
+normalizing it (for example turning slashes into backslashes under
+Windows).
+
+rglob(pattern)
+Recursively yield all existing files (of any kind, including
+directories) matching the given relative pattern, anywhere in
+this subtree.
+
+rmdir()
+Remove this directory.  The directory must be empty.
+
+samefile(other_path)
+Return whether other_path is the same or not as this file
+(as returned by os.path.samefile()).
+
+stat(*, follow_symlinks=True)
+Return the result of the stat() system call on this path, like
+os.stat() does.
+
+symlink_to(target, target_is_directory=False)
+Make this path a symlink pointing to the target path.
+Note the order of arguments (link, target) is the reverse of os.symlink.
+
+touch(mode=438, exist_ok=True)
+Create this file with the given access mode, if it doesn’t exist.
+
+unlink(missing_ok=False)
+Remove this file or link.
+If the path is a directory, use rmdir() instead.
+
+write_bytes(data)
+Open the file in bytes mode, write to it, and close the file.
+
+write_text(data, encoding=None, errors=None, newline=None)
+Open the file in text mode, write to it, and close the file.
+
+pxr.PhysicsSchemaTools.addActor()
+
+pxr.PhysicsSchemaTools.addBoxCollisionShape()
+
+pxr.PhysicsSchemaTools.addCollisionShape()
+
+pxr.PhysicsSchemaTools.addDensity()
+
+pxr.PhysicsSchemaTools.addDisplayColor()
+
+pxr.PhysicsSchemaTools.addGroundPlane()
+
+pxr.PhysicsSchemaTools.addGroundTriMesh()
+
+pxr.PhysicsSchemaTools.addOrientation()
+
+pxr.PhysicsSchemaTools.addPhysicsScene()
+
+pxr.PhysicsSchemaTools.addPosition()
+
+pxr.PhysicsSchemaTools.addRigidBody()
+
+pxr.PhysicsSchemaTools.addRigidBox()
+
+pxr.PhysicsSchemaTools.addRigidBoxForInstancing()
+
+pxr.PhysicsSchemaTools.addRigidCapsule()
+
+pxr.PhysicsSchemaTools.addRigidCone()
+
+pxr.PhysicsSchemaTools.addRigidCylinder()
+
+pxr.PhysicsSchemaTools.addRigidSphere()
+
+pxr.PhysicsSchemaTools.addVelocity()
+
+pxr.PhysicsSchemaTools.createMesh()
+
+pxr.PhysicsSchemaTools.createMeshBox()
+
+pxr.PhysicsSchemaTools.createMeshCapsule()
+
+pxr.PhysicsSchemaTools.createMeshCylinder()
+
+pxr.PhysicsSchemaTools.createMeshSphere()
+
+pxr.PhysicsSchemaTools.createMeshSquare()
+
+pxr.PhysicsSchemaTools.decodeSdfPath()
+
+pxr.PhysicsSchemaTools.encodeSdfPath()
+
+pxr.PhysicsSchemaTools.getMassSpaceInertia()
+
+pxr.PhysicsSchemaTools.intToSdfPath()
+
+pxr.PhysicsSchemaTools.sdfPathToInt()
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

Plug.md

@@ -0,0 +1,580 @@
+
+
+Plug module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+Plug module
+
+ 
+
+# Plug module
+
+Summary: Provides a plug-in framework implementation. Define interfaces, discover, register, and apply plug-in modules to nodes.
+
+This package defines facilities for dealing with plugins.
+Classes:
+
+Notice
+Notifications sent by the Plug module.
+
+Plugin
+Defines an interface to registered plugins.
+
+Registry
+Defines an interface for registering plugins.
+
+class pxr.Plug.Notice
+Notifications sent by the Plug module.
+Classes:
+
+Base
+
+DidRegisterPlugins
+
+class Base
+
+class DidRegisterPlugins
+Methods:
+
+GetNewPlugins
+
+GetNewPlugins()
+
+class pxr.Plug.Plugin
+Defines an interface to registered plugins.
+Plugins are registered using the interfaces in PlugRegistry .
+For each registered plugin, there is an instance of PlugPlugin
+which can be used to load and unload the plugin and to retrieve
+information about the classes implemented by the plugin.
+Methods:
+
+DeclaresType(type, includeSubclasses)
+Returns true if type is declared by this plugin.
+
+FindPluginResource(path, verify)
+Find a plugin resource by absolute or relative path optionally verifying that file exists.
+
+GetMetadataForType(type)
+Returns the metadata sub-dictionary for a particular type.
+
+Load()
+Loads the plugin.
+
+MakeResourcePath(path)
+Build a plugin resource path by returning a given absolute path or combining the plugin's resource path with a given relative path.
+
+Attributes:
+
+expired
+True if this object has expired, False otherwise.
+
+isLoaded
+bool
+
+isPythonModule
+bool
+
+isResource
+bool
+
+metadata
+JsObject
+
+name
+str
+
+path
+str
+
+resourcePath
+str
+
+DeclaresType(type, includeSubclasses) → bool
+Returns true if type is declared by this plugin.
+If includeSubclasses is specified, also returns true if any
+subclasses of type have been declared.
+
+Parameters
+
+type (Type) – 
+includeSubclasses (bool) – 
+
+FindPluginResource(path, verify) → str
+Find a plugin resource by absolute or relative path optionally
+verifying that file exists.
+If verification fails an empty path is returned. Relative paths are
+relative to the plugin’s resource path.
+
+Parameters
+
+path (str) – 
+verify (bool) – 
+
+GetMetadataForType(type) → JsObject
+Returns the metadata sub-dictionary for a particular type.
+
+Parameters
+type (Type) – 
+
+Load() → bool
+Loads the plugin.
+This is a noop if the plugin is already loaded.
+
+MakeResourcePath(path) → str
+Build a plugin resource path by returning a given absolute path or
+combining the plugin’s resource path with a given relative path.
+
+Parameters
+path (str) – 
+
+property expired
+True if this object has expired, False otherwise.
+
+property isLoaded
+bool
+Returns true if the plugin is currently loaded.
+Resource plugins always report as loaded.
+
+Type
+type
+
+property isPythonModule
+bool
+Returns true if the plugin is a python module.
+
+Type
+type
+
+property isResource
+bool
+Returns true if the plugin is resource-only.
+
+Type
+type
+
+property metadata
+JsObject
+Returns the dictionary containing meta-data for the plugin.
+
+Type
+type
+
+property name
+str
+Returns the plugin’s name.
+
+Type
+type
+
+property path
+str
+Returns the plugin’s filesystem path.
+
+Type
+type
+
+property resourcePath
+str
+Returns the plugin’s resources filesystem path.
+
+Type
+type
+
+class pxr.Plug.Registry
+Defines an interface for registering plugins.
+PlugRegistry maintains a registry of plug-ins known to the system and
+provides an interface for base classes to load any plug-ins required
+to instantiate a subclass of a given type.
+
+## Defining a Base Class API
+
+In order to use this facility you will generally provide a module
+which defines the API for a plug-in base class. This API will be
+sufficient for the application or framework to make use of custom
+subclasses that will be written by plug-in developers.
+For example, if you have an image processing application, you might
+want to support plug-ins that implement image filters. You can define
+an abstract base class for image filters that declares the API your
+application will require image filters to implement; perhaps something
+simple like C++ Code Example 1 (Doxygen only).
+People writing custom filters would write a subclass of ImageFilter
+that overrides the two methods, implementing their own special
+filtering behavior.
+
+## Enabling Plug-in Loading for the Base Class
+
+In order for ImageFilter to be able to load plug-ins that implement
+these custom subclasses, it must be registered with the TfType system.
+The ImageFilter base class, as was mentioned earlier, should be made
+available in a module that the application links with. This is done
+so that plug-ins that want to provide ImageFilters can also link with
+the module allowing them to subclass ImageFilter.
+
+## Registering Plug-ins
+
+A plug-in developer can now write plug-ins with ImageFilter
+subclasses. Plug-ins can be implemented either as native dynamic
+modules (either regular dynamic modules or framework bundles) or
+as Python modules.
+Plug-ins must be registered with the registry. All plugins are
+registered via RegisterPlugins() . Plug-in Python modules must be
+directly importable (in other words they must be able to be found in
+Python’s module path.) Plugins are registered by providing a path or
+paths to JSON files that describe the location, structure and contents
+of the plugin. The standard name for these files in plugInfo.json.
+Typically, the application that hosts plug-ins will locate and
+register plug-ins at startup.
+The plug-in facility is lazy. It does not dynamically load code from
+plug-in bundles until that code is required.
+
+## plugInfo.json
+
+A plugInfo.json file has the following structure:
+{
+    # Comments are allowed and indicated by a hash at the start of a
+    # line or after spaces and tabs.  They continue to the end of line.
+    # Blank lines are okay, too.
+
+    # This is optional.  It may contain any number of strings.
+    #   Paths may be absolute or relative.
+    #   Paths ending with slash have plugInfo.json appended automatically.
+    #   '\*' may be used anywhere to match any character except slash.
+    #   '\*\*' may be used anywhere to match any character including slash.
+    "Includes": [
+        "/absolute/path/to/plugInfo.json",
+        "/absolute/path/to/custom.filename",
+        "/absolute/path/to/directory/with/plugInfo/",
+        "relative/path/to/plugInfo.json",
+        "relative/path/to/directory/with/plugInfo/",
+        "glob\*/pa\*th/\*to\*/\*/plugInfo.json",
+        "recursive/pa\*\*th/\*\*/"
+    ],
+
+    # This is optional.  It may contain any number of objects.
+    "Plugins": [
+        {
+            # Type is required and may be "module", "python" or "resource".
+            "Type": "module",
+
+            # Name is required.  It should be the Python module name,
+            # the shared module name, or a unique resource name.
+            "Name": "myplugin",
+
+            # Root is optional.  It defaults to ".".
+            # This gives the path to the plugin as a whole if the plugin
+            # has substructure.  For Python it should be the directory
+            # with the __init__.py file.  The path is usually relative.
+            "Root": ".",
+
+            # LibraryPath is required by Type "module" and unused
+            # otherwise.  It gives the path to the shared module
+            # object, either absolute or relative to Root.
+            "LibraryPath": "libmyplugin.so",
+
+            # ResourcePath is option.  It defaults to ".".
+            # This gives the path to the plugin's resources directory.
+            # The path is either absolute or relative to Root.
+            "ResourcePath": "resources",
+
+            # Info is required.  It's described below.
+            "Info": {
+                # Plugin contents.
+            }
+        }
+    ]
+}
+
+As a special case, if a plugInfo.json contains an object that doesn’t
+have either the”Includes”or”Plugins”keys then it’s as if the object
+was in a”Plugins”array.
+
+## Advertising a Plug-in’s Contents
+
+Once the plug-ins are registered, the plug-in facility must also be
+able to tell what they contain. Specifically, it must be able to find
+out what subclasses of what plug-in base classes each plug-in
+contains. Plug-ins must advertise this information through their
+plugInfo.json file in the”Info”key. In the”Info”object there should be
+a key”Types”holding an object.
+This”Types”object’s keys are names of subclasses and its values are
+yet more objects (the subclass meta-data objects). The meta-data
+objects can contain arbitrary key-value pairs. The plug-in mechanism
+will look for a meta-data key called”displayName”whose value should be
+the display name of the subclass. The plug-in mechanism will look for
+a meta-data key called”bases”whose value should be an array of base
+class type names.
+For example, a bundle that contains a subclass of ImageFilter might
+have a plugInfo.json that looks like the following example.
+{
+    "Types": {
+        "MyCustomCoolFilter" : {
+            "bases": ["ImageFilter"],
+            "displayName": "Add Coolness to Image"
+            # other arbitrary metadata for MyCustomCoolFilter here
+        }
+    }
+}
+
+What this says is that the plug-in contains a type called
+MyCustomCoolFilter which has a base class ImageFilter and that this
+subclass should be called”Add Coolness to Image”in user-visible
+contexts.
+In addition to the”displayName”meta-data key which is actually known
+to the plug-in facility, you may put whatever other information you
+want into a class’meta-data dictionary. If your plug-in base class
+wants to define custom keys that it requires all subclasses to
+provide, you can do that. Or, if a plug-in writer wants to define
+their own keys that their code will look for at runtime, that is OK as
+well.
+
+## Working with Subclasses of a Plug-in Base Class
+
+Most code with uses types defined in plug-ins doesn’t deal with the
+Plug API directly. Instead, the TfType interface is used to lookup
+types and to manufacture instances. The TfType interface will take
+care to load any required plugins.
+To wrap up our example, the application that wants to actually use
+ImageFilter plug-ins would probably do a couple of things. First, it
+would get a list of available ImageFilters to present to the user.
+This could be accomplished as shown in Python Code Example 2 (Doxygen
+only).
+Then, when the user picks a filter from the list, it would manufacture
+and instance of the filter as shown in Python Code Example 3 (Doxygen
+only).
+As was mentioned earlier, this plug-in facility tries to be as lazy as
+possible about loading the code associated with plug-ins. To that end,
+loading of a plugin will be deferred until an instance of a type is
+manufactured which requires the plugin.
+
+## Multiple Subclasses of Multiple Plug-in Base Classes
+
+It is possible for a bundle to implement multiple subclasses for a
+plug-in base class if desired. If you want to package half a dozen
+ImageFilter subclasses in one bundle, that will work fine. All must be
+declared in the plugInfo.json.
+It is possible for there to be multiple classes in your application or
+framework that are plug-in base classes. Plug-ins that implement
+subclasses of any of these base classes can all coexist. And, it is
+possible to have subclasses of multiple plug-in base classes in the
+same bundle.
+When putting multiple subclasses (of the same or different base
+classes) in a bundle, keep in mind that dynamic loading happens for
+the whole bundle the first time any subclass is needed, the whole
+bundle will be loaded. But this is generally not a big concern.
+For example, say the example application also has a plug-in base
+class”ImageCodec”that allows people to add support for reading and
+writing other image formats. Imagine that you want to supply a plug-in
+that has two codecs and a filter all in a single plug-in. Your
+plugInfo.json”Info”object might look something like this example.
+{
+    "Types": {
+        "MyTIFFCodec": {
+            "bases": ["ImageCodec"],
+            "displayName": "TIFF Image"
+        },
+        "MyJPEGCodec": {
+            "bases": ["ImageCodec"],
+            "displayName": "JPEG Image"
+        },
+        "MyCustomCoolFilter" : {
+            "bases": ["ImageFilter"],
+            "displayName": "Add Coolness to Image"
+        }
+    }
+}
+
+## Dependencies on Other Plug-ins
+
+If you write a plug-in that has dependencies on another plug-in that
+you cannot (or do not want to) link against statically, you can
+declare the dependencies in your plug-in’s plugInfo.json. A plug-in
+declares dependencies on other classes with a PluginDependencies key
+whose value is a dictionary. The keys of the dictionary are plug-in
+base class names and the values are arrays of subclass names.
+The following example contains an example of a plug-in that depends on
+two classes from the plug-in in the previous example.
+{
+    "Types": {
+        "UltraCoolFilter": {
+            "bases": ["MyCustomCoolFilter"],
+            "displayName": "Add Unbelievable Coolness to Image"
+            # A subclass of MyCustomCoolFilter that also uses MyTIFFCodec
+        }
+    },
+    "PluginDependencies": {
+        "ImageFilter": ["MyCustomCoolFilter"],
+        "ImageCodec": ["MyTIFFCodec"]
+    }
+}
+
+The ImageFilter provided by the plug-in in this example depends on the
+other ImageFilter MyCoolImageFilter and the ImageCodec MyTIFFCodec.
+Before loading this plug-in, the plug-in facility will ensure that
+those two classes are present, loading the plug-in that contains them
+if needed.
+Methods:
+
+FindDerivedTypeByName
+classmethod FindDerivedTypeByName(base, typeName) -> Type
+
+FindTypeByName
+classmethod FindTypeByName(typeName) -> Type
+
+GetAllDerivedTypes
+classmethod GetAllDerivedTypes(base, result) -> None
+
+GetAllPlugins()
+Returns all registered plug-ins.
+
+GetDirectlyDerivedTypes
+classmethod GetDirectlyDerivedTypes(base) -> list[Type]
+
+GetPluginForType(t)
+Returns the plug-in for the given type, or a null pointer if there is no registered plug-in.
+
+GetPluginWithName(name)
+Returns a plugin with the specified module name.
+
+GetStringFromPluginMetaData(type, key)
+Looks for a string associated with type and key and returns it, or an empty string if type or key are not found.
+
+RegisterPlugins(pathToPlugInfo)
+Registers all plug-ins discovered at pathToPlugInfo.
+
+Attributes:
+
+expired
+True if this object has expired, False otherwise.
+
+static FindDerivedTypeByName()
+classmethod FindDerivedTypeByName(base, typeName) -> Type
+Retrieve the TfType that derives from base and has the given
+alias or type name typeName .
+See the documentation for TfType::FindDerivedByName for more
+information. Use this function if you expect that the derived type may
+be provided by a plugin. Calling this function will incur plugin
+discovery (but not loading) if plugin discovery has not yet occurred.
+Note that additional plugins may be registered during program runtime.
+Plug-In Discovery & Registration
+
+Parameters
+
+base (Type) – 
+typeName (str) – 
+
+FindDerivedTypeByName(typeName) -> Type
+Retrieve the TfType that derives from Base and has the given
+alias or type name typeName .
+See the documentation for TfType::FindDerivedByName for more
+information. Use this function if you expect that the derived type may
+be provided by a plugin. Calling this function will incur plugin
+discovery (but not loading) if plugin discovery has not yet occurred.
+Note that additional plugins may be registered during program runtime.
+Plug-In Discovery & Registration
+
+Parameters
+typeName (str) – 
+
+static FindTypeByName()
+classmethod FindTypeByName(typeName) -> Type
+Retrieve the TfType corresponding to the given name .
+See the documentation for TfType::FindByName for more information.
+Use this function if you expect that name may name a type provided
+by a plugin. Calling this function will incur plugin discovery (but
+not loading) if plugin discovery has not yet occurred.
+Note that additional plugins may be registered during program runtime.
+Plug-In Discovery & Registration
+
+Parameters
+typeName (str) – 
+
+static GetAllDerivedTypes()
+classmethod GetAllDerivedTypes(base, result) -> None
+Return the set of all types derived (directly or indirectly) from
+base.
+Use this function if you expect that plugins may provide types derived
+from base. Otherwise, use TfType::GetAllDerivedTypes.
+Note that additional plugins may be registered during program runtime.
+Plug-In Discovery & Registration
+
+Parameters
+
+base (Type) – 
+result (set[Type]) – 
+
+GetAllDerivedTypes(result) -> None
+Return the set of all types derived (directly or indirectly) from
+Base.
+Use this function if you expect that plugins may provide types derived
+from base. Otherwise, use TfType::GetAllDerivedTypes.
+Note that additional plugins may be registered during program runtime.
+Plug-In Discovery & Registration
+
+Parameters
+result (set[Type]) – 
+
+GetAllPlugins() → list[PlugPluginPtr]
+Returns all registered plug-ins.
+Note that additional plugins may be registered during program runtime.
+Plug-In Discovery & Registration
+
+static GetDirectlyDerivedTypes()
+classmethod GetDirectlyDerivedTypes(base) -> list[Type]
+Return a vector of types derived directly from base.
+Use this function if you expect that plugins may provide types derived
+from base. Otherwise, use TfType::GetDirectlyDerivedTypes.
+
+Parameters
+base (Type) – 
+
+GetPluginForType(t) → Plugin
+Returns the plug-in for the given type, or a null pointer if there is
+no registered plug-in.
+
+Parameters
+t (Type) – 
+
+GetPluginWithName(name) → Plugin
+Returns a plugin with the specified module name.
+Note that additional plugins may be registered during program runtime.
+Plug-In Discovery & Registration
+
+Parameters
+name (str) – 
+
+GetStringFromPluginMetaData(type, key) → str
+Looks for a string associated with type and key and returns it, or
+an empty string if type or key are not found.
+
+Parameters
+
+type (Type) – 
+key (str) – 
+
+RegisterPlugins(pathToPlugInfo) → list[PlugPluginPtr]
+Registers all plug-ins discovered at pathToPlugInfo.
+Sends PlugNotice::DidRegisterPlugins with any newly registered
+plugins.
+
+Parameters
+pathToPlugInfo (str) – 
+
+RegisterPlugins(pathsToPlugInfo) -> list[PlugPluginPtr]
+Registers all plug-ins discovered in any of pathsToPlugInfo.
+Sends PlugNotice::DidRegisterPlugins with any newly registered
+plugins.
+
+Parameters
+pathsToPlugInfo (list[str]) – 
+
+property expired
+True if this object has expired, False otherwise.
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

Sdr.md

@@ -0,0 +1,709 @@
+
+
+Sdr module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+Sdr module
+
+ 
+
+# Sdr module
+
+Summary: The Sdr (Shader Definition Registry) is a specialized version of Ndr for Shaders.
+
+Python bindings for libSdr
+Classes:
+
+NodeContext
+
+NodeMetadata
+
+NodeRole
+
+PropertyMetadata
+
+PropertyRole
+
+PropertyTypes
+
+Registry
+The shading-specialized version of NdrRegistry .
+
+ShaderNode
+A specialized version of NdrNode which holds shading information.
+
+ShaderNodeList
+
+ShaderProperty
+A specialized version of NdrProperty which holds shading information.
+
+class pxr.Sdr.NodeContext
+Attributes:
+
+Displacement
+
+Light
+
+LightFilter
+
+Pattern
+
+PixelFilter
+
+SampleFilter
+
+Surface
+
+Volume
+
+Displacement = 'displacement'
+
+Light = 'light'
+
+LightFilter = 'lightFilter'
+
+Pattern = 'pattern'
+
+PixelFilter = 'pixelFilter'
+
+SampleFilter = 'sampleFilter'
+
+Surface = 'surface'
+
+Volume = 'volume'
+
+class pxr.Sdr.NodeMetadata
+Attributes:
+
+Category
+
+Departments
+
+Help
+
+ImplementationName
+
+Label
+
+Pages
+
+Primvars
+
+Role
+
+SdrDefinitionNameFallbackPrefix
+
+SdrUsdEncodingVersion
+
+Target
+
+Category = 'category'
+
+Departments = 'departments'
+
+Help = 'help'
+
+ImplementationName = '__SDR__implementationName'
+
+Label = 'label'
+
+Pages = 'pages'
+
+Primvars = 'primvars'
+
+Role = 'role'
+
+SdrDefinitionNameFallbackPrefix = 'sdrDefinitionNameFallbackPrefix'
+
+SdrUsdEncodingVersion = 'sdrUsdEncodingVersion'
+
+Target = '__SDR__target'
+
+class pxr.Sdr.NodeRole
+Attributes:
+
+Field
+
+Math
+
+Primvar
+
+Texture
+
+Field = 'field'
+
+Math = 'math'
+
+Primvar = 'primvar'
+
+Texture = 'texture'
+
+class pxr.Sdr.PropertyMetadata
+Attributes:
+
+Colorspace
+
+Connectable
+
+DefaultInput
+
+Help
+
+Hints
+
+ImplementationName
+
+IsAssetIdentifier
+
+IsDynamicArray
+
+Label
+
+Options
+
+Page
+
+RenderType
+
+Role
+
+SdrUsdDefinitionType
+
+Target
+
+ValidConnectionTypes
+
+VstructConditionalExpr
+
+VstructMemberName
+
+VstructMemberOf
+
+Widget
+
+Colorspace = '__SDR__colorspace'
+
+Connectable = 'connectable'
+
+DefaultInput = '__SDR__defaultinput'
+
+Help = 'help'
+
+Hints = 'hints'
+
+ImplementationName = '__SDR__implementationName'
+
+IsAssetIdentifier = '__SDR__isAssetIdentifier'
+
+IsDynamicArray = 'isDynamicArray'
+
+Label = 'label'
+
+Options = 'options'
+
+Page = 'page'
+
+RenderType = 'renderType'
+
+Role = 'role'
+
+SdrUsdDefinitionType = 'sdrUsdDefinitionType'
+
+Target = '__SDR__target'
+
+ValidConnectionTypes = 'validConnectionTypes'
+
+VstructConditionalExpr = 'vstructConditionalExpr'
+
+VstructMemberName = 'vstructMemberName'
+
+VstructMemberOf = 'vstructMemberOf'
+
+Widget = 'widget'
+
+class pxr.Sdr.PropertyRole
+Attributes:
+
+None
+
+None = 'none'
+
+class pxr.Sdr.PropertyTypes
+Attributes:
+
+Color
+
+Color4
+
+Float
+
+Int
+
+Matrix
+
+Normal
+
+Point
+
+String
+
+Struct
+
+Terminal
+
+Unknown
+
+Vector
+
+Vstruct
+
+Color = 'color'
+
+Color4 = 'color4'
+
+Float = 'float'
+
+Int = 'int'
+
+Matrix = 'matrix'
+
+Normal = 'normal'
+
+Point = 'point'
+
+String = 'string'
+
+Struct = 'struct'
+
+Terminal = 'terminal'
+
+Unknown = 'unknown'
+
+Vector = 'vector'
+
+Vstruct = 'vstruct'
+
+class pxr.Sdr.Registry
+The shading-specialized version of NdrRegistry .
+Methods:
+
+GetShaderNodeByIdentifier(identifier, ...)
+Exactly like NdrRegistry::GetNodeByIdentifier() , but returns a SdrShaderNode pointer instead of a NdrNode pointer.
+
+GetShaderNodeByIdentifierAndType(identifier, ...)
+Exactly like NdrRegistry::GetNodeByIdentifierAndType() , but returns a SdrShaderNode pointer instead of a NdrNode pointer.
+
+GetShaderNodeByName(name, typePriority, filter)
+Exactly like NdrRegistry::GetNodeByName() , but returns a SdrShaderNode pointer instead of a NdrNode pointer.
+
+GetShaderNodeByNameAndType(name, nodeType, ...)
+Exactly like NdrRegistry::GetNodeByNameAndType() , but returns a SdrShaderNode pointer instead of a NdrNode pointer.
+
+GetShaderNodeFromAsset(shaderAsset, ...)
+Wrapper method for NdrRegistry::GetNodeFromAsset() .
+
+GetShaderNodeFromSourceCode(sourceCode, ...)
+Wrapper method for NdrRegistry::GetNodeFromSourceCode() .
+
+GetShaderNodesByFamily(family, filter)
+Exactly like NdrRegistry::GetNodesByFamily() , but returns a vector of SdrShaderNode pointers instead of a vector of NdrNode pointers.
+
+GetShaderNodesByIdentifier(identifier)
+Exactly like NdrRegistry::GetNodesByIdentifier() , but returns a vector of SdrShaderNode pointers instead of a vector of NdrNode pointers.
+
+GetShaderNodesByName(name, filter)
+Exactly like NdrRegistry::GetNodesByName() , but returns a vector of SdrShaderNode pointers instead of a vector of NdrNode pointers.
+
+Attributes:
+
+expired
+True if this object has expired, False otherwise.
+
+GetShaderNodeByIdentifier(identifier, typePriority) → ShaderNode
+Exactly like NdrRegistry::GetNodeByIdentifier() , but returns a
+SdrShaderNode pointer instead of a NdrNode pointer.
+
+Parameters
+
+identifier (NdrIdentifier) – 
+typePriority (NdrTokenVec) – 
+
+GetShaderNodeByIdentifierAndType(identifier, nodeType) → ShaderNode
+Exactly like NdrRegistry::GetNodeByIdentifierAndType() , but
+returns a SdrShaderNode pointer instead of a NdrNode pointer.
+
+Parameters
+
+identifier (NdrIdentifier) – 
+nodeType (str) – 
+
+GetShaderNodeByName(name, typePriority, filter) → ShaderNode
+Exactly like NdrRegistry::GetNodeByName() , but returns a
+SdrShaderNode pointer instead of a NdrNode pointer.
+
+Parameters
+
+name (str) – 
+typePriority (NdrTokenVec) – 
+filter (VersionFilter) – 
+
+GetShaderNodeByNameAndType(name, nodeType, filter) → ShaderNode
+Exactly like NdrRegistry::GetNodeByNameAndType() , but returns a
+SdrShaderNode pointer instead of a NdrNode pointer.
+
+Parameters
+
+name (str) – 
+nodeType (str) – 
+filter (VersionFilter) – 
+
+GetShaderNodeFromAsset(shaderAsset, metadata, subIdentifier, sourceType) → ShaderNode
+Wrapper method for NdrRegistry::GetNodeFromAsset() .
+Returns a valid SdrShaderNode pointer upon success.
+
+Parameters
+
+shaderAsset (AssetPath) – 
+metadata (NdrTokenMap) – 
+subIdentifier (str) – 
+sourceType (str) – 
+
+GetShaderNodeFromSourceCode(sourceCode, sourceType, metadata) → ShaderNode
+Wrapper method for NdrRegistry::GetNodeFromSourceCode() .
+Returns a valid SdrShaderNode pointer upon success.
+
+Parameters
+
+sourceCode (str) – 
+sourceType (str) – 
+metadata (NdrTokenMap) – 
+
+GetShaderNodesByFamily(family, filter) → SdrShaderNodePtrVec
+Exactly like NdrRegistry::GetNodesByFamily() , but returns a
+vector of SdrShaderNode pointers instead of a vector of
+NdrNode pointers.
+
+Parameters
+
+family (str) – 
+filter (VersionFilter) – 
+
+GetShaderNodesByIdentifier(identifier) → SdrShaderNodePtrVec
+Exactly like NdrRegistry::GetNodesByIdentifier() , but returns a
+vector of SdrShaderNode pointers instead of a vector of
+NdrNode pointers.
+
+Parameters
+identifier (NdrIdentifier) – 
+
+GetShaderNodesByName(name, filter) → SdrShaderNodePtrVec
+Exactly like NdrRegistry::GetNodesByName() , but returns a vector
+of SdrShaderNode pointers instead of a vector of NdrNode
+pointers.
+
+Parameters
+
+name (str) – 
+filter (VersionFilter) – 
+
+property expired
+True if this object has expired, False otherwise.
+
+class pxr.Sdr.ShaderNode
+A specialized version of NdrNode which holds shading information.
+Methods:
+
+GetAdditionalPrimvarProperties()
+The list of string input properties whose values provide the names of additional primvars consumed by this node.
+
+GetAllVstructNames()
+Gets all vstructs that are present in the shader.
+
+GetAssetIdentifierInputNames()
+Returns the list of all inputs that are tagged as asset identifier inputs.
+
+GetCategory()
+The category assigned to this node, if any.
+
+GetDefaultInput()
+Returns the first shader input that is tagged as the default input.
+
+GetDepartments()
+The departments this node is associated with, if any.
+
+GetHelp()
+The help message assigned to this node, if any.
+
+GetImplementationName()
+Returns the implementation name of this node.
+
+GetLabel()
+The label assigned to this node, if any.
+
+GetPages()
+Gets the pages on which the node's properties reside (an aggregate of the unique SdrShaderProperty::GetPage() values for all of the node's properties).
+
+GetPrimvars()
+The list of primvars this node knows it requires / uses.
+
+GetPropertyNamesForPage(pageName)
+Gets the names of the properties on a certain page (one that was returned by GetPages() ).
+
+GetRole()
+Returns the role of this node.
+
+GetShaderInput(inputName)
+Get a shader input property by name.
+
+GetShaderOutput(outputName)
+Get a shader output property by name.
+
+GetAdditionalPrimvarProperties() → NdrTokenVec
+The list of string input properties whose values provide the names of
+additional primvars consumed by this node.
+For example, this may return a token named varname . This
+indicates that the client should query the value of a (presumed to be
+string-valued) input attribute named varname from its scene
+description to determine the name of a primvar the node will consume.
+See GetPrimvars() for additional information.
+
+GetAllVstructNames() → NdrTokenVec
+Gets all vstructs that are present in the shader.
+
+GetAssetIdentifierInputNames() → NdrTokenVec
+Returns the list of all inputs that are tagged as asset identifier
+inputs.
+
+GetCategory() → str
+The category assigned to this node, if any.
+Distinct from the family returned from GetFamily() .
+
+GetDefaultInput() → ShaderProperty
+Returns the first shader input that is tagged as the default input.
+A default input and its value can be used to acquire a fallback value
+for a node when the node is considered’disabled’or otherwise incapable
+of producing an output value.
+
+GetDepartments() → NdrTokenVec
+The departments this node is associated with, if any.
+
+GetHelp() → str
+The help message assigned to this node, if any.
+
+GetImplementationName() → str
+Returns the implementation name of this node.
+The name of the node is how to refer to the node in shader networks.
+The label is how to present this node to users. The implementation
+name is the name of the function (or something) this node represents
+in the implementation. Any client using the implementation must
+call this method to get the correct name; using getName() is not
+correct.
+
+GetLabel() → str
+The label assigned to this node, if any.
+Distinct from the name returned from GetName() . In the context of
+a UI, the label value might be used as the display name for the node
+instead of the name.
+
+GetPages() → NdrTokenVec
+Gets the pages on which the node’s properties reside (an aggregate of
+the unique SdrShaderProperty::GetPage() values for all of the
+node’s properties).
+Nodes themselves do not reside on pages. In an example scenario,
+properties might be divided into two pages,’Simple’and’Advanced’.
+
+GetPrimvars() → NdrTokenVec
+The list of primvars this node knows it requires / uses.
+For example, a shader node may require the’normals’primvar to function
+correctly. Additional, user specified primvars may have been authored
+on the node. These can be queried via
+GetAdditionalPrimvarProperties() . Together, GetPrimvars() and
+GetAdditionalPrimvarProperties() , provide the complete list of
+primvar requirements for the node.
+
+GetPropertyNamesForPage(pageName) → NdrTokenVec
+Gets the names of the properties on a certain page (one that was
+returned by GetPages() ).
+To get properties that are not assigned to a page, an empty string can
+be used for pageName .
+
+Parameters
+pageName (str) – 
+
+GetRole() → str
+Returns the role of this node.
+This is used to annotate the role that the shader node plays inside a
+shader network. We can tag certain shaders to indicate their role
+within a shading network. We currently tag primvar reading nodes,
+texture reading nodes and nodes that access volume fields (like
+extinction or scattering). This is done to identify resources used by
+a shading network.
+
+GetShaderInput(inputName) → ShaderProperty
+Get a shader input property by name.
+nullptr is returned if an input with the given name does not
+exist.
+
+Parameters
+inputName (str) – 
+
+GetShaderOutput(outputName) → ShaderProperty
+Get a shader output property by name.
+nullptr is returned if an output with the given name does not
+exist.
+
+Parameters
+outputName (str) – 
+
+class pxr.Sdr.ShaderNodeList
+Methods:
+
+append
+
+extend
+
+append()
+
+extend()
+
+class pxr.Sdr.ShaderProperty
+A specialized version of NdrProperty which holds shading
+information.
+Methods:
+
+GetDefaultValueAsSdfType()
+Accessor for default value corresponding to the SdfValueTypeName returned by GetTypeAsSdfType.
+
+GetHelp()
+The help message assigned to this property, if any.
+
+GetHints()
+Any UI"hints"that are associated with this property.
+
+GetImplementationName()
+Returns the implementation name of this property.
+
+GetLabel()
+The label assigned to this property, if any.
+
+GetOptions()
+If the property has a set of valid values that are pre-determined, this will return the valid option names and corresponding string values (if the option was specified with a value).
+
+GetPage()
+The page (group), eg"Advanced", this property appears on, if any.
+
+GetVStructConditionalExpr()
+If this field is part of a vstruct, this is the conditional expression.
+
+GetVStructMemberName()
+If this field is part of a vstruct, this is its name in the struct.
+
+GetVStructMemberOf()
+If this field is part of a vstruct, this is the name of the struct.
+
+GetValidConnectionTypes()
+Gets the list of valid connection types for this property.
+
+GetWidget()
+The widget"hint"that indicates the widget that can best display the type of data contained in this property, if any.
+
+IsAssetIdentifier()
+Determines if the value held by this property is an asset identifier (eg, a file path); the logic for this is left up to the parser.
+
+IsDefaultInput()
+Determines if the value held by this property is the default input for this node.
+
+IsVStruct()
+Returns true if the field is the head of a vstruct.
+
+IsVStructMember()
+Returns true if this field is part of a vstruct.
+
+GetDefaultValueAsSdfType() → VtValue
+Accessor for default value corresponding to the SdfValueTypeName
+returned by GetTypeAsSdfType.
+Note that this is different than GetDefaultValue which returns the
+default value associated with the SdrPropertyType and may differ from
+the SdfValueTypeName, example when sdrUsdDefinitionType metadata is
+specified for a sdr property.
+GetTypeAsSdfType
+
+GetHelp() → str
+The help message assigned to this property, if any.
+
+GetHints() → NdrTokenMap
+Any UI”hints”that are associated with this property.
+“Hints”are simple key/value pairs.
+
+GetImplementationName() → str
+Returns the implementation name of this property.
+The name of the property is how to refer to the property in shader
+networks. The label is how to present this property to users. The
+implementation name is the name of the parameter this property
+represents in the implementation. Any client using the implementation
+must call this method to get the correct name; using getName()
+is not correct.
+
+GetLabel() → str
+The label assigned to this property, if any.
+Distinct from the name returned from GetName() . In the context of
+a UI, the label value might be used as the display name for the
+property instead of the name.
+
+GetOptions() → NdrOptionVec
+If the property has a set of valid values that are pre-determined,
+this will return the valid option names and corresponding string
+values (if the option was specified with a value).
+
+GetPage() → str
+The page (group), eg”Advanced”, this property appears on, if any.
+Note that the page for a shader property can be nested, delimited
+by”:”, representing the hierarchy of sub-pages a property is defined
+in.
+
+GetVStructConditionalExpr() → str
+If this field is part of a vstruct, this is the conditional
+expression.
+
+GetVStructMemberName() → str
+If this field is part of a vstruct, this is its name in the struct.
+
+GetVStructMemberOf() → str
+If this field is part of a vstruct, this is the name of the struct.
+
+GetValidConnectionTypes() → NdrTokenVec
+Gets the list of valid connection types for this property.
+This value comes from shader metadata, and may not be specified. The
+value from NdrProperty::GetType() can be used as a fallback, or
+you can use the connectability test in CanConnectTo() .
+
+GetWidget() → str
+The widget”hint”that indicates the widget that can best display the
+type of data contained in this property, if any.
+Examples of this value could include”number”,”slider”, etc.
+
+IsAssetIdentifier() → bool
+Determines if the value held by this property is an asset identifier
+(eg, a file path); the logic for this is left up to the parser.
+Note: The type returned from GetTypeAsSdfType() will be Asset
+if this method returns true (even though its true underlying data
+type is string).
+
+IsDefaultInput() → bool
+Determines if the value held by this property is the default input for
+this node.
+
+IsVStruct() → bool
+Returns true if the field is the head of a vstruct.
+
+IsVStructMember() → bool
+Returns true if this field is part of a vstruct.
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

Tf.md

@@ -0,0 +1,1345 @@
+
+
+Tf module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+Tf module
+
+ 
+
+# Tf module
+
+Summary: The Tf (Tools Foundations) module.
+
+Tf – Tools Foundation
+Exceptions:
+
+CppException
+
+ErrorException(*args)
+
+Classes:
+
+CallContext
+
+Debug
+
+DiagnosticType
+
+Enum
+
+Error
+
+MallocTag
+
+NamedTemporaryFile([suffix, prefix, dir, text])
+A named temporary file which keeps the internal file handle closed.
+
+Notice
+
+PyModuleWasLoaded
+A TfNotice that is sent when a script module is loaded.
+
+RefPtrTracker
+Provides tracking of TfRefPtr objects to particular objects.
+
+ScopeDescription
+This class is used to provide high-level descriptions about scopes of execution that could possibly block, or to provide relevant information about high-level action that would be useful in a crash report.
+
+ScriptModuleLoader
+Provides low-level facilities for shared modules with script bindings to register themselves with their dependences, and provides a mechanism whereby those script modules will be loaded when necessary.
+
+Singleton
+
+StatusObject
+
+Stopwatch
+
+TemplateString
+
+Tf_PyEnumWrapper
+
+Tf_TestAnnotatedBoolResult
+
+Tf_TestPyContainerConversions
+
+Tf_TestPyOptional
+
+Type
+TfType represents a dynamic runtime type.
+
+Warning
+
+Functions:
+
+Fatal(msg)
+Raise a fatal error to the Tf Diagnostic system.
+
+GetCodeLocation(framesUp)
+Returns a tuple (moduleName, functionName, fileName, lineNo).
+
+PrepareModule(module, result)
+PrepareModule(module, result) -- Prepare an extension module at import time.
+
+PreparePythonModule([moduleName])
+Prepare an extension module at import time.
+
+RaiseCodingError(msg)
+Raise a coding error to the Tf Diagnostic system.
+
+RaiseRuntimeError(msg)
+Raise a runtime error to the Tf Diagnostic system.
+
+Status(msg[, verbose])
+Issues a status update to the Tf diagnostic system.
+
+Warn(msg[, template])
+Issue a warning via the TfDiagnostic system.
+
+WindowsImportWrapper()
+
+exception pxr.Tf.CppException
+
+exception pxr.Tf.ErrorException(*args)
+
+class pxr.Tf.CallContext
+Attributes:
+
+file
+char
+
+function
+char
+
+line
+int
+
+prettyFunction
+char
+
+property file
+char
+
+Type
+type
+
+property function
+char
+
+Type
+type
+
+property line
+int
+
+Type
+type
+
+property prettyFunction
+char
+
+Type
+type
+
+class pxr.Tf.Debug
+Methods:
+
+GetDebugSymbolDescription
+classmethod GetDebugSymbolDescription(name) -> str
+
+GetDebugSymbolDescriptions
+classmethod GetDebugSymbolDescriptions() -> str
+
+GetDebugSymbolNames
+classmethod GetDebugSymbolNames() -> list[str]
+
+IsDebugSymbolNameEnabled
+classmethod IsDebugSymbolNameEnabled(name) -> bool
+
+SetDebugSymbolsByName
+classmethod SetDebugSymbolsByName(pattern, value) -> list[str]
+
+SetOutputFile
+classmethod SetOutputFile(file) -> None
+
+static GetDebugSymbolDescription()
+classmethod GetDebugSymbolDescription(name) -> str
+Get a description for the specified debug symbol.
+A short description of the debug symbol is returned. This is the same
+description string that is embedded in the return value of
+GetDebugSymbolDescriptions.
+
+Parameters
+name (str) – 
+
+static GetDebugSymbolDescriptions()
+classmethod GetDebugSymbolDescriptions() -> str
+Get a description of all debug symbols and their purpose.
+A single string describing all registered debug symbols along with
+short descriptions is returned.
+
+static GetDebugSymbolNames()
+classmethod GetDebugSymbolNames() -> list[str]
+Get a listing of all debug symbols.
+
+static IsDebugSymbolNameEnabled()
+classmethod IsDebugSymbolNameEnabled(name) -> bool
+True if the specified debug symbol is set.
+
+Parameters
+name (str) – 
+
+static SetDebugSymbolsByName()
+classmethod SetDebugSymbolsByName(pattern, value) -> list[str]
+Set registered debug symbols matching pattern to value .
+All registered debug symbols matching pattern are set to value
+. The only matching is an exact match with pattern , or if
+pattern ends with an’*’as is otherwise a prefix of a debug
+symbols. The names of all debug symbols set by this call are returned
+as a vector.
+
+Parameters
+
+pattern (str) – 
+value (bool) – 
+
+static SetOutputFile()
+classmethod SetOutputFile(file) -> None
+Direct debug output to either stdout or stderr.
+Note that file MUST be either stdout or stderr. If not, issue an
+error and do nothing. Debug output is issued to stdout by default. If
+the environment variable TF_DEBUG_OUTPUT_FILE is set to’stderr’, then
+output is issued to stderr by default.
+
+Parameters
+file (FILE) – 
+
+class pxr.Tf.DiagnosticType
+Methods:
+
+GetValueFromName
+
+Attributes:
+
+allValues
+
+static GetValueFromName()
+
+allValues = (Tf.TF_DIAGNOSTIC_CODING_ERROR_TYPE, Tf.TF_DIAGNOSTIC_FATAL_CODING_ERROR_TYPE, Tf.TF_DIAGNOSTIC_RUNTIME_ERROR_TYPE, Tf.TF_DIAGNOSTIC_FATAL_ERROR_TYPE, Tf.TF_DIAGNOSTIC_NONFATAL_ERROR_TYPE, Tf.TF_DIAGNOSTIC_WARNING_TYPE, Tf.TF_DIAGNOSTIC_STATUS_TYPE, Tf.TF_APPLICATION_EXIT_TYPE)
+
+class pxr.Tf.Enum
+Methods:
+
+GetValueFromFullName
+classmethod GetValueFromFullName(fullname, foundIt) -> Enum
+
+static GetValueFromFullName()
+classmethod GetValueFromFullName(fullname, foundIt) -> Enum
+Returns the enumerated value for a fully-qualified name.
+This takes a fully-qualified enumerated value name (e.g.,
+"Season::WINTER" ) and returns the associated value. If there is
+no such name, this returns -1. Since -1 can sometimes be a valid
+value, the foundIt flag pointer, if not None , is set to
+true if the name was found and false otherwise. Also, since
+this is not a templated function, it has to return a generic value
+type, so we use TfEnum .
+
+Parameters
+
+fullname (str) – 
+foundIt (bool) – 
+
+class pxr.Tf.Error
+Classes:
+
+Mark
+
+Attributes:
+
+errorCode
+The error code posted for this error.
+
+errorCodeString
+The error code posted for this error, as a string.
+
+class Mark
+Methods:
+
+Clear
+
+GetErrors
+A list of the errors held by this mark.
+
+IsClean
+
+SetMark
+
+Clear()
+
+GetErrors()
+A list of the errors held by this mark.
+
+IsClean()
+
+SetMark()
+
+property errorCode
+The error code posted for this error.
+
+property errorCodeString
+The error code posted for this error, as a string.
+
+class pxr.Tf.MallocTag
+Classes:
+
+CallTree
+
+Methods:
+
+GetCallStacks
+
+GetCallTree
+classmethod GetCallTree(tree, skipRepeated) -> bool
+
+GetMaxTotalBytes
+classmethod GetMaxTotalBytes() -> int
+
+GetTotalBytes
+classmethod GetTotalBytes() -> int
+
+Initialize
+classmethod Initialize(errMsg) -> bool
+
+IsInitialized
+classmethod IsInitialized() -> bool
+
+SetCapturedMallocStacksMatchList
+classmethod SetCapturedMallocStacksMatchList(matchList) -> None
+
+SetDebugMatchList
+classmethod SetDebugMatchList(matchList) -> None
+
+class CallTree
+Classes:
+
+CallSite
+
+PathNode
+
+Methods:
+
+GetCallSites
+
+GetPrettyPrintString
+
+GetRoot
+
+LogReport
+
+Report
+
+class CallSite
+Attributes:
+
+nBytes
+
+name
+
+property nBytes
+
+property name
+
+class PathNode
+Methods:
+
+GetChildren
+
+Attributes:
+
+nAllocations
+
+nBytes
+
+nBytesDirect
+
+siteName
+
+GetChildren()
+
+property nAllocations
+
+property nBytes
+
+property nBytesDirect
+
+property siteName
+
+GetCallSites()
+
+GetPrettyPrintString()
+
+GetRoot()
+
+LogReport()
+
+Report()
+
+static GetCallStacks()
+
+static GetCallTree()
+classmethod GetCallTree(tree, skipRepeated) -> bool
+Return a snapshot of memory usage.
+Returns a snapshot by writing into \*tree . See the C *tree
+structure for documentation. If Initialize() has not been called,
+*tree is set to a rather blank structure (empty vectors, empty
+strings, zero in all integral fields) and false is returned;
+otherwise, \*tree is set with the contents of the current memory
+snapshot and true is returned. It is fine to call this function on
+the same \*tree instance; each call simply overwrites the data
+from the last call. If /p skipRepeated is true , then any repeated
+callsite is skipped. See the CallTree documentation for more
+details.
+
+Parameters
+
+tree (CallTree) – 
+skipRepeated (bool) – 
+
+static GetMaxTotalBytes()
+classmethod GetMaxTotalBytes() -> int
+Return the maximum total number of bytes that have ever been allocated
+at one time.
+This is simply the maximum value of GetTotalBytes() since Initialize()
+was called.
+
+static GetTotalBytes()
+classmethod GetTotalBytes() -> int
+Return total number of allocated bytes.
+The current total memory that has been allocated and not freed is
+returned. Memory allocated before calling Initialize() is not
+accounted for.
+
+static Initialize()
+classmethod Initialize(errMsg) -> bool
+Initialize the memory tagging system.
+This function returns true if the memory tagging system can be
+successfully initialized or it has already been initialized.
+Otherwise, \*errMsg is set with an explanation for the failure.
+Until the system is initialized, the various memory reporting calls
+will indicate that no memory has been allocated. Note also that memory
+allocated prior to calling Initialize() is not tracked i.e. all
+data refers to allocations that happen subsequent to calling
+Initialize() .
+
+Parameters
+errMsg (str) – 
+
+static IsInitialized()
+classmethod IsInitialized() -> bool
+Return true if the tagging system is active.
+If Initialize() has been successfully called, this function
+returns true .
+
+static SetCapturedMallocStacksMatchList()
+classmethod SetCapturedMallocStacksMatchList(matchList) -> None
+Sets the tags to trace.
+When memory is allocated for any tag that matches matchList a
+stack trace is recorded. When that memory is released the stack trace
+is discarded. Clients can call GetCapturedMallocStacks() to get a
+list of all recorded stack traces. This is useful for finding leaks.
+Traces recorded for any tag that will no longer be matched are
+discarded by this call. Traces recorded for tags that continue to be
+matched are retained.
+matchList is a comma, tab or newline separated list of malloc tag
+names. The names can have internal spaces but leading and trailing
+spaces are stripped. If a name ends in’*’then the suffix is
+wildcarded. A name can have a leading’-‘or’+’to prevent or allow a
+match. Each name is considered in order and later matches override
+earlier matches. For example,’Csd*, -CsdScene::_Populate*,
++CsdScene::_PopulatePrimCacheLocal’matches any malloc tag starting
+with’Csd’but nothing starting
+with’CsdScene::_Populate’except’CsdScene::_PopulatePrimCacheLocal’.
+Use the empty string to disable stack capturing.
+
+Parameters
+matchList (str) – 
+
+static SetDebugMatchList()
+classmethod SetDebugMatchList(matchList) -> None
+Sets the tags to trap in the debugger.
+When memory is allocated or freed for any tag that matches
+matchList the debugger trap is invoked. If a debugger is attached
+the program will stop in the debugger, otherwise the program will
+continue to run. See ArchDebuggerTrap() and ArchDebuggerWait()
+.
+matchList is a comma, tab or newline separated list of malloc tag
+names. The names can have internal spaces but leading and trailing
+spaces are stripped. If a name ends in’*’then the suffix is
+wildcarded. A name can have a leading’-‘or’+’to prevent or allow a
+match. Each name is considered in order and later matches override
+earlier matches. For example,’Csd*, -CsdScene::_Populate*,
++CsdScene::_PopulatePrimCacheLocal’matches any malloc tag starting
+with’Csd’but nothing starting
+with’CsdScene::_Populate’except’CsdScene::_PopulatePrimCacheLocal’.
+Use the empty string to disable debugging traps.
+
+Parameters
+matchList (str) – 
+
+class pxr.Tf.NamedTemporaryFile(suffix='', prefix='', dir=None, text=False)
+A named temporary file which keeps the internal file handle closed.
+A class which constructs a temporary file(that isn’t open) on __enter__,
+provides its name as an attribute, and deletes it on __exit__.
+Note: The constructor args for this object match those of
+python’s tempfile.mkstemp() function, and will have the same effect on
+the underlying file created.
+Attributes:
+
+name
+The path for the temporary file created.
+
+property name
+The path for the temporary file created.
+
+class pxr.Tf.Notice
+Classes:
+
+Listener
+Represents the Notice connection between senders and receivers of notices.
+
+Methods:
+
+Register(noticeType, callback, sender)
+noticeType : Tf.Notice callback : function sender : object
+
+RegisterGlobally(noticeType, callback)
+noticeType : Tf.Notice callback : function
+
+Send
+Send(sender)
+
+SendGlobally
+SendGlobally()
+
+class Listener
+Represents the Notice connection between senders and receivers of notices.  When a Listener object expires the connection is broken. You can also use the Revoke() function to break the connection. A Listener object is returned from the Register() and  RegisterGlobally() functions.
+Methods:
+
+Revoke
+Revoke()
+
+Revoke()
+Revoke()
+Revoke interest by a notice listener.  This function revokes interest in the particular notice type and call-back method that its Listener object was registered for.
+
+static Register(noticeType, callback, sender) → Listener
+noticeType : Tf.Notice
+callback : function
+sender : object
+Register a listener as being interested in a TfNotice  type from a specific sender.  Notice listener will get sender  as an argument.     Registration of interest in a notice class N automatically  registers interest in all classes derived from N.  When a  notice of appropriate type is received, the listening object’s  member-function method is called with the notice.     To reverse the registration, call Revoke() on the Listener object returned by this call.
+Register( noticeType, callback, sender ) -> Listener
+noticeType : Tf.Notice
+callback : function
+sender : object
+Register a listener as being interested in a TfNotice  type from a specific sender.  Notice listener will get sender  as an argument.     Registration of interest in a notice class N automatically  registers interest in all classes derived from N.  When a  notice of appropriate type is received, the listening object’s  member-function method is called with the notice.     To reverse the registration, call Revoke() on the Listener object returned by this call.
+
+static RegisterGlobally(noticeType, callback) → Listener
+noticeType : Tf.Notice
+callback : function
+Register a listener as being interested in a TfNotice type from any sender.  The notice listener does not get sender as an argument.
+
+Send()
+Send(sender)
+sender : object
+Deliver the notice to interested listeners, returning the number of interested listeners. This is the recommended form of Send.  It takes the sender as an argument. Listeners that registered for the given sender AND listeners that registered globally will get the notice.
+Send(sender)
+sender : object
+Deliver the notice to interested listeners, returning the number of interested listeners. This is the recommended form of Send.  It takes the sender as an argument. Listeners that registered for the given sender AND listeners that registered globally will get the notice.
+
+SendGlobally()
+SendGlobally()
+Deliver the notice to interested listeners.   For most clients it is recommended to use the Send(sender) version of Send() rather than this one.  Clients that use this form of Send will prevent listeners from being able to register to receive notices based on the sender of the notice. ONLY listeners that registered globally will get the notice.
+
+class pxr.Tf.PyModuleWasLoaded
+A TfNotice that is sent when a script module is loaded. Since many
+modules may be loaded at once, listeners are encouraged to defer work
+triggered by this notice to the end of an application iteration. This,
+of course, is good practice in general.
+Methods:
+
+name()
+Return the name of the module that was loaded.
+
+name() → str
+Return the name of the module that was loaded.
+
+class pxr.Tf.RefPtrTracker
+Provides tracking of TfRefPtr objects to particular objects.
+Clients can enable, at compile time, tracking of TfRefPtr objects
+that point to particular instances of classes derived from
+TfRefBase . This is useful if you have a ref counted object with a
+ref count that should’ve gone to zero but didn’t. This tracker can
+tell you every TfRefPtr that’s holding the TfRefBase and a
+stack trace where it was created or last assigned to.
+Clients can get a report of all watched instances and how many
+TfRefPtr objects are holding them using
+ReportAllWatchedCounts() (in python use Tf.RefPtrTracker()
+.GetAllWatchedCountsReport()). You can see all of the stack traces
+using ReportAllTraces() (in python use Tf.RefPtrTracker()
+.GetAllTracesReport()).
+Clients will typically enable tracking using code like this:
+#include "pxr/base/tf/refPtrTracker.h"
+
+class MyRefBaseType;
+typedef TfRefPtr<MyRefBaseType> MyRefBaseTypeRefPtr;
+
+TF_DECLARE_REFPTR_TRACK(MyRefBaseType);
+
+class MyRefBaseType {
+\.\.\.
+public:
+    static bool _ShouldWatch(const MyRefBaseType\*);
+\.\.\.
+};
+
+TF_DEFINE_REFPTR_TRACK(MyRefBaseType, MyRefBaseType::_ShouldWatch);
+
+Note that the TF_DECLARE_REFPTR_TRACK() macro must be invoked
+before any use of the MyRefBaseTypeRefPtr type.
+The MyRefBaseType::_ShouldWatch() function returns true if the
+given instance of MyRefBaseType should be tracked. You can also
+use TfRefPtrTracker::WatchAll() to watch every instance (but that
+might use a lot of memory and time).
+If you have a base type, B , and a derived type, D , and you
+hold instances of D in a TfRefPtr < ``B>`` (i.e. a pointer to
+the base) then you must track both type B and type D . But you
+can use TfRefPtrTracker::WatchNone() when tracking B if you’re
+not interested in instances of B .
+Methods:
+
+GetAllTracesReport
+
+GetAllWatchedCountsReport
+
+GetTracesReportForWatched
+
+Attributes:
+
+expired
+True if this object has expired, False otherwise.
+
+GetAllTracesReport()
+
+GetAllWatchedCountsReport()
+
+GetTracesReportForWatched()
+
+property expired
+True if this object has expired, False otherwise.
+
+class pxr.Tf.ScopeDescription
+This class is used to provide high-level descriptions about scopes of
+execution that could possibly block, or to provide relevant
+information about high-level action that would be useful in a crash
+report.
+This class is reasonably fast to use, especially if the message
+strings are not dynamically created, however it should not be used in
+very highly performance sensitive contexts. The cost to push & pop is
+essentially a TLS lookup plus a couple of atomic operations.
+Methods:
+
+SetDescription(description)
+Replace the description stack entry for this scope description.
+
+SetDescription(description) → None
+Replace the description stack entry for this scope description.
+Caller guarantees that the string description lives at least as
+long as this TfScopeDescription object.
+
+Parameters
+description (str) – 
+
+SetDescription(description) -> None
+Replace the description stack entry for this scope description.
+This object adopts ownership of the rvalue description .
+
+Parameters
+description (str) – 
+
+SetDescription(description) -> None
+Replace the description stack entry for this scope description.
+Caller guarantees that the string description lives at least as
+long as this TfScopeDescription object.
+
+Parameters
+description (char) – 
+
+class pxr.Tf.ScriptModuleLoader
+Provides low-level facilities for shared modules with script
+bindings to register themselves with their dependences, and provides a
+mechanism whereby those script modules will be loaded when necessary.
+Currently, this is when one of our script modules is loaded, when
+TfPyInitialize is called, and when Plug opens shared modules.
+Generally, user code will not make use of this.
+Methods:
+
+GetModuleNames()
+Return a list of all currently known modules in a valid dependency order.
+
+GetModulesDict()
+Return a python dict containing all currently known modules under their canonical names.
+
+WriteDotFile(file)
+Write a graphviz dot-file for the dependency graph of all.
+
+Attributes:
+
+expired
+True if this object has expired, False otherwise.
+
+GetModuleNames() → list[str]
+Return a list of all currently known modules in a valid dependency
+order.
+
+GetModulesDict() → python.dict
+Return a python dict containing all currently known modules under
+their canonical names.
+
+WriteDotFile(file) → None
+Write a graphviz dot-file for the dependency graph of all.
+currently known modules/modules to file.
+
+Parameters
+file (str) – 
+
+property expired
+True if this object has expired, False otherwise.
+
+class pxr.Tf.Singleton
+
+class pxr.Tf.StatusObject
+
+class pxr.Tf.Stopwatch
+Methods:
+
+AddFrom(t)
+Adds the accumulated time and sample count from t into the TfStopwatch .
+
+Reset()
+Resets the accumulated time and the sample count to zero.
+
+Start()
+Record the current time for use by the next Stop() call.
+
+Stop()
+Increases the accumulated time stored in the TfStopwatch .
+
+Attributes:
+
+microseconds
+int
+
+milliseconds
+int
+
+nanoseconds
+int
+
+sampleCount
+int
+
+seconds
+float
+
+AddFrom(t) → None
+Adds the accumulated time and sample count from t into the
+TfStopwatch .
+If you have several timers taking measurements, and you wish to
+combine them together, you can add one timer’s results into another;
+for example, t2.AddFrom(t1) will add t1 ‘s time and sample
+count into t2 .
+
+Parameters
+t (Stopwatch) – 
+
+Reset() → None
+Resets the accumulated time and the sample count to zero.
+
+Start() → None
+Record the current time for use by the next Stop() call.
+The Start() function records the current time. A subsequent call
+to Start() before a call to Stop() simply records a later
+current time, but does not change the accumulated time of the
+TfStopwatch .
+
+Stop() → None
+Increases the accumulated time stored in the TfStopwatch .
+The Stop() function increases the accumulated time by the duration
+between the current time and the last time recorded by a Start()
+call. A subsequent call to Stop() before another call to
+Start() will therefore double-count time and throw off the
+results.
+A TfStopwatch also counts the number of samples it has taken.
+The”sample count”is simply the number of times that Stop() has
+been called.
+
+property microseconds
+int
+Return the accumulated time in microseconds.
+Note that 45 minutes will overflow a 32-bit counter, so take care to
+save the result in an int64_t , and not a regular int or
+long .
+
+Type
+type
+
+property milliseconds
+int
+Return the accumulated time in milliseconds.
+
+Type
+type
+
+property nanoseconds
+int
+Return the accumulated time in nanoseconds.
+Note that this number can easily overflow a 32-bit counter, so take
+care to save the result in an int64_t , and not a regular int
+or long .
+
+Type
+type
+
+property sampleCount
+int
+Return the current sample count.
+The sample count, which is simply the number of calls to Stop()
+since creation or a call to Reset() , is useful for computing
+average running times of a repeated task.
+
+Type
+type
+
+property seconds
+float
+Return the accumulated time in seconds as a double .
+
+Type
+type
+
+class pxr.Tf.TemplateString
+Methods:
+
+GetEmptyMapping()
+Returns an empty mapping for the current template.
+
+GetParseErrors()
+Returns any error messages generated during template parsing.
+
+SafeSubstitute(arg1)
+Like Substitute() , except that if placeholders are missing from the mapping, instead of raising a coding error, the original placeholder will appear in the resulting string intact.
+
+Substitute(arg1)
+Performs the template substitution, returning a new string.
+
+Attributes:
+
+template
+str
+
+valid
+bool
+
+GetEmptyMapping() → Mapping
+Returns an empty mapping for the current template.
+This method first calls IsValid to ensure that the template is valid.
+
+GetParseErrors() → list[str]
+Returns any error messages generated during template parsing.
+
+SafeSubstitute(arg1) → str
+Like Substitute() , except that if placeholders are missing from the
+mapping, instead of raising a coding error, the original placeholder
+will appear in the resulting string intact.
+
+Parameters
+arg1 (Mapping) – 
+
+Substitute(arg1) → str
+Performs the template substitution, returning a new string.
+The mapping contains keys which match the placeholders in the
+template. If a placeholder is found for which no mapping is present, a
+coding error is raised.
+
+Parameters
+arg1 (Mapping) – 
+
+property template
+str
+Returns the template source string supplied to the constructor.
+
+Type
+type
+
+property valid
+bool
+Returns true if the current template is well formed.
+Empty templates are valid.
+
+Type
+type
+
+class pxr.Tf.Tf_PyEnumWrapper
+Attributes:
+
+displayName
+
+fullName
+
+name
+
+value
+
+property displayName
+
+property fullName
+
+property name
+
+property value
+
+class pxr.Tf.Tf_TestAnnotatedBoolResult
+Attributes:
+
+annotation
+
+property annotation
+
+class pxr.Tf.Tf_TestPyContainerConversions
+Methods:
+
+GetPairTimesTwo
+
+GetTokens
+
+GetVectorTimesTwo
+
+static GetPairTimesTwo()
+
+static GetTokens()��
+
+static GetVectorTimesTwo()
+
+class pxr.Tf.Tf_TestPyOptional
+Methods:
+
+TakesOptional
+
+TestOptionalChar
+
+TestOptionalDouble
+
+TestOptionalFloat
+
+TestOptionalInt
+
+TestOptionalLong
+
+TestOptionalShort
+
+TestOptionalString
+
+TestOptionalStringVector
+
+TestOptionalUChar
+
+TestOptionalUInt
+
+TestOptionalULong
+
+TestOptionalUShort
+
+static TakesOptional()
+
+static TestOptionalChar()
+
+static TestOptionalDouble()
+
+static TestOptionalFloat()
+
+static TestOptionalInt()
+
+static TestOptionalLong()
+
+static TestOptionalShort()
+
+static TestOptionalString()
+
+static TestOptionalStringVector()
+
+static TestOptionalUChar()
+
+static TestOptionalUInt()
+
+static TestOptionalULong()
+
+static TestOptionalUShort()
+
+class pxr.Tf.Type
+TfType represents a dynamic runtime type.
+TfTypes are created and discovered at runtime, rather than compile
+time.
+Features:
+
+unique typename
+safe across DSO boundaries
+can represent C++ types, pure Python types, or Python subclasses
+of wrapped C++ types
+lightweight value semantics  you can copy and default construct
+TfType, unlike std::type_info .
+totally ordered  can use as a std::map key
+
+Methods:
+
+AddAlias
+classmethod AddAlias(base, name) -> None
+
+Define
+classmethod Define() -> Type
+
+Find
+classmethod Find() -> Type
+
+FindByName
+classmethod FindByName(name) -> Type
+
+FindDerivedByName
+classmethod FindDerivedByName(name) -> Type
+
+GetAliases(derivedType)
+Returns a vector of the aliases registered for the derivedType under this, the base type.
+
+GetAllAncestorTypes(result)
+Build a vector of all ancestor types inherited by this type.
+
+GetAllDerivedTypes(result)
+Return the set of all types derived (directly or indirectly) from this type.
+
+GetRoot
+classmethod GetRoot() -> Type
+
+IsA(queryType)
+Return true if this type is the same as or derived from queryType
+
+Attributes:
+
+Unknown
+
+baseTypes
+list[Type]
+
+derivedTypes
+
+isEnumType
+bool
+
+isPlainOldDataType
+bool
+
+isUnknown
+bool
+
+pythonClass
+TfPyObjWrapper
+
+sizeof
+int
+
+typeName
+str
+
+AddAlias()
+classmethod AddAlias(base, name) -> None
+Add an alias name for this type under the given base type.
+Aliases are similar to typedefs in C++: they provide an alternate name
+for a type. The alias is defined with respect to the given base
+type. Aliases must be unique with respect to both other aliases
+beneath that base type and names of derived types of that base.
+
+Parameters
+
+base (Type) – 
+name (str) – 
+
+AddAlias(name) -> None
+Add an alias for DERIVED beneath BASE.
+This is a convenience method, that declares both DERIVED and BASE as
+TfTypes before adding the alias.
+
+Parameters
+name (str) – 
+
+static Define()
+classmethod Define() -> Type
+Define a TfType with the given C++ type T and C++ base types B.
+Each of the base types will be declared (but not defined) as TfTypes
+if they have not already been.
+The typeName of the created TfType will be the canonical demangled
+RTTI type name, as defined by GetCanonicalTypeName() .
+It is an error to attempt to define a type that has already been
+defined.
+
+Define() -> Type
+Define a TfType with the given C++ type T and no bases.
+See the other Define() template for more details.
+C++ does not allow default template arguments for function templates,
+so we provide this separate definition for the case of no bases.
+
+static Find()
+classmethod Find() -> Type
+Retrieve the TfType corresponding to type T .
+The type T must have been declared or defined in the type system
+or the TfType corresponding to an unknown type is returned.
+IsUnknown()
+
+Find(obj) -> Type
+Retrieve the TfType corresponding to obj .
+The TfType corresponding to the actual object represented by
+obj is returned; this may not be the object returned by
+TfType::Find<T>() if T is a polymorphic type.
+This works for Python subclasses of the C++ type T as well, as
+long as T has been wrapped using TfPyPolymorphic.
+Of course, the object’s type must have been declared or defined in the
+type system or the TfType corresponding to an unknown type is
+returned.
+IsUnknown()
+
+Parameters
+obj (T) – 
+
+Find(t) -> Type
+Retrieve the TfType corresponding to an obj with the given
+type_info .
+
+Parameters
+t (type_info) – 
+
+static FindByName()
+classmethod FindByName(name) -> Type
+Retrieve the TfType corresponding to the given name .
+Every type defined in the TfType system has a unique, implementation
+independent name. In addition, aliases can be added to identify a type
+underneath a specific base type; see TfType::AddAlias() . The given
+name will first be tried as an alias under the root type, and
+subsequently as a typename.
+This method is equivalent to:
+TfType::GetRoot().FindDerivedByName(name)
+
+For any object obj ,
+Find(obj) == FindByName( Find(obj).GetTypeName() )
+
+Parameters
+name (str) – 
+
+FindDerivedByName()
+classmethod FindDerivedByName(name) -> Type
+Retrieve the TfType that derives from this type and has the given
+alias or typename.
+AddAlias
+
+Parameters
+name (str) – 
+
+FindDerivedByName(name) -> Type
+Retrieve the TfType that derives from BASE and has the given alias
+or typename.
+This is a convenience method, and is equivalent to:
+TfType::Find<BASE>().FindDerivedByName(name)
+
+Parameters
+name (str) – 
+
+GetAliases(derivedType) → list[str]
+Returns a vector of the aliases registered for the derivedType under
+this, the base type.
+AddAlias()
+
+Parameters
+derivedType (Type) – 
+
+GetAllAncestorTypes(result) → None
+Build a vector of all ancestor types inherited by this type.
+The starting type is itself included, as the first element of the
+results vector.
+Types are given in”C3”resolution order, as used for new-style classes
+starting in Python 2.3. This algorithm is more complicated than a
+simple depth-first traversal of base classes, in order to prevent some
+subtle errors with multiple-inheritance. See the references below for
+more background.
+This can be expensive; consider caching the results. TfType does not
+cache this itself since it is not needed internally.
+Guido van Rossum.”Unifying types and classes in Python 2.2: Method
+resolution order.”
+http://www.python.org/download/releases/2.2.2/descrintro/#mro
+Barrett, Cassels, Haahr, Moon, Playford, Withington.”A Monotonic
+Superclass Linearization for Dylan.”OOPSLA 96.
+http://www.webcom.com/haahr/dylan/linearization-oopsla96.html
+
+Parameters
+result (list[Type]) – 
+
+GetAllDerivedTypes(result) → None
+Return the set of all types derived (directly or indirectly) from this
+type.
+
+Parameters
+result (set[Type]) – 
+
+static GetRoot()
+classmethod GetRoot() -> Type
+Return the root type of the type hierarchy.
+All known types derive (directly or indirectly) from the root. If a
+type is specified with no bases, it is implicitly considered to derive
+from the root type.
+
+IsA(queryType) → bool
+Return true if this type is the same as or derived from queryType
+.
+If queryType is unknown, this always returns false .
+
+Parameters
+queryType (Type) – 
+
+IsA() -> bool
+Return true if this type is the same as or derived from T.
+This is equivalent to:
+IsA(Find<T>())
+
+Unknown = Tf.Type.Unknown
+
+property baseTypes
+list[Type]
+Return a vector of types from which this type was derived.
+
+Type
+type
+
+property derivedTypes
+
+property isEnumType
+bool
+Return true if this is an enum type.
+
+Type
+type
+
+property isPlainOldDataType
+bool
+Return true if this is a plain old data type, as defined by C++.
+
+Type
+type
+
+property isUnknown
+bool
+Return true if this is the unknown type, representing a type unknown
+to the TfType system.
+The unknown type does not derive from the root type, or any other
+type.
+
+Type
+type
+
+property pythonClass
+TfPyObjWrapper
+Return the Python class object for this type.
+If this type is unknown or has not yet had a Python class defined,
+this will return None , as an empty TfPyObjWrapper
+DefinePythonClass()
+
+Type
+type
+
+property sizeof
+int
+Return the size required to hold an instance of this type on the stack
+(does not include any heap allocated memory the instance uses).
+This is what the C++ sizeof operator returns for the type, so this
+value is not very useful for Python types (it will always be
+sizeof(boost::python::object)).
+
+Type
+type
+
+property typeName
+str
+Return the machine-independent name for this type.
+This name is specified when the TfType is declared.
+Declare()
+
+Type
+type
+
+class pxr.Tf.Warning
+
+pxr.Tf.Fatal(msg)
+Raise a fatal error to the Tf Diagnostic system.
+
+pxr.Tf.GetCodeLocation(framesUp)
+Returns a tuple (moduleName, functionName, fileName, lineNo).
+To trace the current location of python execution, use GetCodeLocation().
+By default, the information is returned at the current stack-frame; thus:
+info = GetCodeLocation()
+
+will return information about the line that GetCodeLocation() was called
+from. One can write:
+def genericDebugFacility():
+    info = GetCodeLocation(1)
+    # print out data
+
+def someCode():
+    ...
+    if bad:
+        genericDebugFacility()
+
+and genericDebugFacility() will get information associated with its caller,
+i.e. the function someCode().
+
+pxr.Tf.PrepareModule(module, result)
+PrepareModule(module, result) – Prepare an extension module at import
+time.  Generally, this should only be called by the __init__.py script for a
+module upon loading a boost python module (generally ‘_libName.so’).
+
+pxr.Tf.PreparePythonModule(moduleName=None)
+Prepare an extension module at import time.  This will import the
+Python module associated with the caller’s module (e.g. ‘_tf’ for ‘pxr.Tf’)
+or the module with the specified moduleName and copy its contents into
+the caller’s local namespace.
+Generally, this should only be called by the __init__.py script for a module
+upon loading a boost python module (generally ‘_libName.so’).
+
+pxr.Tf.RaiseCodingError(msg)
+Raise a coding error to the Tf Diagnostic system.
+
+pxr.Tf.RaiseRuntimeError(msg)
+Raise a runtime error to the Tf Diagnostic system.
+
+pxr.Tf.Status(msg, verbose=True)
+Issues a status update to the Tf diagnostic system.
+If verbose is True (the default) then information about where in the code
+the status update was issued from is included.
+
+pxr.Tf.Warn(msg, template='')
+Issue a warning via the TfDiagnostic system.
+At this time, template is ignored.
+
+pxr.Tf.WindowsImportWrapper()
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

Trace.md

@@ -0,0 +1,395 @@
+
+
+Trace module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+Trace module
+
+ 
+
+# Trace module
+
+Summary: The Trace module provides performance tracking utility classes for counting, timing, measuring, recording, and reporting events.
+
+Trace – Utilities for counting and recording events.
+Classes:
+
+AggregateNode
+A representation of a call tree.
+
+Collector
+This is a singleton class that records TraceEvent instances and populates TraceCollection instances.
+
+Reporter
+This class converts streams of TraceEvent objects into call trees which can then be used as a data source to a GUI or written out to a file.
+
+Functions:
+
+TraceFunction(obj)
+A decorator that enables tracing the function that it decorates.
+
+TraceMethod(obj)
+A convenience.
+
+TraceScope(label)
+A context manager that calls BeginEvent on the global collector on enter and EndEvent on exit.
+
+class pxr.Trace.AggregateNode
+A representation of a call tree. Each node represents one or more
+calls that occurred in the trace. Multiple calls to a child node are
+aggregated into one node.
+Attributes:
+
+children
+list[TraceAggregateNodePtr]
+
+count
+int
+
+exclusiveCount
+int
+
+exclusiveTime
+TimeStamp
+
+expanded
+bool
+
+expired
+True if this object has expired, False otherwise.
+
+id
+Id
+
+inclusiveTime
+TimeStamp
+
+key
+str
+
+property children
+list[TraceAggregateNodePtr]
+
+Type
+type
+
+property count
+int
+Returns the call count of this node.
+recursive determines if recursive calls are counted.
+
+Type
+type
+
+property exclusiveCount
+int
+Returns the exclusive count.
+
+Type
+type
+
+property exclusiveTime
+TimeStamp
+Returns the time spent in this node but not its children.
+
+Type
+type
+
+property expanded
+bool
+Returns whether this node is expanded in a gui.
+
+type : None
+Sets whether or not this node is expanded in a gui.
+
+Type
+type
+
+property expired
+True if this object has expired, False otherwise.
+
+property id
+Id
+Returns the node’s id.
+
+Type
+type
+
+property inclusiveTime
+TimeStamp
+Returns the total time of this node ands its children.
+
+Type
+type
+
+property key
+str
+Returns the node’s key.
+
+Type
+type
+
+class pxr.Trace.Collector
+This is a singleton class that records TraceEvent instances and
+populates TraceCollection instances.
+All public methods of TraceCollector are safe to call from any thread.
+Methods:
+
+BeginEvent(key)
+Record a begin event with key if Category is enabled.
+
+BeginEventAtTime(key, ms)
+Record a begin event with key at a specified time if Category is enabled.
+
+Clear()
+Clear all pending events from the collector.
+
+EndEvent(key)
+Record an end event with key if Category is enabled.
+
+EndEventAtTime(key, ms)
+Record an end event with key at a specified time if Category is enabled.
+
+GetLabel()
+Return the label associated with this collector.
+
+Attributes:
+
+enabled
+bool
+
+expired
+True if this object has expired, False otherwise.
+
+pythonTracingEnabled
+None
+
+BeginEvent(key) → TimeStamp
+Record a begin event with key if Category is enabled.
+A matching end event is expected some time in the future.
+If the key is known at compile time BeginScope and Scope
+methods are preferred because they have lower overhead.
+The TimeStamp of the TraceEvent or 0 if the collector is disabled.
+BeginScope
+Scope
+
+Parameters
+key (Key) – 
+
+BeginEventAtTime(key, ms) → None
+Record a begin event with key at a specified time if Category is
+enabled.
+This version of the method allows the passing of a specific number of
+elapsed milliseconds, ms, to use for this event. This method is used
+for testing and debugging code.
+
+Parameters
+
+key (Key) – 
+ms (float) – 
+
+Clear() → None
+Clear all pending events from the collector.
+No TraceCollection will be made for these events.
+
+EndEvent(key) → TimeStamp
+Record an end event with key if Category is enabled.
+A matching begin event must have preceded this end event.
+If the key is known at compile time EndScope and Scope methods are
+preferred because they have lower overhead.
+The TimeStamp of the TraceEvent or 0 if the collector is disabled.
+EndScope
+Scope
+
+Parameters
+key (Key) – 
+
+EndEventAtTime(key, ms) → None
+Record an end event with key at a specified time if Category is
+enabled.
+This version of the method allows the passing of a specific number of
+elapsed milliseconds, ms, to use for this event. This method is used
+for testing and debugging code.
+
+Parameters
+
+key (Key) – 
+ms (float) – 
+
+GetLabel() → str
+Return the label associated with this collector.
+
+property enabled
+bool
+Returns whether collection of events is enabled for DefaultCategory.
+
+type : None
+Enables or disables collection of events for DefaultCategory.
+
+Type
+classmethod type
+
+property expired
+True if this object has expired, False otherwise.
+
+property pythonTracingEnabled
+None
+Set whether automatic tracing of all python scopes is enabled.
+
+type : bool
+Returns whether automatic tracing of all python scopes is enabled.
+
+Type
+type
+
+class pxr.Trace.Reporter
+This class converts streams of TraceEvent objects into call trees
+which can then be used as a data source to a GUI or written out to a
+file.
+Methods:
+
+ClearTree()
+Clears event tree and counters.
+
+GetLabel()
+Return the label associated with this reporter.
+
+Report(s, iterationCount)
+Generates a report to the ostream s, dividing all times by iterationCount.
+
+ReportChromeTracing(s)
+Generates a timeline trace report suitable for viewing in Chrome's trace viewer.
+
+ReportChromeTracingToFile
+
+ReportTimes(s)
+Generates a report of the times to the ostream s.
+
+UpdateTraceTrees()
+This fully re-builds the event and aggregate trees from whatever the current collection holds.
+
+Attributes:
+
+aggregateTreeRoot
+AggregateNode
+
+expired
+True if this object has expired, False otherwise.
+
+foldRecursiveCalls
+bool
+
+globalReporter
+
+groupByFunction
+bool
+
+shouldAdjustForOverheadAndNoise
+None
+
+ClearTree() → None
+Clears event tree and counters.
+
+GetLabel() → str
+Return the label associated with this reporter.
+
+Report(s, iterationCount) → None
+Generates a report to the ostream s, dividing all times by
+iterationCount.
+
+Parameters
+
+s (ostream) – 
+iterationCount (int) – 
+
+ReportChromeTracing(s) → None
+Generates a timeline trace report suitable for viewing in Chrome’s
+trace viewer.
+
+Parameters
+s (ostream) – 
+
+ReportChromeTracingToFile()
+
+ReportTimes(s) → None
+Generates a report of the times to the ostream s.
+
+Parameters
+s (ostream) – 
+
+UpdateTraceTrees() → None
+This fully re-builds the event and aggregate trees from whatever the
+current collection holds.
+It is ok to call this multiple times in case the collection gets
+appended on inbetween.
+If we want to have multiple reporters per collector, this will need to
+be changed so that all reporters reporting on a collector update their
+respective trees.
+
+property aggregateTreeRoot
+AggregateNode
+Returns the root node of the aggregated call tree.
+
+Type
+type
+
+property expired
+True if this object has expired, False otherwise.
+
+property foldRecursiveCalls
+bool
+Returns the current setting for recursion folding for stack trace
+event reporting.
+
+type : None
+When stack trace event reporting, this sets whether or not recursive
+calls are folded in the output.
+Recursion folding is useful when the stacks contain deep recursive
+structures.
+
+Type
+type
+
+globalReporter = <pxr.Trace.Reporter object>
+
+property groupByFunction
+bool
+Returns the current group-by-function state.
+
+type : None
+This affects only stack trace event reporting.
+If true then all events in a function are grouped together
+otherwise events are split out by address.
+
+Type
+type
+
+property shouldAdjustForOverheadAndNoise
+None
+Set whether or not the reporter should adjust scope times for overhead
+and noise.
+
+Type
+type
+
+pxr.Trace.TraceFunction(obj)
+A decorator that enables tracing the function that it decorates.
+If you decorate with ‘TraceFunction’ the function will be traced in the
+global collector.
+
+pxr.Trace.TraceMethod(obj)
+A convenience.  Same as TraceFunction but changes the recorded
+label to use the term ‘method’ rather than ‘function’.
+
+pxr.Trace.TraceScope(label)
+A context manager that calls BeginEvent on the global collector on enter
+and EndEvent on exit.
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

UsdAppUtils.md

@@ -0,0 +1,115 @@
+
+
+UsdAppUtils module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+UsdAppUtils module
+
+ 
+
+# UsdAppUtils module
+
+Summary: The UsdAppUtils module contains a number of utilities and common functionality for applications that view and/or record images of USD stages.
+
+Classes:
+
+FrameRecorder
+A utility class for recording images of USD stages.
+
+class pxr.UsdAppUtils.FrameRecorder
+A utility class for recording images of USD stages.
+UsdAppUtilsFrameRecorder uses Hydra to produce recorded images of a
+USD stage looking through a particular UsdGeomCamera on that stage at
+a particular UsdTimeCode. The images generated will be effectively the
+same as what you would see in the viewer in usdview.
+Note that it is assumed that an OpenGL context has already been setup.
+Methods:
+
+GetCurrentRendererId()
+Gets the ID of the Hydra renderer plugin that will be used for recording.
+
+Record(stage, usdCamera, timeCode, ...)
+Records an image and writes the result to outputImagePath .
+
+SetColorCorrectionMode(colorCorrectionMode)
+Sets the color correction mode to be used for recording.
+
+SetComplexity(complexity)
+Sets the level of refinement complexity.
+
+SetImageWidth(imageWidth)
+Sets the width of the recorded image.
+
+SetIncludedPurposes(purposes)
+Sets the UsdGeomImageable purposes to be used for rendering.
+
+SetRendererPlugin(id)
+Sets the Hydra renderer plugin to be used for recording.
+
+GetCurrentRendererId() → str
+Gets the ID of the Hydra renderer plugin that will be used for
+recording.
+
+Record(stage, usdCamera, timeCode, outputImagePath) → bool
+Records an image and writes the result to outputImagePath .
+The recorded image will represent the view from usdCamera looking
+at the imageable prims on USD stage stage at time timeCode .
+If usdCamera is not a valid camera, a camera will be computed to
+automatically frame the stage geometry.
+Returns true if the image was generated and written successfully, or
+false otherwise.
+
+Parameters
+
+stage (Stage) – 
+usdCamera (Camera) – 
+timeCode (TimeCode) – 
+outputImagePath (str) – 
+
+SetColorCorrectionMode(colorCorrectionMode) → None
+Sets the color correction mode to be used for recording.
+By default, color correction is disabled.
+
+Parameters
+colorCorrectionMode (str) – 
+
+SetComplexity(complexity) → None
+Sets the level of refinement complexity.
+The default complexity is”low”(1.0).
+
+Parameters
+complexity (float) – 
+
+SetImageWidth(imageWidth) → None
+Sets the width of the recorded image.
+The height of the recorded image will be computed using this value and
+the aspect ratio of the camera used for recording.
+The default image width is 960 pixels.
+
+Parameters
+imageWidth (int) – 
+
+SetIncludedPurposes(purposes) → None
+Sets the UsdGeomImageable purposes to be used for rendering.
+We will always include”default”purpose, and by default, we will
+also include UsdGeomTokens->proxy. Use this method to explicitly
+enumerate an alternate set of purposes to be included along
+with”default”.
+
+Parameters
+purposes (list[TfToken]) – 
+
+SetRendererPlugin(id) → bool
+Sets the Hydra renderer plugin to be used for recording.
+
+Parameters
+id (str) – 
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

UsdHydra.md

@@ -0,0 +1,294 @@
+
+
+UsdHydra module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+UsdHydra module
+
+ 
+
+# UsdHydra module
+
+Summary: The UsdHydra module.
+
+Classes:
+
+GenerativeProceduralAPI
+This API extends and configures the core UsdProcGenerativeProcedural schema defined within usdProc for use with hydra generative procedurals as defined within hdGp.
+
+Tokens
+
+class pxr.UsdHydra.GenerativeProceduralAPI
+This API extends and configures the core UsdProcGenerativeProcedural
+schema defined within usdProc for use with hydra generative
+procedurals as defined within hdGp.
+For any described attribute Fallback Value or Allowed Values
+below that are text/tokens, the actual token is published and defined
+in UsdHydraTokens. So to set an attribute to the value”rightHanded”,
+use UsdHydraTokens->rightHanded as the value.
+Methods:
+
+Apply
+classmethod Apply(prim) -> GenerativeProceduralAPI
+
+CanApply
+classmethod CanApply(prim, whyNot) -> bool
+
+CreateProceduralSystemAttr(defaultValue, ...)
+See GetProceduralSystemAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateProceduralTypeAttr(defaultValue, ...)
+See GetProceduralTypeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Get
+classmethod Get(stage, path) -> GenerativeProceduralAPI
+
+GetProceduralSystemAttr()
+This value should correspond to a configured instance of HdGpGenerativeProceduralResolvingSceneIndex which will evaluate the procedural.
+
+GetProceduralTypeAttr()
+The registered name of a HdGpGenerativeProceduralPlugin to be executed.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+static Apply()
+classmethod Apply(prim) -> GenerativeProceduralAPI
+Applies this single-apply API schema to the given prim .
+This information is stored by adding”HydraGenerativeProceduralAPI”to
+the token-valued, listOp metadata apiSchemas on the prim.
+A valid UsdHydraGenerativeProceduralAPI object is returned upon
+success. An invalid (or empty) UsdHydraGenerativeProceduralAPI object
+is returned upon failure. See UsdPrim::ApplyAPI() for conditions
+resulting in failure.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+prim (Prim) – 
+
+static CanApply()
+classmethod CanApply(prim, whyNot) -> bool
+Returns true if this single-apply API schema can be applied to the
+given prim .
+If this schema can not be a applied to the prim, this returns false
+and, if provided, populates whyNot with the reason it can not be
+applied.
+Note that if CanApply returns false, that does not necessarily imply
+that calling Apply will fail. Callers are expected to call CanApply
+before calling Apply if they want to ensure that it is valid to apply
+a schema.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+
+prim (Prim) – 
+whyNot (str) – 
+
+CreateProceduralSystemAttr(defaultValue, writeSparsely) → Attribute
+See GetProceduralSystemAttr() , and also Create vs Get Property
+Methods for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateProceduralTypeAttr(defaultValue, writeSparsely) → Attribute
+See GetProceduralTypeAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Get()
+classmethod Get(stage, path) -> GenerativeProceduralAPI
+Return a UsdHydraGenerativeProceduralAPI holding the prim adhering to
+this schema at path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdHydraGenerativeProceduralAPI(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetProceduralSystemAttr() → Attribute
+This value should correspond to a configured instance of
+HdGpGenerativeProceduralResolvingSceneIndex which will evaluate the
+procedural.
+The default value of”hydraGenerativeProcedural”matches the equivalent
+default of HdGpGenerativeProceduralResolvingSceneIndex. Multiple
+instances of the scene index can be used to determine where within a
+scene index chain a given procedural will be evaluated.
+Declaration
+token proceduralSystem ="hydraGenerativeProcedural"
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+
+GetProceduralTypeAttr() → Attribute
+The registered name of a HdGpGenerativeProceduralPlugin to be
+executed.
+Declaration
+token primvars:hdGp:proceduralType
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+class pxr.UsdHydra.Tokens
+Attributes:
+
+HwPrimvar_1
+
+HwPtexTexture_1
+
+HwUvTexture_1
+
+black
+
+clamp
+
+displayLookBxdf
+
+faceIndex
+
+faceOffset
+
+frame
+
+hydraGenerativeProcedural
+
+infoFilename
+
+infoVarname
+
+linear
+
+linearMipmapLinear
+
+linearMipmapNearest
+
+magFilter
+
+minFilter
+
+mirror
+
+nearest
+
+nearestMipmapLinear
+
+nearestMipmapNearest
+
+primvarsHdGpProceduralType
+
+proceduralSystem
+
+repeat
+
+textureMemory
+
+useMetadata
+
+uv
+
+wrapS
+
+wrapT
+
+HwPrimvar_1 = 'HwPrimvar_1'
+
+HwPtexTexture_1 = 'HwPtexTexture_1'
+
+HwUvTexture_1 = 'HwUvTexture_1'
+
+black = 'black'
+
+clamp = 'clamp'
+
+displayLookBxdf = 'displayLook:bxdf'
+
+faceIndex = 'faceIndex'
+
+faceOffset = 'faceOffset'
+
+frame = 'frame'
+
+hydraGenerativeProcedural = 'hydraGenerativeProcedural'
+
+infoFilename = 'inputs:file'
+
+infoVarname = 'inputs:varname'
+
+linear = 'linear'
+
+linearMipmapLinear = 'linearMipmapLinear'
+
+linearMipmapNearest = 'linearMipmapNearest'
+
+magFilter = 'magFilter'
+
+minFilter = 'minFilter'
+
+mirror = 'mirror'
+
+nearest = 'nearest'
+
+nearestMipmapLinear = 'nearestMipmapLinear'
+
+nearestMipmapNearest = 'nearestMipmapNearest'
+
+primvarsHdGpProceduralType = 'primvars:hdGp:proceduralType'
+
+proceduralSystem = 'proceduralSystem'
+
+repeat = 'repeat'
+
+textureMemory = 'textureMemory'
+
+useMetadata = 'useMetadata'
+
+uv = 'uv'
+
+wrapS = 'wrapS'
+
+wrapT = 'wrapT'
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

UsdMedia.md

@@ -0,0 +1,462 @@
+
+
+UsdMedia module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+UsdMedia module
+
+ 
+
+# UsdMedia module
+
+Summary: The UsdMedia module provides a representation for including other media, such as audio, in the context of a stage. UsdMedia currently contains one media type, UsdMediaSpatialAudio, which allows the playback of audio files both spatially and non-spatially.
+
+Classes:
+
+SpatialAudio
+The SpatialAudio primitive defines basic properties for encoding playback of an audio file or stream within a USD Stage.
+
+Tokens
+
+class pxr.UsdMedia.SpatialAudio
+The SpatialAudio primitive defines basic properties for encoding
+playback of an audio file or stream within a USD Stage. The
+SpatialAudio schema derives from UsdGeomXformable since it can support
+full spatial audio while also supporting non-spatial mono and stereo
+sounds. One or more SpatialAudio prims can be placed anywhere in the
+namespace, though it is advantageous to place truly spatial audio
+prims under/inside the models from which the sound emanates, so that
+the audio prim need only be transformed relative to the model, rather
+than copying its animation.
+
+## Timecode Attributes and Time Scaling
+
+startTime and endTime are timecode valued attributes which gives
+them the special behavior that layer offsets affecting the layer in
+which one of these values is authored are applied to the attribute’s
+value itself during value resolution. This allows audio playback to be
+kept in sync with time sampled animation as the animation is affected
+by layer offsets in the composition. But this behavior brings with it
+some interesting edge cases and caveats when it comes to layer offsets
+that include scale.
+Although authored layer offsets may have a time scale which can scale
+the duration between an authored startTime and endTime, we make no
+attempt to infer any playback dilation of the actual audio media
+itself. Given that startTime and endTime can be independently
+authored in different layers with differing time scales, it is not
+possible, in general, to define an”original timeframe”from which we
+can compute a dilation to composed stage-time. Even if we could
+compute a composed dilation this way, it would still be impossible to
+flatten a stage or layer stack into a single layer and still retain
+the composed audio dilation using this schema.
+Although we do not expect it to be common, it is possible to apply a
+negative time scale to USD layers, which mostly has the effect of
+reversing animation in the affected composition. If a negative scale
+is applied to a composition that contains authored startTime and
+endTime, it will reverse their relative ordering in time. Therefore,
+we stipulate when playbackMode
+is”onceFromStartToEnd”or”loopFromStartToEnd”, if endTime is less
+than startTime, then begin playback at endTime, and continue until
+startTime. When startTime and endTime are inverted, we do not,
+however, stipulate that playback of the audio media itself be
+inverted, since doing so”successfully”would require perfect knowledge
+of when, within the audio clip, relevant audio ends (so that we know
+how to offset the reversed audio to align it so that we reach
+the”beginning”at startTime), and sounds played in reverse are not
+likely to produce desirable results.
+For any described attribute Fallback Value or Allowed Values
+below that are text/tokens, the actual token is published and defined
+in UsdMediaTokens. So to set an attribute to the value”rightHanded”,
+use UsdMediaTokens->rightHanded as the value.
+Methods:
+
+CreateAuralModeAttr(defaultValue, writeSparsely)
+See GetAuralModeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateEndTimeAttr(defaultValue, writeSparsely)
+See GetEndTimeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateFilePathAttr(defaultValue, writeSparsely)
+See GetFilePathAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateGainAttr(defaultValue, writeSparsely)
+See GetGainAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateMediaOffsetAttr(defaultValue, ...)
+See GetMediaOffsetAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreatePlaybackModeAttr(defaultValue, ...)
+See GetPlaybackModeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateStartTimeAttr(defaultValue, writeSparsely)
+See GetStartTimeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Define
+classmethod Define(stage, path) -> SpatialAudio
+
+Get
+classmethod Get(stage, path) -> SpatialAudio
+
+GetAuralModeAttr()
+Determines how audio should be played.
+
+GetEndTimeAttr()
+Expressed in the timeCodesPerSecond of the containing stage, endTime specifies when the audio stream will cease playing during animation playback if the length of the referenced audio clip is longer than desired.
+
+GetFilePathAttr()
+Path to the audio file.
+
+GetGainAttr()
+Multiplier on the incoming audio signal.
+
+GetMediaOffsetAttr()
+Expressed in seconds, mediaOffset specifies the offset from the referenced audio file's beginning at which we should begin playback when stage playback reaches the time that prim's audio should start.
+
+GetPlaybackModeAttr()
+Along with startTime and endTime, determines when the audio playback should start and stop during the stage's animation playback and whether the audio should loop during its duration.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+GetStartTimeAttr()
+Expressed in the timeCodesPerSecond of the containing stage, startTime specifies when the audio stream will start playing during animation playback.
+
+CreateAuralModeAttr(defaultValue, writeSparsely) → Attribute
+See GetAuralModeAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateEndTimeAttr(defaultValue, writeSparsely) → Attribute
+See GetEndTimeAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateFilePathAttr(defaultValue, writeSparsely) → Attribute
+See GetFilePathAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateGainAttr(defaultValue, writeSparsely) → Attribute
+See GetGainAttr() , and also Create vs Get Property Methods for when
+to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateMediaOffsetAttr(defaultValue, writeSparsely) → Attribute
+See GetMediaOffsetAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreatePlaybackModeAttr(defaultValue, writeSparsely) → Attribute
+See GetPlaybackModeAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateStartTimeAttr(defaultValue, writeSparsely) → Attribute
+See GetStartTimeAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Define()
+classmethod Define(stage, path) -> SpatialAudio
+Attempt to ensure a UsdPrim adhering to this schema at path is
+defined (according to UsdPrim::IsDefined() ) on this stage.
+If a prim adhering to this schema at path is already defined on
+this stage, return that prim. Otherwise author an SdfPrimSpec with
+specifier == SdfSpecifierDef and this schema’s prim type name for
+the prim at path at the current EditTarget. Author SdfPrimSpec s
+with specifier == SdfSpecifierDef and empty typeName at the
+current EditTarget for any nonexistent, or existing but not Defined
+ancestors.
+The given path must be an absolute prim path that does not contain
+any variant selections.
+If it is impossible to author any of the necessary PrimSpecs, (for
+example, in case path cannot map to the current UsdEditTarget ‘s
+namespace) issue an error and return an invalid UsdPrim.
+Note that this method may return a defined prim whose typeName does
+not specify this schema class, in case a stronger typeName opinion
+overrides the opinion at the current EditTarget.
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static Get()
+classmethod Get(stage, path) -> SpatialAudio
+Return a UsdMediaSpatialAudio holding the prim adhering to this schema
+at path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdMediaSpatialAudio(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetAuralModeAttr() → Attribute
+Determines how audio should be played.
+Valid values are:
+
+spatial: Play the audio in 3D space if the device can support
+spatial audio. if not, fall back to mono.
+nonSpatial: Play the audio without regard to the SpatialAudio
+prim’s position. If the audio media contains any form of stereo or
+other multi-channel sound, it is left to the application to determine
+whether the listener’s position should be taken into account. We
+expect nonSpatial to be the choice for ambient sounds and music sound-
+tracks.
+
+Declaration
+uniform token auralMode ="spatial"
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+Variability
+SdfVariabilityUniform
+Allowed Values
+spatial, nonSpatial
+
+GetEndTimeAttr() → Attribute
+Expressed in the timeCodesPerSecond of the containing stage, endTime
+specifies when the audio stream will cease playing during animation
+playback if the length of the referenced audio clip is longer than
+desired.
+This only applies if playbackMode is set to onceFromStartToEnd or
+loopFromStartToEnd, otherwise the endTimeCode of the stage is used
+instead of endTime. If endTime is less than startTime, it is
+expected that the audio will instead be played from endTime to
+startTime. Note that endTime is expressed as a timecode so that
+the stage can properly apply layer offsets when resolving its value.
+See Timecode Attributes and Time Scaling for more details and caveats.
+Declaration
+uniform timecode endTime = 0
+C++ Type
+SdfTimeCode
+Usd Type
+SdfValueTypeNames->TimeCode
+Variability
+SdfVariabilityUniform
+
+GetFilePathAttr() → Attribute
+Path to the audio file.
+In general, the formats allowed for audio files is no more constrained
+by USD than is image-type. As with images, however, usdz has stricter
+requirements based on DMA and format support in browsers and consumer
+devices. The allowed audio filetypes for usdz are M4A, MP3, WAV (in
+order of preference).
+Usdz Specification
+Declaration
+uniform asset filePath = @@
+C++ Type
+SdfAssetPath
+Usd Type
+SdfValueTypeNames->Asset
+Variability
+SdfVariabilityUniform
+
+GetGainAttr() → Attribute
+Multiplier on the incoming audio signal.
+A value of 0”mutes”the signal. Negative values will be clamped to 0.
+Declaration
+double gain = 1
+C++ Type
+double
+Usd Type
+SdfValueTypeNames->Double
+
+GetMediaOffsetAttr() → Attribute
+Expressed in seconds, mediaOffset specifies the offset from the
+referenced audio file’s beginning at which we should begin playback
+when stage playback reaches the time that prim’s audio should start.
+If the prim’s playbackMode is a looping mode, mediaOffset is
+applied only to the first run-through of the audio clip; the second
+and all other loops begin from the start of the audio clip.
+Declaration
+uniform double mediaOffset = 0
+C++ Type
+double
+Usd Type
+SdfValueTypeNames->Double
+Variability
+SdfVariabilityUniform
+
+GetPlaybackModeAttr() → Attribute
+Along with startTime and endTime, determines when the audio
+playback should start and stop during the stage’s animation playback
+and whether the audio should loop during its duration.
+Valid values are:
+
+onceFromStart: Play the audio once, starting at startTime,
+continuing until the audio completes.
+onceFromStartToEnd: Play the audio once beginning at startTime,
+continuing until endTime or until the audio completes, whichever
+comes first.
+loopFromStart: Start playing the audio at startTime and
+continue looping through to the stage’s authored endTimeCode.
+loopFromStartToEnd: Start playing the audio at startTime and
+continue looping through, stopping the audio at endTime.
+loopFromStage: Start playing the audio at the stage’s authored
+startTimeCode and continue looping through to the stage’s authored
+endTimeCode. This can be useful for ambient sounds that should
+always be active.
+
+Declaration
+uniform token playbackMode ="onceFromStart"
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+Variability
+SdfVariabilityUniform
+Allowed Values
+onceFromStart, onceFromStartToEnd, loopFromStart, loopFromStartToEnd,
+loopFromStage
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+GetStartTimeAttr() → Attribute
+Expressed in the timeCodesPerSecond of the containing stage,
+startTime specifies when the audio stream will start playing during
+animation playback.
+This value is ignored when playbackMode is set to loopFromStage as,
+in this mode, the audio will always start at the stage’s authored
+startTimeCode. Note that startTime is expressed as a timecode so
+that the stage can properly apply layer offsets when resolving its
+value. See Timecode Attributes and Time Scaling for more details and
+caveats.
+Declaration
+uniform timecode startTime = 0
+C++ Type
+SdfTimeCode
+Usd Type
+SdfValueTypeNames->TimeCode
+Variability
+SdfVariabilityUniform
+
+class pxr.UsdMedia.Tokens
+Attributes:
+
+auralMode
+
+endTime
+
+filePath
+
+gain
+
+loopFromStage
+
+loopFromStart
+
+loopFromStartToEnd
+
+mediaOffset
+
+nonSpatial
+
+onceFromStart
+
+onceFromStartToEnd
+
+playbackMode
+
+spatial
+
+startTime
+
+auralMode = 'auralMode'
+
+endTime = 'endTime'
+
+filePath = 'filePath'
+
+gain = 'gain'
+
+loopFromStage = 'loopFromStage'
+
+loopFromStart = 'loopFromStart'
+
+loopFromStartToEnd = 'loopFromStartToEnd'
+
+mediaOffset = 'mediaOffset'
+
+nonSpatial = 'nonSpatial'
+
+onceFromStart = 'onceFromStart'
+
+onceFromStartToEnd = 'onceFromStartToEnd'
+
+playbackMode = 'playbackMode'
+
+spatial = 'spatial'
+
+startTime = 'startTime'
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

UsdProc.md

@@ -0,0 +1,138 @@
+
+
+UsdProc module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+UsdProc module
+
+ 
+
+# UsdProc module
+
+Summary: The UsdProc module defines schemas for the scene description of procedural data meaningful to downstream systems.
+
+Classes:
+
+GenerativeProcedural
+Represents an abstract generative procedural prim which delivers its input parameters via properties (including relationships) within the"primvars:"namespace.
+
+Tokens
+
+class pxr.UsdProc.GenerativeProcedural
+Represents an abstract generative procedural prim which delivers its
+input parameters via properties (including relationships) within
+the”primvars:”namespace.
+It does not itself have any awareness or participation in the
+execution of the procedural but rather serves as a means of delivering
+a procedural’s definition and input parameters.
+The value of its”proceduralSystem”property (either authored or
+provided by API schema fallback) indicates to which system the
+procedural definition is meaningful.
+For any described attribute Fallback Value or Allowed Values
+below that are text/tokens, the actual token is published and defined
+in UsdProcTokens. So to set an attribute to the value”rightHanded”,
+use UsdProcTokens->rightHanded as the value.
+Methods:
+
+CreateProceduralSystemAttr(defaultValue, ...)
+See GetProceduralSystemAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Define
+classmethod Define(stage, path) -> GenerativeProcedural
+
+Get
+classmethod Get(stage, path) -> GenerativeProcedural
+
+GetProceduralSystemAttr()
+The name or convention of the system responsible for evaluating the procedural.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+CreateProceduralSystemAttr(defaultValue, writeSparsely) → Attribute
+See GetProceduralSystemAttr() , and also Create vs Get Property
+Methods for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Define()
+classmethod Define(stage, path) -> GenerativeProcedural
+Attempt to ensure a UsdPrim adhering to this schema at path is
+defined (according to UsdPrim::IsDefined() ) on this stage.
+If a prim adhering to this schema at path is already defined on
+this stage, return that prim. Otherwise author an SdfPrimSpec with
+specifier == SdfSpecifierDef and this schema’s prim type name for
+the prim at path at the current EditTarget. Author SdfPrimSpec s
+with specifier == SdfSpecifierDef and empty typeName at the
+current EditTarget for any nonexistent, or existing but not Defined
+ancestors.
+The given path must be an absolute prim path that does not contain
+any variant selections.
+If it is impossible to author any of the necessary PrimSpecs, (for
+example, in case path cannot map to the current UsdEditTarget ‘s
+namespace) issue an error and return an invalid UsdPrim.
+Note that this method may return a defined prim whose typeName does
+not specify this schema class, in case a stronger typeName opinion
+overrides the opinion at the current EditTarget.
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static Get()
+classmethod Get(stage, path) -> GenerativeProcedural
+Return a UsdProcGenerativeProcedural holding the prim adhering to this
+schema at path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdProcGenerativeProcedural(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetProceduralSystemAttr() → Attribute
+The name or convention of the system responsible for evaluating the
+procedural.
+NOTE: A fallback value for this is typically set via an API schema.
+Declaration
+token proceduralSystem
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+class pxr.UsdProc.Tokens
+Attributes:
+
+proceduralSystem
+
+proceduralSystem = 'proceduralSystem'
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

UsdRender.md

@@ -0,0 +1,1343 @@
+
+
+UsdRender module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+UsdRender module
+
+ 
+
+# UsdRender module
+
+Summary: The UsdRender module provides schemas and behaviors for describing renders.
+
+Classes:
+
+DenoisePass
+A RenderDenoisePass generates renders via a denoising process.
+
+Pass
+A RenderPass prim encapsulates the necessary information to generate multipass renders.
+
+Product
+A UsdRenderProduct describes an image or other file-like artifact produced by a render.
+
+Settings
+A UsdRenderSettings prim specifies global settings for a render process, including an enumeration of the RenderProducts that should result, and the UsdGeomImageable purposes that should be rendered.
+
+SettingsBase
+Abstract base class that defines render settings that can be specified on either a RenderSettings prim or a RenderProduct prim.
+
+Tokens
+
+Var
+A UsdRenderVar describes a custom data variable for a render to produce.
+
+class pxr.UsdRender.DenoisePass
+A RenderDenoisePass generates renders via a denoising process. This
+may be the same renderer that a pipeline uses for UsdRender, or may be
+a separate one. Notably, a RenderDenoisePass requires another Pass to
+be present for it to operate. The denoising process itself is not
+generative, and requires images inputs to operate.
+As denoising integration varies so widely across pipelines, all
+implementation details are left to pipeline-specific prims that
+inherit from RenderDenoisePass.
+Methods:
+
+Define
+classmethod Define(stage, path) -> DenoisePass
+
+Get
+classmethod Get(stage, path) -> DenoisePass
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+static Define()
+classmethod Define(stage, path) -> DenoisePass
+Attempt to ensure a UsdPrim adhering to this schema at path is
+defined (according to UsdPrim::IsDefined() ) on this stage.
+If a prim adhering to this schema at path is already defined on
+this stage, return that prim. Otherwise author an SdfPrimSpec with
+specifier == SdfSpecifierDef and this schema’s prim type name for
+the prim at path at the current EditTarget. Author SdfPrimSpec s
+with specifier == SdfSpecifierDef and empty typeName at the
+current EditTarget for any nonexistent, or existing but not Defined
+ancestors.
+The given path must be an absolute prim path that does not contain
+any variant selections.
+If it is impossible to author any of the necessary PrimSpecs, (for
+example, in case path cannot map to the current UsdEditTarget ‘s
+namespace) issue an error and return an invalid UsdPrim.
+Note that this method may return a defined prim whose typeName does
+not specify this schema class, in case a stronger typeName opinion
+overrides the opinion at the current EditTarget.
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static Get()
+classmethod Get(stage, path) -> DenoisePass
+Return a UsdRenderDenoisePass holding the prim adhering to this schema
+at path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdRenderDenoisePass(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+class pxr.UsdRender.Pass
+A RenderPass prim encapsulates the necessary information to generate
+multipass renders. It houses properties for generating dependencies
+and the necessary commands to run to generate renders, as well as
+visibility controls for the scene. While RenderSettings describes the
+information needed to generate images from a single invocation of a
+renderer, RenderPass describes the additional information needed to
+generate a time varying set of images.
+There are two consumers of RenderPass prims - a runtime executable
+that generates images from usdRender prims, and pipeline specific code
+that translates between usdRender prims and the pipeline’s resource
+scheduling software. We’ll refer to the latter as’job submission
+code’.
+The name of the prim is used as the pass’s name.
+For any described attribute Fallback Value or Allowed Values
+below that are text/tokens, the actual token is published and defined
+in UsdRenderTokens. So to set an attribute to the value”rightHanded”,
+use UsdRenderTokens->rightHanded as the value.
+Methods:
+
+CreateCommandAttr(defaultValue, writeSparsely)
+See GetCommandAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateDenoiseEnableAttr(defaultValue, ...)
+See GetDenoiseEnableAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateDenoisePassRel()
+See GetDenoisePassRel() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateFileNameAttr(defaultValue, writeSparsely)
+See GetFileNameAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateInputPassesRel()
+See GetInputPassesRel() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreatePassTypeAttr(defaultValue, writeSparsely)
+See GetPassTypeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateRenderSourceRel()
+See GetRenderSourceRel() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Define
+classmethod Define(stage, path) -> Pass
+
+Get
+classmethod Get(stage, path) -> Pass
+
+GetCommandAttr()
+The command to run in order to generate renders for this pass.
+
+GetDenoiseEnableAttr()
+When True, this Pass pass should be denoised.
+
+GetDenoisePassRel()
+The The UsdRenderDenoisePass prim from which to source denoise settings.
+
+GetFileNameAttr()
+The asset that contains the rendering prims or other information needed to render this pass.
+
+GetInputPassesRel()
+The set of other Passes that this Pass depends on in order to be constructed properly.
+
+GetPassTypeAttr()
+A string used to categorize differently structured or executed types of passes within a customized pipeline.
+
+GetRenderSourceRel()
+The source prim to render from.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+CreateCommandAttr(defaultValue, writeSparsely) → Attribute
+See GetCommandAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateDenoiseEnableAttr(defaultValue, writeSparsely) → Attribute
+See GetDenoiseEnableAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateDenoisePassRel() → Relationship
+See GetDenoisePassRel() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+
+CreateFileNameAttr(defaultValue, writeSparsely) → Attribute
+See GetFileNameAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateInputPassesRel() → Relationship
+See GetInputPassesRel() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+
+CreatePassTypeAttr(defaultValue, writeSparsely) → Attribute
+See GetPassTypeAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateRenderSourceRel() → Relationship
+See GetRenderSourceRel() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+
+static Define()
+classmethod Define(stage, path) -> Pass
+Attempt to ensure a UsdPrim adhering to this schema at path is
+defined (according to UsdPrim::IsDefined() ) on this stage.
+If a prim adhering to this schema at path is already defined on
+this stage, return that prim. Otherwise author an SdfPrimSpec with
+specifier == SdfSpecifierDef and this schema’s prim type name for
+the prim at path at the current EditTarget. Author SdfPrimSpec s
+with specifier == SdfSpecifierDef and empty typeName at the
+current EditTarget for any nonexistent, or existing but not Defined
+ancestors.
+The given path must be an absolute prim path that does not contain
+any variant selections.
+If it is impossible to author any of the necessary PrimSpecs, (for
+example, in case path cannot map to the current UsdEditTarget ‘s
+namespace) issue an error and return an invalid UsdPrim.
+Note that this method may return a defined prim whose typeName does
+not specify this schema class, in case a stronger typeName opinion
+overrides the opinion at the current EditTarget.
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static Get()
+classmethod Get(stage, path) -> Pass
+Return a UsdRenderPass holding the prim adhering to this schema at
+path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdRenderPass(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetCommandAttr() �� Attribute
+The command to run in order to generate renders for this pass.
+The job submission code can use this to properly send tasks to the job
+scheduling software that will generate products.
+The command can contain variables that will be substituted
+appropriately during submission, as seen in the example below with
+{fileName}.
+For example: command[0] =”prman”command[1] =”-progress”command[2]
+=”-pixelvariance”command[3] =”-0.15”command[4] =”{fileName}”# the
+fileName property will be substituted
+Declaration
+uniform string[] command
+C++ Type
+VtArray<std::string>
+Usd Type
+SdfValueTypeNames->StringArray
+Variability
+SdfVariabilityUniform
+
+GetDenoiseEnableAttr() → Attribute
+When True, this Pass pass should be denoised.
+Declaration
+uniform bool denoise:enable = 0
+C++ Type
+bool
+Usd Type
+SdfValueTypeNames->Bool
+Variability
+SdfVariabilityUniform
+
+GetDenoisePassRel() → Relationship
+The The UsdRenderDenoisePass prim from which to source denoise
+settings.
+
+GetFileNameAttr() → Attribute
+The asset that contains the rendering prims or other information
+needed to render this pass.
+Declaration
+uniform asset fileName
+C++ Type
+SdfAssetPath
+Usd Type
+SdfValueTypeNames->Asset
+Variability
+SdfVariabilityUniform
+
+GetInputPassesRel() → Relationship
+The set of other Passes that this Pass depends on in order to be
+constructed properly.
+For example, a Pass A may generate a texture, which is then used as an
+input to Pass B.
+By default, usdRender makes some assumptions about the relationship
+between this prim and the prims listed in inputPasses. Namely, when
+per-frame tasks are generated from these pass prims, usdRender will
+assume a one-to-one relationship between tasks that share their frame
+number. Consider a pass named’composite’whose inputPasses targets a
+Pass prim named’beauty`.  By default, each frame for’composite’will
+depend on the same frame from’beauty’: beauty.1 ->composite.1 beauty.2
+->composite.2 etc
+The consumer of this RenderPass graph of inputs will need to resolve
+the transitive dependencies.
+
+GetPassTypeAttr() → Attribute
+A string used to categorize differently structured or executed types
+of passes within a customized pipeline.
+For example, when multiple DCC’s (e.g. Houdini, Katana, Nuke) each
+compute and contribute different Products to a final result, it may be
+clearest and most flexible to create a separate RenderPass for each.
+Declaration
+uniform token passType
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+Variability
+SdfVariabilityUniform
+
+GetRenderSourceRel() → Relationship
+The source prim to render from.
+If fileName is not present, the source is assumed to be a
+RenderSettings prim present in the current Usd stage. If fileName is
+present, the source should be found in the file there. This
+relationship might target a string attribute on this or another prim
+that identifies the appropriate object in the external container.
+For example, for a Usd-backed pass, this would point to a
+RenderSettings prim. Houdini passes would point to a Rop. Nuke passes
+would point to a write node.
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+class pxr.UsdRender.Product
+A UsdRenderProduct describes an image or other file-like artifact
+produced by a render. A RenderProduct combines one or more RenderVars
+into a file or interactive buffer. It also provides all the controls
+established in UsdRenderSettingsBase as optional overrides to whatever
+the owning UsdRenderSettings prim dictates.
+Specific renderers may support additional settings, such as a way to
+configure compression settings, filetype metadata, and so forth. Such
+settings can be encoded using renderer-specific API schemas applied to
+the product prim.
+For any described attribute Fallback Value or Allowed Values
+below that are text/tokens, the actual token is published and defined
+in UsdRenderTokens. So to set an attribute to the value”rightHanded”,
+use UsdRenderTokens->rightHanded as the value.
+Methods:
+
+CreateOrderedVarsRel()
+See GetOrderedVarsRel() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateProductNameAttr(defaultValue, ...)
+See GetProductNameAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateProductTypeAttr(defaultValue, ...)
+See GetProductTypeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Define
+classmethod Define(stage, path) -> Product
+
+Get
+classmethod Get(stage, path) -> Product
+
+GetOrderedVarsRel()
+Specifies the RenderVars that should be consumed and combined into the final product.
+
+GetProductNameAttr()
+Specifies the name that the output/display driver should give the product.
+
+GetProductTypeAttr()
+The type of output to produce.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+CreateOrderedVarsRel() → Relationship
+See GetOrderedVarsRel() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+
+CreateProductNameAttr(defaultValue, writeSparsely) → Attribute
+See GetProductNameAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateProductTypeAttr(defaultValue, writeSparsely) → Attribute
+See GetProductTypeAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Define()
+classmethod Define(stage, path) -> Product
+Attempt to ensure a UsdPrim adhering to this schema at path is
+defined (according to UsdPrim::IsDefined() ) on this stage.
+If a prim adhering to this schema at path is already defined on
+this stage, return that prim. Otherwise author an SdfPrimSpec with
+specifier == SdfSpecifierDef and this schema’s prim type name for
+the prim at path at the current EditTarget. Author SdfPrimSpec s
+with specifier == SdfSpecifierDef and empty typeName at the
+current EditTarget for any nonexistent, or existing but not Defined
+ancestors.
+The given path must be an absolute prim path that does not contain
+any variant selections.
+If it is impossible to author any of the necessary PrimSpecs, (for
+example, in case path cannot map to the current UsdEditTarget ‘s
+namespace) issue an error and return an invalid UsdPrim.
+Note that this method may return a defined prim whose typeName does
+not specify this schema class, in case a stronger typeName opinion
+overrides the opinion at the current EditTarget.
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static Get()
+classmethod Get(stage, path) -> Product
+Return a UsdRenderProduct holding the prim adhering to this schema at
+path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdRenderProduct(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetOrderedVarsRel() → Relationship
+Specifies the RenderVars that should be consumed and combined into the
+final product.
+If ordering is relevant to the output driver, then the ordering of
+targets in this relationship provides the order to use.
+
+GetProductNameAttr() → Attribute
+Specifies the name that the output/display driver should give the
+product.
+This is provided as-authored to the driver, whose responsibility it is
+to situate the product on a filesystem or other storage, in the
+desired location.
+Declaration
+token productName =""
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+
+GetProductTypeAttr() → Attribute
+The type of output to produce.
+The default,”raster”, indicates a 2D image.
+In the future, UsdRender may define additional product types.
+Declaration
+uniform token productType ="raster"
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+Variability
+SdfVariabilityUniform
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+class pxr.UsdRender.Settings
+A UsdRenderSettings prim specifies global settings for a render
+process, including an enumeration of the RenderProducts that should
+result, and the UsdGeomImageable purposes that should be rendered. How
+settings affect rendering
+For any described attribute Fallback Value or Allowed Values
+below that are text/tokens, the actual token is published and defined
+in UsdRenderTokens. So to set an attribute to the value”rightHanded”,
+use UsdRenderTokens->rightHanded as the value.
+Methods:
+
+CreateIncludedPurposesAttr(defaultValue, ...)
+See GetIncludedPurposesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateMaterialBindingPurposesAttr(...)
+See GetMaterialBindingPurposesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateProductsRel()
+See GetProductsRel() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateRenderingColorSpaceAttr(defaultValue, ...)
+See GetRenderingColorSpaceAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Define
+classmethod Define(stage, path) -> Settings
+
+Get
+classmethod Get(stage, path) -> Settings
+
+GetIncludedPurposesAttr()
+The list of UsdGeomImageable purpose values that should be included in the render.
+
+GetMaterialBindingPurposesAttr()
+Ordered list of material purposes to consider when resolving material bindings in the scene.
+
+GetProductsRel()
+The set of RenderProducts the render should produce.
+
+GetRenderingColorSpaceAttr()
+Describes a renderer's working (linear) colorSpace where all the renderer/shader math is expected to happen.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+GetStageRenderSettings
+classmethod GetStageRenderSettings(stage) -> Settings
+
+CreateIncludedPurposesAttr(defaultValue, writeSparsely) → Attribute
+See GetIncludedPurposesAttr() , and also Create vs Get Property
+Methods for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateMaterialBindingPurposesAttr(defaultValue, writeSparsely) → Attribute
+See GetMaterialBindingPurposesAttr() , and also Create vs Get Property
+Methods for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateProductsRel() → Relationship
+See GetProductsRel() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+
+CreateRenderingColorSpaceAttr(defaultValue, writeSparsely) → Attribute
+See GetRenderingColorSpaceAttr() , and also Create vs Get Property
+Methods for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Define()
+classmethod Define(stage, path) -> Settings
+Attempt to ensure a UsdPrim adhering to this schema at path is
+defined (according to UsdPrim::IsDefined() ) on this stage.
+If a prim adhering to this schema at path is already defined on
+this stage, return that prim. Otherwise author an SdfPrimSpec with
+specifier == SdfSpecifierDef and this schema’s prim type name for
+the prim at path at the current EditTarget. Author SdfPrimSpec s
+with specifier == SdfSpecifierDef and empty typeName at the
+current EditTarget for any nonexistent, or existing but not Defined
+ancestors.
+The given path must be an absolute prim path that does not contain
+any variant selections.
+If it is impossible to author any of the necessary PrimSpecs, (for
+example, in case path cannot map to the current UsdEditTarget ‘s
+namespace) issue an error and return an invalid UsdPrim.
+Note that this method may return a defined prim whose typeName does
+not specify this schema class, in case a stronger typeName opinion
+overrides the opinion at the current EditTarget.
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static Get()
+classmethod Get(stage, path) -> Settings
+Return a UsdRenderSettings holding the prim adhering to this schema at
+path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdRenderSettings(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetIncludedPurposesAttr() → Attribute
+The list of UsdGeomImageable purpose values that should be included
+in the render.
+Note this cannot be specified per-RenderProduct because it is a
+statement of which geometry is present.
+Declaration
+uniform token[] includedPurposes = ["default","render"]
+C++ Type
+VtArray<TfToken>
+Usd Type
+SdfValueTypeNames->TokenArray
+Variability
+SdfVariabilityUniform
+
+GetMaterialBindingPurposesAttr() → Attribute
+Ordered list of material purposes to consider when resolving material
+bindings in the scene.
+The empty string indicates the”allPurpose”binding.
+Declaration
+uniform token[] materialBindingPurposes = ["full",""]
+C++ Type
+VtArray<TfToken>
+Usd Type
+SdfValueTypeNames->TokenArray
+Variability
+SdfVariabilityUniform
+Allowed Values
+full, preview,””
+
+GetProductsRel() → Relationship
+The set of RenderProducts the render should produce.
+This relationship should target UsdRenderProduct prims. If no
+products are specified, an application should produce an rgb image
+according to the RenderSettings configuration, to a default display or
+image name.
+
+GetRenderingColorSpaceAttr() → Attribute
+Describes a renderer’s working (linear) colorSpace where all the
+renderer/shader math is expected to happen.
+When no renderingColorSpace is provided, renderer should use its own
+default.
+Declaration
+uniform token renderingColorSpace
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+Variability
+SdfVariabilityUniform
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+static GetStageRenderSettings()
+classmethod GetStageRenderSettings(stage) -> Settings
+Fetch and return stage ‘s render settings, as indicated by root
+layer metadata.
+If unauthored, or the metadata does not refer to a valid
+UsdRenderSettings prim, this will return an invalid UsdRenderSettings
+prim.
+
+Parameters
+stage (UsdStageWeak) – 
+
+class pxr.UsdRender.SettingsBase
+Abstract base class that defines render settings that can be specified
+on either a RenderSettings prim or a RenderProduct prim.
+For any described attribute Fallback Value or Allowed Values
+below that are text/tokens, the actual token is published and defined
+in UsdRenderTokens. So to set an attribute to the value”rightHanded”,
+use UsdRenderTokens->rightHanded as the value.
+Methods:
+
+CreateAspectRatioConformPolicyAttr(...)
+See GetAspectRatioConformPolicyAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateCameraRel()
+See GetCameraRel() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateDataWindowNDCAttr(defaultValue, ...)
+See GetDataWindowNDCAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateDisableMotionBlurAttr(defaultValue, ...)
+See GetDisableMotionBlurAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateInstantaneousShutterAttr(defaultValue, ...)
+See GetInstantaneousShutterAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreatePixelAspectRatioAttr(defaultValue, ...)
+See GetPixelAspectRatioAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateResolutionAttr(defaultValue, writeSparsely)
+See GetResolutionAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Get
+classmethod Get(stage, path) -> SettingsBase
+
+GetAspectRatioConformPolicyAttr()
+Indicates the policy to use to resolve an aspect ratio mismatch between the camera aperture and image settings.
+
+GetCameraRel()
+The camera relationship specifies the primary camera to use in a render.
+
+GetDataWindowNDCAttr()
+dataWindowNDC specifies the axis-aligned rectangular region in the adjusted aperture window within which the renderer should produce data.
+
+GetDisableMotionBlurAttr()
+Disable all motion blur by setting the shutter interval of the targeted camera to [0,0] - that is, take only one sample, namely at the current time code.
+
+GetInstantaneousShutterAttr()
+Deprecated - use disableMotionBlur instead.
+
+GetPixelAspectRatioAttr()
+The aspect ratio (width/height) of image pixels.
+
+GetResolutionAttr()
+The image pixel resolution, corresponding to the camera's screen window.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+CreateAspectRatioConformPolicyAttr(defaultValue, writeSparsely) → Attribute
+See GetAspectRatioConformPolicyAttr() , and also Create vs Get
+Property Methods for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateCameraRel() → Relationship
+See GetCameraRel() , and also Create vs Get Property Methods for when
+to use Get vs Create.
+
+CreateDataWindowNDCAttr(defaultValue, writeSparsely) → Attribute
+See GetDataWindowNDCAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateDisableMotionBlurAttr(defaultValue, writeSparsely) → Attribute
+See GetDisableMotionBlurAttr() , and also Create vs Get Property
+Methods for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateInstantaneousShutterAttr(defaultValue, writeSparsely) → Attribute
+See GetInstantaneousShutterAttr() , and also Create vs Get Property
+Methods for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreatePixelAspectRatioAttr(defaultValue, writeSparsely) → Attribute
+See GetPixelAspectRatioAttr() , and also Create vs Get Property
+Methods for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateResolutionAttr(defaultValue, writeSparsely) → Attribute
+See GetResolutionAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Get()
+classmethod Get(stage, path) -> SettingsBase
+Return a UsdRenderSettingsBase holding the prim adhering to this
+schema at path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdRenderSettingsBase(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetAspectRatioConformPolicyAttr() → Attribute
+Indicates the policy to use to resolve an aspect ratio mismatch
+between the camera aperture and image settings.
+This policy allows a standard render setting to do something
+reasonable given varying camera inputs.
+The camera aperture aspect ratio is determined by the aperture
+atributes on the UsdGeomCamera.
+The image aspect ratio is determined by the resolution and
+pixelAspectRatio attributes in the render settings.
+
+“expandAperture”: if necessary, expand the aperture to fit the
+image, exposing additional scene content
+“cropAperture”: if necessary, crop the aperture to fit the image,
+cropping scene content
+“adjustApertureWidth”: if necessary, adjust aperture width to
+make its aspect ratio match the image
+“adjustApertureHeight”: if necessary, adjust aperture height to
+make its aspect ratio match the image
+“adjustPixelAspectRatio”: compute pixelAspectRatio to make the
+image exactly cover the aperture; disregards existing attribute value
+of pixelAspectRatio
+
+Declaration
+uniform token aspectRatioConformPolicy ="expandAperture"
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+Variability
+SdfVariabilityUniform
+Allowed Values
+expandAperture, cropAperture, adjustApertureWidth,
+adjustApertureHeight, adjustPixelAspectRatio
+
+GetCameraRel() → Relationship
+The camera relationship specifies the primary camera to use in a
+render.
+It must target a UsdGeomCamera.
+
+GetDataWindowNDCAttr() → Attribute
+dataWindowNDC specifies the axis-aligned rectangular region in the
+adjusted aperture window within which the renderer should produce
+data.
+It is specified as (xmin, ymin, xmax, ymax) in normalized device
+coordinates, where the range 0 to 1 corresponds to the aperture. (0,0)
+corresponds to the bottom-left corner and (1,1) corresponds to the
+upper-right corner.
+Specifying a window outside the unit square will produce overscan
+data. Specifying a window that does not cover the unit square will
+produce a cropped render.
+A pixel is included in the rendered result if the pixel center is
+contained by the data window. This is consistent with standard rules
+used by polygon rasterization engines. UsdRenderRasterization
+The data window is expressed in NDC so that cropping and overscan may
+be resolution independent. In interactive workflows, incremental
+cropping and resolution adjustment may be intermixed to isolate and
+examine parts of the scene. In compositing workflows, overscan may be
+used to support image post-processing kernels, and reduced-resolution
+proxy renders may be used for faster iteration.
+The dataWindow:ndc coordinate system references the aperture after any
+adjustments required by aspectRatioConformPolicy.
+Declaration
+uniform float4 dataWindowNDC = (0, 0, 1, 1)
+C++ Type
+GfVec4f
+Usd Type
+SdfValueTypeNames->Float4
+Variability
+SdfVariabilityUniform
+
+GetDisableMotionBlurAttr() → Attribute
+Disable all motion blur by setting the shutter interval of the
+targeted camera to [0,0] - that is, take only one sample, namely at
+the current time code.
+Declaration
+uniform bool disableMotionBlur = 0
+C++ Type
+bool
+Usd Type
+SdfValueTypeNames->Bool
+Variability
+SdfVariabilityUniform
+
+GetInstantaneousShutterAttr() → Attribute
+Deprecated - use disableMotionBlur instead.
+Override the targeted camera ‘s shutterClose to be equal to the
+value of its shutterOpen, to produce a zero-width shutter interval.
+This gives us a convenient way to disable motion blur.
+Declaration
+uniform bool instantaneousShutter = 0
+C++ Type
+bool
+Usd Type
+SdfValueTypeNames->Bool
+Variability
+SdfVariabilityUniform
+
+GetPixelAspectRatioAttr() → Attribute
+The aspect ratio (width/height) of image pixels.
+The default ratio 1.0 indicates square pixels.
+Declaration
+uniform float pixelAspectRatio = 1
+C++ Type
+float
+Usd Type
+SdfValueTypeNames->Float
+Variability
+SdfVariabilityUniform
+
+GetResolutionAttr() → Attribute
+The image pixel resolution, corresponding to the camera’s screen
+window.
+Declaration
+uniform int2 resolution = (2048, 1080)
+C++ Type
+GfVec2i
+Usd Type
+SdfValueTypeNames->Int2
+Variability
+SdfVariabilityUniform
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+class pxr.UsdRender.Tokens
+Attributes:
+
+adjustApertureHeight
+
+adjustApertureWidth
+
+adjustPixelAspectRatio
+
+aspectRatioConformPolicy
+
+camera
+
+color3f
+
+command
+
+cropAperture
+
+dataType
+
+dataWindowNDC
+
+denoiseEnable
+
+denoisePass
+
+disableMotionBlur
+
+expandAperture
+
+fileName
+
+full
+
+includedPurposes
+
+inputPasses
+
+instantaneousShutter
+
+intrinsic
+
+lpe
+
+materialBindingPurposes
+
+orderedVars
+
+passType
+
+pixelAspectRatio
+
+preview
+
+primvar
+
+productName
+
+productType
+
+products
+
+raster
+
+raw
+
+renderSettingsPrimPath
+
+renderSource
+
+renderingColorSpace
+
+resolution
+
+sourceName
+
+sourceType
+
+adjustApertureHeight = 'adjustApertureHeight'
+
+adjustApertureWidth = 'adjustApertureWidth'
+
+adjustPixelAspectRatio = 'adjustPixelAspectRatio'
+
+aspectRatioConformPolicy = 'aspectRatioConformPolicy'
+
+camera = 'camera'
+
+color3f = 'color3f'
+
+command = 'command'
+
+cropAperture = 'cropAperture'
+
+dataType = 'dataType'
+
+dataWindowNDC = 'dataWindowNDC'
+
+denoiseEnable = 'denoise:enable'
+
+denoisePass = 'denoise:pass'
+
+disableMotionBlur = 'disableMotionBlur'
+
+expandAperture = 'expandAperture'
+
+fileName = 'fileName'
+
+full = 'full'
+
+includedPurposes = 'includedPurposes'
+
+inputPasses = 'inputPasses'
+
+instantaneousShutter = 'instantaneousShutter'
+
+intrinsic = 'intrinsic'
+
+lpe = 'lpe'
+
+materialBindingPurposes = 'materialBindingPurposes'
+
+orderedVars = 'orderedVars'
+
+passType = 'passType'
+
+pixelAspectRatio = 'pixelAspectRatio'
+
+preview = 'preview'
+
+primvar = 'primvar'
+
+productName = 'productName'
+
+productType = 'productType'
+
+products = 'products'
+
+raster = 'raster'
+
+raw = 'raw'
+
+renderSettingsPrimPath = 'renderSettingsPrimPath'
+
+renderSource = 'renderSource'
+
+renderingColorSpace = 'renderingColorSpace'
+
+resolution = 'resolution'
+
+sourceName = 'sourceName'
+
+sourceType = 'sourceType'
+
+class pxr.UsdRender.Var
+A UsdRenderVar describes a custom data variable for a render to
+produce. The prim describes the source of the data, which can be a
+shader output or an LPE (Light Path Expression), and also allows
+encoding of (generally renderer-specific) parameters that configure
+the renderer for computing the variable.
+The name of the RenderVar prim drives the name of the data variable
+that the renderer will produce.
+In the future, UsdRender may standardize RenderVar representation for
+well-known variables under the sourceType intrinsic , such as r,
+g, b, a, z, or id. For any described attribute Fallback
+Value or Allowed Values below that are text/tokens, the actual
+token is published and defined in UsdRenderTokens. So to set an
+attribute to the value”rightHanded”, use UsdRenderTokens->rightHanded
+as the value.
+Methods:
+
+CreateDataTypeAttr(defaultValue, writeSparsely)
+See GetDataTypeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateSourceNameAttr(defaultValue, writeSparsely)
+See GetSourceNameAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateSourceTypeAttr(defaultValue, writeSparsely)
+See GetSourceTypeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Define
+classmethod Define(stage, path) -> Var
+
+Get
+classmethod Get(stage, path) -> Var
+
+GetDataTypeAttr()
+The type of this channel, as a USD attribute type.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+GetSourceNameAttr()
+The renderer should look for an output of this name as the computed value for the RenderVar.
+
+GetSourceTypeAttr()
+Indicates the type of the source.
+
+CreateDataTypeAttr(defaultValue, writeSparsely) → Attribute
+See GetDataTypeAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateSourceNameAttr(defaultValue, writeSparsely) → Attribute
+See GetSourceNameAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateSourceTypeAttr(defaultValue, writeSparsely) → Attribute
+See GetSourceTypeAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Define()
+classmethod Define(stage, path) -> Var
+Attempt to ensure a UsdPrim adhering to this schema at path is
+defined (according to UsdPrim::IsDefined() ) on this stage.
+If a prim adhering to this schema at path is already defined on
+this stage, return that prim. Otherwise author an SdfPrimSpec with
+specifier == SdfSpecifierDef and this schema’s prim type name for
+the prim at path at the current EditTarget. Author SdfPrimSpec s
+with specifier == SdfSpecifierDef and empty typeName at the
+current EditTarget for any nonexistent, or existing but not Defined
+ancestors.
+The given path must be an absolute prim path that does not contain
+any variant selections.
+If it is impossible to author any of the necessary PrimSpecs, (for
+example, in case path cannot map to the current UsdEditTarget ‘s
+namespace) issue an error and return an invalid UsdPrim.
+Note that this method may return a defined prim whose typeName does
+not specify this schema class, in case a stronger typeName opinion
+overrides the opinion at the current EditTarget.
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static Get()
+classmethod Get(stage, path) -> Var
+Return a UsdRenderVar holding the prim adhering to this schema at
+path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdRenderVar(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetDataTypeAttr() → Attribute
+The type of this channel, as a USD attribute type.
+Declaration
+uniform token dataType ="color3f"
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+Variability
+SdfVariabilityUniform
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+GetSourceNameAttr() → Attribute
+The renderer should look for an output of this name as the computed
+value for the RenderVar.
+Declaration
+uniform string sourceName =""
+C++ Type
+std::string
+Usd Type
+SdfValueTypeNames->String
+Variability
+SdfVariabilityUniform
+
+GetSourceTypeAttr() → Attribute
+Indicates the type of the source.
+
+“raw”: The name should be passed directly to the renderer. This
+is the default behavior.
+“primvar”: This source represents the name of a primvar. Some
+renderers may use this to ensure that the primvar is provided; other
+renderers may require that a suitable material network be provided, in
+which case this is simply an advisory setting.
+“lpe”: Specifies a Light Path Expression in the OSL Light Path
+Expressions language as the source for this RenderVar. Some renderers
+may use extensions to that syntax, which will necessarily be non-
+portable.
+“intrinsic”: This setting is currently unimplemented, but
+represents a future namespace for UsdRender to provide portable
+baseline RenderVars, such as camera depth, that may have varying
+implementations for each renderer.
+
+Declaration
+uniform token sourceType ="raw"
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+Variability
+SdfVariabilityUniform
+Allowed Values
+raw, primvar, lpe, intrinsic
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

UsdRi.md

@@ -0,0 +1,974 @@
+
+
+UsdRi module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+UsdRi module
+
+ 
+
+# UsdRi module
+
+Summary: The UsdRi module provides schemas and utilities for authoring USD that encodes Renderman-specific information, and USD/RI data conversions.
+
+Classes:
+
+MaterialAPI
+Deprecated
+
+SplineAPI
+Deprecated
+
+StatementsAPI
+Container namespace schema for all renderman statements.
+
+TextureAPI
+Deprecated
+
+Tokens
+
+class pxr.UsdRi.MaterialAPI
+Deprecated
+Materials should use UsdShadeMaterial instead. This schema will be
+removed in a future release.
+This API provides outputs that connect a material prim to prman
+shaders and RIS objects.
+For any described attribute Fallback Value or Allowed Values
+below that are text/tokens, the actual token is published and defined
+in UsdRiTokens. So to set an attribute to the value”rightHanded”, use
+UsdRiTokens->rightHanded as the value.
+Methods:
+
+Apply
+classmethod Apply(prim) -> MaterialAPI
+
+CanApply
+classmethod CanApply(prim, whyNot) -> bool
+
+ComputeInterfaceInputConsumersMap(...)
+Walks the namespace subtree below the material and computes a map containing the list of all inputs on the material and the associated vector of consumers of their values.
+
+CreateDisplacementAttr(defaultValue, ...)
+See GetDisplacementAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateSurfaceAttr(defaultValue, writeSparsely)
+See GetSurfaceAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateVolumeAttr(defaultValue, writeSparsely)
+See GetVolumeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Get
+classmethod Get(stage, path) -> MaterialAPI
+
+GetDisplacement(ignoreBaseMaterial)
+Returns a valid shader object if the"displacement"output on the material is connected to one.
+
+GetDisplacementAttr()
+Declaration
+
+GetDisplacementOutput()
+Returns the"displacement"output associated with the material.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+GetSurface(ignoreBaseMaterial)
+Returns a valid shader object if the"surface"output on the material is connected to one.
+
+GetSurfaceAttr()
+Declaration
+
+GetSurfaceOutput()
+Returns the"surface"output associated with the material.
+
+GetVolume(ignoreBaseMaterial)
+Returns a valid shader object if the"volume"output on the material is connected to one.
+
+GetVolumeAttr()
+Declaration
+
+GetVolumeOutput()
+Returns the"volume"output associated with the material.
+
+SetDisplacementSource(displacementPath)
+
+param displacementPath
+
+SetSurfaceSource(surfacePath)
+
+param surfacePath
+
+SetVolumeSource(volumePath)
+
+param volumePath
+
+static Apply()
+classmethod Apply(prim) -> MaterialAPI
+Applies this single-apply API schema to the given prim .
+This information is stored by adding”RiMaterialAPI”to the token-
+valued, listOp metadata apiSchemas on the prim.
+A valid UsdRiMaterialAPI object is returned upon success. An invalid
+(or empty) UsdRiMaterialAPI object is returned upon failure. See
+UsdPrim::ApplyAPI() for conditions resulting in failure.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+prim (Prim) – 
+
+static CanApply()
+classmethod CanApply(prim, whyNot) -> bool
+Returns true if this single-apply API schema can be applied to the
+given prim .
+If this schema can not be a applied to the prim, this returns false
+and, if provided, populates whyNot with the reason it can not be
+applied.
+Note that if CanApply returns false, that does not necessarily imply
+that calling Apply will fail. Callers are expected to call CanApply
+before calling Apply if they want to ensure that it is valid to apply
+a schema.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+
+prim (Prim) – 
+whyNot (str) – 
+
+ComputeInterfaceInputConsumersMap(computeTransitiveConsumers) → NodeGraph.InterfaceInputConsumersMap
+Walks the namespace subtree below the material and computes a map
+containing the list of all inputs on the material and the associated
+vector of consumers of their values.
+The consumers can be inputs on shaders within the material or on node-
+graphs under it.
+
+Parameters
+computeTransitiveConsumers (bool) – 
+
+CreateDisplacementAttr(defaultValue, writeSparsely) → Attribute
+See GetDisplacementAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateSurfaceAttr(defaultValue, writeSparsely) → Attribute
+See GetSurfaceAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateVolumeAttr(defaultValue, writeSparsely) → Attribute
+See GetVolumeAttr() , and also Create vs Get Property Methods for when
+to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Get()
+classmethod Get(stage, path) -> MaterialAPI
+Return a UsdRiMaterialAPI holding the prim adhering to this schema at
+path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdRiMaterialAPI(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetDisplacement(ignoreBaseMaterial) → Shader
+Returns a valid shader object if the”displacement”output on the
+material is connected to one.
+If ignoreBaseMaterial is true and if the”displacement”shader
+source is specified in the base-material of this material, then this
+returns an invalid shader object.
+
+Parameters
+ignoreBaseMaterial (bool) – 
+
+GetDisplacementAttr() → Attribute
+Declaration
+token outputs:ri:displacement
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+
+GetDisplacementOutput() → Output
+Returns the”displacement”output associated with the material.
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+GetSurface(ignoreBaseMaterial) → Shader
+Returns a valid shader object if the”surface”output on the material is
+connected to one.
+If ignoreBaseMaterial is true and if the”surface”shader source is
+specified in the base-material of this material, then this returns an
+invalid shader object.
+
+Parameters
+ignoreBaseMaterial (bool) – 
+
+GetSurfaceAttr() → Attribute
+Declaration
+token outputs:ri:surface
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+
+GetSurfaceOutput() → Output
+Returns the”surface”output associated with the material.
+
+GetVolume(ignoreBaseMaterial) → Shader
+Returns a valid shader object if the”volume”output on the material is
+connected to one.
+If ignoreBaseMaterial is true and if the”volume”shader source is
+specified in the base-material of this material, then this returns an
+invalid shader object.
+
+Parameters
+ignoreBaseMaterial (bool) – 
+
+GetVolumeAttr() → Attribute
+Declaration
+token outputs:ri:volume
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+
+GetVolumeOutput() → Output
+Returns the”volume”output associated with the material.
+
+SetDisplacementSource(displacementPath) → bool
+
+Parameters
+displacementPath (Path) – 
+
+SetSurfaceSource(surfacePath) → bool
+
+Parameters
+surfacePath (Path) – 
+
+SetVolumeSource(volumePath) → bool
+
+Parameters
+volumePath (Path) – 
+
+class pxr.UsdRi.SplineAPI
+Deprecated
+This API schema will be removed in a future release.
+RiSplineAPI is a general purpose API schema used to describe a named
+spline stored as a set of attributes on a prim.
+It is an add-on schema that can be applied many times to a prim with
+different spline names. All the attributes authored by the schema are
+namespaced under”$NAME:spline:”, with the name of the spline providing
+a namespace for the attributes.
+The spline describes a 2D piecewise cubic curve with a position and
+value for each knot. This is chosen to give straightforward artistic
+control over the shape. The supported basis types are:
+
+linear (UsdRiTokens->linear)
+bspline (UsdRiTokens->bspline)
+Catmull-Rom (UsdRiTokens->catmullRom)
+
+Methods:
+
+Apply
+classmethod Apply(prim) -> SplineAPI
+
+CanApply
+classmethod CanApply(prim, whyNot) -> bool
+
+CreateInterpolationAttr(defaultValue, ...)
+See GetInterpolationAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreatePositionsAttr(defaultValue, writeSparsely)
+See GetPositionsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateValuesAttr(defaultValue, writeSparsely)
+See GetValuesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Get
+classmethod Get(stage, path) -> SplineAPI
+
+GetInterpolationAttr()
+Interpolation method for the spline.
+
+GetPositionsAttr()
+Positions of the knots.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+GetValuesAttr()
+Values of the knots.
+
+GetValuesTypeName()
+Returns the intended typename of the values attribute of the spline.
+
+Validate(reason)
+Validates the attribute values belonging to the spline.
+
+static Apply()
+classmethod Apply(prim) -> SplineAPI
+Applies this single-apply API schema to the given prim .
+This information is stored by adding”RiSplineAPI”to the token-valued,
+listOp metadata apiSchemas on the prim.
+A valid UsdRiSplineAPI object is returned upon success. An invalid (or
+empty) UsdRiSplineAPI object is returned upon failure. See
+UsdPrim::ApplyAPI() for conditions resulting in failure.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+prim (Prim) – 
+
+static CanApply()
+classmethod CanApply(prim, whyNot) -> bool
+Returns true if this single-apply API schema can be applied to the
+given prim .
+If this schema can not be a applied to the prim, this returns false
+and, if provided, populates whyNot with the reason it can not be
+applied.
+Note that if CanApply returns false, that does not necessarily imply
+that calling Apply will fail. Callers are expected to call CanApply
+before calling Apply if they want to ensure that it is valid to apply
+a schema.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+
+prim (Prim) – 
+whyNot (str) – 
+
+CreateInterpolationAttr(defaultValue, writeSparsely) → Attribute
+See GetInterpolationAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreatePositionsAttr(defaultValue, writeSparsely) → Attribute
+See GetPositionsAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateValuesAttr(defaultValue, writeSparsely) → Attribute
+See GetValuesAttr() , and also Create vs Get Property Methods for when
+to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Get()
+classmethod Get(stage, path) -> SplineAPI
+Return a UsdRiSplineAPI holding the prim adhering to this schema at
+path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdRiSplineAPI(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetInterpolationAttr() → Attribute
+Interpolation method for the spline.
+C++ Type: TfToken  Usd Type: SdfValueTypeNames->Token  Variability:
+SdfVariabilityUniform  Fallback Value: linear  Allowed Values :
+[linear, constant, bspline, catmullRom]
+
+GetPositionsAttr() → Attribute
+Positions of the knots.
+C++ Type: VtArray<float>  Usd Type: SdfValueTypeNames->FloatArray
+Variability: SdfVariabilityUniform  Fallback Value: No Fallback
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+GetValuesAttr() → Attribute
+Values of the knots.
+C++ Type: See GetValuesTypeName()  Usd Type: See GetValuesTypeName()
+Variability: SdfVariabilityUniform  Fallback Value: No Fallback
+
+GetValuesTypeName() → ValueTypeName
+Returns the intended typename of the values attribute of the spline.
+
+Validate(reason) → bool
+Validates the attribute values belonging to the spline.
+Returns true if the spline has all valid attribute values. Returns
+false and populates the reason output argument if the spline has
+invalid attribute values.
+Here’s the list of validations performed by this method:
+
+the SplineAPI must be fully initialized
+interpolation attribute must exist and use an allowed value
+the positions array must be a float array
+the positions array must be sorted by increasing value
+the values array must use the correct value type
+the positions and values array must have the same size
+
+Parameters
+reason (str) – 
+
+class pxr.UsdRi.StatementsAPI
+Container namespace schema for all renderman statements.
+The longer term goal is for clients to go directly to primvar or
+render-attribute API’s, instead of using UsdRi StatementsAPI for
+inherited attributes. Anticpating this, StatementsAPI can smooth the
+way via a few environment variables:
+
+USDRI_STATEMENTS_READ_OLD_ENCODING: Causes StatementsAPI to read
+old-style attributes instead of primvars in the”ri:”namespace.
+
+Methods:
+
+Apply
+classmethod Apply(prim) -> StatementsAPI
+
+CanApply
+classmethod CanApply(prim, whyNot) -> bool
+
+CreateRiAttribute(name, riType, nameSpace)
+Create a rib attribute on the prim to which this schema is attached.
+
+Get
+classmethod Get(stage, path) -> StatementsAPI
+
+GetCoordinateSystem()
+Returns the value in the"ri:coordinateSystem"attribute if it exists.
+
+GetModelCoordinateSystems(targets)
+Populates the output targets with the authored ri:modelCoordinateSystems, if any.
+
+GetModelScopedCoordinateSystems(targets)
+Populates the output targets with the authored ri:modelScopedCoordinateSystems, if any.
+
+GetRiAttribute(name, nameSpace)
+Return a UsdAttribute representing the Ri attribute with the name name, in the namespace nameSpace.
+
+GetRiAttributeName
+classmethod GetRiAttributeName(prop) -> str
+
+GetRiAttributeNameSpace
+classmethod GetRiAttributeNameSpace(prop) -> str
+
+GetRiAttributes(nameSpace)
+Return all rib attributes on this prim, or under a specific namespace (e.g."user").
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+GetScopedCoordinateSystem()
+Returns the value in the"ri:scopedCoordinateSystem"attribute if it exists.
+
+HasCoordinateSystem()
+Returns true if the underlying prim has a ri:coordinateSystem opinion.
+
+HasScopedCoordinateSystem()
+Returns true if the underlying prim has a ri:scopedCoordinateSystem opinion.
+
+IsRiAttribute
+classmethod IsRiAttribute(prop) -> bool
+
+MakeRiAttributePropertyName
+classmethod MakeRiAttributePropertyName(attrName) -> str
+
+SetCoordinateSystem(coordSysName)
+Sets the"ri:coordinateSystem"attribute to the given string value, creating the attribute if needed.
+
+SetScopedCoordinateSystem(coordSysName)
+Sets the"ri:scopedCoordinateSystem"attribute to the given string value, creating the attribute if needed.
+
+static Apply()
+classmethod Apply(prim) -> StatementsAPI
+Applies this single-apply API schema to the given prim .
+This information is stored by adding”StatementsAPI”to the token-
+valued, listOp metadata apiSchemas on the prim.
+A valid UsdRiStatementsAPI object is returned upon success. An invalid
+(or empty) UsdRiStatementsAPI object is returned upon failure. See
+UsdPrim::ApplyAPI() for conditions resulting in failure.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+prim (Prim) – 
+
+static CanApply()
+classmethod CanApply(prim, whyNot) -> bool
+Returns true if this single-apply API schema can be applied to the
+given prim .
+If this schema can not be a applied to the prim, this returns false
+and, if provided, populates whyNot with the reason it can not be
+applied.
+Note that if CanApply returns false, that does not necessarily imply
+that calling Apply will fail. Callers are expected to call CanApply
+before calling Apply if they want to ensure that it is valid to apply
+a schema.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+
+prim (Prim) – 
+whyNot (str) – 
+
+CreateRiAttribute(name, riType, nameSpace) → Attribute
+Create a rib attribute on the prim to which this schema is attached.
+A rib attribute consists of an attribute “nameSpace” and an
+attribute “name”. For example, the namespace”cull”may define
+attributes”backfacing”and”hidden”, and user-defined attributes belong
+to the namespace”user”.
+This method makes no attempt to validate that the given nameSpace
+and name are actually meaningful to prman or any other renderer.
+riType
+should be a known RenderMan type definition, which can be array-
+valued. For instance, both”color”and”float[3]”are valid values for
+riType .
+
+Parameters
+
+name (str) – 
+riType (str) – 
+nameSpace (str) – 
+
+CreateRiAttribute(name, tfType, nameSpace) -> Attribute
+Creates an attribute of the given tfType .
+This is an overloaded member function, provided for convenience. It
+differs from the above function only in what argument(s) it accepts.
+
+Parameters
+
+name (str) – 
+tfType (Type) – 
+nameSpace (str) – 
+
+static Get()
+classmethod Get(stage, path) -> StatementsAPI
+Return a UsdRiStatementsAPI holding the prim adhering to this schema
+at path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdRiStatementsAPI(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetCoordinateSystem() → str
+Returns the value in the”ri:coordinateSystem”attribute if it exists.
+
+GetModelCoordinateSystems(targets) → bool
+Populates the output targets with the authored
+ri:modelCoordinateSystems, if any.
+Returns true if the query was successful.
+
+Parameters
+targets (list[SdfPath]) – 
+
+GetModelScopedCoordinateSystems(targets) → bool
+Populates the output targets with the authored
+ri:modelScopedCoordinateSystems, if any.
+Returns true if the query was successful.
+
+Parameters
+targets (list[SdfPath]) – 
+
+GetRiAttribute(name, nameSpace) → Attribute
+Return a UsdAttribute representing the Ri attribute with the name
+name, in the namespace nameSpace.
+The attribute returned may or may not actually exist so it must be
+checked for validity.
+
+Parameters
+
+name (str) – 
+nameSpace (str) – 
+
+static GetRiAttributeName()
+classmethod GetRiAttributeName(prop) -> str
+Return the base, most-specific name of the rib attribute.
+For example, the name of the rib
+attribute”cull:backfacing”is”backfacing”
+
+Parameters
+prop (Property) – 
+
+static GetRiAttributeNameSpace()
+classmethod GetRiAttributeNameSpace(prop) -> str
+Return the containing namespace of the rib attribute (e.g.”user”).
+
+Parameters
+prop (Property) – 
+
+GetRiAttributes(nameSpace) → list[Property]
+Return all rib attributes on this prim, or under a specific namespace
+(e.g.”user”).
+As noted above, rib attributes can be either UsdAttribute or
+UsdRelationship, and like all UsdProperties, need not have a defined
+value.
+
+Parameters
+nameSpace (str) – 
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+GetScopedCoordinateSystem() → str
+Returns the value in the”ri:scopedCoordinateSystem”attribute if it
+exists.
+
+HasCoordinateSystem() → bool
+Returns true if the underlying prim has a ri:coordinateSystem opinion.
+
+HasScopedCoordinateSystem() → bool
+Returns true if the underlying prim has a ri:scopedCoordinateSystem
+opinion.
+
+static IsRiAttribute()
+classmethod IsRiAttribute(prop) -> bool
+Return true if the property is in the”ri:attributes”namespace.
+
+Parameters
+prop (Property) – 
+
+static MakeRiAttributePropertyName()
+classmethod MakeRiAttributePropertyName(attrName) -> str
+Returns the given attrName prefixed with the full Ri attribute
+namespace, creating a name suitable for an RiAttribute UsdProperty.
+This handles conversion of common separator characters used in other
+packages, such as periods and underscores.
+Will return empty string if attrName is not a valid property
+identifier; otherwise, will return a valid property name that
+identifies the property as an RiAttribute, according to the following
+rules:
+
+If attrName is already a properly constructed RiAttribute
+property name, return it unchanged.
+If attrName contains two or more tokens separated by a
+colon, consider the first to be the namespace, and the rest the
+name, joined by underscores
+If attrName contains two or more tokens separated by a
+period, consider the first to be the namespace, and the rest the
+name, joined by underscores
+If attrName contains two or more tokens separated by an,
+underscore consider the first to be the namespace, and the rest the
+name, joined by underscores
+else, assume attrName is the name, and”user”is the namespace
+
+Parameters
+attrName (str) – 
+
+SetCoordinateSystem(coordSysName) → None
+Sets the”ri:coordinateSystem”attribute to the given string value,
+creating the attribute if needed.
+That identifies this prim as providing a coordinate system, which can
+be retrieved via UsdGeomXformable::GetTransformAttr(). Also adds the
+owning prim to the ri:modelCoordinateSystems relationship targets on
+its parent leaf model prim, if it exists. If this prim is not under a
+leaf model, no relationship targets will be authored.
+
+Parameters
+coordSysName (str) – 
+
+SetScopedCoordinateSystem(coordSysName) → None
+Sets the”ri:scopedCoordinateSystem”attribute to the given string
+value, creating the attribute if needed.
+That identifies this prim as providing a coordinate system, which can
+be retrieved via UsdGeomXformable::GetTransformAttr(). Such coordinate
+systems are local to the RI attribute stack state, but does get
+updated properly for instances when defined inside an object master.
+Also adds the owning prim to the ri:modelScopedCoordinateSystems
+relationship targets on its parent leaf model prim, if it exists. If
+this prim is not under a leaf model, no relationship targets will be
+authored.
+
+Parameters
+coordSysName (str) – 
+
+class pxr.UsdRi.TextureAPI
+Deprecated
+This API schema will be removed in a future release.
+RiTextureAPI is an API schema that provides an interface to add
+Renderman-specific attributes to adjust textures.
+Methods:
+
+Apply
+classmethod Apply(prim) -> TextureAPI
+
+CanApply
+classmethod CanApply(prim, whyNot) -> bool
+
+CreateRiTextureGammaAttr(defaultValue, ...)
+See GetRiTextureGammaAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateRiTextureSaturationAttr(defaultValue, ...)
+See GetRiTextureSaturationAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Get
+classmethod Get(stage, path) -> TextureAPI
+
+GetRiTextureGammaAttr()
+Gamma-correct the texture.
+
+GetRiTextureSaturationAttr()
+Adjust the texture's saturation.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+static Apply()
+classmethod Apply(prim) -> TextureAPI
+Applies this single-apply API schema to the given prim .
+This information is stored by adding”RiTextureAPI”to the token-valued,
+listOp metadata apiSchemas on the prim.
+A valid UsdRiTextureAPI object is returned upon success. An invalid
+(or empty) UsdRiTextureAPI object is returned upon failure. See
+UsdPrim::ApplyAPI() for conditions resulting in failure.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+prim (Prim) – 
+
+static CanApply()
+classmethod CanApply(prim, whyNot) -> bool
+Returns true if this single-apply API schema can be applied to the
+given prim .
+If this schema can not be a applied to the prim, this returns false
+and, if provided, populates whyNot with the reason it can not be
+applied.
+Note that if CanApply returns false, that does not necessarily imply
+that calling Apply will fail. Callers are expected to call CanApply
+before calling Apply if they want to ensure that it is valid to apply
+a schema.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+
+prim (Prim) – 
+whyNot (str) – 
+
+CreateRiTextureGammaAttr(defaultValue, writeSparsely) → Attribute
+See GetRiTextureGammaAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateRiTextureSaturationAttr(defaultValue, writeSparsely) → Attribute
+See GetRiTextureSaturationAttr() , and also Create vs Get Property
+Methods for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Get()
+classmethod Get(stage, path) -> TextureAPI
+Return a UsdRiTextureAPI holding the prim adhering to this schema at
+path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdRiTextureAPI(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetRiTextureGammaAttr() → Attribute
+Gamma-correct the texture.
+Declaration
+float ri:texture:gamma
+C++ Type
+float
+Usd Type
+SdfValueTypeNames->Float
+
+GetRiTextureSaturationAttr() → Attribute
+Adjust the texture’s saturation.
+Declaration
+float ri:texture:saturation
+C++ Type
+float
+Usd Type
+SdfValueTypeNames->Float
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+class pxr.UsdRi.Tokens
+Attributes:
+
+bspline
+
+catmullRom
+
+constant
+
+interpolation
+
+linear
+
+outputsRiDisplacement
+
+outputsRiSurface
+
+outputsRiVolume
+
+positions
+
+renderContext
+
+riTextureGamma
+
+riTextureSaturation
+
+spline
+
+values
+
+bspline = 'bspline'
+
+catmullRom = 'catmull-rom'
+
+constant = 'constant'
+
+interpolation = 'interpolation'
+
+linear = 'linear'
+
+outputsRiDisplacement = 'outputs:ri:displacement'
+
+outputsRiSurface = 'outputs:ri:surface'
+
+outputsRiVolume = 'outputs:ri:volume'
+
+positions = 'positions'
+
+renderContext = 'ri'
+
+riTextureGamma = 'ri:texture:gamma'
+
+riTextureSaturation = 'ri:texture:saturation'
+
+spline = 'spline'
+
+values = 'values'
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

UsdSkel.md

@@ -0,0 +1,2480 @@
+
+
+UsdSkel module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+UsdSkel module
+
+ 
+
+# UsdSkel module
+
+Summary: The UsdSkel module defines schemas and API that form a basis for interchanging skeletally-skinned meshes and joint animations.
+
+Classes:
+
+AnimMapper
+
+AnimQuery
+Class providing efficient queries of primitives that provide skel animation.
+
+Animation
+Describes a skel animation, where joint animation is stored in a vectorized form.
+
+Binding
+Helper object that describes the binding of a skeleton to a set of skinnable objects.
+
+BindingAPI
+Provides API for authoring and extracting all the skinning-related data that lives in the"geometry hierarchy"of prims and models that want to be skeletally deformed.
+
+BlendShape
+Describes a target blend shape, possibly containing inbetween shapes.
+
+BlendShapeQuery
+Helper class used to resolve blend shape weights, including inbetweens.
+
+Cache
+Thread-safe cache for accessing query objects for evaluating skeletal data.
+
+InbetweenShape
+Schema wrapper for UsdAttribute for authoring and introspecting attributes that serve as inbetween shapes of a UsdSkelBlendShape.
+
+PackedJointAnimation
+Deprecated.
+
+Root
+Boundable prim type used to identify a scope beneath which skeletally- posed primitives are defined.
+
+Skeleton
+Describes a skeleton.
+
+SkeletonQuery
+Primary interface to reading bound skeleton data.
+
+SkinningQuery
+Object used for querying resolved bindings for skinning.
+
+Tokens
+
+Topology
+Object holding information describing skeleton topology.
+
+class pxr.UsdSkel.AnimMapper
+Methods:
+
+IsIdentity()
+Returns true if this is an identity map.
+
+IsNull()
+Returns true if this is a null mapping.
+
+IsSparse()
+Returns true if this is a sparse mapping.
+
+Remap(source, target, elementSize, defaultValue)
+Typed remapping of data in an arbitrary, stl-like container.
+
+RemapTransforms(source, target, elementSize)
+Convenience method for the common task of remapping transform arrays.
+
+IsIdentity() → bool
+Returns true if this is an identity map.
+The source and target orders of an identity map are identical.
+
+IsNull() → bool
+Returns true if this is a null mapping.
+No source elements of a null map are mapped to the target.
+
+IsSparse() → bool
+Returns true if this is a sparse mapping.
+A sparse mapping means that not all target values will be overridden
+by source values, when mapped with Remap().
+
+Remap(source, target, elementSize, defaultValue) → bool
+Typed remapping of data in an arbitrary, stl-like container.
+The source array provides a run of elementSize for each path
+in the em sourceOrder. These elements are remapped and copied over
+the target array. Prior to remapping, the target array is
+resized to the size of the em targetOrder (as given at mapper
+construction time) multiplied by the elementSize . New element
+created in the array are initialized to defaultValue , if
+provided.
+
+Parameters
+
+source (Container) – 
+target (Container) – 
+elementSize (int) – 
+defaultValue (Container.value_type) – 
+
+Remap(source, target, elementSize, defaultValue) -> bool
+Type-erased remapping of data from source into target .
+The source array provides a run of elementSize elements for
+each path in the em sourceOrder. These elements are remapped and
+copied over the target array. Prior to remapping, the target
+array is resized to the size of the em targetOrder (as given at
+mapper construction time) multiplied by the elementSize . New
+elements created in the array are initialized to defaultValue , if
+provided. Remapping is supported for registered Sdf array value types
+only.
+
+Parameters
+
+source (VtValue) – 
+target (VtValue) – 
+elementSize (int) – 
+defaultValue (VtValue) – 
+
+RemapTransforms(source, target, elementSize) → bool
+Convenience method for the common task of remapping transform arrays.
+This performs the same operation as Remap(), but sets the matrix
+identity as the default value.
+
+Parameters
+
+source (VtArray[Matrix4]) – 
+target (VtArray[Matrix4]) – 
+elementSize (int) – 
+
+class pxr.UsdSkel.AnimQuery
+Class providing efficient queries of primitives that provide skel
+animation.
+Methods:
+
+BlendShapeWeightsMightBeTimeVarying()
+Return true if it possible, but not certain, that the blend shape weights computed through this animation query change over time, false otherwise.
+
+ComputeBlendShapeWeights(weights, time)
+
+param weights
+
+ComputeJointLocalTransformComponents(...)
+Compute translation,rotation,scale components of the joint transforms in joint-local space.
+
+ComputeJointLocalTransforms(xforms, time)
+Compute joint transforms in joint-local space.
+
+GetBlendShapeOrder()
+Returns an array of tokens describing the ordering of blend shape channels in the animation.
+
+GetBlendShapeWeightTimeSamples(attrs)
+Get the time samples at which values contributing to blend shape weights have been set.
+
+GetBlendShapeWeightTimeSamplesInInterval(...)
+Get the time samples at which values contributing to blend shape weights are set, over interval .
+
+GetJointOrder()
+Returns an array of tokens describing the ordering of joints in the animation.
+
+GetJointTransformTimeSamples(times)
+Get the time samples at which values contributing to joint transforms are set.
+
+GetJointTransformTimeSamplesInInterval(...)
+Get the time samples at which values contributing to joint transforms are set, over interval .
+
+GetPrim()
+Return the primitive this anim query reads from.
+
+JointTransformsMightBeTimeVarying()
+Return true if it possible, but not certain, that joint transforms computed through this animation query change over time, false otherwise.
+
+BlendShapeWeightsMightBeTimeVarying() → bool
+Return true if it possible, but not certain, that the blend shape
+weights computed through this animation query change over time, false
+otherwise.
+UsdAttribute::ValueMightBeTimeVayring
+
+ComputeBlendShapeWeights(weights, time) → bool
+
+Parameters
+
+weights (FloatArray) – 
+time (TimeCode) – 
+
+ComputeJointLocalTransformComponents(translations, rotations, scales, time) → bool
+Compute translation,rotation,scale components of the joint transforms
+in joint-local space.
+This is provided to facilitate direct streaming of animation data in a
+form that can efficiently be processed for animation blending.
+
+Parameters
+
+translations (Vec3fArray) – 
+rotations (QuatfArray) – 
+scales (Vec3hArray) – 
+time (TimeCode) – 
+
+ComputeJointLocalTransforms(xforms, time) → bool
+Compute joint transforms in joint-local space.
+Transforms are returned in the order specified by the joint ordering
+of the animation primitive itself.
+
+Parameters
+
+xforms (VtArray[Matrix4]) – 
+time (TimeCode) – 
+
+GetBlendShapeOrder() → TokenArray
+Returns an array of tokens describing the ordering of blend shape
+channels in the animation.
+
+GetBlendShapeWeightTimeSamples(attrs) → bool
+Get the time samples at which values contributing to blend shape
+weights have been set.
+UsdAttribute::GetTimeSamples
+
+Parameters
+attrs (list[float]) – 
+
+GetBlendShapeWeightTimeSamplesInInterval(interval, times) → bool
+Get the time samples at which values contributing to blend shape
+weights are set, over interval .
+UsdAttribute::GetTimeSamplesInInterval
+
+Parameters
+
+interval (Interval) – 
+times (list[float]) – 
+
+GetJointOrder() → TokenArray
+Returns an array of tokens describing the ordering of joints in the
+animation.
+UsdSkelSkeleton::GetJointOrder
+
+GetJointTransformTimeSamples(times) → bool
+Get the time samples at which values contributing to joint transforms
+are set.
+This only computes the time samples for sampling transforms in joint-
+local space, and does not include time samples affecting the root
+transformation.
+UsdAttribute::GetTimeSamples
+
+Parameters
+times (list[float]) – 
+
+GetJointTransformTimeSamplesInInterval(interval, times) → bool
+Get the time samples at which values contributing to joint transforms
+are set, over interval .
+This only computes the time samples for sampling transforms in joint-
+local space, and does not include time samples affecting the root
+transformation.
+UsdAttribute::GetTimeSamplesInInterval
+
+Parameters
+
+interval (Interval) – 
+times (list[float]) – 
+
+GetPrim() → Prim
+Return the primitive this anim query reads from.
+
+JointTransformsMightBeTimeVarying() → bool
+Return true if it possible, but not certain, that joint transforms
+computed through this animation query change over time, false
+otherwise.
+UsdAttribute::ValueMightBeTimeVayring
+
+class pxr.UsdSkel.Animation
+Describes a skel animation, where joint animation is stored in a
+vectorized form.
+See the extended Skel Animation documentation for more information.
+Methods:
+
+CreateBlendShapeWeightsAttr(defaultValue, ...)
+See GetBlendShapeWeightsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateBlendShapesAttr(defaultValue, ...)
+See GetBlendShapesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateJointsAttr(defaultValue, writeSparsely)
+See GetJointsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateRotationsAttr(defaultValue, writeSparsely)
+See GetRotationsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateScalesAttr(defaultValue, writeSparsely)
+See GetScalesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateTranslationsAttr(defaultValue, ...)
+See GetTranslationsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Define
+classmethod Define(stage, path) -> Animation
+
+Get
+classmethod Get(stage, path) -> Animation
+
+GetBlendShapeWeightsAttr()
+Array of weight values for each blend shape.
+
+GetBlendShapesAttr()
+Array of tokens identifying which blend shapes this animation's data applies to.
+
+GetJointsAttr()
+Array of tokens identifying which joints this animation's data applies to.
+
+GetRotationsAttr()
+Joint-local unit quaternion rotations of all affected joints, in 32-bit precision.
+
+GetScalesAttr()
+Joint-local scales of all affected joints, in 16 bit precision.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+GetTransforms(xforms, time)
+Convenience method for querying resolved transforms at time .
+
+GetTranslationsAttr()
+Joint-local translations of all affected joints.
+
+SetTransforms(xforms, time)
+Convenience method for setting an array of transforms.
+
+CreateBlendShapeWeightsAttr(defaultValue, writeSparsely) → Attribute
+See GetBlendShapeWeightsAttr() , and also Create vs Get Property
+Methods for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateBlendShapesAttr(defaultValue, writeSparsely) → Attribute
+See GetBlendShapesAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateJointsAttr(defaultValue, writeSparsely) → Attribute
+See GetJointsAttr() , and also Create vs Get Property Methods for when
+to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateRotationsAttr(defaultValue, writeSparsely) → Attribute
+See GetRotationsAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateScalesAttr(defaultValue, writeSparsely) → Attribute
+See GetScalesAttr() , and also Create vs Get Property Methods for when
+to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateTranslationsAttr(defaultValue, writeSparsely) → Attribute
+See GetTranslationsAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Define()
+classmethod Define(stage, path) -> Animation
+Attempt to ensure a UsdPrim adhering to this schema at path is
+defined (according to UsdPrim::IsDefined() ) on this stage.
+If a prim adhering to this schema at path is already defined on
+this stage, return that prim. Otherwise author an SdfPrimSpec with
+specifier == SdfSpecifierDef and this schema’s prim type name for
+the prim at path at the current EditTarget. Author SdfPrimSpec s
+with specifier == SdfSpecifierDef and empty typeName at the
+current EditTarget for any nonexistent, or existing but not Defined
+ancestors.
+The given path must be an absolute prim path that does not contain
+any variant selections.
+If it is impossible to author any of the necessary PrimSpecs, (for
+example, in case path cannot map to the current UsdEditTarget ‘s
+namespace) issue an error and return an invalid UsdPrim.
+Note that this method may return a defined prim whose typeName does
+not specify this schema class, in case a stronger typeName opinion
+overrides the opinion at the current EditTarget.
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static Get()
+classmethod Get(stage, path) -> Animation
+Return a UsdSkelAnimation holding the prim adhering to this schema at
+path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdSkelAnimation(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetBlendShapeWeightsAttr() → Attribute
+Array of weight values for each blend shape.
+Each weight value is associated with the corresponding blend shape
+identified within the blendShapes token array, and therefore must
+have the same length as *blendShapes.
+Declaration
+float[] blendShapeWeights
+C++ Type
+VtArray<float>
+Usd Type
+SdfValueTypeNames->FloatArray
+
+GetBlendShapesAttr() → Attribute
+Array of tokens identifying which blend shapes this animation’s data
+applies to.
+The tokens for blendShapes correspond to the tokens set in the
+skel:blendShapes binding property of the UsdSkelBindingAPI.
+Declaration
+uniform token[] blendShapes
+C++ Type
+VtArray<TfToken>
+Usd Type
+SdfValueTypeNames->TokenArray
+Variability
+SdfVariabilityUniform
+
+GetJointsAttr() → Attribute
+Array of tokens identifying which joints this animation’s data applies
+to.
+The tokens for joints correspond to the tokens of Skeleton primitives.
+The order of the joints as listed here may vary from the order of
+joints on the Skeleton itself.
+Declaration
+uniform token[] joints
+C++ Type
+VtArray<TfToken>
+Usd Type
+SdfValueTypeNames->TokenArray
+Variability
+SdfVariabilityUniform
+
+GetRotationsAttr() → Attribute
+Joint-local unit quaternion rotations of all affected joints, in
+32-bit precision.
+Array length should match the size of the joints attribute.
+Declaration
+quatf[] rotations
+C++ Type
+VtArray<GfQuatf>
+Usd Type
+SdfValueTypeNames->QuatfArray
+
+GetScalesAttr() → Attribute
+Joint-local scales of all affected joints, in 16 bit precision.
+Array length should match the size of the joints attribute.
+Declaration
+half3[] scales
+C++ Type
+VtArray<GfVec3h>
+Usd Type
+SdfValueTypeNames->Half3Array
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+GetTransforms(xforms, time) → bool
+Convenience method for querying resolved transforms at time .
+Note that it is more efficient to query transforms through
+UsdSkelAnimQuery or UsdSkelSkeletonQuery.
+
+Parameters
+
+xforms (Matrix4dArray) – 
+time (TimeCode) – 
+
+GetTranslationsAttr() → Attribute
+Joint-local translations of all affected joints.
+Array length should match the size of the joints attribute.
+Declaration
+float3[] translations
+C++ Type
+VtArray<GfVec3f>
+Usd Type
+SdfValueTypeNames->Float3Array
+
+SetTransforms(xforms, time) → bool
+Convenience method for setting an array of transforms.
+The given transforms must be orthogonal.
+
+Parameters
+
+xforms (Matrix4dArray) – 
+time (TimeCode) – 
+
+class pxr.UsdSkel.Binding
+Helper object that describes the binding of a skeleton to a set of
+skinnable objects. The set of skinnable objects is given as
+UsdSkelSkinningQuery prims, which can be used both to identify the
+skinned prim as well compute skinning properties of the prim.
+Methods:
+
+GetSkeleton()
+Returns the bound skeleton.
+
+GetSkinningTargets()
+Returns the set skinning targets.
+
+GetSkeleton() → Skeleton
+Returns the bound skeleton.
+
+GetSkinningTargets() → VtArray[SkinningQuery]
+Returns the set skinning targets.
+
+class pxr.UsdSkel.BindingAPI
+Provides API for authoring and extracting all the skinning-related
+data that lives in the”geometry hierarchy”of prims and models that
+want to be skeletally deformed.
+See the extended UsdSkelBindingAPI schema documentation for more about
+bindings and how they apply in a scene graph.
+Methods:
+
+Apply
+classmethod Apply(prim) -> BindingAPI
+
+CanApply
+classmethod CanApply(prim, whyNot) -> bool
+
+CreateAnimationSourceRel()
+See GetAnimationSourceRel() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateBlendShapeTargetsRel()
+See GetBlendShapeTargetsRel() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateBlendShapesAttr(defaultValue, ...)
+See GetBlendShapesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateGeomBindTransformAttr(defaultValue, ...)
+See GetGeomBindTransformAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateJointIndicesAttr(defaultValue, ...)
+See GetJointIndicesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateJointIndicesPrimvar(constant, elementSize)
+Convenience function to create the jointIndices primvar, optionally specifying elementSize.
+
+CreateJointWeightsAttr(defaultValue, ...)
+See GetJointWeightsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateJointWeightsPrimvar(constant, elementSize)
+Convenience function to create the jointWeights primvar, optionally specifying elementSize.
+
+CreateJointsAttr(defaultValue, writeSparsely)
+See GetJointsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateSkeletonRel()
+See GetSkeletonRel() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateSkinningBlendWeightPrimvar
+
+CreateSkinningBlendWeightsAttr(defaultValue, ...)
+See GetSkinningBlendWeightsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateSkinningMethodAttr(defaultValue, ...)
+See GetSkinningMethodAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Get
+classmethod Get(stage, path) -> BindingAPI
+
+GetAnimationSource(prim)
+Convenience method to query the animation source bound on this prim.
+
+GetAnimationSourceRel()
+Animation source to be bound to Skeleton primitives at or beneath the location at which this property is defined.
+
+GetBlendShapeTargetsRel()
+Ordered list of all target blend shapes.
+
+GetBlendShapesAttr()
+An array of tokens defining the order onto which blend shape weights from an animation source map onto the skel:blendShapeTargets rel of a binding site.
+
+GetGeomBindTransformAttr()
+Encodes the bind-time world space transforms of the prim.
+
+GetInheritedAnimationSource()
+Returns the animation source bound at this prim, or one of its ancestors.
+
+GetInheritedSkeleton()
+Returns the skeleton bound at this prim, or one of its ancestors.
+
+GetJointIndicesAttr()
+Indices into the joints attribute of the closest (in namespace) bound Skeleton that affect each point of a PointBased gprim.
+
+GetJointIndicesPrimvar()
+Convenience function to get the jointIndices attribute as a primvar.
+
+GetJointWeightsAttr()
+Weights for the joints that affect each point of a PointBased gprim.
+
+GetJointWeightsPrimvar()
+Convenience function to get the jointWeights attribute as a primvar.
+
+GetJointsAttr()
+An (optional) array of tokens defining the list of joints to which jointIndices apply.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+GetSkeleton(skel)
+Convenience method to query the Skeleton bound on this prim.
+
+GetSkeletonRel()
+Skeleton to be bound to this prim and its descendents that possess a mapping and weighting to the joints of the identified Skeleton.
+
+GetSkinningBlendWeightPrimvar
+
+GetSkinningBlendWeightsAttr()
+Weights for weighted blend skinning method.
+
+GetSkinningMethodAttr()
+Different calculation method for skinning.
+
+SetRigidJointInfluence(jointIndex, weight)
+Convenience method for defining joints influences that make a primitive rigidly deformed by a single joint.
+
+ValidateJointIndices
+classmethod ValidateJointIndices(indices, numJoints, reason) -> bool
+
+static Apply()
+classmethod Apply(prim) -> BindingAPI
+Applies this single-apply API schema to the given prim .
+This information is stored by adding”SkelBindingAPI”to the token-
+valued, listOp metadata apiSchemas on the prim.
+A valid UsdSkelBindingAPI object is returned upon success. An invalid
+(or empty) UsdSkelBindingAPI object is returned upon failure. See
+UsdPrim::ApplyAPI() for conditions resulting in failure.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+prim (Prim) – 
+
+static CanApply()
+classmethod CanApply(prim, whyNot) -> bool
+Returns true if this single-apply API schema can be applied to the
+given prim .
+If this schema can not be a applied to the prim, this returns false
+and, if provided, populates whyNot with the reason it can not be
+applied.
+Note that if CanApply returns false, that does not necessarily imply
+that calling Apply will fail. Callers are expected to call CanApply
+before calling Apply if they want to ensure that it is valid to apply
+a schema.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+
+prim (Prim) – 
+whyNot (str) – 
+
+CreateAnimationSourceRel() → Relationship
+See GetAnimationSourceRel() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+
+CreateBlendShapeTargetsRel() → Relationship
+See GetBlendShapeTargetsRel() , and also Create vs Get Property
+Methods for when to use Get vs Create.
+
+CreateBlendShapesAttr(defaultValue, writeSparsely) → Attribute
+See GetBlendShapesAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateGeomBindTransformAttr(defaultValue, writeSparsely) → Attribute
+See GetGeomBindTransformAttr() , and also Create vs Get Property
+Methods for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateJointIndicesAttr(defaultValue, writeSparsely) → Attribute
+See GetJointIndicesAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateJointIndicesPrimvar(constant, elementSize) → Primvar
+Convenience function to create the jointIndices primvar, optionally
+specifying elementSize.
+If constant is true, the resulting primvar is configured
+with’constant’interpolation, and describes a rigid deformation.
+Otherwise, the primvar is configured with’vertex’interpolation, and
+describes joint influences that vary per point.
+CreateJointIndicesAttr() , GetJointIndicesPrimvar()
+
+Parameters
+
+constant (bool) – 
+elementSize (int) – 
+
+CreateJointWeightsAttr(defaultValue, writeSparsely) → Attribute
+See GetJointWeightsAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateJointWeightsPrimvar(constant, elementSize) → Primvar
+Convenience function to create the jointWeights primvar, optionally
+specifying elementSize.
+If constant is true, the resulting primvar is configured
+with’constant’interpolation, and describes a rigid deformation.
+Otherwise, the primvar is configured with’vertex’interpolation, and
+describes joint influences that vary per point.
+CreateJointWeightsAttr() , GetJointWeightsPrimvar()
+
+Parameters
+
+constant (bool) – 
+elementSize (int) – 
+
+CreateJointsAttr(defaultValue, writeSparsely) → Attribute
+See GetJointsAttr() , and also Create vs Get Property Methods for when
+to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateSkeletonRel() → Relationship
+See GetSkeletonRel() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+
+CreateSkinningBlendWeightPrimvar()
+
+CreateSkinningBlendWeightsAttr(defaultValue, writeSparsely) → Attribute
+See GetSkinningBlendWeightsAttr() , and also Create vs Get Property
+Methods for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateSkinningMethodAttr(defaultValue, writeSparsely) → Attribute
+See GetSkinningMethodAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Get()
+classmethod Get(stage, path) -> BindingAPI
+Return a UsdSkelBindingAPI holding the prim adhering to this schema at
+path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdSkelBindingAPI(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetAnimationSource(prim) → bool
+Convenience method to query the animation source bound on this prim.
+Returns true if an animation source binding is defined, and sets
+prim to the target prim. The resulting primitive may still be
+invalid, if the prim has been explicitly unbound.
+This does not resolved inherited animation source bindings.
+
+Parameters
+prim (Prim) – 
+
+GetAnimationSourceRel() → Relationship
+Animation source to be bound to Skeleton primitives at or beneath the
+location at which this property is defined.
+
+GetBlendShapeTargetsRel() → Relationship
+Ordered list of all target blend shapes.
+This property is not inherited hierarchically, and is expected to be
+authored directly on the skinnable primitive to which the the blend
+shapes apply.
+
+GetBlendShapesAttr() → Attribute
+An array of tokens defining the order onto which blend shape weights
+from an animation source map onto the skel:blendShapeTargets rel of
+a binding site.
+If authored, the number of elements must be equal to the number of
+targets in the blendShapeTargets rel. This property is not inherited
+hierarchically, and is expected to be authored directly on the
+skinnable primitive to which the blend shapes apply.
+Declaration
+uniform token[] skel:blendShapes
+C++ Type
+VtArray<TfToken>
+Usd Type
+SdfValueTypeNames->TokenArray
+Variability
+SdfVariabilityUniform
+
+GetGeomBindTransformAttr() → Attribute
+Encodes the bind-time world space transforms of the prim.
+If the transform is identical for a group of gprims that share a
+common ancestor, the transform may be authored on the ancestor,
+to”inherit”down to all the leaf gprims. If this transform is unset, an
+identity transform is used instead.
+Declaration
+matrix4d primvars:skel:geomBindTransform
+C++ Type
+GfMatrix4d
+Usd Type
+SdfValueTypeNames->Matrix4d
+
+GetInheritedAnimationSource() → Prim
+Returns the animation source bound at this prim, or one of its
+ancestors.
+
+GetInheritedSkeleton() → Skeleton
+Returns the skeleton bound at this prim, or one of its ancestors.
+
+GetJointIndicesAttr() → Attribute
+Indices into the joints attribute of the closest (in namespace)
+bound Skeleton that affect each point of a PointBased gprim.
+The primvar can have either constant or vertex interpolation. This
+primvar’s elementSize will determine how many joint influences apply
+to each point. Indices must point be valid. Null influences should be
+defined by setting values in jointWeights to zero. See UsdGeomPrimvar
+for more information on interpolation and elementSize.
+Declaration
+int[] primvars:skel:jointIndices
+C++ Type
+VtArray<int>
+Usd Type
+SdfValueTypeNames->IntArray
+
+GetJointIndicesPrimvar() → Primvar
+Convenience function to get the jointIndices attribute as a primvar.
+GetJointIndicesAttr, GetInheritedJointWeightsPrimvar
+
+GetJointWeightsAttr() → Attribute
+Weights for the joints that affect each point of a PointBased gprim.
+The primvar can have either constant or vertex interpolation. This
+primvar’s elementSize will determine how many joints influences
+apply to each point. The length, interpolation, and elementSize of
+jointWeights must match that of jointIndices. See UsdGeomPrimvar
+for more information on interpolation and elementSize.
+Declaration
+float[] primvars:skel:jointWeights
+C++ Type
+VtArray<float>
+Usd Type
+SdfValueTypeNames->FloatArray
+
+GetJointWeightsPrimvar() → Primvar
+Convenience function to get the jointWeights attribute as a primvar.
+GetJointWeightsAttr, GetInheritedJointWeightsPrimvar
+
+GetJointsAttr() → Attribute
+An (optional) array of tokens defining the list of joints to which
+jointIndices apply.
+If not defined, jointIndices applies to the ordered list of joints
+defined in the bound Skeleton’s joints attribute. If undefined on a
+primitive, the primitive inherits the value of the nearest ancestor
+prim, if any.
+Declaration
+uniform token[] skel:joints
+C++ Type
+VtArray<TfToken>
+Usd Type
+SdfValueTypeNames->TokenArray
+Variability
+SdfVariabilityUniform
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+GetSkeleton(skel) → bool
+Convenience method to query the Skeleton bound on this prim.
+Returns true if a Skeleton binding is defined, and sets skel to
+the target skel. The resulting Skeleton may still be invalid, if the
+Skeleton has been explicitly unbound.
+This does not resolved inherited skeleton bindings.
+
+Parameters
+skel (Skeleton) – 
+
+GetSkeletonRel() → Relationship
+Skeleton to be bound to this prim and its descendents that possess a
+mapping and weighting to the joints of the identified Skeleton.
+
+GetSkinningBlendWeightPrimvar()
+
+GetSkinningBlendWeightsAttr() → Attribute
+Weights for weighted blend skinning method.
+The primvar can have either constant or vertex interpolation.
+Constant interpolation means every vertex share the same single blend
+weight. Vertex interpolation means every vertex has their own blend
+weight. The element size should match the vertices count in this case.
+C++ Type: VtArray<float>  Usd Type: SdfValueTypeNames->FloatArray
+Variability: SdfVariabilityUniform  Fallback Value: No Fallback
+
+GetSkinningMethodAttr() → Attribute
+Different calculation method for skinning.
+LBS, DQ, and blendWeight
+C++ Type: TfToken  Usd Type: SdfValueTypeNames->Token  Variability:
+SdfVariabilityUniform  Fallback Value: ClassicLinear  Allowed Values :
+[ClassicLinear, DualQuaternion, WeightedBlend]
+
+SetRigidJointInfluence(jointIndex, weight) → bool
+Convenience method for defining joints influences that make a
+primitive rigidly deformed by a single joint.
+
+Parameters
+
+jointIndex (int) – 
+weight (float) – 
+
+static ValidateJointIndices()
+classmethod ValidateJointIndices(indices, numJoints, reason) -> bool
+Validate an array of joint indices.
+This ensures that all indices are the in the range [0, numJoints).
+Returns true if the indices are valid, or false otherwise. If invalid
+and reason is non-null, an error message describing the first
+validation error will be set.
+
+Parameters
+
+indices (TfSpan[int]) – 
+numJoints (int) – 
+reason (str) – 
+
+class pxr.UsdSkel.BlendShape
+Describes a target blend shape, possibly containing inbetween shapes.
+See the extended Blend Shape Schema documentation for information.
+Methods:
+
+CreateInbetween(name)
+Author scene description to create an attribute on this prim that will be recognized as an Inbetween (i.e.
+
+CreateNormalOffsetsAttr(defaultValue, ...)
+See GetNormalOffsetsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateOffsetsAttr(defaultValue, writeSparsely)
+See GetOffsetsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreatePointIndicesAttr(defaultValue, ...)
+See GetPointIndicesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Define
+classmethod Define(stage, path) -> BlendShape
+
+Get
+classmethod Get(stage, path) -> BlendShape
+
+GetAuthoredInbetweens()
+Like GetInbetweens() , but exclude inbetwens that have no authored scene / description.
+
+GetInbetween(name)
+Return the Inbetween corresponding to the attribute named name , which will be valid if an Inbetween attribute definition already exists.
+
+GetInbetweens()
+Return valid UsdSkelInbetweenShape objects for all defined Inbetweens on this prim.
+
+GetNormalOffsetsAttr()
+Required property.
+
+GetOffsetsAttr()
+Required property.
+
+GetPointIndicesAttr()
+Optional property.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+HasInbetween(name)
+Return true if there is a defined Inbetween named name on this prim.
+
+ValidatePointIndices
+classmethod ValidatePointIndices(indices, numPoints, reason) -> bool
+
+CreateInbetween(name) → InbetweenShape
+Author scene description to create an attribute on this prim that will
+be recognized as an Inbetween (i.e.
+will present as a valid UsdSkelInbetweenShape).
+The name of the created attribute or may or may not be the specified
+attrName , due to the possible need to apply property namespacing.
+Creation may fail and return an invalid Inbetwen if attrName
+contains a reserved keyword.
+an invalid UsdSkelInbetweenShape if we failed to create a valid
+attribute, a valid UsdSkelInbetweenShape otherwise. It is not an error
+to create over an existing, compatible attribute.
+UsdSkelInbetweenShape::IsInbetween()
+
+Parameters
+name (str) – 
+
+CreateNormalOffsetsAttr(defaultValue, writeSparsely) → Attribute
+See GetNormalOffsetsAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateOffsetsAttr(defaultValue, writeSparsely) → Attribute
+See GetOffsetsAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreatePointIndicesAttr(defaultValue, writeSparsely) → Attribute
+See GetPointIndicesAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Define()
+classmethod Define(stage, path) -> BlendShape
+Attempt to ensure a UsdPrim adhering to this schema at path is
+defined (according to UsdPrim::IsDefined() ) on this stage.
+If a prim adhering to this schema at path is already defined on
+this stage, return that prim. Otherwise author an SdfPrimSpec with
+specifier == SdfSpecifierDef and this schema’s prim type name for
+the prim at path at the current EditTarget. Author SdfPrimSpec s
+with specifier == SdfSpecifierDef and empty typeName at the
+current EditTarget for any nonexistent, or existing but not Defined
+ancestors.
+The given path must be an absolute prim path that does not contain
+any variant selections.
+If it is impossible to author any of the necessary PrimSpecs, (for
+example, in case path cannot map to the current UsdEditTarget ‘s
+namespace) issue an error and return an invalid UsdPrim.
+Note that this method may return a defined prim whose typeName does
+not specify this schema class, in case a stronger typeName opinion
+overrides the opinion at the current EditTarget.
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static Get()
+classmethod Get(stage, path) -> BlendShape
+Return a UsdSkelBlendShape holding the prim adhering to this schema at
+path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdSkelBlendShape(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetAuthoredInbetweens() → list[InbetweenShape]
+Like GetInbetweens() , but exclude inbetwens that have no authored
+scene / description.
+
+GetInbetween(name) → InbetweenShape
+Return the Inbetween corresponding to the attribute named name ,
+which will be valid if an Inbetween attribute definition already
+exists.
+Name lookup will account for Inbetween namespacing, which means that
+this method will succeed in some cases where UsdSkelInbetweenShape
+(prim->GetAttribute(name)) will not, unless name has the proper
+namespace prefix.
+HasInbetween()
+
+Parameters
+name (str) – 
+
+GetInbetweens() → list[InbetweenShape]
+Return valid UsdSkelInbetweenShape objects for all defined Inbetweens
+on this prim.
+
+GetNormalOffsetsAttr() → Attribute
+Required property.
+Normal offsets which, when added to the base pose, provides the
+normals of the target shape.
+Declaration
+uniform vector3f[] normalOffsets
+C++ Type
+VtArray<GfVec3f>
+Usd Type
+SdfValueTypeNames->Vector3fArray
+Variability
+SdfVariabilityUniform
+
+GetOffsetsAttr() → Attribute
+Required property.
+Position offsets which, when added to the base pose, provides the
+target shape.
+Declaration
+uniform vector3f[] offsets
+C++ Type
+VtArray<GfVec3f>
+Usd Type
+SdfValueTypeNames->Vector3fArray
+Variability
+SdfVariabilityUniform
+
+GetPointIndicesAttr() → Attribute
+Optional property.
+Indices into the original mesh that correspond to the values in
+offsets and of any inbetween shapes. If authored, the number of
+elements must be equal to the number of elements in the offsets
+array.
+Declaration
+uniform int[] pointIndices
+C++ Type
+VtArray<int>
+Usd Type
+SdfValueTypeNames->IntArray
+Variability
+SdfVariabilityUniform
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+HasInbetween(name) → bool
+Return true if there is a defined Inbetween named name on this
+prim.
+Name lookup will account for Inbetween namespacing.
+GetInbetween()
+
+Parameters
+name (str) – 
+
+static ValidatePointIndices()
+classmethod ValidatePointIndices(indices, numPoints, reason) -> bool
+Validates a set of point indices for a given point count.
+This ensures that all point indices are in the range [0, numPoints).
+Returns true if the indices are valid, or false otherwise. If invalid
+and reason is non-null, an error message describing the first
+validation error will be set.
+
+Parameters
+
+indices (TfSpan[int]) – 
+numPoints (int) – 
+reason (str) – 
+
+class pxr.UsdSkel.BlendShapeQuery
+Helper class used to resolve blend shape weights, including
+inbetweens.
+Methods:
+
+ComputeBlendShapePointIndices()
+Compute an array holding the point indices of all shapes.
+
+ComputeDeformedPoints(subShapeWeights, ...)
+Deform points using the resolved sub-shapes given by subShapeWeights , blendShapeIndices and subShapeIndices .
+
+ComputeSubShapePointOffsets()
+Compute an array holding the point offsets of all sub-shapes.
+
+ComputeSubShapeWeights(weights, ...)
+Compute the resolved weights for all sub-shapes bound to this prim.
+
+GetBlendShape(blendShapeIndex)
+Returns the blend shape corresponding to blendShapeIndex .
+
+GetBlendShapeIndex(subShapeIndex)
+Returns the blend shape index corresponding to the i'th sub-shape.
+
+GetInbetween(subShapeIndex)
+Returns the inbetween shape corresponding to sub-shape i , if any.
+
+GetNumBlendShapes()
+
+GetNumSubShapes()
+
+ComputeBlendShapePointIndices() → list[IntArray]
+Compute an array holding the point indices of all shapes.
+This is indexed by the blendShapeIndices returned by
+ComputeSubShapes(). Since the pointIndices property of blend shapes
+is optional, some of the arrays may be empty.
+
+ComputeDeformedPoints(subShapeWeights, blendShapeIndices, subShapeIndices, blendShapePointIndices, subShapePointOffsets, points) → bool
+Deform points using the resolved sub-shapes given by
+subShapeWeights , blendShapeIndices and subShapeIndices .
+The blendShapePointIndices and blendShapePointOffsets arrays
+both provide the pre-computed point offsets and indices of each sub-
+shape, as computed by ComputeBlendShapePointIndices() and
+ComputeSubShapePointOffsets() .
+
+Parameters
+
+subShapeWeights (TfSpan[float]) – 
+blendShapeIndices (TfSpan[unsigned]) – 
+subShapeIndices (TfSpan[unsigned]) – 
+blendShapePointIndices (list[IntArray]) – 
+subShapePointOffsets (list[Vec3fArray]) – 
+points (TfSpan[Vec3f]) – 
+
+ComputeSubShapePointOffsets() → list[Vec3fArray]
+Compute an array holding the point offsets of all sub-shapes.
+This includes offsets of both primary shapes  those stored directly on
+a BlendShape primitive  as well as those of inbetween shapes. This is
+indexed by the subShapeIndices returned by ComputeSubShapeWeights()
+.
+
+ComputeSubShapeWeights(weights, subShapeWeights, blendShapeIndices, subShapeIndices) → bool
+Compute the resolved weights for all sub-shapes bound to this prim.
+The weights values are initial weight values, ordered according to
+the skel:blendShapeTargets relationship of the prim this query is
+associated with. If there are any inbetween shapes, a new set of
+weights is computed, providing weighting of the relevant inbetweens.
+All computed arrays shared the same size. Elements of the same index
+identify which sub-shape of which blend shape a given weight value is
+mapped to.
+
+Parameters
+
+weights (TfSpan[float]) – 
+subShapeWeights (FloatArray) – 
+blendShapeIndices (UIntArray) – 
+subShapeIndices (UIntArray) – 
+
+GetBlendShape(blendShapeIndex) → BlendShape
+Returns the blend shape corresponding to blendShapeIndex .
+
+Parameters
+blendShapeIndex (int) – 
+
+GetBlendShapeIndex(subShapeIndex) → int
+Returns the blend shape index corresponding to the i'th sub-shape.
+
+Parameters
+subShapeIndex (int) – 
+
+GetInbetween(subShapeIndex) → InbetweenShape
+Returns the inbetween shape corresponding to sub-shape i , if any.
+
+Parameters
+subShapeIndex (int) – 
+
+GetNumBlendShapes() → int
+
+GetNumSubShapes() → int
+
+class pxr.UsdSkel.Cache
+Thread-safe cache for accessing query objects for evaluating skeletal
+data.
+This provides caching of major structural components, such as skeletal
+topology. In a streaming context, this cache is intended to persist.
+Methods:
+
+Clear()
+
+ComputeSkelBinding(skelRoot, skel, binding, ...)
+Compute the bindings corresponding to a single skeleton, bound beneath skelRoot , as discovered through a traversal using predicate .
+
+ComputeSkelBindings(skelRoot, bindings, ...)
+Compute the set of skeleton bindings beneath skelRoot , as discovered through a traversal using predicate .
+
+GetAnimQuery(anim)
+Get an anim query corresponding to anim .
+
+GetSkelQuery(skel)
+Get a skel query for computing properties of skel .
+
+GetSkinningQuery(prim)
+Get a skinning query at prim .
+
+Populate(root, predicate)
+Populate the cache for the skeletal data beneath prim root , as traversed using predicate .
+
+Clear() → None
+
+ComputeSkelBinding(skelRoot, skel, binding, predicate) → bool
+Compute the bindings corresponding to a single skeleton, bound beneath
+skelRoot , as discovered through a traversal using predicate .
+Skinnable prims are only discoverable by this method if Populate() has
+already been called for skelRoot , with an equivalent predicate.
+
+Parameters
+
+skelRoot (Root) – 
+skel (Skeleton) – 
+binding (Binding) – 
+predicate (_PrimFlagsPredicate) – 
+
+ComputeSkelBindings(skelRoot, bindings, predicate) → bool
+Compute the set of skeleton bindings beneath skelRoot , as
+discovered through a traversal using predicate .
+Skinnable prims are only discoverable by this method if Populate() has
+already been called for skelRoot , with an equivalent predicate.
+
+Parameters
+
+skelRoot (Root) – 
+bindings (list[Binding]) – 
+predicate (_PrimFlagsPredicate) – 
+
+GetAnimQuery(anim) → AnimQuery
+Get an anim query corresponding to anim .
+This does not require Populate() to be called on the cache.
+
+Parameters
+anim (Animation) – 
+
+GetAnimQuery(prim) -> AnimQuery
+This is an overloaded member function, provided for convenience. It
+differs from the above function only in what argument(s) it accepts.
+Deprecated
+
+Parameters
+prim (Prim) – 
+
+GetSkelQuery(skel) → SkeletonQuery
+Get a skel query for computing properties of skel .
+This does not require Populate() to be called on the cache.
+
+Parameters
+skel (Skeleton) – 
+
+GetSkinningQuery(prim) → SkinningQuery
+Get a skinning query at prim .
+Skinning queries are defined at any skinnable prims (I.e., boundable
+prims with fully defined joint influences).
+The caller must first Populate() the cache with the skel root
+containing prim , with a predicate that will visit prim , in
+order for a skinning query to be discoverable.
+
+Parameters
+prim (Prim) – 
+
+Populate(root, predicate) → bool
+Populate the cache for the skeletal data beneath prim root , as
+traversed using predicate .
+Population resolves inherited skel bindings set using the
+UsdSkelBindingAPI, making resolved bindings available through
+GetSkinningQuery() , ComputeSkelBdining() and ComputeSkelBindings() .
+
+Parameters
+
+root (Root) – 
+predicate (_PrimFlagsPredicate) – 
+
+class pxr.UsdSkel.InbetweenShape
+Schema wrapper for UsdAttribute for authoring and introspecting
+attributes that serve as inbetween shapes of a UsdSkelBlendShape.
+Inbetween shapes allow an explicit shape to be specified when the
+blendshape to which it’s bound is evaluated at a certain weight. For
+example, rather than performing piecewise linear interpolation between
+a primary shape and the rest shape at weight 0.5, an inbetween shape
+could be defined at the weight. For weight values greater than 0.5, a
+shape would then be resolved by linearly interpolating between the
+inbetween shape and the primary shape, while for weight values less
+than or equal to 0.5, the shape is resolved by linearly interpolating
+between the inbetween shape and the primary shape.
+Methods:
+
+CreateNormalOffsetsAttr(defaultValue)
+Returns the existing normal offsets attribute if the shape has normal offsets, or creates a new one.
+
+GetAttr()
+Explicit UsdAttribute extractor.
+
+GetNormalOffsets(offsets)
+Get the normal offsets authored for this shape.
+
+GetNormalOffsetsAttr()
+Returns a valid normal offsets attribute if the shape has normal offsets.
+
+GetOffsets(offsets)
+Get the point offsets corresponding to this shape.
+
+GetWeight(weight)
+Return the location at which the shape is applied.
+
+HasAuthoredWeight()
+Has a weight value been explicitly authored on this shape?
+
+IsDefined()
+Return true if the wrapped UsdAttribute::IsDefined() , and in addition the attribute is identified as an Inbetween.
+
+IsInbetween
+classmethod IsInbetween(attr) -> bool
+
+SetNormalOffsets(offsets)
+Set the normal offsets authored for this shape.
+
+SetOffsets(offsets)
+Set the point offsets corresponding to this shape.
+
+SetWeight(weight)
+Set the location at which the shape is applied.
+
+CreateNormalOffsetsAttr(defaultValue) → Attribute
+Returns the existing normal offsets attribute if the shape has normal
+offsets, or creates a new one.
+
+Parameters
+defaultValue (VtValue) – 
+
+GetAttr() → Attribute
+Explicit UsdAttribute extractor.
+
+GetNormalOffsets(offsets) → bool
+Get the normal offsets authored for this shape.
+Normal offsets are optional, and may be left unspecified.
+
+Parameters
+offsets (Vec3fArray) – 
+
+GetNormalOffsetsAttr() → Attribute
+Returns a valid normal offsets attribute if the shape has normal
+offsets.
+Returns an invalid attribute otherwise.
+
+GetOffsets(offsets) → bool
+Get the point offsets corresponding to this shape.
+
+Parameters
+offsets (Vec3fArray) – 
+
+GetWeight(weight) → bool
+Return the location at which the shape is applied.
+
+Parameters
+weight (float) – 
+
+HasAuthoredWeight() → bool
+Has a weight value been explicitly authored on this shape?
+GetWeight()
+
+IsDefined() → bool
+Return true if the wrapped UsdAttribute::IsDefined() , and in addition
+the attribute is identified as an Inbetween.
+
+static IsInbetween()
+classmethod IsInbetween(attr) -> bool
+Test whether a given UsdAttribute represents a valid Inbetween, which
+implies that creating a UsdSkelInbetweenShape from the attribute will
+succeed.
+Succes implies that attr.IsDefined() is true.
+
+Parameters
+attr (Attribute) – 
+
+SetNormalOffsets(offsets) → bool
+Set the normal offsets authored for this shape.
+
+Parameters
+offsets (Vec3fArray) – 
+
+SetOffsets(offsets) → bool
+Set the point offsets corresponding to this shape.
+
+Parameters
+offsets (Vec3fArray) – 
+
+SetWeight(weight) → bool
+Set the location at which the shape is applied.
+
+Parameters
+weight (float) – 
+
+class pxr.UsdSkel.PackedJointAnimation
+Deprecated. Please use SkelAnimation instead.
+Methods:
+
+Define
+classmethod Define(stage, path) -> PackedJointAnimation
+
+Get
+classmethod Get(stage, path) -> PackedJointAnimation
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+static Define()
+classmethod Define(stage, path) -> PackedJointAnimation
+Attempt to ensure a UsdPrim adhering to this schema at path is
+defined (according to UsdPrim::IsDefined() ) on this stage.
+If a prim adhering to this schema at path is already defined on
+this stage, return that prim. Otherwise author an SdfPrimSpec with
+specifier == SdfSpecifierDef and this schema’s prim type name for
+the prim at path at the current EditTarget. Author SdfPrimSpec s
+with specifier == SdfSpecifierDef and empty typeName at the
+current EditTarget for any nonexistent, or existing but not Defined
+ancestors.
+The given path must be an absolute prim path that does not contain
+any variant selections.
+If it is impossible to author any of the necessary PrimSpecs, (for
+example, in case path cannot map to the current UsdEditTarget ‘s
+namespace) issue an error and return an invalid UsdPrim.
+Note that this method may return a defined prim whose typeName does
+not specify this schema class, in case a stronger typeName opinion
+overrides the opinion at the current EditTarget.
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static Get()
+classmethod Get(stage, path) -> PackedJointAnimation
+Return a UsdSkelPackedJointAnimation holding the prim adhering to this
+schema at path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdSkelPackedJointAnimation(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+class pxr.UsdSkel.Root
+Boundable prim type used to identify a scope beneath which skeletally-
+posed primitives are defined.
+A SkelRoot must be defined at or above a skinned primitive for any
+skinning behaviors in UsdSkel.
+See the extended Skel Root Schema documentation for more information.
+Methods:
+
+Define
+classmethod Define(stage, path) -> Root
+
+Find
+classmethod Find(prim) -> Root
+
+Get
+classmethod Get(stage, path) -> Root
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+static Define()
+classmethod Define(stage, path) -> Root
+Attempt to ensure a UsdPrim adhering to this schema at path is
+defined (according to UsdPrim::IsDefined() ) on this stage.
+If a prim adhering to this schema at path is already defined on
+this stage, return that prim. Otherwise author an SdfPrimSpec with
+specifier == SdfSpecifierDef and this schema’s prim type name for
+the prim at path at the current EditTarget. Author SdfPrimSpec s
+with specifier == SdfSpecifierDef and empty typeName at the
+current EditTarget for any nonexistent, or existing but not Defined
+ancestors.
+The given path must be an absolute prim path that does not contain
+any variant selections.
+If it is impossible to author any of the necessary PrimSpecs, (for
+example, in case path cannot map to the current UsdEditTarget ‘s
+namespace) issue an error and return an invalid UsdPrim.
+Note that this method may return a defined prim whose typeName does
+not specify this schema class, in case a stronger typeName opinion
+overrides the opinion at the current EditTarget.
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static Find()
+classmethod Find(prim) -> Root
+Returns the skel root at or above prim , or an invalid schema
+object  if no ancestor prim is defined as a skel root.
+
+Parameters
+prim (Prim) – 
+
+static Get()
+classmethod Get(stage, path) -> Root
+Return a UsdSkelRoot holding the prim adhering to this schema at
+path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdSkelRoot(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+class pxr.UsdSkel.Skeleton
+Describes a skeleton.
+See the extended Skeleton Schema documentation for more information.
+Methods:
+
+CreateBindTransformsAttr(defaultValue, ...)
+See GetBindTransformsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateJointNamesAttr(defaultValue, writeSparsely)
+See GetJointNamesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateJointsAttr(defaultValue, writeSparsely)
+See GetJointsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateRestTransformsAttr(defaultValue, ...)
+See GetRestTransformsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Define
+classmethod Define(stage, path) -> Skeleton
+
+Get
+classmethod Get(stage, path) -> Skeleton
+
+GetBindTransformsAttr()
+Specifies the bind-pose transforms of each joint in world space, in the ordering imposed by joints.
+
+GetJointNamesAttr()
+If authored, provides a unique name per joint.
+
+GetJointsAttr()
+An array of path tokens identifying the set of joints that make up the skeleton, and their order.
+
+GetRestTransformsAttr()
+Specifies the rest-pose transforms of each joint in local space, in the ordering imposed by joints.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+CreateBindTransformsAttr(defaultValue, writeSparsely) → Attribute
+See GetBindTransformsAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateJointNamesAttr(defaultValue, writeSparsely) → Attribute
+See GetJointNamesAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateJointsAttr(defaultValue, writeSparsely) → Attribute
+See GetJointsAttr() , and also Create vs Get Property Methods for when
+to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateRestTransformsAttr(defaultValue, writeSparsely) → Attribute
+See GetRestTransformsAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Define()
+classmethod Define(stage, path) -> Skeleton
+Attempt to ensure a UsdPrim adhering to this schema at path is
+defined (according to UsdPrim::IsDefined() ) on this stage.
+If a prim adhering to this schema at path is already defined on
+this stage, return that prim. Otherwise author an SdfPrimSpec with
+specifier == SdfSpecifierDef and this schema’s prim type name for
+the prim at path at the current EditTarget. Author SdfPrimSpec s
+with specifier == SdfSpecifierDef and empty typeName at the
+current EditTarget for any nonexistent, or existing but not Defined
+ancestors.
+The given path must be an absolute prim path that does not contain
+any variant selections.
+If it is impossible to author any of the necessary PrimSpecs, (for
+example, in case path cannot map to the current UsdEditTarget ‘s
+namespace) issue an error and return an invalid UsdPrim.
+Note that this method may return a defined prim whose typeName does
+not specify this schema class, in case a stronger typeName opinion
+overrides the opinion at the current EditTarget.
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static Get()
+classmethod Get(stage, path) -> Skeleton
+Return a UsdSkelSkeleton holding the prim adhering to this schema at
+path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdSkelSkeleton(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetBindTransformsAttr() → Attribute
+Specifies the bind-pose transforms of each joint in world space,
+in the ordering imposed by joints.
+Declaration
+uniform matrix4d[] bindTransforms
+C++ Type
+VtArray<GfMatrix4d>
+Usd Type
+SdfValueTypeNames->Matrix4dArray
+Variability
+SdfVariabilityUniform
+
+GetJointNamesAttr() → Attribute
+If authored, provides a unique name per joint.
+This may be optionally set to provide better names when translating to
+DCC apps that require unique joint names.
+Declaration
+uniform token[] jointNames
+C++ Type
+VtArray<TfToken>
+Usd Type
+SdfValueTypeNames->TokenArray
+Variability
+SdfVariabilityUniform
+
+GetJointsAttr() → Attribute
+An array of path tokens identifying the set of joints that make up the
+skeleton, and their order.
+Each token in the array must be valid when parsed as an SdfPath. The
+parent-child relationships of the corresponding paths determine the
+parent-child relationships of each joint. It is not required that the
+name at the end of each path be unique, but rather only that the paths
+themselves be unique.
+Declaration
+uniform token[] joints
+C++ Type
+VtArray<TfToken>
+Usd Type
+SdfValueTypeNames->TokenArray
+Variability
+SdfVariabilityUniform
+
+GetRestTransformsAttr() → Attribute
+Specifies the rest-pose transforms of each joint in local space,
+in the ordering imposed by joints.
+This provides fallback values for joint transforms when a Skeleton
+either has no bound animation source, or when that animation source
+only contains animation for a subset of a Skeleton’s joints.
+Declaration
+uniform matrix4d[] restTransforms
+C++ Type
+VtArray<GfMatrix4d>
+Usd Type
+SdfValueTypeNames->Matrix4dArray
+Variability
+SdfVariabilityUniform
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+class pxr.UsdSkel.SkeletonQuery
+Primary interface to reading bound skeleton data. This is used to
+query properties such as resolved transforms and animation bindings,
+as bound through the UsdSkelBindingAPI.
+A UsdSkelSkeletonQuery can not be constructed directly, and instead
+must be constructed through a UsdSkelCache instance. This is done as
+follows:
+// Global cache, intended to persist.
+UsdSkelCache skelCache;
+// Populate the cache for a skel root.
+skelCache.Populate(UsdSkelRoot(skelRootPrim));
+
+if (UsdSkelSkeletonQuery skelQuery = skelCache.GetSkelQuery(skelPrim)) {
+    \.\.\.
+}
+
+Methods:
+
+ComputeJointLocalTransforms(xforms, time, atRest)
+Compute joint transforms in joint-local space, at time .
+
+ComputeJointRestRelativeTransforms(xforms, time)
+Compute joint transforms which, when concatenated against the rest pose, produce joint transforms in joint-local space.
+
+ComputeJointSkelTransforms(xforms, time, atRest)
+Compute joint transforms in skeleton space, at time .
+
+ComputeJointWorldTransforms(xforms, xfCache, ...)
+Compute joint transforms in world space, at whatever time is configured on xfCache .
+
+ComputeSkinningTransforms(xforms, time)
+Compute transforms representing the change in transformation of a joint from its rest pose, in skeleton space.
+
+GetAnimQuery()
+Returns the animation query that provides animation for the bound skeleton instance, if any.
+
+GetJointOrder()
+Returns an array of joint paths, given as tokens, describing the order and parent-child relationships of joints in the skeleton.
+
+GetJointWorldBindTransforms(xforms)
+Returns the world space joint transforms at bind time.
+
+GetMapper()
+Returns a mapper for remapping from the bound animation, if any, to the Skeleton.
+
+GetPrim()
+Returns the underlying Skeleton primitive corresponding to the bound skeleton instance, if any.
+
+GetSkeleton()
+Returns the bound skeleton instance, if any.
+
+GetTopology()
+Returns the topology of the bound skeleton instance, if any.
+
+HasBindPose()
+Returns true if the size of the array returned by skeleton::GetBindTransformsAttr() matches the number of joints in the skeleton.
+
+HasRestPose()
+Returns true if the size of the array returned by skeleton::GetRestTransformsAttr() matches the number of joints in the skeleton.
+
+ComputeJointLocalTransforms(xforms, time, atRest) → bool
+Compute joint transforms in joint-local space, at time .
+This returns transforms in joint order of the skeleton. If atRest
+is false and an animation source is bound, local transforms defined by
+the animation are mapped into the skeleton’s joint order. Any
+transforms not defined by the animation source use the transforms from
+the rest pose as a fallback value. If valid transforms cannot be
+computed for the animation source, the xforms are instead set to
+the rest transforms.
+
+Parameters
+
+xforms (VtArray[Matrix4]) – 
+time (TimeCode) – 
+atRest (bool) – 
+
+ComputeJointRestRelativeTransforms(xforms, time) → bool
+Compute joint transforms which, when concatenated against the rest
+pose, produce joint transforms in joint-local space.
+More specifically, this computes restRelativeTransform in:
+restRelativeTransform \* restTransform = jointLocalTransform
+
+Parameters
+
+xforms (VtArray[Matrix4]) – 
+time (TimeCode) – 
+
+ComputeJointSkelTransforms(xforms, time, atRest) → bool
+Compute joint transforms in skeleton space, at time .
+This concatenates joint transforms as computed from
+ComputeJointLocalTransforms() . If atRest is true, any bound
+animation source is ignored, and transforms are computed from the rest
+pose. The skeleton-space transforms of the rest pose are cached
+internally.
+
+Parameters
+
+xforms (VtArray[Matrix4]) – 
+time (TimeCode) – 
+atRest (bool) – 
+
+ComputeJointWorldTransforms(xforms, xfCache, atRest) → bool
+Compute joint transforms in world space, at whatever time is
+configured on xfCache .
+This is equivalent to computing skel-space joint transforms with
+CmoputeJointSkelTransforms(), and then concatenating all transforms by
+the local-to-world transform of the Skeleton prim. If atRest is
+true, any bound animation source is ignored, and transforms are
+computed from the rest pose.
+
+Parameters
+
+xforms (VtArray[Matrix4]) – 
+xfCache (XformCache) – 
+atRest (bool) – 
+
+ComputeSkinningTransforms(xforms, time) → bool
+Compute transforms representing the change in transformation of a
+joint from its rest pose, in skeleton space.
+I.e.,
+inverse(bindTransform)\*jointTransform
+
+These are the transforms usually required for skinning.
+
+Parameters
+
+xforms (VtArray[Matrix4]) – 
+time (TimeCode) – 
+
+GetAnimQuery() → AnimQuery
+Returns the animation query that provides animation for the bound
+skeleton instance, if any.
+
+GetJointOrder() → TokenArray
+Returns an array of joint paths, given as tokens, describing the order
+and parent-child relationships of joints in the skeleton.
+UsdSkelSkeleton::GetJointOrder
+
+GetJointWorldBindTransforms(xforms) → bool
+Returns the world space joint transforms at bind time.
+
+Parameters
+xforms (VtArray[Matrix4]) – 
+
+GetMapper() → AnimMapper
+Returns a mapper for remapping from the bound animation, if any, to
+the Skeleton.
+
+GetPrim() → Prim
+Returns the underlying Skeleton primitive corresponding to the bound
+skeleton instance, if any.
+
+GetSkeleton() → Skeleton
+Returns the bound skeleton instance, if any.
+
+GetTopology() → Topology
+Returns the topology of the bound skeleton instance, if any.
+
+HasBindPose() → bool
+Returns true if the size of the array returned by
+skeleton::GetBindTransformsAttr() matches the number of joints in the
+skeleton.
+
+HasRestPose() → bool
+Returns true if the size of the array returned by
+skeleton::GetRestTransformsAttr() matches the number of joints in the
+skeleton.
+
+class pxr.UsdSkel.SkinningQuery
+Object used for querying resolved bindings for skinning.
+Methods:
+
+ComputeExtentsPadding(skelRestXforms, boundable)
+Helper for computing an approximate padding for use in extents computations.
+
+ComputeJointInfluences(indices, weights, time)
+Convenience method for computing joint influences.
+
+ComputeSkinnedPoints(xforms, points, time)
+Compute skinned points using linear blend skinning.
+
+ComputeSkinnedTransform(xforms, xform, time)
+Compute a skinning transform using linear blend skinning.
+
+ComputeVaryingJointInfluences(numPoints, ...)
+Convenience method for computing joint influence, where constant influences are expanded to hold values per point.
+
+GetBlendShapeMapper()
+Return the mapper for remapping blend shapes from the order of the bound SkelAnimation to the local blend shape order of this prim.
+
+GetBlendShapeOrder(blendShapes)
+Get the blend shapes for this skinning site, if any.
+
+GetBlendShapeTargetsRel()
+
+GetBlendShapesAttr()
+
+GetGeomBindTransform(time)
+
+param time
+
+GetGeomBindTransformAttr()
+
+GetInterpolation()
+
+GetJointIndicesPrimvar()
+
+GetJointMapper()
+Return a mapper for remapping from the joint order of the skeleton to the local joint order of this prim, if any.
+
+GetJointOrder(jointOrder)
+Get the custom joint order for this skinning site, if any.
+
+GetJointWeightsPrimvar()
+
+GetMapper()
+Deprecated
+
+GetNumInfluencesPerComponent()
+Returns the number of influences encoded for each component.
+
+GetPrim()
+
+GetSkinningBlendWeightsPrimvar()
+
+GetSkinningMethodAttr()
+
+GetTimeSamples(times)
+Populate times with the union of time samples for all properties that affect skinning, independent of joint transforms and any other prim-specific properties (such as points).
+
+GetTimeSamplesInInterval(interval, times)
+Populate times with the union of time samples within interval , for all properties that affect skinning, independent of joint transforms and any other prim-specific properties (such as points).
+
+HasBlendShapes()
+Returns true if there are blend shapes associated with this prim.
+
+HasJointInfluences()
+Returns true if joint influence data is associated with this prim.
+
+IsRigidlyDeformed()
+Returns true if the held prim has the same joint influences across all points, or false otherwise.
+
+ComputeExtentsPadding(skelRestXforms, boundable) → float
+Helper for computing an approximate padding for use in extents
+computations.
+The padding is computed as the difference between the pivots of the
+skelRestXforms skeleton space joint transforms at rest  and the
+extents of the skinned primitive. This is intended to provide a
+suitable, constant metric for padding joint extents as computed by
+UsdSkelComputeJointsExtent.
+
+Parameters
+
+skelRestXforms (VtArray[Matrix4]) – 
+boundable (Boundable) – 
+
+ComputeJointInfluences(indices, weights, time) → bool
+Convenience method for computing joint influences.
+In addition to querying influences, this will also perform validation
+of the basic form of the weight data  although the array contents is
+not validated.
+
+Parameters
+
+indices (IntArray) – 
+weights (FloatArray) – 
+time (TimeCode) – 
+
+ComputeSkinnedPoints(xforms, points, time) → bool
+Compute skinned points using linear blend skinning.
+Both xforms and points are given in skeleton space, using
+the joint order of the bound skeleton. Joint influences and the
+(optional) binding transform are computed at time time (which will
+typically be unvarying).
+UsdSkelSkeletonQuery::ComputeSkinningTransforms
+
+Parameters
+
+xforms (VtArray[Matrix4]) – 
+points (Vec3fArray) – 
+time (TimeCode) – 
+
+ComputeSkinnedTransform(xforms, xform, time) → bool
+Compute a skinning transform using linear blend skinning.
+The xforms are given in skeleton space, using the joint order of
+the bound skeleton. Joint influences and the (optional) binding
+transform are computed at time time (which will typically be
+unvarying). If this skinning query holds non-constant joint
+influences, no transform will be computed, and the function will
+return false.
+UsdSkelSkeletonQuery::ComputeSkinningTransforms
+
+Parameters
+
+xforms (VtArray[Matrix4]) – 
+xform (Matrix4) – 
+time (TimeCode) – 
+
+ComputeVaryingJointInfluences(numPoints, indices, weights, time) → bool
+Convenience method for computing joint influence, where constant
+influences are expanded to hold values per point.
+In addition to querying influences, this will also perform validation
+of the basic form of the weight data  although the array contents is
+not validated.
+
+Parameters
+
+numPoints (int) – 
+indices (IntArray) – 
+weights (FloatArray) – 
+time (TimeCode) – 
+
+GetBlendShapeMapper() → AnimMapper
+Return the mapper for remapping blend shapes from the order of the
+bound SkelAnimation to the local blend shape order of this prim.
+Returns a null reference if the underlying prim has no blend shapes.
+The mapper maps data from the order given by the blendShapes order
+on the SkelAnimation to the order given by the skel:blendShapes
+property, as set through the UsdSkelBindingAPI.
+
+GetBlendShapeOrder(blendShapes) → bool
+Get the blend shapes for this skinning site, if any.
+
+Parameters
+blendShapes (TokenArray) – 
+
+GetBlendShapeTargetsRel() → Relationship
+
+GetBlendShapesAttr() → Attribute
+
+GetGeomBindTransform(time) → Matrix4d
+
+Parameters
+time (TimeCode) – 
+
+GetGeomBindTransformAttr() → Attribute
+
+GetInterpolation() → str
+
+GetJointIndicesPrimvar() → Primvar
+
+GetJointMapper() → AnimMapper
+Return a mapper for remapping from the joint order of the skeleton to
+the local joint order of this prim, if any.
+Returns a null pointer if the prim has no custom joint orer. The
+mapper maps data from the order given by the joints order on the
+Skeleton to the order given by the skel:joints property, as
+optionally set through the UsdSkelBindingAPI.
+
+GetJointOrder(jointOrder) → bool
+Get the custom joint order for this skinning site, if any.
+
+Parameters
+jointOrder (TokenArray) – 
+
+GetJointWeightsPrimvar() → Primvar
+
+GetMapper() → AnimMapper
+Deprecated
+Use GetJointMapper.
+
+GetNumInfluencesPerComponent() → int
+Returns the number of influences encoded for each component.
+If the prim defines rigid joint influences, then this returns the
+number of influences that map to every point. Otherwise, this provides
+the number of influences per point.
+IsRigidlyDeformed
+
+GetPrim() → Prim
+
+GetSkinningBlendWeightsPrimvar() → Primvar
+
+GetSkinningMethodAttr() → Attribute
+
+GetTimeSamples(times) → bool
+Populate times with the union of time samples for all properties
+that affect skinning, independent of joint transforms and any other
+prim-specific properties (such as points).
+UsdAttribute::GetTimeSamples
+
+Parameters
+times (list[float]) – 
+
+GetTimeSamplesInInterval(interval, times) → bool
+Populate times with the union of time samples within interval
+, for all properties that affect skinning, independent of joint
+transforms and any other prim-specific properties (such as points).
+UsdAttribute::GetTimeSamplesInInterval
+
+Parameters
+
+interval (Interval) – 
+times (list[float]) – 
+
+HasBlendShapes() → bool
+Returns true if there are blend shapes associated with this prim.
+
+HasJointInfluences() → bool
+Returns true if joint influence data is associated with this prim.
+
+IsRigidlyDeformed() → bool
+Returns true if the held prim has the same joint influences across all
+points, or false otherwise.
+
+class pxr.UsdSkel.Tokens
+Attributes:
+
+bindTransforms
+
+blendShapeWeights
+
+blendShapes
+
+classicLinear
+
+dualQuaternion
+
+jointNames
+
+joints
+
+normalOffsets
+
+offsets
+
+pointIndices
+
+primvarsSkelGeomBindTransform
+
+primvarsSkelJointIndices
+
+primvarsSkelJointWeights
+
+primvarsSkelSkinningBlendWeights
+
+restTransforms
+
+rotations
+
+scales
+
+skelAnimationSource
+
+skelBlendShapeTargets
+
+skelBlendShapes
+
+skelJoints
+
+skelSkeleton
+
+skelSkinningMethod
+
+translations
+
+weight
+
+weightedBlend
+
+bindTransforms = 'bindTransforms'
+
+blendShapeWeights = 'blendShapeWeights'
+
+blendShapes = 'blendShapes'
+
+classicLinear = 'ClassicLinear'
+
+dualQuaternion = 'DualQuaternion'
+
+jointNames = 'jointNames'
+
+joints = 'joints'
+
+normalOffsets = 'normalOffsets'
+
+offsets = 'offsets'
+
+pointIndices = 'pointIndices'
+
+primvarsSkelGeomBindTransform = 'primvars:skel:geomBindTransform'
+
+primvarsSkelJointIndices = 'primvars:skel:jointIndices'
+
+primvarsSkelJointWeights = 'primvars:skel:jointWeights'
+
+primvarsSkelSkinningBlendWeights = 'primvars:skel:skinningBlendWeights'
+
+restTransforms = 'restTransforms'
+
+rotations = 'rotations'
+
+scales = 'scales'
+
+skelAnimationSource = 'skel:animationSource'
+
+skelBlendShapeTargets = 'skel:blendShapeTargets'
+
+skelBlendShapes = 'skel:blendShapes'
+
+skelJoints = 'skel:joints'
+
+skelSkeleton = 'skel:skeleton'
+
+skelSkinningMethod = 'skel:skinningMethod'
+
+translations = 'translations'
+
+weight = 'weight'
+
+weightedBlend = 'WeightedBlend'
+
+class pxr.UsdSkel.Topology
+Object holding information describing skeleton topology. This provides
+the hierarchical information needed to reason about joint
+relationships in a manner suitable to computations.
+Methods:
+
+GetNumJoints()
+
+GetParent(index)
+Returns the parent joint of the index'th joint, Returns -1 for joints with no parent (roots).
+
+GetParentIndices()
+
+IsRoot(index)
+Returns true if the index'th joint is a root joint.
+
+Validate(reason)
+Validate the topology.
+
+GetNumJoints() → int
+
+GetParent(index) → int
+Returns the parent joint of the index'th joint, Returns -1 for
+joints with no parent (roots).
+
+Parameters
+index (int) – 
+
+GetParentIndices() → IntArray
+
+IsRoot(index) → bool
+Returns true if the index'th joint is a root joint.
+
+Parameters
+index (int) – 
+
+Validate(reason) → bool
+Validate the topology.
+If validation is unsuccessful, a reason why will be written to
+reason , if provided.
+
+Parameters
+reason (str) – 
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

UsdUI.md

@@ -0,0 +1,622 @@
+
+
+UsdUI module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+UsdUI module
+
+ 
+
+# UsdUI module
+
+Summary: The UsdUI module provides schemas for encoding information on USD prims for client GUI tools to use in organizing/presenting prims in GUI layouts.
+
+Classes:
+
+Backdrop
+Provides a'group-box'for the purpose of node graph organization.
+
+NodeGraphNodeAPI
+This api helps storing information about nodes in node graphs.
+
+SceneGraphPrimAPI
+Utility schema for display properties of a prim
+
+Tokens
+
+class pxr.UsdUI.Backdrop
+Provides a’group-box’for the purpose of node graph organization.
+Unlike containers, backdrops do not store the Shader nodes inside of
+them. Backdrops are an organizational tool that allows Shader nodes to
+be visually grouped together in a node-graph UI, but there is no
+direct relationship between a Shader node and a Backdrop.
+The guideline for a node-graph UI is that a Shader node is considered
+part of a Backdrop when the Backdrop is the smallest Backdrop a Shader
+node’s bounding-box fits inside.
+Backdrop objects are contained inside a NodeGraph, similar to how
+Shader objects are contained inside a NodeGraph.
+Backdrops have no shading inputs or outputs that influence the
+rendered results of a NodeGraph. Therefore they can be safely ignored
+during import.
+Like Shaders and NodeGraphs, Backdrops subscribe to the
+NodeGraphNodeAPI to specify position and size.
+For any described attribute Fallback Value or Allowed Values
+below that are text/tokens, the actual token is published and defined
+in UsdUITokens. So to set an attribute to the value”rightHanded”, use
+UsdUITokens->rightHanded as the value.
+Methods:
+
+CreateDescriptionAttr(defaultValue, ...)
+See GetDescriptionAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Define
+classmethod Define(stage, path) -> Backdrop
+
+Get
+classmethod Get(stage, path) -> Backdrop
+
+GetDescriptionAttr()
+The text label that is displayed on the backdrop in the node graph.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+CreateDescriptionAttr(defaultValue, writeSparsely) → Attribute
+See GetDescriptionAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Define()
+classmethod Define(stage, path) -> Backdrop
+Attempt to ensure a UsdPrim adhering to this schema at path is
+defined (according to UsdPrim::IsDefined() ) on this stage.
+If a prim adhering to this schema at path is already defined on
+this stage, return that prim. Otherwise author an SdfPrimSpec with
+specifier == SdfSpecifierDef and this schema’s prim type name for
+the prim at path at the current EditTarget. Author SdfPrimSpec s
+with specifier == SdfSpecifierDef and empty typeName at the
+current EditTarget for any nonexistent, or existing but not Defined
+ancestors.
+The given path must be an absolute prim path that does not contain
+any variant selections.
+If it is impossible to author any of the necessary PrimSpecs, (for
+example, in case path cannot map to the current UsdEditTarget ‘s
+namespace) issue an error and return an invalid UsdPrim.
+Note that this method may return a defined prim whose typeName does
+not specify this schema class, in case a stronger typeName opinion
+overrides the opinion at the current EditTarget.
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+static Get()
+classmethod Get(stage, path) -> Backdrop
+Return a UsdUIBackdrop holding the prim adhering to this schema at
+path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdUIBackdrop(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetDescriptionAttr() → Attribute
+The text label that is displayed on the backdrop in the node graph.
+This help-description explains what the nodes in a backdrop do.
+Declaration
+uniform token ui:description
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+Variability
+SdfVariabilityUniform
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+class pxr.UsdUI.NodeGraphNodeAPI
+This api helps storing information about nodes in node graphs.
+For any described attribute Fallback Value or Allowed Values
+below that are text/tokens, the actual token is published and defined
+in UsdUITokens. So to set an attribute to the value”rightHanded���, use
+UsdUITokens->rightHanded as the value.
+Methods:
+
+Apply
+classmethod Apply(prim) -> NodeGraphNodeAPI
+
+CanApply
+classmethod CanApply(prim, whyNot) -> bool
+
+CreateDisplayColorAttr(defaultValue, ...)
+See GetDisplayColorAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateExpansionStateAttr(defaultValue, ...)
+See GetExpansionStateAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateIconAttr(defaultValue, writeSparsely)
+See GetIconAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreatePosAttr(defaultValue, writeSparsely)
+See GetPosAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateSizeAttr(defaultValue, writeSparsely)
+See GetSizeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateStackingOrderAttr(defaultValue, ...)
+See GetStackingOrderAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Get
+classmethod Get(stage, path) -> NodeGraphNodeAPI
+
+GetDisplayColorAttr()
+This hint defines what tint the node should have in the node graph.
+
+GetExpansionStateAttr()
+The current expansionState of the node in the ui.
+
+GetIconAttr()
+This points to an image that should be displayed on the node.
+
+GetPosAttr()
+Declared relative position to the parent in a node graph.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+GetSizeAttr()
+Optional size hint for a node in a node graph.
+
+GetStackingOrderAttr()
+This optional value is a useful hint when an application cares about the visibility of a node and whether each node overlaps another.
+
+static Apply()
+classmethod Apply(prim) -> NodeGraphNodeAPI
+Applies this single-apply API schema to the given prim .
+This information is stored by adding”NodeGraphNodeAPI”to the token-
+valued, listOp metadata apiSchemas on the prim.
+A valid UsdUINodeGraphNodeAPI object is returned upon success. An
+invalid (or empty) UsdUINodeGraphNodeAPI object is returned upon
+failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+prim (Prim) – 
+
+static CanApply()
+classmethod CanApply(prim, whyNot) -> bool
+Returns true if this single-apply API schema can be applied to the
+given prim .
+If this schema can not be a applied to the prim, this returns false
+and, if provided, populates whyNot with the reason it can not be
+applied.
+Note that if CanApply returns false, that does not necessarily imply
+that calling Apply will fail. Callers are expected to call CanApply
+before calling Apply if they want to ensure that it is valid to apply
+a schema.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+
+prim (Prim) – 
+whyNot (str) – 
+
+CreateDisplayColorAttr(defaultValue, writeSparsely) → Attribute
+See GetDisplayColorAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateExpansionStateAttr(defaultValue, writeSparsely) → Attribute
+See GetExpansionStateAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateIconAttr(defaultValue, writeSparsely) → Attribute
+See GetIconAttr() , and also Create vs Get Property Methods for when
+to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreatePosAttr(defaultValue, writeSparsely) → Attribute
+See GetPosAttr() , and also Create vs Get Property Methods for when to
+use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateSizeAttr(defaultValue, writeSparsely) → Attribute
+See GetSizeAttr() , and also Create vs Get Property Methods for when
+to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateStackingOrderAttr(defaultValue, writeSparsely) → Attribute
+See GetStackingOrderAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Get()
+classmethod Get(stage, path) -> NodeGraphNodeAPI
+Return a UsdUINodeGraphNodeAPI holding the prim adhering to this
+schema at path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdUINodeGraphNodeAPI(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetDisplayColorAttr() → Attribute
+This hint defines what tint the node should have in the node graph.
+Declaration
+uniform color3f ui:nodegraph:node:displayColor
+C++ Type
+GfVec3f
+Usd Type
+SdfValueTypeNames->Color3f
+Variability
+SdfVariabilityUniform
+
+GetExpansionStateAttr() → Attribute
+The current expansionState of the node in the ui.
+‘open’= fully expanded’closed’= fully collapsed’minimized’= should
+take the least space possible
+Declaration
+uniform token ui:nodegraph:node:expansionState
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+Variability
+SdfVariabilityUniform
+Allowed Values
+open, closed, minimized
+
+GetIconAttr() → Attribute
+This points to an image that should be displayed on the node.
+It is intended to be useful for summary visual classification of
+nodes, rather than a thumbnail preview of the computed result of the
+node in some computational system.
+Declaration
+uniform asset ui:nodegraph:node:icon
+C++ Type
+SdfAssetPath
+Usd Type
+SdfValueTypeNames->Asset
+Variability
+SdfVariabilityUniform
+
+GetPosAttr() → Attribute
+Declared relative position to the parent in a node graph.
+X is the horizontal position. Y is the vertical position. Higher
+numbers correspond to lower positions (coordinates are Qt style, not
+cartesian).
+These positions are not explicitly meant in pixel space, but rather
+assume that the size of a node is approximately 1.0x1.0. Where size-x
+is the node width and size-y height of the node. Depending on graph UI
+implementation, the size of a node may vary in each direction.
+Example: If a node’s width is 300 and it is position is at 1000, we
+store for x-position: 1000 * (1.0/300)
+Declaration
+uniform float2 ui:nodegraph:node:pos
+C++ Type
+GfVec2f
+Usd Type
+SdfValueTypeNames->Float2
+Variability
+SdfVariabilityUniform
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+GetSizeAttr() → Attribute
+Optional size hint for a node in a node graph.
+X is the width. Y is the height.
+This value is optional, because node size is often determined based on
+the number of in- and outputs of a node.
+Declaration
+uniform float2 ui:nodegraph:node:size
+C++ Type
+GfVec2f
+Usd Type
+SdfValueTypeNames->Float2
+Variability
+SdfVariabilityUniform
+
+GetStackingOrderAttr() → Attribute
+This optional value is a useful hint when an application cares about
+the visibility of a node and whether each node overlaps another.
+Nodes with lower stacking order values are meant to be drawn below
+higher ones. Negative values are meant as background. Positive values
+are meant as foreground. Undefined values should be treated as 0.
+There are no set limits in these values.
+Declaration
+uniform int ui:nodegraph:node:stackingOrder
+C++ Type
+int
+Usd Type
+SdfValueTypeNames->Int
+Variability
+SdfVariabilityUniform
+
+class pxr.UsdUI.SceneGraphPrimAPI
+Utility schema for display properties of a prim
+For any described attribute Fallback Value or Allowed Values
+below that are text/tokens, the actual token is published and defined
+in UsdUITokens. So to set an attribute to the value”rightHanded”, use
+UsdUITokens->rightHanded as the value.
+Methods:
+
+Apply
+classmethod Apply(prim) -> SceneGraphPrimAPI
+
+CanApply
+classmethod CanApply(prim, whyNot) -> bool
+
+CreateDisplayGroupAttr(defaultValue, ...)
+See GetDisplayGroupAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+CreateDisplayNameAttr(defaultValue, ...)
+See GetDisplayNameAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
+
+Get
+classmethod Get(stage, path) -> SceneGraphPrimAPI
+
+GetDisplayGroupAttr()
+When publishing a nodegraph or a material, it can be useful to provide an optional display group, for organizational purposes and readability.
+
+GetDisplayNameAttr()
+When publishing a nodegraph or a material, it can be useful to provide an optional display name, for readability.
+
+GetSchemaAttributeNames
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+
+static Apply()
+classmethod Apply(prim) -> SceneGraphPrimAPI
+Applies this single-apply API schema to the given prim .
+This information is stored by adding”SceneGraphPrimAPI”to the token-
+valued, listOp metadata apiSchemas on the prim.
+A valid UsdUISceneGraphPrimAPI object is returned upon success. An
+invalid (or empty) UsdUISceneGraphPrimAPI object is returned upon
+failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+prim (Prim) – 
+
+static CanApply()
+classmethod CanApply(prim, whyNot) -> bool
+Returns true if this single-apply API schema can be applied to the
+given prim .
+If this schema can not be a applied to the prim, this returns false
+and, if provided, populates whyNot with the reason it can not be
+applied.
+Note that if CanApply returns false, that does not necessarily imply
+that calling Apply will fail. Callers are expected to call CanApply
+before calling Apply if they want to ensure that it is valid to apply
+a schema.
+UsdPrim::GetAppliedSchemas()
+UsdPrim::HasAPI()
+UsdPrim::CanApplyAPI()
+UsdPrim::ApplyAPI()
+UsdPrim::RemoveAPI()
+
+Parameters
+
+prim (Prim) – 
+whyNot (str) – 
+
+CreateDisplayGroupAttr(defaultValue, writeSparsely) → Attribute
+See GetDisplayGroupAttr() , and also Create vs Get Property Methods
+for when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+CreateDisplayNameAttr(defaultValue, writeSparsely) → Attribute
+See GetDisplayNameAttr() , and also Create vs Get Property Methods for
+when to use Get vs Create.
+If specified, author defaultValue as the attribute’s default,
+sparsely (when it makes sense to do so) if writeSparsely is
+true - the default for writeSparsely is false .
+
+Parameters
+
+defaultValue (VtValue) – 
+writeSparsely (bool) – 
+
+static Get()
+classmethod Get(stage, path) -> SceneGraphPrimAPI
+Return a UsdUISceneGraphPrimAPI holding the prim adhering to this
+schema at path on stage .
+If no prim exists at path on stage , or if the prim at that
+path does not adhere to this schema, return an invalid schema object.
+This is shorthand for the following:
+UsdUISceneGraphPrimAPI(stage->GetPrimAtPath(path));
+
+Parameters
+
+stage (Stage) – 
+path (Path) – 
+
+GetDisplayGroupAttr() → Attribute
+When publishing a nodegraph or a material, it can be useful to provide
+an optional display group, for organizational purposes and
+readability.
+This is because often the usd shading hierarchy is rather flat while
+we want to display it in organized groups.
+Declaration
+uniform token ui:displayGroup
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+Variability
+SdfVariabilityUniform
+
+GetDisplayNameAttr() → Attribute
+When publishing a nodegraph or a material, it can be useful to provide
+an optional display name, for readability.
+Declaration
+uniform token ui:displayName
+C++ Type
+TfToken
+Usd Type
+SdfValueTypeNames->Token
+Variability
+SdfVariabilityUniform
+
+static GetSchemaAttributeNames()
+classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
+Return a vector of names of all pre-declared attributes for this
+schema class and all its ancestor classes.
+Does not include attributes that may be authored by custom/extended
+methods of the schemas involved.
+
+Parameters
+includeInherited (bool) – 
+
+class pxr.UsdUI.Tokens
+Attributes:
+
+closed
+
+minimized
+
+open
+
+uiDescription
+
+uiDisplayGroup
+
+uiDisplayName
+
+uiNodegraphNodeDisplayColor
+
+uiNodegraphNodeExpansionState
+
+uiNodegraphNodeIcon
+
+uiNodegraphNodePos
+
+uiNodegraphNodeSize
+
+uiNodegraphNodeStackingOrder
+
+closed = 'closed'
+
+minimized = 'minimized'
+
+open = 'open'
+
+uiDescription = 'ui:description'
+
+uiDisplayGroup = 'ui:displayGroup'
+
+uiDisplayName = 'ui:displayName'
+
+uiNodegraphNodeDisplayColor = 'ui:nodegraph:node:displayColor'
+
+uiNodegraphNodeExpansionState = 'ui:nodegraph:node:expansionState'
+
+uiNodegraphNodeIcon = 'ui:nodegraph:node:icon'
+
+uiNodegraphNodePos = 'ui:nodegraph:node:pos'
+
+uiNodegraphNodeSize = 'ui:nodegraph:node:size'
+
+uiNodegraphNodeStackingOrder = 'ui:nodegraph:node:stackingOrder'
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+

UsdUtils.md

@@ -0,0 +1,635 @@
+
+
+UsdUtils module — pxr-usd-api 105.1 documentation
+
+pxr-usd-api
+
+ »
+Modules »
+UsdUtils module
+
+ 
+
+# UsdUtils module
+
+Summary: The UsdUtils module contains utility classes and functions for managing, inspecting, editing, and creating USD Assets.
+
+Classes:
+
+CoalescingDiagnosticDelegate
+A class which collects warnings and statuses from the Tf diagnostic manager system in a thread safe manner.
+
+CoalescingDiagnosticDelegateItem
+An item used in coalesced results, containing a shared component: the file/function/line number, and a set of unshared components: the call context and commentary.
+
+CoalescingDiagnosticDelegateSharedItem
+The shared component in a coalesced result This type can be thought of as the key by which we coalesce our diagnostics.
+
+CoalescingDiagnosticDelegateUnsharedItem
+The unshared component in a coalesced result.
+
+ConditionalAbortDiagnosticDelegate
+A class that allows client application to instantiate a diagnostic delegate that can be used to abort operations for a non fatal USD error or warning based on immutable include exclude rules defined for this instance.
+
+ConditionalAbortDiagnosticDelegateErrorFilters
+A class which represents the inclusion exclusion filters on which errors will be matched stringFilters: matching and filtering will be done on explicit string of the error/warning codePathFilters: matching and filtering will be done on errors/warnings coming from a specific usd code path.
+
+RegisteredVariantSet
+Info for registered variant set
+
+SparseAttrValueWriter
+A utility class for authoring time-varying attribute values with simple run-length encoding, by skipping any redundant time-samples.
+
+SparseValueWriter
+Utility class that manages sparse authoring of a set of UsdAttributes.
+
+StageCache
+The UsdUtilsStageCache class provides a simple interface for handling a singleton usd stage cache for use by all USD clients.
+
+TimeCodeRange
+Represents a range of UsdTimeCode values as start and end time codes and a stride value.
+
+UsdStageStatsKeys
+
+class pxr.UsdUtils.CoalescingDiagnosticDelegate
+A class which collects warnings and statuses from the Tf diagnostic
+manager system in a thread safe manner.
+This class allows clients to get both the unfiltered results, as well
+as a compressed view which deduplicates diagnostic events by their
+source line number, function and file from which they occurred.
+Methods:
+
+DumpCoalescedDiagnosticsToStderr
+
+DumpCoalescedDiagnosticsToStdout
+
+DumpUncoalescedDiagnostics(ostr)
+Print all pending diagnostics without any coalescing to ostr .
+
+TakeCoalescedDiagnostics()
+Get all pending diagnostics in a coalesced form.
+
+TakeUncoalescedDiagnostics()
+Get all pending diagnostics without any coalescing.
+
+DumpCoalescedDiagnosticsToStderr()
+
+DumpCoalescedDiagnosticsToStdout()
+
+DumpUncoalescedDiagnostics(ostr) → None
+Print all pending diagnostics without any coalescing to ostr .
+This method clears the pending diagnostics.
+
+Parameters
+ostr (ostream) – 
+
+TakeCoalescedDiagnostics() → list[UsdUtilsCoalescingDiagnosticDelegate]
+Get all pending diagnostics in a coalesced form.
+This method clears the pending diagnostics.
+
+TakeUncoalescedDiagnostics() → list[TfDiagnosticBase]
+Get all pending diagnostics without any coalescing.
+This method clears the pending diagnostics.
+
+class pxr.UsdUtils.CoalescingDiagnosticDelegateItem
+An item used in coalesced results, containing a shared component: the
+file/function/line number, and a set of unshared components: the call
+context and commentary.
+Attributes:
+
+sharedItem
+
+unsharedItems
+
+property sharedItem
+
+property unsharedItems
+
+class pxr.UsdUtils.CoalescingDiagnosticDelegateSharedItem
+The shared component in a coalesced result This type can be thought of
+as the key by which we coalesce our diagnostics.
+Attributes:
+
+sourceFileName
+
+sourceFunction
+
+sourceLineNumber
+
+property sourceFileName
+
+property sourceFunction
+
+property sourceLineNumber
+
+class pxr.UsdUtils.CoalescingDiagnosticDelegateUnsharedItem
+The unshared component in a coalesced result.
+Attributes:
+
+commentary
+
+context
+
+property commentary
+
+property context
+
+class pxr.UsdUtils.ConditionalAbortDiagnosticDelegate
+A class that allows client application to instantiate a diagnostic
+delegate that can be used to abort operations for a non fatal USD
+error or warning based on immutable include exclude rules defined for
+this instance.
+These rules are regex strings where case sensitive matching is done on
+error/warning text or the location of the code path where the
+error/warning occured. Note that these rules will be respected only
+during the lifetime of the delegate. Include Rules determine what
+errors or warnings will cause a fatal abort. Exclude Rules determine
+what errors or warnings matched from the Include Rules should not
+cause the fatal abort. Example: to abort on all errors and warnings
+coming from”*pxr*”codepath but not
+from”*ConditionalAbortDiagnosticDelegate*”, a client can create
+the following delegate:
+UsdUtilsConditionalAbortDiagnosticDelegateErrorFilters includeFilters;
+UsdUtilsConditionalAbortDiagnosticDelegateErrorFilters excludeFilters;
+includeFilters.SetCodePathFilters({"\*pxr\*"});
+excludeFilters.SetCodePathFilters({"\*ConditionalAbortDiagnosticDelegate\*"});
+UsdUtilsConditionalAbortDiagnosticDelegate delegate =
+    UsdUtilsConditionalAbortDiagnosticDelegate(includeFilters,
+        excludeFilters);
+
+class pxr.UsdUtils.ConditionalAbortDiagnosticDelegateErrorFilters
+A class which represents the inclusion exclusion filters on which
+errors will be matched stringFilters: matching and filtering will be
+done on explicit string of the error/warning codePathFilters: matching
+and filtering will be done on errors/warnings coming from a specific
+usd code path.
+Methods:
+
+GetCodePathFilters()
+
+GetStringFilters()
+
+SetCodePathFilters(codePathFilters)
+
+param codePathFilters
+
+SetStringFilters(stringFilters)
+
+param stringFilters
+
+GetCodePathFilters() → list[str]
+
+GetStringFilters() → list[str]
+
+SetCodePathFilters(codePathFilters) → None
+
+Parameters
+codePathFilters (list[str]) – 
+
+SetStringFilters(stringFilters) → None
+
+Parameters
+stringFilters (list[str]) – 
+
+class pxr.UsdUtils.RegisteredVariantSet
+Info for registered variant set
+Classes:
+
+SelectionExportPolicy
+This specifies how the variantSet should be treated during export.
+
+Attributes:
+
+name
+
+selectionExportPolicy
+
+class SelectionExportPolicy
+This specifies how the variantSet should be treated during export.
+Note, in the plugInfo.json, the values for these enum’s are
+lowerCamelCase.
+Attributes:
+
+Always
+
+IfAuthored
+
+Never
+
+names
+
+values
+
+Always = pxr.UsdUtils.SelectionExportPolicy.Always
+
+IfAuthored = pxr.UsdUtils.SelectionExportPolicy.IfAuthored
+
+Never = pxr.UsdUtils.SelectionExportPolicy.Never
+
+names = {'Always': pxr.UsdUtils.SelectionExportPolicy.Always, 'IfAuthored': pxr.UsdUtils.SelectionExportPolicy.IfAuthored, 'Never': pxr.UsdUtils.SelectionExportPolicy.Never}
+
+values = {0: pxr.UsdUtils.SelectionExportPolicy.Never, 1: pxr.UsdUtils.SelectionExportPolicy.IfAuthored, 2: pxr.UsdUtils.SelectionExportPolicy.Always}
+
+property name
+
+property selectionExportPolicy
+
+class pxr.UsdUtils.SparseAttrValueWriter
+A utility class for authoring time-varying attribute values with
+simple run-length encoding, by skipping any redundant time-samples.
+Time-samples that are close enough to each other, with relative
+difference smaller than a fixed epsilon value are considered to be
+equivalent. This is to avoid unnecessary authoring of time-samples
+caused by numerical fuzz in certain computations.
+For vectors, matrices, and other composite types (like quaternions and
+arrays), each component is compared with the corresponding component
+for closeness. The chosen epsilon value for double precision floating
+point numbers is 1e-12. For single-precision, it is 1e-6 and for half-
+precision, it is 1e-2.
+Example c++ usage:
+UsdGeomSphere sphere = UsdGeomSphere::Define(stage, SdfPath("/Sphere"));
+UsdAttribute radius = sphere.CreateRadiusAttr();
+UsdUtilsSparseAttrValueWriter attrValueWriter(radius,
+        /\*defaultValue\*/ VtValue(1.0));
+attrValueWriter.SetTimeSample(VtValue(10.0), UsdTimeCode(1.0));
+attrValueWriter.SetTimeSample(VtValue(10.0), UsdTimeCode(2.0));
+attrValueWriter.SetTimeSample(VtValue(10.0), UsdTimeCode(3.0));
+attrValueWriter.SetTimeSample(VtValue(20.0), UsdTimeCode(4.0));
+
+Equivalent python example:
+sphere = UsdGeom.Sphere.Define(stage, Sdf.Path("/Sphere"))
+radius = sphere.CreateRadiusAttr()
+attrValueWriter = UsdUtils.SparseAttrValueWriter(radius, defaultValue=1.0)
+attrValueWriter.SetTimeSample(10.0, 1.0)
+attrValueWriter.SetTimeSample(10.0, 2.0)
+attrValueWriter.SetTimeSample(10.0, 3.0)
+attrValueWriter.SetTimeSample(20.0, 4.0)
+
+In the above examples, the specified default value of radius (1.0)
+will not be authored into scene description since it matches the
+fallback value. Additionally, the time-sample authored at time=2.0
+will be skipped since it is redundant. Also note that for correct
+behavior, the calls to SetTimeSample() must be made with sequentially
+increasing time values. If not, a coding error is issued and the
+authored animation may be incorrect.
+Methods:
+
+SetTimeSample(value, time)
+Sets a new time-sample on the attribute with given value at the given time .
+
+SetTimeSample(value, time) → bool
+Sets a new time-sample on the attribute with given value at the
+given time .
+The time-sample is only authored if it’s different from the previously
+set time-sample, in which case the previous time-sample is also
+authored, in order to to end the previous run of contiguous identical
+values and start a new run.
+This incurs a copy of value . Also, the value will be held in
+memory at least until the next time-sample is written or until the
+SparseAttrValueWriter instance is destroyed.
+
+Parameters
+
+value (VtValue) – 
+time (TimeCode) – 
+
+SetTimeSample(value, time) -> bool
+This is an overloaded member function, provided for convenience. It
+differs from the above function only in what argument(s) it accepts.
+For efficiency, this function swaps out the given value , leaving
+it empty.
+The value will be held in memory at least until the next time-sample
+is written or until the SparseAttrValueWriter instance is destroyed.
+
+Parameters
+
+value (VtValue) – 
+time (TimeCode) – 
+
+class pxr.UsdUtils.SparseValueWriter
+Utility class that manages sparse authoring of a set of UsdAttributes.
+It does this by maintaining a map of UsdAttributes to their
+corresponding UsdUtilsSparseAttrValueWriter objects.
+To use this class, simply instantiate an instance of it and invoke the
+SetAttribute() method with various attributes and their associated
+time-samples.
+If the attribute has a default value, SetAttribute() must be called
+with time=Default first (multiple times, if necessary), followed by
+calls to author time-samples in sequentially increasing time order.
+This class is not threadsafe. In general, authoring to a single USD
+layer from multiple threads isn’t threadsafe. Hence, there is little
+value in making this class threadsafe. Example c++ usage:
+UsdGeomCylinder cylinder = UsdGeomCylinder::Define(stage, SdfPath("/Cylinder"));
+UsdAttribute radius = cylinder.CreateRadiusAttr();
+UsdAttribute height = cylinder.CreateHeightAttr();
+UsdUtilsSparseValueWriter valueWriter;
+valueWriter.SetAttribute(radius, 2.0, UsdTimeCode::Default());
+valueWriter.SetAttribute(height, 2.0, UsdTimeCode::Default());
+
+valueWriter.SetAttribute(radius, 10.0, UsdTimeCode(1.0));
+valueWriter.SetAttribute(radius, 20.0, UsdTimeCode(2.0));
+valueWriter.SetAttribute(radius, 20.0, UsdTimeCode(3.0));
+valueWriter.SetAttribute(radius, 20.0, UsdTimeCode(4.0));
+
+valueWriter.SetAttribute(height, 2.0, UsdTimeCode(1.0));
+valueWriter.SetAttribute(height, 2.0, UsdTimeCode(2.0));
+valueWriter.SetAttribute(height, 3.0, UsdTimeCode(3.0));
+valueWriter.SetAttribute(height, 3.0, UsdTimeCode(4.0));
+
+Equivalent python code:
+cylinder = UsdGeom.Cylinder.Define(stage, Sdf.Path("/Cylinder"))
+radius = cylinder.CreateRadiusAttr()
+height = cylinder.CreateHeightAttr()
+valueWriter = UsdUtils.SparseValueWriter()
+valueWriter.SetAttribute(radius, 2.0, Usd.TimeCode.Default())
+valueWriter.SetAttribute(height, 2.0, Usd.TimeCode.Default())
+
+valueWriter.SetAttribute(radius, 10.0, 1.0)
+valueWriter.SetAttribute(radius, 20.0, 2.0)
+valueWriter.SetAttribute(radius, 20.0, 3.0)
+valueWriter.SetAttribute(radius, 20.0, 4.0)
+
+valueWriter.SetAttribute(height, 2.0, 1.0)
+valueWriter.SetAttribute(height, 2.0, 2.0)
+valueWriter.SetAttribute(height, 3.0, 3.0)
+valueWriter.SetAttribute(height, 3.0, 4.0)
+
+In the above example,
+
+The default value of the”height”attribute is not authored into
+scene description since it matches the fallback value.
+Time-samples at time=3.0 and time=4.0 will be skipped for the
+radius attribute.
+For the”height”attribute, the first timesample at time=1.0 will
+be skipped since it matches the default value.
+The last time-sample at time=4.0 will also be skipped
+for”height”since it matches the previously written value at time=3.0.
+
+Methods:
+
+GetSparseAttrValueWriters()
+Returns a new vector of UsdUtilsSparseAttrValueWriter populated from the attrValueWriter map.
+
+SetAttribute(attr, value, time)
+Sets the value of attr to value at time time .
+
+GetSparseAttrValueWriters() → list[SparseAttrValueWriter]
+Returns a new vector of UsdUtilsSparseAttrValueWriter populated from
+the attrValueWriter map.
+
+SetAttribute(attr, value, time) → bool
+Sets the value of attr to value at time time .
+The value is written sparsely, i.e., the default value is authored
+only if it is different from the fallback value or the existing
+default value, and any redundant time-samples are skipped when the
+attribute value does not change significantly between consecutive
+time-samples.
+
+Parameters
+
+attr (Attribute) – 
+value (VtValue) – 
+time (TimeCode) – 
+
+SetAttribute(attr, value, time) -> bool
+This is an overloaded member function, provided for convenience. It
+differs from the above function only in what argument(s) it accepts.
+For efficiency, this function swaps out the given value , leaving
+it empty.
+The value will be held in memory at least until the next time-sample
+is written or until the SparseAttrValueWriter instance is destroyed.
+
+Parameters
+
+attr (Attribute) – 
+value (VtValue) – 
+time (TimeCode) – 
+
+SetAttribute(attr, value, time) -> bool
+This is an overloaded member function, provided for convenience. It
+differs from the above function only in what argument(s) it accepts.
+
+Parameters
+
+attr (Attribute) – 
+value (T) – 
+time (TimeCode) – 
+
+class pxr.UsdUtils.StageCache
+The UsdUtilsStageCache class provides a simple interface for handling
+a singleton usd stage cache for use by all USD clients. This way code
+from any location can make use of the same cache to maximize stage
+reuse.
+Methods:
+
+Get
+classmethod Get() -> StageCache
+
+GetSessionLayerForVariantSelections
+classmethod GetSessionLayerForVariantSelections(modelName, variantSelections) -> Layer
+
+static Get()
+classmethod Get() -> StageCache
+Returns the singleton stage cache.
+
+static GetSessionLayerForVariantSelections()
+classmethod GetSessionLayerForVariantSelections(modelName, variantSelections) -> Layer
+Given variant selections as a vector of pairs (vector in case order
+matters to the client), constructs a session layer with overs on the
+given root modelName with the variant selections, or returns a cached
+session layer with those opinions.
+
+Parameters
+
+modelName (str) – 
+variantSelections (list[tuple[str, str]]) – 
+
+class pxr.UsdUtils.TimeCodeRange
+Represents a range of UsdTimeCode values as start and end time codes
+and a stride value.
+A UsdUtilsTimeCodeRange can be iterated to retrieve all time code
+values in the range. The range may be empty, it may contain a single
+time code, or it may represent multiple time codes from start to end.
+The interval defined by the start and end time codes is closed on both
+ends.
+Note that when constructing a UsdUtilsTimeCodeRange,
+UsdTimeCode::EarliestTime() and UsdTimeCode::Default() cannot be used
+as the start or end time codes. Also, the end time code cannot be less
+than the start time code for positive stride values, and the end time
+code cannot be greater than the start time code for negative stride
+values. Finally, the stride value cannot be zero. If any of these
+conditions are not satisfied, then an invalid empty range will be
+returned.
+Classes:
+
+Tokens
+
+Methods:
+
+CreateFromFrameSpec
+classmethod CreateFromFrameSpec(frameSpec) -> TimeCodeRange
+
+IsValid()
+Return true if this range contains one or more time codes, or false otherwise.
+
+empty()
+Return true if this range contains no time codes, or false otherwise.
+
+Attributes:
+
+endTimeCode
+TimeCode
+
+frameSpec
+
+startTimeCode
+TimeCode
+
+stride
+float
+
+class Tokens
+Attributes:
+
+EmptyTimeCodeRange
+
+RangeSeparator
+
+StrideSeparator
+
+EmptyTimeCodeRange = 'NONE'
+
+RangeSeparator = ':'
+
+StrideSeparator = 'x'
+
+static CreateFromFrameSpec()
+classmethod CreateFromFrameSpec(frameSpec) -> TimeCodeRange
+Create a time code range from frameSpec .
+A FrameSpec is a compact string representation of a time code range. A
+FrameSpec may contain up to three floating point values for the start
+time code, end time code, and stride values of a time code range.
+A FrameSpec containing just a single floating point value represents a
+time code range containing only that time code.
+A FrameSpec containing two floating point values separated by the
+range separator (‘:’) represents a time code range from the first
+value as the start time code to the second values as the end time
+code.
+A FrameSpec that specifies both a start and end time code value may
+also optionally specify a third floating point value as the stride,
+separating it from the first two values using the stride separator
+(‘x’).
+The following are examples of valid FrameSpecs: 123 101:105 105:101
+101:109x2 101:110x2 101:104x0.5
+An empty string corresponds to an invalid empty time code range.
+A coding error will be issued if the given string is malformed.
+
+Parameters
+frameSpec (str) – 
+
+IsValid() → bool
+Return true if this range contains one or more time codes, or false
+otherwise.
+
+empty() → bool
+Return true if this range contains no time codes, or false otherwise.
+
+property endTimeCode
+TimeCode
+Return the end time code of this range.
+
+Type
+type
+
+property frameSpec
+
+property startTimeCode
+TimeCode
+Return the start time code of this range.
+
+Type
+type
+
+property stride
+float
+Return the stride value of this range.
+
+Type
+type
+
+class pxr.UsdUtils.UsdStageStatsKeys
+Attributes:
+
+activePrimCount
+
+approxMemoryInMb
+
+assetCount
+
+inactivePrimCount
+
+instanceCount
+
+instancedModelCount
+
+modelCount
+
+primCounts
+
+primCountsByType
+
+primary
+
+prototypeCount
+
+prototypes
+
+pureOverCount
+
+totalInstanceCount
+
+totalPrimCount
+
+untyped
+
+usedLayerCount
+
+activePrimCount = 'activePrimCount'
+
+approxMemoryInMb = 'approxMemoryInMb'
+
+assetCount = 'assetCount'
+
+inactivePrimCount = 'inactivePrimCount'
+
+instanceCount = 'instanceCount'
+
+instancedModelCount = 'instancedModelCount'
+
+modelCount = 'modelCount'
+
+primCounts = 'primCounts'
+
+primCountsByType = 'primCountsByType'
+
+primary = 'primary'
+
+prototypeCount = 'prototypeCount'
+
+prototypes = 'prototypes'
+
+pureOverCount = 'pureOverCount'
+
+totalInstanceCount = 'totalInstanceCount'
+
+totalPrimCount = 'totalPrimCount'
+
+untyped = 'untyped'
+
+usedLayerCount = 'usedLayerCount'
+
+© Copyright 2019-2023, NVIDIA.
+      Last updated on Nov 14, 2023.
+      
+
+