mirror of
https://github.com/ynput/ayon-core.git
synced 2026-01-02 08:54:53 +01:00
added some dosctrings with usolved issues
This commit is contained in:
parent
703dd81ecd
commit
65a4365359
1 changed files with 33 additions and 2 deletions
|
|
@ -15,10 +15,41 @@ class OpenPypePyblishPluginMixin:
|
|||
_state_change_callbacks = []
|
||||
|
||||
@classmethod
|
||||
def get_family_attribute_defs(cls, family):
|
||||
return None
|
||||
def get_family_attribute_defs(cls, families):
|
||||
"""Publish attribute definitions per family.
|
||||
|
||||
Questions:
|
||||
Allow to pass multiple families at one time?
|
||||
- If yes return intersection of all attributes for all families or all attributes or attributes by family?
|
||||
- "attributes by family" seems most reasonable so "Main" logic can decide how to handle that.
|
||||
- also it is time saving if all instances will pass
|
||||
|
||||
Pass instance data (avalon instance) instead of families?
|
||||
|
||||
Args:
|
||||
families(list): List of families for which should return attribute
|
||||
definitions.
|
||||
|
||||
Returns:
|
||||
dict<list<AbtractAttrDef>>: Attribute definitions per family.
|
||||
"""
|
||||
return {}
|
||||
|
||||
def set_state(self, percent=None, message=None):
|
||||
"""Inner callback of plugin that would help to show in UI state.
|
||||
|
||||
Plugin have registered callbacks on state change which could trigger
|
||||
update message and percent in UI and repaint the change.
|
||||
|
||||
This part must be optional and should not be used to display errors
|
||||
or for logging.
|
||||
|
||||
Message should be short without details.
|
||||
|
||||
Args:
|
||||
percent(int): Percent of processing in range <1-100>.
|
||||
message(str): Message which will be shown to user (if in UI).
|
||||
"""
|
||||
if percent is not None:
|
||||
self.state_percent = percent
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue