Grid layout in settings

pype/tools/settings/settings/README.md

@@ -0,0 +1,261 @@
+# Creating GUI schemas
+
+## Basic rules
+- configurations does not define GUI, but GUI defines configurations!
+- output is always json (yaml is not needed for anatomy templates anymore)
+- GUI schema has multiple input types, all inputs are represented by a dictionary
+- each input may have "input modifiers" (keys in dictionary) that are required or optional
+ - only required modifier for all input items is key `"type"` which says what type of item it is
+- there are special keys across all inputs
+ - `"is_file"` - this key is for storing pype defaults in `pype` repo
+ - reasons of existence: developing new schemas does not require to create defaults manually
+ - key is validated, must be once in hierarchy else it won't be possible to store pype defaults
+ - `"is_group"` - define that all values under key in hierarchy will be overriden if any value is modified, this information is also stored to overrides
+ - this keys is not allowed for all inputs as they may have not reason for that
+ - key is validated, can be only once in hierarchy but is not required
+- currently there are `system configurations` and `project configurations`
+
+## Inner schema
+- GUI schemas are huge json files, to be able to split whole configuration into multiple schema there's type `schema`
+- system configuration schemas are stored in `~/tools/settings/settings/gui_schemas/system_schema/` and project configurations in `~/tools/settings/settings/gui_schemas/projects_schema/`
+- each schema name is filename of json file except extension (without ".json")
+
+### schema
+- can have only key `"children"` which is list of strings, each string should represent another schema (order matters) string represebts name of the schema
+- will just paste schemas from other schema file in order of "children" list
+
+```
+{
+ "type": "schema",
+ "children": [
+ "my_schema_name",
+ "my_other_schema_name"
+ ]
+}
+```
+
+## Basic Dictionary inputs
+- these inputs wraps another inputs into {key: value} relation
+
+### dict-invisible
+- this input gives ability to wrap another inputs but keep them in same widget without visible divider
+ - this is for example used as first input widget
+- has required keys `"key"` and `"children"`
+ - "children" says what children inputs are underneath
+ - "key" is key under which will be stored value from it's children
+- output is dictionary `{the "key": children values}`
+- can't have `"is_group"` key set to True as it breaks visual override showing
+```
+{
+ "type": "dict-invisible",
+ "key": "global",
+ "children": [
+ ...ITEMS...
+ ]
+}
+```
+
+## dict
+- this is another dictionary input wrapping more inputs but visually makes them different
+- required keys are `"key"` under which will be stored and `"label"` which will be shown in GUI
+- this input can be expandable
+ - that can be set with key `"expandable"` as `True`/`False` (Default: `True`)
+ - with key `"expanded"` as `True`/`False` can be set that is expanded when GUI is opened (Default: `False`)
+- it is possible to add darker background with `"highlight_content"` (Default: `False`)
+ - darker background has limits of maximum applies after 3-4 nested highlighted items there is not difference in the color
+```
+{
+ "key": "applications",
+ "type": "dict",
+ "label": "Applications",
+ "expandable": true,
+ "highlight_content": true,
+ "is_group": true,
+ "is_file": true,
+ "children": [
+ ...ITEMS...
+ ]
+}
+```
+
+## Inputs for setting any kind of value (`Pure` inputs)
+- all these input must have defined `"key"` under which will be stored and `"label"` which will be shown next to input
+ - unless they are used in different types of inputs (later) "as widgets" in that case `"key"` and `"label"` are not required as there is not place where to set them
+
+### boolean
+- simple checkbox, nothing more to set
+```
+{
+ "type": "boolean",
+ "key": "my_boolean_key",
+ "label": "Do you want to use Pype?"
+}
+```
+
+### number
+- number input, can be used for both integer and float
+ - key `"decimal"` defines how many decimal places will be used, 0 is for integer input (Default: `0`)
+ - key `"minimum"` as minimum allowed number to enter (Default: `-99999`)
+ - key `"maxium"` as maximum allowed number to enter (Default: `99999`)
+```
+{
+ "type": "number",
+ "key": "fps",
+ "label": "Frame rate (FPS)"
+ "decimal": 2,
+ "minimum": 1,
+ "maximum": 300000
+}
+```
+
+### text
+- simple text input
+ - key `"multiline"` allows to enter multiple lines of text (Default: `False`)
+
+```
+{
+ "type": "text",
+ "key": "deadline_pool",
+ "label": "Deadline pool"
+}
+```
+
+### path-input
+- enhanced text input
+ - does not allow to enter backslash, is auto-converted to forward slash
+ - may be added another validations, like do not allow end path with slash
+- this input is implemented to add additional features to text input
+- this is meant to be used in proxy input `path-widget`
+ - DO NOT USE this input in schema please
+
+### raw-json
+- a little bit enhanced text input for raw json
+- has validations of json format
+ - empty value is invalid value, always must be at least `{}` of `[]`
+
+```
+{
+ "type": "raw-json",
+ "key": "profiles",
+ "label": "Extract Review profiles"
+}
+```
+
+## Inputs for setting value using Pure inputs
+- these inputs also have required `"key"` and `"label"`
+- they use Pure inputs "as widgets"
+
+### list
+- output is list
+- items can be added and removed
+- items in list must be the same type
+ - type of items is defined with key `"object_type"` where Pure input name is entered (e.g. `number`)
+ - because Pure inputs may have modifiers (`number` input has `minimum`, `maximum` and `decimals`) you can set these in key `"input_modifiers"`
+
+```
+{
+ "type": "list",
+ "object_type": "number",
+ "key": "exclude_ports",
+ "label": "Exclude ports",
+ "input_modifiers": {
+ "minimum": 1,
+ "maximum": 65535
+ }
+}
+```
+
+### dict-modifiable
+- one of dictionary inputs, this is only used as value input
+- items in this input can be removed and added same way as in `list` input
+- value items in dictionary must be the same type
+ - type of items is defined with key `"object_type"` where Pure input name is entered (e.g. `number`)
+ - because Pure inputs may have modifiers (`number` input has `minimum`, `maximum` and `decimals`) you can set these in key `"input_modifiers"`
+- this input can be expandable
+ - that can be set with key `"expandable"` as `True`/`False` (Default: `True`)
+ - with key `"expanded"` as `True`/`False` can be set that is expanded when GUI is opened (Default: `False`)
+
+```
+{
+ "type": "dict-modifiable",
+ "object_type": "number",
+ "input_modifiers": {
+ "minimum": 0,
+ "maximum": 300
+ },
+ "is_group": true,
+ "key": "templates_mapping",
+ "label": "Muster - Templates mapping",
+ "is_file": true
+}
+```
+
+### path-widget
+- input for paths, use `path-input` internally
+- has 2 input modifiers `"multiplatform"` and `"multipath"`
+ - `"multiplatform"` - adds `"windows"`, `"linux"` and `"darwin"` path inputs result is dictionary
+ - `"multipath"` - it is possible to enter multiple paths
+ - if both are enabled result is dictionary with lists
+
+```
+{
+ "type": "path-widget",
+ "key": "ffmpeg_path",
+ "label": "FFmpeg path",
+ "multiplatform": true,
+ "multipath": true
+}
+```
+
+## Noninteractive widgets
+- have nothing to do with data
+
+### label
+- add label with note or explanations
+- it is possible to use html tags inside the label
+
+```
+{
+ "type": "label",
+ "label": "<span style=\"color:#FF0000\";>RED LABEL:</span> Normal label"
+}
+```
+
+### splitter
+- visual splitter of items (more divider than splitter)
+
+```
+{
+ "type": "splitter"
+}
+```
+
+## Proxy wrappers
+- should wraps multiple inputs only visually
+- these does not have `"key"` key and do not allow to have `"is_file"` or `"is_group"` modifiers enabled
+
+### dict-form
+- DEPRECATED
+ - may be used only in `dict` and `dict-invisible` where is currently used grid layout so form is not needed
+ - item is kept as still may be used in specific cases
+- wraps inputs into form look layout
+- should be used only for Pure inputs
+
+```
+{
+ "type": "dict-form",
+ "children": [
+ {
+ "type": "text",
+ "key": "deadline_department",
+ "label": "Deadline apartment"
+ }, {
+ "type": "number",
+ "key": "deadline_priority",
+ "label": "Deadline priority"
+ }, {
+ ...
+ }
+ ]
+}
+```

pype/tools/settings/settings/gui_schemas/projects_schema/1_plugins_gui_schema.json

@@ -30,34 +30,29 @@
  "key": "enabled",
  "label": "Enabled"
  }, {
- "type": "dict-form",
- "children": [
- {
- "type": "text",
- "key": "deadline_department",
- "label": "Deadline apartment"
- }, {
- "type": "number",
- "key": "deadline_priority",
- "label": "Deadline priority"
- }, {
- "type": "text",
- "key": "deadline_pool",
- "label": "Deadline pool"
- }, {
- "type": "text",
- "key": "deadline_pool_secondary",
- "label": "Deadline pool (secondary)"
- }, {
- "type": "text",
- "key": "deadline_group",
- "label": "Deadline Group"
- }, {
- "type": "number",
- "key": "deadline_chunk_size",
- "label": "Deadline Chunk size"
- }
- ]
+ "type": "text",
+ "key": "deadline_department",
+ "label": "Deadline apartment"
+ }, {
+ "type": "number",
+ "key": "deadline_priority",
+ "label": "Deadline priority"
+ }, {
+ "type": "text",
+ "key": "deadline_pool",
+ "label": "Deadline pool"
+ }, {
+ "type": "text",
+ "key": "deadline_pool_secondary",
+ "label": "Deadline pool (secondary)"
+ }, {
+ "type": "text",
+ "key": "deadline_group",
+ "label": "Deadline Group"
+ }, {
+ "type": "number",
+ "key": "deadline_chunk_size",
+ "label": "Deadline Chunk size"
  }
  ]
  }
@@ -531,13 +526,6 @@
  "key": "nukestudio",
  "label": "NukeStudio",
  "children": [
- {
- "type": "raw-json",
- "collapsable": true,
- "key": "filter",
- "label": "Publish GUI Filters",
- "is_file": true
- },
  {
  "type": "dict",
  "collapsable": true,
@@ -649,21 +637,16 @@
  "label": "ffmpeg_args",
  "children": [
  {
- "type": "dict-form",
- "children": [
- {
- "type": "list",
- "object_type": "text",
- "key": "input",
- "label": "input"
- },
- {
- "type": "list",
- "object_type": "text",
- "key": "output",
- "label": "output"
- }
- ]
+ "type": "list",
+ "object_type": "text",
+ "key": "input",
+ "label": "input"
+ },
+ {
+ "type": "list",
+ "object_type": "text",
+ "key": "output",
+ "label": "output"
  }
  ]
  }