The ParameterMeta class defines the base interface for Parameter metadata. More...

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

Inheritance diagram for al::ParameterMeta:

Public Member Functions
	ParameterMeta (std::string parameterName, std::string group="")
	ParameterMeta. More...

	ParameterMeta (const ParameterMeta &)=delete

std::string	getFullAddress ()
	return the full OSC address for the parameter More...

std::string	getName ()
	getName returns the name of the parameter

std::string	displayName ()
	returns the text that should accompany parameters when displayed

void	displayName (std::string displayName)
	sets the text that should accompany parameters when displayed

std::string	getGroup ()
	getGroup returns the name of the group for the parameter

virtual float	toFloat ()
	Generic function to return the value of the parameter as a float. More...

virtual bool	fromFloat (float value)
	Generic function to set the parameter from a single float value. More...

void	setHint (std::string hintName, float hintValue)

float	getHint (std::string hintName, bool *exists=nullptr)

virtual void	getFields (std::vector< ParameterField > &)

virtual void	setFields (std::vector< ParameterField > &)

virtual void	sendValue (osc::Send &sender, std::string prefix="")

virtual void	sendMeta (osc::Send &sender, std::string bundleName="", std::string id="")

void	set (ParameterMeta *p)

Protected Attributes
std::string	mFullAddress

std::string	mParameterName

std::string	mDisplayName

std::string	mGroup

std::map< std::string, float >	mHints

Detailed Description

The ParameterMeta class defines the base interface for Parameter metadata.

Definition at line 246 of file al_Parameter.hpp.

Constructor & Destructor Documentation

◆ ParameterMeta()

al::ParameterMeta::ParameterMeta	(	std::string	parameterName,
		std::string	group = `""`
	)

ParameterMeta.

Parameters

parameterName
group
prefix

Member Function Documentation

◆ fromFloat()

virtual bool al::ParameterMeta::fromFloat ( float value )

inlinevirtual

Generic function to set the parameter from a single float value.

Will only have effect on parameters that have a single internal value and have implemented this function. Returns true if paramter is able to set value from float

Reimplemented in al::ParameterChoice, al::ParameterMenu, al::ParameterString, al::Trigger, al::ParameterBool, al::ParameterInt, and al::Parameter.

Definition at line 303 of file al_Parameter.hpp.

◆ getFullAddress()

std::string al::ParameterMeta::getFullAddress ( )

inline

return the full OSC address for the parameter

The parameter needs to be registered to a ParameterServer to listen to OSC values on this address

Definition at line 267 of file al_Parameter.hpp.

◆ toFloat()

virtual float al::ParameterMeta::toFloat ( )

inlinevirtual

Generic function to return the value of the parameter as a float.

If not implemented, it will return 0.

Reimplemented in al::ParameterChoice, al::ParameterMenu, al::ParameterString, al::Trigger, al::ParameterBool, al::ParameterInt, and al::Parameter.

Definition at line 294 of file al_Parameter.hpp.

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

al_Parameter.hpp

Public Member Functions