Plug Controls

Warning

This documentation is not yet complete.

Plug controls are user interface elements (controls), that act as an “user interface” for plugs.

Control types used in the Attribute Editor

../_images/attr_plug_types.png

Some examples of controls for different plug types.

The following table, summarizes what controls are used for what types:

Type Control Comment
strings Text Edits Default control for strings
  text Used for intput of multiline text
  filepath Used for intput or output filenames
  fontchooser Used as a font choosser (for font names)
  infostring Displays a text label (readonly)
numbers Number Edits Default control for numbers
  spinbox For integers only
  Slider-Number Control  
  stringlist For integers only
Vectors and Points vec2_number Default control for vectors
Matrices (2x2 and 3x3) mat3_number Default control for matrices
booleans Switch Control Default control for booleans
rectangles number Default control for rectangles
squares number Default control for squares
actions (see: action) button Default control for actions
colors color Default control for colors
sizes size Default control for sizees
nodes (see: Concepts) Node Control Default control for nodes
HDR Images image Default control for HDR Images
  HDR Image Control (with Preview) Includes an image preview
number lists number_vector_box Default control for number lists
point lists vec2_vector_box Default control for point lists
lists of point lists vec2_vector_box Default control for lists of point lists
xy-data dataplot Default control for xy-data
stage positions stagepos Default control for stage positions

Common plug control features

Plug connections with Drag-and-Drop

… TODO

Context Menu

… TODO