Skip to main content

Guarded Button

Guarded Buttons are similar to standard push buttons but with added functionality to ensure the user confirms they want to proceed with triggering the commands assigned to the button. This UI Component is ideal for use in scenarios where accidentally triggering commands could have a big impact. i.e. turning on house lights in a theatre or ending a session in a gym etc.

Protocols​

Multiple protocols and commands can be sent from interaction with a single Guarded Button. The default state is off.

When defining the protocols the control will trigger, use the State option to determine when to send a command. Multiple commands can be sent from the same button, each referencing any of the three states:

  • Prompt - Send the command upon first pressing the Guarded Button and the on-screen prompt being shown.
  • Action - Send the command once the user presses Confirm on the Guarded Button dialogue.
  • Cancel - Send the command if the user presses Cancel on the Guarded Button dialogue.

Style​

To customise a guarded button component, navigate to the Style tab. Similar to a push button, the following can be defined:

  • 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

To define the options of the Guarded Button popup, navigate to the Settings tab. Define the:

  • Guarded button popup title.
  • Guarded button popup label text.
  • Guarded button popup box colour.

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.