Parameters for the waveform painting. More...

#include <WavePaintParameters.h>

Collaboration diagram for WavePaintParameters:

Public Member Functions
WavePaintParameters &	SetDisplayParameters (int height, double zoomMin, double zoomMax, bool showClipping) noexcept
	Sets the basic painting parameters. More...

WavePaintParameters &	SetDBParameters (double dbRange, bool dbScale) noexcept
	Sets the dB scale parameters. More...

WavePaintParameters &	SetBlankColor (graphics::Color color) noexcept
	Sets the blank color. More...

WavePaintParameters &	SetBackgroundColors (graphics::Color normal, graphics::Color selected) noexcept
	Sets the background colors. More...

WavePaintParameters &	SetSampleColors (graphics::Color normal, graphics::Color selected) noexcept
	Sets the sample colors. More...

WavePaintParameters &	SetRMSColors (graphics::Color normal, graphics::Color selected) noexcept
	Sets the RMS colors. More...

WavePaintParameters &	SetClippingColors (graphics::Color normal, graphics::Color selected) noexcept
	Sets the clipping colors. More...

WavePaintParameters &	SetEnvelope (const Envelope &envelope) noexcept
	Sets volume envelope. More...

WavePaintParameters &	ResetEnvelope () noexcept
	Resets the envelope. More...

WavePaintParameters &	SetShowRMS (bool showRMS) noexcept
	Sets the ShowRMS flag. More...

Public Attributes
const Envelope *	AttachedEnvelope { nullptr }
	Attached volume envelope, if any. More...

int	Height { 0 }
	Height of the of clip on screen. More...

double	Min { -1.0 }
	Min value used to clip the output. More...

double	Max { 1.0 }
	Max value used to clip the output. More...

double	DBRange { 60.0 }
	Decibel range. More...

bool	DBScale { false }
	True, if we paint in dB scale. More...

bool	ShowClipping { false }
	True, if we mark clipped values. More...

bool	ShowRMS { true }
	True, if we paint RMS values on top of min and max. More...

graphics::Color	BlankColor
	Color outside the waveform area. More...

ColorPair	BackgroundColors
	Waveform background color. More...

ColorPair	SampleColors
	Color of the (min, max) line. More...

ColorPair	RMSColors
	Color of the (-rms, +rms) line. More...

ColorPair	ClippingColors
	Color for the columns where clipping has occurred. More...

Friends
WAVE_TRACK_PAINT_API bool	operator== (const WavePaintParameters &lhs, const WavePaintParameters &rhs) noexcept

WAVE_TRACK_PAINT_API bool	operator!= (const WavePaintParameters &lhs, const WavePaintParameters &rhs) noexcept

Detailed Description

Parameters for the waveform painting.

Definition at line 32 of file WavePaintParameters.h.

Member Function Documentation

◆ ResetEnvelope()

WavePaintParameters & WavePaintParameters::ResetEnvelope ( )

noexcept

Resets the envelope.

Definition at line 77 of file WavePaintParameters.cpp.

{
   AttachedEnvelope = nullptr;
   return *this;
}

References AttachedEnvelope.

◆ SetBackgroundColors()

WavePaintParameters & WavePaintParameters::SetBackgroundColors	(	graphics::Color	normal,
		graphics::Color	selected
	)

noexcept

Sets the background colors.

Definition at line 42 of file WavePaintParameters.cpp.

{
   BackgroundColors = { normal, selected };
   return *this;
}

Referenced by anonymous_namespace{WaveformView.cpp}::DrawWaveform().

Here is the caller graph for this function:

◆ SetBlankColor()

WavePaintParameters & WavePaintParameters::SetBlankColor ( graphics::Color color )

noexcept

Sets the blank color.

Definition at line 35 of file WavePaintParameters.cpp.

{
   BlankColor = color;
 
   return *this;
}

Referenced by anonymous_namespace{WaveformView.cpp}::DrawWaveform().

Here is the caller graph for this function:

◆ SetClippingColors()

WavePaintParameters & WavePaintParameters::SetClippingColors	(	graphics::Color	normal,
		graphics::Color	selected
	)

noexcept

Sets the clipping colors.

Definition at line 63 of file WavePaintParameters.cpp.

{
   ClippingColors = { normal, selected };
   return *this;
}

Referenced by anonymous_namespace{WaveformView.cpp}::DrawWaveform().

Here is the caller graph for this function:

◆ SetDBParameters()

WavePaintParameters & WavePaintParameters::SetDBParameters	(	double	dbRange,
		bool	dbScale
	)

noexcept

Sets the dB scale parameters.

Definition at line 26 of file WavePaintParameters.cpp.

{
   DBRange = dbRange;
   DBScale = dbScale;
 
   return *this;
}

Referenced by anonymous_namespace{WaveformView.cpp}::DrawWaveform().

Here is the caller graph for this function:

◆ SetDisplayParameters()

WavePaintParameters & WavePaintParameters::SetDisplayParameters	(	int	height,
		double	zoomMin,
		double	zoomMax,
		bool	showClipping
	)

noexcept

Sets the basic painting parameters.

Audacity: A Digital Audio Editor

WavePaintParameters.cpp

Dmitry Vedenko

Definition at line 13 of file WavePaintParameters.cpp.

{
   Height = height;
   Min = zoomMin;
   Max = zoomMax;
 
   ShowClipping = showClipping;
 
   return *this;
}

Referenced by anonymous_namespace{WaveformView.cpp}::DrawWaveform().

Here is the caller graph for this function:

◆ SetEnvelope()

WavePaintParameters & WavePaintParameters::SetEnvelope ( const Envelope & envelope )

noexcept

Sets volume envelope.

Definition at line 71 of file WavePaintParameters.cpp.

{
   AttachedEnvelope = &envelope;
   return *this;
}

Referenced by anonymous_namespace{WaveformView.cpp}::DrawWaveform().

Here is the caller graph for this function:

◆ SetRMSColors()

WavePaintParameters & WavePaintParameters::SetRMSColors	(	graphics::Color	normal,
		graphics::Color	selected
	)

noexcept

Sets the RMS colors.

Definition at line 56 of file WavePaintParameters.cpp.

{
   RMSColors = { normal, selected };
   return *this;
}

Referenced by anonymous_namespace{WaveformView.cpp}::DrawWaveform().

Here is the caller graph for this function:

◆ SetSampleColors()

WavePaintParameters & WavePaintParameters::SetSampleColors	(	graphics::Color	normal,
		graphics::Color	selected
	)

noexcept

Sets the sample colors.

Definition at line 49 of file WavePaintParameters.cpp.

{
   SampleColors = { normal, selected };
   return *this;
}

Referenced by anonymous_namespace{WaveformView.cpp}::DrawWaveform().

Here is the caller graph for this function:

◆ SetShowRMS()

WavePaintParameters & WavePaintParameters::SetShowRMS ( bool showRMS )

noexcept

Sets the ShowRMS flag.

Definition at line 83 of file WavePaintParameters.cpp.

{
   ShowRMS = showRMS;
   return *this;
}

Friends And Related Function Documentation

◆ operator!=

WAVE_TRACK_PAINT_API bool operator!=	(	const WavePaintParameters &	lhs,
		const WavePaintParameters &	rhs
	)

friend

Definition at line 114 of file WavePaintParameters.cpp.

{
   return !(lhs == rhs);
}

◆ operator==

WAVE_TRACK_PAINT_API bool operator==	(	const WavePaintParameters &	lhs,
		const WavePaintParameters &	rhs
	)

friend

Definition at line 99 of file WavePaintParameters.cpp.

{
   return lhs.AttachedEnvelope == rhs.AttachedEnvelope &&
          lhs.Height == rhs.Height && lhs.Min == rhs.Min &&
          lhs.Max == rhs.Max && lhs.DBRange == rhs.DBRange &&
          lhs.DBScale == rhs.DBScale && lhs.ShowClipping == rhs.ShowClipping &&
          lhs.BlankColor == rhs.BlankColor &&
          lhs.BackgroundColors == rhs.BackgroundColors &&
          lhs.SampleColors == rhs.SampleColors &&
          lhs.RMSColors == rhs.RMSColors &&
          lhs.ClippingColors == rhs.ClippingColors;
}

Member Data Documentation

◆ AttachedEnvelope

const Envelope* WavePaintParameters::AttachedEnvelope { nullptr }

Attached volume envelope, if any.

Definition at line 35 of file WavePaintParameters.h.

Referenced by ResetEnvelope().

◆ BackgroundColors

ColorPair WavePaintParameters::BackgroundColors

Waveform background color.

Definition at line 61 of file WavePaintParameters.h.

Referenced by WaveBitmapCache::LookupHelper::PerformLookup().

◆ BlankColor

graphics::Color WavePaintParameters::BlankColor

Color outside the waveform area.

Definition at line 58 of file WavePaintParameters.h.

Referenced by WaveBitmapCache::InitializeElement(), and WaveBitmapCache::LookupHelper::PerformLookup().

◆ ClippingColors

ColorPair WavePaintParameters::ClippingColors

Color for the columns where clipping has occurred.

Definition at line 67 of file WavePaintParameters.h.

Referenced by WaveBitmapCache::LookupHelper::PerformLookup().

◆ DBRange

double WavePaintParameters::DBRange { 60.0 }

Decibel range.

Definition at line 47 of file WavePaintParameters.h.

Referenced by WaveBitmapCache::LookupHelper::PerformLookup().

◆ DBScale

bool WavePaintParameters::DBScale { false }

True, if we paint in dB scale.

Definition at line 49 of file WavePaintParameters.h.

Referenced by WaveBitmapCache::LookupHelper::PerformLookup().

◆ Height

int WavePaintParameters::Height { 0 }

Height of the of clip on screen.

Definition at line 38 of file WavePaintParameters.h.

Referenced by WaveBitmapCache::InitializeElement(), and WaveBitmapCache::LookupHelper::PerformLookup().

◆ Max

double WavePaintParameters::Max { 1.0 }

Max value used to clip the output.

Definition at line 44 of file WavePaintParameters.h.

Referenced by WaveBitmapCache::LookupHelper::PerformLookup().

◆ Min

double WavePaintParameters::Min { -1.0 }

Min value used to clip the output.

Definition at line 42 of file WavePaintParameters.h.

Referenced by WaveBitmapCache::LookupHelper::PerformLookup().

◆ RMSColors

ColorPair WavePaintParameters::RMSColors

Color of the (-rms, +rms) line.

Definition at line 65 of file WavePaintParameters.h.

Referenced by WaveBitmapCache::LookupHelper::PerformLookup().

◆ SampleColors

ColorPair WavePaintParameters::SampleColors

Color of the (min, max) line.

Definition at line 63 of file WavePaintParameters.h.

Referenced by WaveBitmapCache::LookupHelper::PerformLookup().

◆ ShowClipping

bool WavePaintParameters::ShowClipping { false }

True, if we mark clipped values.

Definition at line 52 of file WavePaintParameters.h.

Referenced by WaveBitmapCache::LookupHelper::PerformLookup().

◆ ShowRMS

bool WavePaintParameters::ShowRMS { true }

True, if we paint RMS values on top of min and max.

Definition at line 55 of file WavePaintParameters.h.

Referenced by WaveBitmapCache::LookupHelper::PerformLookup().

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

Public Member Functions

Public Attributes

Friends

Detailed Description

Member Function Documentation

◆ ResetEnvelope()

◆ SetBackgroundColors()

◆ SetBlankColor()

◆ SetClippingColors()

◆ SetDBParameters()

◆ SetDisplayParameters()

◆ SetEnvelope()

◆ SetRMSColors()

◆ SetSampleColors()

◆ SetShowRMS()

Friends And Related Function Documentation

◆ operator!=

◆ operator==

Member Data Documentation

◆ AttachedEnvelope

◆ BackgroundColors

◆ BlankColor

◆ ClippingColors

◆ DBRange

◆ DBScale

◆ Height

◆ Max

◆ Min

◆ RMSColors

◆ SampleColors

◆ ShowClipping

◆ ShowRMS