ayon_usd
USD Addon for AYON - client part.
USDAddon
Bases: AYONAddon, ITrayAddon, IPluginPaths
Addon to add USD Support to AYON.
Addon can also skip distribution of binaries from server and can use path/arguments defined by server.
Cares about supplying USD Framework.
Source code in client/ayon_usd/addon.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | |
get_launch_hook_paths()
Get paths to launch hooks.
Source code in client/ayon_usd/addon.py
58 59 60 | |
initialize(studio_settings)
Initialize USD Addon.
Source code in client/ayon_usd/addon.py
39 40 41 | |
tray_exit()
Exit tray module.
Source code in client/ayon_usd/addon.py
50 51 52 | |
tray_init()
Initialize tray module.
Source code in client/ayon_usd/addon.py
35 36 37 | |
tray_menu(tray_menu)
Add menu items to tray menu.
Source code in client/ayon_usd/addon.py
54 55 56 | |
tray_start()
Start tray module.
Download USD if needed.
Source code in client/ayon_usd/addon.py
43 44 45 46 47 48 | |
extract_zip_file(progress_item, zip_file_path, dest_dir)
Extract a zip file to a destination directory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
zip_file_path | str | The path to the zip file. | required |
dest_dir | str | The directory where the zip file should be extracted. | required |
Source code in client/ayon_usd/ayon_bin_client/ayon_bin_distro/util/zip.py
6 7 8 9 10 11 12 13 14 15 16 17 18 | |
get_download_dir(create_if_missing=True)
Dir path where files are downloaded.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
create_if_missing | bool | Create dir if missing. | True |
Returns:
| Name | Type | Description |
|---|---|---|
str | Path to download dir. |
Source code in client/ayon_usd/utils.py
18 19 20 21 22 23 24 25 26 27 28 29 30 | |
get_usd_pinning_envs(instance)
Get USD pinning file path from published representations.
This sets the rootless path to the USD pinning file and enables the static global cache. It is not setting PROJECT_ROOTS because they are platform dependent and on farm they need to be set on task level.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
instance | Instance | Published representations. | required |
Returns:
| Name | Type | Description |
|---|---|---|
dict | dict | environment variables needed for USD pinning. |
Source code in client/ayon_usd/utils.py
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 | |