Command that sets envelope information. More...

#include <SetEnvelopeCommand.h>

Inheritance diagram for SetEnvelopeCommand:

Collaboration diagram for SetEnvelopeCommand:

Public Member Functions
	SetEnvelopeCommand ()

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 (wxWindow *parent, const CommandContext &context, bool shouldPrompt=true)

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

virtual bool	Init ()

virtual bool	PromptUser (wxWindow *parent)

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
double	mT

double	mV

bool	mbDelete

bool	bHasT

bool	bHasV

bool	bHasDelete

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

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

Command that sets envelope information.

Definition at line 21 of file SetEnvelopeCommand.h.

Constructor & Destructor Documentation

◆ SetEnvelopeCommand()

SetEnvelopeCommand::SetEnvelopeCommand ( )

Definition at line 41 of file SetEnvelopeCommand.cpp.

42{

43}

Member Function Documentation

◆ ApplyInner()

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

overridevirtual

Implements SetTrackBase.

Definition at line 72 of file SetEnvelopeCommand.cpp.

{
   // if no time is specified, then
   //   - delete deletes any envelope in selected tracks.
   //   - value is not set for any clip
   t.TypeSwitch([&](WaveTrack &waveTrack) {
      for (const auto pClip : waveTrack.SortedIntervalArray()) {
         bool bFound =
            !bHasT || (
               (pClip->GetPlayStartTime() <= mT) &&
               (pClip->GetPlayEndTime() >= mT)
            );
         if (bFound) {
            // Inside this IF is where we actually apply the command
            auto &env = pClip->GetEnvelope();
            bool didSomething = false;
            if (bHasDelete && mbDelete)
               env.Clear(), didSomething = true;
            if (bHasT && bHasV)
               env.InsertOrReplace(mT, env.ClampValue(mV)),
               didSomething = true;
 
            if (didSomething)
               // Consolidate, because this ApplyInner() function may be
               // visited multiple times in one command invocation
               ProjectHistory::Get(context.project).PushState(
                  XO("Edited Envelope"), XO("Envelope"),
                  UndoPush::CONSOLIDATE);
         }
      }
   } );
 
 
   return true;
}

References WaveTrack::SortedIntervalArray(), and Track::TypeSwitch().

Here is the call graph for this function:

◆ GetDescription()

TranslatableString SetEnvelopeCommand::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 29 of file SetEnvelopeCommand.h.

29{return XO("Sets an envelope point position.");};

XO

XO("Cut/Copy/Paste")

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol SetEnvelopeCommand::GetSymbol ( ) const

inlineoverridevirtual

Implements AudacityCommand.

Definition at line 28 of file SetEnvelopeCommand.h.

28{return Symbol;};

SetEnvelopeCommand::Symbol

static const ComponentInterfaceSymbol Symbol

Definition: SetEnvelopeCommand.h:24

References Symbol.

◆ ManualPage()

ManualPageID SetEnvelopeCommand::ManualPage ( )

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 36 of file SetEnvelopeCommand.h.

36{return L"Extra_Menu:_Scriptables_I#set_envelope";}

◆ PopulateOrExchange()

void SetEnvelopeCommand::PopulateOrExchange ( ShuttleGui & S )

override

Definition at line 59 of file SetEnvelopeCommand.cpp.

{
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(3, wxALIGN_CENTER);
   {
      S.Optional( bHasT           ).TieNumericTextBox(  XXO("Time:"),          mT );
      S.Optional( bHasV           ).TieNumericTextBox(  XXO("Value:"),         mV );
      S.Optional( bHasDelete      ).TieCheckBox(        XXO("Delete"),         mbDelete );
   }
   S.EndMultiColumn();
}

References bHasDelete, bHasT, bHasV, mbDelete, mT, mV, S, and XXO().

Here is the call graph for this function:

◆ VisitSettings() [1/3]

bool SetEnvelopeCommand::VisitSettings ( ConstSettingsVisitor & )

overridevirtual

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

Reimplemented from AudacityCommand.

Definition at line 56 of file SetEnvelopeCommand.cpp.

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

References S.

◆ VisitSettings() [2/3]

bool SetEnvelopeCommand::VisitSettings ( SettingsVisitor & )

overridevirtual

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

Reimplemented from AudacityCommand.

Definition at line 53 of file SetEnvelopeCommand.cpp.

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

References S.

◆ VisitSettings() [3/3]

template<bool Const>

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

Definition at line 46 of file SetEnvelopeCommand.cpp.

                                                                      {
   S.OptionalY( bHasT              ).Define(  mT,              wxT("Time"),     0.0, 0.0, 100000.0);
   S.OptionalY( bHasV              ).Define(  mV,              wxT("Value"),    1.0, 0.0, 2.0);
   S.OptionalN( bHasDelete         ).Define(  mbDelete,        wxT("Delete"),   false );
   return true;
};