Klang C++ 0.7.15
Language Reference (draft)
Loading...
Searching...
No Matches
klang::Control

UI control / parameter. More...

#include <klang.h>

Classes

struct  Group
 
struct  Size
 Control size. More...
 

Public Types

enum  Type {
  NONE , ROTARY , BUTTON , TOGGLE ,
  SLIDER , MENU , METER , WHEEL
}
 
typedef Array< Caption, 128 > Options
 

Public Member Functions

 operator signal & ()
 
 operator signal () const
 
 operator param () const
 
 operator float () const
 
signal smooth ()
 
float range () const
 
float normalise (float value) const
 
float normalised () const
 
void setNormalised (float norm)
 
 operator Control * ()
 
Control & set (float x)
 
template<typename TYPE , std::enable_if_t< std::is_arithmetic_v< TYPE >, int > = 0>
Control & operator= (TYPE input)
 
template<typename TYPE , std::enable_if_t<!std::is_arithmetic_v< std::decay_t< TYPE > > &&!std::is_same_v< std::decay_t< TYPE >, Control > &&std::is_convertible_v< TYPE &&, signal >, int > = 0>
Control & operator= (TYPE &&input)
 
Control & operator+= (float x)
 
Control & operator*= (float x)
 
Control & operator-= (float x)
 
Control & operator/= (float x)
 
template<typename TYPE >
signal operator+ (const Control &x) const
 
template<typename TYPE >
signal operator* (const Control &x) const
 
template<typename TYPE >
signal operator- (const Control &x) const
 
template<typename TYPE >
signal operator/ (const Control &x) const
 
template<typename TYPE >
float operator+ (TYPE &x) const
 
template<typename TYPE >
float operator* (TYPE &x) const
 
template<typename TYPE >
float operator- (TYPE &x) const
 
template<typename TYPE >
float operator/ (TYPE &x) const
 
Control & operator<< (const signal &input)
 
template<typename TYPE , std::enable_if_t< std::is_arithmetic_v< TYPE >, int > = 0>
Control & operator<< (TYPE input)
 

Public Attributes

Caption name
 
Type type = NONE
 
float min
 
float max
 
float initial
 
Size size
 
Options options
 
signal value
 
signal smoothed
 

Static Public Attributes

static constexpr float smoothing = 0.999f
 

Detailed Description

Definition at line 1805 of file klang.h.

Member Typedef Documentation

◆ Options

Definition at line 1845 of file klang.h.

Member Enumeration Documentation

◆ Type

Values
NONE 
ROTARY 
BUTTON 
TOGGLE 
SLIDER 
MENU 
METER 
WHEEL 

Definition at line 1807 of file klang.h.

1808 {
1809 NONE, // no control (list terminator)
1810 ROTARY, // rotary knob (dial/pot)
1811 BUTTON, // push button (trigger)
1812 TOGGLE, // on/off switch (toggle)
1813 SLIDER, // linear slider (fader)
1814 MENU, // drop-down list (menu; up to 128 items)
1815 METER, // level meter (read-only: use setParameter() to set value)
1816 WHEEL, // MIDI control (Pitch Bend / Mod Wheel only)
1817 };

Member Function Documentation

◆ normalise()

float klang::Control::normalise ( float value) const
inline

Definition at line 1869 of file klang.h.

1869{ return range() ? (value - min) / range() : std::clamp(value, 0.f, 1.f); }
float range() const
Definition klang.h:1868
signal value
Definition klang.h:1857

◆ normalised()

float klang::Control::normalised ( ) const
inline

Definition at line 1870 of file klang.h.

1870{ return range() ? (value.value - min) / range() : std::clamp(value.value, 0.f, 1.f); }
float value
Definition klang.h:1124

References klang::signal::value.

◆ operator Control *()

klang::Control::operator Control * ( )
inline

Definition at line 1873 of file klang.h.

1873{ return this; }

◆ operator float()

klang::Control::operator float ( ) const
inline

Definition at line 1863 of file klang.h.

1863{ return value.value; }

References klang::signal::value.

◆ operator param()

klang::Control::operator param ( ) const
inline

Definition at line 1862 of file klang.h.

1862{ return value; }

◆ operator signal()

klang::Control::operator signal ( ) const
inline

Definition at line 1861 of file klang.h.

1861{ return value; }

◆ operator signal &()

klang::Control::operator signal & ( )
inline

Definition at line 1860 of file klang.h.

1860{ return value; }

◆ operator*() [1/2]

template<typename TYPE >
signal klang::Control::operator* ( const Control & x) const
inline

Definition at line 1900 of file klang.h.

1900{ return value * x.operator klang::signal(); }
A mono audio signal (equivalent to a float).
Definition klang.h:1123

◆ operator*() [2/2]

template<typename TYPE >
float klang::Control::operator* ( TYPE & x) const
inline

Definition at line 1905 of file klang.h.

1905{ return value * (signal)x; }
signals< 2 > signal
Stereo audio signal.
Definition klang.h:5840

◆ operator*=()

Control & klang::Control::operator*= ( float x)
inline

Definition at line 1890 of file klang.h.

1890{ value *= x; return *this; }

◆ operator+() [1/2]

template<typename TYPE >
signal klang::Control::operator+ ( const Control & x) const
inline

Definition at line 1899 of file klang.h.

1899{ return value + x.operator klang::signal(); }

◆ operator+() [2/2]

template<typename TYPE >
float klang::Control::operator+ ( TYPE & x) const
inline

Definition at line 1904 of file klang.h.

1904{ return value + (signal)x; }

◆ operator+=()

Control & klang::Control::operator+= ( float x)
inline

Definition at line 1889 of file klang.h.

1889{ value += x; return *this; }

◆ operator-() [1/2]

template<typename TYPE >
signal klang::Control::operator- ( const Control & x) const
inline

Definition at line 1901 of file klang.h.

1901{ return value - x.operator klang::signal(); }

◆ operator-() [2/2]

template<typename TYPE >
float klang::Control::operator- ( TYPE & x) const
inline

Definition at line 1906 of file klang.h.

1906{ return value - (signal)x; }

◆ operator-=()

Control & klang::Control::operator-= ( float x)
inline

Definition at line 1891 of file klang.h.

1891{ value -= x; return *this; }

◆ operator/() [1/2]

template<typename TYPE >
signal klang::Control::operator/ ( const Control & x) const
inline

Definition at line 1902 of file klang.h.

1902{ return value / x.operator klang::signal(); }

◆ operator/() [2/2]

template<typename TYPE >
float klang::Control::operator/ ( TYPE & x) const
inline

Definition at line 1907 of file klang.h.

1907{ return value / (signal)x; }

◆ operator/=()

Control & klang::Control::operator/= ( float x)
inline

Definition at line 1892 of file klang.h.

1892{ value /= x; return *this; }

◆ operator<<() [1/2]

Control & klang::Control::operator<< ( const signal & input)
inline

Definition at line 1909 of file klang.h.

1909{ return operator=(input); }
Control & operator=(TYPE input)
Definition klang.h:1881

◆ operator<<() [2/2]

template<typename TYPE , std::enable_if_t< std::is_arithmetic_v< TYPE >, int > = 0>
Control & klang::Control::operator<< ( TYPE input)
inline

Definition at line 1911 of file klang.h.

1911{ return operator=(input); }

◆ operator=() [1/2]

template<typename TYPE , std::enable_if_t<!std::is_arithmetic_v< std::decay_t< TYPE > > &&!std::is_same_v< std::decay_t< TYPE >, Control > &&std::is_convertible_v< TYPE &&, signal >, int > = 0>
Control & klang::Control::operator= ( TYPE && input)
inline

Definition at line 1884 of file klang.h.

1884 {
1885 const signal sample = std::forward<TYPE>(input);
1886 return set(sample);
1887 }
Control & set(float x)
Definition klang.h:1875

◆ operator=() [2/2]

template<typename TYPE , std::enable_if_t< std::is_arithmetic_v< TYPE >, int > = 0>
Control & klang::Control::operator= ( TYPE input)
inline

Definition at line 1881 of file klang.h.

1881{ return set(static_cast<float>(input)); }

◆ range()

float klang::Control::range ( ) const
inline

Definition at line 1868 of file klang.h.

1868{ return max - min; }

◆ set()

Control & klang::Control::set ( float x)
inline

Definition at line 1875 of file klang.h.

1875 {
1876 value = std::clamp(x, min, max);
1877 return *this;
1878 }

Referenced by klang::Controls::set().

◆ setNormalised()

void klang::Control::setNormalised ( float norm)
inline

Definition at line 1871 of file klang.h.

1871{ value.value = norm * range() + min; }

References klang::signal::value.

◆ smooth()

signal klang::Control::smooth ( )
inline

Definition at line 1866 of file klang.h.

1866{ return smoothed = smoothed * smoothing + (1.f - smoothing) * value; }
static constexpr float smoothing
Definition klang.h:1865
signal smoothed
Definition klang.h:1858

Referenced by klang::ControlMap::smooth().

Member Data Documentation

◆ initial

float klang::Control::initial

Definition at line 1852 of file klang.h.

◆ max

float klang::Control::max

Definition at line 1851 of file klang.h.

◆ min

float klang::Control::min

Definition at line 1850 of file klang.h.

◆ name

Caption klang::Control::name

Definition at line 1847 of file klang.h.

Referenced by klang::Controls::add(), and klang::Controls::add().

◆ options

Options klang::Control::options

Definition at line 1855 of file klang.h.

◆ size

Size klang::Control::size

Definition at line 1854 of file klang.h.

◆ smoothed

signal klang::Control::smoothed

Definition at line 1858 of file klang.h.

◆ smoothing

float klang::Control::smoothing = 0.999f
staticconstexpr

Definition at line 1865 of file klang.h.

◆ type

Type klang::Control::type = NONE

Definition at line 1848 of file klang.h.

◆ value