plugin
LayoutLoader
Bases: Loader
Load Layout from a JSON file
Source code in client/ayon_unreal/api/plugin.py
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 |
|
Loader
Bases: LoaderPlugin
, ABC
This serves as skeleton for future Ayon specific functionality
Source code in client/ayon_unreal/api/plugin.py
272 273 274 |
|
UnrealActorCreator
Bases: UnrealBaseCreator
Base class for Unreal creator plugins based on actors.
Source code in client/ayon_unreal/api/plugin.py
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 261 262 263 264 265 266 267 268 269 |
|
create(product_name, instance_data, pre_create_data)
Create instance of the asset.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
product_name | str | Name of the product. | required |
instance_data | dict | Data for the instance. | required |
pre_create_data | dict | Data for the instance. | required |
Returns:
Name | Type | Description |
---|---|---|
CreatedInstance | Created instance. |
Source code in client/ayon_unreal/api/plugin.py
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 261 262 263 264 |
|
UnrealAssetCreator
Bases: UnrealBaseCreator
Base class for Unreal creator plugins based on assets.
Source code in client/ayon_unreal/api/plugin.py
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
|
create(product_name, instance_data, pre_create_data)
Create instance of the asset.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
product_name | str | Name of the product. | required |
instance_data | dict | Data for the instance. | required |
pre_create_data | dict | Data for the instance. | required |
Returns:
Name | Type | Description |
---|---|---|
CreatedInstance | Created instance. |
Source code in client/ayon_unreal/api/plugin.py
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
|
UnrealBaseAutoCreator
Bases: AutoCreator
, UnrealCreateLogic
Base class for Unreal auto creator plugins.
Source code in client/ayon_unreal/api/plugin.py
154 155 156 157 158 159 160 161 162 163 164 |
|
UnrealBaseCreator
Bases: UnrealCreateLogic
, Creator
Base class for Unreal creator plugins.
Source code in client/ayon_unreal/api/plugin.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
|
UnrealCreateLogic
Universal class for logic that Unreal creators could inherit from.
Source code in client/ayon_unreal/api/plugin.py
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_cached_instances(shared_data)
staticmethod
Cache instances for Creators to shared data.
Create unreal_cached_subsets
key when needed in shared data and fill it with all collected instances from the scene under its respective creator identifiers.
If legacy instances are detected in the scene, create unreal_cached_legacy_subsets
there and fill it with all legacy subsets under product_type as a key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
Dict[str, | Any] | Shared data. | required |
Return
Dict[str, Any]: Shared data dictionary.
Source code in client/ayon_unreal/api/plugin.py
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 |
|