klang::Controls

Plugin UI controls. More...

#include <klang.h>

Inheritance diagram for klang::Controls:

Public Member Functions
void	operator+= (const Control &control)
void	operator= (const Controls &controls)
void	operator= (std::initializer_list< Control > controls)
void	add (const char *name, Control::Type type=Control::ROTARY, float min=0.f, float max=1.f, float initial=0.f, Control::Size size=Automatic)
bool	changed ()
unsigned int	size () const
	The current number of items in the array.
void	add (const Control &item)
	Add the specified item to the end of the array.
Control *	add ()
	Add a blank item to the end of the array, returning a pointer that allows the item to be modified.
void	clear ()
	Clear the array contents. Only resets the item count, without wiping memory.
float	max () const
	Find the maximum value in the array.
float	mean () const
	Find the mean average of values in the array.
float	rms () const
	Find the root mean squared (RMS) average of values in the array.
void	normalise (float target=1.f, int mode=Peak)
	Normalises values in the array to the specified target, based on peak, mean, or RMS value;.
Control &	operator[] (int index)
	Returns a reference to the array item at the given index.
const Control &	operator[] (int index) const
	Returns a read-only reference to the array item at the given index.

Static Public Member Functions
static int	capacity ()
	The maximum capacity of the array.

Public Attributes
float	value [128] = { 0 }
Control	items [CAPACITY]
unsigned int	count

Detailed Description

Definition at line 1095 of file klang.h.

Member Function Documentation

add() [1/3]

Control * klang::Array< Control, CAPACITY >::add ( )

inlineinherited

Definition at line 255 of file klang.h.

                {
      if (count < CAPACITY)
        return &items[count++];
      return nullptr;
    }

add() [2/3]

void klang::Array< Control, CAPACITY >::add ( const Control & item )

inlineinherited

Definition at line 249 of file klang.h.

                               {
      if(count < CAPACITY)
        items[count++] = item;
    }

add() [3/3]

void klang::Controls::add ( const char * name, Control::Type type = Control::ROTARY, float min = 0.f, float max = 1.f, float initial = 0.f, Control::Size size = Automatic )

inline

Definition at line 1113 of file klang.h.

                                                                                                                                                      {
      items[count].name = name;
      items[count].type = type;
      items[count].min = min;
      items[count].max = max;
      items[count].initial = initial;
      items[count].size = size;
      items[count++].value = initial;
    } 

References klang::Control::initial, klang::Control::max, klang::Control::min, klang::Control::name, klang::Text< SIZE >::operator=(), klang::Control::size, klang::Control::type, and klang::Control::value.

capacity()

static int klang::Array< Control, CAPACITY >::capacity ( )

inlinestaticinherited

Definition at line 243 of file klang.h.

{ return CAPACITY; }

changed()

bool klang::Controls::changed ( )

inline

Definition at line 1123 of file klang.h.

                   {
      bool changed = false;
      for (unsigned int c = 0; c < count; c++) {
        if (items[c].value != value[c]) {
          value[c] = items[c].value;
          changed = true;
        }
      }
      return changed;
    }

References klang::Control::value, and value.

clear()

void klang::Array< Control, CAPACITY >::clear ( )

inlineinherited

Definition at line 262 of file klang.h.

{ count = 0; }

max()

float klang::Array< Control, CAPACITY >::max ( ) const

inlineinherited

Definition at line 265 of file klang.h.

                      {
      float max = 0.f;
      for (unsigned int i = 0; i < count; i++)
        if (abs(items[i]) > max)
          max = items[i];
      return max;
    }

mean()

float klang::Array< Control, CAPACITY >::mean ( ) const

inlineinherited

Definition at line 274 of file klang.h.

                       {
      float sum = 0.f;
      for (unsigned int i = 0; i < count; i++)
        sum += abs(items[i]);
      return sum / count;
    }

normalise()

void klang::Array< Control, CAPACITY >::normalise ( float target = 1.f, int mode = Peak )

inlineinherited

Definition at line 290 of file klang.h.

                                                        {
      if (!count) return;
      
      const float current = (mode == Peak) ? max() : (mode == Mean) ? mean() : rms();
      const float scale = current == 0.f ? 0.f : target / current;
      for (int i = 0; i < count; i++)
        items[i] *= scale;
    }

operator+=()

void klang::Controls::operator+= ( const Control & control )

inline

Definition at line 1099 of file klang.h.

                                             {
      items[count++] = control;
    }

Referenced by operator=(), and operator=().

operator=() [1/2]

void klang::Controls::operator= ( const Controls & controls )

inline

Definition at line 1103 of file klang.h.

                                              {
      for (int c = 0; c < 128 && controls[c].type != Control::NONE; c++)
        operator+=(controls[c]);
    }

References klang::Control::NONE, operator+=(), klang::Array< TYPE, CAPACITY >::operator[](), and klang::Control::type.

operator=() [2/2]

void klang::Controls::operator= ( std::initializer_list< Control > controls )

inline

Definition at line 1108 of file klang.h.

                                                          {
      for(auto control : controls)
        operator+=(control);
    }

References operator+=().

operator[]() [1/2]

Control & klang::Array< Control, CAPACITY >::operator[] ( int index )

inlineinherited

Definition at line 300 of file klang.h.

{ return items[index]; }

operator[]() [2/2]

const Control & klang::Array< Control, CAPACITY >::operator[] ( int index ) const

inlineinherited

Definition at line 303 of file klang.h.

{ return items[index]; }

rms()

float klang::Array< Control, CAPACITY >::rms ( ) const

inlineinherited

Definition at line 282 of file klang.h.

                      {
      float sum = 0.f;
      for (unsigned int i = 0; i < count; i++)
        sum += items[i] * items[i];
      return sqrt(sum / count);
    }

size()

unsigned int klang::Array< Control, CAPACITY >::size ( ) const

inlineinherited

Definition at line 246 of file klang.h.

{ return count; }

Member Data Documentation

count

unsigned int klang::Array< Control, CAPACITY >::count

inherited

Definition at line 240 of file klang.h.

items

Control klang::Array< Control, CAPACITY >::items[CAPACITY]

inherited

Definition at line 239 of file klang.h.

value

float klang::Controls::value[128] = { 0 }

Definition at line 1097 of file klang.h.

{ 0 };

Referenced by changed().