pipeline
Pipeline tools for Ayon Substance Designer integration.
get_instances()
Return all instances stored in the project instances as a list
Source code in client/ayon_substancedesigner/api/pipeline.py
302 303 304 305 306 307 308 309 310 | |
imprint(current_package, name, namespace, context, loader, identifier, options=None)
Imprint a loaded container with metadata.
Containerisation enables a tracking of version, author and origin for loaded assets.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name | str | Name of resulting assembly | required |
namespace | str | Namespace under which to host container | required |
context | dict | Asset information | required |
loader | LoaderPlugin | loader instance used to produce container. | required |
identifier | str | SDResource identifier | required |
options | dict | options | None |
Returns:
| Type | Description |
|---|---|
| None |
Source code in client/ayon_substancedesigner/api/pipeline.py
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 | |
remove_container_metadata(container)
Helper method to remove the data for a specific container
Source code in client/ayon_substancedesigner/api/pipeline.py
248 249 250 251 252 253 254 255 256 257 | |
remove_instance(instance_id)
Helper method to remove the data for a specific container
Source code in client/ayon_substancedesigner/api/pipeline.py
292 293 294 295 296 297 298 299 | |
set_instance(instance_id, instance_data, update=False)
Helper method to directly set the data for a specific container
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
instance_id | str | Unique identifier for the instance | required |
instance_data | dict | The instance data to store in the metaadata. | required |
Source code in client/ayon_substancedesigner/api/pipeline.py
260 261 262 263 264 265 266 267 | |
set_instances(instance_data_by_id, update=False)
Store data for multiple instances at the same time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
instance_data_by_id | dict | instance data queried by id | required |
update | bool | whether the data needs update. Defaults to False. | False |
Source code in client/ayon_substancedesigner/api/pipeline.py
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 | |