iPlug2 - C++ Audio Plug-in Framework
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
IParam::ShapeExp Struct Reference

Exponential parameter shaping. More...

#include <IPlugParameter.h>

Inheritance diagram for IParam::ShapeExp:
[legend]

Public Member Functions

void Init (const IParam &param) override
 Initializes the shape instance. More...
 
ShapeClone () const override
 
IParam::EDisplayType GetDisplayType () const override
 
double NormalizedToValue (double value, const IParam &param) const override
 Returns the real value from a normalized input, based on an IParam's settings. More...
 
double ValueToNormalized (double value, const IParam &param) const override
 Returns the normalized value from a real value, based on an IParam's settings. More...
 
virtual ShapeClone () const =0
 
virtual void Init (const IParam &param)
 Initializes the shape instance. More...
 
virtual EDisplayType GetDisplayType () const =0
 
virtual double NormalizedToValue (double value, const IParam &param) const =0
 Returns the real value from a normalized input, based on an IParam's settings. More...
 
virtual double ValueToNormalized (double value, const IParam &param) const =0
 Returns the normalized value from a real value, based on an IParam's settings. More...
 

Public Attributes

double mMul = 1.0
 
double mAdd = 1.0
 

Detailed Description

Exponential parameter shaping.

Definition at line 117 of file IPlugParameter.h.

Member Function Documentation

◆ Clone()

Shape * IParam::ShapeExp::Clone ( ) const
inlineoverridevirtual
Returns
A new instance of this Shape struct

Implements IParam::Shape.

Definition at line 120 of file IPlugParameter.h.

◆ GetDisplayType()

IParam::EDisplayType IParam::ShapeExp::GetDisplayType ( ) const
inlineoverridevirtual
Returns
EDisplayType, used by AudioUnit plugins to determine the mapping of parameters

Implements IParam::Shape.

Definition at line 121 of file IPlugParameter.h.

◆ Init()

void IParam::ShapeExp::Init ( const IParam param)
overridevirtual

Initializes the shape instance.

Parameters
paramThe parent parameter

Reimplemented from IParam::Shape.

Definition at line 61 of file IPlugParameter.cpp.

References IParam::GetMax(), and IParam::GetMin().

◆ NormalizedToValue()

double IParam::ShapeExp::NormalizedToValue ( double  value,
const IParam param 
) const
overridevirtual

Returns the real value from a normalized input, based on an IParam's settings.

Parameters
valueThe normalized value as a double to be converted
paramThe IParam to do the calculation against
Returns
double The real value

Implements IParam::Shape.

Definition at line 72 of file IPlugParameter.cpp.

◆ ValueToNormalized()

double IParam::ShapeExp::ValueToNormalized ( double  value,
const IParam param 
) const
overridevirtual

Returns the normalized value from a real value, based on an IParam's settings.

Parameters
valueThe real value as a double to be converted
paramThe IParam to do the calculation against
Returns
double The normalized value

Implements IParam::Shape.

Definition at line 77 of file IPlugParameter.cpp.

Member Data Documentation

◆ mAdd

double IParam::ShapeExp::mAdd = 1.0

Definition at line 126 of file IPlugParameter.h.

◆ mMul

double IParam::ShapeExp::mMul = 1.0

Definition at line 125 of file IPlugParameter.h.


The documentation for this struct was generated from the following files: