JUCE
Public Member Functions | Public Attributes | List of all members
AudioProcessorParameterWithID Class Reference

This abstract base class is used by some AudioProcessorParameter helper classes. More...

+ Inheritance diagram for AudioProcessorParameterWithID:

Public Member Functions

 AudioProcessorParameterWithID (String parameterID, String name)
 Creation of this object requires providing a name and ID which will be constant for its lifetime. More...
 
 ~AudioProcessorParameterWithID ()
 Destructor. More...
 
- Public Member Functions inherited from AudioProcessorParameter
 AudioProcessorParameter () noexcept
 
virtual ~AudioProcessorParameter ()
 Destructor. More...
 
virtual float getValue () const =0
 Called by the host to find out the value of this parameter. More...
 
virtual void setValue (float newValue)=0
 The host will call this method to change the value of one of the filter's parameters. More...
 
void setValueNotifyingHost (float newValue)
 Your filter can call this when it needs to change one of its parameters. More...
 
void beginChangeGesture ()
 Sends a signal to the host to tell it that the user is about to start changing this parameter. More...
 
void endChangeGesture ()
 Tells the host that the user has finished changing this parameter. More...
 
virtual float getDefaultValue () const =0
 This should return the default value for this parameter. More...
 
virtual int getNumSteps () const
 Returns the number of discrete interval steps that this parameter's range should be quantised into. More...
 
virtual String getText (float value, int) const
 Returns a textual version of the supplied parameter value. More...
 
virtual float getValueForText (const String &text) const =0
 Should parse a string and return the appropriate value for it. More...
 
virtual bool isOrientationInverted () const
 This can be overridden to tell the host that this parameter operates in the reverse direction. More...
 
virtual bool isAutomatable () const
 Returns true if the host can automate this parameter. More...
 
virtual bool isMetaParameter () const
 Should return true if this parameter is a "meta" parameter. More...
 
int getParameterIndex () const noexcept
 Returns the index of this parameter in its parent processor's parameter list. More...
 

Public Attributes

const String paramID
 Provides access to the parameter's ID string. More...
 
const String name
 Provides access to the parameter's name. More...
 

Detailed Description

This abstract base class is used by some AudioProcessorParameter helper classes.

See also
AudioParameterFloat, AudioParameterInt, AudioParameterBool, AudioParameterChoice

Constructor & Destructor Documentation

AudioProcessorParameterWithID::AudioProcessorParameterWithID ( String  parameterID,
String  name 
)

Creation of this object requires providing a name and ID which will be constant for its lifetime.

AudioProcessorParameterWithID::~AudioProcessorParameterWithID ( )

Destructor.

Member Data Documentation

const String AudioProcessorParameterWithID::paramID

Provides access to the parameter's ID string.

const String AudioProcessorParameterWithID::name

Provides access to the parameter's name.


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