project_creation
add_graphs_to_package(parsed_graph_names, parsed_dependencies, temp_package_filepath)
Add graphs to the temp package
Parameters:
Name | Type | Description | Default |
---|---|---|---|
parsed_graph_names | list | parsed graph names | required |
parsed_dependencies | list | parsed dependencies | required |
temp_package_filepath | str | temp package filepath | required |
Source code in client/ayon_substancedesigner/api/project_creation.py
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 |
|
create_project_with_from_template(project_settings=None)
Create Project from template setting
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_settings | str | project settings. Defaults to None. | None |
Source code in client/ayon_substancedesigner/api/project_creation.py
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 205 206 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 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 270 271 272 273 274 275 276 277 278 279 280 281 282 |
|
create_tmp_package_for_template(sd_pkg_mgr, project_name)
Create temp substance package for template graph
Parameters:
Name | Type | Description | Default |
---|---|---|---|
sd_pkg_mgr | SDPackageMgr | package manager | required |
project_name | str | project_name | required |
Returns:
Type | Description |
---|---|
sd.api.sdpackage.SDPackage, str: SD Package and template file path |
Source code in client/ayon_substancedesigner/api/project_creation.py
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
|
get_template_filename_from_project(resources_dir, project_template)
Get template filename from ayon project settings
Parameters:
Name | Type | Description | Default |
---|---|---|---|
resources_dir | SDApplicationPath | resources dir | required |
project_template | str | project template name | required |
Returns:
Name | Type | Description |
---|---|---|
str | absolute filepath of the sbs template file. |
Source code in client/ayon_substancedesigner/api/project_creation.py
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 |
|
parse_dependencies_from_template(template_filepath)
Parse dependencies from Substance template file
Parameters:
Name | Type | Description | Default |
---|---|---|---|
template_filepath | str | Substance template filepath | required |
Returns:
Type | Description |
---|---|
List[xml.etree.ElementTree.Element]: dependencies from the select template |
Source code in client/ayon_substancedesigner/api/project_creation.py
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
|
parse_graph_from_template(graph_name, project_template, template_filepath)
Parse graph by project template name from Substance template file Args: graph_name (str): graph_name project_template (str): project template name template_filepath (str): Substance template filepath
Returns:
Type | Description |
---|---|
List[xml.etree.ElementTree.Element]: graph(s) from the select template |
Source code in client/ayon_substancedesigner/api/project_creation.py
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 |
|
resolve_template_path(path, project_name, folder_entity, task_entity)
resolve template path for Substance files
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path | _type_ | template path to resolve | required |
project_name | str | project name | required |
folder_entity | dict | folder entity data | required |
task_name | str | task name | required |
Returns:
Name | Type | Description |
---|---|---|
str | resolved path for Substance template file |
Source code in client/ayon_substancedesigner/api/project_creation.py
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 |
|
set_output_resolution_by_graphs(resolution_size_by_graphs)
Set output resolution per graph accordingly to Ayon settings
Parameters:
Name | Type | Description | Default |
---|---|---|---|
package | SDPackage | temp package for graphs | required |
resolution_size_by_graphs | dict | resolution data for each graph | required |
Source code in client/ayon_substancedesigner/api/project_creation.py
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 |
|