XY Class Reference

XY widget. More...

Inheritance diagram for XY:

Public Member Functions
	XY (string paramX, string paramY)
	creates an XY widget on the user inteface. More...

Public Attributes
number	alpha
	transparency value between 0.0 and 1.0
string	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
table	bounds
	widget bounding rect {x,y,width,height}
bool	canOnlyDragHandle
	should click on handle to move it. Allows to put different XY widget on top of each other
function	changed
	callback function used by child widgets to be notified of changes
string	displayName
	widget display name
bool	enabled
	boolean flag to enable / disable the widget
string	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
string	handleImage
	path to handle image
int	height
	widget height in pixels
bool	interceptsMouseClicks
	boolean flag to toggle mouse handling on widget
string	name
	widget name
string	paramX
	name of the parameter to control on the X axis
string	paramY
	name of the parameter to control on the Y axis
bool	persistent
	flag to tell if the widget values should be serialized when saving. True by default. Persistent widgets will call their changed function on reload
table	position
	widget position {x,y}
bool	showLabel
	show widgets label if any
table	size
	widget size {width, height}
string	tooltip
	widget tooltip, default is name
bool	visible
	boolean flag to toggle widget visibility
int	width
	widget width in pixels
int	x
	x position in pixels
int	y
	y position in pixels

Detailed Description

XY widget.

Creates an XY widget on the user inteface.

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("X changed ", paramY.value)
end

xy = XY("X", "Y")
xy.bounds = {250, 0, 200, 200}

Constructor & Destructor Documentation

XY::XY	(	string	paramX,
		string	paramY
	)

creates an XY widget on the user inteface.

Parameters

paramX	the name of the parameter to control on the X axis
paramY	the name of the parameter to control on the Y axis