JUCE  v6.1.6 (6.0.8-1114)
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::AudioProcessorValueTreeStateParameterAttributes Class Reference

Advanced properties of an AudioProcessorValueTreeState::Parameter. More...

#include <juce_AudioProcessorValueTreeState.h>

Collaboration diagram for juce::AudioProcessorValueTreeStateParameterAttributes:

Public Member Functions

const JUCE_NODISCARD auto & getAudioParameterFloatAttributes () const
 
const JUCE_NODISCARD auto & getBoolean () const
 
const JUCE_NODISCARD auto & getDiscrete () const
 
JUCE_NODISCARD auto withAutomatable (bool x) const
 
JUCE_NODISCARD auto withBoolean (bool x) const
 Pass 'true' if this parameter only has two valid states. More...
 
JUCE_NODISCARD auto withCategory (Category x) const
 
JUCE_NODISCARD auto withDiscrete (bool x) const
 Pass 'true' if this parameter has discrete steps, or 'false' if the parameter is continuous. More...
 
JUCE_NODISCARD auto withInverted (bool x) const
 
JUCE_NODISCARD auto withLabel (String x) const
 
JUCE_NODISCARD auto withMeta (bool x) const
 
JUCE_NODISCARD auto withStringFromValueFunction (StringFromValue x) const
 
JUCE_NODISCARD auto withValueFromStringFunction (ValueFromString x) const
 

Private Types

using Category = AudioParameterFloatAttributes::Category
 
using StringFromValue = AudioParameterFloatAttributes::StringFromValue
 
using This = AudioProcessorValueTreeStateParameterAttributes
 
using ValueFromString = AudioParameterFloatAttributes::ValueFromString
 

Private Attributes

AudioParameterFloatAttributes attributes
 
bool boolean = false
 
bool discrete = false
 

Detailed Description

Advanced properties of an AudioProcessorValueTreeState::Parameter.

The members here have the same meaning as the similarly-named member functions of AudioParameterFloatAttributes.

See also
AudioParameterFloatAttributes, RangedAudioParameterAttributes

Member Typedef Documentation

◆ Category

◆ StringFromValue

◆ This

◆ ValueFromString

Member Function Documentation

◆ getAudioParameterFloatAttributes()

const JUCE_NODISCARD auto& juce::AudioProcessorValueTreeStateParameterAttributes::getAudioParameterFloatAttributes ( ) const
inline
Returns
all attributes that might also apply to an AudioParameterFloat

References attributes.

◆ getBoolean()

const JUCE_NODISCARD auto& juce::AudioProcessorValueTreeStateParameterAttributes::getBoolean ( ) const
inline
Returns
'true' if this parameter only has two valid states.

References boolean.

◆ getDiscrete()

const JUCE_NODISCARD auto& juce::AudioProcessorValueTreeStateParameterAttributes::getDiscrete ( ) const
inline
Returns
'true' if this parameter has discrete steps, or 'false' if the parameter is continuous.

References discrete.

◆ withAutomatable()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withAutomatable ( bool  x) const
inline

◆ withBoolean()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withBoolean ( bool  x) const
inline

Pass 'true' if this parameter only has two valid states.

Using an AudioParameterBool might be a better choice than setting this flag.

References boolean, juce::withMember(), and juce::gl::x.

◆ withCategory()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withCategory ( Category  x) const
inline

◆ withDiscrete()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withDiscrete ( bool  x) const
inline

Pass 'true' if this parameter has discrete steps, or 'false' if the parameter is continuous.

Using an AudioParameterChoice or AudioParameterInt might be a better choice than setting this flag.

References discrete, juce::withMember(), and juce::gl::x.

◆ withInverted()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withInverted ( bool  x) const
inline

◆ withLabel()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withLabel ( String  x) const
inline

◆ withMeta()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withMeta ( bool  x) const
inline

◆ withStringFromValueFunction()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withStringFromValueFunction ( StringFromValue  x) const
inline

◆ withValueFromStringFunction()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withValueFromStringFunction ( ValueFromString  x) const
inline

Member Data Documentation

◆ attributes

◆ boolean

bool juce::AudioProcessorValueTreeStateParameterAttributes::boolean = false
private

Referenced by getBoolean(), and withBoolean().

◆ discrete

bool juce::AudioProcessorValueTreeStateParameterAttributes::discrete = false
private

Referenced by getDiscrete(), and withDiscrete().


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