lib
add_cache_file(path)
Add new CacheFile datablock.
bpy.ops.cachefile.open does not return the new cache file. As such, we need to query what was there before and using that find out what's new
Source code in client/ayon_blender/api/lib.py
688 689 690 691 692 693 694 695 696 697 698 699 700 | |
append_user_scripts()
Apply user scripts to Blender.
This was originally used for early Blender 4 versions due to requiring AYON to be sources from BLENDER_USER_SCRIPTS paths which unfortunately allowed only a single path, and it had the side effect of not loading the default user scripts anymore.
In Blender 5+ this is irrelevant and instead additional Script Directories can be configured and used instead.
Source code in client/ayon_blender/api/lib.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | |
attribute_overrides(obj, attribute_values)
Apply attribute or property overrides during context.
Supports nested/deep overrides, that is also why it does not use **kwargs as function arguments because it requires the keys to support dots (.).
Example
with attribute_overrides(scene, { ... "render.fps": 30, ... "frame_start": 1001} ... ): ... print(scene.render.fps) ... print(scene.frame_start)
30
1001
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
obj | Any | The object to set attributes and properties on. | required |
attribute_values | (dict[str, Any]): The property names mapped to the values that will be applied during the context. | required |
Source code in client/ayon_blender/api/lib.py
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 | |
clean_filename(filename)
Clean filename from characters which has reached more than maximum 63 characters. It would be removed after fully supporting blender 5.0, because blender 5.0 supports up to 255 characters for the name.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename | str | The filename to clean. | required |
Returns: str: The cleaned filename.
Source code in client/ayon_blender/api/lib.py
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 | |
collect_animation_defs(create_context, step=True, fps=False)
Get the basic animation attribute definitions for the publisher.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
create_context | CreateContext | The context of publisher will be used to define the defaults for the attributes to use the current context's entity frame range as default values. | required |
step | bool | Whether to include | True |
fps | bool | Whether to include | False |
Returns:
| Type | Description |
|---|---|
| List[NumberDef]: List of number attribute definitions. |
Source code in client/ayon_blender/api/lib.py
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 | |
create_animation_instance(rig)
Create animation instances for the given rigs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
rig | Union[Collection, Object] | Rig to create | required |
Source code in client/ayon_blender/api/lib.py
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 | |
get_all_parents(obj)
Get all recursive parents of object.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
obj | Object | Object to get all parents for. | required |
Returns:
| Type | Description |
|---|---|
| List[bpy.types.Object]: All parents of object |
Source code in client/ayon_blender/api/lib.py
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 | |
get_blender_version()
Get Blender Version
Source code in client/ayon_blender/api/lib.py
703 704 705 706 707 | |
get_highest_root(objects)
Get the highest object (the least parents) among the objects.
If multiple objects have the same amount of parents (or no parents) the first object found in the input iterable will be returned.
Note that this will not return objects outside of the input list, as such it will not return the root of node from a child node. It is purely intended to find the highest object among a list of objects. To instead get the root from one object use, e.g. get_all_parents(obj)[-1]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
objects | List[Object] | Objects to find the highest root in. | required |
Returns:
| Type | Description |
|---|---|
| Optional[bpy.types.Object]: First highest root found or None if no |
Source code in client/ayon_blender/api/lib.py
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 | |
get_scene_node_tree(ensure_exists=False)
Return the node tree
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ensure_exists | bool | When enabled, make sure a compositor node tree is enabled and set. | False |
Source code in client/ayon_blender/api/lib.py
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 | |
get_selected_collections()
Returns a list of the currently selected collections in the outliner.
Raises:
| Type | Description |
|---|---|
RuntimeError | If the outliner cannot be found in the main Blender |
Returns:
| Name | Type | Description |
|---|---|---|
list | A list of | |
| selected in the outliner. |
Source code in client/ayon_blender/api/lib.py
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 | |
get_selection(include_collections=False)
Returns a list of selected objects in the current Blender scene.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
include_collections | bool | Whether to include selected | False |
Returns:
| Type | Description |
|---|---|
List[Object] | List[bpy.types.Object]: A list of selected objects. |
Source code in client/ayon_blender/api/lib.py
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 | |
get_upstream_viewlayers(node)
Get view layer nodes connected to a CompositorNodeOutputFile node.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
node | CompositorNodeOutputFile | The output file node to check. | required |
Returns:
| Type | Description |
|---|---|
set[str] | set[str]: A set of view layer names connected to the output file node. |
Source code in client/ayon_blender/api/lib.py
349 350 351 352 353 354 355 356 357 358 359 360 361 362 | |
has_users(cache)
Check if a cache file has users.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cache | CacheFile | Cache File from datablock | required |
Returns:
| Name | Type | Description |
|---|---|---|
bool | bool | True if the cache has users, False otherwise. |
Source code in client/ayon_blender/api/lib.py
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 | |
imprint(node, data)
Write data to node as userDefined attributes
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
node | bpy_struct_meta_idprop | Long name of node | required |
data | Dict | Dictionary of key/value pairs | required |
Example
import bpy def compute(): ... return 6 ... bpy.ops.mesh.primitive_cube_add() cube = bpy.context.view_layer.objects.active imprint(cube, { ... "regularString": "myFamily", ... "computedValue": lambda: compute() ... }) ... cube['ayon']['computedValue'] 6
Source code in client/ayon_blender/api/lib.py
182 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 | |
iter_bpy_prop_collection_idprop()
Iterate over all Blender property collections.
See
https://docs.blender.org/api/current/bpy.types.bpy_prop_collection_idprop.html
Source code in client/ayon_blender/api/lib.py
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 | |
iter_images_in_node_tree(tree)
Iterate over all images in a node tree, including nested node groups.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tree | NodeTree | The node tree to iterate over. | required |
Yields:
| Type | Description |
|---|---|
| bpy.types.Image: Images found in the node tree. |
Source code in client/ayon_blender/api/lib.py
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 | |
iter_viewlayer_nodes(node)
Iterate through all Render Layers nodes connected to a File Output node.
Traverses through all input connections, following through intermediate nodes (like Mix, Composite, etc.) to find all connected Render Layers nodes. Uses an iterative stack-based approach with a set to track processed nodes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
node | CompositorNodeOutputFile | A CompositorNodeOutputFile node to find connected Render Layers nodes from | required |
Yields:
| Type | Description |
|---|---|
| bpy.types.CompositorNodeRLayers: Each connected Render Layers node |
Source code in client/ayon_blender/api/lib.py
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 | |
load_scripts(paths)
Copy of load_scripts from Blender's implementation.
It is possible that this function will be changed in future and usage will be based on Blender version.
This does not work in Blender 5+ due to bpy_types being unavailable. But usually this is not needed for Blender 5+ anyway, because it does allow better user scripts management through environment variables than older releases of Blender.
Source code in client/ayon_blender/api/lib.py
20 21 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 | |
lsattr(attr, value=None)
Return nodes matching attr and value
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
attr | str | Name of Blender property | required |
value | Union[str, int, bool, List, Dict, None] | Value of attribute. If none is provided, return all nodes with this attribute. | None |
Example
lsattr("id", "myId") ... [bpy.data.objects["myNode"] lsattr("id") ... [bpy.data.objects["myNode"], bpy.data.objects["myOtherNode"]]
Returns:
| Type | Description |
|---|---|
List | list |
Source code in client/ayon_blender/api/lib.py
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 | |
lsattrs(attrs)
Return nodes with the given attribute(s).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
attrs | Dict | Name and value pairs of expected matches | required |
Example
lsattrs({"age": 5}) # Return nodes with an
ageof 5
Return nodes with both age and color of 5 and blue
lsattrs({"age": 5, "color": "blue"})
Returns a list.
Source code in client/ayon_blender/api/lib.py
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 270 271 272 273 274 275 276 277 | |
maintained_selection()
Maintain selection during context
Example
with maintained_selection(): ... # Modify selection ... bpy.ops.object.select_all(action='DESELECT')
Selection restored
Source code in client/ayon_blender/api/lib.py
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 | |
maintained_time()
Maintain current frame during context.
Source code in client/ayon_blender/api/lib.py
487 488 489 490 491 492 493 494 | |
make_material_image_paths_absolute(material_datablocks)
Make image paths in materials absolute during context.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
material_datablocks | set[Material] | material datablocks to make image paths absolute for during context | required |
Source code in client/ayon_blender/api/lib.py
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 | |
packed_images(datablocks, logger=None)
Unpack packed images during context This will pack all unpacked images found in the given datablocks, and unpack them back when exiting the context.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
datablocks | set | Datablocks to search for unpacked images. | required |
logger | Logger | Logger to use for warnings if packing fails. | None |
Source code in client/ayon_blender/api/lib.py
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 | |
read(node)
Return user-defined attributes from node
Source code in client/ayon_blender/api/lib.py
280 281 282 283 284 285 286 287 288 289 290 291 | |
search_replace_render_paths(src, dest)
Search and replace render paths in the current scene.
This function searches for all render paths in the current scene and replaces them with a new path defined by the user.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
src | str | Search text to replace. | required |
dest | str | Replacement text for the search. | required |
Returns:
| Name | Type | Description |
|---|---|---|
bool | bool | True if any changes were made, False otherwise. |
Source code in client/ayon_blender/api/lib.py
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 | |
strip_container_data(containers)
Remove container data during context
Source code in client/ayon_blender/api/lib.py
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 | |
strip_instance_data(node)
Remove instance data during context
Source code in client/ayon_blender/api/lib.py
729 730 731 732 733 734 735 736 737 738 | |
strip_namespace(containers)
Strip namespace during context This context manager is only valid for blender version elder than 5.0. This would be deprecated after the blender 5.0.
Source code in client/ayon_blender/api/lib.py
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 | |
update_content_on_context_change()
This will update scene content to match new folder on context change
Source code in client/ayon_blender/api/lib.py
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 | |