Skip to main content

Button

Buttons are fundamental building blocks of interfaces.

Buttons can be configured to send commands in an on or off state, send commands in an ON or OFF state.

Multiple protocols and commands can be sent from an interaction with a single button. The default state OFF.

Style​

To customise a button component navigate to the Style tab.

Select from:

  • Push - Send commands when pressed.

  • Toggle - Sends a command once pressed and sets itself to an On state. Once pressed again, it sends a different set of commands and sets itself to the Off state. Each state of the Toggle Button requires a separate interaction.

    • Toggle Groups - By navigating to the Settings gear icon when a toggle button is selected within the Interface creation UI, the button can be assigned to a Toggle Group. Only one button in a Toggle Group can be set to the on state at a time. - i.e. When a button in a toggle group is pressed to trigger its ON state, all other buttons in the Toggle Group revert to their OFF state. - This option is ideal for triggering diffrent scenes on a control system where only one option can be selected at a time.

  • Press & Release - Send an On command when the button is first pressed (Touch Begin) and sends an Off command when the press is ended (Touch Release).

Define the:

  • Persistence of the Component between specific interfaces
  • Label
  • Label alignment
  • Label font size
  • Label style
  • Label text wrap
  • Selected label - Use to change the label when the button is depressed
  • Theme
  • Selected theme - Use to change the theme when the button is depressed
  • Background image
  • Selected image - Use to change the image when the button is depressed
  • Image scaling, position, size & margin
  • Show border & edge style
  • Show button pulse

Protocol​

To send a raw protocol command from the interface:

  • Select the protocol to be sent.
  • Reference a protocol patch made within Workspace Settings for the command to be sent to.

An example OSC string that transmits a message and includes a system variable as an argument at the end of a string is: /position $1. An example OSC string that transmits a message and includes a system variable as part of the OSC address is: /position/$1.

Alternatively, if using the Pro Version of Ctrl Suite, select Process to route component information into a Ctrl Suite Process through an Input block for advanced logic to be applied to it.

Settings​

To configure wider paramaters of this UI component type, navigate to the Settings tab.

Loading Screen​

This component supports the ability to display a Loading Screen when actioned.

A Loading Screen is a holding page that is displayed for a user-defined period of time (in milliseconds) once a UI component is actioned.

Loading screen options can be found in the Settings tab and can be enabled.

Loading screens are ideal for enforcing a time between each button press on an interface. This can be defined in milliseconds.

Options for a Loading Screen Background Colour and Background Image, alongside a Skip option can be enabled which allows the user to bypass the loading screen if required.

Interact with this component's appearance remotely with timers, external protocols or other remote logic, to lock it out, change the size, position appearance and more by creating a Process adding relevant Interface blocks in combination with Render Components.