api
API for the Equalizer plugin.
Container dataclass
Container data class.
Source code in client/ayon_equalizer/api/pipeline.py
9 10 11 12 13 14 15 16 17 18 19 20 | |
EqualizerCreator
Bases: Creator
Base class for creating instances in 3DEqualizer.
Source code in client/ayon_equalizer/api/plugin.py
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 | |
collect_instances()
Collect instances from the host application.
Returns:
| Type | Description |
|---|---|
None | list[openpype.pipeline.CreatedInstance]: List of instances. |
Source code in client/ayon_equalizer/api/plugin.py
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 | |
create(product_name, instance_data, pre_create_data)
Create a subset in the host application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
product_name | str | Name of the subset to create. | required |
instance_data | dict | Data of the instance to create. | required |
pre_create_data | dict | Data from the pre-create step. | required |
Returns:
| Type | Description |
|---|---|
CreatedInstance | ayon_core.pipeline.CreatedInstance: Created instance. |
Source code in client/ayon_equalizer/api/plugin.py
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 | |
remove_instances(instances)
Remove instances from the host application.
Source code in client/ayon_equalizer/api/plugin.py
102 103 104 105 106 107 | |
update_instances(update_list)
Update instances in the host application.
Source code in client/ayon_equalizer/api/plugin.py
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 | |
EqualizerHost
Bases: HostBase, IWorkfileHost, ILoadHost, IPublishHost
3DEqualizer host implementation.
Source code in client/ayon_equalizer/api/host.py
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 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 283 284 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 348 349 350 351 | |
__init__()
Initialize the host.
Source code in client/ayon_equalizer/api/host.py
77 78 79 80 | |
__new__()
Singleton implementation.
Source code in client/ayon_equalizer/api/host.py
68 69 70 71 72 73 74 75 | |
add_container(container)
Add a container to the current workfile.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
container | Container | Container to add. | required |
Source code in client/ayon_equalizer/api/host.py
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | |
add_publish_instance(instance_data)
Add a publish instance to the current project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
instance_data | dict | Publish instance to add. | required |
Source code in client/ayon_equalizer/api/host.py
252 253 254 255 256 257 258 259 260 261 262 263 264 | |
get_ayon_data()
Get AYON context data from the current project.
3Dequalizer doesn't have any custom node or other place to store metadata, so we store context data in the project notes encoded as JSON and wrapped in a special guard string AYON_CONTEXT::...::AYON_CONTEXT_END.
Returns:
| Name | Type | Description |
|---|---|---|
dict | dict | Context data. |
Source code in client/ayon_equalizer/api/host.py
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 | |
get_containers()
Get containers from the current workfile.
Source code in client/ayon_equalizer/api/host.py
126 127 128 129 130 131 132 133 134 135 | |
get_context_data()
Get context data from the current project.
Source code in client/ayon_equalizer/api/host.py
223 224 225 226 227 | |
get_current_workfile()
Return the current workfile path.
Source code in client/ayon_equalizer/api/host.py
122 123 124 | |
get_host() classmethod
Get the host instance.
Source code in client/ayon_equalizer/api/host.py
344 345 346 347 | |
get_main_window()
Get the main window of the host application.
Source code in client/ayon_equalizer/api/host.py
349 350 351 | |
get_publish_instances()
Get publish instances from the current project.
Source code in client/ayon_equalizer/api/host.py
247 248 249 250 | |
get_workfile_extensions()
Return the workfile extensions for 3DEqualizer.
Source code in client/ayon_equalizer/api/host.py
93 94 95 | |
install()
Install the host.
Source code in client/ayon_equalizer/api/host.py
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 | |
open_workfile(filepath)
Open a workfile in 3DEqualizer.
Source code in client/ayon_equalizer/api/host.py
113 114 115 116 117 118 119 120 | |
remove_create_instance(instance_id)
Remove a publish instance from the current project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
instance_id | str | Publish instance id to remove. | required |
Source code in client/ayon_equalizer/api/host.py
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 | |
save_workfile(dst_path=None)
Save the current workfile.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dst_path | str | Destination path to save the workfile. | None |
Source code in client/ayon_equalizer/api/host.py
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 | |
update_ayon_data(data)
Update AYON context data in the current project.
Serialize context data as json and store it in the project notes. If the context data is not found, create a placeholder there. See get_context_data for more info.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data | dict | Context data. | required |
Source code in client/ayon_equalizer/api/host.py
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 | |
update_context_data(data, changes)
Update context data in the current project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data | dict | Context data. | required |
changes | dict | Changes to the context data. | required |
Raises:
| Type | Description |
|---|---|
RuntimeError | If the context data is not found. |
Source code in client/ayon_equalizer/api/host.py
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 | |
update_publish_instance(instance_id, data)
Update a publish instance in the current project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
instance_id | str | Publish instance id to update. | required |
data | dict | Data to update. | required |
Source code in client/ayon_equalizer/api/host.py
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | |
workfile_has_unsaved_changes()
Return the state of the current workfile.
3DEqualizer returns state as 1 or zero, so we need to invert it.
Returns:
| Name | Type | Description |
|---|---|---|
bool | bool | True if the current workfile has unsaved changes. |
Source code in client/ayon_equalizer/api/host.py
82 83 84 85 86 87 88 89 90 91 | |
write_create_instances(instances)
Write publish instances to the current project.
Source code in client/ayon_equalizer/api/host.py
288 289 290 291 292 293 | |
ExtractScriptBase
Bases: OptionalPyblishPluginMixin
Base class for extract script plugins.
Source code in client/ayon_equalizer/api/plugin.py
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 | |
apply_settings(project_settings, system_settings) classmethod
Apply settings from the configuration.
Source code in client/ayon_equalizer/api/plugin.py
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | |
get_attribute_defs() classmethod
Get attribute definitions for the plugin.
Source code in client/ayon_equalizer/api/plugin.py
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 | |
maintained_model_selection()
Maintain model selection during context.
Source code in client/ayon_equalizer/api/pipeline.py
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 | |