Allolib  1.0
C++ Components For Interactive Multimedia
al::ParameterBundle Class Reference

#include <C:/Users/Andres/source/repos/casm_viewer/external/tinc/external/allolib/include/al/ui/al_ParameterBundle.hpp>

Public Member Functions

 ParameterBundle (std::string name="")
 ParameterBundle. More...
 
std::string name () const
 get the name for this bundle More...
 
void name (std::string newName)
 set the name for this bundle More...
 
std::string bundlePrefix () const
 get the prefix for this bundle More...
 
int bundleIndex () const
 
void addParameter (ParameterMeta *parameter)
 
void addParameter (ParameterMeta &parameter)
 
void addBundle (ParameterBundle &bundle, std::string id="")
 
void clear ()
 clear bundle More...
 
std::vector< ParameterMeta * > & parameters ()
 
std::map< std::string, std::vector< ParameterBundle * > > & bundles ()
 
ParameterBundleoperator<< (ParameterMeta *parameter)
 
ParameterBundleoperator<< (ParameterMeta &parameter)
 
void addNotifier (OSCNotifier *notifier)
 

Detailed Description

ParameterBundle

Definition at line 56 of file al_ParameterBundle.hpp.

Constructor & Destructor Documentation

◆ ParameterBundle()

al::ParameterBundle::ParameterBundle ( std::string  name = "")

ParameterBundle.

Parameters
prefixprefix to add to OSC path

If no prefix is given, each new ParameterBundle gets a different consecutive number with the prefix "bundle_" e.g. bundle_0, bundle_1, etc.

Member Function Documentation

◆ bundlePrefix()

std::string al::ParameterBundle::bundlePrefix ( ) const

get the prefix for this bundle

Returns
the prefix string, includes the name and the index or id e.g. /thing/3

◆ clear()

void al::ParameterBundle::clear ( )
inline

clear bundle

Note this function is not thread safe, so it must be called in the same conetext where the bundle is processed.

Definition at line 101 of file al_ParameterBundle.hpp.

◆ name() [1/2]

std::string al::ParameterBundle::name ( ) const

get the name for this bundle

Returns
the bundle name

◆ name() [2/2]

void al::ParameterBundle::name ( std::string  newName)

set the name for this bundle

Make sure you call this before the bundle is being used as this is not thread safe


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