ParameterValue Class Reference

A non-visual (logical) binding to an existing Element parameter. More...

Inheritance diagram for ParameterValue:

Public Member Functions
	ParameterValue (Element elementOrPath, string paramName)
	creates a logical binding to an existing Element parameter.
string	toString ()

Public Attributes
Value	value
	the bound parameter's value (read and write)
bool	bound
	true if the target element/parameter was resolved (read-only)
Public Attributes inherited from Widget
string	name
	widget name
string	displayName
	widget display name
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
table	size
	widget size {width, height}
table	position
	widget position {x,y}
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

A non-visual (logical) binding to an existing Element parameter.

Unlike the Param* widgets, this draws nothing: it exposes the parameter through a read/write value, staying in sync with host automation, modulation and preset changes. Useful to observe or drive a parameter without placing a control on the UI. It is a global function only (not a Panel method) and does not accept widget layout options.

local vol = ParameterValue(Program.auxs[1].inserts[4], "Volume")
vol.value = -6       -- write the parameter
print(vol.value)     -- read it back

Constructor & Destructor Documentation

ParameterValue()

ParameterValue::ParameterValue	(	Element	elementOrPath,
		string	paramName )

creates a logical binding to an existing Element parameter.

Parameters

elementOrPath	an Element reference, or a path string identifying one
paramName	the parameter name (as used by setParameter)

Member Function Documentation

toString()

string ParameterValue::toString

(

)

Returns

the parameter value formatted as a display string