api
 HoudiniHost 
  Bases: HostBase, IWorkfileHost, ILoadHost, IPublishHost
Source code in client/ayon_houdini/api/pipeline.py
 | 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 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 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |  | 
 create_context_node()  staticmethod  
 Helper for creating context holding node.
Returns:
| Type | Description | 
|---|---|
| hou.Node: context node | 
Source code in client/ayon_houdini/api/pipeline.py
 | 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |  | 
 containerise(name, namespace, nodes, context, loader=None, suffix='') 
 Bundle nodes into a subnet and imprint it with metadata
Containerisation enables a tracking of version, author and origin for loaded products.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| name | str | Name of resulting assembly | required | 
| namespace | str | Namespace under which to host container | required | 
| nodes | list | Long names of nodes to containerise | required | 
| context | dict | Loaded product context information | required | 
| loader | str | Name of loader used to produce this container. | None | 
| suffix | str | Suffix of container, defaults to  | '' | 
Returns:
| Name | Type | Description | 
|---|---|---|
| container | str | Name of container assembly | 
Source code in client/ayon_houdini/api/pipeline.py
 | 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 283 284 285 286 287 288 289 |  | 
 lsattr(attr, value=None, root='/') 
 Return nodes that have attr When value is not None it will only return nodes matching that value for the given attribute. Args: attr (str): Name of the attribute (hou.Parm) value (object, Optional): The value to compare the attribute too. When the default None is provided the value check is skipped. root (str): The root path in Houdini to search in. Returns: list: Matching nodes that have attribute with value.
Source code in client/ayon_houdini/api/lib.py
 | 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 |  | 
 lsattrs(attrs, root='/') 
 Return nodes matching key and value Arguments: attrs (dict): collection of attribute: value root (str): The root path in Houdini to search in. Example: >> lsattrs({"id": "myId"}) ["myNode"] >> lsattr("id") ["myNode", "myOtherNode"] Returns: list: Matching nodes that have attribute with value.
Source code in client/ayon_houdini/api/lib.py
 | 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 |  | 
 maintained_selection() 
 Maintain selection during context Example: >>> with maintained_selection(): ... # Modify selection ... node.setSelected(on=False, clear_all_selected=True) >>> # Selection restored
Source code in client/ayon_houdini/api/lib.py
 | 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 |  | 
 read(node) 
 Read the container data in to a dict
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
| node | Node | Houdini node | required | 
Returns:
| Type | Description | 
|---|---|
| dict | 
Source code in client/ayon_houdini/api/lib.py
 | 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 |  |