Audacity 3.2.0
Public Types | Public Member Functions | Static Public Member Functions | List of all members
MeterValueProvider Class Referenceabstract

#include <MeterValueProvider.h>

Inheritance diagram for MeterValueProvider:
[legend]

Public Types

enum class  Direction { Upwards , Downwards }
 

Public Member Functions

virtual ~MeterValueProvider ()=default
 
virtual void Update (float value, bool alsoFiveSecondMax)=0
 
virtual float GetGlobalMax () const =0
 
virtual float GetFiveSecMax () const =0
 
virtual float GetCurrentMax () const =0
 
virtual Direction GetDirection () const =0
 
virtual bool IsInvisible () const =0
 

Static Public Member Functions

static std::unique_ptr< MeterValueProviderCreate (Direction direction)
 

Detailed Description


Audacity: A Digital Audio Editor

MeterValueProvider.h

Matthieu Hodgkinson

Definition at line 15 of file MeterValueProvider.h.

Member Enumeration Documentation

◆ Direction

enum class MeterValueProvider::Direction
strong
Enumerator
Upwards 
Downwards 

Definition at line 18 of file MeterValueProvider.h.

19 {
20 Upwards,
21 Downwards
22 };

Constructor & Destructor Documentation

◆ ~MeterValueProvider()

virtual MeterValueProvider::~MeterValueProvider ( )
virtualdefault

Member Function Documentation

◆ Create()

std::unique_ptr< MeterValueProvider > MeterValueProvider::Create ( Direction  direction)
static

Audacity: A Digital Audio Editor

MeterValueProvider.cpp

Matthieu Hodgkinson

Definition at line 18 of file MeterValueProvider.cpp.

19{
20 switch (direction)
21 {
23 return std::make_unique<UpwardMeterValueProvider>();
25 return std::make_unique<DownwardMeterValueProvider>();
26 default:
27 assert(false);
28 return nullptr;
29 }
30}

References Downwards, and Upwards.

Referenced by CompressionMeterPanel::Reset().

Here is the caller graph for this function:

◆ GetCurrentMax()

virtual float MeterValueProvider::GetCurrentMax ( ) const
pure virtual

Implemented in DownwardMeterValueProvider, and UpwardMeterValueProvider.

Referenced by CompressionMeterPanel::PaintMeter().

Here is the caller graph for this function:

◆ GetDirection()

virtual Direction MeterValueProvider::GetDirection ( ) const
pure virtual

Implemented in DownwardMeterValueProvider, and UpwardMeterValueProvider.

Referenced by CompressionMeterPanel::PaintMeter().

Here is the caller graph for this function:

◆ GetFiveSecMax()

virtual float MeterValueProvider::GetFiveSecMax ( ) const
pure virtual

Implemented in DownwardMeterValueProvider, and UpwardMeterValueProvider.

Referenced by CompressionMeterPanel::PaintMeter().

Here is the caller graph for this function:

◆ GetGlobalMax()

virtual float MeterValueProvider::GetGlobalMax ( ) const
pure virtual

Implemented in DownwardMeterValueProvider, and UpwardMeterValueProvider.

Referenced by CompressionMeterPanel::PaintMeter().

Here is the caller graph for this function:

◆ IsInvisible()

virtual bool MeterValueProvider::IsInvisible ( ) const
pure virtual

◆ Update()

virtual void MeterValueProvider::Update ( float  value,
bool  alsoFiveSecondMax 
)
pure virtual

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