uvi-script
Musical event scripting with Lua
ParamSlider Class Reference

A fader bound to an existing Element parameter. More...

Inheritance diagram for ParamSlider:
Widget

Public Member Functions

 ParamSlider (Element elementOrPath, string paramName)
 creates a slider bound to an existing Element parameter.
 
 ParamSlider (string name)
 creates an unbound slider, to be targeted later with bind.
 
void bind (Element elementOrPath, string paramName)
 bind the widget to another parameter, or bind an unbound widget for the first time.
 
void setRange (number min, number max)
 override the range inherited from the parameter.
 
void setStripImage (string imagePath, int numImages)
 
void setLottieAnimation (string path)
 dress the widget with a Lottie animation, whose frame follows the value.
 

Public Attributes

number value
 the widget's value (read-only; reflects the bound parameter)
 
Unit::Type unit
 unit override, default is taken from the parameter
 
number default
 value restored by a reset (alt-click), in parameter units; as on ParamKnob
 
bool horizontal
 true for a horizontal fader, false for vertical
 
bool showPopupDisplay
 show/hide the value popup display (if any)
 
string backgroundColour
 background colour (named colour or RGB/ARGB hex string)
 
string thumbColour
 thumb colour (named colour or RGB/ARGB hex string)
 
string fillColour
 fill colour (named colour or RGB/ARGB hex string)
 
string trackColour
 track colour (named colour or RGB/ARGB hex string)
 
string backgroundImage
 path to background image
 
string handleImage
 path to handle image
 
string lottieAnimation
 path to a Lottie animation or package, see Lottie Animations
 
- 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

A fader bound to an existing Element parameter.

Like ParamKnob but rendered as a slider. It is a Widget (not a Slider).

Constructor & Destructor Documentation

◆ ParamSlider() [1/2]

ParamSlider::ParamSlider ( Element elementOrPath,
string paramName )

creates a slider bound to an existing Element parameter.

Parameters
elementOrPathan Element reference, or a path string identifying one
paramNamethe parameter name (as used by setParameter)

◆ ParamSlider() [2/2]

ParamSlider::ParamSlider ( string name)

creates an unbound slider, to be targeted later with bind.

Until then it shows a placeholder and its value is nil.

Parameters
namethe widget name

Member Function Documentation

◆ bind()

void ParamSlider::bind ( Element elementOrPath,
string paramName )

bind the widget to another parameter, or bind an unbound widget for the first time.

The control is rebuilt with the new parameter's range, unit, mapper and value; rebinding to the same element and parameter does nothing. Typically called when the element the UI edits changes, e.g. the insert effect selected in an effect rack. Raises an error when the element no longer exists or has no such parameter.

Parameters
elementOrPathan Element reference, or a path string identifying one
paramNamethe parameter name (as used by setParameter)

◆ setLottieAnimation()

void ParamSlider::setLottieAnimation ( string path)

dress the widget with a Lottie animation, whose frame follows the value.

See Lottie Animations.

Parameters
pathpath to a .json animation or a .lottie package

◆ setRange()

void ParamSlider::setRange ( number min,
number max )

override the range inherited from the parameter.

Parameters
minminimum value
maxmaximum value

◆ setStripImage()

void ParamSlider::setStripImage ( string imagePath,
int numImages )
Parameters
imagePathpath to slider strip image. Supports Retina @2x variants.
numImagesnumber of images in strip