A SetTrackBase that sets appearance of a track. More...

#include <SetTrackInfoCommand.h>

Inheritance diagram for SetTrackVisualsCommand:

Collaboration diagram for SetTrackVisualsCommand:

Public Member Functions
ComponentInterfaceSymbol	GetSymbol () const override

TranslatableString	GetDescription () const override

template<bool Const>
bool	VisitSettings (SettingsVisitorBase< Const > &S)

bool	VisitSettings (SettingsVisitor &S) override

bool	VisitSettings (ConstSettingsVisitor &S) override

void	PopulateOrExchange (ShuttleGui &S) override

ManualPageID	ManualPage () override

bool	ApplyInner (const CommandContext &context, Track &t) override

Public Member Functions inherited from SetTrackBase
bool	Apply (const CommandContext &context) final

virtual bool	ApplyInner (const CommandContext &context, Track &t)=0

Public Member Functions inherited from AudacityCommand
	AudacityCommand ()

virtual	~AudacityCommand ()

PluginPath	GetPath () const override

VendorSymbol	GetVendor () const override

wxString	GetVersion () const override

ComponentInterfaceSymbol	GetSymbol () const override=0

virtual TranslatableString	GetDescription () const override

virtual ManualPageID	ManualPage ()

virtual bool	IsBatchProcessing () const

virtual void	SetBatchProcessing (bool start)

virtual bool	Apply (const CommandContext &WXUNUSED(context))

bool	ShowInterface (wxWindow *parent, bool forceModal=false)

wxDialog *	CreateUI (wxWindow parent, AudacityCommand client)

bool	SaveSettingsAsString (wxString &parms)

bool	LoadSettingsFromString (const wxString &parms)

bool	DoAudacityCommand (const CommandContext &context, bool shouldPrompt=true)

int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})

virtual bool	Init ()

virtual bool	PromptUser (AudacityProject &)

virtual bool	CheckWhetherSkipAudacityCommand ()

virtual void	End ()

virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))

virtual bool	TransferDataToWindow ()

virtual bool	TransferDataFromWindow ()

virtual bool	VisitSettings (SettingsVisitor &)

virtual bool	VisitSettings (ConstSettingsVisitor &)

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

virtual PluginPath	GetPath () const =0

virtual ComponentInterfaceSymbol	GetSymbol () const =0

virtual VendorSymbol	GetVendor () const =0

virtual wxString	GetVersion () const =0

virtual TranslatableString	GetDescription () const =0

TranslatableString	GetName () const

Public Attributes
int	mColour

int	mHeight

int	mDisplayType

int	mScaleType

int	mVZoom

double	mVZoomTop

double	mVZoomBottom

bool	bUseSpecPrefs

bool	bSpectralSelect

int	mSpecColorScheme

bool	bHasColour

bool	bHasHeight

bool	bHasDisplayType

bool	bHasScaleType

bool	bHasVZoom

bool	bHasVZoomTop

bool	bHasVZoomBottom

bool	bHasUseSpecPrefs

bool	bHasSpectralSelect

bool	bHasSpecColorScheme

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol { XO("Set Track Visuals") }

Additional Inherited Members
Public Types inherited from AudacityCommand
enum	: long { DefaultMessageBoxStyle = wxOK \| wxCENTRE }

Protected Attributes inherited from AudacityCommand
ProgressDialog *	mProgress

wxDialog *	mUIDialog

wxWindow *	mUIParent

Detailed Description

A SetTrackBase that sets appearance of a track.

Definition at line 92 of file SetTrackInfoCommand.h.

Member Function Documentation

◆ ApplyInner()

bool SetTrackVisualsCommand::ApplyInner	(	const CommandContext &	context,
		Track &	t
	)

overridevirtual

Implements SetTrackBase.

Definition at line 325 of file SetTrackInfoCommand.cpp.

{
   static_cast<void>(context);
   const auto wt = dynamic_cast<WaveTrack *>(&t);
   if (!wt)
      return true;
   auto &wc = **wt->Channels().begin();
   //auto pt = dynamic_cast<PlayableTrack *>(t);
   static const double ZOOMLIMIT = 0.001f;
 
   if (bHasColour)
      WaveformAppearance::Get(*wt).SetColorIndex(mColour);
 
   if (bHasHeight)
      for (auto pChannel : t.Channels<WaveChannel>())
         ChannelView::Get(*pChannel).SetExpandedHeight(mHeight);
 
   if (bHasDisplayType) {
      auto &view = WaveChannelView::Get(wc);
      auto &all = WaveChannelSubViewType::All();
      if (mDisplayType < all.size())
         view.SetDisplay( all[ mDisplayType ].id );
      else {
         view.SetMultiView( true );
         view.SetDisplay(WaveChannelSubViewType::Default(), false);
      }
   }
   if (bHasScaleType) {
      auto &scaleType = WaveformSettings::Get(*wt).scaleType;
      switch (mScaleType) {
      default:
      case kLinearAmp: scaleType = WaveformSettings::stLinearAmp;
      case kLogarithmicDb: scaleType = WaveformSettings::stLogarithmicDb;
      case kLinearDb: scaleType = WaveformSettings::stLinearDb;
      }
   }
 
   if (bHasVZoom) {
      auto &cache = WaveformScale::Get(*wt);
      switch( mVZoom ){
         default:
         case kReset: cache.SetDisplayBounds(-1,1); break;
         case kTimes2: cache.SetDisplayBounds(-2,2); break;
         case kHalfWave: cache.SetDisplayBounds(0,1); break;
      }
   }
 
   if ((bHasVZoomTop || bHasVZoomBottom) && !bHasVZoom) {
      float vzmin, vzmax;
      auto &cache = WaveformScale::Get(*wt);
      cache.GetDisplayBounds(vzmin, vzmax);
 
      if ( !bHasVZoomTop ){
         mVZoomTop = vzmax;
      }
      if ( !bHasVZoomBottom ){
         mVZoomBottom = vzmin;
      }
 
      mVZoomTop = std::clamp(mVZoomTop, -2.0, 2.0);
      mVZoomBottom = std::clamp(mVZoomBottom, -2.0, 2.0);
 
      if (mVZoomBottom > mVZoomTop){
         std::swap(mVZoomTop, mVZoomBottom);
      }
      if ( mVZoomTop - mVZoomBottom < ZOOMLIMIT ){
         double c = (mVZoomBottom + mVZoomTop) / 2;
         mVZoomBottom = c - ZOOMLIMIT / 2.0;
         mVZoomTop = c + ZOOMLIMIT / 2.0;
      }
      cache.SetDisplayBounds(mVZoomBottom, mVZoomTop);
      auto &tp = TrackPanel::Get( context.project );
      tp.UpdateVRulers();
   }
 
   if (bHasUseSpecPrefs) {
      if (bUseSpecPrefs)
         // reset it, and next we will be getting the defaults.
         SpectrogramSettings::Reset(wc);
      else
         SpectrogramSettings::Own(wc);
   }
   auto &settings = SpectrogramSettings::Get(*wt);
   if (wt && bHasSpectralSelect)
      settings.spectralSelection = bSpectralSelect;
   if (wt && bHasSpecColorScheme)
      settings.colorScheme =
         static_cast<SpectrogramSettings::ColorScheme>(mSpecColorScheme);
 
   return true;
}

References WaveChannelSubViewType::All(), bHasColour, bHasDisplayType, bHasHeight, bHasScaleType, bHasSpecColorScheme, bHasSpectralSelect, bHasUseSpecPrefs, bHasVZoom, bHasVZoomBottom, bHasVZoomTop, bSpectralSelect, bUseSpecPrefs, ChannelGroup::Channels(), WaveTrack::Channels(), WaveChannelSubViewType::Default(), TrackPanel::Get(), ChannelView::Get(), SpectrogramSettings::Get(), WaveformSettings::Get(), WaveformScale::Get(), WaveChannelView::Get(), WaveformAppearance::Get(), kHalfWave, kLinearAmp, kLinearDb, kLogarithmicDb, kReset, kTimes2, mColour, mDisplayType, mHeight, mScaleType, mSpecColorScheme, mVZoom, mVZoomBottom, mVZoomTop, SpectrogramSettings::Own(), CommandContext::project, SpectrogramSettings::Reset(), WaveformSettings::scaleType, WaveformAppearance::SetColorIndex(), ChannelView::SetExpandedHeight(), settings(), WaveformSettings::stLinearAmp, WaveformSettings::stLinearDb, WaveformSettings::stLogarithmicDb, and anonymous_namespace{NoteTrack.cpp}::swap().

Referenced by SetTrackCommand::ApplyInner().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDescription()

TranslatableString SetTrackVisualsCommand::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 100 of file SetTrackInfoCommand.h.

100{return XO("Sets various values for a track.");};

XO

XO("Cut/Copy/Paste")

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol SetTrackVisualsCommand::GetSymbol ( ) const

inlineoverridevirtual

Implements AudacityCommand.

Definition at line 99 of file SetTrackInfoCommand.h.

99{return Symbol;};

SetTrackVisualsCommand::Symbol

static const ComponentInterfaceSymbol Symbol

Definition: SetTrackInfoCommand.h:95

References Symbol.

◆ ManualPage()

ManualPageID SetTrackVisualsCommand::ManualPage ( )

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 107 of file SetTrackInfoCommand.h.

107{return L"Extra_Menu:_Scriptables_I#set_track_visuals";}

◆ PopulateOrExchange()

void SetTrackVisualsCommand::PopulateOrExchange ( ShuttleGui & S )

override

Definition at line 283 of file SetTrackInfoCommand.cpp.

{
   S.StartMultiColumn(3, wxEXPAND);
   {
      S.SetStretchyCol( 2 );
      S.Optional( bHasHeight      ).TieNumericTextBox(  XXO("Height:"),        mHeight );
      S.Optional( bHasColour      ).TieChoice(          XXO("Color:"),         mColour,
         Msgids(  kColourStrings, nColours ) );
 
      {
         auto symbols = DiscoverSubViewTypes();
         auto typeNames = transform_container<TranslatableStrings>(
             symbols, std::mem_fn( &EnumValueSymbol::Stripped ) );
         S.Optional( bHasDisplayType ).TieChoice(          XXO("Display:"),       mDisplayType,
            typeNames );
      }
 
      S.Optional( bHasScaleType   ).TieChoice(          XXO("Scale:"),         mScaleType,
         Msgids( kScaleTypeStrings, nScaleTypes ) );
      S.Optional( bHasVZoom       ).TieChoice(          XXO("VZoom:"),         mVZoom,
         Msgids( kZoomTypeStrings, nZoomTypes ) );
      S.Optional( bHasVZoomTop    ).TieTextBox(         XXO("VZoom Top:"),     mVZoomTop );
      S.Optional( bHasVZoomBottom ).TieTextBox(         XXO("VZoom Bottom:"),  mVZoomBottom );
   }
   S.EndMultiColumn();
   S.StartMultiColumn(2, wxEXPAND);
   {
      S.SetStretchyCol( 1 );
      S.Optional( bHasUseSpecPrefs   ).TieCheckBox( XXO("Use Spectral Prefs"), bUseSpecPrefs );
      S.Optional( bHasSpectralSelect ).TieCheckBox( XXO("Spectral Select"),    bSpectralSelect);
   }
   S.EndMultiColumn();
   S.StartMultiColumn(3, wxEXPAND);
   {
      S.SetStretchyCol( 2 );
      auto schemes = SpectrogramSettings::GetColorSchemeNames();
      S.Optional( bHasSpecColorScheme).TieChoice( XC("Sche&me:", "spectrum prefs"), mSpecColorScheme,
         Msgids( schemes.data(), schemes.size() ) );
   }
   S.EndMultiColumn();
}

References bHasColour, bHasDisplayType, bHasHeight, bHasScaleType, bHasSpecColorScheme, bHasSpectralSelect, bHasUseSpecPrefs, bHasVZoom, bHasVZoomBottom, bHasVZoomTop, bSpectralSelect, bUseSpecPrefs, DiscoverSubViewTypes(), SpectrogramSettings::GetColorSchemeNames(), kColourStrings, kScaleTypeStrings, kZoomTypeStrings, mColour, mDisplayType, mHeight, mScaleType, Msgids(), mSpecColorScheme, mVZoom, mVZoomBottom, mVZoomTop, nColours, nScaleTypes, nZoomTypes, S, ComponentInterfaceSymbol::Stripped(), XC, and XXO().

Referenced by SetTrackCommand::PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VisitSettings() [1/3]

bool SetTrackVisualsCommand::VisitSettings ( ConstSettingsVisitor & )

overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 280 of file SetTrackInfoCommand.cpp.

281 { return VisitSettings<true>(S); }

References S.

◆ VisitSettings() [2/3]

bool SetTrackVisualsCommand::VisitSettings ( SettingsVisitor & )

overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 277 of file SetTrackInfoCommand.cpp.

278 { return VisitSettings<false>(S); }

References S.

◆ VisitSettings() [3/3]

template<bool Const>

bool SetTrackVisualsCommand::VisitSettings ( SettingsVisitorBase< Const > & S )

Definition at line 254 of file SetTrackInfoCommand.cpp.

                                                                          {
   S.OptionalN( bHasHeight         ).Define(     mHeight,         wxT("Height"),     120, 44, 2000 );
 
   {
      auto symbols = DiscoverSubViewTypes();
      S.OptionalN( bHasDisplayType    ).DefineEnum( mDisplayType,    wxT("Display"),    0, symbols.data(), symbols.size() );
   }
 
   S.OptionalN( bHasScaleType      ).DefineEnum( mScaleType,      wxT("Scale"),      kLinearAmp,   kScaleTypeStrings, nScaleTypes );
   S.OptionalN( bHasColour         ).DefineEnum( mColour,         wxT("Color"),      kColour0,  kColourStrings, nColours );
   S.OptionalN( bHasVZoom          ).DefineEnum( mVZoom,          wxT("VZoom"),      kReset,    kZoomTypeStrings, nZoomTypes );
   S.OptionalN( bHasVZoomTop       ).Define(     mVZoomTop,       wxT("VZoomHigh"),  1.0,  -2.0,  2.0 );
   S.OptionalN( bHasVZoomBottom    ).Define(     mVZoomBottom,    wxT("VZoomLow"),   -1.0, -2.0,  2.0 );
 
   S.OptionalN( bHasUseSpecPrefs   ).Define(     bUseSpecPrefs,   wxT("SpecPrefs"),  false );
   S.OptionalN( bHasSpectralSelect ).Define(     bSpectralSelect, wxT("SpectralSel"),true );
 
   auto schemes = SpectrogramSettings::GetColorSchemeNames();
   S.OptionalN( bHasSpecColorScheme).DefineEnum( mSpecColorScheme,wxT("SpecColor"),  SpectrogramSettings::csColorNew, schemes.data(), schemes.size());
 
   return true;
};