template.yaml

specificationVersion: 'jobtemplate-2023-09'
name: GUI Control Showcase

parameterDefinitions:
# Text Controls
  - name: LineEditControl
    type: STRING
    userInterface:
      control: LINE_EDIT
      label: Line Edit Control
      groupLabel: Text Controls
    description: "Unrestricted line of text!"
    default: Default line edit value.
  - name: MultiLineEditControl
    type: STRING
    userInterface:
      control: MULTILINE_EDIT
      label: Multi-line Edit Control
      groupLabel: Text Controls
    description: "Unrestricted text file"
    default: |
      This is a
      text file with
      multiple lines.
  - name: StringDropdown
    type: STRING
    userInterface:
      control: DROPDOWN_LIST
      label: String Dropdown
      groupLabel: Text Controls
    description: A dropdown with string values.
    default: WEDNESDAY
    allowedValues: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
  - name: CheckBox
    type: STRING
    userInterface:
      control: CHECK_BOX
      label: Check Box
      groupLabel: Text Controls
    default: "True"
    allowedValues: ["True", "False"]
    description: Set a true/false value.
# Int Controls
  - name: IntSpinner
    type: INT
    userInterface:
      control: SPIN_BOX
      label: Default Int Spinner
      groupLabel: Int Controls
    description: A default integer spinner.
    default: 42
  - name: BigStepIntSpinner
    type: INT
    userInterface:
      control: SPIN_BOX
      label: Big Step Int Spinner
      groupLabel: Int Controls
      singleStepDelta: 30
    description: A default integer spinner.
    default: 123
  - name: BoundedIntSpinner
    type: INT
    userInterface:
      control: SPIN_BOX
      label: Bounded Int Spinner
      groupLabel: Int Controls
    description: A bounded integer spin box.
    minValue: -100
    maxValue: 100
    default: 25
  - name: IntDropdown
    type: INT
    userInterface:
      control: DROPDOWN_LIST
      label: Int Dropdown
      groupLabel: Dropdown Controls
    description: A dropdown with integer values.
    default: 7
    allowedValues: [3, 8, 7, 2, 9, 1]
  - name: HiddenFieldOne
    type: INT
    userInterface:
      control: HIDDEN
    description: A hidden field that won't show on the UI
    default: 10
# Float Controls
  - name: FloatSpinner
    type: FLOAT
    userInterface:
      control: SPIN_BOX
      label: Default Float Spinner
      groupLabel: Float Controls
    description: A default float spinner.
    default: 1234.56789
  - name: FloatSpinnerOneDecimal
    type: FLOAT
    userInterface:
      control: SPIN_BOX
      label: Float Spinner One Decimal
      groupLabel: Float Controls
      decimals: 1
    description: A float spinner with one decimal of precision.
    default: 100000.01
  - name: FloatSpinnerFixedStep
    type: FLOAT
    userInterface:
      control: SPIN_BOX
      label: Float Spinner Fixed Step
      groupLabel: Float Controls
      singleStepDelta: 0.875
    default: 0.0
    description: A float spinner with a fixed step of .875
  - name: FloatDropdown
    type: FLOAT
    userInterface:
      control: DROPDOWN_LIST
      label: Float Dropdown
      groupLabel: Dropdown Controls
    description: A dropdown with floating point values.
    default: 3.26
    allowedValues: [1.23, 3.26, 9.9, 1.2345]
# Path Controls
  - name: InputFilePicker
    type: PATH
    objectType: FILE
    dataFlow: IN
    userInterface:
      control: CHOOSE_INPUT_FILE
      label: Input File Picker
      groupLabel: Path Controls
      fileFilters:
      - label: Scene Files
        patterns: ["*.blend", "*.mb", "*.ma", "*.nk"]
      - label: Any Files
        patterns: ["*"]
    description: Choose the input scene file.
  - name: OutputFilePicker
    type: PATH
    objectType: FILE
    dataFlow: OUT
    userInterface:
      control: CHOOSE_OUTPUT_FILE
      label: Output File Picker
      groupLabel: Path Controls
      fileFilters:
      - label: EXR Files
        patterns: ["*.exr"]
      - label: JPEG Files
        patterns: ["*.jpg", "*.jpeg"]
      - label: PNG Files
        patterns: ["*.png"]
      - label: All Files
        patterns: ["*"]
    description: Choose the output image file.
  - name: DirectoryPicker
    type: PATH
    objectType: DIRECTORY
    dataFlow: INOUT
    userInterface:
      control: CHOOSE_DIRECTORY
      label: Directory Picker
      groupLabel: Path Controls
    description: Choose a directory.
  - name: HiddenFieldTwo
    type: PATH
    userInterface:
      control: HIDDEN
      label: This won't show
    description: A hidden field that won't show on the UI
    default: relative/path/inside/job/bundle

steps:
- name: PrintAllTheValues
  script:
    actions:
      onRun:
        command: bash
        args: ['{{Task.File.Run}}']
    embeddedFiles:
      - name: TextToPrint
        type: TEXT
        data: |
          LineEditControl value:
            {{Param.LineEditControl}}

          MultiLineEditControl value:
            {{Param.MultiLineEditControl}}

          StringDropdown value:
            {{Param.StringDropdown}}

          CheckBox value:
            {{Param.CheckBox}}


          IntSpinner value:
            {{Param.IntSpinner}}

          BigStepIntSpinner value:
            {{Param.BigStepIntSpinner}}

          BoundedIntSpinner value:
            {{Param.BoundedIntSpinner}}

          IntDropdown value:
            {{Param.IntDropdown}}

          HiddenFieldOne value:
            {{Param.HiddenFieldOne}}


          FloatSpinner value:
            {{Param.FloatSpinner}}

          FloatSpinnerOneDecimal value:
            {{Param.FloatSpinnerOneDecimal}}

          FloatSpinnerFixedStep value:
            {{Param.FloatSpinnerFixedStep}}

          FloatDropdown value:
            {{Param.FloatDropdown}}


          InputFilePicker raw value:
            {{RawParam.InputFilePicker}}
          InputFilePicker value mapped locally:
            {{Param.InputFilePicker}}

          OutputFilePicker raw value:
            {{RawParam.OutputFilePicker}}
          OutputFilePicker value mapped locally:
            {{Param.OutputFilePicker}}

          DirectoryPicker raw value:
            {{RawParam.DirectoryPicker}}
          DirectoryPicker value mapped locally:
            {{Param.DirectoryPicker}}

          HiddenFieldTwo raw value:
            {{RawParam.HiddenFieldTwo}}
          HiddenFieldTwo value mapped locally:
            {{Param.HiddenFieldTwo}}
      - name: Run
        type: TEXT
        data: |
          cat '{{Task.File.TextToPrint}}'