List of all members | Public Member Functions | Public Attributes
WaveView Class Reference

WaveView widget. More...

+ Inheritance diagram for WaveView:

Public Member Functions

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

Public Attributes

number alpha
 transparency value between 0.0 and 1.0
 
string 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
 
table bounds
 widget bounding rect {x,y,width,height}
 
function changed
 callback function used by child widgets to be notified of changes
 
string 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
 
string displayName
 widget display name
 
bool enabled
 boolean flag to enable / disable the widget
 
int height
 widget height in pixels
 
string hiWaveColour
 high wave colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format
 
bool interceptsMouseClicks
 boolean flag to toggle mouse handling on widget
 
string lowWaveColour
 low wave colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format
 
string name
 widget name
 
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
 
string 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
 
table position
 widget position {x,y}
 
string sample
 allow to load manualy a sample into the widget (won't change the sample in the oscilltor if bound)
 
string 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
 
string 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
 
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

WaveView widget.

creates a WaveView widget on the user inteface.

local waveview = WaveView("waveview")
waveview.x = 5
waveview.y = 5
waveview.width = 100
waveview.height = 100
waveview.sample = "Drum Loop.wav"

Constructor & Destructor Documentation

WaveView::WaveView ( string  name)

creates a WaveView widget on the user inteface.

Parameters
namethe name to give to the widget