plugin_load
add_override(loaded_collection)
Add overrides for the loaded armatures.
Source code in client/ayon_blender/api/plugin_load.py
16 17 18 19 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 | |
find_collection_by_name(target_name)
Find a collection by name, handling name collision suffixes (e.g. "MyColl.001").
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
target_name | str | The target collection name to search for. | required |
Returns:
| Type | Description |
|---|---|
| bpy.types.Collection or None: The found collection or None. |
Source code in client/ayon_blender/api/plugin_load.py
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 | |
find_objects_by_name(target_name)
Find an object by name, handling name collision suffixes (e.g. "MyColl.001").
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
target_name | str | The target object name to search for. | required |
Returns:
| Type | Description |
|---|---|
| bpy.types.Object or None: The found object or None. |
Source code in client/ayon_blender/api/plugin_load.py
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | |
get_local_collection(overridden_collections, loaded_collection)
Get the local (overridden) collection.
To get it we check all collections with a library override and check if they have the loaded collection as their reference. If a collection is not in the provided (known) override collections, we assume it's the newly created one.
Source code in client/ayon_blender/api/plugin_load.py
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 | |
get_overridden_collections_from_reference_collection(reference_collection)
Get collections that are overridden versions of the reference collection.
Yields:
| Type | Description |
|---|---|
Collection | All collections that have an override library and have the |
Collection |
|
Source code in client/ayon_blender/api/plugin_load.py
82 83 84 85 86 87 88 89 90 91 92 93 94 95 | |
link_collection(filepath, link=True, group_name=None, instance_collections=False, instance_object_data=False)
Load a collection to the scene using bpy.ops.wm.link (UI 1:1 behavior).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filepath | str | Path to the .blend file. | required |
link | bool | Whether to link or append the data. | True |
group_name | str | Name of the collection to load. | None |
instance_collections | bool | Whether to instance collections. | False |
instance_object_data | bool | Whether to instance object data. | False |
Returns: bpy.types.Collection: The loaded collection datablock.
Source code in client/ayon_blender/api/plugin_load.py
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 | |
load_collection(filepath, link=True, group_name=None)
Load a collection by bpy.data.libraries.load to the scene.
Source code in client/ayon_blender/api/plugin_load.py
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 | |