uvi-script
Musical event scripting with Lua

XY widget. More...

Inheritance diagram for XY:
Widget

Public Member Functions

 XY (string paramX, string paramY)
 creates an XY widget on the user interface.
 

Public Attributes

string paramX
 name of the parameter to control on the X axis
 
string paramY
 name of the parameter to control on the Y axis
 
string handleImage
 path to handle image
 
string backgroundColour
 background colour.
 
string handleColour
 handle colour.
 
bool canOnlyDragHandle
 should click on handle to move it.
 
- Public Attributes inherited from Widget
string name
 widget name, given at construction (read-only)
 
string displayName
 widget display name
 
string displayText
 custom text to display in place of the standard value display, on widgets that show one.
 
string tooltip
 widget tooltip, default is name
 
int x
 x position in pixels
 
int y
 y position in pixels
 
int width
 widget width in pixels
 
int height
 widget height in pixels
 
int w
 alias of width
 
int h
 alias of height
 
table size
 widget size {width, height}
 
table position
 widget position {x,y}
 
table pos
 alias of position
 
table bounds
 widget bounding rect {x,y,width,height}
 
number alpha
 transparency value between 0.0 and 1.0
 
bool enabled
 boolean flag to enable / disable the widget
 
bool visible
 boolean flag to toggle widget visibility
 
bool interceptsMouseClicks
 boolean flag to toggle mouse handling on widget.
 
bool showLabel
 show widgets label if any
 
bool persistent
 flag to tell if the widget values should be serialized when saving.
 
function changed
 callback function used by child widgets to be notified of changes.
 

Detailed Description

XY widget.

Creates an XY widget on the user interface.

paramX = Knob("X", 5, 0, 10)
function paramX:changed(v)
print("X changed ", paramX.value)
end
paramY = Knob("Y", 5, 0, 10)
function paramY:changed(v)
print("Y changed ", paramY.value)
end
xy = XY("X", "Y")
xy.bounds = {250, 0, 200, 200}
Knob widget.
Definition ui.cpp:1763
function changed
callback function used by child widgets to be notified of changes.
Definition ui.cpp:1001
table bounds
widget bounding rect {x,y,width,height}
Definition ui.cpp:988
XY widget.
Definition ui.cpp:2386
string paramY
name of the parameter to control on the Y axis
Definition ui.cpp:2397
string paramX
name of the parameter to control on the X axis
Definition ui.cpp:2396

Constructor & Destructor Documentation

◆ XY()

XY::XY ( string paramX,
string paramY )

creates an XY widget on the user interface.

Parameters
paramXthe name of the parameter to control on the X axis
paramYthe name of the parameter to control on the Y axis

Member Data Documentation

◆ backgroundColour

string XY::backgroundColour

background colour.

It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format

◆ canOnlyDragHandle

bool XY::canOnlyDragHandle

should click on handle to move it.

Allows to put different XY widget on top of each other

◆ handleColour

string XY::handleColour

handle colour.

It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format