uvi-script
Musical event scripting with Lua
WaveView Class Reference

WaveView widget. More...

Inheritance diagram for WaveView:
Widget

Public Member Functions

 WaveView (string name)
 creates a WaveView widget on the user interface.
 
void bind (Element oscillator)
 automatic binding to an oscillator own sample which allows to handle playback position as well
 

Public Attributes

string sample
 allow to load manualy a sample into the widget (won't change the sample in the oscilltor if bound)
 
string playbackCursorColour
 playback marker colour.
 
string hiWaveColour
 colour at the outer edges of the wave (top and bottom), blended towards lowWaveColour at the centre line; the same colour in both gives a flat fill.
 
string lowWaveColour
 colour at the centre line of the wave.
 
bool showPeak
 draws the peak envelope, the outer layer of the wave.
 
bool showRms
 draws the RMS body inside the peak envelope, a slightly lighter tone of the same colours.
 
string axisColour
 axis colour.
 
string channelSeparatorColour
 channel separator colour.
 
string sampleNameColour
 sample name colour.
 
string sampleNameBackgroundColour
 sample name background colour.
 
- 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

WaveView widget.

creates a WaveView widget on the user interface.

local waveview = WaveView("waveview")
waveview.x = 5
waveview.y = 5
waveview.width = 100
waveview.height = 100
waveview.sample = "Drum Loop.wav"
string sample
allow to load manualy a sample into the widget (won't change the sample in the oscilltor if bound)
Definition ui.cpp:2275
WaveView(string name)
creates a WaveView widget on the user interface.
int x
x position in pixels
Definition ui.cpp:979
int height
widget height in pixels
Definition ui.cpp:982
int y
y position in pixels
Definition ui.cpp:980
int width
widget width in pixels
Definition ui.cpp:981

Constructor & Destructor Documentation

◆ WaveView()

WaveView::WaveView ( string name)

creates a WaveView widget on the user interface.

Parameters
namethe name to give to the widget

Member Data Documentation

◆ axisColour

string WaveView::axisColour

axis colour.

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

◆ channelSeparatorColour

string WaveView::channelSeparatorColour

channel separator colour.

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

◆ hiWaveColour

string WaveView::hiWaveColour

colour at the outer edges of the wave (top and bottom), blended towards lowWaveColour at the centre line; the same colour in both gives a flat fill.

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

◆ lowWaveColour

string WaveView::lowWaveColour

colour at the centre line of the wave.

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

◆ playbackCursorColour

string WaveView::playbackCursorColour

playback marker colour.

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

◆ sampleNameBackgroundColour

string WaveView::sampleNameBackgroundColour

sample name background colour.

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

◆ sampleNameColour

string WaveView::sampleNameColour

sample name colour.

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

◆ showPeak

bool WaveView::showPeak

draws the peak envelope, the outer layer of the wave.

Default true

◆ showRms

bool WaveView::showRms

draws the RMS body inside the peak envelope, a slightly lighter tone of the same colours.

Default true; false gives a peaks-only wave. A layer drawn alone keeps the plain colours