sbl::control::Pickup Class Reference

A takeover source must reach the held value before it captures it. More...

Detailed Description

A takeover source must reach the held value before it captures it.

When another source sets the parameter (hold()), the takeover source — a knob — is ignored until it crosses the held value or comes within the window of it. From then on the parameter follows the knob until the next hold(). Without a hold the knob drives the parameter directly.

Definition at line 138 of file merge.hpp.

#include <merge.hpp>

Public Member Functions
	Pickup (float window=0.01f)
void	hold (float value)
	Another source set the parameter; the takeover source must now reach it.
float	process (float source)
	Feed the takeover source (every tick). Returns the parameter value.
bool	caught () const
	True while the takeover source drives the parameter.
float	value () const
void	release ()
	Hand the parameter to the takeover source now (e.g. a panel reset).

Constructor & Destructor Documentation

Pickup()

sbl::control::Pickup::Pickup ( float  window = 0.01f )

inlineexplicit

Definition at line 140 of file merge.hpp.

Member Function Documentation

hold()

void sbl::control::Pickup::hold ( float  value )

inline

Another source set the parameter; the takeover source must now reach it.

Definition at line 143 of file merge.hpp.

References value().

process()

float sbl::control::Pickup::process ( float  source )

inline

Feed the takeover source (every tick). Returns the parameter value.

Definition at line 150 of file merge.hpp.

caught()

bool sbl::control::Pickup::caught ( ) const

inline

True while the takeover source drives the parameter.

Definition at line 168 of file merge.hpp.

value()

float sbl::control::Pickup::value ( ) const

inline

Definition at line 170 of file merge.hpp.

Referenced by hold().

release()

void sbl::control::Pickup::release ( )

inline

Hand the parameter to the takeover source now (e.g. a panel reset).

Definition at line 173 of file merge.hpp.

---

The documentation for this class was generated from the following file:

• src/sbl/control/merge.hpp