TouchOSC

Next generation modular control surface
TouchOSC Manual

Control Reference


In this overview we describe all properties and values that are specific to each control type. For a description of common properties and values that all types of controls share, please see Properties and Values.

All properties and values can also be accessed from within scripts. Please see the scripting API's Properties & Values section for information about the field names and types to use for script access.


 

BOX

A box control is a simple shape with no behavior. It is meant to be efficient to render, for creating decorative elements and backgrounds or to be moved and positioned using messages and script.

Properties

Name Description
Shape The shape of the control
 

BUTTON

A simple button control with properties to control the press/release behavior. As it uses a FLOAT value for its display, it can be also used as a simple LED display.

Properties

Name Description
Shape The shape of the control
Type The type of button.
  • Momentary - A push button
  • Toggle Release - A toggle button, toggle on release
  • Toggle Press - A toggle button, toggle on press
Press Enable the press event for this button.
Release Enable the release event for this button.
Value Position If this property is set to on, the button will use the position of the pointer event to calculate its value. The calculation will take the value of the Orientation property into account.
Values

Name Type Description
x FLOAT The amount of "pressure" on the button from fully released to fully pressed. The button will be rendered using this value as alpha value for the color of the button fill.
 

LABEL

A single-line text display.

Properties

Name Description
Font The typeface for rendering the text.
  • DEFAULT - The default, variable-width font
  • MONOSPACED - A monospaced, fixed-width font
Size The font size.
Length The maximum length of the text.
Alignment Horizontal and vertical alignment of the text inside the control.
Color The text color.
Clip Controls the clipping of the rendered text to the control's frame. Note that disabling this property can significantly improve rendering performance in certain cases.
Values

Name Type Description
text STRING The display text.
 

TEXT

A multi-line text display.

Properties

Name Description
Font The typeface for rendering the text.
  • DEFAULT - The default, variable-width font
  • MONOSPACED - A monospaced, fixed-width font
Size The font size.
Alignment Horizontal alignment of the text inside the control.
Color The text color.
Values

Name Type Description
text STRING The display text.
 

FADER

A fader control.

Properties

Name Description
Cursor Show a cursor.
  • ALWAYS - Show always
  • ACTIVE - Show only if any active pointers
  • INACTIVE - Show only if no active pointers
Bar Show a value bar.
  • ALWAYS - Show always
  • ACTIVE - Show only if any active pointers
  • INACTIVE - Show only if no active pointers
Centered Render the value bar from the center.
Response Type of response to pointer input
  • ABSOLUTE - Jump to pointer position
  • RELATIVE - Change relative to pointer position
Factor Response factor for relative response, in percent of pointer position change.
Grid Render grid lines and the number of grid lines to render.
Values

Name Type Description
x FLOAT The value position.
 

XY

A two-dimensional fader control.

Properties

Name Description
Cursor Show a cursor.
  • ALWAYS - Show always
  • ACTIVE - Show only if any active pointers
  • INACTIVE - Show only if no active pointers
Lines Show value lines.
  • ALWAYS - Show always
  • ACTIVE - Show only if any active pointers
  • INACTIVE - Show only if no active pointers
Lock X Lock the x value for pointer input. The value can still be changed through messages and script.
Lock Y Lock the y value for pointer input. The value can still be changed through messages and script.
Response Type of response to pointer input
  • ABSOLUTE - Jump to pointer position
  • RELATIVE - Change relative to pointer position
Factor Response factor for relative response, in percent of pointer position change.
Grid X Render horizontal grid lines and the number of grid lines to render.
Grid Y Render vertical grid lines and the number of grid lines to render.
Values

Name Type Description
x FLOAT The x value position.
y FLOAT The y value position.
 

RADIAL

A rotary fader control.

Properties

Name Description
Inverted Invert the value range.
Centered Display the value from the center of the value range.
Response Type of response to pointer input
  • ABSOLUTE - Jump to pointer position
  • RELATIVE - Change relative to pointer position
Factor Response factor for relative response, in percent of pointer position change.
Grid Render grid lines and the number of grid lines to render.
Values

Name Type Description
x FLOAT The value position.
 

ENCODER

A circular encoder control.

Properties

Name Description
Cursor Show a cursor.
  • ALWAYS - Show always
  • ACTIVE - Show only if any active pointers
  • INACTIVE - Show only if no active pointers
Response Type of response to pointer input
  • ABSOLUTE - Jump to pointer position
  • RELATIVE - Change relative to pointer position
Factor Response factor for relative response, in percent of pointer position change.
Grid Render grid lines and the number of grid lines to render.
Values

Name Type Description
x FLOAT The value position.
y FLOAT The direction of change of the value position.
 

RADAR

A circular XY control, measuring distance from center and angle.

Properties

Name Description
Cursor Show a cursor.
  • ALWAYS - Show always
  • ACTIVE - Show only if any active pointers
  • INACTIVE - Show only if no active pointers
Lines Show lines for distance and angle.
  • ALWAYS - Show always
  • ACTIVE - Show only if any active pointers
  • INACTIVE - Show only if no active pointers
Lock X Lock the x value for pointer input. The value can still be changed through messages and script.
Lock Y Lock the y value for pointer input. The value can still be changed through messages and script.
Grid X Render grid lines for distance and the number of grid lines to render.
Grid Y Render grid lines for angle and the number of grid lines to render.
Values

Name Type Description
x FLOAT The distance from the center.
y FLOAT The angle. The calculation will take the value of the Orientation property into account.
 

RADIO

A single value selection from a number of discrete values.

Properties

Name Description
Steps The number of discrete values.
Type The type of display
  • Select - Highlight only the active value
  • Meter - Highlight all values up to the active one
Values

Name Type Description
x INTEGER The selected value.
 

GROUP

A simple container for child controls. A group will clip the rendering of any contained child controls to its display area.

 

PAGER

A paged container for child controls. A pager contains a number of group child controls ("pages") and will display only the active one based on its page value. A pager control can be ungrouped to extract the individual page group child controls.

Properties

Name Description
Bar Display the pager tab bar.
Bar Size The size of the pager tab bar.
Double Tap Require a double tap on the tab bar instead of a single press to change the active page.
Labels Display the value of each child page's Label property on the tab bar.
Text Size Font size for labels on the tab bar, for both inactive page labels and the active page label.
Page Properties

Name Description
Name The name of the child group control.
Label The text to display on the parent pager's tab bar for this page.
Background The background color of the page group control.
Tab Color The colors to use for the parent pager's tab bar button for this page, for both active and inactive states.
Text Color The colors to use for the parent pager's tab bar button label for this page, for both active and inactive states.
Values

Name Type Description
page INTEGER The active page index.
 

GRID

A container for a two-dimensional, uniform grid of child controls of the same type. A grid control can be ungrouped to extract the individual child controls. The editor will display the child control type's properties in addition to the grid control's own properties,

Properties

Name Description
Type The type of child control.
X The number of columns in the grid.
Y The number of rows in the grid.
Start The corner of the grid to start from when creating the child controls.
Order The direction in which to proceed first in the grid when creating the child controls.
Naming The value to use when assigning the Name property of the created child controls.
Exclusive Whenever a child control's value changes, reset all other child controls' values of the same name back to the default value.
 

hexler.net uses cookies to deliver website content. By continuing without changing your preferences, you agree to our use of cookies.