WavePaintParameters.h

Go to the documentation of this file.

/*  SPDX-License-Identifier: GPL-2.0-or-later */
/*!********************************************************************
 
  Audacity: A Digital Audio Editor
 
  WavePaintParameters.h
 
  Dmitry Vedenko
 
**********************************************************************/
#pragma once
 
#include "graphics/Color.h"
 
class Envelope;
 
struct WAVE_TRACK_PAINT_API ColorPair final
{
   graphics::Color Normal;
   graphics::Color Selected;
 
   friend WAVE_TRACK_PAINT_API bool
   operator==(const ColorPair& lhs, const ColorPair& rhs) noexcept;
   friend WAVE_TRACK_PAINT_API bool
   operator!=(const ColorPair& lhs, const ColorPair& rhs) noexcept;
};
 
struct WAVE_TRACK_PAINT_API WavePaintParameters final
{
   const Envelope* AttachedEnvelope { nullptr };
 
   int Height { 0 };
 
 
   double Min { -1.0 };
   double Max { 1.0 };
 
   double DBRange { 60.0 };
   bool DBScale { false };
 
   bool ShowClipping { false };
 
   bool ShowRMS { false };
 
   graphics::Color BlankColor;
   graphics::Color ZeroLineColor;
 
   ColorPair BackgroundColors;
   ColorPair SampleColors;
   ColorPair RMSColors;
   ColorPair ClippingColors;
 
   WavePaintParameters& SetDisplayParameters(int height, double zoomMin, double zoomMax, bool showClipping) noexcept;
   WavePaintParameters& SetDBParameters(double dbRange, bool dbScale) noexcept;
   WavePaintParameters& SetBlankColor(graphics::Color color) noexcept;
   WavePaintParameters& SetZeroLineColor(graphics::Color color) noexcept;
   WavePaintParameters& SetBackgroundColors(
      graphics::Color normal, graphics::Color selected) noexcept;
   WavePaintParameters&
   SetSampleColors(graphics::Color normal, graphics::Color selected) noexcept;
   WavePaintParameters&
   SetRMSColors(graphics::Color normal, graphics::Color selected) noexcept;
   WavePaintParameters&
   SetClippingColors(graphics::Color normal, graphics::Color selected) noexcept;
   WavePaintParameters& SetEnvelope(const Envelope& envelope) noexcept;
   WavePaintParameters& ResetEnvelope() noexcept;
   WavePaintParameters& SetShowRMS(bool showRMS) noexcept;
 
   friend WAVE_TRACK_PAINT_API bool operator==(
      const WavePaintParameters& lhs,
      const WavePaintParameters& rhs) noexcept;
 
   friend WAVE_TRACK_PAINT_API bool operator!=(
      const WavePaintParameters& lhs,
      const WavePaintParameters& rhs) noexcept;
};